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 4487 aaronmk
    On local machine:
16
        make test by_col=1
17
            If you get errors (including skipped errors), this always indicates
18
            a bug, usually in either the unique constraints or column-based
19
            import itself
20
            Note that inserted row count diffs of a few rows are benign
21
    On vegbiendev:
22 4482 aaronmk
    svn up
23
    Update the schemas: make schemas/reinstall
24
        WARNING: This will delete the current public schema of your VegBIEN DB!
25
        To save it: make schemas/rotate
26 4481 aaronmk
    Start column-based import: . bin/with_all 'import by_col=1'
27
        To use row-based import: . bin/import_all
28
        To stop all running imports: . bin/stop_imports
29
    Wait (overnight) for the import to finish
30
    ./bin/make_analytical_db &
31
    Wait for make_analytical_db to finish
32 2976 aaronmk
    Archive the last import: make schemas/rotate
33 4790 aaronmk
        Important: This must be done *after* running make_analytical_db
34 4481 aaronmk
    Rename the rotated schema using the date in the first datasource's log
35
        file name
36
    tail inputs/*/*/logs/<date>-*.log.sql
37
    Check that every input's log ends in "Encountered 0 error(s)"
38
    If many do not, fix the bug and discard the current (partial) import:
39
        make schemas/public/reinstall
40
    Otherwise, continue
41
    Delete previous imports so they won't bloat the full DB backup:
42
        make backups/public.<datetime>.backup/remove
43 4751 aaronmk
    make backups/public.<datetime>.backup/test &
44
    make backups/vegbien.<datetime>.backup/test &
45 4481 aaronmk
    On local machine:
46
        make inputs/download-logs
47 4623 aaronmk
        make backups/download
48 4677 aaronmk
    If desired, record the import times in inputs/import.stats.xls:
49
        Open inputs/import.stats.xls
50
        Insert a copy of the leftmost Column-based column group before it
51
        Update the import date in the upper-right corner
52
        ./bin/import_times inputs/*/*/logs/<date>-*.log.sql
53
        Paste the output over the # Rows/Time columns, making sure that the
54
            row counts match up with the previous import's row counts
55
        If the row counts do not match up, insert or reorder rows as needed
56
            until they do
57 4777 aaronmk
        Commit: svn ci -m "inputs/import.stats.xls: Updated import times"
58 3381 aaronmk
59 3545 aaronmk
Backups:
60 3408 aaronmk
    Archived imports:
61
        Back up: make backups/public.<date>.backup &
62 3546 aaronmk
            Note: To back up the last import, you must archive it first (above)
63 3410 aaronmk
        Test: make backups/public.<date>.backup/test &
64 3408 aaronmk
        Restore: make backups/public.<date>.backup/restore &
65
        Remove: make backups/public.<date>.backup/remove
66 3701 aaronmk
        Download: make backups/download
67 3408 aaronmk
    Full DB:
68 3546 aaronmk
        Back up, test, and rotate: make backups/vegbien.backup/all &
69 3439 aaronmk
        Back up and rotate: make backups/vegbien.backup/rotate &
70
        Test: make backups/vegbien.<date>.backup/test &
71
        Restore: make backups/vegbien.<date>.backup/restore &
72 3701 aaronmk
        Download: make backups/download
73 3698 aaronmk
    Import logs:
74
        Download: make inputs/download-logs
75 554 aaronmk
76 1773 aaronmk
Datasource setup:
77 4219 aaronmk
    Add a new datasource: make inputs/<datasrc>/add
78
        <datasrc> may not contain spaces, and should be abbreviated.
79
        If the datasource is a herbarium, <datasrc> should be the herbarium code
80
            as defined by the Index Herbariorum <http://sweetgum.nybg.org/ih/>
81 4360 aaronmk
    Install any MySQL export:
82
        Create database in phpMyAdmin
83
        mysql -p database <export.sql
84 4218 aaronmk
    Add input data for each table present in the datasource:
85
        Choose a table name from <https://projects.nceas.ucsb.edu/nceas/projects
86
            /bien/wiki/VegCSV#Suggested-table-names>, or use a custom name
