Skip to main content

Crate che_orm

Crate che_orm 

Source
Expand description

che-orm — экспериментальная типизированная ORM для Rust.

Runtime сейчас ориентирован на SQLite: Database предоставляет async pool и high-level CRUD/query facade, а Model derive генерирует metadata, row decoding и insert values. SQL можно также использовать отдельно через SqlCompiler.

Основной рабочий сценарий:

ⓘ
use che_orm::{Database, Model};

let database = Database::connect_in_memory()?;
database.create_table::<User>().await?;
let user = database
    .create::<User>()
    .set(User::NAME, "Alice")
    .execute()
    .await?;
let loaded = database.get::<User>(user.id).await?;
assert!(loaded.is_some());

Fixed string choices use DbEnum. It owns the JSON and database value, so a variant has one canonical representation everywhere:

ⓘ
#[derive(Debug, Clone, Copy, DbEnum)]
enum TaskStatus {
    Draft,
    #[db_enum(rename = "in_progress")]
    InProgress,
}

Do not derive serde::Serialize or serde::Deserialize for a DbEnum; the derive generates both implementations.

Re-exports§

pub use rusqlite;
pub use serde;
pub use serde_json;
pub use time;

Structs§

AppRegistry
Registry that combines schemas from multiple application modules.
Assignment
BelongsTo
A typed forward foreign-key relation from one model to another.
ColumnRef
ColumnSchema
Metadata for one table column.
CompiledQuery
SQL text and ordered bound parameters.
CompiledSchema
Table DDL plus separately executable indexes.
CreateBuilder
High-level insert builder. The executed result is the complete inserted model.
CreateTableAst
AST node for a CREATE TABLE statement.
CreateTableQuery
Builder for a model’s CREATE TABLE statement.
Database
Async SQLite database backed by a deadpool-sqlite connection pool.
DatabaseQuery
High-level typed select builder bound to a database.
DeleteAst
DeleteQuery
ExecuteResult
Result metadata returned by an executed mutation or DDL statement.
ForeignKey
Foreign key metadata attached to a column.
HasMany
A typed reverse foreign-key relation from one model to many related models.
InsertAst
InsertQuery
InsertValue
JoinAst
JoinedField
Loaded
A materialized model and a tuple of preloaded relations.
LoadedMany
One reverse relation inside a materialized relation tuple.
LoadedOne
ModelField
A typed reference to one model column.
MultiPrefetchRelatedQuery
Query which materializes two reverse relations in one typed result.
MultiSelectRelatedQuery
NestedPrefetchPlan
NestedPrefetchQuery
OrderBy
PostgresDialect
PrefetchRelatedQuery
Query which materializes a model together with its reverse relation.
SchemaSet
A collection of model schemas exported as one Atlas-compatible SQL schema.
SelectAst
SelectQuery
SelectRelatedQuery
Query which materializes a model together with one related model.
SerializerField
SqlCompiler
SqliteDialect
TableRef
TableSchema
Complete model table metadata used for DDL generation.
UpdateAst
UpdateBuilder
High-level update builder scoped to one model primary key.
UpdateQuery
ValidationErrors
WithMany
A model and its eagerly loaded reverse relation.
WithOne
A model and its eagerly loaded belongs_to relation.
WithOptionalOne

Enums§

ColumnType
SQL column types supported by the schema compiler.
CompareOp
DatabaseValue
Values bound to SQL placeholders.
Expr
Boolean and comparison expression tree used by query builders.
JoinType
OrderDirection
OrmError
Errors returned by the SQLite pool and ORM runtime.
PatchField
A JSON patch value. Missing means that the property was not sent; Value(None) represents an explicit JSON null.
QueryAst
QueryBuildError
Errors detected while finalizing a query builder.
SchemaError
Errors found in model-generated schema metadata.
ValidatedWrite
WriteMode

Traits§

AppConfig
Application-level model registration, similar to a Django app config.
ColumnTypeOf
Maps a Rust field type to a SQL column type.
DbEnum
A string-backed enum that can be stored in a database column.
Model
Trait implemented by #[derive(Model)] for ORM models.
ModelSerializer
Converts a materialized ORM model into an API representation.
ModelWriteSerializer
PrefetchRelation
QueryValue
RelationSource
Identifies the actual foreign-key column behind a serializer relation.
SqlDialect

Type Aliases§

Compiler
CurrentDialect

Derive Macros§

DbEnum
Model
ModelSerializer