CData Cloud offers access to Google Sheets across several standard services and protocols, in a cloud-hosted solution. Any application that can connect to a MySQL or SQL Server database can connect to Google Sheets through CData Cloud.
CData Cloud allows you to standardize and configure connections to Google Sheets as though it were any other OData endpoint, or standard SQL Server/MySQL database.
This page provides a guide to Establishing a Connection to Google Sheets in CData Cloud, as well as information on the available resources, and a reference to the available connection properties.
Establishing a Connection shows how to authenticate to Google Sheets and configure any necessary connection properties to create a database in CData Cloud
Accessing data from Google Sheets through the available standard services and CData Cloud administration is documented in further details in the CData Cloud Documentation.
Connect to Google Sheets by selecting the corresponding icon in the Database tab. Required properties are listed under Settings. The Advanced tab lists connection properties that are not typically required.
Access | AuthScheme | Notes |
User Accounts | OAuth | Can use embedded credentials if access from a Desktop application. See Desktop Applications, below. |
Service Accounts | OAuthJWT | Depends on whether the data will be JSON or PFX files. See Authenticating as a Service, below. |
GCP Instance Acct | GCPInstanceAccount | For use on a GCP virtual machine. |
API Key | Token | Also, set APIKey to True. To create an API key in the Google Cloud Console, click Create credentials > API Key. To restrict the key before using it in production, select Restrict and choose one of the available restrictions. |
The following sections focus on authentication as a User, and authentication as a Service.
The following subsections describe how to authenticate to Google Sheets from a User account (AuthScheme OAuth) via three common authentication flows:
For information about how to create a custom OAuth application, and why you might want to create one even for auth flows that have embedded OAuth credentials, see Creating a Custom OAuth Application. For a complete list of connection string properties available in Google Sheets, see Connection.
When the access token expires, the Cloud refreshes it automatically.
Automatic refresh of the OAuth access token:
To have the Cloud automatically refresh the OAuth access token, do the following:
Manual refresh of the OAuth access token:
The only value needed to manually refresh the OAUth access token is the OAuth refresh token.
Store the OAuth refresh token so that you can use it to manually refresh the OAuth access token after it has expired.
(For information on getting and setting the OAuthAccessToken and other configuration parameters, see the Desktop Authentication section of "Connecting to Google Sheets".)
However, a custom OAuth connection is required for Users who connect via the Web, and for connecting on behalf of users via a Service Account. Custom OAuth applications are also useful if you want to:
When the application is complete, the Cloud Console returns you to the Credentials page. A window opens that displays your client Id and client secret.
Although the client secret is accessible from from the Google Cloud Console, we recommend you write down the client secret. You need both the client secret and client Id to specify the OAuthClientId and OAuthClientSecret.
When using AuthScheme=OAuthJWT, you must create a Service account.
At the Google Cloud Console:
The key is automatically downloaded to your local device, and any additional information specific to the key is displayed.
By default, the Cloud attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store.
To specify another certificate, see the SSLServerCert property for the available formats to do so.
To connect through the Windows system proxy, you do not need to set any additional connection properties. To connect to other proxies, set ProxyAutoDetect to false.
In addition, to authenticate to an HTTP proxy, set ProxyAuthScheme, ProxyUser, and ProxyPassword, in addition to ProxyServer and ProxyPort.
Set the following properties:
The Cloud models spreadsheets and ranges as relational tables.
Tables shows various configuration options to reflect your spreadsheets' organization in the tables; for example, you will find guides for working with headers and querying ranges as tables.
Columns provides more information on column discovery.
The Cloud enables you to represent a top-left-oriented spreadsheet or a user-specified range as a database table. You can control how tables are listed by setting the Header property.
Due to a limitation of Google's Spreadsheet API, all column headers must be non empty.
Note: Range notation is only available in a SELECT or UPDATE statement. Ranges are not supported for DELETE and INSERT commands.
You can specify column names or generate column names automatically by setting the Header property. This property affects how you use columns in commands.
Views are similar to tables in the way that data is represented; however, views are read-only.
Queries can be executed against a view as if it were a normal table.
Name | Description |
Folders | Query the folders contained in a user's Google Drive. |
Sheets | Returns a list of a user's sheets and their relevant information. |
Spreadsheets | Returns a list of a user's spreadsheets and their relevant information. |
Query the folders contained in a user's Google Drive.
The Cloud will use the Google Sheets API to process WHERE clause conditions built with the server side supported columns and operators. The rest of the filter is executed client side within the Cloud.
The columns and operators that support server side filtering are:
Note: You must set the connection property SupportsAllDrives to 'true', in order to query from a specific Drive.
All the columns that support server side filtering can be paired with the AND and OR logical operators. For example, the following queries are processed server side:
SELECT * FROM Folders WHERE Name = 'example folder'
SELECT * FROM Folders WHERE OwnerEmail IN ('[email protected]', '[email protected]') AND ModifiedTime >= '2020-04-01T05:30:00'
Name | Type | Description |
Id [KEY] | String | The ID of the folder. |
Name | String | The name of the folder. This is not necessarily unique within a folder. Note that for immutable items such as the top level folders of Team Drives, My Drive root folder, and Application Data folder the name is constant. |
DriveId | String | The Id of the Drive. |
Description | String | A short description of the folder or folder. |
CreatedTime | Datetime | The creation date of the folder or folder. |
ModifiedTime | Datetime | The last modified date of the folder or folder. |
Size | Long | The size of the folder in bytes. |
OwnerName | String | The name of the resource's owner. |
OwnerEmail | String | The email of the resource's owner. |
Starred | Boolean | This field sets whether or not the resource is starred. |
Trashed | Boolean | This field sets whether or not the resource has been moved to the trash. |
Viewed | Boolean | This field sets whether or not the resource has been viewed by the current user. |
ParentIds | String | A comma-separated list of parent folder Ids. |
ChildIds | String | A semicolon-separated list of child resource Ids. |
ChildLinks | String | A semicolon-separated list of child resource links. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
Query | String | This field accepts a valid Google Drive SDK query, which overrides conditionals in the WHERE clause. |
Returns a list of a user's sheets and their relevant information.
Name | Type | Description |
SpreadsheetId | String | The assigned Id of the spreadsheet. |
SpreadsheetName | String | The name of the spreadsheet. |
SheetId | String | The assigned Id of the sheet. |
SheetName | String | The name of the sheet. |
SheetIndex | Integer | The index of the sheet within the spreadsheet. |
SheetType | String | The type of sheet. Defaults to GRID. |
Hidden | Boolean | Specifies if the sheet is hidden in the UI or not. |
RowCount | Integer | The number of rows in the grid. |
ColumnCount | Integer | The number of columns in the grid. |
FrozenRowCount | Integer | The number of rows that are frozen in the grid. |
FrozenColumnCount | Integer | The number of columns that are frozen in the grid. |
DataSourceExecutionStatus | String | The execution status of the DataSource sheet |
Returns a list of a user's spreadsheets and their relevant information.
Name | Type | Description |
Id [KEY] | String | The assigned Id of the spreadsheet. |
Name | String | The name of the spreadsheet. |
Description | String | A short description of the spreadsheet. |
OwnerName | String | The name of the resource's owner. |
OwnerEmail | String | The email of the resource's owner. |
ModifiedTime | Datetime | The last updated date and time of this spreadsheet. |
CreatedTime | Datetime | The created date and time of this spreadsheet. |
Trashed | Boolean | Whether the spreadsheet has been trashed. |
Starred | Boolean | Whether the user has starred the spreadsheet. |
Viewed | Boolean | Whether the user has viewed the spreadsheet. |
ParentIds | String | A comma-separated list of parent folder Ids. |
Stored procedures are function-like interfaces that extend the functionality of the Cloud beyond simple SELECT/INSERT/UPDATE/DELETE operations with Google Sheets.
Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Google Sheets, along with an indication of whether the procedure succeeded or failed.
Name | Description |
AddDataSource | Add a BigQuery dataSource to the specified spreadsheet. A Custom OAuth app with the scope bigquery.readonly is required to run this stored procedure. |
AddDataSourceTable | Add a DataSource Table to a sheet. A Custom OAuth app with the scope bigquery.readonly is required to run this stored procedure. |
AddSheet | Add a worksheet to an existing Google spreadsheet. |
CopySheet | Copies a sheet from a spreadsheet to another spreadsheet. |
CreateSpreadsheet | Creates a spreadsheet in the user's Google Drive. |
DeleteSheet | Deletes a worksheet in an existing Google spreadsheet. |
DeleteSpreadsheet | Deletes a spreadsheet. |
FormatRange | Format cells in a specific range |
UpdateSheet | Updates properties of the sheet for the specified SpreadsheetId and SheetId. |
Add a BigQuery dataSource to the specified spreadsheet. A Custom OAuth app with the scope bigquery.readonly is required to run this stored procedure.
Name | Type | Description |
SpreadsheetId | String | The ID of the spreadsheet. |
ProjectId | String | The ID of a BigQuery enabled GCP project. |
TableProjectId | String | The ID of a BigQuery project the table belongs to. If not specified, the projectId is assumed. |
DatasetId | String | The BigQuery dataset id. |
TableId | String | The BigQuery table id. |
BigQueryQuery | String | The query to use when querying the DataSource |
Name | Type | Description |
Success | String | This value shows whether the operation was successful or not. |
DataSourceId | String | The ID of the created DataSouce |
Status | String | The DataExecution Status |
Add a DataSource Table to a sheet. A Custom OAuth app with the scope bigquery.readonly is required to run this stored procedure.
Name | Type | Description |
SpreadsheetId | String | The ID of the spreadsheet where the table will be created. |
DataSourceId | String | The ID of the DataSource. |
SheetId | String | The ID of the sheet where the table will be pulled to. If not specified 0 will be assumed
The default value is 0. |
RowLimit | String | The limit of rows to return. If not set, a default limit is applied |
Range | String | Range where the dataTable will be pulled to. Ex: A1:G10 |
RefreshDatasourceMode | String | Refreshes the datasource table after creating it. DATASOURCEID - Refreshes all associated data source objects for the datasource. ISALL - Refreshes all existing data source objects in the spreadsheet. NONE - Do not refresh the datasource table
The allowed values are DATASOURCEID, ISALL, NONE. The default value is DATASOURCEID. |
Name | Type | Description |
Success | String | This value shows whether the operation was successful or not. |
Add a worksheet to an existing Google spreadsheet.
Name | Type | Description |
SpreadsheetId | String | The ID of the spreadsheet. |
SheetId | String | The ID of the sheet. Must be non-negative. This field cannot be changed once set. |
Title | String | The name of the sheet. |
Index | String | The index of the sheet within the spreadsheet. |
SheetType | String | The type of sheet. Defaults to GRID. This field cannot be changed once set.
The allowed values are GRID, OBJECT. The default value is GRID. |
RowCount | String | The number of rows in the grid. |
ColumnCount | String | The number of columns in the grid. |
FrozenRowCount | String | The number of rows that are frozen in the grid. |
FrozenColumnCount | String | The number of columns that are frozen in the grid. |
HideGridlines | Boolean | True if the grid is not showing gridlines in the UI. |
Hidden | Boolean | True if the sheet is hidden in the UI, false if it is visible. |
RightToLeft | Boolean | True if the sheet is an RTL sheet instead of an LTR sheet. |
Name | Type | Description |
Success | String | This value shows whether the operation was successful or not. |
Copies a sheet from a spreadsheet to another spreadsheet.
Name | Type | Description |
SpreadsheetId | String | The ID of the spreadsheet containing the sheet to copy. |
SheetId | String | The ID of the sheet to copy |
DestinationSpreadsheetId | String | The ID of the spreadsheet where it will be copied to. |
SheetName | String | Optional parameter. The new name you want to set to the newly created sheet. |
Name | Type | Description |
Success | String | This value shows whether the operation was successful or not. |
SheetId | String | The Id of the newly created sheet |
Creates a spreadsheet in the user's Google Drive.
Name | Type | Description |
Title | String | The title for the spreadsheet. |
Description | String | The description for the spreadsheet. |
Hidden | Boolean | This parameter sets whether or not the resource is hidden.
The default value is FALSE. |
Restricted | Boolean | This parameter sets whether or not the resource is restricted.
The default value is FALSE. |
Starred | Boolean | This parameter sets whether or not the resource is starred.
The default value is FALSE. |
Parents | String | The Ids of the parent folders for the created spreadsheet. |
Name | Type | Description |
Success | String | This parameter indicates whether the operation was successful or not. |
Id | String | The Id of the new spreadsheet. |
Deletes a worksheet in an existing Google spreadsheet.
Name | Type | Description |
SpreadsheetId | String | The ID of the spreadsheet. |
SheetId | String | The ID of the sheet. |
Name | Type | Description |
Success | String | This value shows whether the operation was successful or not. |
Deletes a spreadsheet.
Name | Type | Description |
SpreadsheetId | String | The ID of the spreadsheet. |
Name | Type | Description |
Success | String | This value shows whether the operation was successful or not. |
Format cells in a specific range
Name | Type | Description |
SpreadsheetId | String | The ID of the spreadsheet. |
SheetId | String | The ID of the sheet. Must be non-negative. |
Range | String | The range of the cells to format. The format should be, for example A1:C3. |
BackgroundColor | String | Specify background color by providing RGB values for Red, Green, Blue. For example 255,0,0. |
Bold | String | Bold the text of the cells. Accepts true or false. |
FontSize | String | Set font size by providing an int value. |
FontFamily | String | Set the font used by providing its name. |
Name | Type | Description |
Success | String | This value shows whether the operation was successful or not. |
Updates properties of the sheet for the specified SpreadsheetId and SheetId.
Name | Type | Description |
SpreadsheetId | String | The ID of the spreadsheet. |
SheetId | String | The ID of the sheet. Must be non-negative. |
Title | String | The name of the sheet. |
Index | String | The index of the sheet within the spreadsheet. |
RowCount | String | The number of rows in the grid. |
ColumnCount | String | The number of columns in the grid. |
FrozenRowCount | String | The number of rows that are frozen in the grid. |
FrozenColumnCount | String | The number of columns that are frozen in the grid. |
HideGridlines | Boolean | True if the grid is not showing gridlines in the UI. |
Hidden | Boolean | True if the sheet is hidden in the UI, false if it is visible. |
RightToLeft | Boolean | True if the sheet is an RTL sheet instead of an LTR sheet. |
Name | Type | Description |
Success | String | This value shows whether the operation was successful or not. |
You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.
The following tables return database metadata for Google Sheets:
The following tables return information about how to connect to and query the data source:
The following table returns query statistics for data modification queries, including batch operations::
Lists the available databases.
The following query retrieves all databases determined by the connection string:
SELECT * FROM sys_catalogs
Name | Type | Description |
CatalogName | String | The database name. |
Lists the available schemas.
The following query retrieves all available schemas:
SELECT * FROM sys_schemas
Name | Type | Description |
CatalogName | String | The database name. |
SchemaName | String | The schema name. |
Lists the available tables.
The following query retrieves the available tables and views:
SELECT * FROM sys_tables
Name | Type | Description |
CatalogName | String | The database containing the table or view. |
SchemaName | String | The schema containing the table or view. |
TableName | String | The name of the table or view. |
TableType | String | The table type (table or view). |
Description | String | A description of the table or view. |
IsUpdateable | Boolean | Whether the table can be updated. |
Describes the columns of the available tables and views.
The following query returns the columns and data types for the Spreadsheet1_Sheet1 table:
SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Spreadsheet1_Sheet1'
Name | Type | Description |
CatalogName | String | The name of the database containing the table or view. |
SchemaName | String | The schema containing the table or view. |
TableName | String | The name of the table or view containing the column. |
ColumnName | String | The column name. |
DataTypeName | String | The data type name. |
DataType | Int32 | An integer indicating the data type. This value is determined at run time based on the environment. |
Length | Int32 | The storage size of the column. |
DisplaySize | Int32 | The designated column's normal maximum width in characters. |
NumericPrecision | Int32 | The maximum number of digits in numeric data. The column length in characters for character and date-time data. |
NumericScale | Int32 | The column scale or number of digits to the right of the decimal point. |
IsNullable | Boolean | Whether the column can contain null. |
Description | String | A brief description of the column. |
Ordinal | Int32 | The sequence number of the column. |
IsAutoIncrement | String | Whether the column value is assigned in fixed increments. |
IsGeneratedColumn | String | Whether the column is generated. |
IsHidden | Boolean | Whether the column is hidden. |
IsArray | Boolean | Whether the column is an array. |
IsReadOnly | Boolean | Whether the column is read-only. |
IsKey | Boolean | Indicates whether a field returned from sys_tablecolumns is the primary key of the table. |
Lists the available stored procedures.
The following query retrieves the available stored procedures:
SELECT * FROM sys_procedures
Name | Type | Description |
CatalogName | String | The database containing the stored procedure. |
SchemaName | String | The schema containing the stored procedure. |
ProcedureName | String | The name of the stored procedure. |
Description | String | A description of the stored procedure. |
ProcedureType | String | The type of the procedure, such as PROCEDURE or FUNCTION. |
Describes stored procedure parameters.
The following query returns information about all of the input parameters for the DownloadDocument stored procedure:
SELECT * FROM sys_procedureparameters WHERE ProcedureName='DownloadDocument' AND Direction=1 OR Direction=2
Name | Type | Description |
CatalogName | String | The name of the database containing the stored procedure. |
SchemaName | String | The name of the schema containing the stored procedure. |
ProcedureName | String | The name of the stored procedure containing the parameter. |
ColumnName | String | The name of the stored procedure parameter. |
Direction | Int32 | An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters. |
DataTypeName | String | The name of the data type. |
DataType | Int32 | An integer indicating the data type. This value is determined at run time based on the environment. |
Length | Int32 | The number of characters allowed for character data. The number of digits allowed for numeric data. |
NumericPrecision | Int32 | The maximum precision for numeric data. The column length in characters for character and date-time data. |
NumericScale | Int32 | The number of digits to the right of the decimal point in numeric data. |
IsNullable | Boolean | Whether the parameter can contain null. |
IsRequired | Boolean | Whether the parameter is required for execution of the procedure. |
IsArray | Boolean | Whether the parameter is an array. |
Description | String | The description of the parameter. |
Ordinal | Int32 | The index of the parameter. |
Describes the primary and foreign keys.
The following query retrieves the primary key for the Spreadsheet1_Sheet1 table:
SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Spreadsheet1_Sheet1'
Name | Type | Description |
CatalogName | String | The name of the database containing the key. |
SchemaName | String | The name of the schema containing the key. |
TableName | String | The name of the table containing the key. |
ColumnName | String | The name of the key column. |
IsKey | Boolean | Whether the column is a primary key in the table referenced in the TableName field. |
IsForeignKey | Boolean | Whether the column is a foreign key referenced in the TableName field. |
PrimaryKeyName | String | The name of the primary key. |
ForeignKeyName | String | The name of the foreign key. |
ReferencedCatalogName | String | The database containing the primary key. |
ReferencedSchemaName | String | The schema containing the primary key. |
ReferencedTableName | String | The table containing the primary key. |
ReferencedColumnName | String | The column name of the primary key. |
Describes the foreign keys.
The following query retrieves all foreign keys which refer to other tables:
SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
Name | Type | Description |
CatalogName | String | The name of the database containing the key. |
SchemaName | String | The name of the schema containing the key. |
TableName | String | The name of the table containing the key. |
ColumnName | String | The name of the key column. |
PrimaryKeyName | String | The name of the primary key. |
ForeignKeyName | String | The name of the foreign key. |
ReferencedCatalogName | String | The database containing the primary key. |
ReferencedSchemaName | String | The schema containing the primary key. |
ReferencedTableName | String | The table containing the primary key. |
ReferencedColumnName | String | The column name of the primary key. |
ForeignKeyType | String | Designates whether the foreign key is an import (points to other tables) or export (referenced from other tables) key. |
Describes the primary keys.
The following query retrieves the primary keys from all tables and views:
SELECT * FROM sys_primarykeys
Name | Type | Description |
CatalogName | String | The name of the database containing the key. |
SchemaName | String | The name of the schema containing the key. |
TableName | String | The name of the table containing the key. |
ColumnName | String | The name of the key column. |
KeySeq | String | The sequence number of the primary key. |
KeyName | String | The name of the primary key. |
Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.
The following query retrieves all indexes that are not primary keys:
SELECT * FROM sys_indexes WHERE IsPrimary='false'
Name | Type | Description |
CatalogName | String | The name of the database containing the index. |
SchemaName | String | The name of the schema containing the index. |
TableName | String | The name of the table containing the index. |
IndexName | String | The index name. |
ColumnName | String | The name of the column associated with the index. |
IsUnique | Boolean | True if the index is unique. False otherwise. |
IsPrimary | Boolean | True if the index is a primary key. False otherwise. |
Type | Int16 | An integer value corresponding to the index type: statistic (0), clustered (1), hashed (2), or other (3). |
SortOrder | String | The sort order: A for ascending or D for descending. |
OrdinalPosition | Int16 | The sequence number of the column in the index. |
Returns information on the available connection properties and those set in the connection string.
When querying this table, the config connection string should be used:
jdbc:cdata:googlesheets:config:
This connection string enables you to query this table without a valid connection.
The following query retrieves all connection properties that have been set in the connection string or set through a default value:
SELECT * FROM sys_connection_props WHERE Value <> ''
Name | Type | Description |
Name | String | The name of the connection property. |
ShortDescription | String | A brief description. |
Type | String | The data type of the connection property. |
Default | String | The default value if one is not explicitly set. |
Values | String | A comma-separated list of possible values. A validation error is thrown if another value is specified. |
Value | String | The value you set or a preconfigured default. |
Required | Boolean | Whether the property is required to connect. |
Category | String | The category of the connection property. |
IsSessionProperty | String | Whether the property is a session property, used to save information about the current connection. |
Sensitivity | String | The sensitivity level of the property. This informs whether the property is obfuscated in logging and authentication forms. |
PropertyName | String | A camel-cased truncated form of the connection property name. |
Ordinal | Int32 | The index of the parameter. |
CatOrdinal | Int32 | The index of the parameter category. |
Hierarchy | String | Shows dependent properties associated that need to be set alongside this one. |
Visible | Boolean | Informs whether the property is visible in the connection UI. |
ETC | String | Various miscellaneous information about the property. |
Describes the SELECT query processing that the Cloud can offload to the data source.
See SQL Compliance for SQL syntax details.
Below is an example data set of SQL capabilities. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.
Name | Description | Possible Values |
AGGREGATE_FUNCTIONS | Supported aggregation functions. | AVG, COUNT, MAX, MIN, SUM, DISTINCT |
COUNT | Whether COUNT function is supported. | YES, NO |
IDENTIFIER_QUOTE_OPEN_CHAR | The opening character used to escape an identifier. | [ |
IDENTIFIER_QUOTE_CLOSE_CHAR | The closing character used to escape an identifier. | ] |
SUPPORTED_OPERATORS | A list of supported SQL operators. | =, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR |
GROUP_BY | Whether GROUP BY is supported, and, if so, the degree of support. | NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE |
OJ_CAPABILITIES | The supported varieties of outer joins supported. | NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS |
OUTER_JOINS | Whether outer joins are supported. | YES, NO |
SUBQUERIES | Whether subqueries are supported, and, if so, the degree of support. | NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED |
STRING_FUNCTIONS | Supported string functions. | LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE |
NUMERIC_FUNCTIONS | Supported numeric functions. | ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE |
TIMEDATE_FUNCTIONS | Supported date/time functions. | NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT |
REPLICATION_SKIP_TABLES | Indicates tables skipped during replication. | |
REPLICATION_TIMECHECK_COLUMNS | A string array containing a list of columns which will be used to check for (in the given order) to use as a modified column during replication. | |
IDENTIFIER_PATTERN | String value indicating what string is valid for an identifier. | |
SUPPORT_TRANSACTION | Indicates if the provider supports transactions such as commit and rollback. | YES, NO |
DIALECT | Indicates the SQL dialect to use. | |
KEY_PROPERTIES | Indicates the properties which identify the uniform database. | |
SUPPORTS_MULTIPLE_SCHEMAS | Indicates if multiple schemas may exist for the provider. | YES, NO |
SUPPORTS_MULTIPLE_CATALOGS | Indicates if multiple catalogs may exist for the provider. | YES, NO |
DATASYNCVERSION | The CData Data Sync version needed to access this driver. | Standard, Starter, Professional, Enterprise |
DATASYNCCATEGORY | The CData Data Sync category of this driver. | Source, Destination, Cloud Destination |
SUPPORTSENHANCEDSQL | Whether enhanced SQL functionality beyond what is offered by the API is supported. | TRUE, FALSE |
SUPPORTS_BATCH_OPERATIONS | Whether batch operations are supported. | YES, NO |
SQL_CAP | All supported SQL capabilities for this driver. | SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX |
PREFERRED_CACHE_OPTIONS | A string value specifies the preferred cacheOptions. | |
ENABLE_EF_ADVANCED_QUERY | Indicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side. | YES, NO |
PSEUDO_COLUMNS | A string array indicating the available pseudo columns. | |
MERGE_ALWAYS | If the value is true, The Merge Mode is forcibly executed in Data Sync. | TRUE, FALSE |
REPLICATION_MIN_DATE_QUERY | A select query to return the replicate start datetime. | |
REPLICATION_MIN_FUNCTION | Allows a provider to specify the formula name to use for executing a server side min. | |
REPLICATION_START_DATE | Allows a provider to specify a replicate startdate. | |
REPLICATION_MAX_DATE_QUERY | A select query to return the replicate end datetime. | |
REPLICATION_MAX_FUNCTION | Allows a provider to specify the formula name to use for executing a server side max. | |
IGNORE_INTERVALS_ON_INITIAL_REPLICATE | A list of tables which will skip dividing the replicate into chunks on the initial replicate. | |
CHECKCACHE_USE_PARENTID | Indicates whether the CheckCache statement should be done against the parent key column. | TRUE, FALSE |
CREATE_SCHEMA_PROCEDURES | Indicates stored procedures that can be used for generating schema files. |
The following query retrieves the operators that can be used in the WHERE clause:
SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'
Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Using Spreadsheets as Tables section for more information.
Name | Type | Description |
NAME | String | A component of SQL syntax, or a capability that can be processed on the server. |
VALUE | String | Detail on the supported SQL or SQL syntax. |
Returns information about attempted modifications.
The following query retrieves the Ids of the modified rows in a batch operation:
SELECT * FROM sys_identity
Name | Type | Description |
Id | String | The database-generated Id returned from a data modification operation. |
Batch | String | An identifier for the batch. 1 for a single operation. |
Operation | String | The result of the operation in the batch: INSERTED, UPDATED, or DELETED. |
Message | String | SUCCESS or an error message if the update in the batch failed. |
The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.
For more information on establishing a connection, see Establishing a Connection.
Property | Description |
AuthScheme | The type of authentication to use when connecting to Google Sheets. |
APIKey | If your client application does not use OAuth 2.0, then it must include an API key when it calls an API that's enabled within a Google Cloud Platform project. |
Property | Description |
Spreadsheet | A comma-separated list of the names or Ids of the spreadsheets to be viewed. |
FolderName | A comma separated list of the folders' names from which to retrieve spreadsheets in the format FolderName='name1,name2'. |
FolderId | A comma separated list of the folders' ids from which to retrieve spreadsheets in the format FolderId='id1,id2,id3'. |
ShowTrashedFiles | Indicates whether or not the trashed files will be listed. |
SkipHiddenSheets | Indicates whether or not the hidden sheets will be listed. |
SupportsAllDrives | Determines whether or not to retrieve Drive items. |
UseIdAsTableName | Indicates whether or not to use Ids as Spreadsheet and Sheet name. |
TeamDrive | A drive's names or ids from which to retrieve spreadsheets in the format TeamDrive='Shared drive 2, Shared drive 3', or TeamDrive='0BKwyFj1j9FOsUk9EVO, 0ANMIP9RIe1LQUk9PVA'. |
DomainSharedFilesOnly | Boolean determining if the exposed sheets are limited to only the sheets shared to the user's domain or not. |
RecurseFolders | Used in case FolderId/FolderName properties are defined. If set to True this makes the driver return all the Spreadsheets inside nested folders, else the driver will return only the files directly to that foder. By default this is set to false. |
IgnoreErrorValues | When enabled, fields where the provider detects error values will be returned as NULL. If disabled, the provider throws an error if an error value is detected in any field. |
Property | Description |
OAuthJWTCert | The JWT Certificate store. |
OAuthJWTCertType | The type of key store containing the JWT Certificate. |
OAuthJWTCertPassword | The password for the OAuth JWT certificate. |
OAuthJWTCertSubject | The subject of the OAuth JWT certificate. |
OAuthJWTIssuer | The issuer of the Java Web Token. |
OAuthJWTSubject | The user subject for which the application is requesting delegated access. |
Property | Description |
SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
Property | Description |
Verbosity | The verbosity level that determines the amount of detail included in the log file. |
Property | Description |
BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC. |
TypeDetectionScheme | Determines how to determine the data types of columns. |
Header | Indicates whether or not the first row should be used as a column header. |
PrimaryKeyIdentifier | Set this property to control the name of the primary key. |
DefineTables | Define the tables within the Google Spreadsheet. |
Orientation | Indicates whether the data in the sheet is laid out horizontally or vertically. |
Property | Description |
AutoAdjustRange | If set to true, the driver will automatically expand the dimensions in case the updated/insert/deleted value is outside the range of the sheet. |
DateTimeRenderOption | Determines how dates, times, and durations should be represented in the output. This is ignored if the ValueRenderOption is FormattedValue. The default datetime render option is SerialNumber. |
InsertDataOption | Determines how existing data is changed when new data is input. |
MaxRows | Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses. |
NullValueMode | Indicates whether to read empty cells as null or as empty. |
Pagesize | The maximum number of results to return per page from Google Sheets. |
PercentageToDecimal | Boolean determining if percentage columns should be considered as decimal. |
PseudoColumns | This property indicates whether or not to include pseudo columns as columns to the table. |
RowScanDepth | The maximum number of rows to scan to look for the columns available in a table. |
ShowEmptyRows | Indicates whether or not the empty rows should be pushed. |
Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
UseSimpleNames | Boolean determining if simple names should be used for tables and columns. |
ValueInputOption | Determines how inserted values should be treated. |
ValueRenderOption | Determines how values should be rendered in the output. |
This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.
Property | Description |
AuthScheme | The type of authentication to use when connecting to Google Sheets. |
APIKey | If your client application does not use OAuth 2.0, then it must include an API key when it calls an API that's enabled within a Google Cloud Platform project. |
The type of authentication to use when connecting to Google Sheets.
string
"OAuth"
If your client application does not use OAuth 2.0, then it must include an API key when it calls an API that's enabled within a Google Cloud Platform project.
string
""
If your client application does not use OAuth 2.0, then it must include an API key when it calls an API that's enabled within a Google Cloud Platform project.
This section provides a complete list of the Connection properties you can configure in the connection string for this provider.
Property | Description |
Spreadsheet | A comma-separated list of the names or Ids of the spreadsheets to be viewed. |
FolderName | A comma separated list of the folders' names from which to retrieve spreadsheets in the format FolderName='name1,name2'. |
FolderId | A comma separated list of the folders' ids from which to retrieve spreadsheets in the format FolderId='id1,id2,id3'. |
ShowTrashedFiles | Indicates whether or not the trashed files will be listed. |
SkipHiddenSheets | Indicates whether or not the hidden sheets will be listed. |
SupportsAllDrives | Determines whether or not to retrieve Drive items. |
UseIdAsTableName | Indicates whether or not to use Ids as Spreadsheet and Sheet name. |
TeamDrive | A drive's names or ids from which to retrieve spreadsheets in the format TeamDrive='Shared drive 2, Shared drive 3', or TeamDrive='0BKwyFj1j9FOsUk9EVO, 0ANMIP9RIe1LQUk9PVA'. |
DomainSharedFilesOnly | Boolean determining if the exposed sheets are limited to only the sheets shared to the user's domain or not. |
RecurseFolders | Used in case FolderId/FolderName properties are defined. If set to True this makes the driver return all the Spreadsheets inside nested folders, else the driver will return only the files directly to that foder. By default this is set to false. |
IgnoreErrorValues | When enabled, fields where the provider detects error values will be returned as NULL. If disabled, the provider throws an error if an error value is detected in any field. |
A comma-separated list of the names or Ids of the spreadsheets to be viewed.
string
""
A comma-separated list of the names or Ids of the spreadsheets to be viewed. Query the Spreadsheets view to retrieve this data.
Note: In case you are providing the names of the spreadsheets, make sure to provide the exact spreadsheet name, including the leading and/or trailing spaces. Also, you should not add extra spaces before and after the comma separator. If any of the spreadsheet names includes a comma, escape it by using a backslash '\'.
A comma separated list of the folders' names from which to retrieve spreadsheets in the format FolderName='name1,name2'.
string
""
A comma separated list of the folders' names from which to retrieve spreadsheets in the format FolderName='name1,name2'.
A comma separated list of the folders' ids from which to retrieve spreadsheets in the format FolderId='id1,id2,id3'.
string
""
A comma separated list of the folders' ids from which to retrieve spreadsheets in the format FolderId='id1,id2,id3'.
Indicates whether or not the trashed files will be listed.
bool
false
If true, the driver will list the files/spreadsheets that have been trashed.
Indicates whether or not the hidden sheets will be listed.
bool
false
If true, the driver will skip the hidden sheets.
Determines whether or not to retrieve Drive items.
bool
false
If you set this property to 'true', you can query from any Drive spreadsheets.
Indicates whether or not to use Ids as Spreadsheet and Sheet name.
bool
false
Indicates whether or not to use Ids as Spreadsheet and Sheet name. To select in a sheet instead of SpreadsheetName_SheetName use: SpreadsheetId_SheetId. Ex: SELECT * FROM 11696gdF5QUL1EnYikYiUeMTHRqA1111KbdYDoINqI_1151117664
A drive's names or ids from which to retrieve spreadsheets in the format TeamDrive='Shared drive 2, Shared drive 3', or TeamDrive='0BKwyFj1j9FOsUk9EVO, 0ANMIP9RIe1LQUk9PVA'.
string
""
A drive's names or ids from which to retrieve spreadsheets in the format TeamDrive='Shared drive 2, Shared drive 3', or TeamDrive='0BKwyFj1j9FOsUk9EVO, 0ANMIP9RIe1LQUk9PVA'.
Used in case FolderId/FolderName properties are defined. If set to True this makes the driver return all the Spreadsheets inside nested folders, else the driver will return only the files directly to that foder. By default this is set to false.
bool
false
Used in case FolderId/FolderName properties are defined. If set to True this makes the driver return all the Spreadsheets inside nested folders, else the driver will return only the files directly to that foder. By default this is set to false.
When enabled, fields where the provider detects error values will be returned as NULL. If disabled, the provider throws an error if an error value is detected in any field.
bool
true
If this property is set to true, the Cloud returns fields containing value errors as NULL.
When this property is set to false, the Cloud throws an error if a value error is discovered.
The Cloud checks for the following error values:
This section provides a complete list of the JWT OAuth properties you can configure in the connection string for this provider.
Property | Description |
OAuthJWTCert | The JWT Certificate store. |
OAuthJWTCertType | The type of key store containing the JWT Certificate. |
OAuthJWTCertPassword | The password for the OAuth JWT certificate. |
OAuthJWTCertSubject | The subject of the OAuth JWT certificate. |
OAuthJWTIssuer | The issuer of the Java Web Token. |
OAuthJWTSubject | The user subject for which the application is requesting delegated access. |
The JWT Certificate store.
string
""
The name of the certificate store for the client certificate.
The OAuthJWTCertType field specifies the type of the certificate store specified by OAuthJWTCert. If the store is password protected, specify the password in OAuthJWTCertPassword.
OAuthJWTCert is used in conjunction with the OAuthJWTCertSubject field in order to specify client certificates. If OAuthJWTCert has a value, and OAuthJWTCertSubject is set, a search for a certificate is initiated. Please refer to the OAuthJWTCertSubject field for details.
Designations of certificate stores are platform-dependent.
The following are designations of the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
SPC | Software publisher certificates. |
In Java, the certificate store normally is a file containing certificates and optional private keys.
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).
The type of key store containing the JWT Certificate.
string
"GOOGLEJSONBLOB"
This property can take one of the following values:
USER | For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: This store type is not available in Java. |
MACHINE | For Windows, this specifies that the certificate store is a machine store. Note: this store type is not available in Java. |
PFXFILE | The certificate store is the name of a PFX (PKCS12) file containing certificates. |
PFXBLOB | The certificate store is a string (base-64-encoded) representing a certificate store in PFX (PKCS12) format. |
JKSFILE | The certificate store is the name of a Java key store (JKS) file containing certificates. Note: this store type is only available in Java. |
JKSBLOB | The certificate store is a string (base-64-encoded) representing a certificate store in Java key store (JKS) format. Note: this store type is only available in Java. |
PEMKEY_FILE | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
PEMKEY_BLOB | The certificate store is a string (base64-encoded) that contains a private key and an optional certificate. |
PUBLIC_KEY_FILE | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
PUBLIC_KEY_BLOB | The certificate store is a string (base-64-encoded) that contains a PEM- or DER-encoded public key certificate. |
SSHPUBLIC_KEY_FILE | The certificate store is the name of a file that contains an SSH-style public key. |
SSHPUBLIC_KEY_BLOB | The certificate store is a string (base-64-encoded) that contains an SSH-style public key. |
P7BFILE | The certificate store is the name of a PKCS7 file containing certificates. |
PPKFILE | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
XMLFILE | The certificate store is the name of a file that contains a certificate in XML format. |
XMLBLOB | The certificate store is a string that contains a certificate in XML format. |
GOOGLEJSON | The certificate store is the name of a JSON file containing the service account information. Only valid when connecting to a Google service. |
GOOGLEJSONBLOB | The certificate store is a string that contains the service account JSON. Only valid when connecting to a Google service. |
The password for the OAuth JWT certificate.
string
""
If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.
This is not required when using the GOOGLEJSON OAuthJWTCertType. Google JSON keys are not encrypted.
The subject of the OAuth JWT certificate.
string
"*"
When loading a certificate the subject is used to locate the certificate in the store.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks the first certificate in the certificate store.
The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, [email protected]". Common fields and their meanings are displayed below.
Field | Meaning |
CN | Common Name. This is commonly a host name like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma it must be quoted.
The issuer of the Java Web Token.
string
""
The issuer of the Java Web Token. Enter the value of a delegated user Email Address.
This is not required when using the GOOGLEJSON OAuthJWTCertType. Google JSON keys contain a copy of the issuer account.
The issuer of the Java Web Token. Enter the value of a delegated user Email Address.
This is not required when using the GOOGLEJSON OAuthJWTCertType. Google JSON keys contain a copy of the issuer account.
The user subject for which the application is requesting delegated access.
string
""
The user subject for which the application is requesting delegated access. Enter the value of the Service Account Email.
The user subject for which the application is requesting delegated access. Enter the value of the Service Account Email.
This section provides a complete list of the SSL properties you can configure in the connection string for this provider.
Property | Description |
SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
The certificate to be accepted from the server when connecting using TLS/SSL.
string
""
If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.
This property can take the following forms:
Description | Example |
A full PEM Certificate (example shortened for brevity) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
A path to a local file containing the certificate | C:\cert.cer |
The public key (example shortened for brevity) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
The MD5 Thumbprint (hex values can also be either space or colon separated) | ecadbdda5a1529c58a1e9e09828d70e4 |
The SHA1 Thumbprint (hex values can also be either space or colon separated) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
If not specified, any certificate trusted by the machine is accepted.
Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.
This section provides a complete list of the Logging properties you can configure in the connection string for this provider.
Property | Description |
Verbosity | The verbosity level that determines the amount of detail included in the log file. |
The verbosity level that determines the amount of detail included in the log file.
string
"1"
The verbosity level determines the amount of detail that the Cloud reports to the Logfile. Verbosity levels from 1 to 5 are supported. These are detailed in the Logging page.
This section provides a complete list of the Schema properties you can configure in the connection string for this provider.
Property | Description |
BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC. |
TypeDetectionScheme | Determines how to determine the data types of columns. |
Header | Indicates whether or not the first row should be used as a column header. |
PrimaryKeyIdentifier | Set this property to control the name of the primary key. |
DefineTables | Define the tables within the Google Spreadsheet. |
Orientation | Indicates whether the data in the sheet is laid out horizontally or vertically. |
This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
string
""
Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.
Determines how to determine the data types of columns.
string
"RowScan"
None | Setting TypeDetectionScheme to None returns all columns as the string type. Note: Even when set to None, the column names are still scanned when Header is set to True. |
RowScan | Setting TypeDetectionScheme to RowScan scans rows to heuristically determine the data type. The RowScanDepth determines the number of rows to be scanned. Setting this to -1 directs the driver to scan the entire sheet. |
Indicates whether or not the first row should be used as a column header.
bool
true
If true, the first row will be used as a column header. Otherwise, the pseudo column names (A, B, C, etc.) will be used.
The Header property is used in conjunction with the Orientation property. When Header is set to false and Orientation is set to Columns, column names are reported as R1, R2, R3, etc.
Set this property to control the name of the primary key.
string
""
Determines the name of the primary key column which holds the row number. The default value of the primary key is Id.
Set this property if there is a column named ID in the table you are quering, or if you prefer to change the name of the primary key.
Define the tables within the Google Spreadsheet.
string
""
This property is used to define the ranges within a sheet that will appear as tables. The value is a comma-separated list of name-value pairs in the form [Table Name]=[Spreadsheet Name]_[Sheet Name]![Range] or [Table Name]=[Spreadsheet Name]_[Sheet Name]![Range]. Table Name is the name of the table you want to use for the data and will be used when issuing queries. Sheet Name is the name of the sheet within the Google Spreadsheet and Range is the range of cells that contain the data for the table.
Here is an example DefineTables value: DefineTables="Table1=Spreadsheet1_Sheet1!A1:N25,Table2=Spreadsheet1_Sheet2!C3:M53,Table4=xIsPcLs2-bF3AavQcSLCfzs3kGc_Sheet4!C20:N60".
Indicates whether the data in the sheet is laid out horizontally or vertically.
string
"Vertical"
Horizontal | Specifies that the Cloud operates on the rows of a sheet. |
Vertical | Specifies that the Cloud operates on the columns of a sheet. |
Set this to "Horizontal" if the rows are arranged left to right. The first column contains the column names and subsequent columns become rows.
This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.
Property | Description |
AutoAdjustRange | If set to true, the driver will automatically expand the dimensions in case the updated/insert/deleted value is outside the range of the sheet. |
DateTimeRenderOption | Determines how dates, times, and durations should be represented in the output. This is ignored if the ValueRenderOption is FormattedValue. The default datetime render option is SerialNumber. |
InsertDataOption | Determines how existing data is changed when new data is input. |
MaxRows | Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses. |
NullValueMode | Indicates whether to read empty cells as null or as empty. |
Pagesize | The maximum number of results to return per page from Google Sheets. |
PercentageToDecimal | Boolean determining if percentage columns should be considered as decimal. |
PseudoColumns | This property indicates whether or not to include pseudo columns as columns to the table. |
RowScanDepth | The maximum number of rows to scan to look for the columns available in a table. |
ShowEmptyRows | Indicates whether or not the empty rows should be pushed. |
Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
UseSimpleNames | Boolean determining if simple names should be used for tables and columns. |
ValueInputOption | Determines how inserted values should be treated. |
ValueRenderOption | Determines how values should be rendered in the output. |
If set to true, the driver will automatically expand the dimensions in case the updated/insert/deleted value is outside the range of the sheet.
bool
false
If set to true, the driver will automatically expand the dimensions in case the updated/insert/deleted value is outside the range of the sheet.
Determines how dates, times, and durations should be represented in the output. This is ignored if the ValueRenderOption is FormattedValue. The default datetime render option is SerialNumber.
string
"SerialNumber"
SerialNumber | Instructs the Cloud to output date, time, datetime, and duration fields as doubles in "serial number" format, as popularized by Lotus 1-2-3. The whole number portion of the value (left of the decimal) counts the days since December 30th 1899. The fractional portion (right of the decimal) counts the time as a fraction of the day. For example, January 1st 1900 at noon would be 2.5, 2 because it's 2 days after December 30st, 1899, and .5 because noon is half a day. February 1st, 1900 at 3pm would be 33.625. This correctly treats the year 1900 as not a leap year. |
FormattedString | Instructs the Cloud to output date, time, datetime, and duration fields as strings in their given number format (which is dependent on the spreadsheet locale). |
Determines how existing data is changed when new data is input.
string
"Overwrite"
Overwrite |
The new data replaces the contents of the row after the last row in the table. Note that this could potentially overwrite data after the last row in the table, as the Cloud stops returning rows if it encounters a blank row. See Tables for more information on how the Cloud discovers tables from the spreadsheet data. |
InsertRows | The Cloud will insert a new row at the line specified (or at the end of the table). This avoids overwriting data below the table by incrementing the Ids of all rows below by one. It also allows you to insert data between existing rows -- the following query inserts a new row 2. The existing row 2 becomes row 3, row 3 becomes row 4, and so on.
INSERT INTO Spreadsheet1_Sheet1(Id,Name, Amount) VALUES (2,'Test', 10) |
Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
int
-1
Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
Indicates whether to read empty cells as null or as empty.
string
"ReadAsNull"
NullValueMode controls how empty Google Sheets cells are modelled. An empty cell is a cell that has not been set and thus contains a null string. If NullValueMode is set to ReadAsNull, NULL is reported for an empty cell; if NullValueMode is set to ReadAsEmpty, an empty string is reported for an empty cell.
The maximum number of results to return per page from Google Sheets.
int
1000
The Pagesize property affects the maximum number of results to return per page from Google Sheets. Setting a higher value may result in better performance at the cost of additional memory allocated per page consumed.
Boolean determining if percentage columns should be considered as decimal.
bool
false
Boolean determining if percentage columns should be considered as decimal.
This property indicates whether or not to include pseudo columns as columns to the table.
string
""
This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".
The maximum number of rows to scan to look for the columns available in a table.
int
50
The columns in a table must be determined by scanning table rows. This value determines the maximum number of rows that will be scanned.
Setting a high value may decrease performance. Setting a low value may prevent the data type from being determined properly, especially when there is null data.
Indicates whether or not the empty rows should be pushed.
bool
false
If true, the empty rows will be pushed at the output.
The value in seconds until the timeout error is thrown, canceling the operation.
int
60
If Timeout = 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.
If Timeout expires and the operation is not yet complete, the Cloud throws an exception.
Boolean determining if simple names should be used for tables and columns.
bool
false
Google Sheets tables and columns can use special characters in names that are normally not allowed in standard databases. UseSimpleNames makes the Cloud easier to use with traditional database tools.
Setting UseSimpleNames to true will simplify the names of tables and columns returned. It will enforce a naming scheme such that only alphanumeric characters and the underscore are valid for the displayed table and column names. Any nonalphanumeric characters will be converted to an underscore.
Determines how inserted values should be treated.
string
"UserEntered"
Raw | The values the user has entered will not be parsed and will be stored as-is. |
UserEntered | The values will be parsed as if the user typed them into the UI. Numbers will stay as numbers, but strings may be converted to numbers, dates, etc. -- following the same rules that are applied when entering text into a cell via the Google Sheets UI. |
Determines how values should be rendered in the output.
string
"FormattedValue"
FormattedValue | Values will be calculated and formatted in the reply according to the cell's formatting. Formatting is based on the spreadsheet's locale, not the requesting user's locale. For example, if A1 is "1.23" and A2 is "=A1" and formatted as currency, then A2 would return "$1.23". |
UnformattedValue | Values will be calculated, but not formatted in the reply. For example, if A1 is "1.23" and A2 is "=A1" and formatted as currency, then A2 would return the number "1.23". |
Formula | Values will not be calculated. The reply will include the formulas. For example, if A1 is "1.23" and A2 is "=A1" and formatted as currency, then A2 would return "=A1". |