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