helper::GoogleSheet Class
Description
The helper::GoogleSheet class contains properties and methods for interacting with Google Sheets.
Properties
- spreadsheetCharacter
String spreadsheet property
- errorCharacter
String error property
- mergedCharacter
String merged property
- listTablesResponseCharacter
String listTablesResponse property
- showFormulasCharacter
String showFormulas property
- formatAsTextCharacter
String formatAsText property
Methods
- AddNamedRanges Method
Define new named ranges.
- AddSheet Method
Add a new sheet to a spreadsheet.
- AppendRows Method
The AppendRows method appends rows to a specified Google Sheet table.
- AppendSheetJSON Method
Append cells in first available empty space in sheet. Values are specified as JSON array of objects
- AppendSheetRaw Method
Append cells in first available empty space in sheet. Values are specified as JSON array of arrays . Optional range can provide a hint of where to start.
- AppendSheetText Method
Append cells in first available empty space in sheet. Values are specified as crlf delimited rows of delimited cells. Separator defines the delimiter, which is assumed to be a comma if ommitted.
- CreateSheetForTable Method
The CreateSheetForTable method creates a new Google Sheet for a specified SQL table.
- DeleteNamedRanges Method
Delete existing named ranges
- DeleteSheet Method
Delete an existing sheet from a spreadsheet.
- DeleteTable Method
The DeleteTable method deletes the Google Sheet that stores the specified table.
- EmptyTable Method
The EmptyTable method clears all data from a specified Google Sheet table.
- FixupAutoIncrements Method
The FixupAutoIncrements method adjusts the auto-increment values for a specified column in a Google Sheet table.
- GetAutoIncrementColumn Method
The GetAutoIncrementColumn method retrieves the index of the auto-increment column for a given table.
- GetKeyColumns Method
The GetKeyColumns method returns the key columns for a specified table.
- GetNamedRangeJson Method
Get the JSON array of objects for named range - if column names are not supplied, then the first row of the range is assumed to contain the column names.
- GetNamedRangeRaw Method
Get Spreadsheet cells using a named range
- GetNamedRanges Method
Get Named Ranges defined for SpreadSheet, setitng details to .t. returns the current range associated with the name
- GetNamedRangeText Method
Get named range as crlf delimited lines of delimited text defaulting to comma separated if to separator specified.
- GetSheetIdFromName Method
The GetSheetIdFromName method retrieves the internal sheet ID for a specified table name.
- GetSheetJson Method
Get the JSON array of objects for the sheet and optional range - if column names are not supplied, then the first row of the range is assumed to contain the column names.
- GetSheetRaw Method
Get the raw JSON array of arrays for the sheet and optional range.
- GetSheetText Method
Get range as crlf delimited lines of delimited text defaulting to comma separated if to separator specified.
- GetTableInfo Method
The GetTableInfo method retrieves table information for a specified Google Sheet table name.
- ListTables Method
The ListTables method returns a list of tables available in the configured Google Sheet.
- PackTable Method
The PackTable method packs a specified Google Sheet table.
- PopulateTableInfo Method
The PopulateTableInfo method populates a table info object with the specified fields.
- PublishTable Method
The PublishTable method publishes a SQL table to a Google Sheet.
- PublishTables Method
The PublishTables method publishes multiple SQL tables to a Google Sheet.
- SelectRecords Method
The SelectRecords method retrieves records from a Google Sheet table.
- UpdateNamedRangeJSON Method
Update a named ranges contents using JSON array of objects, arranged using the supplied columnnames. If column names are not supplied, then the first record is used to generate the column names.
- UpdateNamedRangeRaw Method
Update a named ranges contents using a raw JSON Array or arrays (at optional range / default to A1 if unspecified)
- UpdateNamedRanges Method
Update existing named range, adding them if they are missing.
- UpdateNamedRangeText Method
Update a named ranges contents using a delimited text and an optional range.
- UpdateSheetJSON Method
Update a sheet using JSON array of objects, arranged using the supplied columnnames. If column names are not supplied, then the first record is used to generate the column names.
- UpdateSheetRaw Method
Update a sheet using a raw JSON Array or arrays (at optional range / default to A1 if unspecified)
- UpdateSheetText Method
Update a sheet using a delimited text and an optional range.
See Also