X-Git-Url: https://git.quassel-irc.org/?p=quassel.git;a=blobdiff_plain;f=src%2Fcore%2Fabstractsqlstorage.h;h=c911732a40c44fc69c373e7c7f6a55656c97b22d;hp=adf35fdbfbb6387c64de8d16a7d712ccba256ebc;hb=c3263d1f2db00c39c2057b4126f9a1599d7f9570;hpb=a65f42197839da536975b3e2858eedcef420035f diff --git a/src/core/abstractsqlstorage.h b/src/core/abstractsqlstorage.h index adf35fdb..c911732a 100644 --- a/src/core/abstractsqlstorage.h +++ b/src/core/abstractsqlstorage.h @@ -24,6 +24,7 @@ #include +#include #include #include #include @@ -42,6 +43,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: virtual State init(const QVariantMap &settings = QVariantMap(), const QProcessEnvironment &environment = {}, @@ -74,18 +87,52 @@ 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 + */ + QList 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 + */ + QList 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;