airbyte.SourceMysql

Coming soon!

Coming soon!

Coming soon!

resource_name This property is required. str

The unique name of the resource.

args This property is required. SourceMysqlArgs

The arguments to resource properties.

opts ResourceOptions

Bag of options to control resource's behavior.

ctx Context

Context object for the current deployment.

name This property is required. string

The unique name of the resource.

args This property is required. SourceMysqlArgs

The arguments to resource properties.

opts ResourceOption

Bag of options to control resource's behavior.

name This property is required. string

The unique name of the resource.

args This property is required. SourceMysqlArgs

The arguments to resource properties.

opts CustomResourceOptions

Bag of options to control resource's behavior.

name This property is required. String

The unique name of the resource.

args This property is required. SourceMysqlArgs

The arguments to resource properties.

options CustomResourceOptions

Bag of options to control resource's behavior.

Configuration This property is required. SourceMysqlConfiguration

WorkspaceId This property is required. string

DefinitionId string

The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.

Name string

Name of the source e.g. dev-mysql-instance.

SecretId string

Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

Configuration This property is required. SourceMysqlConfigurationArgs

WorkspaceId This property is required. string

DefinitionId string

The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.

Name string

Name of the source e.g. dev-mysql-instance.

SecretId string

Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

configuration This property is required. SourceMysqlConfiguration

workspaceId This property is required. String

definitionId String

The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.

name String

Name of the source e.g. dev-mysql-instance.

secretId String

Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

configuration This property is required. SourceMysqlConfigurationArgs

workspace_id This property is required. str

definition_id str

The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.

name str

Name of the source e.g. dev-mysql-instance.

secret_id str

Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

configuration This property is required. Property Map

workspaceId This property is required. String

definitionId String

The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.

name String

Name of the source e.g. dev-mysql-instance.

secretId String

Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

CreatedAt double

Id string

The provider-assigned unique ID for this managed resource.

ResourceAllocation SourceMysqlResourceAllocation

actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.

SourceId string

SourceType string

CreatedAt float64

Id string

The provider-assigned unique ID for this managed resource.

ResourceAllocation SourceMysqlResourceAllocation

actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.

SourceId string

SourceType string

createdAt Double

id String

The provider-assigned unique ID for this managed resource.

resourceAllocation SourceMysqlResourceAllocation

actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.

sourceId String

sourceType String

created_at float

id str

The provider-assigned unique ID for this managed resource.

resource_allocation SourceMysqlResourceAllocation

actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.

source_id str

source_type str

createdAt Number

id String

The provider-assigned unique ID for this managed resource.

resourceAllocation Property Map

actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.

sourceId String

sourceType String

resource_name This property is required.

The unique name of the resulting resource.

id This property is required.

The unique provider ID of the resource to lookup.

name This property is required.

The unique name of the resulting resource.

id This property is required.

The unique provider ID of the resource to lookup.

state

Any extra arguments used during the lookup.

opts

A bag of options that control this resource's behavior.

name This property is required.

The unique name of the resulting resource.

id This property is required.

The unique provider ID of the resource to lookup.

state

Any extra arguments used during the lookup.

opts

A bag of options that control this resource's behavior.

name This property is required.

The unique name of the resulting resource.

id This property is required.

The unique provider ID of the resource to lookup.

state

Any extra arguments used during the lookup.

opts

A bag of options that control this resource's behavior.

Database This property is required. string

The database name.

Host This property is required. string

Hostname of the database.

ReplicationMethod This property is required. SourceMysqlConfigurationReplicationMethod

Configures how data is extracted from the database.

Username This property is required. string

The username which is used to access the database.

CheckPrivileges bool

When this feature is enabled, during schema discovery the connector will query each table or view individually to check access privileges and inaccessible tables, views, or columns therein will be removed. In large schemas, this might cause schema discovery to take too long, in which case it might be advisable to disable this feature. Default: true

CheckpointTargetIntervalSeconds double

How often (in seconds) a stream should checkpoint, when possible. Default: 300

Concurrency double

Maximum number of concurrent queries to the database. Default: 1

JdbcUrlParams string

Additional properties to pass to the JDBC URL string when connecting to the database formatted as 'key=value' pairs separated by the symbol '&'. (example: key1=value1&key2=value2&key3=value3).

