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