Cloud

Build 25.0.9434
  • Google Calendar
    • Getting Started
      • Establishing a Connection
      • Creating a Custom OAuth App
      • OAuth Scopes and Endpoints
      • SSL Configuration
      • Firewall and Proxy
    • Data Model
      • Tables
        • AccessControlRules
        • AllCalendars
        • Calendars
        • EventsAttachments
        • MyCalendar
      • Views
        • Colors
        • UserSettings
      • Stored Procedures
        • GetAvailability
        • ImportEvent
        • MoveEvent
        • QuickAddEvent
        • StopWatchingResources
        • SubscribeToAclChanges
        • SubscribeToCalendarListChanges
        • SubscribeToEventChanges
        • SubscribeToSettingsChanges
      • 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
      • Connection
        • EventsScope
        • ShowDeleted
        • SupportsAllDrives
      • OAuth
        • OAuthClientId
        • OAuthClientSecret
        • DelegatedServiceAccounts
        • RequestingServiceAccount
      • JWT OAuth
        • OAuthJWTCert
        • OAuthJWTCertType
        • OAuthJWTCertPassword
        • OAuthJWTCertSubject
        • OAuthJWTIssuer
        • OAuthJWTSubject
      • SSL
        • SSLServerCert
      • Logging
        • Verbosity
      • Schema
        • BrowsableSchemas
      • Miscellaneous
        • AWSWorkloadIdentityConfig
        • AzureWorkloadIdentityConfig
        • MaxRows
        • PseudoColumns
        • Timeout
        • UseSimpleNames
        • WorkloadPoolId
        • WorkloadProjectId
        • WorkloadProviderId
    • Third Party Copyrights

Google Calendar - CData Cloud

Overview

CData Cloud offers access to Google Calendar 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 Calendar through CData Cloud.

CData Cloud allows you to standardize and configure connections to Google Calendar as though it were any other OData endpoint or standard SQL Server.

Key Features

  • Full SQL Support: Google Calendar 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 Calendar in CData Cloud, as well as information on the available resources, and a reference to the available connection properties.

Connecting to Google Calendar

Establishing a Connection shows how to authenticate to Google Calendar and configure any necessary connection properties to create a database in CData Cloud

Accessing Data from CData Cloud Services

Accessing data from Google Calendar 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 Calendar 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.

Authenticating to Google Calendar

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

The following sections discuss the available authentication schemes for Google Calendar:

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

User Accounts (OAuth)

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

Web Applications

When connecting via a Web application, you need to create and register a custom OAuth application with Google Calendar. 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: Set this to the Client Id in your application settings.
  • OAuthClientSecret: Set this to the Client Secret in your application settings.

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

  • InitiateOAuth: Set this to REFRESH.
  • OAuthClientId: Set this to the Client Id in your application settings.
  • OAuthClientSecret: Set this to the Client Secret in your application settings.
  • OAuthAccessToken: Set this to the access token returned by GetOAuthAccessToken.
  • OAuthRefreshToken: Set this to the refresh token returned by GetOAuthAccessToken.
  • OAuthSettingsLocation: Set this to 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: Set this to the Client Id in your application settings.
  • OAuthClientSecret: Set this to 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 driver to use OAuth with a user account on a headless machine, you need to 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 Calendar 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: Set to OFF.
      • OAuthClientId: Set to the client Id assigned when you registered your application.
      • OAuthClientSecret: Set to the client secret assigned when you registered your application.
      Then call the GetOAuthAuthorizationURL stored procedure with the appropriate CallbackURL. 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 need to 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: Set this to REFRESH.
  • OAuthVerifier: Set this to the verifier code.
  • OAuthClientId: (custom applications only) Set this to the Client Id in your custom OAuth application settings.
  • OAuthClientSecret: (custom applications only) Set this to 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 need to re-set the following properties to connect:

  • InitiateOAuth: Set this to REFRESH.
  • OAuthClientId: (custom applications only) Set this to the client Id assigned when you registered your application.
  • OAuthClientSecret: (custom applications only) Set this to the client secret assigned when you registered your application.
  • OAuthSettingsLocation: Set this to 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 need to create and install a connection with the driver on a device that supports an internet browser. Set the connection properties as described in "Desktop Applications" above.

After completing the instructions in "Desktop Applications", the resulting authentication values are encrypted and written to the location specified by OAuthSettingsLocation. The default filename is OAuthSettings.txt.

Once you have successfully tested the connection, copy the OAuth settings file to your headless machine.

On the headless machine, set the following connection properties to connect to data:

  • InitiateOAuth: Set this to REFRESH.
  • OAuthClientId: (custom applications only) Set this to the client Id assigned when you registered your application.
  • OAuthClientSecret: (custom applications only) Set this to the client secret assigned when you registered your application.
  • OAuthSettingsLocation: Set this to 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 Calendar 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 Calendar".)

However, you must create a custom OAuth application to connect to Google Calendar 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 Google Calendar API

Follow these steps to enable the Google Calendar 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 "Google Calendar API" and select Google Calendar API from the search results.
  4. On the Google Calendar API page, click ENABLE.

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

OAuth Scopes and Endpoints

Required Scopes and Endpoint Domains for Google Calendar

When integrating with Google Calendar, your application needs specific permissions to interact with the API.

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

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

Understanding Scopes

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

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

Required Scopes for Google Calendar

Scope Description
googleapis.com/auth/calendar While Google Calendar provides read-only scopes, the driver only surfaces the full one. This scope is required for full access to read and write permissions.
googleapis.com/auth/calendar.events This scope is required for read-only access.

Understanding Endpoint Domains

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

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

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

Required Endpoint Domains for Google Calendar

Domain Always Required Description
accounts.google.com TRUE The subdomain used for OAuth.
googleapis.com TRUE The domain used for accessing various services.

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 Calendar APIs as relational tables, views, and stored procedures. The Cloud uses the Google Calendar API to process supported filters. The Cloud processes other filters client-side within the Cloud.

Tables

The Cloud dynamically retrieves table definitions for the calendars accessible to your account. Tables describes the columns for a sample calendar as well as the Calendars table, which can be used to list, create, modify, and delete calendars.

Views

Views offer additional metadata information from Google Calendar to surface other aspects of a calendar.

Stored Procedures

Stored Procedures are function-like interfaces to the data source.

Key Features

Working with Event-related Entities

When working with events and their related entities through: EventsAttachments, AllCalendars, or dynamic event tables, only single events and recurring events (with their exceptions) are included by default, but not recurring event instances. To change this behavior, you can use EventsScope.

Note: Exceptions are recurring event instances that differ from their parent recurring event in any way.

Note: Single events are non-recurring events.

Working with Deleted Events

When working with events and their related entities through: EventsAttachments, AllCalendars, or dynamic event tables, deleted/canceled events are not included by default. To change this behavior, you can enable ShowDeleted or use the pseudo-column in the corresponding table/view. In that case, events with the status 'canceled' are included in the results. The value specified in the pseudo-column takes higher precedence than the value specified in ShowDeleted.

CData Cloud

Tables

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

CData Cloud - Google Calendar Tables

Name Description
AccessControlRules Create, update, delete, and query access control rules to calendars' resources.
AllCalendars Create, update, delete, and query all calendar events in your Google Account.
Calendars Create, update, delete, and query calendars in Google.
EventsAttachments Query the attachments metadata from the events in your Google calendar.
MyCalendar Create, update, delete, and query events of the calendar.

