datastream.v1alpha1.datastreamStream
Index
fn new(name)
obj metadata
fn withAnnotations(annotations)
fn withAnnotationsMixin(annotations)
fn withClusterName(clusterName)
fn withCreationTimestamp(creationTimestamp)
fn withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)
fn withDeletionTimestamp(deletionTimestamp)
fn withFinalizers(finalizers)
fn withFinalizersMixin(finalizers)
fn withGenerateName(generateName)
fn withGeneration(generation)
fn withLabels(labels)
fn withLabelsMixin(labels)
fn withName(name)
fn withNamespace(namespace)
fn withOwnerReferences(ownerReferences)
fn withOwnerReferencesMixin(ownerReferences)
fn withResourceVersion(resourceVersion)
fn withSelfLink(selfLink)
fn withUid(uid)
obj spec
fn withBackfillNone(backfillNone)
fn withBackfillNoneMixin(backfillNone)
fn withCustomerManagedEncryptionKey(customerManagedEncryptionKey)
fn withDesiredState(desiredState)
fn withDisplayName(displayName)
fn withLocation(location)
fn withResourceID(resourceID)
obj spec.backfillAll
obj spec.backfillAll.mysqlExcludedObjects
fn withMysqlDatabases(mysqlDatabases)
fn withMysqlDatabasesMixin(mysqlDatabases)
obj spec.backfillAll.mysqlExcludedObjects.mysqlDatabases
fn withDatabase(database)
fn withMysqlTables(mysqlTables)
fn withMysqlTablesMixin(mysqlTables)
obj spec.backfillAll.mysqlExcludedObjects.mysqlDatabases.mysqlTables
obj spec.backfillAll.oracleExcludedObjects
fn withOracleSchemas(oracleSchemas)
fn withOracleSchemasMixin(oracleSchemas)
obj spec.backfillAll.oracleExcludedObjects.oracleSchemas
fn withOracleTables(oracleTables)
fn withOracleTablesMixin(oracleTables)
fn withSchema(schema)
obj spec.backfillAll.oracleExcludedObjects.oracleSchemas.oracleTables
obj spec.backfillAll.postgresqlExcludedObjects
fn withPostgresqlSchemas(postgresqlSchemas)
fn withPostgresqlSchemasMixin(postgresqlSchemas)
obj spec.backfillAll.postgresqlExcludedObjects.postgresqlSchemas
fn withPostgresqlTables(postgresqlTables)
fn withPostgresqlTablesMixin(postgresqlTables)
fn withSchema(schema)
obj spec.backfillAll.postgresqlExcludedObjects.postgresqlSchemas.postgresqlTables
obj spec.destinationConfig
fn withDestinationConnectionProfile(destinationConnectionProfile)
obj spec.destinationConfig.bigqueryDestinationConfig
obj spec.destinationConfig.gcsDestinationConfig
obj spec.projectRef
obj spec.sourceConfig
fn withSourceConnectionProfile(sourceConnectionProfile)
obj spec.sourceConfig.mysqlSourceConfig
fn withMaxConcurrentBackfillTasks(maxConcurrentBackfillTasks)
fn withMaxConcurrentCdcTasks(maxConcurrentCdcTasks)
obj spec.sourceConfig.mysqlSourceConfig.excludeObjects
fn withMysqlDatabases(mysqlDatabases)
fn withMysqlDatabasesMixin(mysqlDatabases)
obj spec.sourceConfig.mysqlSourceConfig.excludeObjects.mysqlDatabases
fn withDatabase(database)
fn withMysqlTables(mysqlTables)
fn withMysqlTablesMixin(mysqlTables)
obj spec.sourceConfig.mysqlSourceConfig.excludeObjects.mysqlDatabases.mysqlTables
obj spec.sourceConfig.mysqlSourceConfig.includeObjects
fn withMysqlDatabases(mysqlDatabases)
fn withMysqlDatabasesMixin(mysqlDatabases)
obj spec.sourceConfig.mysqlSourceConfig.includeObjects.mysqlDatabases
fn withDatabase(database)
fn withMysqlTables(mysqlTables)
fn withMysqlTablesMixin(mysqlTables)
obj spec.sourceConfig.mysqlSourceConfig.includeObjects.mysqlDatabases.mysqlTables
obj spec.sourceConfig.oracleSourceConfig
fn withDropLargeObjects(dropLargeObjects)
fn withDropLargeObjectsMixin(dropLargeObjects)
fn withMaxConcurrentBackfillTasks(maxConcurrentBackfillTasks)
fn withMaxConcurrentCdcTasks(maxConcurrentCdcTasks)
fn withStreamLargeObjects(streamLargeObjects)
fn withStreamLargeObjectsMixin(streamLargeObjects)
obj spec.sourceConfig.oracleSourceConfig.excludeObjects
fn withOracleSchemas(oracleSchemas)
fn withOracleSchemasMixin(oracleSchemas)
obj spec.sourceConfig.oracleSourceConfig.excludeObjects.oracleSchemas
fn withOracleTables(oracleTables)
fn withOracleTablesMixin(oracleTables)
fn withSchema(schema)
obj spec.sourceConfig.oracleSourceConfig.excludeObjects.oracleSchemas.oracleTables
obj spec.sourceConfig.oracleSourceConfig.includeObjects
fn withOracleSchemas(oracleSchemas)
fn withOracleSchemasMixin(oracleSchemas)
obj spec.sourceConfig.oracleSourceConfig.includeObjects.oracleSchemas
fn withOracleTables(oracleTables)
fn withOracleTablesMixin(oracleTables)
fn withSchema(schema)
obj spec.sourceConfig.oracleSourceConfig.includeObjects.oracleSchemas.oracleTables
obj spec.sourceConfig.postgresqlSourceConfig
fn withMaxConcurrentBackfillTasks(maxConcurrentBackfillTasks)
fn withPublication(publication)
fn withReplicationSlot(replicationSlot)
obj spec.sourceConfig.postgresqlSourceConfig.excludeObjects
fn withPostgresqlSchemas(postgresqlSchemas)
fn withPostgresqlSchemasMixin(postgresqlSchemas)
obj spec.sourceConfig.postgresqlSourceConfig.excludeObjects.postgresqlSchemas
fn withPostgresqlTables(postgresqlTables)
fn withPostgresqlTablesMixin(postgresqlTables)
fn withSchema(schema)
obj spec.sourceConfig.postgresqlSourceConfig.excludeObjects.postgresqlSchemas.postgresqlTables
obj spec.sourceConfig.postgresqlSourceConfig.includeObjects
fn withPostgresqlSchemas(postgresqlSchemas)
fn withPostgresqlSchemasMixin(postgresqlSchemas)
obj spec.sourceConfig.postgresqlSourceConfig.includeObjects.postgresqlSchemas
fn withPostgresqlTables(postgresqlTables)
fn withPostgresqlTablesMixin(postgresqlTables)
fn withSchema(schema)
obj spec.sourceConfig.postgresqlSourceConfig.includeObjects.postgresqlSchemas.postgresqlTables
Fields
fn new
new(name)
new returns an instance of DatastreamStream
obj metadata
"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."
fn metadata.withAnnotations
withAnnotations(annotations)
"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"
fn metadata.withAnnotationsMixin
withAnnotationsMixin(annotations)
"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"
Note: This function appends passed data to existing values
fn metadata.withClusterName
withClusterName(clusterName)
"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."
fn metadata.withCreationTimestamp
withCreationTimestamp(creationTimestamp)
"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."
fn metadata.withDeletionGracePeriodSeconds
withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)
"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."
fn metadata.withDeletionTimestamp
withDeletionTimestamp(deletionTimestamp)
"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."
fn metadata.withFinalizers
withFinalizers(finalizers)
"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."
fn metadata.withFinalizersMixin
withFinalizersMixin(finalizers)
"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."
Note: This function appends passed data to existing values
fn metadata.withGenerateName
withGenerateName(generateName)
"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"
fn metadata.withGeneration
withGeneration(generation)
"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."
fn metadata.withLabels
withLabels(labels)
"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"
fn metadata.withLabelsMixin
withLabelsMixin(labels)
"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"
Note: This function appends passed data to existing values
fn metadata.withName
withName(name)
"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"
fn metadata.withNamespace
withNamespace(namespace)
"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"
fn metadata.withOwnerReferences
withOwnerReferences(ownerReferences)
"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."
fn metadata.withOwnerReferencesMixin
withOwnerReferencesMixin(ownerReferences)
"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."
Note: This function appends passed data to existing values
fn metadata.withResourceVersion
withResourceVersion(resourceVersion)
"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"
fn metadata.withSelfLink
withSelfLink(selfLink)
"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."
fn metadata.withUid
withUid(uid)
"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"
obj spec
fn spec.withBackfillNone
withBackfillNone(backfillNone)
"Backfill strategy to disable automatic backfill for the Stream's objects."
fn spec.withBackfillNoneMixin
withBackfillNoneMixin(backfillNone)
"Backfill strategy to disable automatic backfill for the Stream's objects."
Note: This function appends passed data to existing values
fn spec.withCustomerManagedEncryptionKey
withCustomerManagedEncryptionKey(customerManagedEncryptionKey)
"Immutable. A reference to a KMS encryption key. If provided, it will be used to encrypt the data. If left blank, data\nwill be encrypted using an internal Stream-specific encryption key provisioned through KMS."
fn spec.withDesiredState
withDesiredState(desiredState)
"Desired state of the Stream. Set this field to 'RUNNING' to start the stream, and 'PAUSED' to pause the stream."
fn spec.withDisplayName
withDisplayName(displayName)
"Display name."
fn spec.withLocation
withLocation(location)
"Immutable. The name of the location this stream is located in."
fn spec.withResourceID
withResourceID(resourceID)
"Immutable. Optional. The streamId of the resource. Used for creation and acquisition. When unset, the value of metadata.name
is used as the default."
obj spec.backfillAll
"Backfill strategy to automatically backfill the Stream's objects. Specific objects can be excluded."
obj spec.backfillAll.mysqlExcludedObjects
"MySQL data source objects to avoid backfilling."
fn spec.backfillAll.mysqlExcludedObjects.withMysqlDatabases
withMysqlDatabases(mysqlDatabases)
"MySQL databases on the server."
fn spec.backfillAll.mysqlExcludedObjects.withMysqlDatabasesMixin
withMysqlDatabasesMixin(mysqlDatabases)
"MySQL databases on the server."
Note: This function appends passed data to existing values
obj spec.backfillAll.mysqlExcludedObjects.mysqlDatabases
"MySQL databases on the server."
fn spec.backfillAll.mysqlExcludedObjects.mysqlDatabases.withDatabase
withDatabase(database)
"Database name."
fn spec.backfillAll.mysqlExcludedObjects.mysqlDatabases.withMysqlTables
withMysqlTables(mysqlTables)
"Tables in the database."
fn spec.backfillAll.mysqlExcludedObjects.mysqlDatabases.withMysqlTablesMixin
withMysqlTablesMixin(mysqlTables)
"Tables in the database."
Note: This function appends passed data to existing values
obj spec.backfillAll.mysqlExcludedObjects.mysqlDatabases.mysqlTables
"Tables in the database."
fn spec.backfillAll.mysqlExcludedObjects.mysqlDatabases.mysqlTables.withMysqlColumns
withMysqlColumns(mysqlColumns)
"MySQL columns in the schema. When unspecified as part of include/exclude objects, includes/excludes everything."
fn spec.backfillAll.mysqlExcludedObjects.mysqlDatabases.mysqlTables.withMysqlColumnsMixin
withMysqlColumnsMixin(mysqlColumns)
"MySQL columns in the schema. When unspecified as part of include/exclude objects, includes/excludes everything."
Note: This function appends passed data to existing values
fn spec.backfillAll.mysqlExcludedObjects.mysqlDatabases.mysqlTables.withTable
withTable(table)
"Table name."
obj spec.backfillAll.mysqlExcludedObjects.mysqlDatabases.mysqlTables.mysqlColumns
"MySQL columns in the schema. When unspecified as part of include/exclude objects, includes/excludes everything."
fn spec.backfillAll.mysqlExcludedObjects.mysqlDatabases.mysqlTables.mysqlColumns.withCollation
withCollation(collation)
"Column collation."
fn spec.backfillAll.mysqlExcludedObjects.mysqlDatabases.mysqlTables.mysqlColumns.withColumn
withColumn(column)
"Column name."
fn spec.backfillAll.mysqlExcludedObjects.mysqlDatabases.mysqlTables.mysqlColumns.withDataType
withDataType(dataType)
"The MySQL data type. Full data types list can be found here:\nhttps://dev.mysql.com/doc/refman/8.0/en/data-types.html."
fn spec.backfillAll.mysqlExcludedObjects.mysqlDatabases.mysqlTables.mysqlColumns.withLength
withLength(length)
"Column length."
fn spec.backfillAll.mysqlExcludedObjects.mysqlDatabases.mysqlTables.mysqlColumns.withNullable
withNullable(nullable)
"Whether or not the column can accept a null value."
fn spec.backfillAll.mysqlExcludedObjects.mysqlDatabases.mysqlTables.mysqlColumns.withOrdinalPosition
withOrdinalPosition(ordinalPosition)
"The ordinal position of the column in the table."
fn spec.backfillAll.mysqlExcludedObjects.mysqlDatabases.mysqlTables.mysqlColumns.withPrimaryKey
withPrimaryKey(primaryKey)
"Whether or not the column represents a primary key."
obj spec.backfillAll.oracleExcludedObjects
"PostgreSQL data source objects to avoid backfilling."
fn spec.backfillAll.oracleExcludedObjects.withOracleSchemas
withOracleSchemas(oracleSchemas)
"Oracle schemas/databases in the database server."
fn spec.backfillAll.oracleExcludedObjects.withOracleSchemasMixin
withOracleSchemasMixin(oracleSchemas)
"Oracle schemas/databases in the database server."
Note: This function appends passed data to existing values
obj spec.backfillAll.oracleExcludedObjects.oracleSchemas
"Oracle schemas/databases in the database server."
fn spec.backfillAll.oracleExcludedObjects.oracleSchemas.withOracleTables
withOracleTables(oracleTables)
"Tables in the database."
fn spec.backfillAll.oracleExcludedObjects.oracleSchemas.withOracleTablesMixin
withOracleTablesMixin(oracleTables)
"Tables in the database."
Note: This function appends passed data to existing values
fn spec.backfillAll.oracleExcludedObjects.oracleSchemas.withSchema
withSchema(schema)
"Schema name."
obj spec.backfillAll.oracleExcludedObjects.oracleSchemas.oracleTables
"Tables in the database."
fn spec.backfillAll.oracleExcludedObjects.oracleSchemas.oracleTables.withOracleColumns
withOracleColumns(oracleColumns)
"Oracle columns in the schema. When unspecified as part of include/exclude objects, includes/excludes everything."
fn spec.backfillAll.oracleExcludedObjects.oracleSchemas.oracleTables.withOracleColumnsMixin
withOracleColumnsMixin(oracleColumns)
"Oracle columns in the schema. When unspecified as part of include/exclude objects, includes/excludes everything."
Note: This function appends passed data to existing values
fn spec.backfillAll.oracleExcludedObjects.oracleSchemas.oracleTables.withTable
withTable(table)
"Table name."
obj spec.backfillAll.oracleExcludedObjects.oracleSchemas.oracleTables.oracleColumns
"Oracle columns in the schema. When unspecified as part of include/exclude objects, includes/excludes everything."
fn spec.backfillAll.oracleExcludedObjects.oracleSchemas.oracleTables.oracleColumns.withColumn
withColumn(column)
"Column name."
fn spec.backfillAll.oracleExcludedObjects.oracleSchemas.oracleTables.oracleColumns.withDataType
withDataType(dataType)
"The Oracle data type. Full data types list can be found here:\nhttps://docs.oracle.com/en/database/oracle/oracle-database/21/sqlrf/Data-Types.html."
fn spec.backfillAll.oracleExcludedObjects.oracleSchemas.oracleTables.oracleColumns.withEncoding
withEncoding(encoding)
"Column encoding."
fn spec.backfillAll.oracleExcludedObjects.oracleSchemas.oracleTables.oracleColumns.withLength
withLength(length)
"Column length."
fn spec.backfillAll.oracleExcludedObjects.oracleSchemas.oracleTables.oracleColumns.withNullable
withNullable(nullable)
"Whether or not the column can accept a null value."
fn spec.backfillAll.oracleExcludedObjects.oracleSchemas.oracleTables.oracleColumns.withOrdinalPosition
withOrdinalPosition(ordinalPosition)
"The ordinal position of the column in the table."
fn spec.backfillAll.oracleExcludedObjects.oracleSchemas.oracleTables.oracleColumns.withPrecision
withPrecision(precision)
"Column precision."
fn spec.backfillAll.oracleExcludedObjects.oracleSchemas.oracleTables.oracleColumns.withPrimaryKey
withPrimaryKey(primaryKey)
"Whether or not the column represents a primary key."
fn spec.backfillAll.oracleExcludedObjects.oracleSchemas.oracleTables.oracleColumns.withScale
withScale(scale)
"Column scale."
obj spec.backfillAll.postgresqlExcludedObjects
"PostgreSQL data source objects to avoid backfilling."
fn spec.backfillAll.postgresqlExcludedObjects.withPostgresqlSchemas
withPostgresqlSchemas(postgresqlSchemas)
"PostgreSQL schemas on the server."
fn spec.backfillAll.postgresqlExcludedObjects.withPostgresqlSchemasMixin
withPostgresqlSchemasMixin(postgresqlSchemas)
"PostgreSQL schemas on the server."
Note: This function appends passed data to existing values
obj spec.backfillAll.postgresqlExcludedObjects.postgresqlSchemas
"PostgreSQL schemas on the server."
fn spec.backfillAll.postgresqlExcludedObjects.postgresqlSchemas.withPostgresqlTables
withPostgresqlTables(postgresqlTables)
"Tables in the schema."
fn spec.backfillAll.postgresqlExcludedObjects.postgresqlSchemas.withPostgresqlTablesMixin
withPostgresqlTablesMixin(postgresqlTables)
"Tables in the schema."
Note: This function appends passed data to existing values
fn spec.backfillAll.postgresqlExcludedObjects.postgresqlSchemas.withSchema
withSchema(schema)
"Database name."
obj spec.backfillAll.postgresqlExcludedObjects.postgresqlSchemas.postgresqlTables
"Tables in the schema."
fn spec.backfillAll.postgresqlExcludedObjects.postgresqlSchemas.postgresqlTables.withPostgresqlColumns
withPostgresqlColumns(postgresqlColumns)
"PostgreSQL columns in the schema. When unspecified as part of include/exclude objects, includes/excludes everything."
fn spec.backfillAll.postgresqlExcludedObjects.postgresqlSchemas.postgresqlTables.withPostgresqlColumnsMixin
withPostgresqlColumnsMixin(postgresqlColumns)
"PostgreSQL columns in the schema. When unspecified as part of include/exclude objects, includes/excludes everything."
Note: This function appends passed data to existing values
fn spec.backfillAll.postgresqlExcludedObjects.postgresqlSchemas.postgresqlTables.withTable
withTable(table)
"Table name."
obj spec.backfillAll.postgresqlExcludedObjects.postgresqlSchemas.postgresqlTables.postgresqlColumns
"PostgreSQL columns in the schema. When unspecified as part of include/exclude objects, includes/excludes everything."
fn spec.backfillAll.postgresqlExcludedObjects.postgresqlSchemas.postgresqlTables.postgresqlColumns.withColumn
withColumn(column)
"Column name."
fn spec.backfillAll.postgresqlExcludedObjects.postgresqlSchemas.postgresqlTables.postgresqlColumns.withDataType
withDataType(dataType)
"The PostgreSQL data type. Full data types list can be found here:\nhttps://www.postgresql.org/docs/current/datatype.html."
fn spec.backfillAll.postgresqlExcludedObjects.postgresqlSchemas.postgresqlTables.postgresqlColumns.withLength
withLength(length)
"Column length."
fn spec.backfillAll.postgresqlExcludedObjects.postgresqlSchemas.postgresqlTables.postgresqlColumns.withNullable
withNullable(nullable)
"Whether or not the column can accept a null value."
fn spec.backfillAll.postgresqlExcludedObjects.postgresqlSchemas.postgresqlTables.postgresqlColumns.withOrdinalPosition
withOrdinalPosition(ordinalPosition)
"The ordinal position of the column in the table."
fn spec.backfillAll.postgresqlExcludedObjects.postgresqlSchemas.postgresqlTables.postgresqlColumns.withPrecision
withPrecision(precision)
"Column precision."
fn spec.backfillAll.postgresqlExcludedObjects.postgresqlSchemas.postgresqlTables.postgresqlColumns.withPrimaryKey
withPrimaryKey(primaryKey)
"Whether or not the column represents a primary key."
fn spec.backfillAll.postgresqlExcludedObjects.postgresqlSchemas.postgresqlTables.postgresqlColumns.withScale
withScale(scale)
"Column scale."
obj spec.destinationConfig
"Destination connection profile configuration."
fn spec.destinationConfig.withDestinationConnectionProfile
withDestinationConnectionProfile(destinationConnectionProfile)
"Immutable. Destination connection profile resource. Format: projects/{project}/locations/{location}/connectionProfiles/{name}."
obj spec.destinationConfig.bigqueryDestinationConfig
"A configuration for how data should be loaded to Cloud Storage."
fn spec.destinationConfig.bigqueryDestinationConfig.withDataFreshness
withDataFreshness(dataFreshness)
"The guaranteed data freshness (in seconds) when querying tables created by the stream.\nEditing this field will only affect new tables created in the future, but existing tables\nwill not be impacted. Lower values mean that queries will return fresher data, but may result in higher cost.\nA duration in seconds with up to nine fractional digits, terminated by 's'. Example: \"3.5s\". Defaults to 900s."
obj spec.destinationConfig.bigqueryDestinationConfig.singleTargetDataset
"A single target dataset to which all data will be streamed."
fn spec.destinationConfig.bigqueryDestinationConfig.singleTargetDataset.withDatasetId
withDatasetId(datasetId)
"Dataset ID in the format projects/{project}/datasets/{dataset_id} or\n{project}:{dataset_id}."
obj spec.destinationConfig.bigqueryDestinationConfig.sourceHierarchyDatasets
"Destination datasets are created so that hierarchy of the destination data objects matches the source hierarchy."
obj spec.destinationConfig.bigqueryDestinationConfig.sourceHierarchyDatasets.datasetTemplate
"Dataset template used for dynamic dataset creation."
fn spec.destinationConfig.bigqueryDestinationConfig.sourceHierarchyDatasets.datasetTemplate.withDatasetIdPrefix
withDatasetIdPrefix(datasetIdPrefix)
"If supplied, every created dataset will have its name prefixed by the provided value.\nThe prefix and name will be separated by an underscore. i.e. _."
fn spec.destinationConfig.bigqueryDestinationConfig.sourceHierarchyDatasets.datasetTemplate.withKmsKeyName
withKmsKeyName(kmsKeyName)
"Immutable. Describes the Cloud KMS encryption key that will be used to protect destination BigQuery\ntable. The BigQuery Service Account associated with your project requires access to this\nencryption key. i.e. projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{cryptoKey}.\nSee https://cloud.google.com/bigquery/docs/customer-managed-encryption for more information."
fn spec.destinationConfig.bigqueryDestinationConfig.sourceHierarchyDatasets.datasetTemplate.withLocation
withLocation(location)
"The geographic location where the dataset should reside.\nSee https://cloud.google.com/bigquery/docs/locations for supported locations."
obj spec.destinationConfig.gcsDestinationConfig
"A configuration for how data should be loaded to Cloud Storage."
fn spec.destinationConfig.gcsDestinationConfig.withAvroFileFormat
withAvroFileFormat(avroFileFormat)
"AVRO file format configuration."
fn spec.destinationConfig.gcsDestinationConfig.withAvroFileFormatMixin
withAvroFileFormatMixin(avroFileFormat)
"AVRO file format configuration."
Note: This function appends passed data to existing values
fn spec.destinationConfig.gcsDestinationConfig.withFileRotationInterval
withFileRotationInterval(fileRotationInterval)
"The maximum duration for which new events are added before a file is closed and a new file is created.\nA duration in seconds with up to nine fractional digits, terminated by 's'. Example: \"3.5s\". Defaults to 900s."
fn spec.destinationConfig.gcsDestinationConfig.withFileRotationMb
withFileRotationMb(fileRotationMb)
"The maximum file size to be saved in the bucket."
fn spec.destinationConfig.gcsDestinationConfig.withPath
withPath(path)
"Path inside the Cloud Storage bucket to write data to."
obj spec.destinationConfig.gcsDestinationConfig.jsonFileFormat
"JSON file format configuration."
fn spec.destinationConfig.gcsDestinationConfig.jsonFileFormat.withCompression
withCompression(compression)
"Compression of the loaded JSON file. Possible values: [\"NO_COMPRESSION\", \"GZIP\"]."
fn spec.destinationConfig.gcsDestinationConfig.jsonFileFormat.withSchemaFileFormat
withSchemaFileFormat(schemaFileFormat)
"The schema file format along JSON data files. Possible values: [\"NO_SCHEMA_FILE\", \"AVRO_SCHEMA_FILE\"]."
obj spec.projectRef
"The project that this resource belongs to."
fn spec.projectRef.withExternal
withExternal(external)
"Allowed value: The name
field of a Project
resource."
fn spec.projectRef.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.projectRef.withNamespace
withNamespace(namespace)
"Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/"
obj spec.sourceConfig
"Source connection profile configuration."
fn spec.sourceConfig.withSourceConnectionProfile
withSourceConnectionProfile(sourceConnectionProfile)
"Immutable. Source connection profile resource. Format: projects/{project}/locations/{location}/connectionProfiles/{name}."
obj spec.sourceConfig.mysqlSourceConfig
"MySQL data source configuration."
fn spec.sourceConfig.mysqlSourceConfig.withMaxConcurrentBackfillTasks
withMaxConcurrentBackfillTasks(maxConcurrentBackfillTasks)
"Maximum number of concurrent backfill tasks. The number should be non negative.\nIf not set (or set to 0), the system's default value will be used."
fn spec.sourceConfig.mysqlSourceConfig.withMaxConcurrentCdcTasks
withMaxConcurrentCdcTasks(maxConcurrentCdcTasks)
"Maximum number of concurrent CDC tasks. The number should be non negative.\nIf not set (or set to 0), the system's default value will be used."
obj spec.sourceConfig.mysqlSourceConfig.excludeObjects
"MySQL objects to exclude from the stream."
fn spec.sourceConfig.mysqlSourceConfig.excludeObjects.withMysqlDatabases
withMysqlDatabases(mysqlDatabases)
"MySQL databases on the server."
fn spec.sourceConfig.mysqlSourceConfig.excludeObjects.withMysqlDatabasesMixin
withMysqlDatabasesMixin(mysqlDatabases)
"MySQL databases on the server."
Note: This function appends passed data to existing values
obj spec.sourceConfig.mysqlSourceConfig.excludeObjects.mysqlDatabases
"MySQL databases on the server."
fn spec.sourceConfig.mysqlSourceConfig.excludeObjects.mysqlDatabases.withDatabase
withDatabase(database)
"Database name."
fn spec.sourceConfig.mysqlSourceConfig.excludeObjects.mysqlDatabases.withMysqlTables
withMysqlTables(mysqlTables)
"Tables in the database."
fn spec.sourceConfig.mysqlSourceConfig.excludeObjects.mysqlDatabases.withMysqlTablesMixin
withMysqlTablesMixin(mysqlTables)
"Tables in the database."
Note: This function appends passed data to existing values
obj spec.sourceConfig.mysqlSourceConfig.excludeObjects.mysqlDatabases.mysqlTables
"Tables in the database."
fn spec.sourceConfig.mysqlSourceConfig.excludeObjects.mysqlDatabases.mysqlTables.withMysqlColumns
withMysqlColumns(mysqlColumns)
"MySQL columns in the schema. When unspecified as part of include/exclude objects, includes/excludes everything."
fn spec.sourceConfig.mysqlSourceConfig.excludeObjects.mysqlDatabases.mysqlTables.withMysqlColumnsMixin
withMysqlColumnsMixin(mysqlColumns)
"MySQL columns in the schema. When unspecified as part of include/exclude objects, includes/excludes everything."
Note: This function appends passed data to existing values
fn spec.sourceConfig.mysqlSourceConfig.excludeObjects.mysqlDatabases.mysqlTables.withTable
withTable(table)
"Table name."
obj spec.sourceConfig.mysqlSourceConfig.excludeObjects.mysqlDatabases.mysqlTables.mysqlColumns
"MySQL columns in the schema. When unspecified as part of include/exclude objects, includes/excludes everything."
fn spec.sourceConfig.mysqlSourceConfig.excludeObjects.mysqlDatabases.mysqlTables.mysqlColumns.withCollation
withCollation(collation)
"Column collation."
fn spec.sourceConfig.mysqlSourceConfig.excludeObjects.mysqlDatabases.mysqlTables.mysqlColumns.withColumn
withColumn(column)
"Column name."
fn spec.sourceConfig.mysqlSourceConfig.excludeObjects.mysqlDatabases.mysqlTables.mysqlColumns.withDataType
withDataType(dataType)
"The MySQL data type. Full data types list can be found here:\nhttps://dev.mysql.com/doc/refman/8.0/en/data-types.html."
fn spec.sourceConfig.mysqlSourceConfig.excludeObjects.mysqlDatabases.mysqlTables.mysqlColumns.withLength
withLength(length)
"Column length."
fn spec.sourceConfig.mysqlSourceConfig.excludeObjects.mysqlDatabases.mysqlTables.mysqlColumns.withNullable
withNullable(nullable)
"Whether or not the column can accept a null value."
fn spec.sourceConfig.mysqlSourceConfig.excludeObjects.mysqlDatabases.mysqlTables.mysqlColumns.withOrdinalPosition
withOrdinalPosition(ordinalPosition)
"The ordinal position of the column in the table."
fn spec.sourceConfig.mysqlSourceConfig.excludeObjects.mysqlDatabases.mysqlTables.mysqlColumns.withPrimaryKey
withPrimaryKey(primaryKey)
"Whether or not the column represents a primary key."
obj spec.sourceConfig.mysqlSourceConfig.includeObjects
"MySQL objects to retrieve from the source."
fn spec.sourceConfig.mysqlSourceConfig.includeObjects.withMysqlDatabases
withMysqlDatabases(mysqlDatabases)
"MySQL databases on the server."
fn spec.sourceConfig.mysqlSourceConfig.includeObjects.withMysqlDatabasesMixin
withMysqlDatabasesMixin(mysqlDatabases)
"MySQL databases on the server."
Note: This function appends passed data to existing values
obj spec.sourceConfig.mysqlSourceConfig.includeObjects.mysqlDatabases
"MySQL databases on the server."
fn spec.sourceConfig.mysqlSourceConfig.includeObjects.mysqlDatabases.withDatabase
withDatabase(database)
"Database name."
fn spec.sourceConfig.mysqlSourceConfig.includeObjects.mysqlDatabases.withMysqlTables
withMysqlTables(mysqlTables)
"Tables in the database."
fn spec.sourceConfig.mysqlSourceConfig.includeObjects.mysqlDatabases.withMysqlTablesMixin
withMysqlTablesMixin(mysqlTables)
"Tables in the database."
Note: This function appends passed data to existing values
obj spec.sourceConfig.mysqlSourceConfig.includeObjects.mysqlDatabases.mysqlTables
"Tables in the database."
fn spec.sourceConfig.mysqlSourceConfig.includeObjects.mysqlDatabases.mysqlTables.withMysqlColumns
withMysqlColumns(mysqlColumns)
"MySQL columns in the schema. When unspecified as part of include/exclude objects, includes/excludes everything."
fn spec.sourceConfig.mysqlSourceConfig.includeObjects.mysqlDatabases.mysqlTables.withMysqlColumnsMixin
withMysqlColumnsMixin(mysqlColumns)
"MySQL columns in the schema. When unspecified as part of include/exclude objects, includes/excludes everything."
Note: This function appends passed data to existing values
fn spec.sourceConfig.mysqlSourceConfig.includeObjects.mysqlDatabases.mysqlTables.withTable
withTable(table)
"Table name."
obj spec.sourceConfig.mysqlSourceConfig.includeObjects.mysqlDatabases.mysqlTables.mysqlColumns
"MySQL columns in the schema. When unspecified as part of include/exclude objects, includes/excludes everything."
fn spec.sourceConfig.mysqlSourceConfig.includeObjects.mysqlDatabases.mysqlTables.mysqlColumns.withCollation
withCollation(collation)
"Column collation."
fn spec.sourceConfig.mysqlSourceConfig.includeObjects.mysqlDatabases.mysqlTables.mysqlColumns.withColumn
withColumn(column)
"Column name."
fn spec.sourceConfig.mysqlSourceConfig.includeObjects.mysqlDatabases.mysqlTables.mysqlColumns.withDataType
withDataType(dataType)
"The MySQL data type. Full data types list can be found here:\nhttps://dev.mysql.com/doc/refman/8.0/en/data-types.html."
fn spec.sourceConfig.mysqlSourceConfig.includeObjects.mysqlDatabases.mysqlTables.mysqlColumns.withLength
withLength(length)
"Column length."
fn spec.sourceConfig.mysqlSourceConfig.includeObjects.mysqlDatabases.mysqlTables.mysqlColumns.withNullable
withNullable(nullable)
"Whether or not the column can accept a null value."
fn spec.sourceConfig.mysqlSourceConfig.includeObjects.mysqlDatabases.mysqlTables.mysqlColumns.withOrdinalPosition
withOrdinalPosition(ordinalPosition)
"The ordinal position of the column in the table."
fn spec.sourceConfig.mysqlSourceConfig.includeObjects.mysqlDatabases.mysqlTables.mysqlColumns.withPrimaryKey
withPrimaryKey(primaryKey)
"Whether or not the column represents a primary key."
obj spec.sourceConfig.oracleSourceConfig
"MySQL data source configuration."
fn spec.sourceConfig.oracleSourceConfig.withDropLargeObjects
withDropLargeObjects(dropLargeObjects)
"Configuration to drop large object values."
fn spec.sourceConfig.oracleSourceConfig.withDropLargeObjectsMixin
withDropLargeObjectsMixin(dropLargeObjects)
"Configuration to drop large object values."
Note: This function appends passed data to existing values
fn spec.sourceConfig.oracleSourceConfig.withMaxConcurrentBackfillTasks
withMaxConcurrentBackfillTasks(maxConcurrentBackfillTasks)
"Maximum number of concurrent backfill tasks. The number should be non negative.\nIf not set (or set to 0), the system's default value will be used."
fn spec.sourceConfig.oracleSourceConfig.withMaxConcurrentCdcTasks
withMaxConcurrentCdcTasks(maxConcurrentCdcTasks)
"Maximum number of concurrent CDC tasks. The number should be non negative.\nIf not set (or set to 0), the system's default value will be used."
fn spec.sourceConfig.oracleSourceConfig.withStreamLargeObjects
withStreamLargeObjects(streamLargeObjects)
"Configuration to drop large object values."
fn spec.sourceConfig.oracleSourceConfig.withStreamLargeObjectsMixin
withStreamLargeObjectsMixin(streamLargeObjects)
"Configuration to drop large object values."
Note: This function appends passed data to existing values
obj spec.sourceConfig.oracleSourceConfig.excludeObjects
"Oracle objects to exclude from the stream."
fn spec.sourceConfig.oracleSourceConfig.excludeObjects.withOracleSchemas
withOracleSchemas(oracleSchemas)
"Oracle schemas/databases in the database server."
fn spec.sourceConfig.oracleSourceConfig.excludeObjects.withOracleSchemasMixin
withOracleSchemasMixin(oracleSchemas)
"Oracle schemas/databases in the database server."
Note: This function appends passed data to existing values
obj spec.sourceConfig.oracleSourceConfig.excludeObjects.oracleSchemas
"Oracle schemas/databases in the database server."
fn spec.sourceConfig.oracleSourceConfig.excludeObjects.oracleSchemas.withOracleTables
withOracleTables(oracleTables)
"Tables in the database."
fn spec.sourceConfig.oracleSourceConfig.excludeObjects.oracleSchemas.withOracleTablesMixin
withOracleTablesMixin(oracleTables)
"Tables in the database."
Note: This function appends passed data to existing values
fn spec.sourceConfig.oracleSourceConfig.excludeObjects.oracleSchemas.withSchema
withSchema(schema)
"Schema name."
obj spec.sourceConfig.oracleSourceConfig.excludeObjects.oracleSchemas.oracleTables
"Tables in the database."
fn spec.sourceConfig.oracleSourceConfig.excludeObjects.oracleSchemas.oracleTables.withOracleColumns
withOracleColumns(oracleColumns)
"Oracle columns in the schema. When unspecified as part of include/exclude objects, includes/excludes everything."
fn spec.sourceConfig.oracleSourceConfig.excludeObjects.oracleSchemas.oracleTables.withOracleColumnsMixin
withOracleColumnsMixin(oracleColumns)
"Oracle columns in the schema. When unspecified as part of include/exclude objects, includes/excludes everything."
Note: This function appends passed data to existing values
fn spec.sourceConfig.oracleSourceConfig.excludeObjects.oracleSchemas.oracleTables.withTable
withTable(table)
"Table name."
obj spec.sourceConfig.oracleSourceConfig.excludeObjects.oracleSchemas.oracleTables.oracleColumns
"Oracle columns in the schema. When unspecified as part of include/exclude objects, includes/excludes everything."
fn spec.sourceConfig.oracleSourceConfig.excludeObjects.oracleSchemas.oracleTables.oracleColumns.withColumn
withColumn(column)
"Column name."
fn spec.sourceConfig.oracleSourceConfig.excludeObjects.oracleSchemas.oracleTables.oracleColumns.withDataType
withDataType(dataType)
"The Oracle data type. Full data types list can be found here:\nhttps://docs.oracle.com/en/database/oracle/oracle-database/21/sqlrf/Data-Types.html."
fn spec.sourceConfig.oracleSourceConfig.excludeObjects.oracleSchemas.oracleTables.oracleColumns.withEncoding
withEncoding(encoding)
"Column encoding."
fn spec.sourceConfig.oracleSourceConfig.excludeObjects.oracleSchemas.oracleTables.oracleColumns.withLength
withLength(length)
"Column length."
fn spec.sourceConfig.oracleSourceConfig.excludeObjects.oracleSchemas.oracleTables.oracleColumns.withNullable
withNullable(nullable)
"Whether or not the column can accept a null value."
fn spec.sourceConfig.oracleSourceConfig.excludeObjects.oracleSchemas.oracleTables.oracleColumns.withOrdinalPosition
withOrdinalPosition(ordinalPosition)
"The ordinal position of the column in the table."
fn spec.sourceConfig.oracleSourceConfig.excludeObjects.oracleSchemas.oracleTables.oracleColumns.withPrecision
withPrecision(precision)
"Column precision."
fn spec.sourceConfig.oracleSourceConfig.excludeObjects.oracleSchemas.oracleTables.oracleColumns.withPrimaryKey
withPrimaryKey(primaryKey)
"Whether or not the column represents a primary key."
fn spec.sourceConfig.oracleSourceConfig.excludeObjects.oracleSchemas.oracleTables.oracleColumns.withScale
withScale(scale)
"Column scale."
obj spec.sourceConfig.oracleSourceConfig.includeObjects
"Oracle objects to retrieve from the source."
fn spec.sourceConfig.oracleSourceConfig.includeObjects.withOracleSchemas
withOracleSchemas(oracleSchemas)
"Oracle schemas/databases in the database server."
fn spec.sourceConfig.oracleSourceConfig.includeObjects.withOracleSchemasMixin
withOracleSchemasMixin(oracleSchemas)
"Oracle schemas/databases in the database server."
Note: This function appends passed data to existing values
obj spec.sourceConfig.oracleSourceConfig.includeObjects.oracleSchemas
"Oracle schemas/databases in the database server."
fn spec.sourceConfig.oracleSourceConfig.includeObjects.oracleSchemas.withOracleTables
withOracleTables(oracleTables)
"Tables in the database."
fn spec.sourceConfig.oracleSourceConfig.includeObjects.oracleSchemas.withOracleTablesMixin
withOracleTablesMixin(oracleTables)
"Tables in the database."
Note: This function appends passed data to existing values
fn spec.sourceConfig.oracleSourceConfig.includeObjects.oracleSchemas.withSchema
withSchema(schema)
"Schema name."
obj spec.sourceConfig.oracleSourceConfig.includeObjects.oracleSchemas.oracleTables
"Tables in the database."
fn spec.sourceConfig.oracleSourceConfig.includeObjects.oracleSchemas.oracleTables.withOracleColumns
withOracleColumns(oracleColumns)
"Oracle columns in the schema. When unspecified as part of include/exclude objects, includes/excludes everything."
fn spec.sourceConfig.oracleSourceConfig.includeObjects.oracleSchemas.oracleTables.withOracleColumnsMixin
withOracleColumnsMixin(oracleColumns)
"Oracle columns in the schema. When unspecified as part of include/exclude objects, includes/excludes everything."
Note: This function appends passed data to existing values
fn spec.sourceConfig.oracleSourceConfig.includeObjects.oracleSchemas.oracleTables.withTable
withTable(table)
"Table name."
obj spec.sourceConfig.oracleSourceConfig.includeObjects.oracleSchemas.oracleTables.oracleColumns
"Oracle columns in the schema. When unspecified as part of include/exclude objects, includes/excludes everything."
fn spec.sourceConfig.oracleSourceConfig.includeObjects.oracleSchemas.oracleTables.oracleColumns.withColumn
withColumn(column)
"Column name."
fn spec.sourceConfig.oracleSourceConfig.includeObjects.oracleSchemas.oracleTables.oracleColumns.withDataType
withDataType(dataType)
"The Oracle data type. Full data types list can be found here:\nhttps://docs.oracle.com/en/database/oracle/oracle-database/21/sqlrf/Data-Types.html."
fn spec.sourceConfig.oracleSourceConfig.includeObjects.oracleSchemas.oracleTables.oracleColumns.withEncoding
withEncoding(encoding)
"Column encoding."
fn spec.sourceConfig.oracleSourceConfig.includeObjects.oracleSchemas.oracleTables.oracleColumns.withLength
withLength(length)
"Column length."
fn spec.sourceConfig.oracleSourceConfig.includeObjects.oracleSchemas.oracleTables.oracleColumns.withNullable
withNullable(nullable)
"Whether or not the column can accept a null value."
fn spec.sourceConfig.oracleSourceConfig.includeObjects.oracleSchemas.oracleTables.oracleColumns.withOrdinalPosition
withOrdinalPosition(ordinalPosition)
"The ordinal position of the column in the table."
fn spec.sourceConfig.oracleSourceConfig.includeObjects.oracleSchemas.oracleTables.oracleColumns.withPrecision
withPrecision(precision)
"Column precision."
fn spec.sourceConfig.oracleSourceConfig.includeObjects.oracleSchemas.oracleTables.oracleColumns.withPrimaryKey
withPrimaryKey(primaryKey)
"Whether or not the column represents a primary key."
fn spec.sourceConfig.oracleSourceConfig.includeObjects.oracleSchemas.oracleTables.oracleColumns.withScale
withScale(scale)
"Column scale."
obj spec.sourceConfig.postgresqlSourceConfig
"PostgreSQL data source configuration."
fn spec.sourceConfig.postgresqlSourceConfig.withMaxConcurrentBackfillTasks
withMaxConcurrentBackfillTasks(maxConcurrentBackfillTasks)
"Maximum number of concurrent backfill tasks. The number should be non\nnegative. If not set (or set to 0), the system's default value will be used."
fn spec.sourceConfig.postgresqlSourceConfig.withPublication
withPublication(publication)
"The name of the publication that includes the set of all tables\nthat are defined in the stream's include_objects."
fn spec.sourceConfig.postgresqlSourceConfig.withReplicationSlot
withReplicationSlot(replicationSlot)
"The name of the logical replication slot that's configured with\nthe pgoutput plugin."
obj spec.sourceConfig.postgresqlSourceConfig.excludeObjects
"PostgreSQL objects to exclude from the stream."
fn spec.sourceConfig.postgresqlSourceConfig.excludeObjects.withPostgresqlSchemas
withPostgresqlSchemas(postgresqlSchemas)
"PostgreSQL schemas on the server."
fn spec.sourceConfig.postgresqlSourceConfig.excludeObjects.withPostgresqlSchemasMixin
withPostgresqlSchemasMixin(postgresqlSchemas)
"PostgreSQL schemas on the server."
Note: This function appends passed data to existing values
obj spec.sourceConfig.postgresqlSourceConfig.excludeObjects.postgresqlSchemas
"PostgreSQL schemas on the server."
fn spec.sourceConfig.postgresqlSourceConfig.excludeObjects.postgresqlSchemas.withPostgresqlTables
withPostgresqlTables(postgresqlTables)
"Tables in the schema."
fn spec.sourceConfig.postgresqlSourceConfig.excludeObjects.postgresqlSchemas.withPostgresqlTablesMixin
withPostgresqlTablesMixin(postgresqlTables)
"Tables in the schema."
Note: This function appends passed data to existing values
fn spec.sourceConfig.postgresqlSourceConfig.excludeObjects.postgresqlSchemas.withSchema
withSchema(schema)
"Database name."
obj spec.sourceConfig.postgresqlSourceConfig.excludeObjects.postgresqlSchemas.postgresqlTables
"Tables in the schema."
fn spec.sourceConfig.postgresqlSourceConfig.excludeObjects.postgresqlSchemas.postgresqlTables.withPostgresqlColumns
withPostgresqlColumns(postgresqlColumns)
"PostgreSQL columns in the schema. When unspecified as part of include/exclude objects, includes/excludes everything."
fn spec.sourceConfig.postgresqlSourceConfig.excludeObjects.postgresqlSchemas.postgresqlTables.withPostgresqlColumnsMixin
withPostgresqlColumnsMixin(postgresqlColumns)
"PostgreSQL columns in the schema. When unspecified as part of include/exclude objects, includes/excludes everything."
Note: This function appends passed data to existing values
fn spec.sourceConfig.postgresqlSourceConfig.excludeObjects.postgresqlSchemas.postgresqlTables.withTable
withTable(table)
"Table name."
obj spec.sourceConfig.postgresqlSourceConfig.excludeObjects.postgresqlSchemas.postgresqlTables.postgresqlColumns
"PostgreSQL columns in the schema. When unspecified as part of include/exclude objects, includes/excludes everything."
fn spec.sourceConfig.postgresqlSourceConfig.excludeObjects.postgresqlSchemas.postgresqlTables.postgresqlColumns.withColumn
withColumn(column)
"Column name."
fn spec.sourceConfig.postgresqlSourceConfig.excludeObjects.postgresqlSchemas.postgresqlTables.postgresqlColumns.withDataType
withDataType(dataType)
"The PostgreSQL data type. Full data types list can be found here:\nhttps://www.postgresql.org/docs/current/datatype.html."
fn spec.sourceConfig.postgresqlSourceConfig.excludeObjects.postgresqlSchemas.postgresqlTables.postgresqlColumns.withLength
withLength(length)
"Column length."
fn spec.sourceConfig.postgresqlSourceConfig.excludeObjects.postgresqlSchemas.postgresqlTables.postgresqlColumns.withNullable
withNullable(nullable)
"Whether or not the column can accept a null value."
fn spec.sourceConfig.postgresqlSourceConfig.excludeObjects.postgresqlSchemas.postgresqlTables.postgresqlColumns.withOrdinalPosition
withOrdinalPosition(ordinalPosition)
"The ordinal position of the column in the table."
fn spec.sourceConfig.postgresqlSourceConfig.excludeObjects.postgresqlSchemas.postgresqlTables.postgresqlColumns.withPrecision
withPrecision(precision)
"Column precision."
fn spec.sourceConfig.postgresqlSourceConfig.excludeObjects.postgresqlSchemas.postgresqlTables.postgresqlColumns.withPrimaryKey
withPrimaryKey(primaryKey)
"Whether or not the column represents a primary key."
fn spec.sourceConfig.postgresqlSourceConfig.excludeObjects.postgresqlSchemas.postgresqlTables.postgresqlColumns.withScale
withScale(scale)
"Column scale."
obj spec.sourceConfig.postgresqlSourceConfig.includeObjects
"PostgreSQL objects to retrieve from the source."
fn spec.sourceConfig.postgresqlSourceConfig.includeObjects.withPostgresqlSchemas
withPostgresqlSchemas(postgresqlSchemas)
"PostgreSQL schemas on the server."
fn spec.sourceConfig.postgresqlSourceConfig.includeObjects.withPostgresqlSchemasMixin
withPostgresqlSchemasMixin(postgresqlSchemas)
"PostgreSQL schemas on the server."
Note: This function appends passed data to existing values
obj spec.sourceConfig.postgresqlSourceConfig.includeObjects.postgresqlSchemas
"PostgreSQL schemas on the server."
fn spec.sourceConfig.postgresqlSourceConfig.includeObjects.postgresqlSchemas.withPostgresqlTables
withPostgresqlTables(postgresqlTables)
"Tables in the schema."
fn spec.sourceConfig.postgresqlSourceConfig.includeObjects.postgresqlSchemas.withPostgresqlTablesMixin
withPostgresqlTablesMixin(postgresqlTables)
"Tables in the schema."
Note: This function appends passed data to existing values
fn spec.sourceConfig.postgresqlSourceConfig.includeObjects.postgresqlSchemas.withSchema
withSchema(schema)
"Database name."
obj spec.sourceConfig.postgresqlSourceConfig.includeObjects.postgresqlSchemas.postgresqlTables
"Tables in the schema."
fn spec.sourceConfig.postgresqlSourceConfig.includeObjects.postgresqlSchemas.postgresqlTables.withPostgresqlColumns
withPostgresqlColumns(postgresqlColumns)
"PostgreSQL columns in the schema. When unspecified as part of include/exclude objects, includes/excludes everything."
fn spec.sourceConfig.postgresqlSourceConfig.includeObjects.postgresqlSchemas.postgresqlTables.withPostgresqlColumnsMixin
withPostgresqlColumnsMixin(postgresqlColumns)
"PostgreSQL columns in the schema. When unspecified as part of include/exclude objects, includes/excludes everything."
Note: This function appends passed data to existing values
fn spec.sourceConfig.postgresqlSourceConfig.includeObjects.postgresqlSchemas.postgresqlTables.withTable
withTable(table)
"Table name."
obj spec.sourceConfig.postgresqlSourceConfig.includeObjects.postgresqlSchemas.postgresqlTables.postgresqlColumns
"PostgreSQL columns in the schema. When unspecified as part of include/exclude objects, includes/excludes everything."
fn spec.sourceConfig.postgresqlSourceConfig.includeObjects.postgresqlSchemas.postgresqlTables.postgresqlColumns.withColumn
withColumn(column)
"Column name."
fn spec.sourceConfig.postgresqlSourceConfig.includeObjects.postgresqlSchemas.postgresqlTables.postgresqlColumns.withDataType
withDataType(dataType)
"The PostgreSQL data type. Full data types list can be found here:\nhttps://www.postgresql.org/docs/current/datatype.html."
fn spec.sourceConfig.postgresqlSourceConfig.includeObjects.postgresqlSchemas.postgresqlTables.postgresqlColumns.withLength
withLength(length)
"Column length."
fn spec.sourceConfig.postgresqlSourceConfig.includeObjects.postgresqlSchemas.postgresqlTables.postgresqlColumns.withNullable
withNullable(nullable)
"Whether or not the column can accept a null value."
fn spec.sourceConfig.postgresqlSourceConfig.includeObjects.postgresqlSchemas.postgresqlTables.postgresqlColumns.withOrdinalPosition
withOrdinalPosition(ordinalPosition)
"The ordinal position of the column in the table."
fn spec.sourceConfig.postgresqlSourceConfig.includeObjects.postgresqlSchemas.postgresqlTables.postgresqlColumns.withPrecision
withPrecision(precision)
"Column precision."
fn spec.sourceConfig.postgresqlSourceConfig.includeObjects.postgresqlSchemas.postgresqlTables.postgresqlColumns.withPrimaryKey
withPrimaryKey(primaryKey)
"Whether or not the column represents a primary key."
fn spec.sourceConfig.postgresqlSourceConfig.includeObjects.postgresqlSchemas.postgresqlTables.postgresqlColumns.withScale
withScale(scale)
"Column scale."