Google BigQuery

archive

true

The connector type, like 'builtin://elastic_search'

autoAck

true

false

Boolean denotes whether or not the framework will automatically acknowledge messages

className

true

The connector type’s class reference, like 'org.apache.pulsar.io.debezium.mysql.DebeziumMysqlSource'

cleanupSubscription

false

false

Boolean denotes whether the subscriptions the functions created/used should be deleted when the functions is deleted

configs

false

{}

A key/value map of config properties specific to the type of connector. See the reference table below for values.

customRuntimeOptions

false

A string that encodes options to customize the runtime, see Apache Pulsar docs for configured runtime for details

deadLetterTopic

false

Name of the dead topic where the failing messages will be sent

inputSpecs

false

The map of input topics to its consumer configuration, each configuration has schema of {"schemaType": "type-x", "serdeClassName": "name-x", "isRegexPattern": true, "receiverQueueSize": 5}

inputs

true

[]

The input topic or topics of the Sink (specified as a JSON array)

maxMessageRetries

false

Maximum number of times that a message will be redelivered before being sent to the dead letter queue

name

true

Give your sink a good name for later reference. The name must start with a lowercase alphabetic character. It can only contain lowercase alphanumeric characters, and hyphens(kebab-case).

namespace

true

The namespace you’d like the sink created under

negativeAckRedeliveryDelayMs

false

The negative ack message redelivery delay in milliseconds

parallelism

true

1

The number of sink instances to run

processingGuarantees

true

ATLEAST_ONCE

The delivery semantics applied to the Pulsar Sink. Values are 'ATLEAST_ONCE', 'ATMOST_ONCE', 'EFFECTIVELY_ONCE'

resources

false

The compute resources that need to be allocated per instance (applicable only to the process)(as a JSON string). Example: {"cpu": 0.25,"disk":1000000000,"ram":500000000}

retainKeyOrdering

false

true

Sink consumes and processes messages in key order

retainOrdering

false

false

Boolean denotes whether the Pulsar Sink consumes and processes messages in order

runtimeFlags

false

A string that encodes options to customize the runtime, see Apache Pulsar docs for configured runtime for details

secrets

false

This is a map of secretName(that is how the secret is going to be accessed in the function via context) to an object that encapsulates how the secret is fetched by the underlying secrets provider. The type of an value here can be found by the SecretProviderConfigurator.getSecretObjectType() method

sourceSubscriptionName

false

Pulsar source subscription name if user wants a specific subscription-name for input-topic consumer

sourceSubscriptionPosition

false

Earliest

The position to begin reading from the source

tenant

true

The tenant you’d like the sink created under

timeoutMs

false

5000

Denotes the message timeout in milliseconds

topicToSchemaProperties

false

topicToSchemaType

false

The map of input topics to Schema types or class names (specified as a JSON object)

topicToSerdeClassName

false

The map of input topics to SerDe class names (specified as a JSON object)

topicsPattern

false

TopicsPattern to consume from list of topics under a namespace that match the pattern. [input] and [topicsPattern] are mutually exclusive. Add SerDe class name for a pattern in customSerdeInputs (supported for java fun only)

kafkaConnectorSinkClass

yes

offsetStorageTopic

yes

Pulsar topic to store offsets at. This is an additional topic to your topic with the actual data going to BigQuery.

sanitizeTopicName

yes

batchSize

no

16384

Size of messages in bytes the sink will attempt to batch messages together before flush.

collapsePartitionedTopics

no

false

Supply Kafka record with topic name without -partition- suffix for partitioned topics.

kafkaConnectorConfigProperties

no

{}

A key/value map of config properties to pass to the Kafka connector. See the reference table below.

lingerTimeMs

no

2147483647L

Time interval in milliseconds the sink will attempt to batch messages together before flush.

maxBatchBitsForOffset

no

12

Number of bits (0 to 20) to use for index of message in the batch for translation into an offset. 0 to disable this behavior (Messages from the same batch will have the same offset which can affect some connectors.)

topic

yes

The Kafka topic name that is passed to the Kafka sink.

unwrapKeyValueIfAvailable

no

true

In case of Record<KeyValue<>> data use key from KeyValue<> instead of one from Record.

useIndexAsOffset

no

true

Allows use of message index instead of message sequenceId as offset, if available. Requires AppendIndexMetadataInterceptor and exposingBrokerEntryMetadataToClientEnabled=true on brokers.

useOptionalPrimitives

no

false

Pulsar schema does not contain information whether the Schema is optional, Kafka’s does. This provides a way to force all primitive schemas to be optional for Kafka.

allBQFieldsNullable

no

false

If true, no fields in any produced BigQuery schemas are REQUIRED. All non-nullable Avro fields are translated as NULLABLE (or REPEATED, if arrays).

allowBigQueryRequiredFieldRelaxation

no

false

