Skip to content

Latest commit

 

History

History
143 lines (98 loc) · 6.72 KB

source_google_sheets.md

File metadata and controls

143 lines (98 loc) · 6.72 KB
page_title subcategory description
airbyte_source_google_sheets Resource - terraform-provider-airbyte
SourceGoogleSheets Resource

airbyte_source_google_sheets (Resource)

SourceGoogleSheets Resource

Example Usage

resource "airbyte_source_google_sheets" "my_source_googlesheets" {
  configuration = {
    batch_size = 10
    credentials = {
      service_account_key_authentication = {
        service_account_info = "{ \"type\": \"service_account\", \"project_id\": YOUR_PROJECT_ID, \"private_key_id\": YOUR_PRIVATE_KEY, ... }"
      }
    }
    names_conversion = false
    spreadsheet_id   = "https://docs.google.com/spreadsheets/d/1hLd9Qqti3UyLXZB2aFfUWDT7BG-arw2xy4HR3D-dwUb/edit"
  }
  definition_id = "8010dc77-56bf-4220-982b-1460e03dad99"
  name          = "...my_name..."
  secret_id     = "...my_secret_id..."
  workspace_id  = "6266806c-1cd7-4250-b2c6-f4ef1504f265"
}

Schema

Required

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

Optional

  • definition_id (String) The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
  • secret_id (String) Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

Read-Only

  • created_at (Number)
  • 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)
  • source_id (String)
  • source_type (String)

Nested Schema for configuration

Required:

  • credentials (Attributes) Credentials for connecting to the Google Sheets API (see below for nested schema)
  • spreadsheet_id (String) Enter the link to the Google spreadsheet you want to sync. To copy the link, click the 'Share' button in the top-right corner of the spreadsheet, then click 'Copy link'.

Optional:

  • batch_size (Number) Default value is 1000000. An integer representing row batch size for each sent request to Google Sheets API. Row batch size means how many rows are processed from the google sheet, for example default value 1000000 would process rows 2-1000002, then 1000003-2000003 and so on. Based on Google Sheets API limits documentation, it is possible to send up to 300 requests per minute, but each individual request has to be processed under 180 seconds, otherwise the request returns a timeout error. In regards to this information, consider network speed and number of columns of the google sheet when deciding a batch_size value. Default: 1000000
  • names_conversion (Boolean) Enables the conversion of column names to a standardized, SQL-compliant format. For example, 'My Name' -> 'my_name'. Enable this option if your destination is SQL-based. Default: false

Nested Schema for configuration.credentials

Optional:

Nested Schema for configuration.credentials.authenticate_via_google_o_auth

Required:

  • client_id (String, Sensitive) Enter your Google application's Client ID. See Google's documentation for more information.
  • client_secret (String, Sensitive) Enter your Google application's Client Secret. See Google's documentation for more information.
  • refresh_token (String, Sensitive) Enter your Google application's refresh token. See Google's documentation for more information.

Nested Schema for configuration.credentials.service_account_key_authentication

Required:

  • service_account_info (String, Sensitive) The JSON key of the service account to use for authorization. Read more here.

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_source_google_sheets.my_airbyte_source_google_sheets ""