Skip to content

Latest commit

 

History

History
202 lines (139 loc) · 8.66 KB

destination_mssql_v2.md

File metadata and controls

202 lines (139 loc) · 8.66 KB
page_title subcategory description
airbyte_destination_mssql_v2 Resource - terraform-provider-airbyte
DestinationMssqlV2 Resource

airbyte_destination_mssql_v2 (Resource)

DestinationMssqlV2 Resource

Example Usage

resource "airbyte_destination_mssql_v2" "my_destination_mssqlv2" {
  configuration = {
    database        = "...my_database..."
    host            = "...my_host..."
    jdbc_url_params = "...my_jdbc_url_params..."
    load_type = {
      insert_load = {
        additional_properties = "{ \"see\": \"documentation\" }"
        load_type             = "INSERT"
      }
    }
    password = "...my_password..."
    port     = 1433
    schema   = "public"
    ssl_method = {
      # ...
    }
    user = "...my_user..."
  }
  definition_id = "c9fa67bf-f0a4-4a94-a50c-0a2889bc913d"
  name          = "...my_name..."
  workspace_id  = "ce5dceb6-f2b2-4d39-b087-2eee8dcc9b07"
}

Schema

Required

  • configuration (Attributes) (see below for nested schema)
  • name (String) Name of the destination e.g. dev-mysql-instance.
  • workspace_id (String)

Optional

  • definition_id (String) The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided. Requires replacement if changed.

Read-Only

  • created_at (Number)
  • destination_id (String)
  • destination_type (String)
  • resource_allocation (Attributes) 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. (see below for nested schema)

Nested Schema for configuration

Required:

  • database (String) The name of the MSSQL database.
  • host (String) The host name of the MSSQL database.
  • load_type (Attributes) Specifies the type of load mechanism (e.g., BULK, INSERT) and its associated configuration. (see below for nested schema)
  • port (Number) The port of the MSSQL database.
  • ssl_method (Attributes) The encryption method which is used to communicate with the database. (see below for nested schema)
  • user (String) The username which is used to access the database.

Optional:

  • jdbc_url_params (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, Sensitive) The password associated with this username.
  • schema (String) The default schema tables are written to if the source does not specify a namespace. The usual value for this field is "public". Default: "public"

Nested Schema for configuration.load_type

Optional:

  • bulk_load (Attributes) Configuration details for using the BULK loading mechanism. (see below for nested schema)
  • insert_load (Attributes) Configuration details for using the INSERT loading mechanism. (see below for nested schema)

Nested Schema for configuration.load_type.bulk_load

Required:

Optional:

  • additional_properties (String) Parsed as JSON.
  • bulk_load_validate_values_pre_load (Boolean) When enabled, Airbyte will validate all values before loading them into the destination table. This provides stronger data integrity guarantees but may significantly impact performance. Default: false
  • load_type (String) Default: "BULK"; must be "BULK"

Nested Schema for configuration.load_type.insert_load

Optional:

  • additional_properties (String) Parsed as JSON.
  • load_type (String) Default: "INSERT"; must be "INSERT"

Nested Schema for configuration.ssl_method

Optional:

  • encrypted_trust_server_certificate (Attributes) Use the certificate provided by the server without verification. (For testing purposes only!) (see below for nested schema)
  • encrypted_verify_certificate (Attributes) Verify and use the certificate provided by the server. (see below for nested schema)
  • unencrypted (Attributes) The data transfer will not be encrypted. (see below for nested schema)

Nested Schema for configuration.ssl_method.encrypted_trust_server_certificate

Optional:

  • additional_properties (String) Parsed as JSON.
  • name (String) Default: "encrypted_trust_server_certificate"; must be "encrypted_trust_server_certificate"

Nested Schema for configuration.ssl_method.encrypted_verify_certificate

Optional:

  • additional_properties (String) Parsed as JSON.
  • host_name_in_certificate (String) Specifies the host name of the server. The value of this property must match the subject property of the certificate.
  • name (String) Default: "encrypted_verify_certificate"; must be "encrypted_verify_certificate"
  • trust_store_name (String) Specifies the name of the trust store.
  • trust_store_password (String, Sensitive) Specifies the password of the trust store.

Nested Schema for configuration.ssl_method.unencrypted

Optional:

  • additional_properties (String) Parsed as JSON.
  • name (String) Default: "unencrypted"; must be "unencrypted"

Nested Schema for resource_allocation

Read-Only:

Nested Schema for resource_allocation.default

Read-Only:

  • cpu_limit (String)
  • cpu_request (String)
  • ephemeral_storage_limit (String)
  • ephemeral_storage_request (String)
  • memory_limit (String)
  • memory_request (String)

Nested Schema for resource_allocation.job_specific

Read-Only:

  • job_type (String) enum that describes the different types of jobs that the platform runs. must be one of ["get_spec", "check_connection", "discover_schema", "sync", "reset_connection", "connection_updater", "replicate"]
  • resource_requirements (Attributes) optional resource requirements to run workers (blank for unbounded allocations) (see below for nested schema)

Nested Schema for resource_allocation.job_specific.resource_requirements

Read-Only:

  • cpu_limit (String)
  • cpu_request (String)
  • ephemeral_storage_limit (String)
  • ephemeral_storage_request (String)
  • memory_limit (String)
  • memory_request (String)

Import

Import is supported using the following syntax:

terraform import airbyte_destination_mssql_v2.my_airbyte_destination_mssql_v2 ""