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