Google Data Catalog Connection Details¶

Introduction¶

Connector Version

This documentation is based on version 23.0.8804 of the connector.

Get Started¶

Google Data Catalog Version Support

The connector leverages the GoogleDataCatalog API to enable read only access to GoogleDataCatalog.

Establish a Connection¶

Connect to Google Data Catalog¶

Provide the following connection properties before adding the authentication properties.

• OrganizationId: The ID associated with the Google Cloud Platform organization resource you would like to connect to. Find this by navigating to the cloud console.
  Open the Project drop-down menu and click the link to your organization from the list. The organization ID is displayed on this page.
• ProjectId: The ID associated with the Google Cloud Platform project resource you would like to connect to.
  Find this by navigating to the cloud console dashboard and selecting your project from the Select from drop-down menu. The project ID is displayed in the Project info card.

Authenticate to Google Data Catalog¶

The connector supports using user accounts, service accounts and GCP instance accounts for authentication.

The following sections discuss the available authentication schemes for Google Data Catalog:

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

User Accounts (OAuth)¶

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

Desktop Applications¶

provides an embedded OAuth application that simplifies OAuth desktop Authentication. Alternatively, you can create a custom OAuth application. See Creating a Custom OAuth App for information about creating custom applications and reasons for doing so.

For authentication, the only difference between the two methods is that you must set two additional connection properties when using custom OAuth applications.

After setting the following connection properties, you are ready to connect:

• InitiateOAuth: Set this to GETANDREFRESH, which instructs the connector to automatically attempt to get and refresh the OAuth access token.
• 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.

When you connect the connector opens the OAuth endpoint in your default browser. Log in and grant permissions to the application. The connector then completes the OAuth process as follows:

• Extracts the access token from the callback URL.
• Obtains a new access token when the old one expires.
• Saves OAuth values in OAuthSettingsLocation that persist across connections.

Service Accounts (OAuthJWT)¶

To authenticate using a service account, you must create a new service account and have a copy of the accounts certificate. If you do not already have a service account, you can create one by following the procedure in Creating a Custom OAuth App.

For a JSON file, set these properties:

• AuthScheme: Set this to OAuthJWT.
• InitiateOAuth: Set this to GETANDREFRESH.
• OAuthJWTCertType: Set this to GOOGLEJSON.
• OAuthJWTCert: Set this to the path to the .json file provided by Google.
• OAuthJWTSubject: (optional) Only set this value if the service account is part of a GSuite domain and you want to enable delegation. The value of this property should be the email address of the user whose data you want to access.

For a PFX file, set these properties instead:

• AuthScheme: Set this to OAuthJWT.
• InitiateOAuth: Set this to GETANDREFRESH.
• OAuthJWTCertType: Set this to PFXFILE.
• OAuthJWTCert: Set this to the path to the .pfx file provided by Google.
• OAuthJWTCertPassword: (optional) Set this to the .pfx file password. In most cases you must provide this since Google encrypts PFX certificates.
• OAuthJWTCertSubject: (optional) Set this only if you are using a OAuthJWTCertType, which stores multiple certificates. This should not be set for PFX certificates generated by Google.
• OAuthJWTIssuer: Set this to the email address of the service account. This address usually includes the domain iam.gserviceaccount.com.
• OAuthJWTSubject: (optional) Only set this value if the service account is part of a GSuite domain and you want to enable delegation. The value of this property is the email address of the user whose data you want to access.

GCP Instance Accounts¶

When running on a GCP virtual machine, the connector can authenticate using a service account tied to the virtual machine. To use this mode, set AuthScheme to GCPInstanceAccount.

Create a Custom OAuth App¶

Create a Custom OAuth Application¶

embeds OAuth Application Credentials with branding that can be used when connecting to Google Data Catalog 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 Data Catalog".)

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

Follow these steps to enable the :

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 "" and select from the search results.
4. On the 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.

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, the Service account ID, and, optionally, a 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 KEYS tab.
9. Click ADD KEY > Create new key.
10. Select any supported Key type (see OAuthJWTCert and OAuthJWTCertType).
11. Click CREATE. The key is automatically downloaded to your device, and any additional information specific to the key is displayed.
12. Record the additional information for future use.

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

Important Notes¶

Configuration Files and Their Paths¶

