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