diff options
| author | Daniel Friesel <derf@finalrewind.org> | 2019-04-29 10:25:17 +0200 |
|---|---|---|
| committer | Daniel Friesel <derf@finalrewind.org> | 2019-04-29 10:25:17 +0200 |
| commit | 6ff397c9b3b702805e248783243368a5dc5388b4 (patch) | |
| tree | 53771d5a4715263fe442fe933472230dc48f84e3 | |
| parent | fd6d12d355e5fb5596168b91affe71eb059c0e99 (diff) | |
add database table/column comments0.18
| -rw-r--r-- | lib/Travelynx/Command/database.pm | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/lib/Travelynx/Command/database.pm b/lib/Travelynx/Command/database.pm index bd22512..393564b 100644 --- a/lib/Travelynx/Command/database.pm +++ b/lib/Travelynx/Command/database.pm @@ -343,6 +343,39 @@ my @migrations = ( } ); }, + + # v5 -> v6 + # Add documentation + sub { + my ($db) = @_; + $db->query( + qq{ + comment on table in_transit is 'Users who are currently checked into a train'; + comment on view in_transit_str is 'in_transit with station IDs resolved to name/ds100'; + comment on table journey_stats is 'Cache for yearly and monthly statistics in JSON format'; + comment on table journeys is 'Past train trips (i.e. the user has already checked out)'; + comment on view journeys_str is 'journeys with station IDs resolved to name/ds100'; + comment on table pending_mails is 'Blacklist for mail addresses used in an unsuccessful registration attempt. Helps ensure that travelynx does not spam individual mails with registration attempts.'; + comment on table stations is 'Map of station IDs to name and DS100 code'; + comment on table tokens is 'User API tokens'; + comment on column in_transit.route is 'Format: station1|station2|station3|...'; + comment on column in_transit.messages is 'Format: epoch:message1|epoch:message2|...'; + comment on column in_transit_str.route is 'Format: station1|station2|station3|...'; + comment on column in_transit_str.messages is 'Format: epoch:message1|epoch:message2|...'; + comment on column journeys.edited is 'Bit mask indicating which part has been entered manually. 0x0001 = sched departure, 0x0002 = real departure, 0x0100 = sched arrival, 0x0200 = real arrival'; + comment on column journeys.route is 'Format: station1|station2|station3|...'; + comment on column journeys.messages is 'Format: epoch:message1|epoch:message2|...'; + comment on column journeys_str.edited is 'Bit mask indicating which part has been entered manually. 0x0001 = sched departure, 0x0002 = real departure, 0x0100 = sched arrival, 0x0200 = real arrival'; + comment on column journeys_str.route is 'Format: station1|station2|station3|...'; + comment on column journeys_str.messages is 'Format: epoch:message1|epoch:message2|...'; + comment on column users.status is 'Bit mask: 0x01 = verified'; + comment on column users.public_level is 'Bit mask indicating public account parts. 0x01 = current status (checkin from/to or last checkout at)'; + comment on column users.token is 'Used for e-mail verification'; + comment on column users.deletion_requested is 'Time at which account deletion was requested'; + update schema_version set version = 6; + } + ); + }, ); sub setup_db { |