package
3.84.1
Repository: https://github.com/ydb-platform/ydb-go-sdk.git
Documentation: pkg.go.dev

# Functions

AlterConsumerWithAttributes change attributes of the consumer.
AlterConsumerWithImportant set/remove important flag for the consumer of topic.
AlterConsumerWithReadFrom change min time of messages, received for the topic.
AlterConsumerWithSupportedCodecs change codecs, supported by the consumer.
AlterWithAddConsumers add consumer to the topic.
AlterWithAttributes change attributes map of topic.
AlterWithDropConsumers drop consumer from the topic.
AlterWithMeteringMode change metering mode for topic (need for serverless installations).
AlterWithMinActivePartitions change min active partitions of the topic.
AlterWithPartitionCountLimit change partition count limit of the topic.
AlterWithPartitionWriteBurstBytes change burst size for write to partition of topic.
AlterWithPartitionWriteSpeedBytesPerSecond change limit of write speed for partitions of the topic.
AlterWithRetentionPeriod change retention period of topic.
AlterWithRetentionStorageMB change retention storage size in MB.
AlterWithSupportedCodecs change set of codec, allowed for the topic.
CreateWithAttributes set attributes for the topic.
CreateWithConsumer create new consumers with the topic.
CreateWithMeteringMode set metering mode for the topic.
CreateWithMinActivePartitions set min active partitions for the topic.
CreateWithPartitionCountLimit set partition count limit for the topic.
CreateWithPartitionWriteBurstBytes set burst limit for partitions of the topic.
CreateWithPartitionWriteSpeedBytesPerSecond set write size limit for partitions of the topic.
CreateWithRetentionPeriod set retention time interval for the topic.
CreateWithRetentionStorageMB set retention size for the topic.
CreateWithSupportedCodecs set supported codecs for the topic.
ReadTopic create simple selector for read topics, if no need special settings.
WithAddDecoder add decoder for a codec.
WithBatchReadMaxCount Deprecated: was experimental and not actual now.
WithBatchReadMinCount prefer min count messages in batch sometimes batch can contain fewer messages, for example if local buffer is full and SDK can't receive more messages Deprecated: was experimental and not actual now.
WithCodec Deprecated: was experimental and not actual now.
WithCodecAutoSelect Deprecated: was experimental and not actual now.
WithCommitCountTrigger Deprecated: was experimental and not actual now.
WithCommitMode Deprecated: was experimental and not actual now.
WithCommitTimeLagTrigger Deprecated: was experimental and not actual now.
WithCommonConfig Experimental: https://github.com/ydb-platform/ydb-go-sdk/blob/master/VERSIONING.md#experimental.
WithGetPartitionStartOffset Deprecated: was experimental and not actual now.
WithListenerAddDecoder add decoder for a codec.
WithMessagesBufferSize Deprecated: was experimental and not actual now.
WithOnWriterFirstConnected set callback f, which will called once - after first successfully init topic writer stream Deprecated: was experimental and not actual now.
WithOperationCancelAfter set the maximum amount of time a YDB server will process an operation.
WithOperationTimeout set the maximum amount of time a YDB server will process an operation.
WithPartitionID Deprecated: was experimental and not actual now.
WithProducerID Deprecated: was experimental and not actual now.
WithReaderBatchMaxCount set max messages count, returned by topic.TopicReader.ReadBatch method.
WithReaderBufferSizeBytes set size of internal buffer for read ahead messages.
WithReaderCheckRetryErrorFunction can override default error retry policy use CheckErrorRetryDecisionDefault for use default behavior for the error callback func must be fast and deterministic: always result same result for same error - it can be called few times for every error.
WithReaderCommitCountTrigger set count trigger for send batch to server if count > 0 and sdk count of buffered commits >= count - send commit request to server 0 mean no count limit and use timer lag trigger only.
WithReaderCommitMode set commit mode to the reader.
WithReaderCommitTimeLagTrigger set time lag from first commit message before send commit to server for accumulate many similar-time commits to one server request 0 mean no additional lag and send commit soon as possible Default value: 1 second.
WithReaderGetPartitionStartOffset set optional handler for own manage progress of read partitions instead of/additional to commit messages.
WithReaderOperationCancelAfter Experimental: https://github.com/ydb-platform/ydb-go-sdk/blob/master/VERSIONING.md#experimental.
WithReaderOperationTimeout Experimental: https://github.com/ydb-platform/ydb-go-sdk/blob/master/VERSIONING.md#experimental.
WithReaderStartTimeout mean timeout for connect to reader stream and work some time without errors Experimental: https://github.com/ydb-platform/ydb-go-sdk/blob/master/VERSIONING.md#experimental.
WithReaderTrace set tracer for the topic reader Experimental: https://github.com/ydb-platform/ydb-go-sdk/blob/master/VERSIONING.md#experimental.
WithReaderUpdateTokenInterval set custom interval for send update token message to the server.
WithReaderWithoutConsumer allow read topic without consumer.
WithSyncWrite Deprecated: was experimental and not actual now.
WithTrace defines trace over persqueue client calls Experimental: https://github.com/ydb-platform/ydb-go-sdk/blob/master/VERSIONING.md#experimental.
WithWriterAddEncoder add custom codec implementation to writer.
WithWriterCheckRetryErrorFunction can override default error retry policy use CheckErrorRetryDecisionDefault for use default behavior for the error callback func must be fast and deterministic: always result same result for same error - it can be called few times for every error.
WithWriterCodec disable codec auto select and force set codec for the write session.
WithWriterCodecAutoSelect - auto select best codec for messages stream enabled by default if option enabled - send a batch of messages for every allowed codec (for prevent delayed bad codec accident) then from time to time measure all codecs and select codec with the smallest result messages size.
WithWriterCompressorCount set max count of goroutine for compress messages must be more zero panic if num <= 0.
WithWriterMaxQueueLen set max len of queue for wait ack Experimental: https://github.com/ydb-platform/ydb-go-sdk/blob/master/VERSIONING.md#experimental.
WithWriterMessageMaxBytesSize set max body size of one message in bytes.
WithWriterPartitionID set direct partition id on write session level.
WithWriterProducerID set producer for write session.
WithWriterSessionMeta set writer's session metadata.
WithWriterSetAutoCreatedAt set messages CreatedAt by SDK enabled by default if enabled - Message.CreatedAt field must be zero.
WithWriterSetAutoSeqNo set messages SeqNo by SDK enabled by default if enabled - Message.SeqNo field must be zero.
WithWriterStartTimeout mean timeout for connect to writer stream and work some time without errors.
WithWriterTrace set tracer for the writer.
WithWriterUpdateTokenInterval set time interval between send auth token to the server.
WithWriterWaitServerAck - when enabled every Write call wait ack from server for all messages from the call disabled by default.
WithWriteSessionMeta Deprecated: was experimental and not actual now.

