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