4 author: Michael Orlitzky
5 maintainer: Michael Orlitzky <michael@orlitzky.com>
8 license-file: doc/LICENSE
12 doc/htsn-importrc.example
13 doc/man1/htsn-import.1
19 schemagen/Auto_Racing_Schedule_XML/*.xml
20 schemagen/Heartbeat/*.xml
21 schemagen/injuriesxml/*.xml
22 schemagen/Injuries_Detail_XML/*.xml
23 schemagen/newsxml/*.xml
24 schemagen/Odds_XML/*.xml
25 schemagen/scoresxml/*.xml
26 schemagen/weatherxml/*.xml
31 Import XML files from The Sports Network into an RDBMS.
36 htsn-import [OPTIONS] [FILES]
39 The Sports Network <http://www.sportsnetwork.com/> offers an XML feed
40 containing various sports news and statistics. Our sister program
41 /htsn/ is capable of retrieving the feed and saving the individual
42 XML documents contained therein. But what to do with them?
44 The purpose of /htsn-import/ is to take these XML documents and
45 get them into something we can use, a relational database management
46 system (RDBMS), loosely known as a SQL database. The structure of
47 relational database, is, well, relational, and the feed XML is not. So
48 there is some work to do before the data can be inserted.
50 First, we must parse the XML. Each supported document type (see below)
51 has a full pickle/unpickle implementation (\"pickle\" is simply a
52 synonym for serialize here). That means that we parse the entire
53 document into a data structure, and if we pickle (serialize) that data
54 structure, we get the exact same XML document tha we started with.
56 This is important for two reasons. First, it serves as a second level
57 of validation. The first validation is performed by the XML parser,
58 but if that succeeds and unpicking fails, we know that something is
59 fishy. Second, we don't ever want to be surprised by some new element
60 or attribute showing up in the XML. The fact that we can unpickle the
61 whole thing now means that we won't be surprised in the future.
63 The aforementioned feature is especially important because we
64 automatically migrate the database schema every time we import a
65 document. If you attempt to import a \"newsxml.dtd\" document, all
66 database objects relating to the news will be created if they do not
67 exist. We don't want the schema to change out from under us without
68 warning, so it's important that no XML be parsed that would result in
69 a different schema than we had previously. Since we can
70 pickle/unpickle everything already, this should be impossible.
72 Examples and usage documentation are available in the man page.
74 executable htsn-import
85 groundhog-postgresql >= 0.5,
86 groundhog-sqlite >= 0.5,
109 OptionalConfiguration
116 TSN.XML.AutoRacingResults
117 TSN.XML.AutoRacingSchedule
121 TSN.XML.InjuriesDetail
132 -fwarn-missing-signatures
133 -fwarn-name-shadowing
137 -fwarn-incomplete-record-updates
138 -fwarn-monomorphism-restriction
139 -fwarn-unused-do-bind
146 -- The following unbreak profiling with template haskell. We have
147 -- to build the program twice; once without profile and again with
154 type: exitcode-stdio-1.0
155 hs-source-dirs: src test
156 main-is: TestSuite.hs
164 htsn-common >= 0.0.1,
167 groundhog-postgresql >= 0.5,
168 groundhog-sqlite >= 0.5,
179 -- It's not entirely clear to me why I have to reproduce all of this.
183 -fwarn-missing-signatures
184 -fwarn-name-shadowing
188 -fwarn-incomplete-record-updates
189 -fwarn-monomorphism-restriction
190 -fwarn-unused-do-bind
195 type: exitcode-stdio-1.0
200 -- Additional test dependencies.
203 -- It's not entirely clear to me why I have to reproduce all of this.
207 -fwarn-missing-signatures
208 -fwarn-name-shadowing
212 -fwarn-incomplete-record-updates
213 -fwarn-monomorphism-restriction
214 -fwarn-unused-do-bind
222 -- These won't work without shelltestrunner installed in your
223 -- $PATH. Maybe there is some way to tell Cabal that.
224 test-suite shelltests
225 type: exitcode-stdio-1.0
227 main-is: ShellTests.hs
236 htsn-common >= 0.0.1,
239 groundhog-postgresql >= 0.5,
240 groundhog-sqlite >= 0.5,
254 source-repository head
256 location: http://michael.orlitzky.com/git/htsn-import.git