# Constants

default.
CommitModeNone - reader will not be commit operation.
CommitModeSync - commit return true when sdk receive ack of commit from server The mode needs strong ordering client code for prevent deadlock.

# Variables

Apply default behavior for the error.
Do once more retry.
Do not retry.

# Interfaces

AlterOption type of options for change topic settings.
CreateOption type for options of topic create.
DropOption type for drop options.

# Type aliases

No description provided by the author
No description provided by the author
No description provided by the author
CommitMode variants of commit mode of the reader.
CreateDecoderFunc interface for fabric of message decoders.
CreateEncoderFunc for create message decoders.
DescribeOption type for options of describe method.
No description provided by the author
No description provided by the author
No description provided by the author
ListenerOption set settings for topic listener struct Experimental: https://github.com/ydb-platform/ydb-go-sdk/blob/master/VERSIONING.md#experimental.
No description provided by the author
ReaderOption options for topic reader.
ReadSelector set rules for reader: set of topic, partitions, start time filted, etc.
ReadSelectors slice of rules for topic reader.
TopicOption Experimental: https://github.com/ydb-platform/ydb-go-sdk/blob/master/VERSIONING.md#experimental.
No description provided by the author
WriterOption options for a topic writer.
WriteSessionMetadata set key-value metadata for write session.