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