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