package
0.0.0-20220127160557-8b3bc450087d
Repository: https://github.com/estuary/protocols.git
Documentation: pkg.go.dev
# Packages
No description provided by the author
# Functions
AdaptServerToClient wraps an in-process DriverServer to provide a DriverClient.
No description provided by the author
NewLoadIterator returns a *LoadIterator of the stream.
NewStoreIterator returns a *StoreIterator of the stream.
OpenTransactions opens a Transactions RPC.
No description provided by the author
RunTransactions processes materialization protocol transactions over the established stream against a Driver.
Rx receives from a TransactionResponse channel.
StageLoad potentially sends a previously staged Load into the stream, and then stages its arguments into request.Load.
StageLoaded potentially sends a previously staged Loaded into the stream, and then stages its arguments into response.Loaded.
StageStore potentially sends a previously staged Store into the stream, and then stages its arguments into request.Store.
TransactionResponseChannel spawns a goroutine which receives from the stream and sends responses into the returned channel, which is closed after the first encountered read error.
WriteAcknowledge writes an Acknowledge request into the stream.
WriteAcknowledged writes an Acknowledged response to the stream.
WriteCommit flushes a pending Store request, and sends a Commit request.
WriteDriverCommitted writes a DriverCommitted response to the stream.
WritePrepare flushes a pending Load request, and sends a Prepare request with the provided Flow checkpoint.
WritePrepared flushes a pending Loaded response, and sends a Prepared response with the provided driver checkpoint.
# Constants
This projection must not be present in the materialization.
This projection may be included, but should be omitted by default.
This specific projection must be present.
A projection with this location is recommended, and should be included by default.
At least one projection with this location pointer must be present.
This specific projection is required but is also unacceptable (e.x., because it uses an incompatible type with a previous applied version).
# 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
ExplicitZeroCheckpoint is a zero-valued message encoding, implemented as a trivial encoding of the max-value 2^29-1 protobuf tag with boolean true.
# Structs
ApplyRequest is the request type of the ApplyUpsert and ApplyDelete RPCs.
ApplyResponse is the response type of the ApplyUpsert and ApplyDelete RPCs.
CommitOps are operations which coordinate the mutual commit of a transaction between the Flow runtime and materialization driver.
Constraint constrains the use of a flow.Projection within a materialization.
LoadIterator is an iterator over Load requests.
SpecRequest is the request type of the Spec RPC.
SpecResponse is the response type of the Spec RPC.
StoreIterator is an iterator over Store requests.
TransactionRequest is the request type of a Transaction RPC.
Notify the driver that the previous transaction has committed to the Flow runtime's recovery log.
Mark the end of the Store phase, and if the remote store is authoritative, instruct it to commit its transaction.
Load one or more documents identified by key.
Open a transaction stream.
Prepare to commit.
Store documents of this transaction commit.
TransactionResponse is the response type of a Transaction RPC.
Notify the Flow runtime of receipt of it's confirmation that the Flow recovery log has committed.
Mark the end of the Store phase, indicating that all documents have been fully stored.
Loaded responds to TransactionRequest.Loads of the client.
Opened responds to TransactionRequest.Open of the client.
TransactionResponseError is a channel-oriented wrapper of TransactionResponse.
TxnClient is a client of a driver's Transactions RPC.
UnimplementedDriverServer can be embedded to have forward compatible implementations.
ValidateRequest is the request type of the Validate RPC.
Bindings of endpoint resources and collections from which they would be materialized.
ValidateResponse is the response type of the Validate RPC.
Validation responses for each binding of the request, and matching the request ordering.
# Interfaces
No description provided by the author
No description provided by the author
DriverClient is the client API for Driver service.
DriverServer is the server API for Driver service.
Transactor is a store-agnostic interface for a materialization driver that implements Flow materialization protocol transactions.
# Type aliases
Type encodes a constraint type for this flow.Projection.