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

# Packages

# Functions

GetFirstActiveClient iterates through each provided stream uri and returns the first client it's able to successfully dial.
GetFirstActiveSpanConfigClient iterates through each provided stream address and returns the first client it's able to successfully Dial.
MakeClusterUriForNode creates a new ClusterUri with the node address set to the given address.
MakeTestClusterUri creates an unvalidated ClusterUri for testing.
NewHeartbeatSender creates a new HeartbeatSender.
NewStreamClient creates a new stream client based on the stream address.
WithBatchSize requests the producer emit batches up to the specified size.
WithCompression controls requesting a compressed stream from the producer.
WithDiff controls whether the producer-side rangefeeds should be started with the WithDiff option NB: Callers should note that initial scan results will not contain a diff.
WithFiltering controls whether the producer side rangefeed is started with the WithFiltering option, eliding rows where OmitInRangefeed was set at write-time.
WithStreamID sets the StreamID for the client.

# Constants

RandomGenScheme is the URI scheme used to create a test load.
routingModeGateway is a routing mode that replaces the default node routing mode.
routinModeNode is the default routing mode for LDR and PCR.
SslInlineURLParam is a non-standard connection URL parameter.

# Variables

GetRandomStreamClientSingletonForTesting returns the singleton instance of the client.

# Structs

ClusterUri is a connection uri for a crdb cluster.
ConfigUri is a URI supplied as configuration to the job.
ErrorStreamClient always returns an error when consuming a partition.
HeartbeatSender periodically sends a heartbeat for the given streamID to the given client.
MockStreamClient will return the slice of events associated to the stream partition being consumed.
PartitionInfo describes a partition of a replication stream, i.e.
Topology is a configuration of stream partitions.

# Interfaces

Client provides methods to stream updates from an application tenant.
SpanConfigClient provides methods to interact with a stream of span config updates of a specific application tenant.
Subscription represents subscription to a replication stream partition.

# Type aliases

CheckpointToken is an opaque identifier which can be used to represent checkpoint information to start a stream processor.
DialInterceptFn is a function that will intercept Dial calls made to an InterceptableStreamClient.
HeartbeatInterceptFn is a function that will intercept calls to a client's Heartbeat.
InterceptFn is a function that will intercept events emitted by an InterceptableStreamClient.
An Option configures some part of a Client.
SSTableMakerFn is a function that generates RangeFeedSSTable event with a given list of roachpb.KeyValue.
SubscriptionToken is an opaque identifier returned by Plan which can be used to subscribe to a given partition.