faucet_core/
lib.rs

1#![cfg_attr(docsrs, feature(doc_cfg))]
2
3//! # faucet-core
4//!
5//! Shared types, traits, and utilities for the faucet-stream ecosystem.
6//!
7//! This crate provides the common foundation used by all faucet source and
8//! sink connectors:
9//!
10//! - [`FaucetError`] — unified error type
11//! - [`Source`] / [`Sink`] — async traits for data connectors
12//! - [`RecordTransform`] — record transformation pipeline
13//! - [`ReplicationMethod`] — incremental replication support
14//! - [`schema::infer_schema`] — JSON Schema inference from record samples
15
16pub mod adaptive;
17pub mod auth;
18pub mod check;
19pub mod config;
20#[cfg(feature = "contract")]
21pub mod contract;
22pub mod dlq;
23pub mod drift;
24pub mod error;
25pub mod idempotency;
26#[cfg(feature = "masking")]
27pub mod masking;
28pub mod observability;
29pub mod pipeline;
30#[cfg(feature = "quality")]
31pub mod quality;
32pub mod replication;
33pub mod resilience;
34pub mod retry;
35pub mod schema;
36pub mod shard;
37pub mod stage;
38pub mod state;
39pub mod traits;
40pub mod transform;
41pub mod transforming_source;
42pub mod util;
43pub mod verify;
44pub mod write_mode;
45
46#[cfg(feature = "compression")]
47pub mod compression;
48
49pub use adaptive::{
50    AdaptiveBatchConfig, AdjustDirection, AdjustReason, Adjustment, AimdController, Observation,
51};
52pub use auth::{AuthProvider, AuthReference, AuthSpec, Credential, SharedAuthProvider};
53pub use check::{CheckContext, CheckReport, Probe, ProbeStatus};
54pub use dlq::{
55    DlqConfig, DlqReason, DlqStats, EnvelopeError, OnBatchError, UnwrappedEnvelope, build_envelope,
56    unwrap_envelope,
57};
58pub use drift::{
59    ColumnChange, OnDrift, OnIncompatible, SchemaDiff, SchemaDriftPolicy, SchemaDriftSpec,
60    SchemaEvolution, SqlBaseType, adds_null, base_widened, json_schema_base_type,
61};
62pub use error::FaucetError;
63pub use idempotency::{
64    DeliveryGuarantee, DeliveryMode, EffectivelyOnceMechanism, GuaranteeInputs, ReplayGuarantee,
65    SinkGuarantee, derive_delivery_guarantee, format_token, format_token_with_bookmark,
66    parse_token, parse_token_parts, unwrap_state, wrap_state,
67};
68#[cfg(feature = "contract")]
69pub use observability::instrumented_apply_contract;
70#[cfg(feature = "masking")]
71pub use observability::instrumented_apply_masking;
72#[cfg(feature = "quality")]
73pub use observability::instrumented_apply_quality;
74pub use observability::otel::{OtelConfig, OtelProtocol, OtelSignal, shutdown_otel};
75pub use observability::{
76    DurationGuard, InstallError, InstallReport, InstrumentedSink, InstrumentedSource,
77    InstrumentedStateStore, Labels, ObservabilityConfig, PrometheusConfig, RunStreamOptions,
78    TracingConfig, install_observability, instrumented_apply_stages, register_build_info,
79    update_bookmark_lag,
80};
81pub use pipeline::{
82    DEFAULT_BATCH_SIZE, MAX_BATCH_SIZE, Pipeline, PipelineResult, StreamPage, run_stream,
83    validate_batch_size,
84};
85pub use replication::ReplicationMethod;
86pub use resilience::{
87    BackoffKind, CircuitBreaker, CircuitBreakerConfig, PoisonAction, PoisonPolicy,
88    ResiliencePolicy, RetryClass, RetryClassSet, RetryMetrics, RetryPolicy, classify,
89    execute_with_policy, execute_with_policy_metered,
90};
91pub use retry::execute_with_retry;
92pub use shard::ShardSpec;
93#[cfg(feature = "transform-cdc-unwrap")]
94pub use stage::CdcUnwrapSpec;
95#[cfg(feature = "transform-explode")]
96pub use stage::{ExplodeSpec, OnMissing};
97#[cfg(feature = "transform-filter")]
98pub use stage::{FilterOp, FilterSpec};
99pub use stage::{TransformStage, compile_stage};
100pub use state::{FileStateStore, MemoryStateStore, StateStore};
101pub use traits::{RowOutcome, Sink, Source};
102#[cfg(feature = "transform-keys-case")]
103pub use transform::KeyCaseMode;
104pub use transform::RecordTransform;
105#[cfg(feature = "transform-value-case")]
106pub use transform::ValueCaseMode;
107#[cfg(feature = "transform-cast")]
108pub use transform::{CastOnError, CastType};
109pub use transforming_source::TransformingSource;
110pub use util::redact_uri_credentials;
111pub use verify::{IntegrityCheck, LengthCheck, VerifyingReader};
112pub use write_mode::{
113    DeleteMarker, KeyTuple, WriteMode, WritePlan, WriteSpec, key_to_doc_id, key_to_filter,
114    plan_writes,
115};
116
117// Re-export dependencies that connector authors need, so they only depend on
118// `faucet-core` instead of adding `async-trait` and `serde_json` themselves.
119pub use async_stream;
120pub use async_trait::async_trait;
121pub use futures_core::{self, Stream};
122pub use schemars::{self, JsonSchema, schema_for};
123pub use serde_json::{self, Value, json};
124/// Re-exported so callers of [`Pipeline::with_cancel`](pipeline::Pipeline::with_cancel)
125/// / [`RunStreamOptions::with_cancel`] can name the token type without adding
126/// `tokio-util` themselves.
127pub use tokio_util::sync::CancellationToken;
128
129#[cfg(feature = "compression")]
130pub use compression::{Compression, CompressionConfig, compress_buf, warn_mismatch};
131
132#[cfg(feature = "quality")]
133pub use quality::{
134    BatchCheck, CheckTally, CompareOp, CompiledQuality, JsonType, OnFailure, QualityOutcome,
135    QualitySpec, QuarantinedRecord, RecordCheck, apply_quality,
136};
137
138#[cfg(feature = "contract")]
139pub use contract::{
140    CompiledContract, ContractFieldType, ContractOutcome, ContractSpec, ContractViolation,
141    FieldContract, OnBreach, ViolatingRecord, apply_contract, to_json_schema, to_openlineage_facet,
142};
143
144#[cfg(feature = "masking")]
145pub use masking::{
146    CompiledMasking, Detector, MaskAction, MaskHit, MaskRule, MaskingOutcome, MaskingSpec,
147    MatchSpec, apply_masking,
148};
faucet_core/lib.rs

faucet_core/
lib.rs
