API Reference¶

Complete API documentation for Ralph, auto-generated from source code.

Modules¶

• Associations -

  Associations module for defining model relationships

• Athena -

  Athena Framework integration - Auto Migration Listener

• BulkOperations -

  Bulk operations mixin for Ralph::Model

• Database -

  Abstract database backend interface

• IdentityMap -

  Per-request identity map for loaded models

• JoinMacros -

  Join macros - generate join methods for associations

• Transactions -

  Transaction support for models

Classes¶

• AssociationMetadata -

  Association metadata storage

• BackendError -

  Raised when using a backend-specific feature on an unsupported backend

• ColumnMetadata -

  Metadata about a column

• Configuration -

  Configuration options for the Athena integration

• ConfigurationError -

  Raised when there's a configuration error in the Athena integration.

• ConfigurationError -

  Raised when Ralph is not properly configured

• DeleteRestrictionError -

  Raised when trying to destroy a record with dependent: :restrict_with_exception

• Error -

  Base class for all Ralph errors

• FiberState -

  Fiber-local transaction state container

• MigrationError -

  Raised when a migration fails to execute

• Model -

  Base class for all ORM models

• PostgresBackend -

  PostgreSQL database backend implementation

• QueryError -

  Raised when a query cannot be built or executed

• RecordInvalid -

  Raised when save! or create! fails due to validation errors

• RecordNotFound -

  Raised when find! or first! returns no results

• SchemaMismatchError -

  Raised when model columns don't match the ResultSet columns during hydration

• Service -

  A dependency-injectable service that provides access to Ralph's database functionality within Athena applications.

• Settings -

  Global settings for the ORM

• SqliteBackend -

  SQLite database backend implementation

• StatementCache -

  LRU (Least Recently Used) Cache for prepared statements

• TypeMismatchError -

  Raised when a column type from the database doesn't match the model's expected type

• UnsupportedOperationError -

  Raised when an operation is not supported by the current backend

Structs¶

• AutoMigrationListener -

  Event listener that runs pending migrations on the first HTTP request.

• BulkInsertResult -

  Result of a bulk insert operation

• BulkUpsertResult -

  Result of a bulk upsert operation

• PoolStats -

  Connection pool statistics

• Stats -

  Statistics for monitoring identity map usage

• UpsertOptions -

  Options for upsert conflict resolution

Enums¶

• DependentBehavior -

  Dependent behavior options for associations

Annotations¶

• Column -

  Annotation to mark instance variables as database columns This allows from_result_set to identify which ivars are columns vs associations