Struct sql_schema_connector::SqlSchemaConnector

pub struct SqlSchemaConnector { /* private fields */ }

The top-level SQL migration connector.

Implementations

impl SqlSchemaConnector

pub fn new_postgres() -> Self

Initialize a PostgreSQL migration connector.

pub fn new_cockroach() -> Self

Initialize a CockroachDb migration connector.

pub fn new_postgres_like() -> Self

Initialize a PostgreSQL-like schema connector.

Use Self::new_postgres() or Self::new_cockroach() instead when the provider is explicitly specified by user or already known otherwise.

pub fn new_sqlite() -> Self

Initialize a SQLite migration connector.

pub fn new_mysql() -> Self

Initialize a MySQL migration connector.

pub fn new_mssql() -> Self

Initialize a MSSQL migration connector.

pub fn describe_schema( &mut self, namespaces: Option<Namespaces> ) -> BoxFuture<'_, ConnectorResult<SqlSchema>>

Made public for tests.

pub async fn query_raw( &mut self, sql: &str, params: &[Value<'_>] ) -> ConnectorResult<ResultSet>

For tests

pub async fn query( &mut self, query: impl Into<Query<'_>> ) -> ConnectorResult<ResultSet>

For tests

pub async fn raw_cmd(&mut self, sql: &str) -> ConnectorResult<()>

For tests

pub fn set_params(&mut self, params: ConnectorParams) -> ConnectorResult<()>

Prepare the connector to connect.

Trait Implementations

impl DestructiveChangeChecker for SqlSchemaConnector

fn check<'a>( &'a mut self, migration: &'a Migration ) -> BoxFuture<'a, ConnectorResult<DestructiveChangeDiagnostics>>

Check destructive changes resulting of applying the provided migration.

fn pure_check(&self, migration: &Migration) -> DestructiveChangeDiagnostics

Check the migration for destructive or unexecutable steps without performing any IO.

impl MigrationPersistence for SqlSchemaConnector

fn baseline_initialize(&mut self) -> BoxFuture<'_, ConnectorResult<()>>

Initialize the migration persistence without checking the database first.

fn initialize( &mut self, namespaces: Option<Namespaces> ) -> BoxFuture<'_, ConnectorResult<()>>

This method is responsible for checking whether the migrations persistence is initialized.

fn mark_migration_applied_impl<'a>( &'a mut self, migration_name: &'a str, checksum: &'a str ) -> BoxFuture<'a, ConnectorResult<String>>

Implementation in the connector for the core’s MarkMigrationApplied command. See the docs there. Note that the started_at and finished_at for the migration should be the same.

fn mark_migration_rolled_back_by_id<'a>( &'a mut self, migration_id: &'a str ) -> BoxFuture<'a, ConnectorResult<()>>

Mark the failed instances of the migration in the persistence as rolled back, so they will be ignored by the engine in the future.

fn record_migration_started_impl<'a>( &'a mut self, migration_name: &'a str, checksum: &'a str ) -> BoxFuture<'a, ConnectorResult<String>>

Record that a migration is about to be applied. Returns the unique identifier for the migration.

fn record_successful_step<'a>( &'a mut self, id: &'a str ) -> BoxFuture<'a, ConnectorResult<()>>

Increase the applied_steps_count counter.

fn record_failed_step<'a>( &'a mut self, id: &'a str, logs: &'a str ) -> BoxFuture<'a, ConnectorResult<()>>

Report logs for a failed migration step. We assume the next steps in the migration will not be applied, and the error reported.

fn record_migration_finished<'a>( &'a mut self, id: &'a str ) -> BoxFuture<'a, ConnectorResult<()>>

Record that the migration completed successfully. This means populating the finished_at field in the migration record.

fn list_migrations( &mut self ) -> BoxFuture<'_, ConnectorResult<Result<Vec<MigrationRecord>, PersistenceNotInitializedError>>>

List all applied migrations, ordered by started_at. This should fail with a PersistenceNotInitializedError when the migration persistence is not initialized.

fn mark_migration_applied<'a>( &'a mut self, migration_name: &'a str, script: &'a str ) -> Pin<Box<dyn Future<Output = Result<String, ConnectorError>> + Send + 'a>>

Implementation in the connector for the core’s MarkMigrationApplied command. See the docs there. Note that the started_at and finished_at for the migration should be the same.

fn record_migration_started<'a>( &'a mut self, migration_name: &'a str, script: &'a str ) -> Pin<Box<dyn Future<Output = Result<String, ConnectorError>> + Send + 'a>>

Record that a migration is about to be applied. Returns the unique identifier for the migration.

impl SchemaConnector for SqlSchemaConnector