CData Cloud

AccessControlRules

Create, update, delete, and query access control rules to calendars' resources.

Table-Specific Information

Select

To query access control rules of all calendars you can execute a query as below.

SELECT * FROM [AccessControlRules]

The CalendarId, and Id and CalendarId (both specified at the same time) columns support server side filtering only for the = operator.

To query the access control rules of a certain calendar you will need to specify the CalendarId as a WHERE clause criterion.

SELECT * FROM [AccessControlRules] WHERE CalendarId = '[email protected]'

To query a specific access control rule of a certain calendar you will need to specify the CalendarId and Id as WHERE clause criteria.

SELECT * FROM [AccessControlRules] WHERE CalendarId = '[email protected]' AND Id = 'domain:cdatatest.page'

Insert

To add a new access control rule to a specific calendar, for example to share the calendar with a user, group or domain, or to make the calendar publicly available (ScopeType='default'), you will need to at least specify the CalendarId, Role, ScopeType and optionally the ScopeValue (required if you haven't specified the default ScopeType).

For example, to share a calendar with a specific user you can execute a query as below.

INSERT INTO [AccessControlRules] (CalendarId, Role, ScopeType, ScopeValue) VALUES ('[email protected]', 'writer', 'user', '[email protected]')

For example, to share a calendar with a specific domain you can execute a query as below.

INSERT INTO [AccessControlRules] (calendarId, Role, ScopeType, ScopeValue, SendNotification) VALUES ('[email protected]', 'writer', 'domain', 'cdatatest.page', 'true')

Note: Sharing a calendar with a user no longer automatically inserts the calendar into their CalendarList. If the user should be able to perform CRUD operations on the shared calendar, they will need to execute an INSERT statement by specifying at least the existing CalendarId in the statement. For more information, refer to the Calendars table section.

Update

To update an access control rule of a specific calendar, you will need to specify the CalendarId along with the Id in the WHERE clause criteria.

UPDATE [AccessControlRules] SET Role = 'writer', ScopeType = 'user' WHERE Id = 'user:[email protected]' AND CalendarId = '[email protected]'

Delete

To delete an access control rule from a specific calendar, you will need to specify the CalendarId along with the Id in the WHERE clause criteria.

DELETE FROM [AccessControlRules] WHERE Id = 'user:[email protected]' AND CalendarId = '[email protected]'

Columns

Name Type ReadOnly Description
CalendarId [KEY] String False

The calendar identifier.

Id [KEY] String True

The identifier of the ACL rule.

Etag String True

The ETag of the resource.

Kind String True

The type of the resource.

Role String False

The role assigned to the scope. Possible values are: none, freeBusyReader, reader, writer and owner.

ScopeType String False

The type of the scope. Possible values are: default, user, group and domain.

ScopeValue String False

The email address of a user or group, or the name of a domain, depending on the scope type. Not applicable for type 'default'.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
SendNotification String

This value sets whether or not to send notifications about the calendar sharing change.

The default value is True.

CData Cloud

AllCalendars

Create, update, delete, and query all calendar events in your Google Account.

Table-Specific Information

This is an example on how all calendar events in your account are exposed in a single table.

Select

Query events of all calendars.

SELECT * FROM [AllCalendars]

Insert

Create a new event in a certain calendar. At least StartDateTime, EndDateTime and CalendarId must be specified.

INSERT INTO [AllCalendars] (Summary, Description, StartDateTime, EndDateTime, CalendarId) VALUES ('Great Event', 'Description for event', '8/27/2017', '8/28/2017', '[email protected]')

You can create an All-Day event by setting the StartDate and EndDate columns to the actual start and end dates of the event.

INSERT INTO [AllCalendars] (Summary, Description, StartDate, EndDate, CalendarId) VALUES ('Google Cal Test Event 1', 'Example All Day Event', '2017-01-01', '2017-01-09', '[email protected]')

You can create a Time Limited event by setting the StartDateTime and EndDateTime columns to the actual start and end dates and times of the event.

INSERT INTO [AllCalendars] (Summary, Description, StartDateTime, EndDateTime, CalendarId) VALUES ('Google Cal Test Event 2', 'Example Time Limited Event', '2017-09-05T22:13:03', '2017-09-11T13:24:10', '[email protected]')

Update

Update details of a specific event. At least the Id of the event being updated must be specified.

UPDATE AllCalendars SET Summary = 'Test Event' WHERE id = '6bjelf33p0al4d8ei5ft5ghqjs' AND CalendarId = '[email protected]'

You can update a Time Limited event to an All-Day one by setting the StartDate and EndDate columns to the actual start and end dates of the event, and the StartDateTime and EndDateTime columns to Null-s.

UPDATE [AllCalendars] SET StartDate = '2017-09-05', EndDate = '2017-09-11', StartDateTime = NULL, EndDateTime = NULL WHERE Id = '8ba774m3anenroqcepfi7ka6ok' AND CalendarId = '[email protected]'

You can update an All-Day event to a Time Limited one by setting the StartDateTime and EndDateTime columns to the actual start and end dates and times of the event, and the StartDate and EndDate columns to Null-s.

UPDATE [AllCalendars] SET StartDate = NULL, EndDate = NULL, StartDateTime = '2017-09-05T22:13:03', EndDateTime = '2017-09-11T13:24:10' WHERE Id = '8ba774m3anenroqcepfi7ka6ok' AND CalendarId = '[email protected]'

Delete

Delete an event from AllCalendars by specifying at least its Id.

DELETE FROM [AllCalendars] WHERE Id = '8ba774m3anenroqcepfi7ka6ok' AND CalendarId = '[email protected]'

Order Events

When you query from AllCalendars table, the events will not be ordered by the StartDate, but rather by the CalendarId. You can order the calendars by either the StartDate or StartDateTime column, depending if the event is an AllDayEvent or not. Alternatively, you can order both Event types using the example query below.

SELECT CalendarId, Id, Summary, 
CASE 
     WHEN StartDateTime IS NULL THEN startDate 
     ELSE StartDateTime 
END AS EventDate 
FROM AllCalendars ORDER BY EventDate ASC

Columns

Name Type ReadOnly Description
Id [KEY] String True

The Id of the event.

CalendarId String False

Calendar Id. This can be used to override the Calendar Id for which you are querying events.

Summary String False

The title of the event.

Description String False

The description of the event.

Location String False

The geographic location of the event as free-form text.

AllDayEvent Boolean True

This value indicates whether or not the event is an all-day event.

StartDate Date False

The start date if this is an all-day event.

StartDateTime Datetime False

The (inclusive) start time of the event. For a recurring event, this value is the start time of the first instance.

StartDateTimeZone String False

The time zone in which the start date time is specified.

EndDate Date False

The end date if this is an all-day event.

EndDateTime Datetime False

The (exclusive) end time of the event. For a recurring event, this value is the end time of the first instance.

EndDateTimeZone String False

The time zone in which the end date time is specified.

OriginalStartTimeDateTime Datetime False

For an instance of a recurring event, this value is the time when the event would start according to the recurrence data in the recurring event identified by RecurringEventId.

SendNotification Boolean False

This value sets whether to send a notification when performing an insert or update.

Kind String True

The type of the resource, returned in the format calendar#event.

ETag String True

The ETag of the resource.

Status String False

The status of the event.

HTML_Link String True

The absolute link to the event in the Google Calendar Web UI.

Locked Boolean True

Whether this is a locked event copy where no changes can be made to the main event fields 'summary', 'description', 'location', 'start', 'end' or 'recurrence'. The default is False.

SourceTitle String False

Title of the source; for example a title of a web page or an email subject.

SourceURL String False

URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.

HangoutLink String True

An absolute link to the Google+ hangout associated with this event, if there is any.

Created Datetime True

The creation time of the event.

Updated Datetime True

The latest modification time of the event.

ColorId Integer False

The color of the event. This value is an Id referring to an entry in the event section of the colors definitions.

CreatorEmail String True

The creator's email address, if available.

CreatorDisplayName String True

The creator's name, if available.

OrganizerEmail String True

The organizer's email address, if available.

OrganizerDisplayName String True

The organizer's name, if available.

Recurrences String False

A pipe-separated list of RRULE, EXRULE, RDATE, and EXDATE lines for a recurring event. This field is omitted for single events or instances of recurring events. OriginalStartTimeDateTime must be set in order to modify this value.

RecurringEventId String True

For an instance of a recurring event, this value is the event Id of the recurring event itself.

Transparency String False

This value sets whether the event blocks time on the calendar. If set to transparent, the event does not block time on the calendar. If set to opaque, the event blocks time; this is the default value.

Visibility String False

The visibility of the event.

The allowed values are default, public, private, confidential.

ICalUid String True

The event Id in the iCalendar format.

Sequence String False

The sequence number as per iCalendar.

AttendeesEmails String False

A comma-separated list of attendee's email addresses, if available.

AttendeesDisplayNames String False

A comma-separated list of attendee's names, if available.

AttendeesResponseStatus String False

A comma-separated list of attendee's response status, if available.

AttendeesOptional String False

A comma-separated list of whether the attendee's are optional, if available.

AttendeesOmitted Boolean True

This field sets whether attendees have been omitted from the event's representation. When updating an event, this field can be used to update only the participant's response. When retrieving an event, the attendees that are returned are restricted to only the participant by the MaxAttendees query parameter.

ExtendedPropertiesPrivateKey String False

This field contains properties that are private to the copy of the event that appears on the calendar.

ExtendedPropertiesPrivateValue String False

This field contains properties that are private to the copy of the event that appears on the calendar.

ExtendedPropertiesSharedKey String False

This field contains properties that are shared between copies of the event on other attendees' calendars.

ExtendedPropertiesSharedValue String False

This field contains properties that are shared between copies of the event on other attendees' calendars.

GuestsCanInviteOthers Boolean False

This value sets whether attendees other than the organizer can invite others to the event.

GuestsCanSeeOtherGuests Boolean False

This value sets whether attendees other than the organizer can see who the event's attendees are.

GuestsCanModify Boolean False

Whether attendees other than the organizer can modify the event.

PrivateCopy Boolean True

This value sets whether this is a private event copy where changes are not shared with other copies on other calendars.

RemindersUseDefault Boolean False

This value sets whether the default reminders of the calendar apply to the event.

ReminderOverrideMethods String False

A comma-separated list of the methods used by the reminder. The possible values are EMAIL, SMS, and POPUP.

ReminderOverrideMinutes String False

A comma-separated list of the minutes before the start of the event when the corresponding ReminderOverrideMethod should trigger.

ConferenceId String False

The ID of the conference. Can be used by developers to keep track of conferences, should not be displayed to users.

ConferenceNotes String False

Additional notes (such as instructions from the domain administrator, legal notices) to display to the user. Can contain HTML. The maximum length is 2048 characters.

ConferenceSignature String False

The signature of the conference data. Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.

ConferenceSolutionName String False

The user-visible name of this solution. Not localized.

ConferenceSolutionKeyType String False

The conference solution type. If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications. Valid values are: (1) 'eventHangout' for Hangouts for consumers (http://hangouts.google.com) -- (2) 'eventNamedHangout' for classic Hangouts for G Suite users (http://hangouts.google.com) -- (3) 'hangoutsMeet' for Hangouts Meet (http://meet.google.com) -- (4) 'addOn' for 3P conference providers.

The allowed values are eventHangout, eventNamedHangout, hangoutsMeet, addOn.

ConferenceSolutionIconUri String False

The user-visible icon for this solution.

ConferenceRequestId String False

The client-generated unique ID for this request. Clients should regenerate this ID for every new request. If an ID provided is the same as for the previous request, the request is ignored.

ConferenceRequestKey String False

The conference solution, such as Hangouts or Hangouts Meet.

ConferenceRequestKeyType String False

The conference solution type. If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications. Valid values are: (1) 'eventHangout' for Hangouts for consumers (http://hangouts.google.com) -- (2) 'eventNamedHangout' for classic Hangouts for G Suite users (http://hangouts.google.com) -- (3) 'hangoutsMeet' for Hangouts Meet (http://meet.google.com) -- (4) 'addOn' for 3P conference providers.

ConferenceRequestStatus String False

The status of the conference create request.

ConferenceRequestStatusCode String True

The current status of the conference create request. The possible values are: (1) 'pending': the conference create request is still being processed. -- (2) 'success': the conference create request succeeded, the entry points are populated. -- (3) 'failure': the conference create request failed, there are no entry points.

ConferenceEntryPointsAggregate String False

Information about individual conference entry points, such as URLs or phone numbers. All of them must belong to the same conference.

EventType String False

Specific type of the event. Read-only. Possible values are: 'default' - A regular event or not further specified. 'outOfOffice' - An out-of-office event. 'focusTime' - A focus-time event. 'workingLocation' - A working-location event.

WorkingLocationType String False

Type of working location. Required when creating a workingLocation Event.

The allowed values are homeOffice, officeLocation, customLocation.

HomeOffice String False

Specifies that the user is working from home.

CustomLocationLabel String False

The label of the custom location where the user is working from.

OfficeLocationBuildingId String False

References the the building ID in the organization's Resources database.

OfficeLocationDeskId String False

The office desk identifier.

OfficeLocationFloorId String False

The office floor identifier.

OfficeLocationFloorSectionId String False

the office section floor identifier.

OfficeLocationLabel String False

The office name that's displayed in Calendar Web and Mobile Clients.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
SearchTerms String

Free text search terms to find events that match these terms in any field, except for extended properties.

ShowDeleted Boolean

Whether to list cancelled events.

CData Cloud

Calendars

Create, update, delete, and query calendars in Google.

Table-Specific Information

Select

When selecting calendars no fields are required. In addition an Id can be specified for filtering the result. For example:

SELECT Id, Summary, Description FROM Calendars

Insert

To insert a new calendar, issue an INSERT statement and specify a value for at least the Summary column. For example:

INSERT INTO Calendars (Summary) VALUES ('My Custom Calendar')

To insert an existing calendar, a shared one or a global/domain public one, into the user's calendars list, you will need to execute an INSERT statement by specifying at least the existing CalendarId in the statement.

For example, to add a shared calendar from a specific user, you can execute a query as below.

INSERT INTO Calendars (Id) VALUES ('[email protected]')

For example, to add a public calendar, you can execute a query as below.

INSERT INTO Calendars (id, SummaryOverride) VALUES ('en.usa#[email protected]', 'Official Holidays in the US')

Update

To update a calendar, the Id column must be specified. Only the Description, Location, Summary, and Timezone columns are updateable. For example:

UPDATE Calendars SET Description = 'Updated Description' WHERE Id = '8ba774m3anenroqcepfi7ka6ok'

Delete

Delete a calendar by specifying its Id. For example:

DELETE FROM Calendars WHERE Id = '123456789'

Columns

Name Type ReadOnly Description
Id [KEY] String False

The calendar identifier.

Summary String False

The title of the calendar.

Description String False

The description of the calendar.

Kind String True

The type of the resource.

ETag String True

The ETag of the resource.

Location String False

The geographic location of the calendar as free-form text.

Timezone String False

The time zone of the calendar.

SummaryOverride String False

The summary that the authenticated user has set for the calendar.

ColorId Integer False

The color of the calendar. This is an Id referring to an entry in the 'calendar' section of the colors definition.

Hidden Boolean False

This field sets whether the calendar has been hidden from the list.

Selected Boolean False

This field sets whether the calendar content shows up in the calendar UI.

AccessRole String True

The effective access role that the authenticated user has on the calendar.

ReminderMethods String False

A semicolon-separated list of the methods used by the reminder. Possible values are: EMAIL, SMS, and POPUP.

ReminderMinutes String False

A semicolon-separated list of minutes before the start of the event when the corresponding ReminderOverrideMethod should trigger.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
showHidden String

This value sets whether to show hidden calendars.

The default value is False.

CData Cloud

EventsAttachments

Query the attachments metadata from the events in your Google calendar.

Table-Specific Information

Select

To query attachments metadata of all events in a certain calendar, you must specify the CalendarId the WHERE clause.

SELECT * FROM EventsAttachments WHERE CalendarId = 'df5bf39459e666e1f6835a287923a083f83bfbe21113051b2759a9f2fa40a7c9@group.calendar.google.com'

To query attachments metadata for only a specific recurring event in a certain calendar, you must specify the CalendarId and the ParentEventId (the recurring event's Id) in the WHERE clause.

SELECT * FROM EventsAttachments WHERE CalendarId = 'df5bf39459e666e1f6835a287923a083f83bfbe21113051b2759a9f2fa40a7c9@group.calendar.google.com' AND ParentEventId = '4fbitolj1eb2ilbspcm2l5jcvc'

To query attachments metadata of all events in multiple calendars, you must specify their CalendarIds in the IN clause.

SELECT * FROM EventsAttachments WHERE CalendarId IN ('df5bf39459e666e1f6835a287923a083f83bfbe21113051b2759a9f2fa40a7c9@group.calendar.google.com', '8aab717ee7e6fca501e1e178e590f3ac4ac0c2660361fdff47b8c341eb379559@group.calendar.google.com')

Columns

Name Type ReadOnly Description
CalendarId String False

The calendar identifier.

EventId [KEY] String False

The event identifier.

ParentEventId String True

The event instance identifier of a recurring event instance.

EventStatus String True

The status of the event.

FileId String True

The Google Drive file identifier of the attachment, if the attachment is located in a GoogleDrive.

FileURL [KEY] String False

The URL link to the attachment.

Title String False

The name of the attachment.

MimeType String False

The internet media type (MIME type) of the attachment.

IconLink String True

The URL link to the attachment's icon.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ShowDeleted Boolean

Indicates whether to list cancelled events.

CData Cloud

MyCalendar

Create, update, delete, and query events of the calendar.

Table-Specific Information

This is an example on how a calendar is exposed as table.

Select

Query events of the specified calendar.

SELECT * FROM [MyCalendar]

Insert

Create a new event in the calendar. At least StartDateTime and EndDateTime must be specified.

INSERT INTO [MyCalendar] (Summary, Description, StartDateTime, EndDateTime) VALUES ('Great Event', 'Description for event', '8/27/2017', '8/28/2017')

You can create an All-Day event by setting the StartDate and EndDate columns to the actual start and end dates of the event.

INSERT INTO [MyCalendar] (Summary, Description, StartDate, EndDate) VALUES ('Google Cal Test Event 1', 'Example All Day Event', '2017-01-01', '2017-01-09')

You can create a Time Limited event by setting the StartDateTime and EndDateTime columns to the actual start and end dates and times of the event.

INSERT INTO [MyCalendar] (Summary, Description, StartDateTime, EndDateTime) VALUES ('Google Cal Test Event 2', 'Example Time Limited Event', '2017-09-05T22:13:03', '2017-09-11T13:24:10')

When inserting a new event, multiple values can be specified for AttendeesEmails and AttendeesDisplayNames.

INSERT INTO [MyCalendar] (StartDateTime, EndDateTime, AttendeesEmails) VALUES ('2017-03-15 15:00', '2017-03-15 20:00', '[email protected],[email protected]')

Update

Update details of a specific event. The Id of the event being updated must be specified.

UPDATE [MyCalendar] SET Summary = 'Updated Summary 2' WHERE Id = '8ba774m3anenroqcepfi7ka6ok'

You can update a Time Limited event to an All-Day one by setting the StartDate and EndDate columns to the actual start and end dates of the event, and the StartDateTime and EndDateTime columns to Null-s.

UPDATE [MyCalendar] SET StartDate = '2017-09-05', EndDate = '2017-09-11', StartDateTime = NULL, EndDateTime = NULL WHERE Id = '8ba774m3anenroqcepfi7ka6ok'

You can update an All-Day event to a Time Limited one by setting the StartDateTime and EndDateTime columns to the actual start and end dates and times of the event, and the StartDate and EndDate columns to Null-s.

UPDATE [MyCalendar] SET StartDate = NULL, EndDate = NULL, StartDateTime = '2017-09-05T22:13:03', EndDateTime = '2017-09-11T13:24:10' WHERE Id = '8ba774m3anenroqcepfi7ka6ok'

Delete

Delete an event by specifying its Id.

DELETE FROM [MyCalendar] WHERE Id = '8ba774m3anenroqcepfi7ka6ok'

Columns

Name Type ReadOnly Description
Id [KEY] String True

The Id of the event.

CalendarId String False

Calendar Id. This can be used to override the Calendar Id for which you are querying events.

Summary String False

The title of the event.

Description String False

The description of the event.

Location String False

The geographic location of the event as free-form text.

AllDayEvent Boolean True

This value indicates whether or not the event is an all-day event.

StartDate Date False

The start date if this is an all-day event.

StartDateTime Datetime False

The (inclusive) start time of the event. For a recurring event, this value is the start time of the first instance.

StartDateTimeZone String False

The time zone in which the start date time is specified.

EndDate Date False

The end date if this is an all-day event.

EndDateTime Datetime False

The (exclusive) end time of the event. For a recurring event, this value is the end time of the first instance.

EndDateTimeZone String False

The time zone in which the end date time is specified.

OriginalStartTimeDateTime Datetime False

For an instance of a recurring event, this value is the time when the event would start according to the recurrence data in the recurring event identified by RecurringEventId.

SendNotification Boolean False

This value sets whether to send a notification when performing an insert or update.

Kind String True

The type of the resource, returned in the format calendar#event.

ETag String True

The ETag of the resource.

Status String False

The status of the event.

HTML_Link String True

The absolute link to the event in the Google Calendar Web UI.

Locked Boolean True

Whether this is a locked event copy where no changes can be made to the main event fields

SourceTitle String False

Title of the source; for example a title of a web page or an email subject.

SourceURL String False

URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.

HangoutLink String True

An absolute link to the Google+ hangout associated with this event, if there is any.

Created Datetime True

The creation time of the event.

Updated Datetime True

The latest modification time of the event.

ColorId Integer False

The color of the event. This value is an Id referring to an entry in the event section of the colors definitions.

CreatorEmail String True

The creator's email address, if available.

CreatorDisplayName String True

The creator's name, if available.

OrganizerEmail String True

The organizer's email address, if available.

OrganizerDisplayName String True

The organizer's name, if available.

Recurrences String False

A pipe-separated list of RRULE, EXRULE, RDATE, and EXDATE lines for a recurring event. This field is omitted for single events or instances of recurring events. OriginalStartTimeDateTime must be set in order to modify this value.

RecurringEventId String True

For an instance of a recurring event, this value is the event Id of the recurring event itself.

Transparency String False

This value sets whether the event blocks time on the calendar. If set to transparent, the event does not block time on the calendar. If set to opaque, the event blocks time; this is the default value.

Visibility String False

The visibility of the event.

ICalUid String True

The event Id in the iCalendar format.

Sequence String False

The sequence number as per iCalendar.

AttendeesEmails String False

A comma-separated list of attendee's email addresses, if available.

AttendeesDisplayNames String False

A comma-separated list of attendee's names, if available.

AttendeesResponseStatus String False

A comma-separated list of attendee's response status, if available.

AttendeesOmitted Boolean True

This field sets whether attendees have been omitted from the event's representation. When updating an event, this field can be used to update only the participant's response. When retrieving an event, the attendees that are returned are restricted to only the participant by the MaxAttendees query parameter.

ExtendedPropertiesPrivateKey String False

This field contains properties that are private to the copy of the event that appears on the calendar.

ExtendedPropertiesPrivateValue String False

This field contains properties that are private to the copy of the event that appears on the calendar.

ExtendedPropertiesSharedKey String False

This field contains properties that are shared between copies of the event on other attendees' calendars.

ExtendedPropertiesSharedValue String False

This field contains properties that are shared between copies of the event on other attendees' calendars.

GuestsCanInviteOthers Boolean False

This value sets whether attendees other than the organizer can invite others to the event.

GuestsCanSeeOtherGuests Boolean False

This value sets whether attendees other than the organizer can see who the event's attendees are.

GuestsCanModify Boolean False

Whether attendees other than the organizer can modify the event.

PrivateCopy Boolean True

This value sets whether this is a private event copy where changes are not shared with other copies on other calendars.

RemindersUseDefault Boolean False

This value sets whether the default reminders of the calendar apply to the event.

ReminderOverrideMethods String False

A comma-separated list of the methods used by the reminder. The possible values are EMAIL, SMS, and POPUP.

ReminderOverrideMinutes String False

A comma-separated list of the minutes before the start of the event when the corresponding ReminderOverrideMethod should trigger.

ConferenceId String False

The ID of the conference. Can be used by developers to keep track of conferences, should not be displayed to users.

ConferenceNotes String False

Additional notes (such as instructions from the domain administrator, legal notices) to display to the user. Can contain HTML. The maximum length is 2048 characters.

ConferenceSignature String False

The signature of the conference data. Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.

ConferenceSolutionName String False

The user-visible name of this solution. Not localized.

ConferenceSolutionKeyType String False

The conference solution type. If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications. Valid values are: (1) 'eventHangout' for Hangouts for consumers (http://hangouts.google.com) -- (2) 'eventNamedHangout' for classic Hangouts for G Suite users (http://hangouts.google.com) -- (3) 'hangoutsMeet' for Hangouts Meet (http://meet.google.com) -- (4) 'addOn' for 3P conference providers.

ConferenceSolutionIconUri String False

The user-visible icon for this solution.

ConferenceRequestId String False

The client-generated unique ID for this request. Clients should regenerate this ID for every new request. If an ID provided is the same as for the previous request, the request is ignored.

ConferenceRequestKey String False

The conference solution, such as Hangouts or Hangouts Meet.

ConferenceRequestKeyType String False

The conference solution type. If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications. Valid values are: (1) 'eventHangout' for Hangouts for consumers (http://hangouts.google.com) -- (2) 'eventNamedHangout' for classic Hangouts for G Suite users (http://hangouts.google.com) -- (3) 'hangoutsMeet' for Hangouts Meet (http://meet.google.com) -- (4) 'addOn' for 3P conference providers.

ConferenceRequestStatus String False

The status of the conference create request.

ConferenceRequestStatusCode String True

The current status of the conference create request. The possible values are: (1)

ConferenceEntryPointsAggregate String False

Information about individual conference entry points, such as URLs or phone numbers. All of them must belong to the same conference.

EventType String False

Specific type of the event. Read-only. Possible values are: 'default' - A regular event or not further specified. 'outOfOffice' - An out-of-office event. 'focusTime' - A focus-time event. 'workingLocation' - A working-location event.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
SearchTerms String

Free text search terms to find events that match these terms in any field, except for extended properties.

ShowDeleted Boolean

Whether to list canceled events.

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 Calendar Views

Name Description
Colors Query colors for Google calendars and events.
UserSettings User settings for a calendar.

CData Cloud

Colors

Query colors for Google calendars and events.

Table-Specific Information

Select

Returns the color definitions for calendars and events.

SELECT * FROM Colors

Columns

Name Type Description
Id [KEY] String The unique color identifier composed of the color type and Id separated by the pipe character.
EntityType [KEY] String The type of the entity the color is specified for. It can be either Calendar or Event
ColorBackground String The background color for the calendar color.
ColorForeground String The foreground color for the calendar color.
Updated Datetime The last time the list of colors was updated.

CData Cloud

UserSettings

User settings for a calendar.

Columns

Name Type Description
Id [KEY] String The ID of the user setting.
Value String The value of the user setting.
ETag String ETag of the resource.
Kind String Type of the resource ('calendar#setting').

CData Cloud

Stored Procedures

Stored procedures are function-like interfaces that extend the functionality of the Cloud beyond simple SELECT/INSERT/UPDATE/DELETE operations with Google Calendar.

Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Google Calendar, along with an indication of whether the procedure succeeded or failed.

CData Cloud - Google Calendar Stored Procedures

Name Description
GetAvailability Queries the free/busy information for one or more calendars using the FreeBusy: query API.
ImportEvent Imports an event into a calendar.
MoveEvent Moves an event from one calendar to another using the Google Calendar Events.move API.
QuickAddEvent Creates a Google Calendar event based on a simple text string.
StopWatchingResources Stops receiving notifications for a given channel.
SubscribeToAclChanges Starts watching for changes to the access control list (ACL) of a calendar.
SubscribeToCalendarListChanges Starts watching for changes in the user's calendar list.
SubscribeToEventChanges Starts watching for changes to events on a calendar.
SubscribeToSettingsChanges Starts watching for changes to the authenticated user's calendar settings.

CData Cloud

GetAvailability

Queries the free/busy information for one or more calendars using the FreeBusy: query API.

Input

Name Type Required Description
TimeMin Datetime True The start of the interval for the query (RFC3339 timestamp).
TimeMax Datetime True The end of the interval for the query (RFC3339 timestamp).
EntityIds String True Comma-separated list of identifiers of a calendars and/or groups to query.
CalendarExpansionMax Integer False Maximal number of calendars for which FreeBusy information is to be provided. Maximum value is 50.
GroupExpansionMax Integer False Maximal number of calendar identifiers to be provided for a single group. Maximum value is 100.

Result Set Columns

Name Type Description
EntityId String The identifier of the calendar or group.
BusyStartTime Datetime Indicates the start time of the busy period.
BusyEndTime Datetime Indicates the end time of the busy period.

CData Cloud

ImportEvent

Imports an event into a calendar.

Execute

Imports a single event into a Google Calendar using the Events.import API.

Basic usage example with common fields:

EXEC ImportEvent
CalendarId = 'primary',
ICalUID = 'external-uid-12345',
Summary = 'Team Sync',
Status = 'confirmed',
StartDateTime = '2025-09-10T09:00:00Z',
StartDateTimeZone = 'UTC',
EndDateTime = '2025-09-10T10:00:00Z',
EndDateTimeZone = 'UTC',
Description = 'Weekly sync up',
Location = 'Room 101'

You can also specify Recurrences (pipe-separated RRULE|EXRULE|RDATE|EXDATE lines), SourceTitle/SourceUrl, visibility and other standard event fields as documented in the input list.

Aggregate inputs: JSON array or #TEMP table

The following inputs support either a JSON array literal or a temporary table reference (use the special table suffixed with #Temp and pass its name as the input value). This enables bulk/aggregate inserts:

ReminderOverrides

Only used when RemindersUseDefault = 'false'. Each override defines one reminder:

  • Method ('email'|'popup')
  • Minute (integer minutes before start; 0-40320)

Maximum of 5 overrides.

Option A: JSON array

EXEC ImportEvent
CalendarId = 'primary',
ICalUID = 'uid-rem-1',
Summary = 'With Custom Reminders',
Status = 'confirmed',
StartDateTime = '2025-11-20T15:00:00Z',
EndDateTime = '2025-11-20T16:00:00Z',
RemindersUseDefault = 'false',
ReminderOverrides = '[{"method":"email","minutes":30},{"method":"popup","minutes":10}]'

Option B: #TEMP table

INSERT INTO EventReminders#Temp(Method, Minute) VALUES ('email', 30);
INSERT INTO EventReminders#Temp(Method, Minute) VALUES ('popup', 10);
EXEC ImportEvent
CalendarId = 'primary',
ICalUID = 'uid-rem-2',
Summary = 'With Custom Reminders (Temp)',
Status = 'confirmed',
StartDateTime = '2025-11-20T15:00:00Z',
EndDateTime = '2025-11-20T16:00:00Z',
RemindersUseDefault = 'false',
ReminderOverrides = 'EventReminders#Temp'

Attendees

Each attendee must at least include an Email. Optional columns: DisplayName, Comment, Optional, AdditionalGuests, Resource, ResponseStatus ('needsAction'|'declined'|'tentative'|'accepted'), Organizer.

Option A: JSON array

EXEC ImportEvent
CalendarId = 'primary',
ICalUID = 'uid-att-1',
Summary = 'Event With Attendees',
Status = 'confirmed',
StartDateTime = '2025-12-01T10:00:00Z',
EndDateTime = '2025-12-01T11:00:00Z',
Attendees = '[
{"email":"[email protected]","displayName":"Alice"},
{"email":"[email protected]","optional":true}
]'

Option B: #TEMP table

INSERT INTO EventAttendees#Temp(DisplayName, Email, Comment, Optional, AdditionalGuests, Resource, ResponseStatus, Organizer)
VALUES ('Alice', '[email protected]', 'Project lead', false, 0, false, 'accepted', false);
INSERT INTO EventAttendees#Temp(DisplayName, Email, Optional)
VALUES ('Bob', '[email protected]', true);
EXEC ImportEvent
CalendarId = 'primary',
ICalUID = 'uid-att-2',
Summary = 'Event With Attendees (Temp)',
Status = 'confirmed',
StartDateTime = '2025-12-01T10:00:00Z',
EndDateTime = '2025-12-01T11:00:00Z',
Attendees = 'EventAttendees#Temp'

Conference Data

Conference details require ConferenceDataVersion = '1'.

A) Create a new conference (Google Meet)

EXEC ImportEvent
CalendarId = 'primary',
ICalUID = 'uid-conf-new',
Summary = 'Meet With Team',
Status = 'confirmed',
StartDateTime = '2025-12-10T14:00:00Z',
EndDateTime = '2025-12-10T15:00:00Z',
ConferenceDataVersion = '1',
ConferenceDataCreateNewRequest = 'true',
ConferenceDataConferenceSolutionType = 'hangoutsMeet'

B) Use existing conference data

Provide available ConferenceData fields (ConferenceDataConferenceId, ConferenceDataNotes, ConferenceDataSignature, ConferenceDataConferenceSolutionType, ConferenceDataConferenceSolutionIconUri, ConferenceDataConferenceSolutionName) and at least one ConferenceDataEntryPoints item, via JSON or #TEMP table.

EntryPoints JSON array example:

EXEC ImportEvent
CalendarId = 'primary',
ICalUID = 'uid-conf-existing',
Summary = 'Join Existing Conference',
Status = 'confirmed',
StartDateTime = '2025-12-15T09:00:00Z',
EndDateTime = '2025-12-15T10:00:00Z',
ConferenceDataVersion = '1',
ConferenceDataConferenceId = 'aaa-bbbb-ccc',
ConferenceDataConferenceSolutionType = 'hangoutsMeet',
ConferenceDataConferenceSolutionName = 'Google Meet',
ConferenceDataEntryPoints = '[{"entryPointType":"video","label":"meet","meetingCode":"aaa-bbbb-ccc","uri":"https://meet.google.com/aaa-bbbb-ccc"}]'
 

EntryPoints #TEMP table example (ConferenceDataEntryPoints#Temp)

Columns: AccessCode, EntryPointType, Label, MeetingCode, Passcode, Password, PIN, URI.

 INSERT INTO ConferenceDataEntryPoints#Temp(EntryPointType, Label, MeetingCode, Uri)
 VALUES ('video', 'Google Meet', 'aaa-bbbb-ccc', 'https://meet.google.com/aaa-bbbb-ccc');
 EXEC ImportEvent
 CalendarId = 'primary',
 ICalUID = 'uid-conf-existing-2',
 Summary = 'Join Existing Conference (Temp)',
 Status = 'confirmed',
 StartDateTime = '2025-12-15T09:00:00Z',
 EndDateTime = '2025-12-15T10:00:00Z',
 ConferenceDataVersion = '1',
 ConferenceDataConferenceId = 'aaa-bbbb-ccc',
 ConferenceDataConferenceSolutionType = 'hangoutsMeet',
 ConferenceDataConferenceSolutionName = 'Google Meet',
 ConferenceDataEntryPoints = 'ConferenceDataEntryPoints#Temp'

Attachments

Provide a pipe-separated list of file URLs in AttachmentsFileUrls. To include attachments in responses, set SupportsAttachments = 'true'.

EXEC ImportEvent
CalendarId = 'primary',
ICalUID = 'uid-attch-ps',
Summary = 'Event With Attachments',
Status = 'confirmed',
StartDateTime = '2025-12-05T09:00:00Z',
EndDateTime = '2025-12-05T09:30:00Z',
SupportsAttachments = 'true',
AttachmentsFileUrls = 'https://example.com/file1|https://docs.google.com/document/d/1Abc...'
 

Full example combining multiple inputs


EXEC ImportEvent
CalendarId = 'primary',
ICalUID = 'test-uid-1757601360956',
Summary = 'Test Event',
Status = 'confirmed',
ConferenceDataVersion = '1',
SupportsAttachments = 'true',
Visibility = 'default',
Transparency = 'opaque',
Description = 'Automated test description',
Location = 'Test Location',
ColorId = '1',
AttendeesOmitted = 'false',
GuestsCanInviteOthers = 'true',
GuestsCanModify = 'false',
GuestsCanSeeOtherGuests = 'true',
Sequence = '0',
StartDateTime = '2025-09-10T09:00:00Z',
StartDateTimeZone = 'UTC',
EndDateTime = '2025-09-10T10:00:00Z',
EndDateTimeZone = 'UTC',
Recurrences = 'RRULE:FREQ=WEEKLY;BYDAY=MO,WE,FR;UNTIL=20251231T235959Z|EXRULE:FREQ=WEEKLY;BYDAY=FR;UNTIL=20251231T235959Z|RDATE:20251225T090000Z|EXDATE:20251224T090000Z',
RemindersUseDefault = 'false',
ReminderOverrides = 'EventReminders#Temp',
Attendees = 'EventAttendees#Temp',
AttachmentsFileUrls = 'https://example.com/file1|https://example.com/file2',
ConferenceDataCreateNewRequest = 'true',
ConferenceDataConferenceSolutionType = 'hangoutsMeet'
 

Temp table schemas

The following are the column schemas for the #Temp tables that can be passed to ImportEvent inputs. Create and populate them implicitly by inserting into TableName#Temp as shown in the examples above.

EventReminders#Temp (used by ReminderOverrides) schema info:

Column NameTypeRequiredDescription
Method string true The method used by this reminder.
Minute string true Number of minutes before the start of the event when the reminder should trigger. Valid values are between 0 and 40320 (4 weeks in minutes).

EventAttendees#Temp (used by Attendees) schema info:

Column NameTypeRequiredDescription
DisplayName string false The attendee's name.
Email string true The attendee's email address, if available. This field must be present when adding an attendee. It must be a valid email address as per RFC5322. Required when adding an attendee.
Comment string false The attendee's response comment.
Optional boolean false Whether the attendee is optional.
AdditionalGuests integer false Number of additional guests.
Resource boolean false Whether the attendee is a resource.
ResponseStatus string false The attendee response status.
Organizer boolean false Whether the attendee is the organizer of the event.

ConferenceDataEntryPoints#Temp (used by ConferenceDataEntryPoints) schema info:

Column NameTypeRequiredDescription
AccessCode string false The access code to access the conference. When creating new conference data, populate only the subset of {MeetingCode, AccessCode, Passcode, Password, Pin} fields that match the terminology that the conference provider uses.
EntryPointType string true The type of the conference entry point.
Label string false The label for the URI. Visible to end users.
MeetingCode string false The meeting code to access the conference. When creating new conference data, populate only the subset of {MeetingCode, AccessCode, Passcode, Password, Pin} fields that match the terminology that the conference provider uses.
Passcode string false The passcode to access the conference. When creating new conference data, populate only the subset of {MeetingCode, AccessCode, Passcode, Password, Pin} fields that match the terminology that the conference provider uses.
Password string false The password to access the conference. When creating new conference data, populate only the subset of {MeetingCode, AccessCode, Passcode, Password, Pin} fields that match the terminology that the conference provider uses.
PIN string false The PIN to access the conference. When creating new conference data, populate only the subset of {MeetingCode, AccessCode, Passcode, Password, Pin} fields that match the terminology that the conference provider uses.
URI string true The URI of the entry point.

Input

Name Type Required Description
CalendarId String True The calendar identifier where the event will be imported.If you want to access the primary calendar of the currently logged in user, use the 'primary' keyword.
ConferenceDataVersion Integer False Version number indicating whether conference data should be included in the response.
SupportsAttachments Boolean False Whether API client supports event attachments. When true, event with attachments is returned; otherwise, attachments are stripped.
ICalUID String True Event unique identifier as defined in RFC5545.
Summary String False Title of the event.
Status String False Status of the event.
Visibility String False Visibility of the event.
Transparency String False Whether the event blocks time on the calendar.
Description String False Description of the event.
Location String False Geographic location of the event.
ColorId String False Color ID of the event.
Attendees String False The attendees of the event. Accepts only temporary table or JSON inputs.
AttachmentsFileUrls String False Pipe-Seperated list of attachments file urls.
AttendeesOmitted Boolean False Whether attendees may have been omitted from the event's representation.
GuestsCanInviteOthers Boolean False Whether attendees other than the organizer can invite others to the event.
GuestsCanModify Boolean False Whether attendees other than the organizer can modify the event.
GuestsCanSeeOtherGuests Boolean False Whether attendees other than the organizer can see who the event's attendees are.
Sequence Integer False Sequence number as per iCalendar.
StartDate Date False Start date (for all-day events).
StartDateTime String False Start date/time (RFC3339).
StartDateTimeZone String False Time zone of the start (e.g., 'UTC', 'America/New_York').
EndDate Date False End date (for all-day events).
EndDateTime String False End date/time (RFC3339).
EndDateTimeZone String False Time zone of the end.
Recurrences String False Pipe-separated List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event, as specified in RFC5545. Note that DTSTART and DTEND lines are not allowed in this field.
SourceTitle String False Title of the source; for example a title of a web page or an email subject.
SourceUrl String False URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.
RemindersUseDefault Boolean False Whether the calendar's default reminders apply.
ReminderOverrides String False If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event. The maximum number of override reminders is 5. Accepts only temporary table or JSON inputs.
OrganizeName String False The organizer name. If the organizer is also an attendee, this is indicated with a separate entry in attendees with the organizer field set to True.
OrganizerEmail String False The organizer's email address, if available. It must be a valid email address as per RFC5322.
ConferenceDataCreateNewRequest Boolean False Whether a new conference solution should be created, or an existing one should be used. If set to true only the ConferenceDataConferenceSolutionType will be considered of the Conference Data inputs.
ConferenceDataConferenceId String False The ID of the conference. The ID value is formed differently for each conference solution type: hangoutsMeet: ID is the 10-letter meeting code, for example aaa-bbbb-ccc. addOn: ID is defined by the third-party provider.
ConferenceDataNotes String False Additional notes to display to user.
ConferenceDataSignature String False The signature of the conference data. Generated on the server side.
ConferenceDataConferenceSolutionType String False The conference solution type.
ConferenceDataConferenceSolutionIconUri String False The user-visible icon for this solution.
ConferenceDataConferenceSolutionName String False The user-visible solution name.
ConferenceDataEntryPoints String False Information about individual conference entry points, such as URLs or phone numbers. All of them must belong to the same conference. Accepts only temporary table or JSON inputs.

Result Set Columns

Name Type Description
EventId String The identifier of the imported event.
Success String Indicates whether the operation was successful.

CData Cloud

MoveEvent

Moves an event from one calendar to another using the Google Calendar Events.move API.

Input

Name Type Required Description
CalendarId String True The source calendar identifier.
EventId String True The identifier of the event to move.
Destination String True The destination calendar identifier.
SendUpdates String False Guests who should receive notifications about the move.

Result Set Columns

Name Type Description
Success String Indicates whether the operation was successful.

CData Cloud

QuickAddEvent

Creates a Google Calendar event based on a simple text string.

Input

Name Type Required Description
CalendarId String True The calendar identifier.
Summary String True The text describing the event to be created.
SendUpdates String False Guests who should receive notifications about the creation of the new event.

Result Set Columns

Name Type Description
EventId String The identifier of the created event.
Success String Indicates whether the operation was successful.

CData Cloud

StopWatchingResources

Stops receiving notifications for a given channel.

Input

Name Type Required Description
ChannelId String True A UUID or unique string that identifies the notification channel.
ResourceId String True An opaque ID that identifies the resource being watched on this channel.

Result Set Columns

Name Type Description
Success String Indicates whether the operation was successful.

CData Cloud

SubscribeToAclChanges

Starts watching for changes to the access control list (ACL) of a calendar.

Input

Name Type Required Description
CalendarId String True The calendar identifier whose ACL to watch. Use 'primary' for the primary calendar of the authenticated user.
ChannelAddress String True The address where notifications of this channel will be delivered.
ChannelId String False A UUID or unique string that identifies the notification channel.
ChannelType String False Type of delivery mechanism for notifications. Valid values are 'web_hook' (or 'webhook').
ChannelToken String False Arbitrary string delivered to the target address with each notification. Used for validation.
ChannelTimeToLive String False The lifetime of the channel in seconds .

Result Set Columns

Name Type Description
Success String Indicates whether the operation was successful.
ChannelId String The UUID or the unique string of the channel.
ResourceId String An opaque ID that identifies the watched resource.
ResourceUri String A version-specific identifier for the watched resource.
Expiration Datetime The expiration date time of the channel.
ChannelToken String Arbitrary string delivered to the target address with each notification. Used for validation.

CData Cloud

SubscribeToCalendarListChanges

Starts watching for changes in the user's calendar list.

Input

Name Type Required Description
ChannelAddress String True The address where notifications of this channel will be delivered.
ChannelId String False A UUID or unique string that identifies the notification channel.
ChannelType String False Type of delivery mechanism for notifications. Valid values are 'web_hook' (or 'webhook').
ChannelToken String False Arbitrary string delivered to the target address with each notification. Used for validation.
ChannelTimeToLive String False The lifetime of the channel in seconds .

Result Set Columns

Name Type Description
Success String Indicates whether the operation was successful.
ChannelId String The UUID or the unique string of the channel.
ResourceId String An opaque ID that identifies the watched resource.
ResourceUri String A version-specific identifier for the watched resource.
Expiration Datetime The expiration date time of the channel.
ChannelToken String Arbitrary string delivered to the target address with each notification. Used for validation.

CData Cloud

SubscribeToEventChanges

Starts watching for changes to events on a calendar.

Input

Name Type Required Description
CalendarId String True The calendar identifier whose events to watch. Use 'primary' for the primary calendar of the authenticated user.
ChannelAddress String True The address where notifications of this channel will be delivered.
EventTypes String False A comma-separated list of event types of resources to watch. If unset, all event types will be watched.
ChannelId String False A UUID or unique string that identifies the notification channel.
ChannelType String False Type of delivery mechanism for notifications. Valid values are 'web_hook' (or 'webhook').
ChannelToken String False Arbitrary string delivered to the target address with each notification. Used for validation.
ChannelTimeToLive String False The lifetime of the channel in seconds .

Result Set Columns

Name Type Description
Success String Indicates whether the operation was successful.
ChannelId String The UUID or the unique string of the channel.
ResourceId String An opaque ID that identifies the watched resource.
ResourceUri String A version-specific identifier for the watched resource.
Expiration Datetime The expiration date time of the channel.
ChannelToken String Arbitrary string delivered to the target address with each notification. Used for validation.

CData Cloud

SubscribeToSettingsChanges

Starts watching for changes to the authenticated user's calendar settings.

Input

Name Type Required Description
ChannelAddress String True The address where notifications of this channel will be delivered.
ChannelId String False A UUID or unique string that identifies the notification channel.
ChannelType String False Type of delivery mechanism for notifications. Valid values are 'web_hook' (or 'webhook').
ChannelToken String False Arbitrary string delivered to the target address with each notification. Used for validation.
ChannelTimeToLive String False The lifetime of the channel in seconds .

Result Set Columns

Name Type Description
Success String Indicates whether the operation was successful.
ChannelId String The UUID or the unique string of the channel.
ResourceId String An opaque ID that identifies the watched resource.
ResourceUri String A version-specific identifier for the watched resource.
Expiration Datetime The expiration date time of the channel.
ChannelToken String Arbitrary string delivered to the target address with each notification. Used for validation.

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

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

CData Cloud

sys_tablecolumns

Describes the columns of the available tables and views.

The following query returns the columns and data types for the MyCalendar table:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='MyCalendar' 

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.

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 RefreshOAuthAccessToken stored procedure:

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'RefreshOAuthAccessToken' 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 = 'RefreshOAuthAccessToken' 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 Calendar procedure.

Pseudo-Columns

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 MyCalendar table:

         SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='MyCalendar' 
          

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

Connection


PropertyDescription
EventsScopeSpecifies the event types to expose in the Data Model.
ShowDeletedWhether to include deleted events when listing events.
SupportsAllDrivesDetermines whether to retrieve items from shared Drives.

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.

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
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'.
TimeoutSpecifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
UseSimpleNamesSpecifies whether or not simple names should be used for tables and columns.
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 Calendar.
CData Cloud

AuthScheme

Specifies the authentication method used to connect to Google Calendar.

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

Connection

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


PropertyDescription
EventsScopeSpecifies the event types to expose in the Data Model.
ShowDeletedWhether to include deleted events when listing events.
SupportsAllDrivesDetermines whether to retrieve items from shared Drives.
CData Cloud

EventsScope

Specifies the event types to expose in the Data Model.

Possible Values

UNIQUE, SINGLE, ALL

Data Type

string

Default Value

"UNIQUE"

Remarks

UNIQUE Includes single events and recurring events (with their exceptions), but not recurring event instances.
SINGLE Includes single events and recurring events, but not recurring event instances and their exceptions.
ALL Includes single events and all recurring event instances (but not their underlying parent events).

CData Cloud

ShowDeleted

Whether to include deleted events when listing events.

Data Type

bool

Default Value

false

Remarks

When set to True, events with the status 'canceled' are included in query results. Otherwise, they are omitted.

CData Cloud

SupportsAllDrives

Determines whether to retrieve items from shared Drives.

Data Type

bool

Default Value

false

Remarks

If you set this property to 'true', you can download attachments from any Drive.

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

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
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'.
TimeoutSpecifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
UseSimpleNamesSpecifies whether or not simple names should be used for tables and columns.
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

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

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

UseSimpleNames

Specifies whether or not simple names should be used for tables and columns.

Data Type

bool

Default Value

false

Remarks

Google Calendar tables can include special characters in their names that are typically not allowed in standard databases. This property makes the Cloud easier to use with traditional database tools.

Setting UseSimpleNames to True simplifies the names of the columns that are returned. It enforces a naming scheme where only alphanumeric characters and underscores are valid for displayed column names.

Notes:

  • Any non-alphanumeric characters are converted to underscores.
  • If the column or table names exceed 128 characters in length they are truncated to 128 characters to comply with SQL Server standards.

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) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9434