Cloud

Build 26.0.9770
  • Google Cloud Storage
    • Getting Started
      • Establishing a Connection
      • Creating a Custom OAuth App
      • SSL Configuration
      • Firewall and Proxy
    • Data Model
      • Information Schema
        • Tables
          • AllManagedFolders
          • AllObjects
          • AllObjectVersions
        • Views
          • AllObjectACLs
          • BucketACLs
          • BucketCORS
          • BucketLifecycle
          • Buckets
        • Stored Procedures
          • CopyObject
          • CreateBucket
          • CreateManagedFolder
          • DeleteManagedFolder
          • DeleteObject
          • DownloadObject
          • EnableVersioning
          • MoveObject
          • SignBlob
          • SignURL
          • UpdateBucket
          • UploadObject
      • Bucket Schema
        • Tables
          • ManagedFolders
          • Objects
          • ObjectVersions
        • Views
          • ObjectACLs
      • System Tables
        • sys_catalogs
        • sys_schemas
        • sys_tables
        • sys_tablecolumns
        • sys_procedures
        • sys_procedureparameters
        • sys_keycolumns
        • sys_foreignkeys
        • sys_primarykeys
        • sys_indexes
        • sys_connection_props
        • sys_sqlinfo
        • sys_identity
        • sys_information
    • Connection String Options
      • Authentication
        • AuthScheme
        • ProjectId
      • Connection
        • Buckets
      • OAuth
        • OAuthClientId
        • OAuthClientSecret
        • DelegatedServiceAccounts
        • RequestingServiceAccount
        • Scope
      • JWT OAuth
        • OAuthJWTCert
        • OAuthJWTCertType
        • OAuthJWTCertPassword
        • OAuthJWTCertSubject
        • OAuthJWTIssuer
        • OAuthJWTSubject
      • SSL
        • SSLServerCert
      • Logging
        • Verbosity
      • Schema
        • BrowsableSchemas
      • Miscellaneous
        • AffectedRowsTimeout
        • AWSWorkloadIdentityConfig
        • AzureWorkloadIdentityConfig
        • MaxRows
        • PseudoColumns
        • SimpleUploadLimit
        • ThrowsKeyNotFound
        • Timeout
        • WorkloadPoolId
        • WorkloadProjectId
        • WorkloadProviderId
    • Third Party Copyrights

Google Cloud Storage - CData Cloud

Overview

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.

Key Features

  • Full SQL Support: Google Cloud Storage appears as standard relational databases, allowing you to perform operations - Filter, Group, Join, etc. - using standard SQL, regardless of whether these operations are supported by the underlying API.
  • CRUD Support: Both read and write operations are supported, restricted only by security settings that you can configure in Cloud or downstream in the source itself.
  • Secure Access: The administrator can create users and define their access to specific databases and read-only operations or grant full read & write privileges.
  • Comprehensive Data Model & Dynamic Discovery: CData Cloud provides comprehensive access to all of the data exposed in the underlying data source, including full access to dynamic data and easily searchable metadata.

CData Cloud

Getting Started

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.

Connecting to Google Cloud Storage

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

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.

CData Cloud

Establishing a Connection

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.

Connecting to Google Cloud Storage

Provide the following connection property before setting the authentication properties.

  • ProjectId: The Id of the project you want to connect to.

Authenticating to Google Cloud Storage

The Cloud supports using user accounts and GCP instance accounts for authentication.

The following sections discuss the available authentication schemes for Google Cloud Storage:

  • User Accounts (OAuth)
  • Service Accounts (OAuthJWT)
  • GCP Instance Accounts

User Accounts (OAuth)

AuthScheme must be set to OAuth in all user account flows.

Web Applications

When connecting via a web application, you must create and register a custom OAuth application with Google Cloud Storage. You can then use the Cloud to acquire and manage the OAuth token values. See Creating a Custom OAuth App for more information about custom applications.

Get an OAuth Access Token

Set the following connection properties to obtain the OAuthAccessToken:

  • OAuthClientId: The client Id in your application settings.
  • OAuthClientSecret: The client secret in your application settings.

Then call the following stored procedures to complete the OAuth exchange:

  1. Call the GetOAuthAuthorizationURL stored procedure. Set the CallbackURL input to the callback URL you specified in your application settings. The stored procedure returns the URL to the OAuth endpoint.
  2. Navigate to the URL that the stored procedure returned in Step 1. Log in to the custom OAuth application and authorize the web application. Once authenticated, the browser redirects you to the callback URL.
  3. Call the GetOAuthAccessToken stored procedure. Set AuthMode to WEB and the Verifier input to the "code" parameter in the query string of the callback URL.

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 Cloud automatically refresh the OAuth access token, set the following on the first data connection:

  • 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.
  • OAuthRefreshToken: The refresh token returned by GetOAuthAccessToken.
  • OAuthSettingsLocation: The location where the Cloud saves the OAuth token values, which persist across connections.
On subsequent data connections, the values for OAuthAccessToken and OAuthRefreshToken are taken from OAuthSettingsLocation.

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:

  • OAuthClientId: The client Id in your application settings.
  • OAuthClientSecret: The client secret in your application settings.

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.

Headless Machines

To configure the Cloud to use OAuth with a user account on a headless machine, you must authenticate on another device that has an internet browser.

  1. Choose one of two options:
    • Option 1: Obtain the OAuthVerifier value as described in "Obtain and Exchange a Verifier Code" below.
    • Option 2: Install the Cloud on a machine with an internet browser and transfer the OAuth authentication values after you authenticate through the usual browser-based flow, as described in "Transfer OAuth Settings" below.
  2. Then configure the Cloud to automatically refresh the access token on the headless machine.

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.

  1. Choose one of these options:
    • If you are using the Embedded OAuth Application click Google Cloud Storage OAuth endpoint to open the endpoint in your browser.
    • If you are using a custom OAuth application, create the Authorization URL by setting the following properties:
      • InitiateOAuth: OFF.
      • OAuthClientId: The client Id assigned when you registered your application.
      • OAuthClientSecret: The client secret assigned when you registered your application.
      Then call the GetOAuthAuthorizationURL stored procedure with the appropriate callback URL. Open the URL returned by the stored procedure in a browser.
  2. Log in and grant permissions to the Cloud. You are then redirected to the callback URL, which contains the verifier code.
  3. Save the value of the verifier code. Later you will set this in the OAuthVerifier connection property.
Next, you must exchange the OAuth verifier code for OAuth refresh and access tokens. Set the following properties:

On the headless machine, set the following connection properties to obtain the OAuth authentication values:

  • InitiateOAuth: REFRESH.
  • OAuthVerifier: The verifier code.
  • OAuthClientId (custom applications only): The client Id in your custom OAuth application settings.
  • OAuthClientSecret (custom applications only): The client secret in the custom OAuth application settings.
  • OAuthSettingsLocation: Set this to persist the encrypted OAuth authentication values to the specified location.

After the OAuth settings file is generated, you must re-set the following properties to connect:

  • InitiateOAuth: REFRESH.
  • OAuthClientId (custom applications only): The client Id assigned when you registered your application.
  • OAuthClientSecret (custom applications only): The client secret assigned when you registered your application.
  • OAuthSettingsLocation: The location containing the encrypted OAuth authentication values. Make sure this location gives read and write permissions to the Cloud to enable the automatic refreshing of the access token.

Option 2: Transfer OAuth Settings

Prior to connecting on a headless machine, you must create and install a connection with the Cloud 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:

  • InitiateOAuth: REFRESH.
  • OAuthClientId (custom applications only): The client Id assigned when you registered your application.
  • OAuthClientSecret (custom applications only): The client secret assigned when you registered your application.
  • OAuthSettingsLocation: The location of your OAuth settings file. Make sure this location gives read and write permissions to the Cloud to enable the automatic refreshing of the access token.

GCP Instance Accounts

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.

CData Cloud

Creating a Custom OAuth App

Creating a Custom OAuth Application

CData embeds OAuth Application Credentials with CData branding that can be used when connecting to Google Cloud Storage via a desktop application or a headless machine.

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

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

The following sections describe how to enable the Directory API and create custom OAuth applications for user accounts (OAuth) and Service Accounts (OAuth/JWT).

Enable the Cloud Storage API

Follow these steps to enable the Cloud Storage API:

  1. Navigate to the Google Cloud Console.
  2. Select Library from the left-hand navigation menu. This opens the Library page.
  3. In the search field, enter "Cloud Storage API" and select Cloud Storage API from the search results.
  4. On the Cloud Storage API page, ENABLE both APIs.

