AsTerminalError determines if the cause error is a terminal changefeed error.

IsTaggedError returns whether or not the top level error is a TaggedError along with its tag.

MakeDefaultOptions creates the StatementOptions you'd get from a changefeed statement with no WITH.

MakeStatementOptions wraps and canonicalizes the options we get from TypeAsStringOpts or the job record.

MarkRetryableError wraps the given error, marking it as retryable.s.

MarkTaggedError wraps the given error with an extra tag string property to be read afterwards in cases such as logging.

RedactUserFromURI takes a URI string and removes the user from it.

TestingSetDefaultMinCheckpointFrequency changes DefaultMinCheckpointFrequency for tests.

WithTerminalError decorates underlying error to indicate that the error is a terminal changefeed error.

ConfluentAvroWireFormatMagic is the "magic" header bytes for kafka messages.

ConnectionClosed means the user disconnected from a core changefeed.

Constants for the options.

Deprecated options.

Constants for the options.

Constants for the options.

Constants for the options.

Constants for the options.

Constants for the options.

Constants for the options.

DeprecatedSinkSchemeHTTP is interpreted as cloudstorage over HTTP PUT.

DeprecatedSinkSchemeHTTPS is interpreted as cloudstorage over HTTPS PUT.

Constants for the initial scan types.

Constants for the initial scan types.

Constants for the initial scan types.

OnStartup applies to all non-user-input errors during Planning.

Constants for the options.

Constants for the options.

Constants for the options.

Constants for the options.

Constants for the options.

Constants for the options.

OptEmitAllResolvedTimestamps is a sentinel value to indicate that all resolved timestamp events should be emitted.

Constants for the options.

Constants for the options.

Constants for the options.

Constants for the options.

Constants for the options.

Constants for the options.

Constants for the options.

Constants for the options.

Constants for the options.

Constants for the options.

Constants for the options.

Constants for the options.

Constants for the options.

Constants for the options.

Constants for the options.

Constants for the options.

Constants for the options.

OptInitialScan enables an initial scan.

Constants for the options.

Constants defining OptionTypes.

Constants defining OptionTypes.

Boolean options set to true if present, false if absent.

Constants defining OptionTypes.

OptionTypeString is a catch-all for options needing a value.

Constants defining OptionTypes.

OptKafkaSinkConfig is a JSON configuration for kafka sink (kafkaSinkConfig).

Constants for the options.

Constants for the options.

Constants for the options.

Constants for the options.

Constants for the options.

Constants for the options.

OptNoInitialScan disables an initial scan.

Constants for the options.

Constants for the options.

Constants for the options.

Constants for the options.

Constants for the options.

OptSchemaChangeEventClassColumnChange corresponds to all schema change events which add or remove any column.

OptSchemaChangeEventClassDefault corresponds to all schema change events which add a column with a default value or remove any column.

Constants for the options.

Constants for the options.

OptSchemaChangePolicyBackfill indicates that when a schema change event occurs, a full table backfill should occur.

OptSchemaChangePolicyIgnore indicates that all schema change events should be ignored.

OptSchemaChangePolicyNoBackfill indicates that when a schema change event occurs no backfill should occur and the changefeed should continue.

OptSchemaChangePolicyStop indicates that when a schema change event occurs the changefeed should resolve all data up to when it occurred and then exit with an error indicating the HLC timestamp of the change from which the user could continue.

OptSink allows users to alter the Sink URI of an existing changefeed.

Constants for the options.

Constants for the options.

Constants for the options.

Constants for the options.

Constants for the options.

Constants for the options.

Constants for the options.

Constants for the options.

Constants for the options.

Constants for the options.

Constants for the options.

Constants for the options.

Constants for the options.

Constants for the options.

Constants for the options.

Constants for the options.

Constants for the options.

Constants for the options.

Constants for the options.

Constants for the options.

Constants for the options.

Constants for the options.

Constants for the options.

Constants for the options.

Constants for the options.

Constants for the options.

Constants for the options.

Constants for the options.

Constants for the options.

Constants for the options.

Constants for the options.

Constants for the options.

Constants for the options.

Constants for the options.

Constants for the options.

Constants for the options.

Constants for the options.

Constants for the options.

Constants for the options.

Constants for the options.

Constants for the options.

Constants for the options.

Constants for the options.

Constants for the options.

Constants for the options.

Constants for the options.

Constants for the options.

Constants for the options.

Constants for the options.

Constants for the options.

Constants for the options.

Constants for the options.

Constants for the options.

Constants for the options.

Constants for the options.

Constants for the options.

Topics is used to store the topics generated by the sink in the options struct so that they can be displayed in the show changefeed jobs query.

UnknownError applies to all errors not otherwise categorized.

UserInput applies to errors in the create statement prior to job creation.

AlterChangefeedOptionExpectValues is used to parse alter changefeed options using PlanHookState.TypeAsStringOpts().

AlterChangefeedTargetOptions is used to parse target specific alter changefeed options using PlanHookState.TypeAsStringOpts().

AlterChangefeedUnsupportedOptions are changefeed options that we do not allow users to alter.

BatchReductionRetryEnabled enables the temporary reduction of batch sizes upon kafka message too large errors.

CaseInsensitiveOpts options which supports case Insensitive value.

