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