• All references to adding configuration files and their paths refer to files and locations on the Harmony Agent where the connector is installed. These paths are to be adjusted as appropriate depending on the agent and the operating system. If multiple agents are used in an agent group, identical files will be required on each agent.

Advanced Features¶

This section details a selection of advanced features of the Google Data Catalog connector.

User Defined Views

The connector allows you to define virtual tables, called user defined views, whose contents are decided by a pre-configured query. These views are useful when you cannot directly control queries being issued to the drivers. See User Defined Views for an overview of creating and configuring custom views.

SSL Configuration

Use SSL Configuration to adjust how connector handles TLS/SSL certificate negotiations. You can choose from various certificate formats; see the SSLServerCert property under "Connection String Options" for more information.

Proxy

To configure the connector using Private Agent proxy settings, select the Use Proxy Settings checkbox on the connection configuration screen.

Query Processing

The connector offloads as much of the SELECT statement processing as possible to Google Data Catalog and then processes the rest of the query in memory (client-side).

User Defined Views¶

The Google Data Catalog connector allows you to define a virtual table whose contents are decided by a pre-configured query. These are called User Defined Views, which are useful in situations where you cannot directly control the query being issued to the driver, e.g. when using the driver from Jitterbit. The User Defined Views can be used to define predicates that are always applied. If you specify additional predicates in the query to the view, they are combined with the query already defined as part of the view.

There are two ways to create user defined views:

• Create a JSON-formatted configuration file defining the views you want.
• DDL statements.

Define Views Using a Configuration File¶

User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The connector automatically detects the views specified in this file.

You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the connector.

This User Defined View configuration file is formatted as follows:

• Each root element defines the name of a view.
• Each root element contains a child element, called query, which contains the custom SQL query for the view.

For example:

{
    "MyView": {
        "query": "SELECT * FROM Schemas WHERE MyColumn = 'value'"
    },
    "MyView2": {
        "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
    }
}

Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:

"UserDefinedViews", "C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json"

Define Views Using DDL Statements¶

The connector is also capable of creating and altering the schema via DDL Statements such as CREATE LOCAL VIEW, ALTER LOCAL VIEW, and DROP LOCAL VIEW.

Create a View¶

To create a new view using DDL statements, provide the view name and query as follows:

CREATE LOCAL VIEW [MyViewName] AS SELECT * FROM Customers LIMIT 20;

If no JSON file exists, the above code creates one. The view is then created in the JSON configuration file and is now discoverable. The JSON file location is specified by the UserDefinedViews connection property.

Alter a View¶

To alter an existing view, provide the name of an existing view alongside the new query you would like to use instead:

ALTER LOCAL VIEW [MyViewName] AS SELECT * FROM Customers WHERE TimeModified > '3/1/2020';

The view is then updated in the JSON configuration file.

Drop a View¶

To drop an existing view, provide the name of an existing schema alongside the new query you would like to use instead.

DROP LOCAL VIEW [MyViewName]

This removes the view from the JSON configuration file. It can no longer be queried.

Schema for User Defined Views¶

User Defined Views are exposed in the UserViews schema by default. This is done to avoid the view's name clashing with an actual entity in the data model. You can change the name of the schema used for UserViews by setting the UserViewsSchemaName property.

Work with User Defined Views¶

For example, a SQL statement with a User Defined View called UserViews.RCustomers only lists customers in Raleigh:

SELECT * FROM Customers WHERE City = 'Raleigh';

An example of a query to the driver:

SELECT * FROM UserViews.RCustomers WHERE Status = 'Active';

Resulting in the effective query to the source:

SELECT * FROM Customers WHERE City = 'Raleigh' AND Status = 'Active';

That is a very simple example of a query to a User Defined View that is effectively a combination of the view query and the view definition. It is possible to compose these queries in much more complex patterns. All SQL operations are allowed in both queries and are combined when appropriate.

SSL Configuration¶

Customize the SSL Configuration¶

By default, the connector attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store.

To specify another certificate, see the SSLServerCert property for the available formats to do so.

Data Model¶

Overview

This section shows the available API objects and provides more information on executing SQL to Google Data Catalog APIs.

Key Features

• The connector models Google Data Catalog entities like Documents, Folders, and Groups as relational views, allowing you to write SQL to query Google Data Catalog data.
• Stored procedures allow you to execute operations to Google Data Catalog
• Live connectivity to these objects means any changes to your Google Data Catalog account are immediately reflected when using the connector.