ChangefeedOptionExpectValues is used to parse changefeed options using PlanHookState.TypeAsStringOpts().

CloudStorageValidOptions is options exclusive to cloud storage sink.

CommonOptions is options common to all sinks.

DefaultLaggingRangesPollingInterval is the default polling rate at which lagging ranges are checked and metrics are updated.

DefaultLaggingRangesThreshold is the default duration by which a range must be lagging behind the present to be considered as 'lagging' behind in metrics.

DefaultMinCheckpointFrequency is the default frequency to flush sink.

ErrNodeDraining indicates that this node is being drained.

EventConsumerPacerRequestSize specifies how often (measured in CPU time) that event consumer workers request CPU time from admission control.

EventConsumerWorkerQueueSize specifies the maximum number of events a worker buffer.

EventConsumerWorkers specifies the maximum number of workers to use when processing events.

EventMemoryMultiplier is the multiplier for the amount of memory needed to process an event.

ExternalConnectionValidOptions is options exclusive to the external connection sink.

IdleTimeout controls how long the changefeed will wait for a new KV being emitted before marking itself as idle.

InitialScanOnlyUnsupportedOptions is options that are not supported with the initial scan only option.

KafkaValidOptions is options exclusive to Kafka sink.

MaxProtectedTimestampAge controls the frequency of protected timestamp record updates.

NodeSinkThrottleConfig is the node wide throttling configuration for changefeeds.

NoLongerExperimental aliases options prefixed with experimental that no longer need to be.

ParquetFormatUnsupportedOptions is options that are not supported with the parquet format.

PerChangefeedMemLimit controls how much data can be buffered by a single changefeed.

PerEventElasticCPUControlEnabled determines whether changefeed event processing integrates with elastic CPU control.

ProtectTimestampInterval controls the frequency of protected timestamp record updates.

ProtectTimestampLag controls how much the protected timestamp record should lag behind the high watermark.

PubsubValidOptions is options exclusive to pubsub sink.

RedactedOptions are options whose values should be replaced with "redacted" in job descriptions and errors.

RequireExternalConnectionSink is used to restrict non-admins with the CHANGEFEED privilege to create changefeeds to external connections only.

ResolvedTimestampMinUpdateInterval specifies the minimum amount of time that must have elapsed since the last time a changefeed's resolved timestamp was updated before it is eligible to updated again.

RetiredOptions are the options which are no longer active.

ScanRequestLimit is the number of Scan requests that can run at once.

ScanRequestSize is the target size of the scan request response.

SinkIOWorkers controls the number of IO workers used by sinks that use parallelIO to be able to send multiple requests in parallel.

SinkPacerRequestSize specifies how often (measured in CPU time) that the Sink batching worker request CPU time from admission control.

SlowSpanLogThreshold controls when we will log slow spans.

SpanCheckpointInterval controls how often span-level checkpoints can be written.

SpanCheckpointLagThreshold controls the amount of time a changefeed's lagging spans must lag behind its leading spans before a span-level checkpoint is written.

SpanCheckpointMaxBytes controls the maximum number of key bytes that will be added to a span-level checkpoint record.

SQLValidOptions is options exclusive to SQL sink.

TableDescriptorPollInterval controls how fast table descriptors are polled.

UsageMetricsReportingInterval is the interval at which the changefeed calculates and updates its usage metric.

UsageMetricsReportingTimeoutPercent is the percent of UsageMetricsReportingInterval that may be spent gathering the usage metrics.

WebhookValidOptions is options exclusive to webhook sink.

CanHandle tracks whether users have explicitly specificed how to handle unusual table schemas.

EncodingOptions describe how events are encoded when sent to the sink.

Filters are aspects of the feed that the backing kvfeed or rangefeed want to know about.

OptionPermittedValues is used in validations and is meant to be self-documenting.

SchemaChangeHandlingOptions specify how the feed should behave when a target is affected by a schema change.

SinkThrottleConfig describes throttling configuration for the sink.

SinkURL is a helper struct which for "consuming" URL query parameters from the underlying URL.

StatementOptions provides friendlier access to the options map from the WITH part of a changefeed statement and smaller bundles to pass around.

Target provides a version-agnostic wrapper around jobspb.ChangefeedTargetSpecification.

Targets is the complete list of target specifications for a changefeed.

WebhookSinkOptions are passed in WITH args but are specific to the webhook sink.

EnvelopeType configures the information in the changefeed events for a row.

FailureType is the reason for the changefeed failure that maps to the failure_type values we emit in the ChangefeedFailed telemetry events.

FormatType configures the encoding format.

InitialScanType configures whether the changefeed will perform an initial scan, and the type of initial scan that it will perform.

OnErrorType configures the job behavior when an error occurs.

OptionsSet is a test of changefeed option strings.

OptionType is an enum of the ways changefeed options can be provided in WITH.

SchemaChangeEventClass defines a set of schema change event types which trigger the action defined by the SchemaChangeEventPolicy.

SchemaChangePolicy defines the behavior of a changefeed when a schema change event which is a member of the changefeed's schema change events.

SinkSpecificJSONConfig is a JSON string that the sink is responsible for parsing, validating, and honoring.

StatementTimeName is the original way a table was referred to when it was added to the changefeed, possibly modified by WITH options.

VirtualColumnVisibility defines the behaviour of how the changefeed will include virtual columns in an event.