Project

General

Profile

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