Module schema 

Schema definitions for the surreal-sync framework.

This module defines schema types for both database introspection and data generation.

Type Hierarchy

Base types (context-neutral, no generators):

• ColumnDefinition - Single column metadata
• TableDefinition - Table with columns (no generators)
• DatabaseSchema - Collection of tables (no generators)

Generator types (embed base types, include generators):

• GeneratorFieldDefinition - Field with generator config
• GeneratorIDDefinition - Primary key with generator config
• GeneratorTableDefinition - Table with generators
• GeneratorSchema - Full schema with generators

Usage

• Use base types for schema introspection during sync operations
• Use generator types for test data generation (YAML schema files)

Structs

ColumnDefinition

Column definition - shared by both introspection and generation.

DatabaseSchema

Database schema (collection of tables, no generators).

GeneratorFieldDefinition

Field with generator config. Embeds ColumnDefinition.

GeneratorIDDefinition

Primary key with generator config.

GeneratorSchema

Full schema with generators.

GeneratorTableDefinition

Table with generators. For test data generation.

TableDefinition

Table schema definition (no generators).

Enums

GeneratorConfig

Generator configuration for a field.

SchemaError

Error type for schema operations.

Type Aliases

FieldDefinition

Type alias for backwards compatibility. Old FieldDefinition is now GeneratorFieldDefinition.

IDDefinition

Type alias for backwards compatibility. Old IDDefinition is now GeneratorIDDefinition.

Schema

Type alias for backwards compatibility. Schema is now GeneratorSchema.

TableDefinitionWithGenerators

Type alias for backwards compatibility. Old TableDefinition (with generators) is now GeneratorTableDefinition.