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