Create an OAuth Application

To create custom OAuth applications that retrieve the necessary OAuth connection properties, follow these procedures.

User Accounts (OAuth)

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:

  1. Navigate to the Google Cloud Console.
  2. Create a new project or select an existing project.
  3. At the left-hand navigation menu, select Credentials.
  4. If this project does not already have a consent screen configured, click CONFIGURE CONSENT SCREEN to create one. 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 info is optional.
  5. On the Credentials page, select Create Credentials > OAuth Client ID.
  6. In the Application Type menu, select Web application.
  7. Specify a name for your custom OAuth application.
  8. Under Authorized redirect URIs, click ADD URI and enter a redirect URI.
  9. Click Enter, then CREATE. The Cloud Console returns you to the Credentials page.
    A window opens that displays your client Id and client secret.
  10. Record the client Id and Client Secret for later use as the OAuthClientId and OAuthClientSecret connection properties.

Note: The client secret remains accessible from from the Google Cloud Console.

Service Accounts (OAuthJWT)

Service accounts (AuthScheme OAuthJWT) can be used in an OAuth flow to access Google APIs on behalf of users in a domain. A domain administrator can delegate domain-wide access to the service account.

To create a new service account:

  1. Navigate to the Google Cloud Console.
  2. Create a new project or select an existing project.
  3. At the left-hand navigation menu, select Credentials.
  4. Select Create Credentials > Service account.
  5. On the Create service account page, enter the service account name, ID, and an optional description.
  6. Click DONE. The Cloud Console redisplays the Credentials page.
  7. In the Service Accounts section, select the service account you just created.
  8. Click the Advanced Settings section and enable Domain-Wide Delegation.
  9. Record the Client ID shown for domain-wide delegation. You'll use this in the Admin Console.
  10. In a new tab, navigate to the Google Admin Console.
  11. Go to Security > API Controls > Domain-Wide Delegation.
  12. Click Manage Domain-Wide Delegation, then Add new.
  13. Enter the recorded Client ID and the list of required scopes. See OAuth Scopes and Endpoints for more details.
  14. Back in the Cloud Console, select the KEYS tab for the service account.
  15. Click ADD KEY > Create new key.
  16. Select a supported key type (see OAuthJWTCert and OAuthJWTCertType).
  17. Click CREATE. The key is automatically downloaded to your device.
  18. Record the additional information for later use.

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.

CData Cloud

SSL Configuration

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.

CData Cloud

Firewall and Proxy

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.

CData Cloud

Data Model

The CData Cloud models Google Cloud Storage buckets, bucket information, and objects as a SQL database with tables, views, and stored procedures, allowing you to write SQL to query Google Cloud Storage data. Any changes you make to your buckets in the Google Cloud Storage UI, such as adding new objects or modifying bucket configurations, are automatically included in the schema of the Cloud.

Key Features

  • The Cloud uses a multi-schema model, meaning that the data model is organized into separate schemas. A separate Bucket Schema is dynamically generated for each bucket and named after it, while the static Information Schema serves as the default, and has tables and views that provide both cross-bucket aggregate data and bucket-level metadata. This schema also hosts the stored procedures.
  • Stored Procedures allow you to execute operations to Google Cloud Storage, including downloading and uploading objects. Because all stored procedures are located in the Information Schema, the Cloud always connects to both the selected Bucket Schema and the Information Schema simultaneously.

System Tables

System Tables contain information about the objects and resources belonging to your database.

CData Cloud

Information Schema

The CData Cloud models Information objects as tables, views, and stored procedures. The Information schema provides access to bucket metadata, object information across all buckets, access control lists (ACLs), Cross-Origin Resource Sharing (CORS) configurations, and lifecycle policies.

Note: Tables and views prefixed with "All" (for example, AllObjects or AllObjectACLs) automatically aggregate data from all buckets in the project. No bucket needs to be specified when querying them.

Tables

Tables provide read, write, and delete access to all information across buckets in the project.

Views

Views provide read access to all information across buckets in the project.

Stored Procedures

Stored Procedures are actions that are invoked via SQL queries. They perform tasks beyond standard CRUD operations, including managing buckets and objects, generating signed URLs, and handling OAuth authentication.

CData Cloud

Tables

The Cloud models the data in Google Cloud Storage as a list of tables in a relational database that can be queried using standard SQL statements.

CData Cloud - Google Cloud Storage Tables

Name Description
AllManagedFolders Returns information for managed folders in a bucket. Managed folders allow granular IAM access control within a bucket. Requires hierarchical namespace to be enabled on the bucket.
AllObjects Returns information for objects inside a specific bucket.
AllObjectVersions Returns information for object versions inside a specific bucket.

CData Cloud

AllManagedFolders

Returns information for managed folders in a bucket. Managed folders allow granular IAM access control within a bucket. Requires hierarchical namespace to be enabled on the bucket.

Table-Specific Information

SELECT

The Cloud uses the Google Cloud Storage API to process WHERE clause conditions built with the following columns and operators.

  • Name supports the =, LIKE operators.
  • Bucket supports the = operator.
For example, the following queries are processed server-side:
SELECT * FROM Information.AllManagedFolders WHERE Id = 'test_bucket/newmanagedfolder/'

SELECT * FROM Information.AllManagedFolders WHERE Name = 'test'
The rest of the filter is executed client-side within the Cloud.

INSERT

The following is an example of how to insert into the AllManagedFolders table:
INSERT INTO Information.AllManagedFolders (Bucket, Name) VALUES ('test_bucket', 'testee')

DELETE

The following is an example of how to delete from the AllManagedFolders table:
DELETE FROM Information.AllManagedFolders WHERE Id = 'test_bucket/test_folder/'

Columns

Name Type ReadOnly References Description
Id [KEY] String True

The ID of the managed folder (bucket name + managed folder path).

Name String False

The name of the managed folder, expressed as a path (e.g., example-dir/ or example-dir/subdir/).

Bucket String False

The name of the bucket containing this managed folder.

CreateTime Datetime True

The creation time of the managed folder in RFC 3339 format.

UpdateTime Datetime True

The time at which the managed folder's metadata or IAM policy was last updated in RFC 3339 format.

MetaGeneration Long True

The metadata generation of the managed folder.

CData Cloud

AllObjects

Returns information for objects inside a specific bucket.

Table-Specific Information

SELECT

The Cloud uses the Google Cloud Storage API to process WHERE clause conditions built with the following columns and operators.

  • Name supports the =, LIKE operators.
  • Bucket supports the = operator.
For example, the following queries are processed server-side:
SELECT * FROM Information.AllObjects WHERE Name = 'Test.txt'

SELECT * FROM Information.AllObjects WHERE Name LIKE 'Test%'

SELECT * FROM Information.AllObjects WHERE Bucket = 'asia_northeast1'
The rest of the filter is executed client-side within the Cloud.

DELETE

The following is an example of how to delete from the AllObjects table:
DELETE FROM Information.AllObjects WHERE Id = 'test_bucket/test_file.txt/1780039210076465'

Columns

Name Type ReadOnly References Description
Id [KEY] String True

The ID of the object, including the bucket name, object name, and generation number.

Name String True

The name of the object. Required if not specified by URL parameter.

Bucket String True

The name of the bucket containing this object.

Generation Long True

The content generation of this object. Used for object versioning.

MetaGeneration Long True

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 True

Content-Type of the object data. If an object is stored without a Content-Type, it is served as application/octet-stream.

TimeCreated Datetime True

The creation time of the object in RFC 3339 format.

Updated Datetime True

The modification time of the object metadata in RFC 3339 format.

TimeDeleted Datetime True

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 True

Whether or not the object is subject to a temporary hold.

EventBasedHold Boolean True

Whether or not the object is subject to an event-based hold.

RetentionExpirationTime Datetime True

The earliest time that the object can be deleted, based on a bucket's retention policy, in RFC 3339 format.

RetentionMode String True

The mode of the object-level retention configuration (Unlocked or Locked). When Locked, the retention cannot be removed and retainUntilTime cannot be reduced.

RetainUntilTime Datetime True

The earliest time that the object can be deleted or replaced based on object-level retention, in RFC 3339 format.

StorageClass String True

Storage class of the object.

TimeStorageClassUpdated Datetime True

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 Long True

Content-Length of the data in bytes.

Md5Hash String True

MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see Hashes and ETags: Best Practices.

MediaLink String True

Media download link.

ContentEncoding String True

Content-Encoding of the object data.

ContentDisposition String True

Content-Disposition of the object data.

ContentLanguage String True

Content-Language of the object data.

CacheControl String True

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 True

