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