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