The entity, in the form user-emailAddress.

OwnerEntityId String True

The ID for the entity.

Crc32c String True

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 True

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 True

HTTP 1.1 Entity tag for the object.

CustomerEncryptionAlgorithm String True

The encryption algorithm.

CustomerEncryptionKeySha256 String True

SHA256 hash value of the encryption key.

KmsKeyName String True

Cloud KMS Key used to encrypt this object, if the object is encrypted by such a key.

CustomTime Datetime True

CA user-specified timestamp for the object in RFC 3339 format.

SoftDeleteTime Datetime True

When the object was soft-deleted. Essential for soft-delete workflows.

HardDeleteTime Datetime True

When a soft-deleted object will be permanently deleted. Companion to the above.

CData Cloud

AllObjectVersions

Returns information for object versions inside a specific bucket.

Table-Specific Information

SELECT

The Cloud uses the Google Cloud Storage API to process WHERE clause conditions built with the following columns and operators.

  • Name supports the =, LIKE operators.
  • Bucket supports the = operator.
For example, the following queries are processed server-side:
SELECT * FROM Information.AllObjectVersions WHERE Name = 'Test.txt'

SELECT * FROM Information.AllObjectVersions WHERE Name LIKE 'Test%'

SELECT * FROM Information.AllObjectVersions WHERE Bucket = 'asia_northeast1'
The rest of the filter is executed client-side within the Cloud.

DELETE

The following is an example of how to delete from the AllObjectVersions table:
DELETE FROM Information.AllObjectVersions WHERE Id = 'test_bucket/test_file.txt/1779445427321723'

Columns

Name Type ReadOnly References Description
Id [KEY] String True

The ID of the object, including the bucket name, object name, and generation number.

Name String True

The name of the object. Required if not specified by URL parameter.

Bucket String True

The name of the bucket containing this object.

Generation Long True

The content generation of this object. Used for object versioning.

MetaGeneration Long True

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 True

Content-Type of the object data. If an object is stored without a Content-Type, it is served as application/octet-stream.

TimeCreated Datetime True

The creation time of the object in RFC 3339 format.

Updated Datetime True

The modification time of the object metadata in RFC 3339 format.

TimeDeleted Datetime True

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 True

Whether or not the object is subject to a temporary hold.

EventBasedHold Boolean True

Whether or not the object is subject to an event-based hold.

RetentionExpirationTime Datetime True

The earliest time that the object can be deleted, based on a bucket's retention policy, in RFC 3339 format.

StorageClass String True

Storage class of the object.

TimeStorageClassUpdated Datetime True

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 Long True

Content-Length of the data in bytes.

Md5Hash String True

MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see Hashes and ETags: Best Practices.

MediaLink String True

Media download link.

ContentEncoding String True

Content-Encoding of the object data.

ContentDisposition String True

Content-Disposition of the object data.

ContentLanguage String True

Content-Language of the object data.

CacheControl String True

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 True

The entity, in the form user-emailAddress.

OwnerEntityId String True

The ID for the entity.

Crc32c String True

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 True

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 True

HTTP 1.1 Entity tag for the object.

CustomerEncryptionAlgorithm String True

The encryption algorithm.

CustomerEncryptionKeySha256 String True

SHA256 hash value of the encryption key.

KmsKeyName String True

Cloud KMS Key used to encrypt this object, if the object is encrypted by such a key.

CustomTime Datetime True

CA user-specified timestamp for the object in RFC 3339 format.

CData Cloud

Views

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 Cloud Storage Views

Name Description
AllObjectACLs Returns access control list (ACL) entries for a specific object, including the entity, role, and project team details that govern object-level permissions.
BucketACLs Returns the access control list entries for a specific bucket, including the entity, role, and project team details.
BucketCORS Returns the cross-origin resource sharing (CORS) configuration for a specific bucket.
BucketLifecycle Returns lifecycle configuration rules for a specific bucket, including action and condition details.
Buckets Returns information for buckets. Buckets are used to store objects, which consist of data and its metadata.

CData Cloud

AllObjectACLs

Returns access control list (ACL) entries for a specific object, including the entity, role, and project team details that govern object-level permissions.

View-Specific Information

SELECT

The Cloud uses the Google Cloud Storage API to process WHERE clause conditions built with the following columns and operators.

  • Bucket supports the = operator.
  • Object supports the =, LIKE operators.
For example, the following queries are processed server-side:
SELECT * FROM Information.AllObjectACLs WHERE Bucket = 'test_bucket'

SELECT * FROM Information.AllObjectACLs WHERE Object = 'test.txt'

SELECT * FROM Information.AllObjectACLs WHERE Object LIKE 'Test%'
The rest of the filter is executed client-side within the Cloud.

Columns

Name Type References Description
Id [KEY] String The Id of the access control entry.
Entity String The entity holding the permission.
Role String The access permission granted to the entity.
Email 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 of the team associated with the entity.
ProjectTeamType String The team type of the project team associated with the entity.
ETag String The HTTP 1.1 entity tag for the access control entry.
Bucket String The name of the bucket that contains the object.
Object String The name of the object to which the access control entry applies.

CData Cloud

BucketACLs

Returns the access control list entries for a specific bucket, including the entity, role, and project team details.

Columns

Name Type References 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.
Email 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 of the project team scoped to the bucket.
ProjectTeamType String The team type within the project, such as owners, editors, or viewers.
ETag String The HTTP 1.1 entity tag for the access control entry.
Bucket String The name of the bucket.

CData Cloud

BucketCORS

Returns the cross-origin resource sharing (CORS) configuration for a specific bucket.

Columns

Name Type References 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, such as GET, OPTIONS, or POST.
ResponseHeader String The list of HTTP headers, other than the simple response headers, that the user agent is permitted to share across domains.
MaxAgeSeconds Integer The value, in seconds, returned in the Access-Control-Max-Age header used in preflight responses.
Bucket String The name of the bucket.

CData Cloud

BucketLifecycle

Returns lifecycle configuration rules for a specific bucket, including action and condition details.

Columns

Name Type References Description
ActionType String The type of action applied by the lifecycle rule, such as Delete, AbortIncompleteMultipartUpload, or SetStorageClass.
ActionStorageClass String The new storage class assigned to the object when the action type is SetStorageClass.
Age Integer The age of an object in days. This condition is satisfied when an object reaches the specified age.
CreatedBefore Date The date in RFC 3339 format, containing only the date part, that the object must have been created before for this condition to be satisfied.
IsLive Boolean Indicates whether the condition matches the live version of objects. This setting is relevant only for versioned objects. If the value is true, the condition matches the live version of objects; if the value is false, it matches noncurrent versions of objects.
MatchesStorageClass String The storage classes that an object must belong to for this condition to be satisfied, such as STANDARD, NEARLINE, COLDLINE, ARCHIVE, MULTI_REGIONAL, REGIONAL, or DURABLE_REDUCED_AVAILABILITY.
NumberOfNewerVersions Integer The number of newer versions of an object that must exist for this condition to be satisfied. This setting is 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 The date in RFC 3339 format, YYYY-MM-DD, that the customTime metadata for the object must precede for this condition to be satisfied.
NoncurrentTimeBefore Date The date in RFC 3339 format, YYYY-MM-DD, that an object must have become noncurrent before for this condition to be satisfied. This setting is relevant only for versioned objects.
DaysSinceNoncurrentTime Integer The number of days an object must have been noncurrent for this condition to be satisfied. This setting is relevant only for versioned objects.
DaysSinceCustomTime Integer The number of 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 The name of the bucket.

CData Cloud

Buckets

Returns information for buckets. Buckets are used to store objects, which consist of data and its metadata.

View-Specific Information

SELECT

The Cloud uses the Google Cloud Storage API to process WHERE clause conditions built with the following column and operators.

  • Name supports the =, LIKE operators.
For example, the following queries are processed server-side:
SELECT * FROM Information.Buckets WHERE Name = 'Test.txt'

SELECT * FROM Information.Buckets WHERE Name LIKE 'Test%'
The rest of the filter is executed client-side within the Cloud.

Columns

Name Type References 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 Long The project number of the project the bucket belongs to.
MetaGeneration Long 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 The HTTP 1.1 entity tag for the bucket.
DefaultEventBasedHold Boolean Indicates 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 Indicates whether or not the bucket uses uniform bucket-level access. If set, access checks only use bucket-level IAM policies or above.
UniformBucketLevelAccessEnabled Boolean Indicates 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 Long 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 Indicates 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 is 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 ensures 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 returns 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.
ObjectRetention String The bucket's object retention mode. When set to Enabled, retention configurations can be set on objects in the bucket.
HierarchicalNamespaceEnabled Boolean Indicates whether hierarchical namespace is enabled for this bucket. Required for managed folders support. Cannot be disabled once enabled.

