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.

Connecting to Google Sheets

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 CData Cloud Services

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.

Connecting to Google Sheets

The following sections focus on authentication as a User, and authentication as a Service.

Authenticating as a User (OAuth)

The following subsections describe how to authenticate to Google Sheets from a User account (AuthScheme OAuth) via three common authentication flows:

• Desktop: a connection to a server on the user's local machine, frequently used for testing and prototyping. Authenticated via either embedded OAuth or custom OAuth.
• Web: access to data via a shared website. Authenticated via custom OAuth only.
• Headless Server: a dedicated computer that provides services to other computers and their users, which is configured to operate without a monitor and keyboard. Authenticated via embedded OAuth or custom OAuth.

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:

1. The first time you connect to data, set the following connection parameters:
   • InitiateOAuth: REFRESH.
   • OAuthClientId: The client Id in your application settings.
   • OAuthClientSecret: The client secret in your application settings.
   • OAuthAccessToken: The access token returned by GetOAuthAccessToken.
   • OAuthSettingsLocation: The path where you want the Cloud to save the OAuth values, which persist across connections.
2. On subsequent data connections, set the following:
   • InitiateOAuth
   • OAuthSettingsLocation

Manual refresh of the OAuth access token:

The only value needed to manually refresh the OAUth access token is the OAuth refresh token.

1. To manually refresh the OAuthAccessToken after the ExpiresIn period (returned by GetOAuthAccessToken) has elapsed, call the RefreshOAuthAccessToken stored procedure.
2. Set the following connection properties:
   • OAuthClientId: The Client Id in your application settings.
   • OAuthClientSecret: The Client Secret in your application settings.

3. Call RefreshOAuthAccessToken with OAuthRefreshToken set to the OAuth refresh token returned by GetOAuthAccessToken.
4. After the new tokens have been retrieved, set the OAuthAccessToken property to the value returned by RefreshOAuthAccessToken. This opens a new connection.

Store the OAuth refresh token so that you can use it to manually refresh the OAuth access token after it has expired.

Required Scopes and Endpoint Domains for Google Sheets

These permissions are defined by access scopes, which determine what data your application can access and what actions it can perform.

This topic provides information about the required access scopes and endpoint domains for the Google Sheets Cloud.

Understanding Scopes

Scopes are a way to limit an application's access to a user's data. They define the specific actions that an application can perform on behalf of the user.

For example, a read-only scope might allow an application to view data, while a full access scope might allow it to modify data.

Required Scopes for Google Sheets

Understanding Endpoint Domains

Endpoint domains are the specific URLs that the application needs to communicate with in order to authenticate, retrieve records, and perform other essential operations.

Allowlisting these domains ensures that the network traffic between your application and the API is not blocked by firewalls or security settings.

Note: Most users do not need to make any special configurations. Allowlisting is typically only necessary for environments with strict security measures, such as restricted outbound network traffic.

Required Endpoint Domains for Google Sheets

Creating a Custom OAuth Application

• set AuthScheme to OAuth,
• get and set the OAuthAccessToken, and
• set the necessary configuration parameters.

