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