CData Cloud

Stored Procedures

Stored procedures are function-like interfaces that extend the functionality of the Cloud beyond simple SELECT/INSERT/DELETE 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.

CData Cloud - Google Cloud Storage Stored Procedures

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 stored procedure.
CreateManagedFolder Creates a managed folder within a bucket. Requires hierarchical namespace to be enabled on the bucket.
DeleteManagedFolder Deletes a managed folder within a bucket.
DeleteObject Deletes an object from a bucket.
DownloadObject Downloads an object from the specified bucket.
EnableVersioning Enables object versioning in a specific bucket.
MoveObject Moves an object from one bucket to another.
SignBlob Creates 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 Generates a V4 signed URL that grants time-limited access to a Cloud Storage object without requiring Google credentials when the request is made.
UpdateBucket Updates an existing bucket's properties. The authenticated user must have the storage.buckets.update IAM permission to use this StoredProcedure.
UploadObject Uploads an object in a single operation. Use the SimpleUploadLimit connection property to adjust the threshold, in bytes, at which a multipart upload is performed.

CData Cloud

CopyObject

Copies an object from one bucket to another.

Input

Name Type Required Description
BucketSource String True The name of the bucket where the object to be copied is located.
ObjectSource String True The name of the object to be copied.
BucketDestination String True The name of the bucket where the object is copied to.
ObjectDestination String False The new name of the object in the destination bucket. If not specified, the name remains the same.

Result Set Columns

Name Type Description
Success String Indicates whether the stored procedure executed successfully.

CData Cloud

CreateBucket

Creates a bucket. The authenticated user must have the storage.buckets.create IAM permission to use this stored procedure.

Input

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.

EnableObjectRetention Boolean False Indicates whether to permanently enable object retention for this bucket.
EnableHierarchicalNamespace Boolean False Indicates whether to enable hierarchical namespace for this bucket. Required to use managed folders. Cannot be disabled once enabled.
Location String False The location of the bucket (for example, US, EU, us-central1). Defaults to US.
StorageClass String False The bucket's default storage class.

The allowed values are STANDARD, NEARLINE, COLDLINE, ARCHIVE.

DefaultEventBasedHold Boolean False Indicates whether to automatically apply an event-based hold to new objects added to the bucket.
BillingRequesterPays Boolean False When set to true, Requester Pays is enabled for this bucket.
VersioningEnabled Boolean False When set to true, versioning is fully enabled for this bucket.
AutoclassEnabled Boolean False When set to true, Autoclass is enabled for this bucket.
AutoclassTerminalStorageClass String False The coldest storage class that objects transition to with Autoclass. Default is NEARLINE. Requires AutoclassEnabled to be set to true.

The allowed values are NEARLINE, ARCHIVE.

EncryptionDefaultKmsKeyName String False A Cloud KMS key that is used to encrypt objects inserted into this bucket.
WebsiteMainPageSuffix String False Behaves as the bucket's directory index (e.g., index.html).
WebsiteNotFoundPage String False The custom object to return for 404 responses.
LoggingLogBucket String False The destination bucket where the current bucket's logs should be placed.
LoggingLogObjectPrefix String False A prefix for log object names. Default is the bucket name.
RetentionPolicyPeriod Long False The retention period in seconds. Objects cannot be deleted during this time. Max: 3155760000 seconds.
PublicAccessPrevention String False The bucket's public access prevention status.

The allowed values are inherited, enforced.

UniformBucketLevelAccessEnabled Boolean False When true, access checks only use bucket-level IAM policies or above.
SoftDeleteRetentionDurationSeconds Long False Soft delete retention period in seconds (604800-7776000, or 0 to disable).
Rpo String False Recovery point objective for cross-region replication. Applicable only for dual- and multi-region buckets.

The allowed values are DEFAULT, ASYNC_TURBO.

IpFilterMode String False The state of the IP filter configuration.

The allowed values are Enabled, Disabled.

IpFilterAllowAllServiceAgentAccess Boolean False When true, service agents can access the bucket regardless of IP filter rules.
IpFilterAllowCrossOrgVpcs Boolean False When true, allows VPC networks from different organizations. Default is false.
IpFilterPublicNetworkAllowedIpCidrRanges String False A comma-separated list of public IPv4/IPv6 CIDR ranges allowed to access the bucket, e.g. range1,range2. Sets ipFilter.publicNetworkSource.allowedIpCidrRanges.
IpFilterVpcNetworkName String False A comma-separated list of VPC network resource names allowed to access the bucket, e.g. projects/PROJECT_ID/global/networks/NETWORK_NAME. Sets ipFilter.vpcNetworkSources[].network.
IpFilterVpcNetworkAllowedIpCidrRanges String False The IPv4/IPv6 CIDR ranges per VPC network. Separate groups with commas and separate the ranges within a group with a dash or space, e.g. range1 - range2, range3. Each group maps to the matching network in IpFilterVpcNetworkName. Requires IpFilterVpcNetworkName.

Result Set Columns

Name Type Description
Success String Indicates whether the stored procedure executed successfully.
Id String The Id of the created bucket.

CData Cloud

CreateManagedFolder

Creates a managed folder within a bucket. Requires hierarchical namespace to be enabled on the bucket.

Input

Name Type Required Description
Bucket String True The name of the bucket where the managed folder will be created.
Name String True The name of the managed folder, expressed as a path (for example, example-dir or example-dir/subdir).

Result Set Columns

Name Type Description
Success String Indicates whether the stored procedure executed successfully.
Id String The Id of the created managed folder.

CData Cloud

DeleteManagedFolder

Deletes a managed folder within a bucket.

Input

Name Type Required Description
Bucket String True The name of the bucket containing the managed folder.
ManagedFolder String True The name of the managed folder to delete. For nested paths (for example, example-dir1/example-dir2), the path is URL encoded automatically.
AllowNonEmpty Boolean False Allows deletion of a managed folder even if it contains objects or other managed folders. Default is false.

Result Set Columns

Name Type Description
Success String Indicates whether the stored procedure executed successfully.

CData Cloud

DeleteObject

Deletes an object from a bucket.

Input

Name Type Required Description
BucketSource String True The name of the bucket where the object to be deleted is located.
ObjectSource String True The name of the object to delete.
Generation Long False If present, permanently deletes a specific revision of this object, as opposed to the latest version, which is 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.

Result Set Columns

Name Type Description
Success String Indicates whether the stored procedure executed successfully.

CData Cloud

DownloadObject

Downloads an object from the specified bucket.

Input

Name Type Required Description
Bucket String True The name of the bucket where the object is located.
Object String False The name of the object to retrieve. If not specified, all objects from the specified bucket are retrieved. The format for downloading a specific object from a subfolder is Object='FolderName/SubfolderName/FileName.'
LocalFolderPath String False The path to the local folder that receives the object.
UpdatedStartDate Datetime False The start of the datetime range to filter objects by their last modified timestamp. Objects with an updated timestamp greater than or equal to this value are included. If not specified, objects are retrieved from the beginning until the UpdatedEndDate.
UpdatedEndDate Datetime False The end of the datetime range to filter objects by their last modified timestamp. Objects with an updated timestamp less than or equal to this value are included. If not specified, objects are retrieved from the specified UpdatedStartDate until the present.
Encoding String False If the LocalFile input is left empty, the data outputs to FileData in the specified encoding.

The allowed values are NONE, BASE64.

The default value is BASE64.

Result Set Columns

Name Type Description
Object String The name of the object that is downloaded.
FileData String The base64encoded object data output, if the LocalFolderPath input is empty.
Success String Indicates whether the stored procedure executed successfully.
DownloadedObjectLocalPath String The full path to the downloaded object on disk. Null if LocalFolderPath input was not specified.

CData Cloud

EnableVersioning

Enables object versioning in a specific bucket.

Input

Name Type Required Description
Bucket String True The name of the bucket where versioning is enabled.

Result Set Columns

Name Type Description
Success String Indicates whether the stored procedure executed successfully.

CData Cloud

MoveObject

Moves an object from one bucket to another.

Input

Name Type Required Description
BucketSource String True The name of the bucket where the object to be moved is located.
ObjectSource String True The name of the object to be moved.
BucketDestination String True The name of the bucket where the object is moved to.
ObjectDestination String False The new name of the object in the destination bucket. If not specified, the name remains the same.

Result Set Columns

