From 0d15e8349c8014be0ab0dab766ce893699cad94c Mon Sep 17 00:00:00 2001 From: Shane Synan Date: Sat, 4 Mar 2017 22:57:51 -0600 Subject: [PATCH] Add documentation, clean up whitespace Maintain tabs in .sql files, remove extra newline. Add documentation to the setLastMsg function. This helps maintain consistency with the other files. --- src/core/SQL/PostgreSQL/20/setup_050_buffer.sql | 2 +- src/core/SQL/SQLite/21/setup_030_buffer.sql | 2 +- ...de_006_alter_table_buffer_new_rename_to_buffer.sql | 1 - src/core/postgresqlstorage.h | 11 +++++++++++ src/core/sqlitestorage.h | 11 +++++++++++ 5 files changed, 24 insertions(+), 3 deletions(-) diff --git a/src/core/SQL/PostgreSQL/20/setup_050_buffer.sql b/src/core/SQL/PostgreSQL/20/setup_050_buffer.sql index a6665b5c..a9206acb 100644 --- a/src/core/SQL/PostgreSQL/20/setup_050_buffer.sql +++ b/src/core/SQL/PostgreSQL/20/setup_050_buffer.sql @@ -6,7 +6,7 @@ create TABLE buffer ( buffername varchar(128) NOT NULL, buffercname varchar(128) NOT NULL, -- CANONICAL BUFFER NAME (lowercase version) buffertype integer NOT NULL DEFAULT 0, - lastmsgid integer NOT NULL DEFAULT 0, + lastmsgid integer NOT NULL DEFAULT 0, lastseenmsgid integer NOT NULL DEFAULT 0, markerlinemsgid integer NOT NULL DEFAULT 0, key varchar(128), diff --git a/src/core/SQL/SQLite/21/setup_030_buffer.sql b/src/core/SQL/SQLite/21/setup_030_buffer.sql index 53ea5429..952e20db 100644 --- a/src/core/SQL/SQLite/21/setup_030_buffer.sql +++ b/src/core/SQL/SQLite/21/setup_030_buffer.sql @@ -6,7 +6,7 @@ CREATE TABLE buffer ( buffername TEXT NOT NULL, buffercname TEXT NOT NULL, -- CANONICAL BUFFER NAME (lowercase version) buffertype INTEGER NOT NULL DEFAULT 0, - lastmsgid INTEGER NOT NULL DEFAULT 0, + lastmsgid INTEGER NOT NULL DEFAULT 0, lastseenmsgid INTEGER NOT NULL DEFAULT 0, markerlinemsgid INTEGER NOT NULL DEFAULT 0, key TEXT, diff --git a/src/core/SQL/SQLite/21/upgrade_006_alter_table_buffer_new_rename_to_buffer.sql b/src/core/SQL/SQLite/21/upgrade_006_alter_table_buffer_new_rename_to_buffer.sql index cda47146..991f19c8 100644 --- a/src/core/SQL/SQLite/21/upgrade_006_alter_table_buffer_new_rename_to_buffer.sql +++ b/src/core/SQL/SQLite/21/upgrade_006_alter_table_buffer_new_rename_to_buffer.sql @@ -1,2 +1 @@ ALTER TABLE buffer_new RENAME TO buffer; - diff --git a/src/core/postgresqlstorage.h b/src/core/postgresqlstorage.h index 062aa0ab..bffdb0d0 100644 --- a/src/core/postgresqlstorage.h +++ b/src/core/postgresqlstorage.h @@ -95,6 +95,17 @@ public slots: virtual QHash bufferLastSeenMsgIds(UserId user); virtual void setBufferMarkerLineMsg(UserId user, const BufferId &bufferId, const MsgId &msgId); virtual QHash bufferMarkerLineMsgIds(UserId user); + /** + * Sets the last known valid message ID for the given buffer. + * + * This limits LastSeenMsgIds from being set to message IDs in the future, improving performance + * when searching for messages in the backlog. + * + * @see PostgreSqlStorage::setBufferLastSeenMsg() + * + * @param bufferId[in] ID of the Buffer + * @param msgId[in] ID of latest message for this buffer + */ virtual void setBufferLastMsg(const BufferId &bufferId, const MsgId &msgId); /* Message handling */ diff --git a/src/core/sqlitestorage.h b/src/core/sqlitestorage.h index f66e70f5..e42feb4b 100644 --- a/src/core/sqlitestorage.h +++ b/src/core/sqlitestorage.h @@ -96,6 +96,17 @@ public slots: virtual QHash bufferLastSeenMsgIds(UserId user); virtual void setBufferMarkerLineMsg(UserId user, const BufferId &bufferId, const MsgId &msgId); virtual QHash bufferMarkerLineMsgIds(UserId user); + /** + * Sets the last known valid message ID for the given buffer. + * + * This limits LastSeenMsgIds from being set to message IDs in the future, improving performance + * when searching for messages in the backlog. + * + * @see SqliteStorage::setBufferLastSeenMsg() + * + * @param bufferId[in] ID of the Buffer + * @param msgId[in] ID of latest message for this buffer + */ virtual void setBufferLastMsg(const BufferId &bufferId, const MsgId &msgId); /* Message handling */ -- 2.20.1