87 4264 aaronmk
        Note that if this table will be joined together with another table, its
88
            name must end in ".src"
89 4219 aaronmk
        make inputs/<datasrc>/<table>/add
90 4342 aaronmk
            Important: DO NOT just create an empty directory named <table>!
91
                This command also creates necessary subdirs, such as logs/.
92 4219 aaronmk
        Place the CSV for the table in inputs/<datasrc>/<table>/
93 4264 aaronmk
            OR place a query joining other tables together in
94
            inputs/<datasrc>/<table>/create.sql and svn add this file
95 4212 aaronmk
        Important: When exporting relational databases to CSVs, you MUST ensure
96
            that embedded quotes are escaped by doubling them, *not* by
97
            preceding them with a "\" as is the default in phpMyAdmin
98 3612 aaronmk
        If there are multiple part files for a table, and the header is repeated
99
            in each part, make sure each header is EXACTLY the same.
100
             (If the headers are not the same, the CSV concatenation script
101
             assumes the part files don't have individual headers and treats the
102
             subsequent headers as data rows.)
103 4255 aaronmk
        Add <table> to inputs/<datasrc>/import_order.txt before other tables
104 4220 aaronmk
            that depend on it
105 3593 aaronmk
    Auto-create the map spreadsheets:
106 4644 aaronmk
        make inputs/<datasrc>/
107 4645 aaronmk
        svn add inputs/<datasrc>/*/{,.}{header,map,*terms,VegBIEN}.csv{,.*}
108 3611 aaronmk
    Install the staging tables:
109 4219 aaronmk
        make inputs/<datasrc>/reinstall quiet=1 &
110
        To view progress: tail -f inputs/<datasrc>/<table>/logs/install.log.sql
111
        View the logs: tail -n +1 inputs/<datasrc>/*/logs/install.log.sql
112 3611 aaronmk
            tail provides a header line with the filename
113
            +1 starts at the first line, to show the whole file
114
        For every file with an error 'column "..." specified more than once':
115 4182 aaronmk
            Add a header override file "+header.<ext>" in <table>/:
116 3611 aaronmk
                Note: The leading "+" should sort it before the flat files.
117
                    "_" unfortunately sorts *after* capital letters in ASCII.
118
                Create a text file containing the header line of the flat files
119
                Add an ! at the beginning of the line
120
                    This signals cat_csv that this is a header override.
121
                For empty names, use their 0-based column # (by convention)
122
                For duplicate names, add a distinguishing suffix
123
                For long names that collided, rename them to <= 63 chars long
124
                Do NOT make readability changes in this step; that is what the
125
                    map spreadsheets (below) are for.
126
                Save
127 4219 aaronmk
                svn add inputs/<datasrc>/<table>/<header_override>
128 3611 aaronmk
        If you made any changes, re-run the install command above
129 3576 aaronmk
    Map each table's columns:
130 4125 aaronmk
        In each <table>/ subdir, for each "via map" map.csv:
131 3576 aaronmk
            Open the map in a spreadsheet editor
132 4125 aaronmk
            Open the "core map" /mappings/Veg+-VegBIEN.csv
133 3576 aaronmk
            In each row of the via map, set the right column to a value from the
134
                left column of the core map
135
            Save
136 4219 aaronmk
        Regenerate the derived maps: make inputs/<datasrc>/
137 3593 aaronmk
    Accept the test cases:
138 4219 aaronmk
        make inputs/<datasrc>/test
139 3593 aaronmk
            When prompted to "Accept new test output", enter y and press ENTER
140 3690 aaronmk
            If you instead get errors, do one of the following for each one:
141
            -   If the error was due to a bug, fix it
142
            -   Add a SQL function that filters or transforms the invalid data
143
            -   Make an empty mapping for the columns that produced the error.
144
                Put something in the Comments column of the map spreadsheet to
145
                prevent the automatic mapper from auto-removing the mapping.
146 3783 aaronmk
            When accepting tests, it's helpful to use WinMerge
147
                (see WinMerge setup below for configuration)
148 4476 aaronmk
        make inputs/<datasrc>/test by_col=1