Name Type Description
Success String Indicates whether the stored procedure executed successfully.

CData Cloud

SignBlob

Creates 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

Input

Name Type Required Description
RequestInformation String True The string-to-sign or policy document to be signed. The data can be in raw format or base64 encoded.
ServiceAccountEmail String True The email address or the unique Id of the service account used to create the signature.
Delegates String False The sequence of service accounts separated by a comma in a delegation chain.

Result Set Columns

Name Type Description
Success String Indicates whether the stored procedure executed successfully.
KeyId String The Id of the key used to sign the blob.
SignedBlob String The signature for the blob, returned as a base64-encoded string. This value does not include the original blob.

CData Cloud

SignURL

Generates a V4 signed URL that grants time-limited access to a Cloud Storage object without requiring Google credentials when the request is made.

Input

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. Provide the raw object name; the driver percent-encodes path segments and preserves '/' for folder structure.
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. Provide raw name=value pairs separated by ampersands; the driver percent-encodes each name and value.
CustomHeaders String False A comma separated list of name=value of the headers to use with the SignedURL, if not specified no custom headers will be used. Header names and values are passed through to the canonical request as provided.
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.

Result Set Columns

Name Type Description
Success Boolean Indicates whether the stored procedure executed successfully.
SignedURL String Returns a signed URL that can be used to download the resource.

CData Cloud

UpdateBucket

Updates an existing bucket's properties. The authenticated user must have the storage.buckets.update IAM permission to use this StoredProcedure.

Input

Name Type Required Description
Bucket String True The name of the bucket to update.
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.

IfMetagenerationMatch Long False Makes the update conditional on whether the bucket's current metageneration matches the given value.
IfMetagenerationNotMatch Long False Makes the update conditional on whether the bucket's current metageneration does not match the given value.
StorageClass String False The bucket's default storage class.

The allowed values are STANDARD, NEARLINE, COLDLINE, ARCHIVE.

DefaultEventBasedHold Boolean False Whether to automatically apply an eventBasedHold to new objects added to the bucket.
BillingRequesterPays Boolean False When set to true, Requester Pays is enabled for this bucket.
VersioningEnabled Boolean False When set to true, versioning is fully enabled for this bucket.
AutoclassEnabled Boolean False When set to true, Autoclass is enabled for this bucket.
AutoclassTerminalStorageClass String False The coldest storage class that objects transition to with Autoclass. Default is NEARLINE. Requires AutoclassEnabled to be set to true.

The allowed values are NEARLINE, ARCHIVE.

EncryptionDefaultKmsKeyName String False A Cloud KMS key that will be used to encrypt objects inserted into this bucket.
WebsiteMainPageSuffix String False Behaves as the bucket's directory index (e.g., index.html).
WebsiteNotFoundPage String False The custom object to return for 404 responses.
LoggingLogBucket String False The destination bucket where the current bucket's logs should be placed.
LoggingLogObjectPrefix String False A prefix for log object names. Default is the bucket name.
RetentionPolicyPeriod Long False The retention period in seconds. Objects cannot be deleted during this time. Max: 3155760000 seconds.
PublicAccessPrevention String False The bucket's public access prevention status.

The allowed values are inherited, enforced.

UniformBucketLevelAccessEnabled Boolean False When true, access checks only use bucket-level IAM policies or above.
SoftDeleteRetentionDurationSeconds Long False Soft delete retention period in seconds (604800-7776000, or 0 to disable).
Rpo String False Recovery point objective for cross-region replication. Applicable only for dual- and multi-region buckets.

The allowed values are DEFAULT, ASYNC_TURBO.

IpFilterMode String False The state of the IP filter configuration.

The allowed values are Enabled, Disabled.

IpFilterAllowAllServiceAgentAccess Boolean False When true, service agents can access the bucket regardless of IP filter rules.
IpFilterAllowCrossOrgVpcs Boolean False When true, allows VPC networks from different organizations. Default is false.
IpFilterPublicNetworkAllowedIpCidrRanges String False A comma-separated list of public IPv4/IPv6 CIDR ranges allowed to access the bucket, e.g. range1,range2. Sets ipFilter.publicNetworkSource.allowedIpCidrRanges.
IpFilterVpcNetworkName String False A comma-separated list of VPC network resource names allowed to access the bucket, e.g. projects/PROJECT_ID/global/networks/NETWORK_NAME. Sets ipFilter.vpcNetworkSources[].network.
IpFilterVpcNetworkAllowedIpCidrRanges String False The IPv4/IPv6 CIDR ranges per VPC network. Separate groups with commas and separate the ranges within a group with a dash or space, e.g. range1 - range2, range3. Each group maps to the matching network in IpFilterVpcNetworkName. Requires IpFilterVpcNetworkName.

Result Set Columns

Name Type Description
Success String Indicator if the stored procedure was successful or not.

CData Cloud

UploadObject

Uploads an object in a single operation. Use the SimpleUploadLimit connection property to adjust the threshold, in bytes, at which a multipart upload is performed.

Input

Name Type Required Description
Bucket String True The name of the bucket where the object is uploaded.
ObjectName String False The name of the uploaded object. Specify this value only when uploading the content as an InputStream.
FolderPath String False The path to the folder that receives the data of the object.
LocalFilePath String False The path to the file that is uploaded to the bucket. If this is a path to a folder, all the files in the folder are uploaded to the bucket.
ContentType String False The Content-Type of the object data.
ObjectInformationAggregate String False An aggregate representing the object information. Can be in the form of XML, JSON, or a #TEMP table.
GetSignedUrl Boolean False Indicates whether to return a signed URL. Only available when OAuthJWTCert is set.

The default value is false.

ExpiresIn String False The expiration time for the signed URL, in the format 1d2h3m4s. The maximum value is 7d0h0m0s.

Result Set Columns

Name Type Description
Object String The name of the object that is uploaded.
Success String Indicates whether the stored procedure executed successfully.
SignedURL String Returns a signed URL that can be used to download the resource.

CData Cloud

Bucket Schema

The CData Cloud creates a separate Bucket Schema for each bucket in Google Cloud Storage, with each schema named after its corresponding bucket. Within a Bucket Schema, objects, object versions, object access control lists (ACLs), and managed folders are modeled as tables and views scoped to that specific bucket.

Tables

Tables provide read, write, and delete access to bucket-specific data.

Views

Views provide read access to bucket-specific data.

CData Cloud

Tables

The Cloud models the data in Google Cloud Storage as a list of tables in a relational database that can be queried using standard SQL statements.

CData Cloud - Google Cloud Storage Tables

Name Description
ManagedFolders Returns information for managed folders in a bucket. Managed folders allow granular IAM access control within a bucket. Requires hierarchical namespace to be enabled on the bucket.
Objects Returns information for objects inside a specific bucket.
ObjectVersions Returns information for object versions inside a specific bucket.

CData Cloud

ManagedFolders

Returns information for managed folders in a bucket. Managed folders allow granular IAM access control within a bucket. Requires hierarchical namespace to be enabled on the bucket.

Table-Specific Information

SELECT

The Cloud uses the Google Cloud Storage API to process WHERE clause conditions built with the following column and operators.

  • Name supports the =, LIKE operators.
For example, the following queries are processed server-side:
SELECT * FROM test_bucket.ManagedFolders WHERE Name = 'test'

SELECT * FROM test_bucket.ManagedFolders WHERE Bucket = 'test_bucket'
The rest of the filter is executed client-side within the Cloud.

INSERT

The following is an example of how to insert into the ManagedFolders table:
INSERT INTO test_bucket.ManagedFolders (Name) VALUES ('test1')

DELETE

The following is an example of how to delete from the ManagedFolders table:
DELETE FROM test_bucket.ManagedFolders WHERE Name = 'test1'

Columns

Name Type ReadOnly References Description
Id [KEY] String True

The ID of the managed folder (bucket name + managed folder path).

Name String False

The name of the managed folder, expressed as a path (e.g., example-dir/ or example-dir/subdir/).

Bucket String True

The name of the bucket containing this managed folder.

CreateTime Datetime True

The creation time of the managed folder in RFC 3339 format.

UpdateTime Datetime True

The time at which the managed folder's metadata or IAM policy was last updated in RFC 3339 format.

MetaGeneration Long True

The metadata generation of the managed folder.

CData Cloud

Objects

Returns information for objects inside a specific bucket.

Table-Specific Information

DELETE

The following is an example of how to delete from the Objects table:
DELETE FROM test_bucket.Objects WHERE Name = 'test_file.csv'

Columns

Name Type ReadOnly References Description
Id [KEY] String True