Views

Views describes the available views. Views are statically defined to model read-only entities such as Schemas, Tables, and TagTemplates.

Stored Procedures

Stored Procedures are function-like interfaces to Google Data Catalog. Stored procedures allow you to execute operations to Google Data Catalog, including downloading documents and moving envelopes.

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.

Google Data Catalog Connector Views¶

Schemas¶

To view the list of schemas

Table Specific Information¶

Select¶

The connector will use the Google Data Catalog API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.

• DataSetName supports the 'CONTAINS' comparison.
• Type supports the '=' comparison.
• ProjectId supports the '=' comparison.
• EntryGroup supports the '=' comparison.
• CreatedTime supports the '=, <, <=, >, >=' comparisons.
• UpdatedTime supports the '=, <, <=, >, >=' comparisons.
• OrganizationId supports the '=' comparison.
• DisplayName supports the 'CONTAINS' comparison.
• Description supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM Schemas WHERE CONTAINS (DataSetName, 'prop')

SELECT * FROM Schemas WHERE UpdatedTime >= '2018-01-01 01:00:00'

SELECT * FROM Schemas WHERE CreatedTime < '2018-06-01'

SELECT * FROM Schemas WHERE UpdatedTime > '2018-06-01 12:00:00' AND CreatedTime <= '2019-06-01 11:00'

SELECT * FROM Schemas WHERE OrganizationId = '112025358'

SELECT * FROM Schemas WHERE ProjectId = 'bigquery-public-data OR ProjectId = 'level-works-253411''

Additionally LastAccessedTime and UpdatedTime columns can be used in the ORDER BY clause, as following:

SELECT * FROM Schemas ORDER BY LastAccessed ASC

SELECT * FROM Schemas ORDER BY UpdatedTime DESC

Columns¶

Pseudo-Columns¶

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

TableColumns¶

To view the columns in the table or view

Table Specific Information¶

Select¶

The connector will use the Google Data Catalog API to process WHERE clause conditions built with the following column and operator. The ResourceName is required to make a request and the rest of the filter is executed client side within the connector.

• ResourceName supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM TableColumns WHERE ResourceName = 'projects/bigquery-public-data/locations/US/entryGroups/@bigquery/entries/cHJvamVjdHMvYmlncXVlcnktcHVibGljLWRhdGEvZGF0YXNldHMvZ2VvX2NlbnN1c19ibG9ja2dyb3Vwcy90YWJsZXMvYmxvY2tncm91cHNfMTE'

Columns¶

TableProperties¶

To view the properties of the table

Table Specific Information¶

Select¶

The connector will use the Google Data Catalog API to process WHERE clause conditions built with the following column and operator. The ResourceName is required to make a request and the rest of the filter is executed client side within the connector.

• ResourceName supports the '=' comparison.

SELECT * FROM TableProperties WHERE ResourceName = 'projects/bigquery-public-data/locations/US/entryGroups/@bigquery/entries/cHJvamVjdHMvYmlncXVlcnktcHVibGljLWRhdGEvZGF0YXNldHMvZ2VvX2NlbnN1c19ibG9ja2dyb3Vwcy90YWJsZXMvYmxvY2tncm91cHNfMTE'

Columns¶

Tables¶

To view the list of tables and views

Table Specific Information¶

Select¶

The connector will use the Google Data Catalog API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.

• DataSetName supports the 'CONTAINS' comparison.
• Type supports the '=' comparison.
• ProjectId supports the '=' comparison.
• EntryGroup supports the '=' comparison.
• CreatedTime supports the '=, <, <=, >, >=' comparisons.
• UpdatedTime supports the '=, <, <=, >, >=' comparisons.
• OrganizationId supports the '=' comparison.
• TagName supports the 'CONTAINS' comparison.
• DisplayName supports the 'CONTAINS' comparison.
• SearchColumn supports the 'CONTAINS' comparison.
• Description supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM Tables WHERE UpdatedTime <= '2018-06-01 11:00:00.0'

SELECT * FROM Tables WHERE UpdatedTime >= '2018-06-01'

SELECT * FROM Tables WHERE UpdatedTime > '2018-06-01 12:00:00' AND CreatedTime < '2019-06-01 11:00:00'

SELECT * FROM Tables WHERE OrganizationId = '112025358'

