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