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