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
Basic Tab.
Authentication
| 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. |
Connection
| 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. |
| TeamDriveSupport | Determines whether or not to retrieve Team
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. |
OAuth
| Property | Description |
| InitiateOAuth | Set this property to initiate the process
to obtain or refresh the OAuth access token when you connect. |
| OAuthClientId | The client Id assigned when you register
your application with an OAuth authorization server. |
| OAuthClientSecret | The client secret assigned when you
register your application with an OAuth authorization server. |
| OAuthAccessToken | The access token for connecting using
OAuth. |
| OAuthSettingsLocation | The location of the settings file where
OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH.
Alternatively, this can be held in memory by specifying a value starting with memory://.
|
| OAuthVerifier | The verifier code returned from the OAuth
authorization URL. |
| OAuthRefreshToken | The OAuth refresh token for the
corresponding OAuth access token. |
| OAuthExpiresIn | The lifetime in seconds of the OAuth
AccessToken. |
| OAuthTokenTimestamp | The Unix epoch timestamp in milliseconds
when the current Access Token was created. |
JWT OAuth
SSL
| Property | Description |
| SSLServerCert | The certificate to be accepted from the
server when connecting using TLS/SSL. |
Firewall
| Property | Description |
| FirewallType | The protocol used by a proxy-based
firewall. |
| FirewallServer | The name or IP address of a proxy-based
firewall. |
| FirewallPort | The TCP port for a proxy-based firewall.
|
| FirewallUser | The user name to use to authenticate with a
proxy-based firewall. |
| FirewallPassword | A password used to authenticate to a
proxy-based firewall. |
Proxy
| Property | Description |
| ProxyAutoDetect | This indicates whether to use the system
proxy settings or not. This takes precedence over other proxy settings, so you'll need
to set ProxyAutoDetect to FALSE in order use custom proxy settings. |
| ProxyServer | The hostname or IP address of a proxy to
route HTTP traffic through. |
| ProxyPort | The TCP port the ProxyServer proxy is
running on. |
| ProxyAuthScheme | The authentication type to use to
authenticate to the ProxyServer proxy. |
| ProxyUser | A user name to be used to authenticate to
the ProxyServer proxy. |
| ProxyPassword | A password to be used to authenticate to
the ProxyServer proxy. |
| ProxySSLType | The SSL type to use when connecting to the
ProxyServer proxy. |
| ProxyExceptions | A semicolon separated list of destination
hostnames or IPs that are exempt from connecting through the ProxyServer . |
Logging
| Property | Description |
| LogModules | Core modules to be included in the log
file. |
Schema
| Property | Description |
| Location | A path to the directory that contains the
schema files defining tables, views, and stored procedures. |
| 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. |
Miscellaneous
| 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 rows
when no aggregation or group by is used in the query. This helps avoid performance
issues at design time. |
| NullValueMode | Indicates whether to read empty cells as
null or as empty. |
| Other | These hidden properties are used only in
specific use cases. |
| Pagesize | The maximum number of results to return per
page from Google Sheets. |
| PercentageToDecimal | Boolean determining if percentage columns
should be considered as decimal. |
| Readonly | You can use this property to enforce
read-only access to Google Sheets from the provider. |
| 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. |