|
1
|
Installation:
|
|
2
|
Install: make install
|
|
3
|
WARNING: This will delete the current public schema of your VegBIEN DB!
|
|
4
|
Uninstall: make uninstall
|
|
5
|
WARNING: This will delete your entire VegBIEN DB!
|
|
6
|
This includes all archived imports and staging tables.
|
|
7
|
Reinstall all datasources at once: . bin/reinstall_all
|
|
8
|
|
|
9
|
Data import:
|
|
10
|
Import data into VegBIEN: . bin/import_all
|
|
11
|
Using column-based import: . bin/with_all 'import by_col=1'
|
|
12
|
Stop all running imports: . bin/stop_imports
|
|
13
|
Archive the last import: make schemas/rotate
|
|
14
|
Remove the last import: make schemas/public/reinstall
|
|
15
|
WARNING: This will delete the current public schema of your VegBIEN DB!
|
|
16
|
Re-import data: make schemas/rotate; . bin/import_all
|
|
17
|
Note: This will archive the last import.
|
|
18
|
|
|
19
|
Backups:
|
|
20
|
After a new import:
|
|
21
|
make schemas/rotate
|
|
22
|
Rename the rotated schema using the date in the first datasource's log
|
|
23
|
file name
|
|
24
|
Delete previous imports so they won't bloat the full DB backup:
|
|
25
|
make backups/public.<date>.backup/remove
|
|
26
|
make backups/<schema>.backup/test & make backups/vegbien.backup/all &
|
|
27
|
Archived imports:
|
|
28
|
Back up: make backups/public.<date>.backup &
|
|
29
|
Note: To back up the last import, you must archive it first (above)
|
|
30
|
Test: make backups/public.<date>.backup/test &
|
|
31
|
Restore: make backups/public.<date>.backup/restore &
|
|
32
|
Remove: make backups/public.<date>.backup/remove
|
|
33
|
Full DB:
|
|
34
|
Back up, test, and rotate: make backups/vegbien.backup/all &
|
|
35
|
Back up and rotate: make backups/vegbien.backup/rotate &
|
|
36
|
Test: make backups/vegbien.<date>.backup/test &
|
|
37
|
Restore: make backups/vegbien.<date>.backup/restore &
|
|
38
|
|
|
39
|
Datasource setup:
|
|
40
|
Add a new datasource: make inputs/<short_name>/add
|
|
41
|
If the datasource is a herbarium, <short_name> should be the herbarium
|
|
42
|
code as defined by the Index Herbariorum <http://sweetgum.nybg.org/ih/>
|
|
43
|
Populate the src/ subdir with input data:
|
|
44
|
Obtain/create CSVs for the tables present in the datasource:
|
|
45
|
specimens, plots, organisms, stems
|
|
46
|
Rename each CSV so it ends in ".<table>.<ext>" (see tables above)
|
|
47
|
Auto-create the src column spreadsheets: make inputs/<short_name>/
|
|
48
|
|
|
49
|
Schema changes:
|
|
50
|
Regenerate schema from installed DB: make schemas/remake
|
|
51
|
Reinstall DB from schema: make schemas/reinstall
|
|
52
|
WARNING: This will delete the current public schema of your VegBIEN DB!
|
|
53
|
Reinstall errors tables: make inputs/install errors_table_only=1
|
|
54
|
Sync ERD with vegbien.sql schema:
|
|
55
|
Run make schemas/vegbien.my.sql
|
|
56
|
Open schemas/vegbien.ERD.mwb in MySQLWorkbench
|
|
57
|
Go to File > Export > Synchronize With SQL CREATE Script...
|
|
58
|
For Input File, select schemas/vegbien.my.sql
|
|
59
|
Click Continue
|
|
60
|
Click in the changes list and press Ctrl+A or Apple+A to select all
|
|
61
|
Click Update Model
|
|
62
|
Click Continue
|
|
63
|
Note: The generated SQL script will be empty because we are syncing in
|
|
64
|
the opposite direction
|
|
65
|
Click Execute
|
|
66
|
Reposition any lines that have been reset
|
|
67
|
Add any new tables by dragging them from the Catalog in the left sidebar
|
|
68
|
to the diagram
|
|
69
|
Remove any deleted tables by right-clicking the table's diagram element,
|
|
70
|
selecting Delete '<table name>', and clicking Delete
|
|
71
|
Save
|
|
72
|
If desired, update the graphical ERD exports (see below)
|
|
73
|
Update graphical ERD exports:
|
|
74
|
Go to File > Export > Export as PNG...
|
|
75
|
Select schemas/vegbien.ERD.png and click Save
|
|
76
|
Go to File > Export > Export as SVG...
|
|
77
|
Select schemas/vegbien.ERD.svg and click Save
|
|
78
|
Go to File > Export > Export as Single Page PDF...
|
|
79
|
Select schemas/vegbien.ERD.pdf and click Save
|
|
80
|
Go to File > Print...
|
|
81
|
For Pages, choose From 1 To 1
|
|
82
|
In the lower left corner, click PDF > Save as PDF...
|
|
83
|
Set the Title and Author to ""
|
|
84
|
Select schemas/vegbien.ERD.core.pdf and click Save
|
|
85
|
|
|
86
|
Testing:
|
|
87
|
Mapping process: make test
|
|
88
|
Map spreadsheet generation: make remake
|
|
89
|
Missing mappings: make missing_mappings
|
|
90
|
Everything (for most complete coverage): make test-all
|
|
91
|
|
|
92
|
Documentation:
|
|
93
|
To generate a Redmine-formatted list of steps for column-based import:
|
|
94
|
make inputs/QMOR/import/steps.by_col.sql
|
|
95
|
|
|
96
|
General:
|
|
97
|
To see a program's description, read its top-of-file comment
|
|
98
|
To see a program's usage, run it without arguments
|
|
99
|
To remake a directory: make <dir>/remake
|
|
100
|
To remake a file: make <file>-remake
|
