Project

General

Profile

1 702 aaronmk
Installation:
2
    Install: make install
3 3370 aaronmk
        WARNING: This will delete the current public schema of your VegBIEN DB!
4 702 aaronmk
    Uninstall: make uninstall
5 3370 aaronmk
        WARNING: This will delete your entire VegBIEN DB!
6 3374 aaronmk
        This includes all archived imports and staging tables.
7 554 aaronmk
8 3674 aaronmk
Maintenance:
9
    Important: Whenever you install a system update that affects PostgreSQL or
10
        any of its dependencies, such as libc, you should restart the PostgreSQL
11
        server. Otherwise, you may get strange errors like "the database system
12
        is in recovery mode" which go away upon reimport.
13
14 702 aaronmk
Data import:
15 4487 aaronmk
    On local machine:
16
        make test by_col=1
17 5016 aaronmk
            See note under Testing below
18 4487 aaronmk
    On vegbiendev:
19 4482 aaronmk
    svn up
20
    Update the schemas: make schemas/reinstall
21
        WARNING: This will delete the current public schema of your VegBIEN DB!
22
        To save it: make schemas/rotate
23 4793 aaronmk
        Important: This must be done *after* running make_analytical_db on a
24
            previous import
25 5206 aaronmk
    Import the TNRS names:
26
        make inputs/.TNRS/cleanup; make inputs/.TNRS/import by_col=1 &
27
    Wait for the TNRS import to finish: wait
28
    Start column-based import: . bin/import_all by_col=1
29
        To use row-based import: . bin/import_all
30 4481 aaronmk
        To stop all running imports: . bin/stop_imports
31
    Wait (overnight) for the import to finish
32
    ./bin/make_analytical_db &
33
    Wait for make_analytical_db to finish
34 2976 aaronmk
    Archive the last import: make schemas/rotate
35 4790 aaronmk
        Important: This must be done *after* running make_analytical_db
36 4481 aaronmk
    Rename the rotated schema using the date in the first datasource's log
37
        file name
38
    tail inputs/*/*/logs/<date>-*.log.sql
39
    Check that every input's log ends in "Encountered 0 error(s)"
40
    If many do not, fix the bug and discard the current (partial) import:
41
        make schemas/public/reinstall
42
    Otherwise, continue
43
    Delete previous imports so they won't bloat the full DB backup:
44
        make backups/public.<datetime>.backup/remove
45 5211 aaronmk
    make inputs/.TNRS/cleanup; make backups/TNRS.backup-remake &
46 4751 aaronmk
    make backups/public.<datetime>.backup/test &
47
    make backups/vegbien.<datetime>.backup/test &
48 4481 aaronmk
    On local machine:
49
        make inputs/download-logs
50 4623 aaronmk
        make backups/download
51 4677 aaronmk
    If desired, record the import times in inputs/import.stats.xls:
52
        Open inputs/import.stats.xls
53
        Insert a copy of the leftmost Column-based column group before it
54
        Update the import date in the upper-right corner
55
        ./bin/import_times inputs/*/*/logs/<date>-*.log.sql
56
        Paste the output over the # Rows/Time columns, making sure that the
57
            row counts match up with the previous import's row counts
58
        If the row counts do not match up, insert or reorder rows as needed
59
            until they do
60 4777 aaronmk
        Commit: svn ci -m "inputs/import.stats.xls: Updated import times"
61 3381 aaronmk
62 3545 aaronmk
Backups:
63 3408 aaronmk
    Archived imports:
64
        Back up: make backups/public.<date>.backup &
65 3546 aaronmk
            Note: To back up the last import, you must archive it first (above)
66 3410 aaronmk
        Test: make backups/public.<date>.backup/test &
67 3408 aaronmk
        Restore: make backups/public.<date>.backup/restore &
68
        Remove: make backups/public.<date>.backup/remove
69 3701 aaronmk
        Download: make backups/download
70 3408 aaronmk
    Full DB:
71 3546 aaronmk
        Back up, test, and rotate: make backups/vegbien.backup/all &
72 3439 aaronmk
        Back up and rotate: make backups/vegbien.backup/rotate &
73
        Test: make backups/vegbien.<date>.backup/test &
74
        Restore: make backups/vegbien.<date>.backup/restore &
75 3701 aaronmk
        Download: make backups/download
76 3698 aaronmk
    Import logs:
77
        Download: make inputs/download-logs
78 554 aaronmk
79 1773 aaronmk
Datasource setup:
80 4219 aaronmk
    Add a new datasource: make inputs/<datasrc>/add
81
        <datasrc> may not contain spaces, and should be abbreviated.
82
        If the datasource is a herbarium, <datasrc> should be the herbarium code
83
            as defined by the Index Herbariorum <http://sweetgum.nybg.org/ih/>
84 4360 aaronmk
    Install any MySQL export:
85
        Create database in phpMyAdmin
86
        mysql -p database <export.sql
87 4218 aaronmk
    Add input data for each table present in the datasource:
88
        Choose a table name from <https://projects.nceas.ucsb.edu/nceas/projects
89
            /bien/wiki/VegCSV#Suggested-table-names>, or use a custom name
90 4264 aaronmk
        Note that if this table will be joined together with another table, its
91
            name must end in ".src"
92 4219 aaronmk
        make inputs/<datasrc>/<table>/add
93 4342 aaronmk
            Important: DO NOT just create an empty directory named <table>!
94
                This command also creates necessary subdirs, such as logs/.
95 4219 aaronmk
        Place the CSV for the table in inputs/<datasrc>/<table>/
96 4264 aaronmk
            OR place a query joining other tables together in
97
            inputs/<datasrc>/<table>/create.sql and svn add this file
98 4212 aaronmk
        Important: When exporting relational databases to CSVs, you MUST ensure
99
            that embedded quotes are escaped by doubling them, *not* by
100
            preceding them with a "\" as is the default in phpMyAdmin
101 3612 aaronmk
        If there are multiple part files for a table, and the header is repeated
102
            in each part, make sure each header is EXACTLY the same.
103
             (If the headers are not the same, the CSV concatenation script
104
             assumes the part files don't have individual headers and treats the
105
             subsequent headers as data rows.)
106 4255 aaronmk
        Add <table> to inputs/<datasrc>/import_order.txt before other tables
107 4220 aaronmk
            that depend on it
108 3593 aaronmk
    Auto-create the map spreadsheets:
109 4644 aaronmk
        make inputs/<datasrc>/
110 4645 aaronmk
        svn add inputs/<datasrc>/*/{,.}{header,map,*terms,VegBIEN}.csv{,.*}
111 3611 aaronmk
    Install the staging tables:
112 4219 aaronmk
        make inputs/<datasrc>/reinstall quiet=1 &
113
        To view progress: tail -f inputs/<datasrc>/<table>/logs/install.log.sql
114
        View the logs: tail -n +1 inputs/<datasrc>/*/logs/install.log.sql
115 3611 aaronmk
            tail provides a header line with the filename
116
            +1 starts at the first line, to show the whole file
117
        For every file with an error 'column "..." specified more than once':
118 4182 aaronmk
            Add a header override file "+header.<ext>" in <table>/:
119 3611 aaronmk
                Note: The leading "+" should sort it before the flat files.
120
                    "_" unfortunately sorts *after* capital letters in ASCII.
121
                Create a text file containing the header line of the flat files
122
                Add an ! at the beginning of the line
123
                    This signals cat_csv that this is a header override.
124
                For empty names, use their 0-based column # (by convention)
125
                For duplicate names, add a distinguishing suffix
126
                For long names that collided, rename them to <= 63 chars long
127
                Do NOT make readability changes in this step; that is what the
128
                    map spreadsheets (below) are for.
129
                Save
130 4219 aaronmk
                svn add inputs/<datasrc>/<table>/<header_override>
131 3611 aaronmk
        If you made any changes, re-run the install command above
132 3576 aaronmk
    Map each table's columns:
133 4125 aaronmk
        In each <table>/ subdir, for each "via map" map.csv:
134 3576 aaronmk
            Open the map in a spreadsheet editor
135 4125 aaronmk
            Open the "core map" /mappings/Veg+-VegBIEN.csv
136 3576 aaronmk
            In each row of the via map, set the right column to a value from the
137
                left column of the core map
138
            Save
139 4219 aaronmk
        Regenerate the derived maps: make inputs/<datasrc>/
140 3593 aaronmk
    Accept the test cases:
141 4219 aaronmk
        make inputs/<datasrc>/test
142 3593 aaronmk
            When prompted to "Accept new test output", enter y and press ENTER
143 3690 aaronmk
            If you instead get errors, do one of the following for each one:
144
            -   If the error was due to a bug, fix it
145
            -   Add a SQL function that filters or transforms the invalid data
146
            -   Make an empty mapping for the columns that produced the error.
147
                Put something in the Comments column of the map spreadsheet to
148
                prevent the automatic mapper from auto-removing the mapping.
149 3783 aaronmk
            When accepting tests, it's helpful to use WinMerge
150
                (see WinMerge setup below for configuration)
151 4476 aaronmk
        make inputs/<datasrc>/test by_col=1
152
            If you get errors this time, this always indicates a bug, usually in
153
                either the unique constraints or column-based import itself