SELECT * FROM Tables WHERE ProjectId = 'bigquery-public-data'

SELECT * FROM Tables WHERE CONTAINS (SearchColumn, 'name')

SELECT * FROM Tables WHERE TagName = 'test'

SELECT * FROM Tables WHERE Type = 'table' OR Type = 'view'

Additionally LastAccessedTime and UpdatedTime columns can be used in the ORDER BY clause, as following:

SELECT * FROM Tables ORDER BY LastAccessed DESC

SELECT * FROM Tables ORDER BY UpdatedTime ASC

Columns¶

Pseudo-Columns¶

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

TableTagsDetails¶

To view the list of tags added to the table

Table Specific Information¶

Select¶

The connector will use the Google Data Catalog API to process WHERE clause conditions built with the following column and operator. The ResourceName is required to make a request and the rest of the filter is executed client side within the connector.

• ResourceName supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM TableTagsDetails WHERE ResourceName = 'projects/level-works-253411/locations/us/entryGroups/@bigquery/entries/cHJvamVjdHMvbGV2ZWwtd29ya3MtMjUzNDExL2RhdGFzZXRzL3Rlc3RkYi90YWJsZXMvbXl2aWV3'

Columns¶

TagTemplateColumns¶

To view the list of columns in the TagTemplate.

Table Specific Information¶

Select¶

The connector will use the Google Data Catalog API to process WHERE clause conditions built with the following column and operator. The ResourceName is required to make a request and the rest of the filter is executed client side within the connector.

• ResourceName supports the '=' comparison.

SELECT * FROM TagTemplateColumns WHERE ResourceName = 'projects/level-works-253411/locations/us-central1/tagTemplates/demotemplate'

Columns¶

TagTemplateIAMPolicy¶

To view the TagTemplates permission in the project

Table Specific Information¶

Select¶

The connector will use the Google Data Catalog API to process WHERE clause conditions built with the following column and operator. The ResourceName is required to make a request and the rest of the filter is executed client side within the connector.

• ResourceName supports the '=' comparison.

SELECT * FROM TagTemplateIAMPolicy WHERE ResourceName = 'projects/level-works-253411/locations/us-central1/tagTemplates/demotemplate'

Columns¶

TagTemplates¶

To view the list of TagTemplates in the project

Table Specific Information¶

Select¶

The connector will use the Google Data Catalog API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.

• Name supports the 'CONTAINS' comparison.
• Type supports the '=' comparison.
• ProjectId supports the '=' comparison.
• CreatedTime supports the '=, <, <=, >, >=' comparisons.
• UpdatedTime supports the '=, <, <=, >, >=' comparisons.
• OrganizationId supports the '=' comparison.
• DisplayName supports the 'CONTAINS' comparison.

For example, the following queries are processed server side:

SELECT * FROM TagTemplates WHERE OrganizationId = '112025358'

SELECT * FROM TagTemplates WHERE CONTAINS (Name, 'test') OR ProjectId = 'bigquery-public-data'

SELECT * FROM TagTemplates WHERE CreatedTime >= '2018-01-01 01:00:00'

SELECT * FROM TagTemplates WHERE UpdatedTime < '2018-06-01'

SELECT * FROM TagTemplates WHERE UpdatedTime > '2018-06-01 12:00:00' AND CreatedTime <= '2019-06-01 11:00'

SELECT * FROM TagTemplates WHERE Type = 'tag_template' AND DisplayName = 'test_template'

Additionally LastAccessedTime and UpdatedTime columns can be used in the ORDER BY clause, as following:

SELECT * FROM TagTemplates ORDER BY LastAccessed ASC

SELECT * FROM TagTemplates ORDER BY UpdatedTime DESC

Columns¶

Pseudo-Columns¶

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

Stored Procedures¶

Stored procedures are function-like interfaces that extend the functionality of the connector beyond simple SELECT operations with Google Data Catalog.

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

Google Data Catalog Connector Stored Procedures¶

GetOAuthAccessToken¶

Obtains the OAuth access token to be used for authentication with various Google services.

Input¶

Result Set Columns¶

GetOAuthAuthorizationURL¶

Obtains the OAuth authorization URL for authentication with various Google services.

Input¶

Result Set Columns¶

RefreshOAuthAccessToken¶

Obtains the OAuth access token to be used for authentication with various Google services.

