Skip to content

Commit

Permalink
Improve readme - more detailed description of range option
Browse files Browse the repository at this point in the history
  • Loading branch information
lancondrej committed Apr 18, 2024
1 parent edc0635 commit 6c9cb5c
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ Setting | Required | Type | Description |
`sheet_id` | Required | String | Your target google sheet id
`output_name` | Optional | String | Optionailly rename the stream and output file or table from the tap
`child_sheet_name` | Optional | String | Optionally choose a different sheet from your Google Sheet file
`range` | Optional | String | Optionally choose a range of data from your Google Sheet file. Example: `B5:GH` (starts at B5 and goes to columns GH at the end of the sheet)
`range` | Optional | String | Optionally choose a range of data from your Google Sheet file (empty mean whole sheet). Range is defined using [A1 notation](https://developers.google.com/sheets/api/guides/concepts#expandable-1). Both start and end cell/column/row needs to be specified. Examples: `B5:G45` (starts at B5 and goes to end of column G45, inclusively), `A:T` (same as `A1:T` whole columns A to T), `3:5` (rows 3 to 5, whole sheet columns), `D3:ZZZ` (starts at D3 and goes to end of sheet, ZZZ is the last column in Google Sheets)
`key_properties` | Optional | Array of Strings | Optionally choose primary key column(s) from your Google Sheet file. Example: `["column_one", "column_two"]`
`sheets` | Optional | Array of Objects | Optionally provide a list of configs for each sheet/stream. See "Per Sheet Config" below. Overrides the `sheet_id` provided at the root level.

Expand All @@ -75,7 +75,7 @@ Setting | Required | Type | Description |
`sheet_id` | Required | String | Your target google sheet id
`output_name` | Optional | String | Optionailly rename the stream and output file or table from the tap
`child_sheet_name` | Optional | String | Optionally choose a different sheet from your Google Sheet file
`range` | Optional | String | Optionally choose a range of data from your Google Sheet file. Example: `B5:GH` (starts at B5 and goes to columns GH at the end of the sheet)
`range` | Optional | String | Optionally choose a range of data from your Google Sheet file (empty mean whole sheet). Range is defined using [A1 notation](https://developers.google.com/sheets/api/guides/concepts#expandable-1). Both start and end cell/column/row needs to be specified. Examples: `B5:G45` (starts at B5 and goes to end of column G45, inclusively), `A:T` (same as `A1:T` whole columns A to T), `3:5` (rows 3 to 5, whole sheet columns), `D3:ZZZ` (starts at D3 and goes to end of sheet, ZZZ is the last column in Google Sheets)
`key_properties` | Optional | Array of Strings | Optionally choose primary key column(s) from your Google Sheet file. Example: `["column_one", "column_two"]`

### Environment Variable
Expand Down

0 comments on commit 6c9cb5c

Please sign in to comment.