X-Git-Url: https://git.quassel-irc.org/?p=quassel.git;a=blobdiff_plain;f=src%2Fcore%2Fabstractsqlstorage.h;h=e422795be3b85a7781ffbaf284f51fb6f20c9d4d;hp=624489fc73d29bb51605148a10e2a629ced3c8db;hb=HEAD;hpb=cc6e7c08709c4e761e2fd9c2e322751015497003 diff --git a/src/core/abstractsqlstorage.h b/src/core/abstractsqlstorage.h index 624489fc..431c7ef2 100644 --- a/src/core/abstractsqlstorage.h +++ b/src/core/abstractsqlstorage.h @@ -1,5 +1,5 @@ /*************************************************************************** - * Copyright (C) 2005-2019 by the Quassel Project * + * Copyright (C) 2005-2022 by the Quassel Project * * devel@quassel-irc.org * * * * This program is free software; you can redistribute it and/or modify * @@ -21,13 +21,18 @@ #pragma once #include +#include +#include +#include #include #include #include #include "storage.h" +class QThread; + class AbstractSqlMigrationReader; class AbstractSqlMigrationWriter; @@ -42,6 +47,18 @@ public: virtual std::unique_ptr createMigrationReader() { return {}; } virtual std::unique_ptr createMigrationWriter() { return {}; } + /** + * An SQL query with associated resource filename + */ + struct SqlQueryResource { + QString queryString; ///< SQL query string + QString queryFilename; ///< Path to the resource file providing this query + + SqlQueryResource(const QString& queryString, const QString& queryFilename) + : queryString(std::move(queryString)), + queryFilename(std::move(queryFilename)) {} + }; + public slots: State init(const QVariantMap& settings = QVariantMap(), const QProcessEnvironment& environment = {}, @@ -74,18 +91,53 @@ protected: */ QString queryString(const QString& queryName, int version = 0); - QStringList setupQueries(); + /** + * Gets the collection of SQL setup queries and filenames to create a new database + * + * @return List of SQL query strings and filenames + */ + std::vector setupQueries(); - QStringList upgradeQueries(int ver); + /** + * Gets the collection of SQL upgrade queries and filenames for a given schema version + * + * @param ver SQL schema version + * @return List of SQL query strings and filenames + */ + std::vector upgradeQueries(int ver); bool upgradeDb(); bool watchQuery(QSqlQuery& query); int schemaVersion(); virtual int installedSchemaVersion() { return -1; }; - virtual bool updateSchemaVersion(int newVersion) = 0; + + /** + * Update the stored schema version number, optionally clearing the record of mid-schema steps + * + * @param newVersion New schema version number + * @param clearUpgradeStep If true, clear the record of any in-progress schema upgrades + * @return + */ + virtual bool updateSchemaVersion(int newVersion, bool clearUpgradeStep = true) = 0; + virtual bool setupSchemaVersion(int version) = 0; + /** + * Gets the last successful schema upgrade step, or an empty string if no upgrade is in progress + * + * @return Filename of last successful schema upgrade query, or empty string if not upgrading + */ + virtual QString schemaVersionUpgradeStep(); + + /** + * Sets the last successful schema upgrade step + * + * @param upgradeQuery The filename of the last successful schema upgrade query + * @return True if successfully set, otherwise false + */ + virtual bool setSchemaVersionUpgradeStep(QString upgradeQuery) = 0; + virtual void setConnectionProperties(const QVariantMap& properties, const QProcessEnvironment& environment, bool loadFromEnvironment) = 0; virtual QString driverName() = 0; inline virtual QString hostName() { return QString(); } @@ -221,6 +273,7 @@ public: QString awaymessage; QString attachperform; QString detachperform; + QString skipcaps; NetworkId networkid; IdentityId identityid; int messagerateburstsize;