Expand description
Database contracts, model metadata, and SQL naming defaults.
Re-exports§
pub use crate::options::validate_rate_limit_rule;pub use oauth_provider::oauth_provider_schema;pub use oauth_provider::OAUTH_ACCESS_TOKEN_MODEL;pub use oauth_provider::OAUTH_CLIENT_MODEL;pub use oauth_provider::OAUTH_CONSENT_MODEL;pub use oauth_provider::OAUTH_REFRESH_TOKEN_MODEL;pub use sql::consume_sql_rate_limit_record;pub use sql::count_statement;pub use sql::create_statement;pub use sql::delete_many_statement;pub use sql::delete_one_statement;pub use sql::ensure_executable_migration_plan;pub use sql::execute_schema_migration_plan;pub use sql::find_many_statement;pub use sql::find_many_with_joins_statement;pub use sql::find_one_statement;pub use sql::plan_schema_migration;pub use sql::rate_limit_consume_statements;pub use sql::rate_limit_count_from_i64;pub use sql::rate_limit_count_to_i64;pub use sql::update_many_statement;pub use sql::update_one_plan;pub use sql::ColumnToAdd;pub use sql::DeleteOneStrategy;pub use sql::IndexToCreate;pub use sql::MigrationStatement;pub use sql::MigrationStatementKind;pub use sql::SchemaMigrationPlan;pub use sql::SchemaMigrationWarning;pub use sql::SqlAdapterRunner;pub use sql::SqlColumnSnapshot;pub use sql::SqlDeleteOnePlan;pub use sql::SqlDialect;pub use sql::SqlExecutor;pub use sql::SqlFragment;pub use sql::SqlJoinReadStatement;pub use sql::SqlParam;pub use sql::SqlRateLimitNames;pub use sql::SqlRateLimitPlan;pub use sql::SqlReadStatement;pub use sql::SqlRowReader;pub use sql::SqlSchemaSnapshot;pub use sql::SqlSelectedField;pub use sql::SqlStatement;pub use sql::SqlUpdateOnePlan;pub use sql::TableToCreate;
Modules§
- oauth_
provider - Shared OAuth 2.1 provider database schema used by
rustauth-oauth-providerand MCP. - sql
- Shared SQL planning helpers for SQL-speaking database adapters.
Structs§
- Account
- Linked credential, OAuth, or social provider account.
- Adapter
Capabilities - Database adapter capability metadata.
- Auth
Schema - Schema view for validated table and field names.
- Auth
Schema Options - Options used to build RustAuth’s core database schema metadata.
- Count
- Count query contract for adapters.
- Create
- Create query contract for adapters.
- DbField
- Field metadata used by adapters and migrations.
- DbSchema
- Schema metadata keyed by logical table name.
- DbTable
- Table metadata keyed by logical field name.
- Delete
- Single-row delete query contract for adapters.
- Delete
Many - Multi-row delete query contract for adapters.
- Find
Many - Find-many query contract for adapters.
- FindOne
- Find-one query contract for adapters.
- Foreign
Key - Foreign key metadata for adapter and migration implementations.
- Hooked
Adapter - Adapter wrapper that runs plugin database hooks for mutating operations.
- IdPolicy
- ID field and transform policy.
- Join
Adapter - Adapter wrapper that resolves RustAuth join options at runtime.
- Join
Config - Adapter-facing join configuration after relation metadata is resolved.
- JoinOn
- Resolved join column pair.
- Join
Option - User-facing join request before schema relation metadata has been resolved.
- Join
Resolution - Resolved join metadata plus any base select fields required to execute it.
- Memory
Adapter - Async-safe in-memory adapter backed by shared state.
- Rate
Limit - Database-backed rate limit bucket.
- Schema
Adapter - Adapter wrapper that maps RustAuth logical schema names to database names.
- Schema
Creation - Schema file content produced by an adapter or migration generator.
- Schema
Table - Validated logical table bound to the merged auth schema.
- Session
- Persisted user session.
- Sort
- Sort clause.
- Table
Options - Per-table schema overrides.
- Update
- Single-row update query contract for adapters.
- Update
Many - Multi-row update query contract for adapters.
- User
- Core user record.
- Verification
- Verification token or value used by flows such as email verification.
- Where
- Adapter query predicate.
Enums§
- Connector
- Connector between predicates.
- DbField
Type - Supported database field kinds for core schema metadata.
- DbValue
- Primitive value accepted by adapter query predicates.
- IdGeneration
- ID generation strategy for core database models.
- IdValue
- Normalized ID value.
- Join
Relation - Resolved relation kind for joined output.
- OnDelete
- Foreign key delete behavior.
- Rate
Limit Storage - Storage backend selected for rate limit counters.
- Sort
Direction - Sort direction.
- Where
Mode - Case sensitivity for string predicates.
- Where
Operator - Predicate operator.
Traits§
- DbAdapter
- Async database adapter contract used by core authentication behavior.
Functions§
- auth_
schema - Build RustAuth’s core database schema metadata.
- filter_
output_ fields - Return a copy of a DB record with non-returnable fields removed.
- resolve_
join_ options - run_
transaction_ without_ native_ support - Execute a transaction callback directly when native transactions are unavailable.
- transform_
count_ query - transform_
count_ query_ with_ capabilities - transform_
create_ query - transform_
create_ query_ with_ capabilities - transform_
delete_ many_ query - transform_
delete_ many_ query_ with_ capabilities - transform_
delete_ query - transform_
delete_ query_ with_ capabilities - transform_
find_ many_ query - transform_
find_ many_ query_ with_ capabilities - transform_
find_ one_ query - transform_
find_ one_ query_ with_ capabilities - transform_
update_ many_ query - transform_
update_ many_ query_ with_ capabilities - transform_
update_ query - transform_
update_ query_ with_ capabilities
Type Aliases§
- Adapter
Future - Boxed async result returned by database adapter methods.
- Adapter
Result - DbRecord
- Dynamic record payload exchanged between core auth logic and adapters.
- Transaction
Adapter - Adapter handle passed to transaction callbacks.
- Transaction
Callback - Callback executed inside an adapter transaction.