Project

General

Profile

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