Input¶

Result Set Columns¶

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 Data Catalog:

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

sys_catalogs¶

Lists the available databases.

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

SELECT * FROM sys_catalogs

Columns¶

sys_schemas¶

Lists the available schemas.

The following query retrieves all available schemas:

SELECT * FROM sys_schemas

Columns¶

sys_tables¶

Lists the available tables.

The following query retrieves the available tables and views:

SELECT * FROM sys_tables

Columns¶

sys_tablecolumns¶

Describes the columns of the available tables and views.

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

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

Columns¶

sys_procedures¶

Lists the available stored procedures.

The following query retrieves the available stored procedures:

SELECT * FROM sys_procedures

Columns¶

sys_procedureparameters¶

Describes stored procedure parameters.

The following query returns information about all of the input parameters for the SampleProcedure stored procedure:

SELECT * FROM sys_procedureparameters WHERE ProcedureName='SampleProcedure' AND Direction=1 OR Direction=2

Columns¶

sys_keycolumns¶

Describes the primary and foreign keys.

The following query retrieves the primary key for the Schemas table:

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

Columns¶

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¶

sys_primarykeys¶

Describes the primary keys.

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

SELECT * FROM sys_primarykeys

Columns¶

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¶

sys_connection_props¶

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

When querying this table, the config connection string should be used:

jdbc:cdata:googledatacatalog:config:

This connection string enables you to query this table without a valid connection.

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¶

sys_sqlinfo¶

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

Discovering the Data Source's SELECT Capabilities¶

Below is an example data set of SQL capabilities. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.

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

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'

Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.

Columns¶

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¶

Advanced Configurations Properties¶

The advanced configurations 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. Click the links for further details.

Authentication

OAuth

JWT OAuth

SSL

Schema

Miscellaneous

Authentication¶

This section provides a complete list of authentication properties you can configure.

AuthScheme¶

The type of authentication to use when connecting to Google Data Catalog.

Possible Values¶

Auto, OAuth, OAuthJWT, GCPInstanceAccount

Data Type¶

string

Default Value¶

Auto

Remarks¶

• Auto: Lets the driver decide automatically based on the other connection properties you have set.
• 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.

OrganizationId¶

The ID associated with the Google Cloud Platform organization resource to connect to.

Data Type¶

string

Default Value¶

""

Remarks¶

Find this by navigating to the cloud console. Click the project selection drop-down, and select your organization from the list. Then, click More -> Settings. The organization ID is displayed on this page.

ProjectId¶

The ID associated with the Google Cloud Platform project resource you would like to connect to.

Data Type¶

string

Default Value¶

""

Remarks¶

Find this by navigating to the cloud console dashboard and selecting your project from the Select from drop-down. The project ID will be present in the Project info card. Set this to a comma-separated values for more than one Project(Project1, Project2).

OAuth¶

This section provides a complete list of OAuth properties you can configure.

InitiateOAuth¶

Set this property to initiate the process to obtain or refresh the OAuth access token when you connect.

Possible Values¶

OFF, GETANDREFRESH, REFRESH

Data Type¶

string

Default Value¶

OFF

Remarks¶

The following options are available:

1. OFF: Indicates that the OAuth flow will be handled entirely by the user. An OAuthAccessToken will be required to authenticate.
2. GETANDREFRESH: Indicates that the entire OAuth Flow will be handled by the connector. If no token currently exists, it will be obtained by prompting the user via the browser. If a token exists, it will be refreshed when applicable.
3. REFRESH: Indicates that the connector will only handle refreshing the OAuthAccessToken. The user will never be prompted by the connector to authenticate via the browser. The user must handle obtaining the OAuthAccessToken and OAuthRefreshToken initially.

OAuthClientId¶

The client ID assigned when you register your application with an OAuth authorization server.

Data Type¶

string

Default Value¶

""

Remarks¶

As part of registering an OAuth application, you will receive the OAuthClientId value, sometimes also called a consumer key, and a client secret, the OAuthClientSecret.

OAuthClientSecret¶

The client secret assigned when you register your application with an OAuth authorization server.

Data Type¶

string

Default Value¶

""

Remarks¶

As part of registering an OAuth application, you will receive the OAuthClientId, also called a consumer key. You will also receive a client secret, also called a consumer secret. Set the client secret in the OAuthClientSecret property.

