Project

General

Profile

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
        This includes all public schema versions and staging tables.
7 1957 aaronmk
    Reinstall all datasources at once: . bin/reinstall_all
8 554 aaronmk
9 702 aaronmk
Data import:
10 1550 aaronmk
    Import data into VegBIEN: . bin/import_all
11 3205 aaronmk
        Using column-based import: . bin/with_all 'import by_col=1'
12 1556 aaronmk
    Stop all running imports: . bin/stop_imports
13 2976 aaronmk
    Archive the last import: make schemas/rotate
14
    Re-import data: make schemas/rotate; . bin/import_all
15
        Note: This will archive the last import.
16 3369 aaronmk
    Back up an archived import: make schemas/public.<date>.backup &
17
        Note: To back up the last import, you must archive it first (see above)
18 3373 aaronmk
    Restore an archived import: make schemas/public.<date>.backup/restore &
19 2976 aaronmk
    Empty the DB: make schemas/reinstall
20 3370 aaronmk
        WARNING: This will delete the current public schema of your VegBIEN DB!
21 554 aaronmk
22 1773 aaronmk
Datasource setup:
23
    Add a new datasource: make inputs/<short_name>/add
24
        If the datasource is a herbarium, <short_name> should be the herbarium
25
        code as defined by the Index Herbariorum <http://sweetgum.nybg.org/ih/>
26
27 702 aaronmk
Schema changes:
28
    Regenerate schema from installed DB: make schemas/remake
29 1967 aaronmk
    Reinstall DB from schema: make schemas/reinstall
30 3370 aaronmk
        WARNING: This will delete the current public schema of your VegBIEN DB!
31 702 aaronmk
    Sync ERD with vegbien.sql schema:
32
        Run make schemas/vegbien.my.sql
33
        Open schemas/vegbien.ERD.mwb in MySQLWorkbench
34
        Go to File > Export > Synchronize With SQL CREATE Script...
35
        For Input File, select schemas/vegbien.my.sql
36
        Click Continue
37
        Click in the changes list and press Ctrl+A or Apple+A to select all
38
        Click Update Model
39
        Click Continue
40
        Note: The generated SQL script will be empty because we are syncing in
41
            the opposite direction
42
        Click Execute
43
        Reposition any lines that have been reset
44
        Add any new tables by dragging them from the Catalog in the left sidebar
45
            to the diagram
46
        Remove any deleted tables by right-clicking the table's diagram element,
47
            selecting Delete '<table name>', and clicking Delete
48
        Save
49 1774 aaronmk
        If desired, update the graphical ERD exports (see below)
50
    Update graphical ERD exports:
51 702 aaronmk
        Go to File > Export > Export as PNG...
52 1774 aaronmk
        Select schemas/vegbien.ERD.png and click Save
53 702 aaronmk
        Go to File > Export > Export as SVG...
54 1774 aaronmk
        Select schemas/vegbien.ERD.svg and click Save
55 702 aaronmk
        Go to File > Export > Export as Single Page PDF...
56 1774 aaronmk
        Select schemas/vegbien.ERD.pdf and click Save
57
        Go to File > Print...
58
        For Pages, choose From 1 To 1
59
        In the lower left corner, click PDF > Save as PDF...
60
        Set the Title and Author to ""
61
        Select schemas/vegbien.ERD.core.pdf and click Save
62 203 aaronmk
63 1459 aaronmk
Testing:
64
    Mapping process: make test
65
    Map spreadsheet generation: make remake
66 1744 aaronmk
    Missing mappings: make missing_mappings
67 1459 aaronmk
    Everything (for most complete coverage): make test-all
68 702 aaronmk
69 3133 aaronmk
Documentation:
70
    To generate a Redmine-formatted list of steps for column-based import:
71
        make inputs/QMOR/import/steps.by_col.sql
72
73 702 aaronmk
General:
74
    To see a program's description, read its top-of-file comment
75
    To see a program's usage, run it without arguments