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