Skip to main content

Version: 2.3.10

GoogleSheets

GoogleSheets source connector

Description

Used to read data from GoogleSheets.

Key features

Options

name	type	required	default value
service_account_key	string	yes	-
sheet_id	string	yes	-
sheet_name	string	yes	-
range	string	yes	-
schema	config	no	-

service_account_key [string]

google cloud service account, base64 required

sheet_id [string]

sheet id in a Google Sheets URL

sheet_name [string]

the name of the sheet you want to import

range [string]

the range of the sheet you want to import

schema [config]

fields [config]

the schema fields of upstream data

Example

simple:

GoogleSheets {
  service_account_key = "seatunnel-test"
  sheet_id = "1VI0DvyZK-NIdssSdsDSsSSSC-_-rYMi7ppJiI_jhE"
  sheet_name = "sheets01"
  range = "A1:C3"
  schema = {
    fields {
      a = int
      b = string
      c = string
    }
  }
}

Changelog

Change Log

Change	Commit	Version
[improve] google sheets options (#8922)	https://github.com/apache/seatunnel/commit/48ede612d	2.3.10
[Improve] restruct connector common options (#8634)	https://github.com/apache/seatunnel/commit/f3499a6ee	2.3.10
[Improve][API] Make sure the table name in TablePath not be null (#7252)	https://github.com/apache/seatunnel/commit/764d8b0bc	2.3.7
[Feature][Kafka] Support multi-table source read (#5992)	https://github.com/apache/seatunnel/commit/60104602d	2.3.6
[Improve][Connector-V2] Replace CommonErrorCodeDeprecated.JSON_OPERATION_FAILED (#5978)	https://github.com/apache/seatunnel/commit/456cd1771	2.3.4
[Improve][Common] Introduce new error define rule (#5793)	https://github.com/apache/seatunnel/commit/9d1b2582b	2.3.4
Support config column/primaryKey/constraintKey in schema (#5564)	https://github.com/apache/seatunnel/commit/eac76b4e5	2.3.4
Merge branch 'dev' into merge/cdc	https://github.com/apache/seatunnel/commit/4324ee191	2.3.1
[Improve][Project] Code format with spotless plugin.	https://github.com/apache/seatunnel/commit/423b58303	2.3.1
[improve][api] Refactoring schema parse (#4157)	https://github.com/apache/seatunnel/commit/b2f573a13	2.3.1
[Improve][build] Give the maven module a human readable name (#4114)	https://github.com/apache/seatunnel/commit/d7cd60105	2.3.1
[Improve][Project] Code format with spotless plugin. (#4101)	https://github.com/apache/seatunnel/commit/a2ab16656	2.3.1
[Feature][shade][Jackson] Add seatunnel-jackson module (#3947)	https://github.com/apache/seatunnel/commit/5d8862ec9	2.3.1
[Feature][Connector] add get source method to all source connector (#3846)	https://github.com/apache/seatunnel/commit/417178fb8	2.3.1
[Hotfix][OptionRule] Fix option rule about all connectors (#3592)	https://github.com/apache/seatunnel/commit/226dc6a11	2.3.0
[Improve][Connector-V2][GoogleSheets] Unified exception for GoogleSheets source connector (#3524)	https://github.com/apache/seatunnel/commit/eb42d629a	2.3.0
[Feature][Connector-V2][Google Sheets] Add Google Sheets option rules (#3364)	https://github.com/apache/seatunnel/commit/da33f730c	2.3.0
fix: schema get error (#3361)	https://github.com/apache/seatunnel/commit/fdaa85ed2	2.3.0
[Feature][Connector-V2][GoogleSheets] Support GoogleSheets Source (#3185)	https://github.com/apache/seatunnel/commit/60ecc6428	2.3.0

Description
Key features
Options
Example
Changelog