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