149
            If you get errors this time, this always indicates a bug, usually in
150
                either the unique constraints or column-based import itself
151 4219 aaronmk
        svn add inputs/<datasrc>/*/test.xml.ref
152
    Commit: svn ci -m "Added inputs/<datasrc>/" inputs/<datasrc>/
153 3585 aaronmk
    Update vegbiendev:
154
        On vegbiendev: svn up
155
        On local machine: make inputs/upload
156 4291 aaronmk
        On vegbiendev:
157
            Follow the steps under Install the staging tables above
158
            make inputs/<datasrc>/test
159 1773 aaronmk
160 702 aaronmk
Schema changes:
161
    Regenerate schema from installed DB: make schemas/remake
162 1967 aaronmk
    Reinstall DB from schema: make schemas/reinstall
163 3370 aaronmk
        WARNING: This will delete the current public schema of your VegBIEN DB!
164 3589 aaronmk
    Reinstall staging tables: . bin/reinstall_all
165 702 aaronmk
    Sync ERD with vegbien.sql schema:
166
        Run make schemas/vegbien.my.sql
167
        Open schemas/vegbien.ERD.mwb in MySQLWorkbench
168
        Go to File > Export > Synchronize With SQL CREATE Script...
169
        For Input File, select schemas/vegbien.my.sql
170
        Click Continue
171
        Click in the changes list and press Ctrl+A or Apple+A to select all
172
        Click Update Model
173
        Click Continue
174
        Note: The generated SQL script will be empty because we are syncing in
175
            the opposite direction
176
        Click Execute
177
        Reposition any lines that have been reset
178
        Add any new tables by dragging them from the Catalog in the left sidebar
179
            to the diagram
180
        Remove any deleted tables by right-clicking the table's diagram element,
181
            selecting Delete '<table name>', and clicking Delete
182
        Save
183 1774 aaronmk
        If desired, update the graphical ERD exports (see below)
184
    Update graphical ERD exports:
185 702 aaronmk
        Go to File > Export > Export as PNG...
186 1774 aaronmk
        Select schemas/vegbien.ERD.png and click Save
187 702 aaronmk
        Go to File > Export > Export as SVG...
188 1774 aaronmk
        Select schemas/vegbien.ERD.svg and click Save
189 702 aaronmk
        Go to File > Export > Export as Single Page PDF...
190 4087 aaronmk
        Select schemas/vegbien.ERD.1_pg.pdf and click Save
191 1774 aaronmk
        Go to File > Print...
192
        In the lower left corner, click PDF > Save as PDF...
193
        Set the Title and Author to ""
194 4087 aaronmk
        Select schemas/vegbien.ERD.pdf and click Save
195 203 aaronmk
196 1459 aaronmk
Testing:
197
    Mapping process: make test
198 4292 aaronmk
        Including column-based import: make test by_col=1
199 1459 aaronmk
    Map spreadsheet generation: make remake
200 1744 aaronmk
    Missing mappings: make missing_mappings
201 1459 aaronmk
    Everything (for most complete coverage): make test-all
202 702 aaronmk
203 3783 aaronmk
WinMerge setup:
204
    Install WinMerge from <http://winmerge.org/>
205 3785 aaronmk
    Open WinMerge
206
    Go to Edit > Options and click Compare in the left sidebar
207 3783 aaronmk
    Enable "Moved block detection", as described at
208
        <http://manual.winmerge.org/Configuration.html#d0e5892>.
209 3784 aaronmk
    Set Whitespace to Ignore change, as described at
210
        <http://manual.winmerge.org/Configuration.html#d0e5758>.
211 3783 aaronmk
212 3133 aaronmk
Documentation:
213
    To generate a Redmine-formatted list of steps for column-based import:
214 4486 aaronmk
        make inputs/QMOR/Specimen/logs/steps.by_col.log.sql
215 3133 aaronmk
216 702 aaronmk
General:
217
    To see a program's description, read its top-of-file comment
218
    To see a program's usage, run it without arguments
219 3389 aaronmk
    To remake a directory: make <dir>/remake
220
    To remake a file: make <file>-remake