(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:

• control branding of the authentication dialog;
• control the redirect URI that the application redirects the user to after the user authenticates; or
• customize the permissions that you are requesting from the user.

Procedure

1. Navigate to the Google Cloud Console.
2. At the left navigation pane, select Library. The console opens the Library page.
3. Use the Search service to find Google Sheets API. Select "Google Sheets API" from the search results.
4. On the Google Sheets API page, click ENABLE.

User Accounts

1. Create a new project or select an existing project.
2. At the left navigation pane, select Credentials.
3. If the selected project does not have a consent screen, click CONFIGURE CONSENT SCREEN. If you are not using a Google Workspace account, you are restricted to creating an External-type Consent Screen, which requires specifying a support email and developer contact email. Additional information is optional.
4. On the Credentials page, select Create Credentials > OAuth Client ID.
5. In the Application Type menu, select Web application.
6. Specify a name for your OAuth custom web application.
7. Under Authorized redirect URIs, click ADD URI and enter a redirect URI.
8. Click Enter.
9. Click CREATE.

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.

Service Accounts

When using AuthScheme=OAuthJWT, you must create a Service account.

At the Google Cloud Console:

• To complete the service account flow, generate a private key in the Google Cloud Console. In the service account flow, the driver exchanges a JSON Web token (JWT) for the OAuthAccessToken. The private key is required to sign the JWT. The driver grants the same permissions to the Service Account.

• Now create a new Service Account:
  
  1. Create a new project or select an existing project.
  2. At the left navigation pane, select Credentials.
  3. Navigate to Create Credentials > Service account. The Cloud Console displays the Create Service Account page.
  4. Enter the Service account name, the Service account ID, and, optionally, a description.
  5. Click DONE. The Cloud Console returns you to the Credentials page.
  6. In the Service Accounts area, select the service accout you just created.
  7. Click the KEYs tab, then click ADD KEY > Create new key.
  8. Select any supported Key type, such as OAuthJWTCert or OAuthJWTCertType.
  9. Click CREATE.

The key is automatically downloaded to your local device, and any additional information specific to the key is displayed.

Customizing the SSL Configuration

By default, the Cloud attempts to negotiate TLS with the server. The server certificate is validated against the default system trusted certificate store. You can override how the certificate gets validated using the SSLServerCert connection property.

To specify another certificate, see the SSLServerCert connection property.

Connecting Through a Firewall or Proxy

HTTP Proxies

To authenticate to an HTTP proxy, set the following:

• ProxyServer: the hostname or IP address of the proxy server that you want to route HTTP traffic through.
• ProxyPort: the TCP port that the proxy server is running on.
• ProxyAuthScheme: the authentication method the Cloud uses when authenticating to the proxy server.
• ProxyUser: the username of a user account registered with the proxy server.
• ProxyPassword: the password associated with the ProxyUser.

Other Proxies

Set the following properties:

• To use a proxy-based firewall, set FirewallType, FirewallServer, and FirewallPort.
• To tunnel the connection, set FirewallType to TUNNEL.
• To authenticate, specify FirewallUser and FirewallPassword.
• To authenticate to a SOCKS proxy, additionally set FirewallType to SOCKS5.

Spreadsheets as Tables

The Cloud models spreadsheets and ranges as relational tables.

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.

Stored Procedures

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.

Top-Left Oriented Tables

• Top-left-oriented tables are represented with the name of the worksheet.
• The default format requires that the table is top-left-oriented and that the first row of data in the worksheet contains the column names. This means that the default value of true for the Header connection string property is required.
• Headers should not contain special characters.
• By default the Cloud will return all rows until the first empty row. Note: an empty row between data will prevent further data from being returned.

Due to a limitation of Google's Spreadsheet API, all column headers must be non empty.

User-Specified Range

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.

Header=True (Default)

• Columns are determined by the first row of the Google spreadsheet. If no values are provided for the first row of the spreadsheet, the Cloud will create unique, alphabetized column names that are available only within the scope of that request.
• The Cloud also adds an Id column for each row that corresponds to the unique URI of the row on the Google servers. This is used during update and delete operations.

Header=False

• Columns will be dynamically assigned based on either the specified range or the size of the worksheet. The autogenerated column names are alphabetical.
• The Id column for each row will represent the row number from the top of the sheet. For example, if you specify a range A3:E6, rows 3, 4, 5, and 6 will be returned.

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.

CData Cloud - Google Sheets Views

Query the folders contained in a user's Google Drive.

Select

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:

• Name supports the 'CONTAINS,=,!=' operators.
• Description supports the 'CONTAINS' operator.
• ModifiedTime supports the '<=,<,=,!=,>,>=' operators.
• OwnerEmail supports the 'IN' operator.
• Starred supports the '=,!=' operators.
• Trashed supports the '=,!=' operators.
• ParentIds supports the 'IN' operator.
• DriveId supports the '=' operator. It is used to get all the folders from the specified Drive.

  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'

Columns

Pseudo-Columns

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.

Returns a list of a user's sheets and their relevant information.

Columns

Returns a list of a user's spreadsheets and their relevant information.

Columns

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.

CData Cloud - Google Sheets Stored Procedures

Add a BigQuery dataSource to the specified spreadsheet. A Custom OAuth app with the scope bigquery.readonly is required to run this stored procedure.

Input

Result Set Columns

Add a DataSource Table to a sheet. A Custom OAuth app with the scope bigquery.readonly is required to run this stored procedure.

Input

Result Set Columns

Add a worksheet to an existing Google spreadsheet.

Input

Result Set Columns

Copies a sheet from a spreadsheet to another spreadsheet.

Input

Result Set Columns

Creates a spreadsheet in the user's Google Drive.

Input

Result Set Columns

Deletes a worksheet in an existing Google spreadsheet.

Input

Result Set Columns

Deletes a spreadsheet.

Input

Result Set Columns

Format cells in a specific range

Input

Result Set Columns

Updates properties of the sheet for the specified SpreadsheetId and SheetId.

Input

Result Set Columns

You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.

Schema Tables

The following tables return database metadata for Google Sheets:

• sys_catalogs: Lists the available databases.
• sys_schemas: Lists the available schemas.
• sys_tables: Lists the available tables and views.
• sys_tablecolumns: Describes the columns of the available tables and views.
• sys_procedures: Describes the available stored procedures.
• sys_procedureparameters: Describes stored procedure parameters.
• sys_keycolumns: Describes the primary and foreign keys.
• sys_indexes: Describes the available indexes.

Data Source Tables

The following tables return information about how to connect to and query the data source:

• sys_connection_props: Returns information on the available connection properties.
• sys_sqlinfo: Describes the SELECT queries that the Cloud can offload to the data source.

Query Information Tables

The following table returns query statistics for data modification queries, including batch operations::

• sys_identity: Returns information about batch operations or single updates.

Lists the available databases.

The following query retrieves all databases determined by the connection string:

SELECT * FROM sys_catalogs

Columns

Lists the available schemas.

The following query retrieves all available schemas:

          SELECT * FROM sys_schemas
          

Columns

Lists the available tables.

The following query retrieves the available tables and views:

          SELECT * FROM sys_tables
          

Columns

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' 

Columns

Lists the available stored procedures.

The following query retrieves the available stored procedures:

          SELECT * FROM sys_procedures
          

Columns

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

Columns

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' 
          

Columns

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'
          

Columns

Describes the primary keys.

The following query retrieves the primary keys from all tables and views:

         SELECT * FROM sys_primarykeys
          

Columns

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'
          

Columns

Returns information on the available connection properties and those set in the connection string.

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 <> ''

Columns

Describes the SELECT query processing that the Cloud can offload to the data source.

See SQL Compliance for SQL syntax details.

Discovering the Data Source's SELECT Capabilities

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.

The following query retrieves the operators that can be used in the WHERE clause:

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'

Columns

Returns information about attempted modifications.

The following query retrieves the Ids of the modified rows in a batch operation:

         SELECT * FROM sys_identity
          

Columns

Describes the available system information.

The following query retrieves all columns:

SELECT * FROM sys_information

Columns

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.

Authentication

Connection

OAuth

JWT OAuth

SSL

Logging

Schema

Miscellaneous

This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.

The type of authentication to use when connecting to Google Sheets.

Possible Values

Data Type

string

Default Value

"OAuth"

Remarks

• Token: Set this to perform Token Based Authentication via the APIKey property.
• OAuth: Set this to perform OAuth authentication using a standard user account.
• OAuthJWT: Set this to perform OAuth authentication using an OAuth service account.
• GCPInstanceAccount: Set this to get Access Token from Google Cloud Platform instance.

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.

Data Type

string

Default Value

""

Remarks

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.

A comma-separated list of the names or Ids of the spreadsheets to be viewed.

Data Type

string

Default Value

""

Remarks

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'.

Data Type

string

Default Value

""

Remarks

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'.

Data Type

string

Default Value

""

Remarks

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.

Data Type

bool

Default Value

false

Remarks

If true, the driver will list the files/spreadsheets that have been trashed.

Indicates whether or not the hidden sheets will be listed.

Data Type

bool

Default Value

false

Remarks

If true, the driver will skip the hidden sheets.

Determines whether or not to retrieve Drive items.

Data Type

bool

Default Value

false

Remarks

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.

Data Type

bool

Default Value

false

Remarks

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'.

Data Type

string

Default Value

""

Remarks

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'.

Boolean determining if the exposed sheets are limited to only the sheets shared to the user's domain or not.

Data Type

bool

Default Value

false

Remarks

If true, the driver will retrieve and expose only the sheets shared to the user's domain, excluding the sheets owned by the user. If false, the driver will retrieve both, the files owned by and shared to the user.

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.

Data Type

bool

Default Value

false

Remarks

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.

Data Type

bool

Default Value

true

Remarks

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:

• #NULL!
• #N/A
• #DIV/0!
• #VALUE!
• #REF!
• #NAME?
• #NUM!
• #ERROR!

This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.

Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.

Data Type

string

Default Value

""

Remarks

OAuthClientId is one of a handful of connection parameters that need to be set before users can authenticate via OAuth. For details, see Establishing a Connection.

Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.

Data Type

string

Default Value

""

Remarks

OAuthClientSecret is one of a handful of connection parameters that need to be set before users can authenticate via OAuth. For details, see Establishing a Connection.

A space-delimited list of service account emails for delegated requests.

Data Type

string

Default Value

""

Remarks

The service account emails must be specified in a space-delimited list.

Each service account must be granted the roles/iam.serviceAccountTokenCreator role on its next service account in the chain.

The last service account in the chain must be granted the roles/iam.serviceAccountTokenCreator role on the requesting service account. The requesting service account is the one specified in the RequestingServiceAccount property.

Note that for delegated requests, the requesting service account must have the permission iam.serviceAccounts.getAccessToken, which can also be granted through the serviceAccountTokenCreator role.

A service account email to make a delegated request.

Data Type

string

Default Value

""

Remarks

The service account email of the account for which the credentials are requested in a delegated request. With the list of delegated service accounts in DelegatedServiceAccounts, this property is used to make a delegated request.

You must have the IAM permission iam.serviceAccounts.getAccessToken on this service account.

This section provides a complete list of the JWT OAuth properties you can configure in the connection string for this provider.

The JWT Certificate store.

Data Type

string

Default Value

""

Remarks

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:

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.

Possible Values

Data Type

string

Default Value

"GOOGLEJSONBLOB"

Remarks

This property can take one of the following values:

The password for the OAuth JWT certificate used to access a certificate store that requires a password. If the certificate store does not require a password, leave this property blank.

Data Type

string

Default Value

""

Remarks

This property specifies the password needed to open the certificate store, but only if the store type requires one. To determine if a password is necessary, refer to the documentation or configuration for your specific certificate store.

This is not required when using the GOOGLEJSON OAuthJWTCertType. Google JSON keys are not encrypted.

The subject of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '*' to select the first certificate.

Data Type

string

Default Value

"*"

Remarks

The value of this property is used to locate a matching certificate in the store. The search process works as follows:

• If an exact match for the subject is found, the corresponding certificate is selected.
• If no exact match is found, the store is searched for certificates whose subjects contain the property value.
• If no match is found, no certificate is selected.

You can set the value to '*' to automatically select the first certificate in the store. The certificate subject is a comma-separated list of distinguished name fields and values. For example: CN=www.server.com, OU=test, C=US, [email protected]. Common fields include:

If a field value contains a comma, enclose it in quotes. For example: "O=ACME, Inc.".

The issuer of the Java Web Token.

Data Type

string

Default Value

""

Remarks

The issuer of the Java Web Token. Enter the value of the service account 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.

Data Type

string

Default Value

""

Remarks

The user subject for which the application is requesting delegated access. Enter the email address of the user for which the application is requesting delegated access.

This section provides a complete list of the SSL properties you can configure in the connection string for this provider.

Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

Data Type

string

Default Value

""

Remarks

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:

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.

Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.

Data Type

string

Default Value

"1"

Remarks

This property defines the level of detail the Cloud includes in the log file. Higher verbosity levels increase the detail of the logged information, but may also result in larger log files and slower performance due to the additional data being captured.

The default verbosity level is 1, which is recommended for regular operation. Higher verbosity levels are primarily intended for debugging purposes. For more information on each level, refer to Logging.

When combined with the LogModules property, Verbosity can refine logging to specific categories of information.

This section provides a complete list of the Schema properties you can configure in the connection string for this provider.

Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .

Data Type

string

Default Value

""

Remarks

Listing all available database schemas can take extra time, thus degrading performance. Providing a list of schemas in the connection string saves time and improves performance.

Determines how to determine the data types of columns.

Possible Values

Data Type

string

Default Value

"RowScan"

Remarks

Indicates whether or not the first row should be used as a column header.

Data Type

bool

Default Value

true

Remarks

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.

Data Type

string

Default Value

""

Remarks

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.

Data Type

string

Default Value

""

Remarks

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.

Possible Values

Data Type

string

Default Value

"Vertical"

Remarks

By default, the Cloud models vertically oriented spreadsheet data -- rows arranged vertically below a header row.

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.

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.

Data Type

bool

Default Value

false

Remarks

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.

Configuration properties to provide when using Workload Identity Federation via AWS.

Data Type

string

Default Value

""

Remarks

The properties are formatted as a semicolon-separated list of Key=Value properties, where the value is optionally quoted. For example, this setting authenticates in AWS using a user's root keys:

AWSWorkloadIdentityConfig="AuhtScheme=AwsRootKeys;AccessKey='AKIAABCDEF123456';SecretKey=...;Region=us-east-1"

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.

Possible Values

Data Type

string

Default Value

"SerialNumber"

Remarks

Determines how existing data is changed when new data is input.

Possible Values

Data Type

string

Default Value

"Overwrite"

Remarks

INSERT INTO Spreadsheet1_Sheet1(Id,Name, Amount) VALUES (2,'Test', 10)

Specifies the maximum rows returned for queries without aggregation or GROUP BY.

Data Type

int

Default Value

-1

Remarks

This property sets an upper limit on the number of rows the Cloud returns for queries that do not include aggregation or GROUP BY clauses. This limit ensures that queries do not return excessively large result sets by default.

When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting. If MaxRows is set to "-1", no row limit is enforced unless a LIMIT clause is explicitly included in the query.

This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.

Indicates whether to read empty cells as null or as empty.

Possible Values

Data Type

string

Default Value

"ReadAsNull"

Remarks

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.

Specifies the maximum number of results to return from Google Sheets, per page. This setting overrides the default page size set by the datasource, which is optimized for most use cases.

Data Type

int

Default Value

1000

Remarks

You may want to adjust the default pagesize to optimize results for a particular object or service endpoint you are querying. Be aware that increasing the page size may improve performance, but it could also result in higher memory consumption per page.

Boolean determining if percentage columns should be considered as decimal.

Data Type

bool

Default Value

false

Remarks

Boolean determining if percentage columns should be considered as decimal.

Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.

Data Type

string

Default Value

""

Remarks

This property allows you to define which pseudocolumns the Cloud exposes as table columns.

To specify individual pseudocolumns, use the following format: "Table1=Column1;Table1=Column2;Table2=Column3"

To include all pseudocolumns for all tables use: "*=*"

The maximum number of rows to scan to look for the columns available in a table.

Data Type

int

Default Value

50

Remarks

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.

Data Type

bool

Default Value

false

Remarks

If true, the empty rows will be pushed at the output.

Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.

Data Type

int

Default Value

60

Remarks

This property controls the maximum time, in seconds, that the Cloud waits for an operation to complete before canceling it. If the timeout period expires before the operation finishes, the Cloud cancels the operation and throws an exception.

The timeout applies to each individual communication with the server rather than the entire query or operation. For example, a query could continue running beyond 60 seconds if each paging call completes within the timeout limit.

Setting this property to 0 disables the timeout, allowing operations to run indefinitely until they succeed or fail due to other conditions such as server-side timeouts, network interruptions, or resource limits on the server. Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.

Boolean determining if simple names should be used for tables and columns.

Data Type

bool

Default Value

false

Remarks

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.

Possible Values

Data Type

string

Default Value

"UserEntered"

Remarks

Determines how values should be rendered in the output.

Possible Values

Data Type

string

Default Value

"FormattedValue"

Remarks

The ID of your Workload Identity Federation pool.

Data Type

string

Default Value

""

Remarks

The ID of your Workload Identity Federation pool.

The ID of the Google Cloud project that hosts your Workload Identity Federation pool.

Data Type

string

Default Value

""

Remarks

The ID of the Google Cloud project that hosts your Workload Identity Federation pool.

The ID of your Workload Identity Federation pool provider.

Data Type

string

Default Value

""

Remarks

The ID of your Workload Identity Federation pool provider.