surreal-sync-core 0.6.0

Core types, SurrealSink, transform/sink-connect traits, and checkpoint API for surreal-sync
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96

//! Core types for the surreal-sync framework.
//!
//! This crate provides the foundational types used across the sync
//! framework, including:
//!
//! - [`Type`] - Universal type representation for all supported databases
//! - [`Value`] - Raw generated values before type conversion
//! - [`TypedValue`] - Values with type information for conversion
//! - [`Row`] - Intermediate row representation
//! - [`Schema`] - Schema definitions loaded from YAML
//!
//! # Architecture
//!
//! The `surreal-sync-core` crate sits at the foundation of the sync framework:
//!
//! ```text
//! surreal-sync-core (this crate)
//!    │
//!    ├─── loadtest-generator  (depends on surreal-sync-core for types)
//!    │
//!    ├─── surreal-sync-mysql  (implements From/Into for MySQL)
//!    ├─── surreal-sync-postgresql::types    (implements From/Into for PostgreSQL)
//!    ├─── mongodb-types       (implements From/Into for MongoDB)
//!    ├─── surrealdb-types     (implements From/Into for SurrealDB)
//!    └─── surreal-sync-json::types          (implements From/Into for JSON/CSV)
//! ```
//!
//! # Example
//!
//! ```rust
//! use surreal_sync_core::types::Type;
//! use surreal_sync_core::values::{Value, TypedValue};
//!
//! // Create a typed value using factory methods
//! let value = TypedValue::int32(42);
//!
//! // For dynamic types (e.g., from schema), use try_with_type for validation:
//! let dynamic_value = TypedValue::try_with_type(
//!     Type::Int32,
//!     Value::Int32(42)
//! ).expect("valid type-value combination");
//!
//! // Type-specific crates implement From<TypedValue> for their native types:
//! // let mysql_value: MySQLValue = value.into();
//! ```

pub mod checkpoint;
pub mod foreign_keys;
pub mod id_columns;
pub mod relation_change;
pub mod schema;
pub mod sink;
pub mod transform;
pub mod types;
pub mod values;

// Re-exports for convenience
// Checkpoint API (storage backends live in separate crates)
pub use sink::{SinkConnect, SinkWithCheckpoints, SurrealConfig, SurrealSdkVersion, SurrealSink};

pub use checkpoint::{
    Checkpoint, CheckpointFile, CheckpointID, CheckpointStorage, CheckpointStore,
    InterleavedSnapshotCheckpoint, NullStore, NullSyncManager, SnapshotCheckpointer,
    SnapshotTableProgress, StoredCheckpoint, SyncConfig, SyncManager, SyncPhase,
};

pub use transform::{InPlaceTransform, Passthrough};

// Foreign key types
pub use foreign_keys::{classify_table, ForeignKeyDefinition, TableKind};

// ID / primary-key column helpers
pub use id_columns::{
    apply_id_column_overrides, build_composite_record_id, flatten_composite_id,
    parse_id_column_overrides, stringify_id_part, IdColumnOverrides, IdColumnsError,
};

// Base types (context-neutral, no generators)
pub use schema::{ColumnDefinition, DatabaseSchema, TableDefinition};

// Generator types (with generators)
pub use schema::{
    FieldDefinition, GeneratorConfig, GeneratorFieldDefinition, GeneratorIDDefinition,
    GeneratorSchema, GeneratorTableDefinition, IDDefinition, Schema, SchemaError,
    TableDefinitionWithGenerators,
};

// Legacy alias for backwards compatibility
#[deprecated(since = "1.0.0", note = "Use GeneratorSchema instead")]
pub type LoadTestSchema = Schema;
pub use relation_change::RelationChange;
pub use types::{GeometryType, ToDdl, Type};
pub use values::{
    Change, ChangeOp, GeometryData, Relation, Row, RowBuilder, RowConverter, ThingRef, TypedValue,
    TypedValueError, Value, ZeroTemporalPolicy,
};