Password string

The password associated with the username.

Port double

Port of the database. Default: 3306

SslMode SourceMysqlConfigurationSslMode

The encryption method with is used when communicating with the database.

TunnelMethod SourceMysqlConfigurationTunnelMethod

Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use.

Database This property is required. string

The database name.

Host This property is required. string

Hostname of the database.

ReplicationMethod This property is required. SourceMysqlConfigurationReplicationMethod

Configures how data is extracted from the database.

Username This property is required. string

The username which is used to access the database.

CheckPrivileges bool

When this feature is enabled, during schema discovery the connector will query each table or view individually to check access privileges and inaccessible tables, views, or columns therein will be removed. In large schemas, this might cause schema discovery to take too long, in which case it might be advisable to disable this feature. Default: true

CheckpointTargetIntervalSeconds float64

How often (in seconds) a stream should checkpoint, when possible. Default: 300

Concurrency float64

Maximum number of concurrent queries to the database. Default: 1

JdbcUrlParams string

Additional properties to pass to the JDBC URL string when connecting to the database formatted as 'key=value' pairs separated by the symbol '&'. (example: key1=value1&key2=value2&key3=value3).

Password string

The password associated with the username.

Port float64

Port of the database. Default: 3306

SslMode SourceMysqlConfigurationSslMode

The encryption method with is used when communicating with the database.

TunnelMethod SourceMysqlConfigurationTunnelMethod

Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use.

database This property is required. String

The database name.

host This property is required. String

Hostname of the database.

replicationMethod This property is required. SourceMysqlConfigurationReplicationMethod

Configures how data is extracted from the database.

username This property is required. String

The username which is used to access the database.

checkPrivileges Boolean

When this feature is enabled, during schema discovery the connector will query each table or view individually to check access privileges and inaccessible tables, views, or columns therein will be removed. In large schemas, this might cause schema discovery to take too long, in which case it might be advisable to disable this feature. Default: true

checkpointTargetIntervalSeconds Double

How often (in seconds) a stream should checkpoint, when possible. Default: 300

concurrency Double

Maximum number of concurrent queries to the database. Default: 1

jdbcUrlParams String

Additional properties to pass to the JDBC URL string when connecting to the database formatted as 'key=value' pairs separated by the symbol '&'. (example: key1=value1&key2=value2&key3=value3).

password String

The password associated with the username.

port Double

Port of the database. Default: 3306

sslMode SourceMysqlConfigurationSslMode

The encryption method with is used when communicating with the database.

tunnelMethod SourceMysqlConfigurationTunnelMethod

Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use.

database This property is required. str

The database name.

host This property is required. str

Hostname of the database.

replication_method This property is required. SourceMysqlConfigurationReplicationMethod

Configures how data is extracted from the database.

username This property is required. str

The username which is used to access the database.

check_privileges bool

When this feature is enabled, during schema discovery the connector will query each table or view individually to check access privileges and inaccessible tables, views, or columns therein will be removed. In large schemas, this might cause schema discovery to take too long, in which case it might be advisable to disable this feature. Default: true

checkpoint_target_interval_seconds float

How often (in seconds) a stream should checkpoint, when possible. Default: 300

concurrency float

Maximum number of concurrent queries to the database. Default: 1

jdbc_url_params str

Additional properties to pass to the JDBC URL string when connecting to the database formatted as 'key=value' pairs separated by the symbol '&'. (example: key1=value1&key2=value2&key3=value3).

password str

The password associated with the username.

port float

Port of the database. Default: 3306

ssl_mode SourceMysqlConfigurationSslMode

The encryption method with is used when communicating with the database.

tunnel_method SourceMysqlConfigurationTunnelMethod

Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use.

database This property is required. String

The database name.

host This property is required. String

Hostname of the database.

replicationMethod This property is required. Property Map

Configures how data is extracted from the database.

username This property is required. String

The username which is used to access the database.

checkPrivileges Boolean

When this feature is enabled, during schema discovery the connector will query each table or view individually to check access privileges and inaccessible tables, views, or columns therein will be removed. In large schemas, this might cause schema discovery to take too long, in which case it might be advisable to disable this feature. Default: true

checkpointTargetIntervalSeconds Number

