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 6846 aaronmk
    VegCore data dictionary:
10
        Regularly, or whenever the VegCore data dictionary page
11
            (https://projects.nceas.ucsb.edu/nceas/projects/bien/wiki/VegCore)
12
            is changed, regenerate mappings/VegCore.csv:
13 6856 aaronmk
            make mappings/VegCore.htm-remake; make mappings/
14 3674 aaronmk
    Important: Whenever you install a system update that affects PostgreSQL or
15
        any of its dependencies, such as libc, you should restart the PostgreSQL
16
        server. Otherwise, you may get strange errors like "the database system
17 6820 aaronmk
        is in recovery mode" which go away upon reimport, or you may not be able
18 6821 aaronmk
        to access the database as the postgres superuser. This applies to both
19
        Linux and Mac OS X.
20 3674 aaronmk
21 702 aaronmk
Data import:
22 4487 aaronmk
    On local machine:
23
        make test by_col=1
24 5016 aaronmk
            See note under Testing below
25 4487 aaronmk
    On vegbiendev:
26 4482 aaronmk
    svn up
27 6059 aaronmk
    make inputs/upload
28
    For each newly-uploaded datasource: make inputs/<datasrc>/reinstall
29 4482 aaronmk
    Update the schemas: make schemas/reinstall
30
        WARNING: This will delete the current public schema of your VegBIEN DB!
31
        To save it: make schemas/rotate
32 6802 aaronmk
    Make sure there is at least 100GB of disk space on /: df -h
33
        The import schema is 75GB, and may use additional space for temp tables
34 6804 aaronmk
        To free up space, remove backups that have been archived on jupiter:
35
            List backups/ to view older backups
36
            Check their MD5 sums using the steps under On jupiter below
37
            Remove these backups
38 5206 aaronmk
    Start column-based import: . bin/import_all by_col=1
39
        To use row-based import: . bin/import_all
40 4481 aaronmk
        To stop all running imports: . bin/stop_imports
41 5318 aaronmk
        WARNING: Do NOT run import_all in the background, or the jobs it creates
42
            won't be owned by your shell.
43 6797 aaronmk
        Note that import_all will take several hours to import the NCBI backbone
44
            and TNRS names before returning control to the shell.
45 4481 aaronmk
    Wait (overnight) for the import to finish
46 6796 aaronmk
    On local machine: make inputs/download-logs
47 6871 aaronmk
    In PostgreSQL, check that the source table contains entries for all inputs
48 6103 aaronmk
    tail inputs/{.,}*/*/logs/*.r<revision>[.-]*log.sql
49 6799 aaronmk
    In the output, search for "Command exited with non-zero status"
50
    For inputs that have this, fix the associated bug(s)
51
    If many inputs have errors, discard the current (partial) import:
52 6103 aaronmk
        make schemas/public/reinstall
53
    Otherwise, continue
54 6105 aaronmk
    Determine the import name:
55
        bin/import_name inputs/{.,}*/*/logs/*.r<revision>[.-]*log.sql
56
    Archive the last import: make schemas/rename/public.<import_name>
57 4481 aaronmk
    Delete previous imports so they won't bloat the full DB backup:
58 6646 aaronmk
        make backups/vegbien.<version>.backup/remove
59 5917 aaronmk
    make backups/TNRS.backup-remake &
60 5461 aaronmk
    make backups/vegbien.<version>.backup/test &
61 6490 aaronmk
    env public=public.<version> bin/export_analytical_db &
62 6848 aaronmk
    sudo backups/fix_perms
63 6666 aaronmk
    make backups/upload
64 6719 aaronmk
    On jupiter:
65
        cd /data/dev/aaronmk/VegBIEN.backups
66
        For each newly-archived backup:
67
            make <backup>.md5/test
68
            Check that "OK" is printed next to the filename
69 6494 aaronmk
    On nimoy:
70
        cd /home/bien/svn/
71
        svn up
72 6722 aaronmk
        make backups/analytical_aggregate.public.<version>.csv/download
73 6723 aaronmk
        make backups/analytical_aggregate.public.<version>.csv.md5/test
74
        Check that "OK" is printed next to the filename
75 6494 aaronmk
        In the bien_web DB:
76 6652 aaronmk
            Create the analytical_aggregate_r<revision> table using its schema
77
                in schemas/vegbien.my.sql
78 6650 aaronmk
        env table=analytical_aggregate_r<revision> bin/publish_analytical_db \
79 6653 aaronmk
            backups/analytical_aggregate.public.<version>.csv
80 4677 aaronmk
    If desired, record the import times in inputs/import.stats.xls:
81
        Open inputs/import.stats.xls
82
        Insert a copy of the leftmost Column-based column group before it
83
        Update the import date in the upper-right corner
84 5461 aaronmk
        ./bin/import_times inputs/{.,}*/*/logs/*.r<revision>[.-]*log.sql
85 4677 aaronmk
        Paste the output over the # Rows/Time columns, making sure that the
86
            row counts match up with the previous import's row counts
87
        If the row counts do not match up, insert or reorder rows as needed
88
            until they do
89 4777 aaronmk
        Commit: svn ci -m "inputs/import.stats.xls: Updated import times"
90 6367 aaronmk
    To remake analytical DB: env public=... bin/make_analytical_db &
91
        public should be set to the current import's schema name
92 6212 aaronmk
        To view progress:
93
            tail -f inputs/analytical_db/logs/make_analytical_db.log.sql
94 3381 aaronmk
95 3545 aaronmk
Backups:
96 3408 aaronmk
    Archived imports:
97
        Back up: make backups/public.<date>.backup &
98 6516 aaronmk
            Note: To back up the last import, you must archive it first:
99
                make schemas/rotate
100 3410 aaronmk
        Test: make backups/public.<date>.backup/test &
101 3408 aaronmk
        Restore: make backups/public.<date>.backup/restore &
102
        Remove: make backups/public.<date>.backup/remove
103 3701 aaronmk
        Download: make backups/download
104 5801 aaronmk
    TNRS cache:
105
        Back up: make backups/TNRS.backup-remake &
106
        Restore:
107
            yes|make inputs/.TNRS/uninstall
108
            make backups/TNRS.backup/restore &
109
            yes|make schemas/public/reinstall
110
                Must come after TNRS restore to recreate tnrs_input_name view
111 3408 aaronmk
    Full DB:
112 6517 aaronmk
        Back up: make backups/vegbien.<date>.backup &
113 3439 aaronmk
        Test: make backups/vegbien.<date>.backup/test &
114
        Restore: make backups/vegbien.<date>.backup/restore &
115 3701 aaronmk
        Download: make backups/download
116 3698 aaronmk
    Import logs:
117
        Download: make inputs/download-logs
118 554 aaronmk
119 1773 aaronmk
Datasource setup:
120 4219 aaronmk
    Add a new datasource: make inputs/<datasrc>/add
121
        <datasrc> may not contain spaces, and should be abbreviated.
122
        If the datasource is a herbarium, <datasrc> should be the herbarium code
123
            as defined by the Index Herbariorum <http://sweetgum.nybg.org/ih/>
124 6366 aaronmk
    For MySQL inputs (exports and live DB connections):
125
        For .sql exports:
126
            Place the original .sql file in _src/ (*not* in _MySQL/)
127
            Create a database for the MySQL export in phpMyAdmin
128
            mysql -p database <inputs/<datasrc>/_src/export.sql
129
        mkdir inputs/<datasrc>/_MySQL/
130
        cp -p lib/MySQL.{data,schema}.sql.make inputs/<datasrc>/_MySQL/
131
        Edit _MySQL/*.make for the DB connection
132
            For a .sql export, use your local MySQL DB
133 6372 aaronmk
        Install the export according to Install the staging tables below
134 4218 aaronmk
    Add input data for each table present in the datasource:
135 6365 aaronmk
        For .sql exports, you must use the name of the table in the DB export
136
        For CSV files, you can use any name. It's recommended to use a table
137
            name from <https://projects.nceas.ucsb.edu/nceas/projects/bien/wiki/VegCSV#Suggested-table-names>
138 4264 aaronmk
        Note that if this table will be joined together with another table, its
139
            name must end in ".src"
140 4219 aaronmk
        make inputs/<datasrc>/<table>/add
141 4342 aaronmk
            Important: DO NOT just create an empty directory named <table>!
142
                This command also creates necessary subdirs, such as logs/.
143 6373 aaronmk
        If the table is in a .sql export: make inputs/<datasrc>/<table>/install
144
            Otherwise, place the CSV(s) for the table in
145 6370 aaronmk
            inputs/<datasrc>/<table>/ OR place a query joining other tables
146
            together in inputs/<datasrc>/<table>/create.sql
147 4212 aaronmk
        Important: When exporting relational databases to CSVs, you MUST ensure
148
            that embedded quotes are escaped by doubling them, *not* by
149
            preceding them with a "\" as is the default in phpMyAdmin
150 3612 aaronmk
        If there are multiple part files for a table, and the header is repeated
151
            in each part, make sure each header is EXACTLY the same.
152
             (If the headers are not the same, the CSV concatenation script
153
             assumes the part files don't have individual headers and treats the
154
             subsequent headers as data rows.)
155 4255 aaronmk
        Add <table> to inputs/<datasrc>/import_order.txt before other tables
156 4220 aaronmk
            that depend on it
157 3611 aaronmk
    Install the staging tables:
158 4219 aaronmk
        make inputs/<datasrc>/reinstall quiet=1 &
159
        To view progress: tail -f inputs/<datasrc>/<table>/logs/install.log.sql
160
        View the logs: tail -n +1 inputs/<datasrc>/*/logs/install.log.sql
161 3611 aaronmk
            tail provides a header line with the filename
162
            +1 starts at the first line, to show the whole file
163
        For every file with an error 'column "..." specified more than once':
164 4182 aaronmk
            Add a header override file "+header.<ext>" in <table>/:
165 3611 aaronmk
                Note: The leading "+" should sort it before the flat files.
166
                    "_" unfortunately sorts *after* capital letters in ASCII.
167
                Create a text file containing the header line of the flat files
168
                Add an ! at the beginning of the line
169
                    This signals cat_csv that this is a header override.
170
                For empty names, use their 0-based column # (by convention)
171
                For duplicate names, add a distinguishing suffix
172
                For long names that collided, rename them to <= 63 chars long
173
                Do NOT make readability changes in this step; that is what the
174
                    map spreadsheets (below) are for.
175
                Save
176
        If you made any changes, re-run the install command above
177 6015 aaronmk
    Auto-create the map spreadsheets: make inputs/<datasrc>/
178 3576 aaronmk
    Map each table's columns:
179 4125 aaronmk
        In each <table>/ subdir, for each "via map" map.csv:
180 3576 aaronmk
            Open the map in a spreadsheet editor
181 4125 aaronmk
            Open the "core map" /mappings/Veg+-VegBIEN.csv
182 3576 aaronmk
            In each row of the via map, set the right column to a value from the
183
                left column of the core map
184
            Save
185 4219 aaronmk
        Regenerate the derived maps: make inputs/<datasrc>/
186 3593 aaronmk
    Accept the test cases:
187 4219 aaronmk
        make inputs/<datasrc>/test
188 3593 aaronmk
            When prompted to "Accept new test output", enter y and press ENTER
189 3690 aaronmk
            If you instead get errors, do one of the following for each one:
190
            -   If the error was due to a bug, fix it
191
            -   Add a SQL function that filters or transforms the invalid data
192
            -   Make an empty mapping for the columns that produced the error.
193
                Put something in the Comments column of the map spreadsheet to
194
                prevent the automatic mapper from auto-removing the mapping.
195 3783 aaronmk
            When accepting tests, it's helpful to use WinMerge
196
                (see WinMerge setup below for configuration)
197 4476 aaronmk
        make inputs/<datasrc>/test by_col=1
198
            If you get errors this time, this always indicates a bug, usually in
199 6368 aaronmk
                the VegBIEN unique constraints or column-based import itself
200 5881 aaronmk
    Add newly-created files: make inputs/<datasrc>/add
201 4219 aaronmk
    Commit: svn ci -m "Added inputs/<datasrc>/" inputs/<datasrc>/
202 3585 aaronmk
    Update vegbiendev:
203
        On vegbiendev: svn up
204
        On local machine: make inputs/upload
205 4291 aaronmk
        On vegbiendev:
206
            Follow the steps under Install the staging tables above
207
            make inputs/<datasrc>/test
208 1773 aaronmk
209 6484 aaronmk
Datasource refreshing:
210
    VegBank:
211
        make inputs/VegBank/vegbank.sql-remake
212
        make inputs/VegBank/reinstall quiet=1 &
213
214 702 aaronmk
Schema changes:
215 5227 aaronmk
    Remember to update the following files with any renamings:
216
        schemas/filter_ERD.csv
217
        mappings/VegCore-VegBIEN.csv
218 6058 aaronmk
        mappings/verify.*.sql
219 702 aaronmk
    Regenerate schema from installed DB: make schemas/remake
220 1967 aaronmk
    Reinstall DB from schema: make schemas/reinstall
221 3370 aaronmk
        WARNING: This will delete the current public schema of your VegBIEN DB!
222 3589 aaronmk
    Reinstall staging tables: . bin/reinstall_all
223 702 aaronmk
    Sync ERD with vegbien.sql schema:
224
        Run make schemas/vegbien.my.sql
225
        Open schemas/vegbien.ERD.mwb in MySQLWorkbench
226
        Go to File > Export > Synchronize With SQL CREATE Script...
227
        For Input File, select schemas/vegbien.my.sql
228
        Click Continue
229 6369 aaronmk
        In the changes list, select each table with an arrow next to it
230 702 aaronmk
        Click Update Model
231
        Click Continue
232
        Note: The generated SQL script will be empty because we are syncing in
233
            the opposite direction
234
        Click Execute
235
        Reposition any lines that have been reset
236
        Add any new tables by dragging them from the Catalog in the left sidebar
237
            to the diagram
238
        Remove any deleted tables by right-clicking the table's diagram element,
239
            selecting Delete '<table name>', and clicking Delete
240
        Save
241 1774 aaronmk
        If desired, update the graphical ERD exports (see below)
242
    Update graphical ERD exports:
243 702 aaronmk
        Go to File > Export > Export as PNG...
244 1774 aaronmk
        Select schemas/vegbien.ERD.png and click Save
245 702 aaronmk
        Go to File > Export > Export as SVG...
246 1774 aaronmk
        Select schemas/vegbien.ERD.svg and click Save
247 702 aaronmk
        Go to File > Export > Export as Single Page PDF...
248 4087 aaronmk
        Select schemas/vegbien.ERD.1_pg.pdf and click Save
249 1774 aaronmk
        Go to File > Print...
250
        In the lower left corner, click PDF > Save as PDF...
251
        Set the Title and Author to ""
252 4087 aaronmk
        Select schemas/vegbien.ERD.pdf and click Save
253 5226 aaronmk
    Refactoring tips:
254
        To rename a table:
255
            In vegbien.sql, do the following:
256
                Replace regexp (?<=_|\b)<old>(?=_|\b) with <new>
257
                    This is necessary because the table name is *everywhere*
258
                Search for <new>
259
                Manually change back any replacements inside comments
260
        To rename a column:
261
            Rename the column: ALTER TABLE <table> RENAME <old> TO <new>;
262
            Recreate any foreign key for the column, removing CONSTRAINT <name>
263
                This resets the foreign key name using the new column name
264 6320 aaronmk
    Creating a poster of the ERD:
265 6326 aaronmk
        Determine the poster size:
266 6320 aaronmk
            Measure the line height (from the bottom of one line to the bottom
267
                of another): 16.3cm/24 lines = 0.679cm
268
            Measure the height of the ERD: 35.4cm*2 = 70.8cm
269
            Zoom in as far as possible
270
            Measure the height of a capital letter: 3.5mm
271
            Measure the line height: 8.5mm
272
            Calculate the text's fraction of the line height: 3.5mm/8.5mm = 0.41
273
            Calculate the text height: 0.679cm*0.41 = 0.28cm
274
            Calculate the text height's fraction of the ERD height:
275
                0.28cm/70.8cm = 0.0040
276
            Measure the text height on the *VegBank* ERD poster: 5.5mm = 0.55cm
277
            Calculate the VegBIEN poster height to make the text the same size:
278
                0.55cm/0.0040 = 137.5cm H; *1in/2.54cm = 54.1in H
279
            The ERD aspect ratio is 11 in W x (2*8.5in H) = 11x17 portrait
280
            Calculate the VegBIEN poster width: 54.1in H*11W/17H = 35.0in W
281
            The minimum VegBIEN poster size is 35x54in portrait
282 6327 aaronmk
        Determine the cost:
283
            The FedEx Kinkos near NCEAS (1030 State St, Santa Barbara, CA 93101)
284
                charges the following for posters:
285
                base: $7.25/sq ft
286
                lamination: $3/sq ft
287
                mounting on a board: $8/sq ft
288 203 aaronmk
289 1459 aaronmk
Testing:
290
    Mapping process: make test
291 4292 aaronmk
        Including column-based import: make test by_col=1
292 4985 aaronmk
            If the row-based and column-based imports produce different inserted
293
            row counts, this usually means that a table is underconstrained
294
            (the unique indexes don't cover all possible rows).
295
            This can occur if you didn't use COALESCE(field, null_value) around
296
            a nullable field in a unique index. See sql_gen.null_sentinels for
297
            the appropriate null value to use.
298 1459 aaronmk
    Map spreadsheet generation: make remake
299 1744 aaronmk
    Missing mappings: make missing_mappings
300 1459 aaronmk
    Everything (for most complete coverage): make test-all
301 702 aaronmk
302 3783 aaronmk
WinMerge setup:
303
    Install WinMerge from <http://winmerge.org/>
304 3785 aaronmk
    Open WinMerge
305
    Go to Edit > Options and click Compare in the left sidebar
306 3783 aaronmk
    Enable "Moved block detection", as described at
307
        <http://manual.winmerge.org/Configuration.html#d0e5892>.
308 3784 aaronmk
    Set Whitespace to Ignore change, as described at
309
        <http://manual.winmerge.org/Configuration.html#d0e5758>.
310 3783 aaronmk
311 3133 aaronmk
Documentation:
312
    To generate a Redmine-formatted list of steps for column-based import:
313 6291 aaronmk
        make inputs/ACAD/Specimen/logs/steps.by_col.log.sql
314 5210 aaronmk
    To import and scrub just the test taxonomic names:
315 5415 aaronmk
        inputs/test_taxonomic_names/test_scrub
316 3133 aaronmk
317 702 aaronmk
General:
318
    To see a program's description, read its top-of-file comment
319
    To see a program's usage, run it without arguments
320 3389 aaronmk
    To remake a directory: make <dir>/remake
321
    To remake a file: make <file>-remake