Change database column comments for new installs.

Author: noplanman

structure.sql

@@ -1,10 +1,10 @@
 CREATE TABLE IF NOT EXISTS `user` (
-  `id` bigint COMMENT 'Unique user identifier',
-  `is_bot` tinyint(1) DEFAULT 0 COMMENT 'True if this user is a bot',
-  `first_name` CHAR(255) NOT NULL DEFAULT '' COMMENT 'User''s first name',
-  `last_name` CHAR(255) DEFAULT NULL COMMENT 'User''s last name',
-  `username` CHAR(191) DEFAULT NULL COMMENT 'User''s username',
-  `language_code` CHAR(10) DEFAULT NULL COMMENT 'User''s system language',
+  `id` bigint COMMENT 'Unique identifier for this user or bot',
+  `is_bot` tinyint(1) DEFAULT 0 COMMENT 'True, if this user is a bot',
+  `first_name` CHAR(255) NOT NULL DEFAULT '' COMMENT 'User''s or bot''s first name',
+  `last_name` CHAR(255) DEFAULT NULL COMMENT 'User''s or bot''s last name',
+  `username` CHAR(191) DEFAULT NULL COMMENT 'User''s or bot''s username',
+  `language_code` CHAR(10) DEFAULT NULL COMMENT 'IETF language tag of the user''s language',
   `created_at` timestamp NULL DEFAULT NULL COMMENT 'Entry date creation',
   `updated_at` timestamp NULL DEFAULT NULL COMMENT 'Entry date update',
 
@@ -13,9 +13,9 @@ CREATE TABLE IF NOT EXISTS `user` (
 ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_520_ci;
 
 CREATE TABLE IF NOT EXISTS `chat` (
-  `id` bigint COMMENT 'Unique user or chat identifier',
-  `type` ENUM('private', 'group', 'supergroup', 'channel') NOT NULL COMMENT 'Chat type, either private, group, supergroup or channel',
-  `title` CHAR(255) DEFAULT '' COMMENT 'Chat (group) title, is null if chat type is private',
+  `id` bigint COMMENT 'Unique identifier for this chat',
+  `type` ENUM('private', 'group', 'supergroup', 'channel') NOT NULL COMMENT 'Type of chat, can be either private, group, supergroup or channel',
+  `title` CHAR(255) DEFAULT '' COMMENT 'Title, for supergroups, channels and group chats',
   `username` CHAR(255) DEFAULT NULL COMMENT 'Username, for private chats, supergroups and channels if available',
   `first_name` CHAR(255) DEFAULT NULL COMMENT 'First name of the other party in a private chat',
   `last_name` CHAR(255) DEFAULT NULL COMMENT 'Last name of the other party in a private chat',
@@ -54,9 +54,9 @@ CREATE TABLE IF NOT EXISTS `inline_query` (
 
 CREATE TABLE IF NOT EXISTS `chosen_inline_result` (
   `id` bigint UNSIGNED AUTO_INCREMENT COMMENT 'Unique identifier for this entry',
-  `result_id` CHAR(255) NOT NULL DEFAULT '' COMMENT 'Identifier for this result',
-  `user_id` bigint NULL COMMENT 'Unique user identifier',
-  `location` CHAR(255) NULL DEFAULT NULL COMMENT 'Location object, user''s location',
+  `result_id` CHAR(255) NOT NULL DEFAULT '' COMMENT 'The unique identifier for the result that was chosen',
+  `user_id` bigint NULL COMMENT 'The user that chose the result',
+  `location` CHAR(255) NULL DEFAULT NULL COMMENT 'Sender location, only for bots that require user location',
   `inline_message_id` CHAR(255) NULL DEFAULT NULL COMMENT 'Identifier of the sent inline message',
   `query` TEXT NOT NULL COMMENT 'The query that was used to obtain the result',
   `created_at` timestamp NULL DEFAULT NULL COMMENT 'Entry date creation',
@@ -79,25 +79,25 @@ CREATE TABLE IF NOT EXISTS `message` (
   `forward_date` timestamp NULL DEFAULT NULL COMMENT 'date the original message was sent in timestamp format',
   `reply_to_chat` bigint NULL DEFAULT NULL COMMENT 'Unique chat identifier',
   `reply_to_message` bigint UNSIGNED DEFAULT NULL COMMENT 'Message that this message is reply to',
-  `edit_date` bigint UNSIGNED DEFAULT NULL COMMENT 'Optional. Date the message was last edited in Unix time',
+  `edit_date` bigint UNSIGNED DEFAULT NULL COMMENT 'Date the message was last edited in Unix time',
   `media_group_id` TEXT COMMENT 'The unique identifier of a media message group this message belongs to',
   `author_signature` TEXT COMMENT 'Signature of the post author for messages in channels',
   `text` TEXT COMMENT 'For text messages, the actual UTF-8 text of the message max message length 4096 char utf8mb4',
   `entities` TEXT COMMENT 'For text messages, special entities like usernames, URLs, bot commands, etc. that appear in the text',
   `caption_entities` TEXT COMMENT 'For messages with a caption, special entities like usernames, URLs, bot commands, etc. that appear in the caption',
   `audio` TEXT COMMENT 'Audio object. Message is an audio file, information about the file',
   `document` TEXT COMMENT 'Document object. Message is a general file, information about the file',
-  `animation` TEXT COMMENT 'Optional. Message is an animation, information about the animation',
+  `animation` TEXT COMMENT 'Message is an animation, information about the animation',
   `game` TEXT COMMENT 'Game object. Message is a game, information about the game',
   `photo` TEXT COMMENT 'Array of PhotoSize objects. Message is a photo, available sizes of the photo',
   `sticker` TEXT COMMENT 'Sticker object. Message is a sticker, information about the sticker',
   `video` TEXT COMMENT 'Video object. Message is a video, information about the video',
   `voice` TEXT COMMENT 'Voice Object. Message is a Voice, information about the Voice',
   `video_note` TEXT COMMENT 'VoiceNote Object. Message is a Video Note, information about the Video Note',
+  `caption` TEXT COMMENT  'For message with caption, the actual UTF-8 text of the caption',
   `contact` TEXT COMMENT 'Contact object. Message is a shared contact, information about the contact',
   `location` TEXT COMMENT 'Location object. Message is a shared location, information about the location',
   `venue` TEXT COMMENT 'Venue object. Message is a Venue, information about the Venue',
-  `caption` TEXT COMMENT  'For message with caption, the actual UTF-8 text of the caption',
   `new_chat_members` TEXT COMMENT 'List of unique user identifiers, new member(s) were added to the group, information about them (one of these members may be the bot itself)',
   `left_chat_member` bigint NULL DEFAULT NULL COMMENT 'Unique user identifier, a member was removed from the group, information about them (this member may be the bot itself)',
   `new_chat_title` CHAR(255) DEFAULT NULL COMMENT 'A chat title was changed to this value',
@@ -175,11 +175,11 @@ CREATE TABLE IF NOT EXISTS `edited_message` (
 CREATE TABLE IF NOT EXISTS `telegram_update` (
   `id` bigint UNSIGNED COMMENT 'Update''s unique identifier',
   `chat_id` bigint NULL DEFAULT NULL COMMENT 'Unique chat identifier',
-  `message_id` bigint UNSIGNED DEFAULT NULL COMMENT 'Unique message identifier',
-  `inline_query_id` bigint UNSIGNED DEFAULT NULL COMMENT 'Unique inline query identifier',
-  `chosen_inline_result_id` bigint UNSIGNED DEFAULT NULL COMMENT 'Local chosen inline result identifier',
-  `callback_query_id` bigint UNSIGNED DEFAULT NULL COMMENT 'Unique callback query identifier',
-  `edited_message_id` bigint UNSIGNED DEFAULT NULL COMMENT 'Local edited message identifier',
+  `message_id` bigint UNSIGNED DEFAULT NULL COMMENT 'New incoming message of any kind - text, photo, sticker, etc.',
+  `edited_message_id` bigint UNSIGNED DEFAULT NULL COMMENT 'New version of a message that is known to the bot and was edited',
+  `inline_query_id` bigint UNSIGNED DEFAULT NULL COMMENT 'New incoming inline query',
+  `chosen_inline_result_id` bigint UNSIGNED DEFAULT NULL COMMENT 'The result of an inline query that was chosen by a user and sent to their chat partner',
+  `callback_query_id` bigint UNSIGNED DEFAULT NULL COMMENT 'New incoming callback query',
 
   PRIMARY KEY (`id`),
   KEY `message_id` (`chat_id`, `message_id`),

utils/db-schema-update/0.54.0-unreleased.sql

@@ -1,8 +1,8 @@
 ALTER TABLE `chat` ADD COLUMN `first_name` CHAR(255) DEFAULT NULL COMMENT 'First name of the other party in a private chat' AFTER `username`;
 ALTER TABLE `chat` ADD COLUMN `last_name` CHAR(255) DEFAULT NULL COMMENT 'Last name of the other party in a private chat' AFTER `first_name`;
-ALTER TABLE `message` ADD COLUMN `animation` TEXT NULL COMMENT 'Optional. Message is an animation, information about the animation' AFTER `document`;
+ALTER TABLE `message` ADD COLUMN `animation` TEXT NULL COMMENT 'Message is an animation, information about the animation' AFTER `document`;
 ALTER TABLE `message` ADD COLUMN `forward_signature` TEXT COMMENT 'For messages forwarded from channels, signature of the post author if present' AFTER `forward_from_message_id`;
-ALTER TABLE `message` ADD COLUMN `edit_date` bigint UNSIGNED DEFAULT NULL COMMENT 'Optional. Date the message was last edited in Unix time' AFTER `reply_to_message`;
+ALTER TABLE `message` ADD COLUMN `edit_date` bigint UNSIGNED DEFAULT NULL COMMENT 'Date the message was last edited in Unix time' AFTER `reply_to_message`;
 ALTER TABLE `message` ADD COLUMN `author_signature` TEXT COMMENT 'Signature of the post author for messages in channels' AFTER `media_group_id`;
 ALTER TABLE `message` ADD COLUMN `caption_entities` TEXT COMMENT 'For messages with a caption, special entities like usernames, URLs, bot commands, etc. that appear in the caption';
 ALTER TABLE `message` ADD COLUMN `invoice` TEXT NULL COMMENT 'Message is an invoice for a payment, information about the invoice' AFTER `pinned_message`;