How often (in seconds) a stream should checkpoint, when possible. Default: 300

concurrency Number

Maximum number of concurrent queries to the database. Default: 1

jdbcUrlParams String

Additional properties to pass to the JDBC URL string when connecting to the database formatted as 'key=value' pairs separated by the symbol '&'. (example: key1=value1&key2=value2&key3=value3).

password String

The password associated with the username.

port Number

Port of the database. Default: 3306

sslMode Property Map

The encryption method with is used when communicating with the database.

tunnelMethod Property Map

Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use.

ReadChangesUsingChangeDataCaptureCdc SourceMysqlConfigurationReplicationMethodReadChangesUsingChangeDataCaptureCdc

\n\nRecommended\n\n - Incrementally reads new inserts, updates, and deletes using MySQL's \n\n change data capture feature\n\n. This must be enabled on your database.

ScanChangesWithUserDefinedCursor SourceMysqlConfigurationReplicationMethodScanChangesWithUserDefinedCursor

Incrementally detects new inserts and updates using the \n\ncursor column\n\n chosen when configuring a connection (e.g. createdat, updatedat).

ReadChangesUsingChangeDataCaptureCdc SourceMysqlConfigurationReplicationMethodReadChangesUsingChangeDataCaptureCdc

\n\nRecommended\n\n - Incrementally reads new inserts, updates, and deletes using MySQL's \n\n change data capture feature\n\n. This must be enabled on your database.

ScanChangesWithUserDefinedCursor SourceMysqlConfigurationReplicationMethodScanChangesWithUserDefinedCursor

Incrementally detects new inserts and updates using the \n\ncursor column\n\n chosen when configuring a connection (e.g. createdat, updatedat).

readChangesUsingChangeDataCaptureCdc SourceMysqlConfigurationReplicationMethodReadChangesUsingChangeDataCaptureCdc

\n\nRecommended\n\n - Incrementally reads new inserts, updates, and deletes using MySQL's \n\n change data capture feature\n\n. This must be enabled on your database.

scanChangesWithUserDefinedCursor SourceMysqlConfigurationReplicationMethodScanChangesWithUserDefinedCursor

Incrementally detects new inserts and updates using the \n\ncursor column\n\n chosen when configuring a connection (e.g. createdat, updatedat).

read_changes_using_change_data_capture_cdc SourceMysqlConfigurationReplicationMethodReadChangesUsingChangeDataCaptureCdc

\n\nRecommended\n\n - Incrementally reads new inserts, updates, and deletes using MySQL's \n\n change data capture feature\n\n. This must be enabled on your database.

scan_changes_with_user_defined_cursor SourceMysqlConfigurationReplicationMethodScanChangesWithUserDefinedCursor

Incrementally detects new inserts and updates using the \n\ncursor column\n\n chosen when configuring a connection (e.g. createdat, updatedat).

readChangesUsingChangeDataCaptureCdc Property Map

\n\nRecommended\n\n - Incrementally reads new inserts, updates, and deletes using MySQL's \n\n change data capture feature\n\n. This must be enabled on your database.

scanChangesWithUserDefinedCursor Property Map

Incrementally detects new inserts and updates using the \n\ncursor column\n\n chosen when configuring a connection (e.g. createdat, updatedat).

AdditionalProperties string

Parsed as JSON.

InitialLoadTimeoutHours double

The amount of time an initial load is allowed to continue for before catching up on CDC logs. Default: 8

InvalidCdcCursorPositionBehavior string

Determines whether Airbyte should fail or re-sync data in case of an stale/invalid cursor value in the mined logs. If 'Fail sync' is chosen, a user will have to manually reset the connection before being able to continue syncing data. If 'Re-sync data' is chosen, Airbyte will automatically trigger a refresh but could lead to higher cloud costs and data loss. Default: "Fail sync"; must be one of ["Fail sync", "Re-sync data"]

Method string

Default: "CDC"; must be "CDC"

ServerTimezone string

Enter the configured MySQL server timezone. This should only be done if the configured timezone in your MySQL instance does not conform to IANNA standard.

AdditionalProperties string

Parsed as JSON.

InitialLoadTimeoutHours float64

The amount of time an initial load is allowed to continue for before catching up on CDC logs. Default: 8

