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