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