OAuthAccessToken¶

The access token for connecting using OAuth.

Data Type¶

string

Default Value¶

""

Remarks¶

The OAuthAccessToken property is used to connect using OAuth. The OAuthAccessToken is retrieved from the OAuth server as part of the authentication process. It has a server-dependent timeout and can be reused between requests.

The access token is used in place of your user name and password. The access token protects your credentials by keeping them on the server.

OAuthSettingsLocation¶

The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH. Alternatively, you can hold this location in memory by specifying a value starting with 'memory://'.

Data Type¶

string

Default Value¶

%APPDATA%\CData\Acumatica Data Provider\OAuthSettings.txt

Remarks¶

When InitiateOAuth is set to GETANDREFRESH or REFRESH, the driver saves OAuth values to avoid requiring the user to manually enter OAuth connection properties and to allow the credentials to be shared across connections or processes.

Instead of specifying a file path, you can use memory storage. Memory locations are specified by using a value starting with 'memory://' followed by a unique identifier for that set of credentials (for example, memory://user1). The identifier can be anything you choose but should be unique to the user. Unlike file-based storage, where credentials persist across connections, memory storage loads the credentials into static memory, and the credentials are shared between connections using the same identifier for the life of the process. To persist credentials outside the current process, you must manually store the credentials prior to closing the connection. This enables you to set them in the connection when the process is started again. You can retrieve OAuth property values with a query to the sys_connection_props system table. If there are multiple connections using the same credentials, the properties are read from the previously closed connection.

The default location is "%APPDATA%\CData\Acumatica Data Provider\OAuthSettings.txt" with %APPDATA% set to the user's configuration directory. The default values are

• Windows: "register://%DSN"
• Unix: "%AppData%..."

where DSN is the name of the current DSN used in the open connection.

The following table lists the value of %APPDATA% by OS:

CallbackURL¶

The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings.

Data Type¶

string

Default Value¶

""

Remarks¶

During the authentication process, the OAuth authorization server redirects the user to this URL. This value must match the callback URL you specify in your app settings.

OAuthVerifier¶

The verifier code returned from the OAuth authorization URL.

Data Type¶

string

Default Value¶

""

Remarks¶

The verifier code returned from the OAuth authorization URL. This can be used on systems where a browser cannot be launched such as headless systems.

Authentication on Headless Machines¶

See to obtain the OAuthVerifier value.

Set OAuthSettingsLocation along with OAuthVerifier. When you connect, the connector exchanges the OAuthVerifier for the OAuth authentication tokens and saves them, encrypted, to the specified location. Set InitiateOAuth to GETANDREFRESH to automate the exchange.

Once the OAuth settings file has been generated, you can remove OAuthVerifier from the connection properties and connect with OAuthSettingsLocation set.

To automatically refresh the OAuth token values, set OAuthSettingsLocation and additionally set InitiateOAuth to REFRESH.

OAuthRefreshToken¶

The OAuth refresh token for the corresponding OAuth access token.

Data Type¶

string

Default Value¶

""

Remarks¶

The OAuthRefreshToken property is used to refresh the OAuthAccessToken when using OAuth authentication.

OAuthExpiresIn¶

The lifetime in seconds of the OAuth AccessToken.

Data Type¶

string

Default Value¶

""

Remarks¶

Pair with OAuthTokenTimestamp to determine when the AccessToken will expire.

OAuthTokenTimestamp¶

The Unix epoch timestamp in milliseconds when the current Access Token was created.

Data Type¶

string

Default Value¶

""

Remarks¶

Pair with OAuthExpiresIn to determine when the AccessToken will expire.

JWT OAuth¶

This section provides a complete list of JWT OAuth properties you can configure.

OAuthJWTCert¶

The JWT Certificate store.

Data Type¶

string

Default Value¶

""

Remarks¶

The name of the certificate store for the client certificate.

The OAuthJWTCertType field specifies the type of the certificate store specified by OAuthJWTCert. If the store is password protected, specify the password in OAuthJWTCertPassword.

OAuthJWTCert is used in conjunction with the OAuthJWTCertSubject

field in order to specify client certificates. If OAuthJWTCert has a value, and OAuthJWTCertSubject is set, a search for a certificate is initiated. Please refer to the OAuthJWTCertSubject field for details.

Designations of certificate stores are platform-dependent.

The following are designations of the most common User and Machine certificate stores in Windows:

In Java, the certificate store normally is a file containing certificates and optional private keys.

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).

