Crate schema_connector

This crate defines the API exposed by the connectors to the schema engine core. The entry point for this API is the MigrationConnector trait.

Re-exports

• pub use warnings::Warnings;

Modules

• migrations_directory
  Migrations directory management.
• warnings
  Warnings generator for Introspection

Structs

• ConnectorError
  The general error reporting type for migration connectors.
• ConnectorParams
  Parameters passed from the core to connectors on initialization.
• DatabaseSchema
  A database schema. Part of the MigrationConnector API.
• DestructiveChangeDiagnostics
  The errors and warnings emitted by the DestructiveChangeChecker.
• EmptyHost
  A no-op ConnectorHost.
• IntrospectionContext
  Input parameters for a database introspection.
• IntrospectionResult
  The result structure from a successful introspection run.
• IntrospectionResultOutput
  The output type from introspection.
• Migration
  A boxed migration, opaque to the schema engine core. The connectors are sole responsible for producing and understanding migrations — the core just orchestrates.
• MigrationRecord
  An applied migration, as returned by list_migrations.
• MigrationWarning
  A warning emitted by DestructiveChangeChecker. Warnings will prevent a migration from being applied, unless the force flag is passed.
• Namespaces
  A nonempty set of namespaces. It is assumed that the namespaces are unique. It is often passed around an Option for when the namespaces cannot be inferred, or when the MultiSchema preview feature is not enabled.
• PersistenceNotInitializedError
  Error returned when the persistence is not initialized.
• UnexecutableMigration
  An unexecutable migration step detected by the DestructiveChangeChecker.
• ViewDefinition
  Defines a view in the database.

Enums

• CompositeTypeDepth
  Control type for composite type traversal.
• DiffTarget
  Diffable things

Traits

• ConnectorHost
  An abstract host for a migration connector. It exposes IO that is not directly performed by the connectors.
• DestructiveChangeChecker
  Implementors of this trait are responsible for checking whether a migration could lead to data loss, or if it would be potentially unexecutable.
• MigrationPersistence
  Management of imperative migrations state in the database.
• SchemaConnector
  The top-level trait for connectors. This is the abstraction the schema engine core relies on to interface with different database backends.

Type Aliases

• BoxFuture
  Alias for a pinned, boxed future, used by the traits.
• ConnectorResult
  Shorthand for a Result where the error variant is a ConnectorError.
• Timestamp
  A timestamp.