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