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