CData Cloud offers access to Google Cloud Storage across several standard services and protocols, in a cloud-hosted solution. Any application that can connect to a SQL Server database can connect to Google Cloud Storage through CData Cloud.
CData Cloud allows you to standardize and configure connections to Google Cloud Storage as though it were any other OData endpoint or standard SQL Server.
This page provides a guide to Establishing a Connection to Google Cloud Storage 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 Cloud Storage and configure any necessary connection properties to create a database in CData Cloud
Accessing data from Google Cloud Storage through the available standard services and CData Cloud administration is documented in further details in the CData Cloud Documentation.
Connect to Google Cloud Storage 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.
Provide the following connection properties before adding the authentication properties.
The Cloud supports using user accounts and GCP instance accounts for authentication.
The following sections discuss the available authentication schemes for Google Cloud Storage:
AuthScheme must be set to OAuth in all user account flows.
Get an OAuth Access Token
Set the following connection properties to obtain the OAuthAccessToken:
Then call stored procedures to complete the OAuth exchange:
Once you have obtained the access and refresh tokens, you can connect to data and refresh the OAuth access token either automatically or manually.
Automatic Refresh of the OAuth Access Token
To have the driver automatically refresh the OAuth access token, set the following on the first data connection:
Manual Refresh of the OAuth Access Token
The only value needed to manually refresh the OAuth access token when connecting to data is the OAuth refresh token.
Use the RefreshOAuthAccessToken stored procedure to manually refresh the OAuthAccessToken after the ExpiresIn parameter value returned by GetOAuthAccessToken has elapsed, then set the following connection properties:
Then call RefreshOAuthAccessToken with OAuthRefreshToken set to the OAuth refresh token returned by GetOAuthAccessToken. After the new tokens have been retrieved, open a new connection by setting the OAuthAccessToken property to the value returned by RefreshOAuthAccessToken.
Finally, store the OAuth refresh token so that you can use it to manually refresh the OAuth access token after it has expired.
Option 1: Obtain and Exchange a Verifier Code
To obtain a verifier code, you must authenticate at the OAuth authorization URL.
Follow the steps below to authenticate from the machine with an internet browser and obtain the OAuthVerifier connection property.
On the headless machine, set the following connection properties to obtain the OAuth authentication values:
After the OAuth settings file is generated, you need to re-set the following properties to connect:
Option 2: Transfer OAuth Settings
Prior to connecting on a headless machine, you need to create and install a connection with the driver on a device that supports an internet browser. Set the connection properties as described in "Desktop Applications" above.
After completing the instructions in "Desktop Applications", the resulting authentication values are encrypted and written to the location specified by OAuthSettingsLocation. The default filename is OAuthSettings.txt.
Once you have successfully tested the connection, copy the OAuth settings file to your headless machine.
On the headless machine, set the following connection properties to connect to data:
When running on a GCP virtual machine, the Cloud can authenticate using a service account tied to the virtual machine. To use this mode, set AuthScheme to GCPInstanceAccount.
(For information on getting and setting the OAuthAccessToken and other configuration parameters, see the Desktop Authentication section of "Connecting to Google Cloud Storage".)
However, you must create a custom OAuth application to connect to Google Cloud Storage via the Web. And since custom OAuth applications seamlessly support all three commonly-used auth flows, you might want to create custom OAuth applications (use your own OAuth Application Credentials) for those auth flows anyway.
Custom OAuth applications are useful if you want to:
The following sections describe how to enable the Directory API and create custom OAuth applications for user accounts (OAuth) and Service Accounts (OAuth/JWT).
For users whose AuthScheme is OAuth and who need to authenticate over a web application, you must always create a custom OAuth application. (For desktop and headless flows, creating a custom OAuth application is optional.)
Do the following:
Note: The client secret remains accessible from from the Google Cloud Console.
To create a new service account:
In the service account flow, the Cloud exchanges a JSON Web Token (JWT) for the OAuthAccessToken. The private key downloaded in the steps above is used to sign the JWT. The Cloud inherits the permissions granted to the service account, including any scopes configured through domain-wide delegation.
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.
To authenticate to an HTTP proxy, set the following:
Set the following properties:
This section describes how the Cloud models the Google Cloud Storage API as relational Views and Stored Procedures.
Pre-defined Views are available for read only access to data from Google Cloud Storage, including Buckets, Bucket information, and Objects.
Stored procedures allow you to execute operations to Google Cloud Storage, including downloading and uploading objects.
System Tables contains information about the objects and resources belonging to your database.
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 |
| BucketACLs | Returns information for ACLs of a specific bucket. |
| BucketCORS | Returns information for CORS of a specific bucket. |
| BucketLifecycle | Returns information about lifecycle of a specific bucket. |
| Buckets | Returns information for buckets. Buckets are used to store objects, which consist of data and its metadata. |
| ObjectACLs | Returns information for ACLs of a specific object. |
| Objects | Returns information for objects inside a specific bucket. |
| ObjectVersions | Returns information for object versions inside a specific bucket. |
Returns information for ACLs of a specific bucket.
The Cloud will use the Google Cloud Storage API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
For example, the following queries are processed server side:
SELECT * FROM BucketACLs WHERE Bucket = 'TestBucket'
| Name | Type | Description |
| Id [KEY] | String | The ID of the access-control entry. |
| Entity | String | The entity holding the permission. |
| Role | String | The access permission for the entity. |
| String | The email address associated with the entity, if any. | |
| EntityId | String | The ID for the entity, if any. |
| Domain | String | The domain associated with the entity, if any. |
| ProjectTeamNumber | String | The project number. |
| ProjectTeamType | String | The team type. |
| ETag | String | HTTP 1.1 Entity tag for the access-control entry. |
| Bucket | String | The name of the bucket. |
Returns information for CORS of a specific bucket.
The Cloud will use the Google Cloud Storage API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
For example, the following queries are processed server side:
SELECT * FROM BucketCORS WHERE Bucket = 'TestBucket'
| Name | Type | Description |
| Origin | String | The list of Origins eligible to receive CORS response headers. |
| Method | String | The list of HTTP methods on which to include CORS response headers, (GET, OPTIONS, POST, etc). |
| ResponseHeader | String | The list of HTTP headers other than the simple response headers to give permission for the user-agent to share across domains. |
| MaxAgeSeconds | Integer | The value, in seconds, to return in the Access-Control-Max-Age header used in preflight responses. |
| Bucket | String | Name of the bucket. |
Returns information about lifecycle of a specific bucket.
The Cloud will use the Google Cloud Storage API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
For example, the following queries are processed server side:
SELECT * FROM BucketLifecycle WHERE Bucket = 'TestBucket'
| Name | Type | Description |
| ActionType | String | Type of the action. Currently, Delete and SetStorageClass are supported. |
| ActionStorageClass | String | The new storage class when action.type is SetStorageClass. See lifecycle actions for a table of supported storage class transitions. |
| Age | Integer | Age of an object (in days). This condition is satisfied when an object reaches the specified age. |
| CreatedBefore | Date | A date in RFC 3339 format with only the date part. |
| IsLive | Boolean | Relevant only for versioned objects. If the value is true, this condition matches the live version of objects; if the value is false, it matches noncurrent versions of objects. |
| MatchesStorageClass | String | Objects having any of the storage classes specified by this condition will be matched. Values include STANDARD, NEARLINE, COLDLINE, ARCHIVE, MULTI_REGIONAL, REGIONAL, and DURABLE_REDUCED_AVAILABILITY. |
| NumberOfNewerVersions | Integer | Relevant only for versioned objects. If the value is N, this condition is satisfied when there are at least N versions (including the live version) newer than this version of the object. |
| CustomTimeBefore | Date | A date in the RFC 3339 format YYYY-MM-DD. This condition is satisfied when the customTime metadata for the object is set to an earlier date than the date used in this lifecycle condition. |
| NoncurrentTimeBefore | Date | Relevant only for versioned objects. A date in the RFC 3339 format YYYY-MM-DD. This condition is satisfied for objects that became noncurrent on a date prior to the one specified in this condition. |
| DaysSinceNoncurrentTime | Integer | Relevant only for versioned objects. This condition is satisfied when an object has been noncurrent for more than the specified number of days. |
| DaysSinceCustomTime | Integer | Days since the date set in the customTime metadata for the object. This condition is satisfied when the current date and time is at least the specified number of days after the customTime. |
| Bucket | String | Name of the bucket. |
Returns information for buckets. Buckets are used to store objects, which consist of data and its metadata.
The Cloud will use the Google Cloud Storage API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
For example, the following queries are processed server side:
SELECT * FROM Buckets WHERE Name = 'TestBucket'
| Name | Type | Description |
| Id [KEY] | String | The ID of the bucket. For buckets, the id and name properties are the same. |
| Name | String | The name of the bucket. |
| ProjectNumber | String | The project number of the project the bucket belongs to. |
| MetaGeneration | String | The metadata generation of this bucket. |
| Location | String | The location of the bucket. Object data for objects in the bucket resides in physical storage within this region. |
| StorageClass | String | The bucket's default storage class, used whenever no storageClass is specified for a newly-created object. |
| ETag | String | HTTP 1.1 Entity tag for the bucket. |
| DefaultEventBasedHold | Boolean | Whether or not to automatically apply an eventBasedHold to new objects added to the bucket. |
| TimeCreated | Datetime | The creation time of the bucket in RFC 3339 format. |
| Updated | Datetime | The modification time of the bucket in RFC 3339 format. |
| BucketPolicyOnlyEnabled | Boolean | Whether or not the bucket uses uniform bucket-level access. If set, access checks only use bucket-level IAM policies or above. |
| UniformBucketLevelAccessEnabled | String | Whether or not the bucket uses uniform bucket-level access. If set, access checks only use bucket-level IAM policies or above. |
| LocationType | String | The type of location that the bucket resides in, as determined by the location property. |
| RetentionPolicyPeriod | String | The period of time, in seconds, that objects in the bucket must be retained and cannot be deleted, overwritten, or made noncurrent. The value must be greater than 0 seconds and less than 3,155,760,000 seconds. |
| RetentionPolicyEffectiveTime | Datetime | The time from which the retentionPolicy was effective, in RFC 3339 format. |
| RetentionPolicyIsLocked | Boolean | Whether or not the retentionPolicy is locked. If true, the retentionPolicy cannot be removed and the retention period cannot be reduced. |
| EncryptionDefaultKmsKeyName | String | A Cloud KMS key that will be used to encrypt objects inserted into this bucket, if no encryption method is specified. |
| OwnerEntity | String | The entity, in the form project-owner-projectId. |
| OwnerEntityId | String | The ID for the entity. |
| WebsiteMainPageSuffix | String | If the requested object path is missing, the service will ensure the path has a trailing '/', append this suffix, and attempt to retrieve the resulting object. This allows the creation of index.html objects to represent directory pages. |
| WebsiteNotFoundPage | String | If the requested object path is missing, and any mainPageSuffix object is missing, if applicable, the service will return the named object from this bucket as the content for a 404 Not Found result. |
| LogBucket | String | The destination bucket where the current bucket's logs should be placed. |
| LogObjectPrefix | String | A prefix for log object names. The default prefix is the bucket name. |
| VersioningEnabled | Boolean | While set to true, versioning is fully enabled for this bucket. |
| BillingRequesterPays | Boolean | When set to true, Requester Pays is enabled for this bucket. |
Returns information for ACLs of a specific object.
The Cloud will use the Google Cloud Storage API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
For example, the following queries are processed server side:
SELECT * FROM ObjectACLs WHERE Object = 'TestObject' SELECT * FROM ObjectACLs WHERE Bucket = 'TestBucket' SELECT * FROM ObjectACLs WHERE Object = 'TestObject' AND Bucket = 'TestBucket'
| Name | Type | Description |
| Id [KEY] | String | The ID of the access-control entry. |
| Entity | String | The entity holding the permission. |
| Role | String | The access permission for the entity. |
| String | The email address associated with the entity, if any. | |
| EntityId | String | The ID for the entity, if any. |
| Domain | String | The domain associated with the entity, if any. |
| ProjectTeamNumber | String | The project number. |
| ProjectTeamType | String | The team type. |
| ETag | String | HTTP 1.1 Entity tag for the access-control entry. |
| Bucket | String | The name of the bucket. |
| Object | String | The name of the object. |
Returns information for objects inside a specific bucket.
The Cloud will use the Google Cloud Storage API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
For example, the following queries are processed server side:
SELECT * FROM Objects WHERE Name = 'TestObject' SELECT * FROM Objects WHERE Bucket = 'TestBucket' SELECT * FROM Objects WHERE Name LIKE 'Test%' AND Bucket = 'TestBucket'
| Name | Type | Description |
| Id [KEY] | String | The ID of the object, including the bucket name, object name, and generation number. |
| Name | String | The name of the object. Required if not specified by URL parameter. |
| Bucket | String | The name of the bucket containing this object. |
| Generation | String | The content generation of this object. Used for object versioning. |
| MetaGeneration | String | The version of the metadata for this object at this generation. Used for preconditions and for detecting changes in metadata. A metageneration number is only meaningful in the context of a particular generation of a particular object. |
| ContentType | String | Content-Type of the object data. If an object is stored without a Content-Type, it is served as application/octet-stream. |
| TimeCreated | Datetime | The creation time of the object in RFC 3339 format. |
| Updated | Datetime | The modification time of the object metadata in RFC 3339 format. |
| TimeDeleted | Datetime | The deletion time of the object in RFC 3339 format. Returned if and only if this version of the object is no longer a live version, but remains in the bucket as a noncurrent version. |
| TemporaryHold | Boolean | Whether or not the object is subject to a temporary hold. |
| EventBasedHold | Boolean | Whether or not the object is subject to an event-based hold. |
| RetentionExpirationTime | Datetime | The earliest time that the object can be deleted, based on a bucket's retention policy, in RFC 3339 format. |
| StorageClass | String | Storage class of the object. |
| TimeStorageClassUpdated | Datetime | The time at which the object's storage class was last changed. When the object is initially created, it will be set to timeCreated. |
| Size | String | Content-Length of the data in bytes. |
| Md5Hash | String | MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see Hashes and ETags: Best Practices. |
| MediaLink | String | Media download link. |
| ContentEncoding | String | Content-Encoding of the object data. |
| ContentDisposition | String | Content-Disposition of the object data. |
| ContentLanguage | String | Content-Language of the object data. |
| CacheControl | String | Cache-Control directive for the object data. If omitted, and the object is accessible to all anonymous users, the default will be public, max-age=3600. |
| OwnerEntity | String | The entity, in the form user-emailAddress. |
| OwnerEntityId | String | The ID for the entity. |
| Crc32c | String | CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order. For more information about using the CRC32c checksum, see Hashes and ETags: Best Practices. |
| ComponentCount | Integer | Number of underlying components that make up a composite object. Components are accumulated by compose operations, counting 1 for each non-composite source object and componentCount for each composite source object. Note: componentCount is included in the metadata for composite objects only. |
| Etag | String | HTTP 1.1 Entity tag for the object. |
| CustomerEncryptionAlgorithm | String | The encryption algorithm. |
| CustomerEncryptionKeySha256 | String | SHA256 hash value of the encryption key. |
| KmsKeyName | String | Cloud KMS Key used to encrypt this object, if the object is encrypted by such a key. |
| CustomTime | Datetime | CA user-specified timestamp for the object in RFC 3339 format. |
Returns information for object versions inside a specific bucket.
The Cloud will use the Google Cloud Storage API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
For example, the following queries are processed server side:
SELECT * FROM ObjectVersions WHERE Name = 'TestName' SELECT * FROM ObjectVersions WHERE Bucket = 'TestBucket'
| Name | Type | Description |
| Id | String | The ID of the object, including the bucket name, object name, and generation number. |
| Name [KEY] | String | The name of the object. Required if not specified by URL parameter. |
| Bucket | String | The name of the bucket containing this object. |
| Generation | String | The content generation of this object. Used for object versioning. |
| MetaGeneration | String | The version of the metadata for this object at this generation. Used for preconditions and for detecting changes in metadata. A metageneration number is only meaningful in the context of a particular generation of a particular object. |
| ContentType | String | Content-Type of the object data. If an object is stored without a Content-Type, it is served as application/octet-stream. |
| TimeCreated | Datetime | The creation time of the object in RFC 3339 format. |
| Updated | Datetime | The modification time of the object metadata in RFC 3339 format. |
| TimeDeleted | Datetime | The deletion time of the object in RFC 3339 format. Returned if and only if this version of the object is no longer a live version, but remains in the bucket as a noncurrent version. |
| TemporaryHold | Boolean | Whether or not the object is subject to a temporary hold. |
| EventBasedHold | Boolean | Whether or not the object is subject to an event-based hold. |
| RetentionExpirationTime | Datetime | The earliest time that the object can be deleted, based on a bucket's retention policy, in RFC 3339 format. |
| StorageClass | String | Storage class of the object. |
| TimeStorageClassUpdated | Datetime | The time at which the object's storage class was last changed. When the object is initially created, it will be set to timeCreated. |
| Size | String | Content-Length of the data in bytes. |
| Md5Hash | String | MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see Hashes and ETags: Best Practices. |
| MediaLink | String | Media download link. |
| ContentEncoding | String | Content-Encoding of the object data. |
| ContentDisposition | String | Content-Disposition of the object data. |
| ContentLanguage | String | Content-Language of the object data. |
| CacheControl | String | Cache-Control directive for the object data. If omitted, and the object is accessible to all anonymous users, the default will be public, max-age=3600. |
| OwnerEntity | String | The entity, in the form user-emailAddress. |
| OwnerEntityId | String | The ID for the entity. |
| Crc32c | String | CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order. For more information about using the CRC32c checksum, see Hashes and ETags: Best Practices. |
| ComponentCount | Integer | Number of underlying components that make up a composite object. Components are accumulated by compose operations, counting 1 for each non-composite source object and componentCount for each composite source object. Note: componentCount is included in the metadata for composite objects only. |
| Etag | String | HTTP 1.1 Entity tag for the object. |
| CustomerEncryptionAlgorithm | String | The encryption algorithm. |
| CustomerEncryptionKeySha256 | String | SHA256 hash value of the encryption key. |
| KmsKeyName | String | Cloud KMS Key used to encrypt this object, if the object is encrypted by such a key. |
| CustomTime | Datetime | CA user-specified timestamp for the object in RFC 3339 format. |
Stored procedures are function-like interfaces that extend the functionality of the Cloud beyond simple SELECT operations with Google Cloud Storage.
Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Google Cloud Storage, along with an indication of whether the procedure succeeded or failed.
| Name | Description |
| CopyObject | Copies an object from one bucket to another. |
| CreateBucket | Creates a bucket. The authenticated user must have the storage.buckets.create IAM permission to use this StoredProcedure. |
| DeleteObject | Deletes an object from a bucket. |
| EnableVersioning | Enables object versioning in a specific bucket. |
| MoveObject | Moves an object from one bucket to another. |
| SignBlob | Create a signature from a string-to-sign or policy document. Requires one of the following OAuth scopes: https://www.googleapis.com/auth/iam or https://www.googleapis.com/auth/cloud-platform |
| SignURL | Uploads objects in a single operation. Use the SimpleUploadLimit connection property to adjust the threshold in bytes in order to perform a multipart upload. |
Copies an object from one bucket to another.
| Name | Type | Required | Description |
| BucketSource | String | True | Bucket name where the object to be copied is located. |
| ObjectSource | String | True | Object name of the object that will be copied. |
| BucketDestination | String | True | Bucket name where the object will be copied to. |
| ObjectDestination | String | False | New name of the object in the new bucket. If not specified, the name will be the same. |
| Name | Type | Description |
| Success | String | Indicator if the stored procedure was successful or not. |
Creates a bucket. The authenticated user must have the storage.buckets.create IAM permission to use this StoredProcedure.
| Name | Type | Required | Description |
| Name | String | True | The name of the new bucket |
| PredefinedAcl | String | False | Apply a predefined set of access controls to this bucket.
The allowed values are authenticatedRead, private, projectPrivate, publicRead, publicReadWrite. |
| PredefinedDefaultObjectAcl | String | False | Apply a predefined set of default object access controls to this bucket.
The allowed values are authenticatedRead, bucketOwnerFullControl, bucketOwnerRead, private, projectPrivate, publicRead. |
| Name | Type | Description |
| Success | String | Indicator if the stored procedure was successful or not. |
| Id | String | The id of the created bucket. |
Deletes an object from a bucket.
| Name | Type | Required | Description |
| BucketSource | String | True | Bucket name where the object to be deleted is located. |
| ObjectSource | String | True | Object name of the object that will be deleted. |
| Generation | Long | False | If present, permanently deletes a specific revision of this object (as opposed to the latest version, the default). |
| IfGenerationMatch | Long | False | Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object. |
| IfGenerationNotMatch | Long | False | Makes the operation conditional on whether the object's current generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object. |
| IfMetagenerationMatch | Long | False | Makes the operation conditional on whether the object's current metageneration matches the given value. |
| IfMetagenerationNotMatch | Long | False | Makes the operation conditional on whether the object's current metageneration does not match the given value. |
| Name | Type | Description |
| Success | String | Indicator if the stored procedure was successful or not. |
Enables object versioning in a specific bucket.
| Name | Type | Required | Description |
| Bucket | String | True | Bucket name where the versioning will be enabled. |
| Name | Type | Description |
| Success | String | Indicator if the stored procedure was successful or not. |
Moves an object from one bucket to another.
| Name | Type | Required | Description |
| BucketSource | String | True | Bucket name where the object to be moved is located. |
| ObjectSource | String | True | Object name of the object that will be moved. |
| BucketDestination | String | True | Bucket name where the object will be moved to. |
| ObjectDestination | String | False | New name of the object in the new bucket. If not specified, the name will be the same. |
| Name | Type | Description |
| Success | String | Indicator if the stored procedure was successful or not. |
Create a signature from a string-to-sign or policy document. Requires one of the following OAuth scopes: https://www.googleapis.com/auth/iam or https://www.googleapis.com/auth/cloud-platform
| Name | Type | Required | Description |
| RequestInformation | String | True | Is a string-to-sign or a policy document. The data can be in raw format or base64 encoded. |
| ServiceAccountEmail | String | True | The email address or the unique id of the service account you want to use to create the signature. |
| Delegates | String | False | The sequence of service accounts separated by a comma in a delegation chain. |
| Name | Type | Description |
| Success | String | Indicator if the stored procedure was successful or not. |
| KeyId | String | The ID of the key used to sign the blob. |
| SignedBlob | String | The signature for the blob. Does not include the original blob. A base64-encoded string. |
Uploads objects in a single operation. Use the SimpleUploadLimit connection property to adjust the threshold in bytes in order to perform a multipart upload.
Note: You will need the following IAM roles to leverage this stored procedure:
| Name | Type | Required | Description |
| Bucket | String | True | The bucket name where the object resides. |
| Object | String | True | The name of the object to generate the SignedURL for. |
| RequestMethod | String | False | The method that the signed request will use.
The default value is GET. |
| Location | String | False | Location of the specified bucket.
The default value is auto. |
| ActiveDateTime | String | False | The dateTime when the SignedURL will become active. If not specified the current dateTime will be used. |
| Query | String | False | The query string that must be included when using the SignedURL,if not specified no query string will be used. |
| CustomHeaders | String | False | A comma separated list of name=value of the headers to use with the SignedURL, if not specified not custom headers will be used. |
| ExpiresIn | String | True | The expiration time for the SignedURL it should be in the format: 1d2h3m4s, the maximum value is 7d0h0m0s |
| HmacAccessKey | String | False | The Hmac access key. |
| HmacSecret | String | False | The Hmac secret. |
| Cert | String | False | The certificate in JSON or P12 format used for RSA signature. |
| Authorizer | String | False | The authorizer of the certificate in P12 format or private key generated from the service account for RSA signature. |
| CertPassword | String | False | The password for accessing the certificate that stores the private key when it requires a password for RSA signature. If a password is not required, leave this property blank. |
| Subject | String | False | The user subject for which the application is requesting delegated access to use for RSA signature. |
| PrivateKey | String | False | The private key generated from the service account. |
| Name | Type | Description |
| Success | String | Indicator if the stored procedure was successful or not. |
| SignedURL | String | Returns a signedUrl which can be used to download the resource. |
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 Cloud Storage:
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:
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 Buckets table:
SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Buckets'
| 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. |
| ColumnType | String | The role or classification of the column in the schema. Possible values include SYSTEM, LINKEDCOLUMN, NAVIGATIONKEY, REFERENCECOLUMN, and NAVIGATIONPARENTCOLUMN. |
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 DownloadObject stored procedure:
SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'DownloadObject' AND Direction = 1 OR Direction = 2
To include result set columns in addition to the parameters, set the IncludeResultColumns pseudo column to True:
SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'DownloadObject' AND IncludeResultColumns='True'
| 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. |
| DataType | Int32 | An integer indicating the data type. This value is determined at run time based on the environment. |
| DataTypeName | String | The name of the data type. |
| NumericPrecision | Int32 | The maximum precision for numeric data. The column length in characters for character and date-time data. |
| Length | Int32 | The number of characters allowed for character data. The number of digits allowed for numeric 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. |
| Values | String | The values you can set in this parameter are limited to those shown in this column. Possible values are comma-separated. |
| SupportsStreams | Boolean | Whether the parameter represents a file that you can pass as either a file path or a stream. |
| IsPath | Boolean | Whether the parameter is a target path for a schema creation operation. |
| Default | String | The value used for this parameter when no value is specified. |
| SpecificName | String | A label that, when multiple stored procedures have the same name, uniquely identifies each identically-named stored procedure. If there's only one procedure with a given name, its name is simply reflected here. |
| IsCDataProvided | Boolean | Whether the procedure is added/implemented by CData, as opposed to being a native Google Cloud Storage procedure. |
| Name | Type | Description |
| IncludeResultColumns | Boolean | Whether the output should include columns from the result set in addition to parameters. Defaults to False. |
Describes the primary and foreign keys.
The following query retrieves the primary key for the Buckets table:
SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Buckets'
| 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.
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 Data Model 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. |
Describes the available system information.
The following query retrieves all columns:
SELECT * FROM sys_information
| Name | Type | Description |
| Product | String | The name of the product. |
| Version | String | The version number of the product. |
| Datasource | String | The name of the datasource the product connects to. |
| NodeId | String | The unique identifier of the machine where the product is installed. |
| HelpURL | String | The URL to the product's help documentation. |
| License | String | The license information for the product. (If this information is not available, the field may be left blank or marked as 'N/A'.) |
| Location | String | The file path location where the product's library is stored. |
| Environment | String | The version of the environment or rumtine the product is currently running under. |
| DataSyncVersion | String | The tier of CData Sync required to use this connector. |
| DataSyncCategory | String | The category of CData Sync functionality (e.g., Source, Destination). |
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 | Specifies the authentication method used to connect to Google Cloud Storage. |
| ProjectId | The Id of the project where your Google Cloud Storage instance resides. |
| Property | Description |
| DelegatedServiceAccounts | Specifies a space-delimited list of service account emails for delegated requests. |
| RequestingServiceAccount | Specifies a service account email to make a delegated request. |
| Scope | Specifies the scope of the authenticating user's access to the application, to ensure they get appropriate access to data. If a custom OAuth application is needed, this is generally specified at the time the application is created. |
| Property | Description |
| SSLServerCert | Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
| Property | Description |
| Verbosity | Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5. |
| Property | Description |
| BrowsableSchemas | Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC . |
| Property | Description |
| AWSWorkloadIdentityConfig | Configuration properties to provide when using Workload Identity Federation via AWS. |
| AzureWorkloadIdentityConfig | Configuration properties to provide when using Workload Identity Federation via Azure. |
| MaxRows | Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY. |
| PseudoColumns | Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'. |
| SimpleUploadLimit | This setting specifies the threshold, in bytes, above which the provider will choose to perform a multipart upload rather than uploading everything in one request. |
| ThrowsKeyNotFound | Specifies whether or not throws an exception if there is no rows updated. |
| Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. |
| WorkloadPoolId | The ID of your Workload Identity Federation pool. |
| WorkloadProjectId | The ID of the Google Cloud project that hosts your Workload Identity Federation pool. |
| WorkloadProviderId | The ID of your Workload Identity Federation pool provider. |
This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.
| Property | Description |
| AuthScheme | Specifies the authentication method used to connect to Google Cloud Storage. |
| ProjectId | The Id of the project where your Google Cloud Storage instance resides. |
Specifies the authentication method used to connect to Google Cloud Storage.
string
"OAuth"
The Id of the project where your Google Cloud Storage instance resides.
string
""
The Id of the project where your Google Cloud Storage instance resides. You can find this value by going to Google Cloud Console and clicking the project name at the top left screen. The ProjectId is displayed on the Id column of the matching project.
This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.
| Property | Description |
| DelegatedServiceAccounts | Specifies a space-delimited list of service account emails for delegated requests. |
| RequestingServiceAccount | Specifies a service account email to make a delegated request. |
| Scope | Specifies the scope of the authenticating user's access to the application, to ensure they get appropriate access to data. If a custom OAuth application is needed, this is generally specified at the time the application is created. |
Specifies a space-delimited list of service account emails for delegated requests.
string
""
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.
Specifies a service account email to make a delegated request.
string
""
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.
Specifies the scope of the authenticating user's access to the application, to ensure they get appropriate access to data. If a custom OAuth application is needed, this is generally specified at the time the application is created.
string
""
Scopes are set to define what kind of access the authenticating user will have; for example, read, read and write, restricted access to sensitive information. System administrators can use scopes to selectively enable access by functionality or security clearance.
When InitiateOAuth is set to GETANDREFRESH, you must use this property if you want to change which scopes are requested.
When InitiateOAuth is set to either REFRESH or OFF, you can change which scopes are requested using either this property or the Scope input.
This section provides a complete list of the SSL properties you can configure in the connection string for this provider.
| Property | Description |
| SSLServerCert | Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
Specifies the certificate to be accepted from the server when connecting using TLS/SSL.
string
""
If you are using a TLS/SSL connection, use this property to specify the TLS/SSL certificate to be accepted from the server. If you specify a value for this property, all other certificates that are not trusted by the machine are 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 |
Note: It is possible to use '*' to signify that all certificates should be accepted, but due to security concerns this is not recommended.
This section provides a complete list of the Logging properties you can configure in the connection string for this provider.
| Property | Description |
| Verbosity | Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5. |
Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.
string
"1"
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.
| Property | Description |
| BrowsableSchemas | Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC . |
Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
string
""
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.
This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.
| Property | Description |
| AWSWorkloadIdentityConfig | Configuration properties to provide when using Workload Identity Federation via AWS. |
| AzureWorkloadIdentityConfig | Configuration properties to provide when using Workload Identity Federation via Azure. |
| MaxRows | Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY. |
| PseudoColumns | Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'. |
| SimpleUploadLimit | This setting specifies the threshold, in bytes, above which the provider will choose to perform a multipart upload rather than uploading everything in one request. |
| ThrowsKeyNotFound | Specifies whether or not throws an exception if there is no rows updated. |
| Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. |
| WorkloadPoolId | The ID of your Workload Identity Federation pool. |
| WorkloadProjectId | The ID of the Google Cloud project that hosts your Workload Identity Federation pool. |
| WorkloadProviderId | The ID of your Workload Identity Federation pool provider. |
Configuration properties to provide when using Workload Identity Federation via AWS.
string
""
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="AuthScheme=AwsRootKeys;AccessKey='AKIAABCDEF123456';SecretKey=...;Region=us-east-1"
Configuration properties to provide when using Workload Identity Federation via Azure.
string
""
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 Azure using client credentials:
AzureWorkloadIdentityConfig="AuthScheme=AzureServicePrincipal;AzureTenant=directory (tenant) id;OAuthClientID=application (client) id;OAuthClientSecret=client secret;AzureResource=application id uri;"
Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
int
-1
The default value for this property, -1, means that no row limit is enforced unless the query explicitly includes a LIMIT clause. (When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting.)
Setting MaxRows to a whole number greater than 0 ensures that queries do not return excessively large result sets by default.
This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.
Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
string
""
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:
*=*
This setting specifies the threshold, in bytes, above which the provider will choose to perform a multipart upload rather than uploading everything in one request.
string
"5242880"
Default value is 5242880 bytes. Minimum value for this property is 262144 bytes.
Specifies whether or not throws an exception if there is no rows updated.
bool
false
Specifies whether or not throws an exception if there is no rows updated.
Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
int
60
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.
Timeout is set to 60 seconds by default. To disable timeouts, set this property to 0.
Disabling the timeout allows 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.
Note: Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.
The ID of your Workload Identity Federation pool.
string
""
The ID of your Workload Identity Federation pool.
The ID of the Google Cloud project that hosts your Workload Identity Federation pool.
string
""
The ID of the Google Cloud project that hosts your Workload Identity Federation pool.
The ID of your Workload Identity Federation pool provider.
string
""
The ID of your Workload Identity Federation pool provider.
LZMA from 7Zip LZMA SDK
LZMA SDK is placed in the public domain.
Anyone is free to copy, modify, publish, use, compile, sell, or distribute the original LZMA SDK code, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.
LZMA2 from XZ SDK
Version 1.9 and older are in the public domain.
Xamarin.Forms
Xamarin SDK
The MIT License (MIT)
Copyright (c) .NET Foundation Contributors
All rights reserved.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
NSIS 3.10
Copyright (C) 1999-2025 Contributors THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS COMMON PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
1. DEFINITIONS
"Contribution" means:
a) in the case of the initial Contributor, the initial code and documentation distributed under this Agreement, and b) in the case of each subsequent Contributor:
i) changes to the Program, and
ii) additions to the Program;
where such changes and/or additions to the Program originate from and are distributed by that particular Contributor. A Contribution 'originates' from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include additions to the Program which: (i) are separate modules of software distributed in conjunction with the Program under their own license agreement, and (ii) are not derivative works of the Program.
"Contributor" means any person or entity that distributes the Program.
"Licensed Patents " mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program.
"Program" means the Contributions distributed in accordance with this Agreement.
"Recipient" means anyone who receives the Program under this Agreement, including all Contributors.
2. GRANT OF RIGHTS
a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, distribute and sublicense the Contribution of such Contributor, if any, and such derivative works, in source code and object code form.
b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in source code and object code form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder.
c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program.
d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement.
3. REQUIREMENTS
A Contributor may choose to distribute the Program in object code form under its own license agreement, provided that:
a) it complies with the terms and conditions of this Agreement; and
b) its license agreement:
i) effectively disclaims on behalf of all Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose;
ii) effectively excludes on behalf of all Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits;
iii) states that any provisions which differ from this Agreement are offered by that Contributor alone and not by any other party; and
iv) states that source code for the Program is available from such Contributor, and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange.
When the Program is made available in source code form:
a) it must be made available under this Agreement; and
b) a copy of this Agreement must be included with each copy of the Program.
Contributors may not remove or alter any copyright notices contained within the Program.
Each Contributor must identify itself as the originator of its Contribution, if any, in a manner that reasonably allows subsequent Recipients to identify the originator of the Contribution.
4. COMMERCIAL DISTRIBUTION
Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense.
For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages.
5. NO WARRANTY
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations.
6. DISCLAIMER OF LIABILITY
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
7. GENERAL
If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.
If Recipient institutes patent litigation against a Contributor with respect to a patent applicable to software (including a cross-claim or counterclaim in a lawsuit), then any patent licenses granted by that Contributor to such Recipient under this Agreement shall terminate as of the date such litigation is filed. In addition, if Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed.
All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive.
Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. IBM is the initial Agreement Steward. IBM may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to distribute the Program (including its Contributions) under the new version. Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved.
This Agreement is governed by the laws of the State of New York and the intellectual property laws of the United States of America. No party to this Agreement will bring a legal action under this Agreement more than one year after the cause of action arose. Each party waives its rights to a jury trial in any resulting litigation.