package
25.1.0+incompatible
Repository: https://github.com/cockroachdb/cockroach.git
Documentation: pkg.go.dev

# Functions

HandleStreamErr is a utility method used to handle an error when calling a method on a flowStreamClient.
IsFlowRetryableError returns true if an error represents a retryable flow error.
IsNoInboundStreamConnectionError returns true if err's Cause is an errNoInboundStreamConnection.
NewFlowBase creates a new FlowBase.
NewFlowRegistry creates a new FlowRegistry.
NewInboundStreamInfo returns a new InboundStreamInfo.
NewOutbox creates a new Outbox.
NewRemoteFlowRunner creates a new RemoteFlowRunner which must be initialized before use.
StartMockDistSQLServer starts a MockDistSQLServer and returns the address on which it's listening.

# Constants

FuseAggressively means serialize unordered input synchronizers.
FuseNormally means fuse what you can, but don't serialize unordered input synchronizers.
OutboxBufRows is the maximum number of rows that are buffered by the Outbox before flushing.
PreferredEncoding is the encoding used for EncDatums that don't already have an encoding available.

# Variables

SettingFlowStreamTimeout is a cluster setting that sets the default flow stream timeout.

# Structs

FlowBase is the shared logic between row based and vectorized flows.
FlowRegistry allows clients to look up flows by ID and to wait for flows to be registered.
InboundStreamInfo represents the endpoint where a data stream from another node connects to a flow.
InboundStreamNotification is the MockDistSQLServer's way to tell its clients that a new gRPC call has arrived and thus a stream has arrived.
MockDialer is a mocked implementation of the Outbox's `Dialer` interface.
MockDistSQLServer implements the DistSQLServer (gRPC) interface and allows clients to control the inbound streams.
Outbox implements an outgoing mailbox as a RowReceiver that receives rows and sends them to a gRPC stream.
RemoteFlowRunner manages running flows that are created on behalf of other nodes.
RowInboundStreamHandler is an InboundStreamHandler for the row based flow.
StreamDecoder converts a sequence of ProducerMessage to rows and metadata records.
StreamEncoder converts EncDatum rows into a sequence of ProducerMessage.
TestingKnobs are the testing knobs for flowinfra.

# Interfaces

Flow represents a flow which consists of processors and streams.
InboundStreamHandler is a handler of an inbound stream.
Startable is any component that can be started (a router or an outbox).

# Type aliases

FuseOpt specifies options for processor fusing at Flow.Setup() time.
StartableFn is an adapter when a customer function (i.e.