Skip to content

Reference

Technical reference for every class, function, and parameter in Cendry. Everything is importable from cendry:

from cendry import (
    # Models
    Model, Map, Field, field, FieldDescriptor,
    # Context
    Cendry, AsyncCendry,
    # Query
    Query, AsyncQuery, ProjectedQuery, AsyncProjectedQuery, Asc, Desc,
    # Batch & Transactions
    Batch, AsyncBatch, Txn, AsyncTxn,
    # Filters
    FieldFilter, And, Or,
    # Firestore sentinels & transforms
    DELETE_FIELD, SERVER_TIMESTAMP,
    Increment, ArrayUnion, ArrayRemove, Maximum, Minimum,
    # Serialization
    from_dict, to_dict,
    # Type system
    TypeHandler, BaseTypeHandler, TypeRegistry, FirestoreValue, register_type,
    # Backends
    Backend, AsyncBackend, FirestoreBackend, FirestoreAsyncBackend,
    DocResult, WriteResult,
    # Metadata
    get_metadata, DocumentMetadata,
    # Exceptions
    CendryError, DocumentNotFoundError, DocumentAlreadyExistsError,
)

Models · Context · Query · Filters · Serialization · Types · Exceptions