The ID of the object, including the bucket name, object name, and generation number.

Name String True

The name of the object. Required if not specified by URL parameter.

Bucket String True

The name of the bucket containing this object.

Generation Long True

The content generation of this object. Used for object versioning.

MetaGeneration Long True

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 True

Content-Type of the object data. If an object is stored without a Content-Type, it is served as application/octet-stream.

TimeCreated Datetime True

The creation time of the object in RFC 3339 format.

Updated Datetime True

The modification time of the object metadata in RFC 3339 format.

TimeDeleted Datetime True

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 True

Whether or not the object is subject to a temporary hold.

EventBasedHold Boolean True

Whether or not the object is subject to an event-based hold.

RetentionExpirationTime Datetime True

The earliest time that the object can be deleted, based on a bucket's retention policy, in RFC 3339 format.

RetentionMode String True

The mode of the object-level retention configuration (Unlocked or Locked). When Locked, the retention cannot be removed and retainUntilTime cannot be reduced.

RetainUntilTime Datetime True

The earliest time that the object can be deleted or replaced based on object-level retention, in RFC 3339 format.

StorageClass String True

Storage class of the object.

TimeStorageClassUpdated Datetime True

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 Long True

Content-Length of the data in bytes.

Md5Hash String True

MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see Hashes and ETags: Best Practices.

MediaLink String True

Media download link.

ContentEncoding String True

Content-Encoding of the object data.

ContentDisposition String True

Content-Disposition of the object data.

ContentLanguage String True

Content-Language of the object data.

CacheControl String True

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 True

The entity, in the form user-emailAddress.

OwnerEntityId String True

The ID for the entity.

Crc32c String True

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 True

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 True

HTTP 1.1 Entity tag for the object.

CustomerEncryptionAlgorithm String True

The encryption algorithm.

CustomerEncryptionKeySha256 String True

SHA256 hash value of the encryption key.

KmsKeyName String True

Cloud KMS Key used to encrypt this object, if the object is encrypted by such a key.

CustomTime Datetime True

CA user-specified timestamp for the object in RFC 3339 format.

SoftDeleteTime Datetime True

When the object was soft-deleted. Essential for soft-delete workflows.

HardDeleteTime Datetime True

When a soft-deleted object will be permanently deleted. Companion to the above.

CData Cloud

ObjectVersions

Returns information for object versions inside a specific bucket.

Table-Specific Information

SELECT

The Cloud uses the Google Cloud Storage API to process WHERE clause conditions built with the following column and operators.

  • Name supports the =, LIKE operators.
For example, the following query is processed server-side:
SELECT * FROM asia_northeast1.ObjectVersions WHERE Name LIKE 'test%'
The rest of the filter is executed client-side within the Cloud.

DELETE

The following is an example of how to delete from the ObjectVersions table:
DELETE FROM asia_northeast1.ObjectVersions WHERE Id = 'asia_northeast1/test_object.txt/1590497592691208'

Columns

Name Type ReadOnly References Description
Id [KEY] String True

The ID of the object, including the bucket name, object name, and generation number.

Name String False

The name of the object. Required if not specified by URL parameter.

Bucket String True

The name of the bucket containing this object.

Generation Long True

The content generation of this object. Used for object versioning.

MetaGeneration Long True

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 True

Content-Type of the object data. If an object is stored without a Content-Type, it is served as application/octet-stream.

TimeCreated Datetime True

The creation time of the object in RFC 3339 format.

Updated Datetime True

The modification time of the object metadata in RFC 3339 format.

TimeDeleted Datetime True

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 True

Whether or not the object is subject to a temporary hold.

EventBasedHold Boolean True

Whether or not the object is subject to an event-based hold.

RetentionExpirationTime Datetime True

The earliest time that the object can be deleted, based on a bucket's retention policy, in RFC 3339 format.

StorageClass String True

Storage class of the object.

TimeStorageClassUpdated Datetime True

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 Long True

Content-Length of the data in bytes.

Md5Hash String True

MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see Hashes and ETags: Best Practices.

MediaLink String True

Media download link.

ContentEncoding String True

Content-Encoding of the object data.

ContentDisposition String True

Content-Disposition of the object data.

ContentLanguage String True

Content-Language of the object data.

CacheControl String True

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 True

The entity, in the form user-emailAddress.

OwnerEntityId String True

The ID for the entity.

Crc32c String True

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 True

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 True

HTTP 1.1 Entity tag for the object.

CustomerEncryptionAlgorithm String True

The encryption algorithm.

CustomerEncryptionKeySha256 String True

SHA256 hash value of the encryption key.

KmsKeyName String True

Cloud KMS Key used to encrypt this object, if the object is encrypted by such a key.

CustomTime Datetime True

CA user-specified timestamp for the object in RFC 3339 format.

CData Cloud

Views

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 Cloud Storage Views

Name Description
ObjectACLs Returns access control list (ACL) entries for a specific object, including the entity, role, and project team details for each permission.

CData Cloud

ObjectACLs

Returns access control list (ACL) entries for a specific object, including the entity, role, and project team details for each permission.

View-Specific Information

SELECT

The Cloud uses the Google Cloud Storage API to process WHERE clause conditions built with the following column and operators.

  • Object supports the =, LIKE operators.
For example, the following queries are processed server-side:
SELECT * FROM test_bucket.ObjectACLs WHERE Object = 'Test.txt'

SELECT * FROM test_bucket.ObjectACLs WHERE Object LIKE 'Test%'
The rest of the filter is executed client-side within the Cloud.

Columns

Name Type References 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.
Email 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 of the project team associated with the entity.
ProjectTeamType String The type of the project team associated with the entity.
ETag String The HTTP 1.1 entity tag for the access control entry.
Bucket String The name of the bucket.
Object String The name of the object.

CData Cloud

System Tables

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 Cloud Storage:

  • 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

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

CData Cloud

sys_catalogs

Lists the available databases.

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

SELECT * FROM sys_catalogs

Columns

Name Type Description
CatalogName String The database name.

CData Cloud

sys_schemas

Lists the available schemas.

The following query retrieves all available schemas:

          SELECT * FROM sys_schemas
          

Columns

Name Type Description
CatalogName String The database name.
SchemaName String The schema name.

CData Cloud

sys_tables

Lists the available tables.

The following query retrieves the available tables and views:

          SELECT * FROM sys_tables
          

Columns

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.
IsInsertable Boolean Whether the table can be inserted into.
IsDeleteable Boolean Whether rows can be deleted from the table.

CData Cloud

sys_tablecolumns

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' 

Columns

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.
ColumnCapabilities Int32 A bit mask denoting the column's write capabilities. The value is the sum of the following: 1 if the column is required for INSERTs, 2 if the column is allowed for INSERTs, and 4 if the column is allowed for UPDATEs. A value of 0 indicates that the write capabilities of the column are unknown or that the column is read-only.

CData Cloud

sys_procedures

Lists the available stored procedures.

The following query retrieves the available stored procedures:

          SELECT * FROM sys_procedures
          

Columns

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.

CData Cloud

sys_procedureparameters

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'

Columns

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.

Pseudocolumns

Name Type Description
IncludeResultColumns Boolean Whether the output should include columns from the result set in addition to parameters. Defaults to False.

CData Cloud

sys_keycolumns

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' 
          

Columns

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.

CData Cloud

sys_foreignkeys

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

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.

CData Cloud

sys_primarykeys

Describes the primary keys.

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

         SELECT * FROM sys_primarykeys
          

Columns

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.

CData Cloud

sys_indexes

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

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.

CData Cloud

sys_connection_props

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

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.

CData Cloud

sys_sqlinfo

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.

