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