If true, fields in BigQuery Schema can be changed from REQUIRED to NULLABLE.

allowNewBigQueryFields

no

false

If true, new fields can be added to BigQuery tables during subsequent schema updates.

allowSchemaUnionization

no

false

autoCreateBucket

no

true

Whether to automatically create the given bucket if it does not exist.

autoCreateTables

no

false

Automatically create BigQuery tables if they don’t already exist

avroDataCacheSize

no

100

The size of the cache to use when converting schemas from Avro to Kafka Connect.

batchLoadIntervalSec

no

120

The interval, in seconds, in which to attempt to run GCS to BigQuery load jobs. Only relevant if enableBatchLoad is configured.

bigQueryMessageTimePartitioning

no

false

Whether or not to use the message time when inserting records. Default uses the connector processing time.

bigQueryPartitionDecorator

no

true

Whether or not to append partition decorator to BigQuery table name when inserting records. Default is true. Setting this to true appends partition decorator to table name (e.g. table$yyyyMMdd depending on the configuration set for bigQueryPartitionDecorator). Setting this to false bypasses the logic to append the partition decorator and uses raw table name for inserts.

bigQueryRetry

no

0

The number of retry attempts made for a BigQuery request that fails with a backend error or a quota exceeded error.

bigQueryRetryWait

no

1000

The minimum amount of time, in milliseconds, to wait between retry attempts for a BigQuery backend or quota exceeded error.

clusteringPartitionFieldNames

no

Comma-separated list of fields where data is clustered in BigQuery.

convertDoubleSpecialValues

no

false

Designates whether +Infinity is converted to Double.MAX_VALUE and whether -Infinity and NaN are converted to Double.MIN_VALUE to ensure successful delivery to BigQuery.

defaultDataset

yes

The default dataset to be used

deleteEnabled

no

false

Enable delete functionality on the connector through the use of record keys, intermediate tables, and periodic merge flushes. A delete will be performed when a record with a null value (that is–a tombstone record) is read. This feature will not work with SMTs that change the name of the topic.

enableBatchLoad

no

empty

Beta Feature. Use with caution. The sublist of topics to be batch loaded through GCS.

gcsBucketName

no

empty

The name of the bucket where Google Cloud Storage (GCS) blobs are located. These blobs are used to batch-load to BigQuery. This is applicable only if enableBatchLoad is configured.

includeKafkaData

no

false

Whether to include an extra block containing the Kafka source topic, offset, and partition information in the resulting BigQuery rows.

intermediateTableSuffix

no

.tmp

A suffix that will be appended to the names of destination tables to create the names for the corresponding intermediate tables. Multiple intermediate tables may be created for a single destination table, but their names will always start with the name of the destination table, followed by this suffix, and possibly followed by an additional suffix.

kafkaDataFieldName

no

The Kafka data field name. The default value is null, which means the Kafka Data field will not be included.

kafkaKeyFieldName

no

The Kafka key field name. The default value is null, which means the Kafka Key field will not be included.

keyfile

yes

keySource

yes

FILE

name

yes

The name of the connector. Use the same value as Pulsar sink name.

mergeIntervalMs

no

60_000L

How often (in milliseconds) to perform a merge flush, if upsert/delete is enabled. Can be set to -1 to disable periodic flushing.

mergeRecordsThreshold

no

-1

How many records to write to an intermediate table before performing a merge flush, if upsert/delete is enabled. If set to -1, then record count-based flushing is disabled.

project

yes

The BigQuery project to write to

queueSize

no

-1

The maximum size (or -1 for no maximum size) of the worker queue for BigQuery write requests before all topics are paused. This is a soft limit; the size of the queue can go over this before topics are paused. All topics resume once a flush is triggered or the size of the queue drops under half of the maximum size.

sanitizeTopics

yes

false

schemaRetriever

no

com.wepay.kafka.connect.bigquery.retrieve.IdentitySchemaRetriever

A class that can be used for automatically creating tables and/or updating schemas.

threadPoolSize

no

10

The size of the BigQuery write thread pool. This establishes the maximum number of concurrent writes to BigQuery.

timePartitioningType

no

DAY

The time partitioning type to use when creating tables. Existing tables will not be altered to use this partitioning type. Valid Values: (case insensitive) [MONTH, YEAR, HOUR, DAY]

timestampPartitionFieldName

no

The name of the field in the value that contains the timestamp to partition by in BigQuery and enable timestamp partitioning for each table. Leave this configuration blank, to enable ingestion time partitioning for each table.

topic2TableMap

no

topics

yes

A list of Kafka topics to read from. Use the same name as the Pulsar topic. Only provide the topic name, not the whole address.

upsertEnabled

no

false

Enable upsert functionality on the connector through the use of record keys, intermediate tables, and periodic merge flushes. Row-matching will be performed based on the contents of record keys. This feature won’t work with SMTs that change the name of the topic.