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 |
1550
|
aaronmk
|
Import data into VegBIEN: . bin/import_all
|
16 |
3205
|
aaronmk
|
Using column-based import: . bin/with_all 'import by_col=1'
|
17 |
1556
|
aaronmk
|
Stop all running imports: . bin/stop_imports
|
18 |
2976
|
aaronmk
|
Archive the last import: make schemas/rotate
|
19 |
3381
|
aaronmk
|
Remove the last import: make schemas/public/reinstall
|
20 |
|
|
WARNING: This will delete the current public schema of your VegBIEN DB!
|
21 |
2976
|
aaronmk
|
Re-import data: make schemas/rotate; . bin/import_all
|
22 |
|
|
Note: This will archive the last import.
|
23 |
3381
|
aaronmk
|
|
24 |
3545
|
aaronmk
|
Backups:
|
25 |
3547
|
aaronmk
|
After a new import:
|
26 |
3698
|
aaronmk
|
On vegbiendev:
|
27 |
3547
|
aaronmk
|
make schemas/rotate
|
28 |
|
|
Rename the rotated schema using the date in the first datasource's log
|
29 |
|
|
file name
|
30 |
3845
|
aaronmk
|
tail inputs/*/import/*.<date>-*.log.sql
|
31 |
|
|
Check that every input's log ends in "Encountered 0 error(s)"
|
32 |
|
|
If many do not, fix the bug and discard the current (partial) import
|
33 |
|
|
Otherwise, continue
|
34 |
3548
|
aaronmk
|
Delete previous imports so they won't bloat the full DB backup:
|
35 |
3845
|
aaronmk
|
make backups/public.<datetime>.backup/remove
|
36 |
3547
|
aaronmk
|
make backups/<schema>.backup/test & make backups/vegbien.backup/all &
|
37 |
3698
|
aaronmk
|
On local machine:
|
38 |
|
|
make inputs/download-logs
|
39 |
3701
|
aaronmk
|
make backups/download &
|
40 |
3845
|
aaronmk
|
If desired, record the import times in inputs/import.stats.xls
|
41 |
3408
|
aaronmk
|
Archived imports:
|
42 |
|
|
Back up: make backups/public.<date>.backup &
|
43 |
3546
|
aaronmk
|
Note: To back up the last import, you must archive it first (above)
|
44 |
3410
|
aaronmk
|
Test: make backups/public.<date>.backup/test &
|
45 |
3408
|
aaronmk
|
Restore: make backups/public.<date>.backup/restore &
|
46 |
|
|
Remove: make backups/public.<date>.backup/remove
|
47 |
3701
|
aaronmk
|
Download: make backups/download
|
48 |
3408
|
aaronmk
|
Full DB:
|
49 |
3546
|
aaronmk
|
Back up, test, and rotate: make backups/vegbien.backup/all &
|
50 |
3439
|
aaronmk
|
Back up and rotate: make backups/vegbien.backup/rotate &
|
51 |
|
|
Test: make backups/vegbien.<date>.backup/test &
|
52 |
|
|
Restore: make backups/vegbien.<date>.backup/restore &
|
53 |
3701
|
aaronmk
|
Download: make backups/download
|
54 |
3698
|
aaronmk
|
Import logs:
|
55 |
|
|
Download: make inputs/download-logs
|
56 |
554
|
aaronmk
|
|
57 |
1773
|
aaronmk
|
Datasource setup:
|
58 |
3586
|
aaronmk
|
Add a new datasource: make inputs/<name>/add
|
59 |
|
|
<name> may not contain spaces, and should be abbreviated.
|
60 |
|
|
If the datasource is a herbarium, <name> should be the herbarium code as
|
61 |
|
|
defined by the Index Herbariorum <http://sweetgum.nybg.org/ih/>
|
62 |
3557
|
aaronmk
|
Populate the src/ subdir with input data:
|
63 |
3586
|
aaronmk
|
Obtain/create CSVs for the table(s) present in the datasource:
|
64 |
3557
|
aaronmk
|
specimens, plots, organisms, stems
|
65 |
3612
|
aaronmk
|
If there are multiple part files for a table, and the header is repeated
|
66 |
|
|
in each part, make sure each header is EXACTLY the same.
|
67 |
|
|
(If the headers are not the same, the CSV concatenation script
|
68 |
|
|
assumes the part files don't have individual headers and treats the
|
69 |
|
|
subsequent headers as data rows.)
|
70 |
3557
|
aaronmk
|
Rename each CSV so it ends in ".<table>.<ext>" (see tables above)
|
71 |
3593
|
aaronmk
|
Auto-create the map spreadsheets:
|
72 |
|
|
make inputs/<name>/; make inputs/<name>/
|
73 |
|
|
Note: Must be run twice to properly bootstrap all maps.
|
74 |
|
|
svn add inputs/<name>/maps/{*.csv,.*.last_cleanup}
|
75 |
3611
|
aaronmk
|
Install the staging tables:
|
76 |
|
|
make inputs/<name>/reinstall quiet=1 &
|
77 |
|
|
To view progress: tail -f inputs/<name>/import/install-<table>.log.sql
|
78 |
3614
|
aaronmk
|
View the logs: tail -n +1 inputs/<name>/import/install-*.log.sql
|
79 |
3611
|
aaronmk
|
tail provides a header line with the filename
|
80 |
|
|
+1 starts at the first line, to show the whole file
|
81 |
|
|
For every file with an error 'column "..." specified more than once':
|
82 |
|
|
Add a header override file "+header.<table>.<ext>" in src/:
|
83 |
|
|
Note: The leading "+" should sort it before the flat files.
|
84 |
|
|
"_" unfortunately sorts *after* capital letters in ASCII.
|
85 |
|
|
Create a text file containing the header line of the flat files
|
86 |
|
|
Add an ! at the beginning of the line
|
87 |
|
|
This signals cat_csv that this is a header override.
|
88 |
|
|
For empty names, use their 0-based column # (by convention)
|
89 |
|
|
For duplicate names, add a distinguishing suffix
|
90 |
|
|
For long names that collided, rename them to <= 63 chars long
|
91 |
|
|
Do NOT make readability changes in this step; that is what the
|
92 |
|
|
map spreadsheets (below) are for.
|
93 |
|
|
Save
|
94 |
|
|
svn add inputs/<name>/src/<header_override>
|
95 |
|
|
If you made any changes, re-run the install command above
|
96 |
3576
|
aaronmk
|
Map each table's columns:
|
97 |
|
|
In the maps/ subdir, for each "via map" of the form "<via>.<table>.csv":
|
98 |
|
|
Open the map in a spreadsheet editor
|
99 |
|
|
In /mappings, open the corresponding "core map" of the form
|
100 |
|
|
"<via>-VegBIEN.<table>.csv"
|
101 |
|
|
In each row of the via map, set the right column to a value from the
|
102 |
|
|
left column of the core map
|
103 |
|
|
Save
|
104 |
|
|
Regenerate the derived maps: make inputs/<name>/
|
105 |
3593
|
aaronmk
|
Accept the test cases:
|
106 |
|
|
make inputs/<name>/test/
|
107 |
|
|
When prompted to "Accept new test output", enter y and press ENTER
|
108 |
3690
|
aaronmk
|
If you instead get errors, do one of the following for each one:
|
109 |
|
|
- If the error was due to a bug, fix it
|
110 |
|
|
- Add a SQL function that filters or transforms the invalid data
|
111 |
|
|
- Make an empty mapping for the columns that produced the error.
|
112 |
|
|
Put something in the Comments column of the map spreadsheet to
|
113 |
|
|
prevent the automatic mapper from auto-removing the mapping.
|
114 |
3783
|
aaronmk
|
When accepting tests, it's helpful to use WinMerge
|
115 |
|
|
(see WinMerge setup below for configuration)
|
116 |
3593
|
aaronmk
|
svn add inputs/<name>/test/*.ref
|
117 |
3583
|
aaronmk
|
Commit: svn ci -m "Added inputs/<name>/" inputs/<name>/
|
118 |
3585
|
aaronmk
|
Update vegbiendev:
|
119 |
|
|
On vegbiendev: svn up
|
120 |
|
|
On local machine: make inputs/upload
|
121 |
3588
|
aaronmk
|
On vegbiendev: Follow the steps under Install the staging tables above
|
122 |
1773
|
aaronmk
|
|
123 |
702
|
aaronmk
|
Schema changes:
|
124 |
|
|
Regenerate schema from installed DB: make schemas/remake
|
125 |
1967
|
aaronmk
|
Reinstall DB from schema: make schemas/reinstall
|
126 |
3370
|
aaronmk
|
WARNING: This will delete the current public schema of your VegBIEN DB!
|
127 |
3441
|
aaronmk
|
Reinstall errors tables: make inputs/install errors_table_only=1
|
128 |
3589
|
aaronmk
|
Reinstall staging tables: . bin/reinstall_all
|
129 |
702
|
aaronmk
|
Sync ERD with vegbien.sql schema:
|
130 |
|
|
Run make schemas/vegbien.my.sql
|
131 |
|
|
Open schemas/vegbien.ERD.mwb in MySQLWorkbench
|
132 |
|
|
Go to File > Export > Synchronize With SQL CREATE Script...
|
133 |
|
|
For Input File, select schemas/vegbien.my.sql
|
134 |
|
|
Click Continue
|
135 |
|
|
Click in the changes list and press Ctrl+A or Apple+A to select all
|
136 |
|
|
Click Update Model
|
137 |
|
|
Click Continue
|
138 |
|
|
Note: The generated SQL script will be empty because we are syncing in
|
139 |
|
|
the opposite direction
|
140 |
|
|
Click Execute
|
141 |
|
|
Reposition any lines that have been reset
|
142 |
|
|
Add any new tables by dragging them from the Catalog in the left sidebar
|
143 |
|
|
to the diagram
|
144 |
|
|
Remove any deleted tables by right-clicking the table's diagram element,
|
145 |
|
|
selecting Delete '<table name>', and clicking Delete
|
146 |
|
|
Save
|
147 |
1774
|
aaronmk
|
If desired, update the graphical ERD exports (see below)
|
148 |
|
|
Update graphical ERD exports:
|
149 |
702
|
aaronmk
|
Go to File > Export > Export as PNG...
|
150 |
1774
|
aaronmk
|
Select schemas/vegbien.ERD.png and click Save
|
151 |
702
|
aaronmk
|
Go to File > Export > Export as SVG...
|
152 |
1774
|
aaronmk
|
Select schemas/vegbien.ERD.svg and click Save
|
153 |
702
|
aaronmk
|
Go to File > Export > Export as Single Page PDF...
|
154 |
1774
|
aaronmk
|
Select schemas/vegbien.ERD.pdf and click Save
|
155 |
|
|
Go to File > Print...
|
156 |
|
|
For Pages, choose From 1 To 1
|
157 |
|
|
In the lower left corner, click PDF > Save as PDF...
|
158 |
|
|
Set the Title and Author to ""
|
159 |
|
|
Select schemas/vegbien.ERD.core.pdf and click Save
|
160 |
203
|
aaronmk
|
|
161 |
1459
|
aaronmk
|
Testing:
|
162 |
|
|
Mapping process: make test
|
163 |
|
|
Map spreadsheet generation: make remake
|
164 |
1744
|
aaronmk
|
Missing mappings: make missing_mappings
|
165 |
1459
|
aaronmk
|
Everything (for most complete coverage): make test-all
|
166 |
702
|
aaronmk
|
|
167 |
3783
|
aaronmk
|
WinMerge setup:
|
168 |
|
|
Install WinMerge from <http://winmerge.org/>
|
169 |
3785
|
aaronmk
|
Open WinMerge
|
170 |
|
|
Go to Edit > Options and click Compare in the left sidebar
|
171 |
3783
|
aaronmk
|
Enable "Moved block detection", as described at
|
172 |
|
|
<http://manual.winmerge.org/Configuration.html#d0e5892>.
|
173 |
3784
|
aaronmk
|
Set Whitespace to Ignore change, as described at
|
174 |
|
|
<http://manual.winmerge.org/Configuration.html#d0e5758>.
|
175 |
3783
|
aaronmk
|
|
176 |
3133
|
aaronmk
|
Documentation:
|
177 |
|
|
To generate a Redmine-formatted list of steps for column-based import:
|
178 |
|
|
make inputs/QMOR/import/steps.by_col.sql
|
179 |
|
|
|
180 |
702
|
aaronmk
|
General:
|
181 |
|
|
To see a program's description, read its top-of-file comment
|
182 |
|
|
To see a program's usage, run it without arguments
|
183 |
3389
|
aaronmk
|
To remake a directory: make <dir>/remake
|
184 |
|
|
To remake a file: make <file>-remake
|