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