Skip to main content

Crate icydb_schema

Crate icydb_schema 

Source
Expand description

Bounded public schema-proposal contract for IcyDB.

This crate owns proposal vocabulary only. It does not own accepted schema, runtime planning, storage, clocks, generators, application callbacks, or persisted row formats.

Macros§

scalar_kind_registry

Structs§

Account
Canonical ICRC account atom.
Blob
Engine-neutral binary scalar.
ConstraintFragment
One source constraint declaration.
ConstraintSourceKey
Typed proposal key derived from one current ConstraintSourceKey name.
Date
Decimal
Decimal
DecimalParts
DecimalParts
Duration
Canonical millisecond duration.
EntityFragment
Store-free logical entity definition.
EntitySourceKey
Typed proposal key derived from one current EntitySourceKey name.
EntityStoreAssignment
Explicit entity-to-store routing in the target database.
EnumTypeFragment
Named enum-type definition.
EnumVariantFragment
One named enum variant.
ExpectedSchemaFingerprint
Opaque expected accepted-schema fingerprint.
FieldFragment
One field definition keyed by its current source name.
FieldSourceKey
Typed proposal key derived from one current FieldSourceKey name.
Float32
Finite canonical f32 atom.
Float64
Finite canonical f64 atom.
IndexFragment
One secondary-index proposal definition.
IndexSourceKey
Typed proposal key derived from one current IndexSourceKey name.
IntBig
Arbitrary-precision signed integer used by schema and typed values.
NatBig
Arbitrary-precision unsigned integer used by schema and typed values.
ParseDecimalError
ParseDecimalError
Principal
Canonical principal atom.
ProposalContractVersion
Sole maintained proposal contract version.
RecordFieldFragment
One structural field in a named record type.
RecordTypeFragment
Named record-type definition.
RelationFragment
One source-owned relation definition.
RelationSourceKey
Typed proposal key derived from one current RelationSourceKey name.
RuleSourceKey
Typed proposal key derived from one current RuleSourceKey name.
ScalarMetadata
ScalarMetadata
SchemaCapability
Feature required by one proposal.
SchemaFragment
Reusable store-free collection of entity and type definitions.
SchemaName
Bounded current schema name.
SchemaProposal
Canonical current-form database-scoped proposal.
SchemaProposalDigest
Canonical digest of one current-form schema proposal.
SchemaSubmissionKey
Caller-generated immutable schema-submission key.
SourceCheckExpr
Bounded canonical source expression.
Subaccount
A canonical 32-byte ICRC account subaccount.
TargetDatabaseIdentity
Opaque identity binding a proposal to one target database.
TargetStoreIdentity
Opaque identity routing one entity to a store in the target database.
TargetedRuleFragment
One source-bound nominal durable-rule target.
Timestamp
Canonical Unix-millisecond timestamp.
TupleElementFragment
One positional tuple member and its explicit-null policy.
TypeSourceKey
Typed proposal key derived from one current TypeSourceKey name.
Ulid
Canonical ULID atom without generation authority.
Unit

Enums§

ConstraintFragmentKind
One source constraint kind.
ExpectedAcceptedHead
Expected accepted-schema head used for optimistic application.
FieldInsertPolicy
Insert policy authored for one field.
FieldManagementPolicy
Accepted database-owned lifecycle policy.
FieldType
Logical type reference in a proposal fragment.
Float32DecodeError
Failure while decoding one finite 32-bit floating-point atom.
Float64DecodeError
Failure while decoding one finite 64-bit floating-point atom.
IndexKeyFragment
One ordered index key component.
NamedTypeFragment
Named reusable type definition.
ParseDecimalErrorReason
ParseDecimalErrorReason
PrincipalDecodeError
Failure while decoding canonical principal bytes.
PrincipalEncodeError
Failure while exposing canonical principal bytes.
PrincipalError
Failure while parsing a canonical principal.
RelationDeleteAction
Maintained referential action in the current proposal contract.
ScalarCoercionFamily
ScalarCoercionFamily
ScalarKind
ScalarKind
ScalarLiteral
One canonical scalar literal carried by a schema proposal.
ScalarType
Exact scalar field contract required by accepted-schema lowering.
SchemaContractError
Failure while constructing, validating, encoding, or decoding proposal data.
SchemaRemoval
Explicit hard-cut removal operation.
SourceCheckInstruction
One instruction in a bounded source-level postfix check expression.
SourceRuleOperation
One closed durable operation applied to every selected nominal value.
TypeParseError
Compact scalar parsing failure.
UlidDecodeError
Failure while decoding canonical ULID bytes.
UlidParseError
Failure while parsing a canonical ULID.

Constants§

ALL_SCALAR_KINDS
Ordered list of all scalar kinds in registry order.
DEFAULT_BIG_INT_MAX_BYTES
Default maximum canonical encoding for unbounded authored big integers.
MAX_FRAGMENT_CONSTRAINTS
Maximum number of accepted constraints in one entity definition.
MAX_FRAGMENT_ENTITIES
Maximum number of entity definitions in one fragment.
MAX_FRAGMENT_FIELDS
Maximum number of fields in one entity or record definition.
MAX_FRAGMENT_INDEXES
Maximum number of indexes in one entity definition.
MAX_FRAGMENT_RELATIONS
Maximum number of relations in one entity definition.
MAX_FRAGMENT_TYPES
Maximum number of named type definitions in one fragment.
MAX_PROPOSAL_LITERAL_BYTES
Maximum byte length of one text or blob proposal literal.
MAX_SCHEMA_ASSIGNMENTS
Maximum number of entity-to-store assignments in one proposal.
MAX_SCHEMA_CAPABILITIES
Maximum number of required capabilities in one proposal.
MAX_SCHEMA_FIELD_TYPE_DEPTH
Maximum inline nesting depth of one field-type contract.
MAX_SCHEMA_FRAGMENT_BYTES
Maximum encoded size of one reusable schema fragment.
MAX_SCHEMA_NAME_BYTES
Maximum byte length of one current schema name.
MAX_SCHEMA_PROPOSAL_BYTES
Maximum encoded size of one database-scoped schema proposal.
MAX_SCHEMA_PROPOSAL_FRAGMENTS
Maximum number of reusable fragments in one proposal.
MAX_SCHEMA_REMOVALS
Maximum number of explicit removals in one proposal.
MAX_SCHEMA_SUBMISSION_KEY_BYTES
Maximum byte length of one caller-generated submission key.
MAX_SOURCE_CHECK_INSTRUCTIONS
Maximum number of instructions in one source-level check expression.
MAX_SOURCE_KEY_BYTES
Maximum byte length of one typed current-name proposal key.

Traits§

NumericValue
Fallible numeric round-trip contract used by generic validators and normalizers.

Functions§

canonical_index_name_slug
Normalize one entity or index-key label into its canonical index-name slug.
decode_schema_fragment
Decode one bounded current-form schema fragment.
decode_schema_proposal
Decode one bounded current-form database-scoped proposal.
encode_schema_fragment
Encode one canonical schema fragment.
encode_schema_proposal
Encode one canonical database-scoped schema proposal.