package
0.0.0-20220127160557-8b3bc450087d
Repository: https://github.com/estuary/protocols.git
Documentation: pkg.go.dev
# Functions
GetProjectionByField finds the projection with the given field name, or nil if one does not exist.
NewFullRange returns a RangeSpec covering the full key and r-clock range.
No description provided by the author
No description provided by the author
NewUUIDParts returns a decomposition of |uuid| into its UUIDParts.
No description provided by the author
No description provided by the author
UnmarshalStrict unmarshals |doc| into |m|, using a strict decoding of the document which prohibits unknown fields.
# Constants
Begin a build with a Config (Go -> Rust).
Generate catalog specification JSON schema (Go <-> Rust).
Build completed successfully (Rust -> Go).
Build completed with errors (Rust -> Go).
Poll the build after completing one or more trampoline tasks (Go -> Rust).
Trampoline task start or completion (Rust <-> Go).
Trampoline sub-type: Start fetch of a resource.
Trampoline sub-type: Start validation of a capture.
Trampoline sub-type: Start validation of a materialization.
Combine a right-hand side document (Go -> Rust).
Configure or re-configure the combiner (Go -> Rust).
Drain the combiner (Go -> Rust).
Next drained document is partially combined (Rust -> Go).
Next drained fields (follows key; Rust -> Go).
Next drained key (follows drained document; Rust -> Go).
Next drained document is fully reduced (Rust -> Go).
No description provided by the author
Reduce a left-hand side document (Go -> Rust).
Drain stats, sent after all documents have been drained.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Begin a new transaction (Go -> Rust).
Clear registers values (test support only; Go -> Rust).
Configure or re-configure the derive API (Go -> Rust).
Next drained document is partially combined (Rust -> Go).
Next drained fields (follows key; Rust -> Go).
Next drained key (follows drained document; Rust -> Go).
Next drained document is fully reduced (Rust -> Go).
Flush transaction (Go -> Rust).
No description provided by the author
Next source document body (Go -> Rust).
Next source document header (Go -> Rust).
Open the registers database (Go -> Rust).
Prepare transaction to commit (Go -> Rust).
Restore the last checkpoint from an opened database (Go <-> Rust).
Drain stats, sent after all documents have been drained.
Trampoline task start or completion (Rust <-> Go).
Trampoline sub-type: invoke transform lambda.
No description provided by the author
No description provided by the author
No description provided by the author
Reserved for REMOTE gRPC servers if there's ever a use case.
No description provided by the author
Configure or re-configure the extractor (Go -> Rust).
Extract from a document (Go -> Rust).
Fields extracted from a document (Rust -> Go).
UUID extracted from a document (Rust -> Go).
No description provided by the author
Type_ constants for each type name used in JSON schemas.
Type_ constants for each type name used in JSON schemas.
Type_ constants for each type name used in JSON schemas.
Type_ constants for each type name used in JSON schemas.
Type_ constants for each type name used in JSON schemas.
Type_ constants for each type name used in JSON schemas.
Type_ constants for each type name used in JSON schemas.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Take a request SchemaBundle and respond with a BuiltIndex.
No description provided by the author
No description provided by the author
No description provided by the author
# Variables
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
DocumentUUIDPlaceholder is a unique 36-byte sequence which is used to mark the location within a document serialization which holds the document UUID.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Structs
AdvanceTimeRequest is the request of the Testing.AdvanceTime RPC.
AdvanceTimeResponse is the response of the Testing.AdvanceTime RPC.
BuildAPI is a meta-message which name spaces messages of the Build API bridge.
No description provided by the author
No description provided by the author
CaptureSpec describes a collection and its capture from an endpoint.
Bindings of endpoint resources and collections into which they're captured.
No description provided by the author
No description provided by the author
No description provided by the author
Stats holds statistics relating to one or more combiner transactions.
DerivationSpec describes a collection, and it's means of derivation.
DeriveAPI is a meta-message which name spaces messages of the Derive API bridge.
Config configures the derived DerivationSpec and its associated schema index.
DocHeader precedes a JSON-encoded document.
Invoke a lambda, using Rust-owned memory buffers of invocation content.
Open the registers database.
Prepare a commit of the transaction.
Stats holds statistics relating to a single derive transaction.
Stats about the invocation of update or publish lambdas.
No description provided by the author
No description provided by the author
DocsAndBytes represents a count of JSON documents, and their cumulative total size in bytes.
DriverCheckpoint is a driver-originated checkpoint withn a capture or materialization.
No description provided by the author
No description provided by the author
FieldSelection is a selection of a collection's projection fields.
IndexedShuffleResponse is an implementation of message.Message which indexes a specific document within a ShuffleResponse.
Inference details type information which is statically known about a given document location.
String type-specific inferences, or nil iff types doesn't include "string".
No description provided by the author
IngestResponse is the response of the Testing.Ingest RPC.
JournalShuffle is a Shuffle of a Journal by a Coordinator shard.
LambdaSpec describes a Flow transformation lambda and how to invoke it.
MaterializationSpec describes a collection and its materialization to an endpoint.
Bindings of endpoint resources and collections from which they're materialized.
MockCombiner implements Combiner by recording invocations of ReduceLeft, CombineRight, and Destroy, and by returning pre-arranged fixtures upon a call to Drain.
Projection is a mapping between a document location, specified as a JSON-Pointer, and a corresponding field string in a flattened (i.e.
RangeSpec describes the ranges of shuffle keys and r-clocks which a reader is responsible for.
ResetStateRequest is the request of the Testing.ResetState RPC.
ResetStateResponse is the response of the Testing.ResetState RPC.
No description provided by the author
No description provided by the author
SchemaBundle is a bundle of JSON schemas and their base URI.
Shuffle is a description of a document shuffle, where each document is mapped into: * An extracted, packed composite key (a "shuffle key").
ShuffleRequest is the request message of a Shuffle RPC.
ShuffleResponse is the streamed response message of a Shuffle RPC.
Slice represents a contiguous slice of bytes within an associated Arena.
TestSpec describes a catalog test.
Steps of the test.
TransformSpec describes a specific transform of a derivation.
UnimplementedShufflerServer can be embedded to have forward compatible implementations.
UnimplementedTestingServer can be embedded to have forward compatible implementations.
UUIDParts is a deconstructed, RFC 4122 v1 variant Universally Unique Identifier as used by Gazette.
# Interfaces
Combiner combines and reduces keyed documents.
No description provided by the author
No description provided by the author
ShufflerClient is the client API for Shuffler service.
ShufflerServer is the server API for Shuffler service.
Task is a common interface of specifications which are also Flow runtime tasks.
TestingClient is the client API for Testing service.
TestingServer is the server API for Testing service.
# Type aliases
Arena is a packed memory region into which byte content and strings are written.
Code labels message codes passed over the CGO bridge.
Capture is a type wrapper for Capture catalog task names.
No description provided by the author
Collection names a specified catalog collection.
Code labels message codes passed over the CGO bridge.
ContentType enumerates the content types understood by Flow.
Codes passed over the CGO bridge.
No description provided by the author
EndpointType enumerates the endpoint types understood by Flow.
Code labels message codes passed over the CGO bridge.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
LogLevelFilter is a common representation of a simple logging filter, which is shared between Rust and Go code.
Materialization is a type wrapper for Materialization catalog task names.
No description provided by the author
No description provided by the author
Code labels message codes passed over the CGO bridge.
No description provided by the author
No description provided by the author
Type of this step.
Transform names a specified catalog transformation.