InvalidCdcCursorPositionBehavior string

Determines whether Airbyte should fail or re-sync data in case of an stale/invalid cursor value in the mined logs. If 'Fail sync' is chosen, a user will have to manually reset the connection before being able to continue syncing data. If 'Re-sync data' is chosen, Airbyte will automatically trigger a refresh but could lead to higher cloud costs and data loss. Default: "Fail sync"; must be one of ["Fail sync", "Re-sync data"]

Method string

Default: "CDC"; must be "CDC"

ServerTimezone string

Enter the configured MySQL server timezone. This should only be done if the configured timezone in your MySQL instance does not conform to IANNA standard.

additionalProperties String

Parsed as JSON.

initialLoadTimeoutHours Double

The amount of time an initial load is allowed to continue for before catching up on CDC logs. Default: 8

invalidCdcCursorPositionBehavior String

Determines whether Airbyte should fail or re-sync data in case of an stale/invalid cursor value in the mined logs. If 'Fail sync' is chosen, a user will have to manually reset the connection before being able to continue syncing data. If 'Re-sync data' is chosen, Airbyte will automatically trigger a refresh but could lead to higher cloud costs and data loss. Default: "Fail sync"; must be one of ["Fail sync", "Re-sync data"]

method String

Default: "CDC"; must be "CDC"

serverTimezone String

Enter the configured MySQL server timezone. This should only be done if the configured timezone in your MySQL instance does not conform to IANNA standard.

additional_properties str

Parsed as JSON.

initial_load_timeout_hours float

The amount of time an initial load is allowed to continue for before catching up on CDC logs. Default: 8

invalid_cdc_cursor_position_behavior str

Determines whether Airbyte should fail or re-sync data in case of an stale/invalid cursor value in the mined logs. If 'Fail sync' is chosen, a user will have to manually reset the connection before being able to continue syncing data. If 'Re-sync data' is chosen, Airbyte will automatically trigger a refresh but could lead to higher cloud costs and data loss. Default: "Fail sync"; must be one of ["Fail sync", "Re-sync data"]

method str

Default: "CDC"; must be "CDC"

server_timezone str

Enter the configured MySQL server timezone. This should only be done if the configured timezone in your MySQL instance does not conform to IANNA standard.

additionalProperties String

Parsed as JSON.

initialLoadTimeoutHours Number

The amount of time an initial load is allowed to continue for before catching up on CDC logs. Default: 8

invalidCdcCursorPositionBehavior String

Determines whether Airbyte should fail or re-sync data in case of an stale/invalid cursor value in the mined logs. If 'Fail sync' is chosen, a user will have to manually reset the connection before being able to continue syncing data. If 'Re-sync data' is chosen, Airbyte will automatically trigger a refresh but could lead to higher cloud costs and data loss. Default: "Fail sync"; must be one of ["Fail sync", "Re-sync data"]

method String

Default: "CDC"; must be "CDC"

serverTimezone String

Enter the configured MySQL server timezone. This should only be done if the configured timezone in your MySQL instance does not conform to IANNA standard.

AdditionalProperties string

Parsed as JSON.

Method string

Default: "STANDARD"; must be "STANDARD"

AdditionalProperties string

Parsed as JSON.

Method string

Default: "STANDARD"; must be "STANDARD"

additionalProperties String

Parsed as JSON.

method String

Default: "STANDARD"; must be "STANDARD"

additional_properties str

Parsed as JSON.

method str

Default: "STANDARD"; must be "STANDARD"

additionalProperties String

Parsed as JSON.

method String

Default: "STANDARD"; must be "STANDARD"

Preferred SourceMysqlConfigurationSslModePreferred

To allow unencrypted communication only when the source doesn't support encryption.

Required SourceMysqlConfigurationSslModeRequired

To always require encryption. Note: The connection will fail if the source doesn't support encryption.

VerifyCa SourceMysqlConfigurationSslModeVerifyCa

To always require encryption and verify that the source has a valid SSL certificate.

VerifyIdentity SourceMysqlConfigurationSslModeVerifyIdentity

To always require encryption and verify that the source has a valid SSL certificate.

Preferred SourceMysqlConfigurationSslModePreferred

