Move MIGRATIONS list into dedicated migrations module

Author: tankyleo

rust/impls/src/lib.rs

@@ -11,6 +11,7 @@
 #![deny(rustdoc::private_intra_doc_links)]
 #![deny(missing_docs)]
 
+mod migrations;
 /// Contains [PostgreSQL](https://www.postgresql.org/) based backend implementation for VSS.
 pub mod postgres_store;
 

rust/impls/src/migrations.rs

@@ -0,0 +1,39 @@
+pub(crate) const DB_VERSION_COLUMN: &str = "db_version";
+#[cfg(test)]
+pub(crate) const MIGRATION_LOG_COLUMN: &str = "upgrade_from";
+
+pub(crate) const CHECK_DB_STMT: &str = "SELECT 1 FROM pg_database WHERE datname = $1";
+pub(crate) const INIT_DB_CMD: &str = "CREATE DATABASE";
+#[cfg(test)]
+const DROP_DB_CMD: &str = "DROP DATABASE";
+pub(crate) const GET_VERSION_STMT: &str = "SELECT db_version FROM vss_db_version;";
+pub(crate) const UPDATE_VERSION_STMT: &str = "UPDATE vss_db_version SET db_version=$1;";
+pub(crate) const LOG_MIGRATION_STMT: &str = "INSERT INTO vss_db_upgrades VALUES($1);";
+#[cfg(test)]
+pub(crate) const GET_MIGRATION_LOG_STMT: &str = "SELECT upgrade_from FROM vss_db_upgrades;";
+
+// APPEND-ONLY list of migration statements
+//
+// Each statement MUST be applied in-order, and only once per database.
+//
+// We make an exception for the vss_db table creation statement, as users of VSS could have initialized the table
+// themselves.
+pub(crate) const MIGRATIONS: &[&str] = &[
+	"CREATE TABLE vss_db_version (db_version INTEGER);",
+	"INSERT INTO vss_db_version VALUES(1);",
+	// A write-only log of all the migrations performed on this database, useful for debugging and testing
+	"CREATE TABLE vss_db_upgrades (upgrade_from INTEGER);",
+	// We do not complain if the table already exists, as users of VSS could have already created this table
+	"CREATE TABLE IF NOT EXISTS vss_db (
+	    user_token character varying(120) NOT NULL CHECK (user_token <> ''),
+	    store_id character varying(120) NOT NULL CHECK (store_id <> ''),
+	    key character varying(600) NOT NULL,
+	    value bytea NULL,
+	    version bigint NOT NULL,
+	    created_at TIMESTAMP WITH TIME ZONE,
+	    last_updated_at TIMESTAMP WITH TIME ZONE,
+	    PRIMARY KEY (user_token, store_id, key)
+	);",
+];
+#[cfg(test)]
+const DUMMY_MIGRATION: &str = "SELECT 1 WHERE FALSE;";

rust/impls/src/postgres_store.rs

@@ -1,3 +1,5 @@
+use crate::migrations::*;
+
 use api::error::VssError;
 use api::kv_store::{KvStore, GLOBAL_VERSION_KEY, INITIAL_RECORD_VERSION};
 use api::types::{
@@ -27,46 +29,6 @@ const KEY_COLUMN: &str = "key";
 const VALUE_COLUMN: &str = "value";
 const VERSION_COLUMN: &str = "version";
 
-const DB_VERSION_COLUMN: &str = "db_version";
-#[cfg(test)]
-const MIGRATION_LOG_COLUMN: &str = "upgrade_from";
-
-const CHECK_DB_STMT: &str = "SELECT 1 FROM pg_database WHERE datname = $1";
-const INIT_DB_CMD: &str = "CREATE DATABASE";
-#[cfg(test)]
-const DROP_DB_CMD: &str = "DROP DATABASE";
-const GET_VERSION_STMT: &str = "SELECT db_version FROM vss_db_version;";
-const UPDATE_VERSION_STMT: &str = "UPDATE vss_db_version SET db_version=$1;";
-const LOG_MIGRATION_STMT: &str = "INSERT INTO vss_db_upgrades VALUES($1);";
-#[cfg(test)]
-const GET_MIGRATION_LOG_STMT: &str = "SELECT upgrade_from FROM vss_db_upgrades;";
-
-// APPEND-ONLY list of migration statements
-//
-// Each statement MUST be applied in-order, and only once per database.
-//
-// We make an exception for the vss_db table creation statement, as users of VSS could have initialized the table
-// themselves.
-const MIGRATIONS: &[&str] = &[
-	"CREATE TABLE vss_db_version (db_version INTEGER);",
-	"INSERT INTO vss_db_version VALUES(1);",
-	// A write-only log of all the migrations performed on this database, useful for debugging and testing
-	"CREATE TABLE vss_db_upgrades (upgrade_from INTEGER);",
-	// We do not complain if the table already exists, as users of VSS could have already created this table
-	"CREATE TABLE IF NOT EXISTS vss_db (
-	    user_token character varying(120) NOT NULL CHECK (user_token <> ''),
-	    store_id character varying(120) NOT NULL CHECK (store_id <> ''),
-	    key character varying(600) NOT NULL,
-	    value bytea NULL,
-	    version bigint NOT NULL,
-	    created_at TIMESTAMP WITH TIME ZONE,
-	    last_updated_at TIMESTAMP WITH TIME ZONE,
-	    PRIMARY KEY (user_token, store_id, key)
-	);",
-];
-#[cfg(test)]
-const DUMMY_MIGRATION: &str = "SELECT 1 WHERE FALSE;";
-
 /// The maximum number of key versions that can be returned in a single page.
 ///
 /// This constant helps control memory and bandwidth usage for list operations,