Project

General

Profile

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