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