Module prelude
Expand description
Re-export common types from the entity
Structs§
- BigDecimal
- A big decimal type.
- Chrono
Date - ISO 8601 calendar date without timezone. Allows for every proleptic Gregorian date from Jan 1, 262145 BCE to Dec 31, 262143 CE. Also supports the conversion from ISO 8601 ordinal and week date.
- Chrono
Date Time - ISO 8601 combined date and time without timezone.
- Chrono
Time - ISO 8601 time without timezone. Allows for the nanosecond precision and optional leap second representation.
- Column
Def - Defines a Column for an Entity
- Column
From StrErr - Error during
impl FromStr for Entity::Column - Date
- ISO 8601 calendar date without timezone. Allows for every proleptic Gregorian date from Jan 1, 262145 BCE to Dec 31, 262143 CE. Also supports the conversion from ISO 8601 ordinal and week date.
- Date
Time - ISO 8601 combined date and time without timezone.
- Decimal
Decimalrepresents a 128 bit representation of a fixed-precision decimal number. The finite set of values of typeDecimalare of the form m / 10e, where m is an integer such that -296 < m < 296, and e is an integer between 0 and 28 inclusive.- Expr
- Helper to build a
SimpleExpr. - Query
Result - Defines the result of a query operation on a Model
- RcOrArc
- A thread-safe reference-counting pointer. ‘Arc’ stands for ‘Atomically Reference Counted’.
- Relation
Def - Defines a relationship
- SeaRc
- Select
- Defines a structure to perform select operations
- Sqlx
Sqlite Error - Time
- ISO 8601 time without timezone. Allows for the nanosecond precision and optional leap second representation.
- Time
Date - Date in the proleptic Gregorian calendar.
- Time
Date Time - Combined date and time.
- Time
Date Time With Time Zone - A
PrimitiveDateTimewith aUtcOffset. - Time
Time - The clock time within a given date. Nanosecond precision.
- Uuid
- A Universally Unique Identifier (UUID).
Enums§
- Column
Type - All column types
- Conn
Acquire Err - Connection Acquire error
- Database
Connection - Handle a database connection depending on the backend enabled by the feature
flags. This creates a database pool. This will be
Cloneunless the feature flagmockis enabled. - DbErr
- An error from unsuccessful database operations
- Json
- Represents any valid JSON value.
- Runtime
Err - Runtime error
- SqlErr
- An error from unsuccessful SQL query
- Sqlx
Error - Represents all the ways a method can fail within SQLx.
- String
Len - Length for var-char/binary; default to 255
- TryGet
Error - An error from trying to get a row from a Model
- Value
- Value variants
Traits§
- Active
Enum - A Rust representation of enum defined in database.
- Active
Model Behavior - A Trait for overriding the ActiveModel behavior
- Active
Model Trait - A Trait for ActiveModel to perform Create, Update or Delete operation. The type must also implement the EntityTrait. See module level docs crate::entity for a full example
- Column
Trait - API for working with a
Column. Mostly a wrapper of the identically named methods insea_query::Expr - Column
Type Trait - SeaORM’s utility methods that act on ColumnType
- Connection
Trait - The generic API for a database connection that can perform query or execute statements. It abstracts database connection and transaction
- Cursor
Trait - A trait for any type that can be turn into a cursor
- Entity
Name - A Trait for mapping an Entity to a database table
- Entity
Trait - An abstract base class for defining Entities.
- Iden
- Identifier
- Iden
Static - Ensure the identifier for an Entity can be converted to a static str
- Linked
- A Trait for links between Entities
- Loader
Trait - This trait implements the Data Loader API
- Model
Trait - The interface for Model, implemented by data structs
- Paginator
Trait - A Trait for any type that can paginate results
- Primary
KeyArity - How many columns this Primary Key comprises
- Primary
KeyTo Column - How to map a Primary Key to a column
- Primary
KeyTrait - A Trait for to be used to define a Primary Key.
- Query
Filter - Perform a FILTER opertation on a statement
- Related
- Checks if Entities are related
- Relation
Trait - Defines the relations of an Entity
Type Aliases§
- Chrono
Date Time Local - Date time represented in local time
- Chrono
Date Time Utc - Date time represented in UTC
- Chrono
Date Time With Time Zone - Date time with fixed offset
- Date
Time Local - Date time represented in local time
- Date
Time Utc - Date time represented in UTC
- Date
Time With Time Zone - Date time with fixed offset
- DbConn
- The same as a DatabaseConnection
- DynIden
- Foreign
KeyAction - Action to perform on a foreign key whenever there are changes to an ActiveModel
Derive Macros§
- Derive
Active Enum - A derive macro to implement
sea_orm::ActiveEnumtrait for enums. - Derive
Active Model - The DeriveActiveModel derive macro will implement ActiveModelTrait for ActiveModel which provides setters and getters for all active values in the active model.
- Derive
Active Model Behavior - Models that a user can override
- Derive
Column - The DeriveColumn derive macro will implement [ColumnTrait] for Columns. It defines the identifier of each column by implementing Iden and IdenStatic. The EnumIter is also derived, allowing iteration over all enum variants.
- Derive
Custom Column - Derive a column if column names are not in snake-case
- Derive
Display - Derive
Entity - Create an Entity
- Derive
Entity Model - This derive macro is the ‘almighty’ macro which automatically generates Entity, Column, and PrimaryKey from a given Model.
- Derive
Iden - The DeriveIden derive macro will implement
sea_orm::sea_query::Idenfor simplify Iden implementation. - Derive
Into Active Model - Derive into an active model
- Derive
Model - The DeriveModel derive macro will implement ModelTrait for Model, which provides setters and getters for all attributes in the mod It also implements FromQueryResult to convert a query result into the corresponding Model.
- Derive
Partial Model - The DerivePartialModel derive macro will implement [
sea_orm::PartialModelTrait] for simplify partial model queries. - Derive
Primary Key - The DerivePrimaryKey derive macro will implement [PrimaryKeyToColumn] for PrimaryKey which defines tedious mappings between primary keys and columns. The EnumIter is also derived, allowing iteration over all enum variants.
- Derive
Related Entity - The DeriveRelatedEntity derive macro will implement seaography::RelationBuilder for RelatedEntity enumeration.
- Derive
Relation - The DeriveRelation derive macro will implement RelationTrait for Relation.
- Derive
Value Type - Implements traits for types that wrap a database value type.
- Enum
Iter - Creates a new type that iterates of the variants of an enum.
- Iden