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