Project

General

Profile

1
Installation:
2
    Install: make install
3
        WARNING: This will delete any existing VegBIEN DB!
4
    Uninstall: make uninstall
5
        WARNING: This will delete your VegBIEN DB!
6
    Reinstall all datasources at once: . bin/reinstall_all
7

    
8
Data import:
9
    Import data into VegBIEN: . bin/import_all
10
        Using column-based import: . bin/with_all 'import by_col=1'
11
    Stop all running imports: . bin/stop_imports
12
    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
    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
    Empty the DB: make schemas/reinstall
18
        WARNING: This will delete your VegBIEN DB!
19

    
20
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
Schema changes:
26
    Regenerate schema from installed DB: make schemas/remake
27
    Reinstall DB from schema: make schemas/reinstall
28
        WARNING: This will delete your VegBIEN DB!
29
    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
        If desired, update the graphical ERD exports (see below)
48
    Update graphical ERD exports:
49
        Go to File > Export > Export as PNG...
50
        Select schemas/vegbien.ERD.png and click Save
51
        Go to File > Export > Export as SVG...
52
        Select schemas/vegbien.ERD.svg and click Save
53
        Go to File > Export > Export as Single Page PDF...
54
        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

    
61
Testing:
62
    Mapping process: make test
63
    Map spreadsheet generation: make remake
64
    Missing mappings: make missing_mappings
65
    Everything (for most complete coverage): make test-all
66

    
67
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
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
(2-2/3)