Expand description
Database contracts, model metadata, and SQL naming defaults.
Modules§
- 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 Options - Options used to build OpenAuth’s core database schema metadata.
- Column
ToAdd - A column missing from an existing table and planned for additive creation.
- 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.
- Index
ToCreate - A standalone index missing from the database and planned for creation.
- Join
Adapter - Adapter wrapper that resolves OpenAuth 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.
- Migration
Statement - A SQL statement emitted by a migration plan.
- Rate
Limit - Database-backed rate limit bucket.
- Schema
Adapter - Adapter wrapper that maps OpenAuth logical schema names to database names.
- Schema
Creation - Schema file content produced by an adapter or migration generator.
- Schema
Migration Plan - Additive schema changes planned for a live database.
- Session
- Persisted user session.
- Sort
- Sort clause.
- SqlAdapter
Runner - Shared CRUD runner for SQL adapters that can execute raw SQL.
- SqlColumn
Snapshot - Introspected column metadata used by the pure migration planner.
- SqlDelete
OnePlan - Shared single-row delete statement.
- SqlFragment
- A SQL fragment plus its ordered parameters.
- SqlJoin
Read Statement - A native join read statement and borrowed metadata needed for row grouping.
- SqlParam
- A database value paired with the field type needed to bind NULLs correctly.
- SqlRate
Limit Names - Physical database names used by SQL-backed rate limit stores.
- SqlRate
Limit Plan - SQL statements used by database-backed rate limit stores.
- SqlRead
Statement - A read statement and the metadata needed to decode its result rows.
- SqlSchema
Snapshot - Introspected database schema used by the pure migration planner.
- SqlSelected
Field - Field selected by a SQL read statement.
- SqlStatement
- A complete SQL statement plus its ordered parameters.
- Table
Options - Per-table schema overrides.
- Table
ToCreate - A table missing from the database and planned for creation.
- 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.
- Delete
OneStrategy - Dialect strategy used to delete only one matching row.
- IdGeneration
- ID generation strategy for core database models.
- IdValue
- Normalized ID value.
- Join
Relation - Resolved relation kind for joined output.
- Migration
Statement Kind - The additive operation represented by a migration statement.
- OnDelete
- Foreign key delete behavior.
- Rate
Limit Storage - Storage backend selected for rate limit counters.
- Schema
Migration Warning - Non-executable findings discovered while planning migrations.
- Sort
Direction - Sort direction.
- SqlDialect
- SQL dialect supported by OpenAuth’s shared SQL planner.
- SqlUpdate
OnePlan - Shared single-row update strategy.
- Where
Mode - Case sensitivity for string predicates.
- Where
Operator - Predicate operator.
Traits§
- DbAdapter
- Async database adapter contract used by core authentication behavior.
- SqlExecutor
- Minimal async execution boundary required by the shared SQL runner.
- SqlRow
Reader - Driver row decoding boundary for converting raw driver rows into OpenAuth values.
Functions§
- auth_
schema - Build OpenAuth’s core database schema metadata.
- consume_
sql_ rate_ limit_ record - Applies OpenAuth rate-limit semantics to a locked database record.
- count_
statement - create_
statement - delete_
many_ statement - delete_
one_ statement - execute_
schema_ migration_ plan - Executes a pure migration plan through any SQL executor.
- filter_
output_ fields - Return a copy of a DB record with non-returnable fields removed.
- find_
many_ statement - find_
many_ with_ joins_ statement - find_
one_ statement - plan_
schema_ migration - Compares a target OpenAuth schema with a SQL schema snapshot and emits an additive plan.
- rate_
limit_ consume_ statements - Builds the dialect-specific statement trio used by SQL-backed rate-limit stores.
- 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 - update_
many_ statement - update_
one_ plan
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.