NameDescriptionPossible Values
AGGREGATE_FUNCTIONSSupported aggregation functions.AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNTWhether COUNT function is supported.YES, NO
IDENTIFIER_QUOTE_OPEN_CHARThe opening character used to escape an identifier.[
IDENTIFIER_QUOTE_CLOSE_CHARThe closing character used to escape an identifier.]
SUPPORTED_OPERATORSA list of supported SQL operators.=, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BYWhether GROUP BY is supported, and, if so, the degree of support.NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
OJ_CAPABILITIESThe supported varieties of outer joins supported.NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS
OUTER_JOINSWhether outer joins are supported.YES, NO
SUBQUERIESWhether subqueries are supported, and, if so, the degree of support.NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED
STRING_FUNCTIONSSupported 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_FUNCTIONSSupported 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_FUNCTIONSSupported 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_TABLESIndicates tables skipped during replication.
REPLICATION_TIMECHECK_COLUMNSA 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_PATTERNString value indicating what string is valid for an identifier.
SUPPORT_TRANSACTIONIndicates if the provider supports transactions such as commit and rollback.YES, NO
DIALECTIndicates the SQL dialect to use.
KEY_PROPERTIESIndicates the properties which identify the uniform database.
SUPPORTS_MULTIPLE_SCHEMASIndicates if multiple schemas may exist for the provider.YES, NO
SUPPORTS_MULTIPLE_CATALOGSIndicates if multiple catalogs may exist for the provider.YES, NO
DATASYNCVERSIONThe CData Data Sync version needed to access this driver.Standard, Starter, Professional, Enterprise
DATASYNCCATEGORYThe CData Data Sync category of this driver.Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQLWhether enhanced SQL functionality beyond what is offered by the API is supported.TRUE, FALSE
SUPPORTS_BATCH_OPERATIONSWhether batch operations are supported.YES, NO
SQL_CAPAll 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_OPTIONSA string value specifies the preferred cacheOptions.
ENABLE_EF_ADVANCED_QUERYIndicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side.YES, NO
PSEUDO_COLUMNSA string array indicating the available pseudo columns.
MERGE_ALWAYSIf the value is true, The Merge Mode is forcibly executed in Data Sync.TRUE, FALSE
REPLICATION_MIN_DATE_QUERYA select query to return the replicate start datetime.
REPLICATION_MIN_FUNCTIONAllows a provider to specify the formula name to use for executing a server side min.
REPLICATION_START_DATEAllows a provider to specify a replicate startdate.
REPLICATION_MAX_DATE_QUERYA select query to return the replicate end datetime.
REPLICATION_MAX_FUNCTIONAllows a provider to specify the formula name to use for executing a server side max.
IGNORE_INTERVALS_ON_INITIAL_REPLICATEA list of tables which will skip dividing the replicate into chunks on the initial replicate.
CHECKCACHE_USE_PARENTIDIndicates whether the CheckCache statement should be done against the parent key column.TRUE, FALSE
CREATE_SCHEMA_PROCEDURESIndicates 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.

Columns

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.

CData Cloud

sys_identity

Returns information about attempted modifications.

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

         SELECT * FROM sys_identity
          

Columns

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.

CData Cloud

sys_information

Describes the available system information.

The following query retrieves all columns:

SELECT * FROM sys_information

Columns

NameTypeDescription
ProductStringThe name of the product.
VersionStringThe version number of the product.
DatasourceStringThe name of the datasource the product connects to.
NodeIdStringThe unique identifier of the machine where the product is installed.
HelpURLStringThe URL to the product's help documentation.
LicenseStringThe license information for the product. (If this information is not available, the field may be left blank or marked as 'N/A'.)
LocationStringThe file path location where the product's library is stored.
EnvironmentStringThe version of the environment or rumtine the product is currently running under.
DataSyncVersionStringThe tier of CData Sync required to use this connector.
DataSyncCategoryStringThe category of CData Sync functionality (e.g., Source, Destination).

CData Cloud

Connection String Options

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.

Authentication


PropertyDescription
AuthSchemeSpecifies the authentication method used to connect to Google Cloud Storage.
ProjectIdThe Id of the project where your Google Cloud Storage instance resides.

Connection


PropertyDescription
BucketsSpecifies the bucket or buckets you want to connect to.

OAuth


PropertyDescription
OAuthClientIdSpecifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
OAuthClientSecretSpecifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).
DelegatedServiceAccountsSpecifies a space-delimited list of service account emails for delegated requests.
RequestingServiceAccountSpecifies a service account email to make a delegated request.
ScopeSpecifies 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.

JWT OAuth


PropertyDescription
OAuthJWTCertSupplies the name of the client certificate's JWT Certificate store.
OAuthJWTCertTypeIdentifies the type of key store containing the JWT Certificate.
OAuthJWTCertPasswordProvides the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
OAuthJWTCertSubjectIdentifies 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.
OAuthJWTIssuerThe issuer of the Java Web Token.
OAuthJWTSubjectThe user subject for which the application is requesting delegated access.

SSL


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

Logging


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

Schema


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

Miscellaneous


PropertyDescription
AffectedRowsTimeoutSpecifies the interval (in milliseconds) between polling attempts when waiting to determine the number of rows affected by a CUD operation. This property applies only to tables backed by asynchronous operations (_RapidCache, AllRapidCaches_). If the operation has not completed by the time the polling interval elapses, the provider stops waiting and reports the affected row count as unknown. The operation itself is not cancelled.
AWSWorkloadIdentityConfigConfiguration properties to provide when using Workload Identity Federation via AWS.
AzureWorkloadIdentityConfigConfiguration properties to provide when using Workload Identity Federation via Azure.
MaxRowsSpecifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
PseudoColumnsSpecifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
SimpleUploadLimitSpecifies the threshold, in bytes, above which the provider performs a multipart upload rather than uploading everything in one request.
ThrowsKeyNotFoundSpecifies whether or not throws an exception if there is no rows updated.
TimeoutSpecifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
WorkloadPoolIdThe ID of your Workload Identity Federation pool.
WorkloadProjectIdThe ID of the Google Cloud project that hosts your Workload Identity Federation pool.
WorkloadProviderIdThe ID of your Workload Identity Federation pool provider.
CData Cloud

Authentication

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


PropertyDescription
AuthSchemeSpecifies the authentication method used to connect to Google Cloud Storage.
ProjectIdThe Id of the project where your Google Cloud Storage instance resides.
CData Cloud

AuthScheme

Specifies the authentication method used to connect to Google Cloud Storage.

Possible Values

OAuth, OAuthJWT, AWSWorkloadIdentity, AzureWorkloadIdentity

Data Type

string

Default Value

"OAuth"

Remarks

  • 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.
  • AWSWorkloadIdentity: Set this to authenticate using Workload Identity Federation via AWS. The Cloud authenticates to AWS according to the AWSWorkloadIdentityConfig and provides Google Security Token Service with an authentication token. The Google STS validates this token and produces an OAuth token that can access Google services.
  • AzureWorkloadIdentity: Set this to authenticate using Workload Identity Federation via Azure. The Cloud authenticates to Azure according to the AzureWorkloadIdentityConfig and provides Google Security Token Service with an authentication token. The Google STS validates this token and produces an OAuth token that can access Google services.

CData Cloud

ProjectId

The Id of the project where your Google Cloud Storage instance resides.

Data Type

string

Default Value

""

Remarks

To locate the value for this property, open the Google Cloud Console and click the project name in the top-left of the UI. The Project Id is listed in the Id column of the project selector.

CData Cloud

Connection

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


PropertyDescription
BucketsSpecifies the bucket or buckets you want to connect to.
CData Cloud

Buckets

Specifies the bucket or buckets you want to connect to.

Data Type

string

Default Value

""

Remarks

Multiple buckets can be specified by separating each one with a comma (for example, bucket1,bucket2,bucket3).

CData Cloud

OAuth

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


PropertyDescription
OAuthClientIdSpecifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
OAuthClientSecretSpecifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).
DelegatedServiceAccountsSpecifies a space-delimited list of service account emails for delegated requests.
RequestingServiceAccountSpecifies a service account email to make a delegated request.
ScopeSpecifies 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.
CData Cloud

OAuthClientId

Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.

Data Type

string

Default Value

""

Remarks

This property is required in two cases:

  • When using a custom OAuth application, such as in web-based authentication flows, service-based authentication, or certificate-based flows that require application registration.
  • If the driver does not provide embedded OAuth credentials.

(When the driver provides embedded OAuth credentials, this value may already be provided by the Cloud and thus not require manual entry.)

OAuthClientId is generally used alongside other OAuth-related properties such as OAuthClientSecret and OAuthSettingsLocation when configuring an authenticated connection.

OAuthClientId is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can usually find this value in your identity provider’s application registration settings. Look for a field labeled Client ID, Application ID, or Consumer Key.

While the client ID is not considered a confidential value like a client secret, it is still part of your application's identity and should be handled carefully. Avoid exposing it in public repositories or shared configuration files.

For more information on how this property is used when configuring a connection, see Establishing a Connection.

CData Cloud

OAuthClientSecret

Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).

Data Type

string

Default Value

""

Remarks

This property (sometimes called the application secret or consumer secret) is required when using a custom OAuth application in any flow that requires secure client authentication, such as web-based OAuth, service-based connections, or certificate-based authorization flows. It is not required when using an embedded OAuth application.

The client secret is used during the token exchange step of the OAuth flow, when the driver requests an access token from the authorization server. If this value is missing or incorrect, authentication fails with either an invalid_client or an unauthorized_client error.

