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