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 |
|
|
Update the schemas: make schemas/reinstall
|
21 |
|
|
WARNING: This will delete the current public schema of your VegBIEN DB!
|
22 |
|
|
To save it: make schemas/rotate
|
23 |
4793
|
aaronmk
|
Important: This must be done *after* running make_analytical_db on a
|
24 |
|
|
previous import
|
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 |
|
|
./bin/make_analytical_db &
|
34 |
|
|
Wait for make_analytical_db to finish
|
35 |
2976
|
aaronmk
|
Archive the last import: make schemas/rotate
|
36 |
4790
|
aaronmk
|
Important: This must be done *after* running make_analytical_db
|
37 |
4481
|
aaronmk
|
Rename the rotated schema using the date in the first datasource's log
|
38 |
|
|
file name
|
39 |
5461
|
aaronmk
|
tail inputs/{.,}*/*/logs/*.r<revision>[.-]*log.sql
|
40 |
4481
|
aaronmk
|
Check that every input's log ends in "Encountered 0 error(s)"
|
41 |
|
|
If many do not, fix the bug and discard the current (partial) import:
|
42 |
|
|
make schemas/public/reinstall
|
43 |
|
|
Otherwise, continue
|
44 |
|
|
Delete previous imports so they won't bloat the full DB backup:
|
45 |
5461
|
aaronmk
|
make backups/public.<version>.backup/remove
|
46 |
5211
|
aaronmk
|
make inputs/.TNRS/cleanup; make backups/TNRS.backup-remake &
|
47 |
5461
|
aaronmk
|
make backups/public.<version>.backup/test &
|
48 |
|
|
make backups/vegbien.<version>.backup/test &
|
49 |
4481
|
aaronmk
|
On local machine:
|
50 |
5219
|
aaronmk
|
make inputs/download-logs tnrs_log=1
|
51 |
4623
|
aaronmk
|
make backups/download
|
52 |
5221
|
aaronmk
|
make inputs/.TNRS/uninstall; make backups/TNRS.backup/restore &
|
53 |
5519
|
aaronmk
|
make inputs/.TNRS/cleanup
|
54 |
|
|
This is necessary because the PostgreSQL collation may differ
|
55 |
|
|
between vegbiendev's and your DB.
|
56 |
4677
|
aaronmk
|
If desired, record the import times in inputs/import.stats.xls:
|
57 |
|
|
Open inputs/import.stats.xls
|
58 |
|
|
Insert a copy of the leftmost Column-based column group before it
|
59 |
|
|
Update the import date in the upper-right corner
|
60 |
5461
|
aaronmk
|
./bin/import_times inputs/{.,}*/*/logs/*.r<revision>[.-]*log.sql
|
61 |
4677
|
aaronmk
|
Paste the output over the # Rows/Time columns, making sure that the
|
62 |
|
|
row counts match up with the previous import's row counts
|
63 |
|
|
If the row counts do not match up, insert or reorder rows as needed
|
64 |
|
|
until they do
|
65 |
4777
|
aaronmk
|
Commit: svn ci -m "inputs/import.stats.xls: Updated import times"
|
66 |
3381
|
aaronmk
|
|
67 |
3545
|
aaronmk
|
Backups:
|
68 |
3408
|
aaronmk
|
Archived imports:
|
69 |
|
|
Back up: make backups/public.<date>.backup &
|
70 |
3546
|
aaronmk
|
Note: To back up the last import, you must archive it first (above)
|
71 |
3410
|
aaronmk
|
Test: make backups/public.<date>.backup/test &
|
72 |
3408
|
aaronmk
|
Restore: make backups/public.<date>.backup/restore &
|
73 |
|
|
Remove: make backups/public.<date>.backup/remove
|
74 |
3701
|
aaronmk
|
Download: make backups/download
|
75 |
3408
|
aaronmk
|
Full DB:
|
76 |
3546
|
aaronmk
|
Back up, test, and rotate: make backups/vegbien.backup/all &
|
77 |
3439
|
aaronmk
|
Back up and rotate: make backups/vegbien.backup/rotate &
|
78 |
|
|
Test: make backups/vegbien.<date>.backup/test &
|
79 |
|
|
Restore: make backups/vegbien.<date>.backup/restore &
|
80 |
3701
|
aaronmk
|
Download: make backups/download
|
81 |
3698
|
aaronmk
|
Import logs:
|
82 |
|
|
Download: make inputs/download-logs
|
83 |
554
|
aaronmk
|
|
84 |
1773
|
aaronmk
|
Datasource setup:
|
85 |
4219
|
aaronmk
|
Add a new datasource: make inputs/<datasrc>/add
|
86 |
|
|
<datasrc> may not contain spaces, and should be abbreviated.
|
87 |
|
|
If the datasource is a herbarium, <datasrc> should be the herbarium code
|
88 |
|
|
as defined by the Index Herbariorum <http://sweetgum.nybg.org/ih/>
|
89 |
4360
|
aaronmk
|
Install any MySQL export:
|
90 |
|
|
Create database in phpMyAdmin
|
91 |
|
|
mysql -p database <export.sql
|
92 |
4218
|
aaronmk
|
Add input data for each table present in the datasource:
|
93 |
|
|
Choose a table name from <https://projects.nceas.ucsb.edu/nceas/projects
|
94 |
|
|
/bien/wiki/VegCSV#Suggested-table-names>, or use a custom name
|
95 |
4264
|
aaronmk
|
Note that if this table will be joined together with another table, its
|
96 |
|
|
name must end in ".src"
|
97 |
4219
|
aaronmk
|
make inputs/<datasrc>/<table>/add
|
98 |
4342
|
aaronmk
|
Important: DO NOT just create an empty directory named <table>!
|
99 |
|
|
This command also creates necessary subdirs, such as logs/.
|
100 |
4219
|
aaronmk
|
Place the CSV for the table in inputs/<datasrc>/<table>/
|
101 |
4264
|
aaronmk
|
OR place a query joining other tables together in
|
102 |
|
|
inputs/<datasrc>/<table>/create.sql and svn add this file
|
103 |
4212
|
aaronmk
|
Important: When exporting relational databases to CSVs, you MUST ensure
|
104 |
|
|
that embedded quotes are escaped by doubling them, *not* by
|
105 |
|
|
preceding them with a "\" as is the default in phpMyAdmin
|
106 |
3612
|
aaronmk
|
If there are multiple part files for a table, and the header is repeated
|
107 |
|
|
in each part, make sure each header is EXACTLY the same.
|
108 |
|
|
(If the headers are not the same, the CSV concatenation script
|
109 |
|
|
assumes the part files don't have individual headers and treats the
|
110 |
|
|
subsequent headers as data rows.)
|
111 |
4255
|
aaronmk
|
Add <table> to inputs/<datasrc>/import_order.txt before other tables
|
112 |
4220
|
aaronmk
|
that depend on it
|
113 |
3593
|
aaronmk
|
Auto-create the map spreadsheets:
|
114 |
4644
|
aaronmk
|
make inputs/<datasrc>/
|
115 |
4645
|
aaronmk
|
svn add inputs/<datasrc>/*/{,.}{header,map,*terms,VegBIEN}.csv{,.*}
|
116 |
3611
|
aaronmk
|
Install the staging tables:
|
117 |
4219
|
aaronmk
|
make inputs/<datasrc>/reinstall quiet=1 &
|
118 |
|
|
To view progress: tail -f inputs/<datasrc>/<table>/logs/install.log.sql
|
119 |
|
|
View the logs: tail -n +1 inputs/<datasrc>/*/logs/install.log.sql
|
120 |
3611
|
aaronmk
|
tail provides a header line with the filename
|
121 |
|
|
+1 starts at the first line, to show the whole file
|
122 |
|
|
For every file with an error 'column "..." specified more than once':
|
123 |
4182
|
aaronmk
|
Add a header override file "+header.<ext>" in <table>/:
|
124 |
3611
|
aaronmk
|
Note: The leading "+" should sort it before the flat files.
|
125 |
|
|
"_" unfortunately sorts *after* capital letters in ASCII.
|
126 |
|
|
Create a text file containing the header line of the flat files
|
127 |
|
|
Add an ! at the beginning of the line
|
128 |
|
|
This signals cat_csv that this is a header override.
|
129 |
|
|
For empty names, use their 0-based column # (by convention)
|
130 |
|
|
For duplicate names, add a distinguishing suffix
|
131 |
|
|
For long names that collided, rename them to <= 63 chars long
|
132 |
|
|
Do NOT make readability changes in this step; that is what the
|
133 |
|
|
map spreadsheets (below) are for.
|
134 |
|
|
Save
|
135 |
4219
|
aaronmk
|
svn add inputs/<datasrc>/<table>/<header_override>
|
136 |
3611
|
aaronmk
|
If you made any changes, re-run the install command above
|
137 |
3576
|
aaronmk
|
Map each table's columns:
|
138 |
4125
|
aaronmk
|
In each <table>/ subdir, for each "via map" map.csv:
|
139 |
3576
|
aaronmk
|
Open the map in a spreadsheet editor
|
140 |
4125
|
aaronmk
|
Open the "core map" /mappings/Veg+-VegBIEN.csv
|
141 |
3576
|
aaronmk
|
In each row of the via map, set the right column to a value from the
|
142 |
|
|
left column of the core map
|
143 |
|
|
Save
|
144 |
4219
|
aaronmk
|
Regenerate the derived maps: make inputs/<datasrc>/
|
145 |
3593
|
aaronmk
|
Accept the test cases:
|
146 |
4219
|
aaronmk
|
make inputs/<datasrc>/test
|
147 |
3593
|
aaronmk
|
When prompted to "Accept new test output", enter y and press ENTER
|
148 |
3690
|
aaronmk
|
If you instead get errors, do one of the following for each one:
|
149 |
|
|
- If the error was due to a bug, fix it
|
150 |
|
|
- Add a SQL function that filters or transforms the invalid data
|
151 |
|
|
- Make an empty mapping for the columns that produced the error.
|
152 |
|
|
Put something in the Comments column of the map spreadsheet to
|
153 |
|
|
prevent the automatic mapper from auto-removing the mapping.
|
154 |
3783
|
aaronmk
|
When accepting tests, it's helpful to use WinMerge
|
155 |
|
|
(see WinMerge setup below for configuration)
|
156 |
4476
|
aaronmk
|
make inputs/<datasrc>/test by_col=1
|
157 |
|
|
If you get errors this time, this always indicates a bug, usually in
|
158 |
|
|
either the unique constraints or column-based import itself
|
159 |
4219
|
aaronmk
|
svn add inputs/<datasrc>/*/test.xml.ref
|
160 |
|
|
Commit: svn ci -m "Added inputs/<datasrc>/" inputs/<datasrc>/
|
161 |
3585
|
aaronmk
|
Update vegbiendev:
|
162 |
|
|
On vegbiendev: svn up
|
163 |
|
|
On local machine: make inputs/upload
|
164 |
4291
|
aaronmk
|
On vegbiendev:
|
165 |
|
|
Follow the steps under Install the staging tables above
|
166 |
|
|
make inputs/<datasrc>/test
|
167 |
1773
|
aaronmk
|
|
168 |
702
|
aaronmk
|
Schema changes:
|
169 |
5227
|
aaronmk
|
Remember to update the following files with any renamings:
|
170 |
|
|
schemas/filter_ERD.csv
|
171 |
|
|
mappings/VegCore-VegBIEN.csv
|
172 |
5321
|
aaronmk
|
bin/tnrs_db
|
173 |
702
|
aaronmk
|
Regenerate schema from installed DB: make schemas/remake
|
174 |
1967
|
aaronmk
|
Reinstall DB from schema: make schemas/reinstall
|
175 |
3370
|
aaronmk
|
WARNING: This will delete the current public schema of your VegBIEN DB!
|
176 |
3589
|
aaronmk
|
Reinstall staging tables: . bin/reinstall_all
|
177 |
702
|
aaronmk
|
Sync ERD with vegbien.sql schema:
|
178 |
|
|
Run make schemas/vegbien.my.sql
|
179 |
|
|
Open schemas/vegbien.ERD.mwb in MySQLWorkbench
|
180 |
|
|
Go to File > Export > Synchronize With SQL CREATE Script...
|
181 |
|
|
For Input File, select schemas/vegbien.my.sql
|
182 |
|
|
Click Continue
|
183 |
|
|
Click in the changes list and press Ctrl+A or Apple+A to select all
|
184 |
|
|
Click Update Model
|
185 |
|
|
Click Continue
|
186 |
|
|
Note: The generated SQL script will be empty because we are syncing in
|
187 |
|
|
the opposite direction
|
188 |
|
|
Click Execute
|
189 |
|
|
Reposition any lines that have been reset
|
190 |
|
|
Add any new tables by dragging them from the Catalog in the left sidebar
|
191 |
|
|
to the diagram
|
192 |
|
|
Remove any deleted tables by right-clicking the table's diagram element,
|
193 |
|
|
selecting Delete '<table name>', and clicking Delete
|
194 |
|
|
Save
|
195 |
1774
|
aaronmk
|
If desired, update the graphical ERD exports (see below)
|
196 |
|
|
Update graphical ERD exports:
|
197 |
702
|
aaronmk
|
Go to File > Export > Export as PNG...
|
198 |
1774
|
aaronmk
|
Select schemas/vegbien.ERD.png and click Save
|
199 |
702
|
aaronmk
|
Go to File > Export > Export as SVG...
|
200 |
1774
|
aaronmk
|
Select schemas/vegbien.ERD.svg and click Save
|
201 |
702
|
aaronmk
|
Go to File > Export > Export as Single Page PDF...
|
202 |
4087
|
aaronmk
|
Select schemas/vegbien.ERD.1_pg.pdf and click Save
|
203 |
1774
|
aaronmk
|
Go to File > Print...
|
204 |
|
|
In the lower left corner, click PDF > Save as PDF...
|
205 |
|
|
Set the Title and Author to ""
|
206 |
4087
|
aaronmk
|
Select schemas/vegbien.ERD.pdf and click Save
|
207 |
5226
|
aaronmk
|
Refactoring tips:
|
208 |
|
|
To rename a table:
|
209 |
|
|
In vegbien.sql, do the following:
|
210 |
|
|
Replace regexp (?<=_|\b)<old>(?=_|\b) with <new>
|
211 |
|
|
This is necessary because the table name is *everywhere*
|
212 |
|
|
Search for <new>
|
213 |
|
|
Manually change back any replacements inside comments
|
214 |
|
|
To rename a column:
|
215 |
|
|
Rename the column: ALTER TABLE <table> RENAME <old> TO <new>;
|
216 |
|
|
Recreate any foreign key for the column, removing CONSTRAINT <name>
|
217 |
|
|
This resets the foreign key name using the new column name
|
218 |
203
|
aaronmk
|
|
219 |
1459
|
aaronmk
|
Testing:
|
220 |
|
|
Mapping process: make test
|
221 |
4292
|
aaronmk
|
Including column-based import: make test by_col=1
|
222 |
4985
|
aaronmk
|
If the row-based and column-based imports produce different inserted
|
223 |
|
|
row counts, this usually means that a table is underconstrained
|
224 |
|
|
(the unique indexes don't cover all possible rows).
|
225 |
|
|
This can occur if you didn't use COALESCE(field, null_value) around
|
226 |
|
|
a nullable field in a unique index. See sql_gen.null_sentinels for
|
227 |
|
|
the appropriate null value to use.
|
228 |
1459
|
aaronmk
|
Map spreadsheet generation: make remake
|
229 |
1744
|
aaronmk
|
Missing mappings: make missing_mappings
|
230 |
1459
|
aaronmk
|
Everything (for most complete coverage): make test-all
|
231 |
702
|
aaronmk
|
|
232 |
3783
|
aaronmk
|
WinMerge setup:
|
233 |
|
|
Install WinMerge from <http://winmerge.org/>
|
234 |
3785
|
aaronmk
|
Open WinMerge
|
235 |
|
|
Go to Edit > Options and click Compare in the left sidebar
|
236 |
3783
|
aaronmk
|
Enable "Moved block detection", as described at
|
237 |
|
|
<http://manual.winmerge.org/Configuration.html#d0e5892>.
|
238 |
3784
|
aaronmk
|
Set Whitespace to Ignore change, as described at
|
239 |
|
|
<http://manual.winmerge.org/Configuration.html#d0e5758>.
|
240 |
3783
|
aaronmk
|
|
241 |
3133
|
aaronmk
|
Documentation:
|
242 |
|
|
To generate a Redmine-formatted list of steps for column-based import:
|
243 |
4486
|
aaronmk
|
make inputs/QMOR/Specimen/logs/steps.by_col.log.sql
|
244 |
5210
|
aaronmk
|
To import and scrub just the test taxonomic names:
|
245 |
5415
|
aaronmk
|
inputs/test_taxonomic_names/test_scrub
|
246 |
5416
|
aaronmk
|
WARNING: This will delete the TNRS cache!
|
247 |
5210
|
aaronmk
|
To save it: make backups/TNRS.backup-remake
|
248 |
5424
|
aaronmk
|
Restore the original DB:
|
249 |
|
|
yes|make inputs/.TNRS/uninstall
|
250 |
5496
|
aaronmk
|
make backups/TNRS.backup/restore &
|
251 |
5424
|
aaronmk
|
yes|make schemas/public/reinstall
|
252 |
5668
|
aaronmk
|
Must come after TNRS restore to recreate tnrs_input_name view
|
253 |
3133
|
aaronmk
|
|
254 |
702
|
aaronmk
|
General:
|
255 |
|
|
To see a program's description, read its top-of-file comment
|
256 |
|
|
To see a program's usage, run it without arguments
|
257 |
3389
|
aaronmk
|
To remake a directory: make <dir>/remake
|
258 |
|
|
To remake a file: make <file>-remake
|