fn check_database_version_compatibility( &self, datamodel: &ValidatedSchema ) -> Option<DatabaseVersionIncompatibility>

Optionally check that the features implied by the provided datamodel are all compatible with the specific database version being used.

fn set_host(&mut self, host: Arc<dyn ConnectorHost>)

Accept a new ConnectorHost.

fn set_params(&mut self, params: ConnectorParams) -> ConnectorResult<()>

Accept and validate new ConnectorParams. This should fail if it is called twice on the same connector.

fn set_preview_features(&mut self, preview_features: BitFlags<PreviewFeature>)

Accept a new set of enabled preview features.

fn connection_string(&self) -> Option<&str>

Return the connection string that was used to initialize this connector in set_params().

fn connector_type(&self) -> &'static str

A string that should identify what database backend is being used. Note that this is not necessarily the connector name. The SQL connector for example can return “postgresql”, “mysql” or “sqlite”.

fn acquire_lock(&mut self) -> BoxFuture<'_, ConnectorResult<()>>

If possible on the target connector, acquire an advisory lock, so multiple instances of migrate do not run concurrently.

fn apply_migration<'a>( &'a mut self, migration: &'a Migration ) -> BoxFuture<'a, ConnectorResult<u32>>

Applies the migration to the database. Returns the number of executed steps.

fn apply_script<'a>( &'a mut self, migration_name: &'a str, script: &'a str ) -> BoxFuture<'a, ConnectorResult<()>>

Apply a migration script to the database. The migration persistence is managed by the core.

fn empty_database_schema(&self) -> DatabaseSchema

An empty database schema (for diffing).

fn ensure_connection_validity(&mut self) -> BoxFuture<'_, ConnectorResult<()>>

Make sure the connection to the database is established and valid. Connectors can choose to connect lazily, but this method should force them to connect.

fn host(&self) -> &Arc<dyn ConnectorHost>

Return the ConnectorHost passed with set_host.

fn version(&mut self) -> BoxFuture<'_, ConnectorResult<String>>

The version of the underlying database.

fn create_database(&mut self) -> BoxFuture<'_, ConnectorResult<String>>

Create the database referenced by Prisma schema that was used to initialize the connector.

fn database_schema_from_diff_target<'a>( &'a mut self, diff_target: DiffTarget<'a>, shadow_database_connection_string: Option<String>, namespaces: Option<Namespaces> ) -> BoxFuture<'a, ConnectorResult<DatabaseSchema>>

Read a schema for diffing. The shadow database connection string is strictly optional, you don’t need to pass it if a shadow database url was passed in params, or if it can be inferred from context, or if it isn’t necessary for the task at hand. When MultiSchema is enabled, the namespaces are required for diffing anything other than a prisma schema, because that information is otherwise unavailable.

fn db_execute(&mut self, script: String) -> BoxFuture<'_, ConnectorResult<()>>

Send a command to the database directly.

fn diff(&self, from: DatabaseSchema, to: DatabaseSchema) -> Migration

Create a migration by comparing two database schemas.

fn drop_database(&mut self) -> BoxFuture<'_, ConnectorResult<()>>

Drop the database referenced by Prisma schema that was used to initialize the connector.

fn introspect<'a>( &'a mut self, ctx: &'a IntrospectionContext ) -> BoxFuture<'a, ConnectorResult<IntrospectionResult>>

In-tro-spec-shon.

fn migration_file_extension(&self) -> &'static str

The file extension for generated migration files.

fn migration_len(&self, migration: &Migration) -> usize

Return the number of steps in the migration. Invariant: migration_is_empty() == true iff migration_len() == 0.

fn render_script( &self, migration: &Migration, diagnostics: &DestructiveChangeDiagnostics ) -> ConnectorResult<String>

Render the migration to a runnable script.

fn reset( &mut self, soft: bool, namespaces: Option<Namespaces> ) -> BoxFuture<'_, ConnectorResult<()>>

Drop all database state.

fn migration_summary(&self, migration: &Migration) -> String

Render a human-readable drift summary for the migration.

fn destructive_change_checker(&mut self) -> &mut dyn DestructiveChangeChecker

See DestructiveChangeChecker.

fn migration_persistence(&mut self) -> &mut dyn MigrationPersistence

See MigrationPersistence.

fn validate_migrations<'a>( &'a mut self, migrations: &'a [MigrationDirectory], namespaces: Option<Namespaces> ) -> BoxFuture<'a, ConnectorResult<()>>

If possible, check that the passed in migrations apply cleanly.

fn extract_namespaces(&self, schema: &DatabaseSchema) -> Option<Namespaces>

Extract the namespaces from a Sql database schema (it will return None for mongodb).

fn migration_is_empty(&self, migration: &Migration) -> bool

Return whether the migration is empty.