Project

General

Profile

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