OAuthClientSecret is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can obtain this value from your identity provider when registering the OAuth application.

Notes:

  • This value should be stored securely and never exposed in public repositories, scripts, or unsecured environments.
  • Client secrets may also expire after a set period. Be sure to monitor expiration dates and rotate secrets as needed to maintain uninterrupted access.

For more information on how this property is used when configuring a connection, see Establishing a Connection

CData Cloud

DelegatedServiceAccounts

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

CData Cloud

RequestingServiceAccount

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

CData Cloud

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.

Data Type

string

Default Value

""

Remarks

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.

CData Cloud

JWT OAuth

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


PropertyDescription
OAuthJWTCertSupplies the name of the client certificate's JWT Certificate store.
OAuthJWTCertTypeIdentifies the type of key store containing the JWT Certificate.
OAuthJWTCertPasswordProvides the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
OAuthJWTCertSubjectIdentifies 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.
OAuthJWTIssuerThe issuer of the Java Web Token.
OAuthJWTSubjectThe user subject for which the application is requesting delegated access.
CData Cloud

OAuthJWTCert

Supplies the name of the client certificate's JWT Certificate store.

Data Type

string

Default Value

""

Remarks

The OAuthJWTCertType field specifies the type of the certificate store specified in OAuthJWTCert. If the store is password-protected, use OAuthJWTCertPassword to supply the password..

OAuthJWTCert is used in conjunction with the OAuthJWTCertSubject field in order to specify client certificates. If OAuthJWTCert has a value, and OAuthJWTCertSubject is set, the CData Cloud initiates a search for a certificate. For further information, see OAuthJWTCertSubject.

Designations of certificate stores are platform-dependent.

Notes

  • The most common User and Machine certificate stores in Windows include:
    • MY: A certificate store holding personal certificates with their associated private keys.
    • CA: Certifying authority certificates.
    • ROOT: Root certificates.
    • SPC: Software publisher certificates.
  • In Java, the certificate store normally is a file containing certificates and optional private keys.
  • When the certificate store type is PFXFile, this property must be set to the name of the file.
  • When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).

CData Cloud

OAuthJWTCertType

Identifies the type of key store containing the JWT Certificate.

Possible Values

PFXBLOB, JKSBLOB, PEMKEY_BLOB, PUBLIC_KEY_BLOB, SSHPUBLIC_KEY_BLOB, XMLBLOB, BCFKSBLOB, GOOGLEJSONBLOB

Data Type

string

Default Value

"PEMKEY_BLOB"

Remarks

ValueDescriptionNotes
USERA certificate store owned by the current user. Only available in Windows.
MACHINEA machine store.Not available in Java or other non-Windows environments.
PFXFILEA PFX (PKCS12) file containing certificates.
PFXBLOBA string (base-64-encoded) representing a certificate store in PFX (PKCS12) format.
JKSFILEA Java key store (JKS) file containing certificates.Only available in Java.
JKSBLOBA string (base-64-encoded) representing a certificate store in Java key store (JKS) format. Only available in Java.
PEMKEY_FILEA PEM-encoded file that contains a private key and an optional certificate.
PEMKEY_BLOBA string (base64-encoded) that contains a private key and an optional certificate.
PUBLIC_KEY_FILEA file that contains a PEM- or DER-encoded public key certificate.
PUBLIC_KEY_BLOBA string (base-64-encoded) that contains a PEM- or DER-encoded public key certificate.
SSHPUBLIC_KEY_FILEA file that contains an SSH-style public key.
SSHPUBLIC_KEY_BLOBA string (base-64-encoded) that contains an SSH-style public key.
P7BFILEA PKCS7 file containing certificates.
PPKFILEA file that contains a PPK (PuTTY Private Key).
XMLFILEA file that contains a certificate in XML format.
XMLBLOBAstring that contains a certificate in XML format.
BCFKSFILEA file that contains an Bouncy Castle keystore.
BCFKSBLOBA string (base-64-encoded) that contains a Bouncy Castle keystore.
GOOGLEJSONA JSON file containing the service account information. Only valid when connecting to a Google service.
GOOGLEJSONBLOBA string that contains the service account JSON. Only valid when connecting to a Google service.

CData Cloud

OAuthJWTCertPassword

Provides the password for the OAuth JWT certificate used to access a password-protected certificate store. 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 a password-protected certificate store. 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.

CData Cloud

OAuthJWTCertSubject

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

FieldMeaning
CNCommon Name. This is commonly a host name like www.server.com.
OOrganization
OUOrganizational Unit
LLocality
SState
CCountry
EEmail Address

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

CData Cloud

OAuthJWTIssuer

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.

CData Cloud

OAuthJWTSubject

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.

CData Cloud

SSL

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


PropertyDescription
SSLServerCertSpecifies the certificate to be accepted from the server when connecting using TLS/SSL.
CData Cloud

SSLServerCert

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

Data Type

string

Default Value

""

Remarks

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.

CData Cloud

Logging

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


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

Verbosity

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.

CData Cloud

Schema

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


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

BrowsableSchemas

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.

CData Cloud

Miscellaneous

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


PropertyDescription
AffectedRowsTimeoutSpecifies the interval (in milliseconds) between polling attempts when waiting to determine the number of rows affected by a CUD operation. This property applies only to tables backed by asynchronous operations (_RapidCache, AllRapidCaches_). If the operation has not completed by the time the polling interval elapses, the provider stops waiting and reports the affected row count as unknown. The operation itself is not cancelled.
AWSWorkloadIdentityConfigConfiguration properties to provide when using Workload Identity Federation via AWS.
AzureWorkloadIdentityConfigConfiguration properties to provide when using Workload Identity Federation via Azure.
MaxRowsSpecifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
PseudoColumnsSpecifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
SimpleUploadLimitSpecifies the threshold, in bytes, above which the provider performs a multipart upload rather than uploading everything in one request.
ThrowsKeyNotFoundSpecifies whether or not throws an exception if there is no rows updated.
TimeoutSpecifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
WorkloadPoolIdThe ID of your Workload Identity Federation pool.
WorkloadProjectIdThe ID of the Google Cloud project that hosts your Workload Identity Federation pool.
WorkloadProviderIdThe ID of your Workload Identity Federation pool provider.
CData Cloud

AffectedRowsTimeout

Specifies the interval (in milliseconds) between polling attempts when waiting to determine the number of rows affected by a CUD operation. This property applies only to tables backed by asynchronous operations (_RapidCache, AllRapidCaches_). If the operation has not completed by the time the polling interval elapses, the provider stops waiting and reports the affected row count as unknown. The operation itself is not cancelled.

Data Type

int

Default Value

10000

Remarks

Default value is 10000 ms.

CData Cloud

AWSWorkloadIdentityConfig

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="AuthScheme=AwsRootKeys;AccessKey='AKIAABCDEF123456';SecretKey=...;Region=us-east-1"

CData Cloud

AzureWorkloadIdentityConfig

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

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 Azure using client credentials:

AzureWorkloadIdentityConfig="AuthScheme=AzureServicePrincipal;AzureTenant=directory (tenant) id;OAuthClientID=application (client) id;OAuthClientSecret=client secret;AzureResource=application id uri;"

CData Cloud

MaxRows

Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.

Data Type

int

Default Value

-1

Remarks

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.

CData Cloud

PseudoColumns

Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.

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:

*=*

CData Cloud

SimpleUploadLimit

Specifies the threshold, in bytes, above which the provider performs a multipart upload rather than uploading everything in one request.

Data Type

string

Default Value

"5242880"

Remarks

The default and the minimum value is 5242880 bytes. Values below the minimum are automatically raised to the minimum.

CData Cloud

ThrowsKeyNotFound

Specifies whether or not throws an exception if there is no rows updated.

Data Type

bool

Default Value

false

Remarks

Specifies whether or not throws an exception if there is no rows updated.

CData Cloud

Timeout

Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.

Data Type

int

Default Value

60

Remarks

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.

CData Cloud

WorkloadPoolId

The ID of your Workload Identity Federation pool.

Data Type

string

Default Value

""

Remarks

The ID of your Workload Identity Federation pool.

CData Cloud

WorkloadProjectId

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.

CData Cloud

WorkloadProviderId

The ID of your Workload Identity Federation pool provider.

Data Type

string

Default Value

""

Remarks

The ID of your Workload Identity Federation pool provider.

CData Cloud

Third Party Copyrights

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.

Copyright (c) 2026 CData Software, Inc. - All rights reserved.
Build 26.0.9770