To allow unencrypted communication only when the source doesn't support encryption.

Required SourceMysqlConfigurationSslModeRequired

To always require encryption. Note: The connection will fail if the source doesn't support encryption.

VerifyCa SourceMysqlConfigurationSslModeVerifyCa

To always require encryption and verify that the source has a valid SSL certificate.

VerifyIdentity SourceMysqlConfigurationSslModeVerifyIdentity

To always require encryption and verify that the source has a valid SSL certificate.

preferred SourceMysqlConfigurationSslModePreferred

To allow unencrypted communication only when the source doesn't support encryption.

required SourceMysqlConfigurationSslModeRequired

To always require encryption. Note: The connection will fail if the source doesn't support encryption.

verifyCa SourceMysqlConfigurationSslModeVerifyCa

To always require encryption and verify that the source has a valid SSL certificate.

verifyIdentity SourceMysqlConfigurationSslModeVerifyIdentity

To always require encryption and verify that the source has a valid SSL certificate.

preferred SourceMysqlConfigurationSslModePreferred

To allow unencrypted communication only when the source doesn't support encryption.

required SourceMysqlConfigurationSslModeRequired

To always require encryption. Note: The connection will fail if the source doesn't support encryption.

verify_ca SourceMysqlConfigurationSslModeVerifyCa

To always require encryption and verify that the source has a valid SSL certificate.

verify_identity SourceMysqlConfigurationSslModeVerifyIdentity

To always require encryption and verify that the source has a valid SSL certificate.

preferred Property Map

To allow unencrypted communication only when the source doesn't support encryption.

required Property Map

To always require encryption. Note: The connection will fail if the source doesn't support encryption.

verifyCa Property Map

To always require encryption and verify that the source has a valid SSL certificate.

verifyIdentity Property Map

To always require encryption and verify that the source has a valid SSL certificate.

AdditionalProperties string

Parsed as JSON.

Mode string

Default: "preferred"; must be "preferred"

AdditionalProperties string

Parsed as JSON.

Mode string

Default: "preferred"; must be "preferred"

additionalProperties String

Parsed as JSON.

mode String

Default: "preferred"; must be "preferred"

additional_properties str

Parsed as JSON.

mode str

Default: "preferred"; must be "preferred"

additionalProperties String

Parsed as JSON.

mode String

Default: "preferred"; must be "preferred"

AdditionalProperties string

Parsed as JSON.

Mode string

Default: "required"; must be "required"

AdditionalProperties string

Parsed as JSON.

Mode string

Default: "required"; must be "required"

additionalProperties String

Parsed as JSON.

mode String

Default: "required"; must be "required"

additional_properties str

Parsed as JSON.

mode str

Default: "required"; must be "required"

additionalProperties String

Parsed as JSON.

mode String

Default: "required"; must be "required"

CaCertificate This property is required. string

CA certificate

AdditionalProperties string

Parsed as JSON.

ClientCertificate string

Client certificate (this is not a required field, but if you want to use it, you will need to add the Client key as well)

ClientKey string

Client key (this is not a required field, but if you want to use it, you will need to add the Client certificate as well)

ClientKeyPassword string

Password for keystorage. This field is optional. If you do not add it - the password will be generated automatically.

Mode string

Default: "verifyca"; must be "verifyca"

CaCertificate This property is required. string

CA certificate

AdditionalProperties string

Parsed as JSON.

ClientCertificate string

Client certificate (this is not a required field, but if you want to use it, you will need to add the Client key as well)

ClientKey string

Client key (this is not a required field, but if you want to use it, you will need to add the Client certificate as well)

ClientKeyPassword string

Password for keystorage. This field is optional. If you do not add it - the password will be generated automatically.

Mode string

Default: "verifyca"; must be "verifyca"

caCertificate This property is required. String

CA certificate

additionalProperties String

Parsed as JSON.

clientCertificate String

Client certificate (this is not a required field, but if you want to use it, you will need to add the Client key as well)

clientKey String

Client key (this is not a required field, but if you want to use it, you will need to add the Client certificate as well)

clientKeyPassword String

Password for keystorage. This field is optional. If you do not add it - the password will be generated automatically.

mode String

Default: "verifyca"; must be "verifyca"