154 4219 aaronmk
        svn add inputs/<datasrc>/*/test.xml.ref
155
    Commit: svn ci -m "Added inputs/<datasrc>/" inputs/<datasrc>/
156 3585 aaronmk
    Update vegbiendev:
157
        On vegbiendev: svn up
158
        On local machine: make inputs/upload
159 4291 aaronmk
        On vegbiendev:
160
            Follow the steps under Install the staging tables above
161
            make inputs/<datasrc>/test
162 1773 aaronmk
163 702 aaronmk
Schema changes:
164
    Regenerate schema from installed DB: make schemas/remake
165 1967 aaronmk
    Reinstall DB from schema: make schemas/reinstall
166 3370 aaronmk
        WARNING: This will delete the current public schema of your VegBIEN DB!
167 3589 aaronmk
    Reinstall staging tables: . bin/reinstall_all
168 702 aaronmk
    Sync ERD with vegbien.sql schema:
169
        Run make schemas/vegbien.my.sql
170
        Open schemas/vegbien.ERD.mwb in MySQLWorkbench
171
        Go to File > Export > Synchronize With SQL CREATE Script...
172
        For Input File, select schemas/vegbien.my.sql
173
        Click Continue
174
        Click in the changes list and press Ctrl+A or Apple+A to select all
175
        Click Update Model
176
        Click Continue
177
        Note: The generated SQL script will be empty because we are syncing in
178
            the opposite direction
179
        Click Execute
180
        Reposition any lines that have been reset
181
        Add any new tables by dragging them from the Catalog in the left sidebar
182
            to the diagram
183
        Remove any deleted tables by right-clicking the table's diagram element,
184
            selecting Delete '<table name>', and clicking Delete
185
        Save
186 1774 aaronmk
        If desired, update the graphical ERD exports (see below)
187
    Update graphical ERD exports:
188 702 aaronmk
        Go to File > Export > Export as PNG...
189 1774 aaronmk
        Select schemas/vegbien.ERD.png and click Save
190 702 aaronmk
        Go to File > Export > Export as SVG...
191 1774 aaronmk
        Select schemas/vegbien.ERD.svg and click Save
192 702 aaronmk
        Go to File > Export > Export as Single Page PDF...
193 4087 aaronmk
        Select schemas/vegbien.ERD.1_pg.pdf and click Save
194 1774 aaronmk
        Go to File > Print...
195
        In the lower left corner, click PDF > Save as PDF...
196
        Set the Title and Author to ""
197 4087 aaronmk
        Select schemas/vegbien.ERD.pdf and click Save
198 203 aaronmk
199 1459 aaronmk
Testing:
200
    Mapping process: make test
201 4292 aaronmk
        Including column-based import: make test by_col=1
202 4985 aaronmk
            If the row-based and column-based imports produce different inserted
203
            row counts, this usually means that a table is underconstrained
204
            (the unique indexes don't cover all possible rows).
205
            This can occur if you didn't use COALESCE(field, null_value) around
206
            a nullable field in a unique index. See sql_gen.null_sentinels for
207
            the appropriate null value to use.
208 1459 aaronmk
    Map spreadsheet generation: make remake
209 1744 aaronmk
    Missing mappings: make missing_mappings
210 1459 aaronmk
    Everything (for most complete coverage): make test-all
211 702 aaronmk
212 3783 aaronmk
WinMerge setup:
213
    Install WinMerge from <http://winmerge.org/>
214 3785 aaronmk
    Open WinMerge
215
    Go to Edit > Options and click Compare in the left sidebar
216 3783 aaronmk
    Enable "Moved block detection", as described at
217
        <http://manual.winmerge.org/Configuration.html#d0e5892>.
218 3784 aaronmk
    Set Whitespace to Ignore change, as described at
219
        <http://manual.winmerge.org/Configuration.html#d0e5758>.
220 3783 aaronmk
221 3133 aaronmk
Documentation:
222
    To generate a Redmine-formatted list of steps for column-based import:
223 4486 aaronmk
        make inputs/QMOR/Specimen/logs/steps.by_col.log.sql
224 5210 aaronmk
    To import and scrub just the test taxonomic names:
225
        make inputs/.TNRS/reinstall
226
            WARNING: This will delete the TNRS cache!
227
            To save it: make backups/TNRS.backup-remake
228
        make schemas/public/reinstall
229
            WARNING: This will delete the public schema of your VegBIEN DB!
230
            To save it: make schemas/rotate
231
        make inputs/test_taxonomic_names/import log=
232
        Do the following twice: (The 2nd time parses the accepted names.)
233
            make inputs/.TNRS/tnrs/tnrs-remake log=
234
            Press Ctrl+C when it displays "Waiting..."
235
            make schemas/public/reinstall
236
            make inputs/.TNRS/cleanup
237
            make inputs/.TNRS/import log=
238
            make inputs/test_taxonomic_names/import log=
239 3133 aaronmk
240 702 aaronmk
General:
241
    To see a program's description, read its top-of-file comment
242
    To see a program's usage, run it without arguments
243 3389 aaronmk
    To remake a directory: make <dir>/remake
244
    To remake a file: make <file>-remake