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