OAuthJWTCertType¶

The type of key store containing the JWT Certificate.

Data Type¶

string

Default Value¶

USER

Remarks¶

This property can take one of the following values:

OAuthJWTCertPassword¶

The password for the OAuth JWT certificate.

Data Type¶

string

Default Value¶

""

Remarks¶

If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.

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

OAuthJWTCertSubject¶

The subject of the OAuth JWT certificate.

Data Type¶

string

Default Value¶

*

Remarks¶

When loading a certificate the subject is used to locate the certificate in the store.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks the first certificate in the certificate store.

The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, E=support@jitterbit.com". Common fields and their meanings are displayed below.

If a field value contains a comma it must be quoted.

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 a delegated user Email Address.

This is not required when using the GOOGLEJSON OAuthJWTCertType. Google JSON keys contain a copy of the issuer account.

The issuer of the Java Web Token. Enter the value of a delegated user Email Address.

This is not required when using the GOOGLEJSON OAuthJWTCertType. Google JSON keys contain a copy of the issuer account.

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 value of the Service Account Email.

The user subject for which the application is requesting delegated access. Enter the value of the Service Account Email.

SSL¶

This section provides a complete list of SSL properties you can configure.

SSLServerCert¶

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

Data Type¶

string

Default Value¶

""

Remarks¶

If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.

This property can take the following forms:

If not specified, any certificate trusted by the machine is accepted.

Certificates are validated as trusted by the machine based on the System's trust store. The trust store used is the 'javax.net.ssl.trustStore' value specified for the system. If no value is specified for this property, Java's default trust store is used (for example, JAVA_HOME\lib\security\cacerts).

Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.

Schema¶

This section provides a complete list of schema properties you can configure.

Location¶

A path to the directory that contains the schema files defining tables, views, and stored procedures.

Data Type¶

string

Default Value¶

%APPDATA%\GoogleDataCatalog Data Provider\Schema

Remarks¶

The path to a directory which contains the schema files for the connector (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) or extend the data model with new tables, views, or stored procedures.

If left unspecified, the default location is "%APPDATA%\GoogleDataCatalog Data Provider\Schema" with %APPDATA% being set to the user's configuration directory:

BrowsableSchemas¶

This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Data Type¶

string

Default Value¶

""

Remarks¶

Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.

Tables¶

This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.

Data Type¶

string

Default Value¶

""

Remarks¶

Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the connector.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Views¶

Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Data Type¶

string

Default Value¶

""

Remarks¶

Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the connector.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Miscellaneous¶

This section provides a complete list of miscellaneous properties you can configure.

MaxRows¶

Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.

Data Type¶

int

Default Value¶

-1

Remarks¶

Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.

Other¶

These hidden properties are used only in specific use cases.

Data Type¶

string

Default Value¶

""

Remarks¶

The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.

Specify multiple properties in a semicolon-separated list.

Integration and Formatting¶

Pagesize¶

The maximum number of results to return per page from Google Data Catalog.

Data Type¶

int

Default Value¶

1000

Remarks¶

The Pagesize property affects the maximum number of results to return per page from Google Data Catalog. Setting a higher value may result in better performance at the cost of additional memory allocated per page consumed.

PseudoColumns¶

This property indicates whether or not to include pseudo columns as columns to the table.

Data Type¶

string

Default Value¶

""

Remarks¶

This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".

Timeout¶

The value in seconds until the timeout error is thrown, canceling the operation.

Data Type¶

int

Default Value¶

60

Remarks¶

If Timeout = 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.

If Timeout expires and the operation is not yet complete, the connector throws an exception.

UserDefinedViews¶

A filepath pointing to the JSON configuration file containing your custom views.

Data Type¶

string

Default Value¶

""

Remarks¶

User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The connector automatically detects the views specified in this file.

You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the connector.

This User Defined View configuration file is formatted as follows:

• Each root element defines the name of a view.
• Each root element contains a child element, called query, which contains the custom SQL query for the view.

For example:

{
    "MyView": {
        "query": "SELECT * FROM Schemas WHERE MyColumn = 'value'"
    },
    "MyView2": {
        "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
    }
}

Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:

"UserDefinedViews", C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json

Note that the specified path is not embedded in quotation marks.