Struct sql_migration_tests::test_api::TestApi

pub struct TestApi {
    pub connector: SqlSchemaConnector,
    /* private fields */
}

Fields

connector: SqlSchemaConnector

Implementations

impl TestApi

pub fn new(args: TestApiArgs) -> Self

Initializer, called by the test macros.

pub fn args(&self) -> &TestApiArgs

pub fn apply_migrations<'a>( &'a mut self, migrations_directory: &'a TempDir ) -> ApplyMigrations<'a>

Plan an applyMigrations command

pub fn connection_string(&self) -> &str

pub fn connection_info(&self) -> ConnectionInfo

pub fn ensure_connection_validity(&mut self) -> ConnectorResult<()>

pub fn schema_name(&self) -> String

pub fn create_migration<'a>( &'a mut self, name: &'a str, schema: &'a str, migrations_directory: &'a TempDir ) -> CreateMigration<'a>

Plan a createMigration command

pub fn create_migrations_directory(&self) -> TempDir

Create a temporary directory to serve as a test migrations directory.

pub fn dev_diagnostic<'a>( &'a mut self, migrations_directory: &'a TempDir ) -> DevDiagnostic<'a>

Builder and assertions to call the devDiagnostic command.

pub fn diagnose_migration_history<'a>( &'a mut self, migrations_directory: &'a TempDir ) -> DiagnoseMigrationHistory<'a>

pub fn diff(&self, params: DiffParams) -> ConnectorResult<DiffResult>

pub fn dump_table(&mut self, table_name: &str) -> ResultSet

pub fn evaluate_data_loss<'a>( &'a mut self, migrations_directory: &'a TempDir, schema: String ) -> EvaluateDataLoss<'a>

pub fn is_mssql(&self) -> bool

Returns true only when testing on MSSQL.

pub fn is_mariadb(&self) -> bool

Returns true only when testing on MariaDB.

pub fn is_mysql(&self) -> bool

Returns true only when testing on MySQL.

pub fn is_mysql_mariadb(&self) -> bool

Returns true only when testing on MariaDB.

pub fn is_mysql_5_6(&self) -> bool

Returns true only when testing on MySQL 5.6.

pub fn is_mysql_8(&self) -> bool

Returns true only when testing on MySQL 8.

pub fn is_postgres(&self) -> bool

Returns true only when testing on postgres.

pub fn is_postgres_15(&self) -> bool

Returns true only when testing on postgres version 15.

pub fn is_postgres_16(&self) -> bool

Returns true only when testing on postgres version 16.

pub fn is_cockroach(&self) -> bool

Returns true only when testing on cockroach.

pub fn is_sqlite(&self) -> bool

Returns true only when testing on sqlite.

pub fn is_vitess(&self) -> bool

Returns true only when testing on vitess.

pub fn max_ddl_refresh_delay(&self) -> Option<Duration>

Returns a duration that is guaranteed to be larger than the maximum refresh rate after a DDL statement

pub fn insert<'a>(&'a mut self, table_name: &'a str) -> SingleRowInsert<'a>

Insert test values

pub fn list_migration_directories<'a>( &'a mut self, migrations_directory: &'a TempDir ) -> ListMigrationDirectories<'a>

pub fn lower_cases_table_names(&self) -> bool

pub fn mark_migration_applied<'a>( &'a mut self, migration_name: impl Into<String>, migrations_directory: &'a TempDir ) -> MarkMigrationApplied<'a>

pub fn mark_migration_rolled_back( &mut self, migration_name: impl Into<String> ) -> MarkMigrationRolledBack<'_>

pub fn migration_persistence<'a>( &'a mut self ) -> &mut (dyn MigrationPersistence + 'a)

pub fn assert_schema(&mut self) -> SchemaAssertion

Assert facts about the database schema

pub fn assert_schema_with_namespaces( &mut self, namespaces: Option<Namespaces> ) -> SchemaAssertion

pub fn datasource_block(&self) -> DatasourceBlock<'_>

Render a valid datasource block, including database URL.

pub fn datasource_block_with<'a>( &'a self, params: &'a [(&'a str, &'a str)] ) -> DatasourceBlock<'a>

pub fn connector_diff( &mut self, from: DiffTarget<'_>, to: DiffTarget<'_>, namespaces: Option<Namespaces> ) -> String

Generate a migration script using MigrationConnector::diff().

pub fn normalize_identifier<'a>(&self, identifier: &'a str) -> Cow<'a, str>

pub fn query(&mut self, q: Query<'_>) -> ResultSet

Like quaint::Queryable::query()

pub fn query_raw(&mut self, q: &str, params: &[Value<'static>]) -> ResultSet

Like quaint::Queryable::query_raw()

pub fn raw_cmd(&mut self, sql: &str)

Send a SQL command to the database, and expect it to succeed.

pub fn render_table_name(&self, table_name: &str) -> Table<'static>

Render a table name with the required prefixing for use with quaint query building.

pub fn reset(&mut self) -> Reset<'_>

Plan a reset command

pub fn expect_sql_for_schema(&mut self, schema: &'static str, sql: &Expect)

pub fn schema_push_w_datasource( &mut self, dm: impl Into<String> ) -> SchemaPush<'_>

Plan a schemaPush command adding the datasource

pub fn schema_push(&mut self, dm: impl Into<String>) -> SchemaPush<'_>

Plan a schemaPush command

pub fn tags(&self) -> BitFlags<Tags>

pub fn write_datasource_block( &self, out: &mut dyn Write, params: &[(&str, &str)], preview_features: &'static [&'static str] )

Render a valid datasource block, including database URL.

pub fn generator_block(&self) -> String

pub fn datamodel_with_provider(&self, schema: &str) -> String

pub fn datamodel_with_provider_and_features( &self, schema: &str, params: &[(&str, &str)], preview_features: &'static [&'static str] ) -> String