Azure Data Catalog Version Support

The connector leverages the Azure Data Catalog API to enable read access to Azure Data Catalog.

Connecting to Azure Data Catalog

You can optionally set the following to read the different catalog data returned from Azure Data Catalog.

• CatalogName: Set this to the catalog name associated with your Azure Data Catalog. If left blank, the default catalog will be used.

  To get your catalog name, navigate to the Azure Portal home page -> Data Catalog -> Catalog Name

Authenticating using Azure AD

Azure AD is a connection type that goes through OAuth. Set your AuthScheme to AzureAD and see Using OAuth Authentication for an authentication guide.

Authenticating using Azure Service Principal

Azure Service Principal is a connection type that goes through OAuth. Set your AuthScheme to AzureServicePrincipal and see Using Azure Service Principal Authentication for an authentication guide.

Authenticating using MSI Authentication

If you are running Azure Data Catalog on an Azure VM, you can leverage Managed Service Identity (MSI) credentials to connect:

• AuthScheme: Set this to AzureMSI.

The MSI credentials will then be automatically obtained for authentication.

OAuth requires the authenticating user to interact with Azure Data Catalog using the browser. The connector facilitates this in various ways as described below.

Embedded Credentials

See Embedded Credentials to connect with the connector's embedded credentials and skip creating a custom OAuth app.

Custom Credentials

Instead of connecting with the connector's embedded credentials, you can register an app with Custom Credentials to obtain the OAuthClientId and OAuthClientSecret.

When to Create a Custom OAuth App

Creating a custom OAuth app is optional as the connector is already registered with Azure Data Catalog and you can connect with its embedded credentials. You might want to create a custom OAuth app to change the information displayed when users log into the Azure Data Catalog OAuth endpoint to grant permissions to the connector.

Creating a Custom OAuth App

See Creating a Custom OAuth App for a procedure.

Authenticate using the Embedded OAuth Credentials

Desktop Authentication with the Embedded OAuth App

You can connect without setting any connection properties for your user credentials.

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.

1. Extracts the access token from the callback URL and authenticates requests.
2. Obtains a new access token when the old one expires.
3. Saves OAuth values in OAuthSettingsLocation to be persisted across connections.

There are two types of app authentication available: using a client secret and using a certificate. You can use any of them depending on the configured app authentication.

Desktop Authentication with Your OAuth App

Follow the steps below to authenticate with the credentials for a custom OAuth app. See Creating a Custom OAuth App.

Get an OAuth Access Token

You are ready to connect after setting one of the below connection properties groups depending on the authentication type.

1. Authenticating using a Client Secret
   • OAuthClientId: Set this to the Client ID in your app settings.
   • OAuthClientSecret: Set this to the Client Secret in your app settings.
   • CallbackURL: Set this to the Redirect URL in your app settings.
   • AuthScheme: Set this to the "AzureAD" in your app settings.
   • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken. .
2. Authenticating using a Certificate
   • OAuthClientId: Set this to the Client ID in your app settings.
   • OAuthJWTCert: Set this to the JWT Certificate store.
   • OAuthJWTCertType: Set this to the type of the certificate store specified by OAuthJWTCert.
   • CallbackURL: Set this to the Redirect URL in your app settings.
   • AuthScheme: Set this to the "AzureAD" in your app settings.
   • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken. .

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:

1. Extracts the access token from the callback URL and authenticates requests.
2. Obtains a new access token when the old one expires.
3. Saves OAuth values in OAuthSettingsLocation to be persisted across connections.

Using OAuth on a Headless Machine

To create Azure Data Catalog data sources on headless servers or other machines on which the connector cannot open a browser, you need to authenticate from another machine. Authentication is a two-step process.

1. Instead of installing the connector on another machine, you can follow the steps below to obtain the OAuthVerifier value. Or, you can install the connector on another machine and transfer the OAuth authentication values, after you authenticate through the usual browser-based flow.
2. You can then configure the connector to automatically refresh the access token from the headless machine.

You can follow the headless OAuth authentication flow using the connector's embedded OAuth credentials or using the OAuth credentials for your custom OAuth app.

Using the Credentials for a Custom OAuth App

Create a Custom OAuth App

See Creating a Custom OAuth App for a procedure. You can then follow the procedures below to authenticate and connect to data.

Obtain a Verifier Code

On the headless machine, set one the following properties groups depending on the authentication type:

1. Authenticating using a Client Secret
   • InitiateOAuth: Set this to OFF.
   • OAuthClientId: Set this to the App ID in your app settings.
   • OAuthClientSecret: Set this to the App Secret in your app settings.
2. Authenticating using a Certificate
   • InitiateOAuth: Set this to OFF.
   • OAuthClientId: Set this to the App ID in your app settings.
   • OAuthJWTCert: Set this to the JWT Certificate store.
   • OAuthJWTCertType: Set this to the type of the certificate store specified by OAuthJWTCert.

You can then follow the steps below to authenticate from another machine and obtain the OAuthVerifier connection property.

1. Call the GetOAuthAuthorizationURL stored procedure* with the CallbackURL input parameter set to the exact Redirect URI you specified in your app settings.
2. Open the returned URL in a browser. Log in and grant permissions to the connector. You are then redirected to the callback URL. The webpage will state that the site could not be reached.
3. Inspect the URL of the this site page and find the code value. It will be present in the URL in the form code=XXXXXX (terminated with &, which denotes the next URL parameter) The value after the "code=" is the verifier code.
4. Save the value of the verifier code. You will set this in the OAuthVerifier connection property.

On the headless machine, set the one of the following connection properties groups depending on the authentication type to obtain the OAuth authentication values:

• OAuthClientId: Set this to the consumer key in your app settings.
• OAuthClientSecret: Set this to the consumer secret in your app settings.
• OAuthVerifier: Set this to the verifier code.
• OAuthSettingsLocation: Set this to persist the encrypted OAuth authentication values to the specified file.
• InitiateOAuth: Set this to REFRESH.

Connect to Data

After the OAuth settings file is generated, set the following properties to connect to data:

• OAuthSettingsLocation: Set this to the file containing the encrypted OAuth authentication values. Make sure this file gives read and write permissions to the provider to enable the automatic refreshing of the access token.
• InitiateOAuth: Set this to REFRESH.

Transfer OAuth Settings

Follow the steps below to install the connector on another machine, authenticate, and then transfer the resulting OAuth values.

On a second machine, install the connector and connect with the one of the following properties groups depending on the authentication type:

1. Authenticating using a Client Secret
   • OAuthSettingsLocation: Set this to a writable text file.
   • InitiateOAuth: Set this to GETANDREFRESH.
   • OAuthClientId: Set this to the Client ID in your app settings.
   • OAuthClientSecret: Set this to the Client Secret in your app settings.
   • CallbackURL: Set this to the Callback URL in your app settings.
2. Authenticating using a Certificate
   • OAuthSettingsLocation: Set this to a writable text file.
   • InitiateOAuth: Set this to GETANDREFRESH.
   • OAuthClientId: Set this to the Client ID in your app settings.
   • OAuthJWTCert: Set this to the JWT Certificate store.
   • OAuthJWTCertType: Set this to the type of the certificate store specified by OAuthJWTCert.
   • CallbackURL: Set this to the Callback URL in your app settings.

Test the connection to authenticate. The resulting authentication values are written, encrypted, to the path specified by OAuthSettingsLocation. 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.
• OAuthSettingsLocation: Set this to the path to your OAuth settings file. Make sure this file gives read and write permissions to the connector to enable the automatic refreshing of the access token.

When to Create a Custom OAuth App

Creating a custom OAuth app is optional as the connector is already registered with Azure Data Catalog and you can connect with its embedded credentials.

You might want to create a custom OAuth app to change the information displayed when users log into the Azure Data Catalog OAuth endpoint to grant permissions to the connector.

Follow the steps below to create a custom OAuth app and obtain the connection properties in a specific OAuth authentication flow.

Steps to Create a Custom OAuth App

Follow the steps below to obtain the OAuth values for your app, the OAuthClientId and OAuthClientSecret.

1. Log in to https://portal.azure.com.
2. In the left-hand navigation pane, select Azure Active Directory then App Registrations and click the New registration button.
3. Enter an app name and set the radio button for the desired tenant setup. When creating a custom OAuth application in Azure Active Directory, you can define if the application is single- or multi-tenant. If you select the default option of "Accounts in this organizational directory only", you will need to set the AzureTenant connection property to the ID of the Azure AD Tenant when establishing a connection with the Jitterbit Connector for Azure Data Catalog. Otherwise, the authentication attempt will fail with an error. If your app is for private use only, "Accounts in this organization directory only" should be sufficient. Otherwise, if you want to distribute your app, choose one of the multi-tenant options.
4. Then set the redirect URL to something such as http://localhost:33333, the connector's default. Or, set a different port of your choice and set CallbackURL to the exact reply URL you defined.
5. Define the app authentication type by going to the Certificates & Secrets section. There are two types of authentication available: using a client secret and using a certificate. The recommended authentication method is via a certificate, but you can also create an application secret.
   • Option 1 - Upload a certificate: In the Certificates & Secrets section, select Upload certificate and select the certificate to upload from your local machine.
   • Option 2 - Create a new application secret: In the Certificates & Secrets section, select New Client Secret for the app and select its duration. After saving the client secret, the key value is displayed. Copy this value as it is displayed only once, and it is used as the OAuthClientSecret.
6. Select API Permissions and then click Add. If you plan for your app to connect without a user context, select the Application Permissions (OAuthGrantType = CLIENT). Otherwise, when selecting permissions, use the Delegated permissions.
7. Select Azure Dat Catalog -> Delegated Permissions -> user_impersonation.
8. Save your changes.
9. If you have selected to use permissions that require admin consent (such as the Application Permissions), you may grant them from the current tenant on the API Permissions page. Otherwise, follow the steps under Admin Consent.

Admin consent refers to when the Admin for an Azure Active Directory tenant grants permissions to an application which requires an admin to consent to the use case. The embedded app within the Jitterbit Connector for Azure Data Catalog, contains no permissions that require admin consent. Therefore, this information applies only to custom applications.

Admin Consent Permissions

When creating a new OAuth app in the Azure Portal, you must specify which permissions the app will require. Some permissions may be marked stating "Admin Consent Required". For example, all Groups permissions require Admin Consent. If your app requires admin consent, there are a couple of ways this can be done.

The easiest way to grant admin consent is to just have an admin log into portal.azure.com and navigate to the app you have created in App Registrations. Under API Permissions, there will be a button for Grant Consent. You can consent here for your app to have permissions on the tenant it was created under.

If your organization has multiple tenants or the app needs to be granted permissions for other tenants outside your organization, the GetAdminConsentURL may be used to generate the Admin Authorization URL. Unlike the GetOAuthAuthorizationURL, there will be no important information returned from this endpoint. If the grants access, it will simply return a boolean indicating that permissions were granted.

Once an admin grants consent, authentication may be performed as normal.

Client credentials refers to a flow in OAuth where there is no direct user authentication taking place. Instead, credentials are created for just the app itself. All tasks taken by the app are done without a default user context. This makes the authentication flow a bit different from standard.

Client OAuth Flow

All permissions related to the client oauth flow require admin consent. This means the app embedded with the Jitterbit Connector for Azure Data Catalog cannot be used in the client oauth flow. You must create your own OAuth app in order to use client credentials. See Creating a Custom OAuth App for more details.

In your App Registration in portal.azure.com, navigate to API Permissions and select the Microsoft Graph permissions. There are two distinct sets of permissions - Delegated and Application permissions. The permissions used during client credential authentication are under Application Permissions. Select the applicable permissions you require for your integration.

You are ready to connect after setting one of the below connection properties groups depending on the authentication type.

1. Authenticating using a Client Secret
   • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
   • AzureTenant: Set this to the tenant you wish to connect to.
   • OAuthGrantType: Set this to CLIENT.
   • OAuthClientId: Set this to the Client ID in your app settings.
   • OAuthClientSecret: Set this to the Client Secret in your app settings.
2. Authenticating using a Certificate
   • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
   • AzureTenant: Set this to the tenant you wish to connect to.
   • OAuthGrantType: Set this to CLIENT.
   • OAuthClientId: Set this to the Client ID in your app settings.
   • OAuthJWTCert: Set this to the JWT Certificate store.
   • OAuthJWTCertType: Set this to the type of the certificate store specified by OAuthJWTCert.

Authentication with client credentials will take place automatically like any other connection, except there will be no window opened prompting the user. Because there is no user context, there is no need for a browser popup. Connections will take place and be handled internally.

The authentication as an Azure Service Principal is handled via the OAuth Client Credentials flow, and it does not involve direct user authentication. Instead, credentials are created for just the app itself. All tasks taken by the app are done without a default user context, but based on the assigned roles. The application access to the resources is controlled through the assigned roles' permissions.

Custom Credentials

You will need to register an OAuth app to obtain the OAuth property values before connection to the Azure Data Catalog data source. You can check the Custom Credentials guide on how to set the OAuth properties.

Creating a Custom OAuth App

See Creating a Custom OAuth App for a procedure.

Creating a custom OAuth app and a service principal that can access the necessary resources is required when authenticating using an Azure Service Principal.

Follow the steps below to create a custom OAuth app and obtain the connection properties for the Azure Service Principal authentication.

Steps to Create a Custom OAuth App

Follow the steps below to obtain the OAuth values for your app.

1. Log in to https://portal.azure.com.
2. In the left-hand navigation pane, select Azure Active Directory then App Registrations and click on New registration button.
3. Enter an app name and set the radio button for "Any Azure AD Directory - Multi Tenant". Then set the redirect URL to something such as http://localhost:33333, the connector's default.
4. Copy the Application (client) ID value displayed on the Overview section after creating the app, since this value is used as the OAuthClientId
5. Define the app authentication type by going to the Certificates & Secrets section. There are two types of authentication available: using a client secret and using a certificate. The recommended authentication method is via a certificate, but you can also create an application secret.
   • Option 1 - Upload a certificate: In the Certificates & Secrets section, select Upload certificate and select the certificate to upload from your local machine.
   • Option 2 - Create a new application secret: In the Certificates & Secrets section, select New Client Secret for the app and select its duration. After saving the client secret, the key value is displayed. Copy this value as it is displayed only once, and it is used as the OAuthClientSecret.
6. In the Authentication tab, make sure to check the option: Access tokens (used for implicit flows).
7. Open the Subscriptions page by searching and selecting the Subscriptions service from the search bar.
8. Select the particular subscription to assign the application to, then open the Access control (IAM) section, and click on the Add role assignment button.
9. Select Owner as the role to assign to your created OAuth app.

Follow the steps below to authenticate with the credentials for a custom OAuth app. See Creating a Custom OAuth App.

Authentication with Your OAuth App

There are two types of app authentication available: using a client secret and using a certificate. You can use any of them depending on the configured app authentication.

Get an OAuth Access Token

You are ready to connect after setting one of the below connection properties groups depending on the authentication type.

1. Authenticating using a Client Secret
   • AuthScheme: Set this to the "AzureServicePrincipal" in your app settings.
   • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
   • AzureTenant: Set this to the tenant you wish to connect to.
   • OAuthClientId: Set this to the Client ID in your app settings.
   • OAuthClientSecret: Set this to the Client Secret in your app settings.
2. Authenticating using a Certificate
   • AuthScheme: Set this to the "AzureServicePrincipal" in your app settings.
   • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
   • AzureTenant: Set this to the tenant you wish to connect to.
   • OAuthClientId: Set this to the Client ID in your app settings.
   • OAuthJWTCert: Set this to the JWT Certificate store.
   • OAuthJWTCertType: Set this to the type of the certificate store specified by OAuthJWTCert.

This section details a selection of advanced features of the Azure 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.

The Jitterbit Connector for Azure Data Catalog 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.

Defining 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 Tables 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"

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.

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

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

Overview

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

Key Features

• The connector models Azure Data Catalog entities like custom data sources, data assets, and data asset annotations as relational views, allowing you to write SQL to query Azure Data Catalog data.
• Live connectivity to these objects means any changes to your Azure Data Catalog account are immediately reflected when using the connector.

Views

Views describes the available views. Views are statically defined to model Custom Data Sources, Data Assets, Data Asset Annotations, and more.

Collaborative Query Processing

The connector offloads as much of the SELECT statement processing as possible to Azure Data Catalog and then processes the rest of the query in memory. API limitations and requirements are also documented in this section.

See SupportEnhancedSQL for more information on how the connector circumvents API limitations with in-memory client-side processing.

Views are composed of columns and pseudo columns. Views are similar to tables in the way that data is represented; however, views do not support updates. Entities that are represented as views are typically read-only entities. Often, a stored procedure* is available to update the data if such functionality is applicable to the data source.

Queries can be executed against a view as if it were a normal table, and the data that comes back is similar in that regard. To find out more about tables and stored procedures, please navigate to their corresponding entries in this help document.

Jitterbit Connector for Azure Data Catalog Views

Name	Description
ColumnDataProfiles	Get list of column data profiles.
CustomDataSourceProperties	Get Identity properties of Custom Data Sources.
CustomDataSources	Retrieves list of custom data sources, which are registered with the catalog.
Databases	Get list of databases.
Descriptions	Get list of descriptions of databases, tables, and objects.
Experts	Get list of experts of databases, tables, and objects.
Objects	Get list datasource properties.
TableColumns	Get details of table schema.
TableDataProfiles	Get list of table data profiles.
Tables	Get list of tables in the data asset.
Tags	Get list of tags of databases, tables, and objects.

Get list of column data profiles.

Table Specific Information

Select

The connector will use the Azure 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.
Note: ItemId is required in order to query ColumnDataProfiles.

• ItemId supports the '=' operator.

For example:

    SELECT * FROM ColumnDataProfiles WHERE ItemId = '8a2b7305-b474-45d6-9fba-562454045070'

Columns

Name	Type	Description
ItemId [KEY]	String	Item ID of a view or table.
ColumnName	String	The name of the column.
Type	String	The type of the column.
Min	String	The minimum value in the data set.
Max	String	The maximum value in the data set.
Avg	Decimal	The average value in the data set.
Stdev	Double	The standard deviation for the data set.
NullCount	Integer	The count of null values in the data set.
DistinctCount	Integer	The count of distinct values in the data set.

Get Identity properties of Custom Data Sources.

Table Specific Information

Select

No filters are supported server side for this table. All criteria will be handled client side within the connector.

Columns

Name	Type	Description
Namespace	String	Qualified name of the custom data source protocol.
Name	String	Name of the custom data source property.
Type	String	Data type of the custom data source property.

Retrieves list of custom data sources, which are registered with the catalog.

Table Specific Information

Select

No filters are supported server side for this table. All criteria will be handled client side within the connector.

Columns

Name	Type	Description
Id	String	Id of a custom data source.
Name	String	Name of a custom data source.
Namespace	String	Qualified name of the custom data source protocol.
Timestamp	Datetime	It contains the date and time at which an event occurred.
IdentitySets	String	Property of identity sets.

Get list of databases.

Table Specific Information

Select

The connector will use the Azure 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' operators.
• Timestamp supports the '=, <, <=, >, >=, CONTAINS' operators.
• LastRegisteredTime supports the '=, CONTAINS' operators.
• ObjectType supports the '=' operator.
• SourceType supports the '=' operator.
• FriendlyName supports the '=, CONTAINS' operators.
• Experts supports the '=, CONTAINS' operators.
• Description supports the '=, CONTAINS' operators.
• Tags supports the '=, !=, <>, CONTAINS' operators.
• HasTags supports the '=' operator.
• HasPreviews supports the '=' operator.
• HasDocumentation supports the '=' operator.
• HasTableDataProfiles supports the '=' operator.
• HasColumnsDataProfiles supports the '=' operator.
• HasDescription supports the '=' operator.
• View supports the '=' operator.
• Facets supports the '=' operator.

For example:

    SELECT * FROM Databases WHERE HasDocumentation=false AND HasDescription = false AND HasTags = true;

    SELECT * FROM Databases WHERE Timestamp > '2019-09-19T04:39:54.0083651Z'

    SELECT * FROM Databases WHERE Tags = 'sales' OR Name = 'FactProductInventory'

Columns

Name	Type	Description
Id	String	Id of a database.
Type	String	Type of database.
EffectiveRights	String	Rights a particular annotation has.
Roles	String	Roles of a database.
RoleMembers	String	Members whom roles was assigned.
Timestamp	Datetime	Created time of database.
Name	String	Name of a property.
ObjectType	String	Type of object. Eg. table, etc.
SourceType	String	Source type. Eg. Jdbc, Odbc, etc.
DslAddressDatabase	String	DSL address of a database.
DslAuthentication	String	Type of authentication used.
DslProtocol	String	Describes a protocol used to communicate with the data source.
FromSourceSystem	Boolean	Indicates whether data of an item is derived from a source system or authored by a user.
LastRegisteredByObjectId	String	Object ID of a last registered user.
LastRegisteredByUpn	String	Upn of last registered user.
AccessInstructionsId	String	Id of an access instructions.
AccessInstructionsType	String	Type of an access instructions.
AccessInstructionsEffectiveRights	String	Effective rights of a particular access instructions.
AccessInstructionsMimeType	String	Mime type of access instructions.
AccessInstructionsContent	String	Content of an access instructions.
AccessInstructionsFromSourceSystem	Boolean	Indicates whether data of an item is derived from a source system or authored by a user.
AccessInstructionsRoles	String	Roles of Database.
AccessInstructionsRoleMembers	String	Members whom roles was assigned.
AccessInstructionsTimestamp	Datetime	Created time of access instructions.
DocumentationType	String	Type of documentation.
DocumentationId	String	Id of a documentation.
DocumentationEffectiveRights	String	Rights a particular documentation has.
DocumentationMimeType	String	Mime type a documentation.
DocumentationContent	String	Content of a documentation.
DocumentationFromSourceSystem	Boolean	Indicates whether data of an item is derived from a source system or authored by a user.
DocumentationRoles	String	Roles of a documentation.
DocumentationRoleMembers	String	Members whom roles was assigned.
DocumentationTimestamp	Datetime	Created time of other:mirror=
FriendlyName	String	Name of a friendly name.
FriendlyNameId	String	Id of a friendly name.
FriendlyNameType	String	Type of friendly name.
FriendlyNameEffectiveRights	String	Rights a particular friendly name has.
FriendlyNameFromSourceSystem	Boolean	Indicates whether data of an item is derived from a source system or authored by a user.
FriendlyNameRoles	String	Roles of friendly name.
FriendlyNameRoleMembers	String	Members whom roles was assigned.
FriendlyNameTimestamp	Datetime	Created time of friendly name.
Experts	String	Check items where the data source expert matches the search term.
Description	String	Description of databases.
Tags	String	Tags available in databases.
Facets	String	A comma separated field names to facet the results on.
View	String	Name of the view the client wants to see.
HasTags	Boolean	Check items that have a tag.
HasPreviews	Boolean	Check items that contain a preview.
HasDocumentation	Boolean	Check items that contain documentation.
HasTableDataProfiles	Boolean	Check items that have a table profile.
HasColumnsDataProfiles	Boolean	Check items that have a columns data profile.
HasDescription	Boolean	Check items that have a description.

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
LastRegisteredTime	Date	Date and time when the metadata was registered.

Get list of descriptions of databases, tables, and objects.

Table Specific Information

Select

The connector will use the Azure 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' operators.
• Timestamp supports the '=, <, <=, >, >=, CONTAINS' operators.
• LastRegisteredTime supports the '=, CONTAINS' operators.
• ObjectType supports the '=' operator.
• SourceType supports the '=' operator.
• FriendlyName supports the '=, CONTAINS' operators.
• Experts supports the '=, CONTAINS' operators.
• Description supports the '=, CONTAINS' operators.
• Tags supports the '=, !=, <>, CONTAINS' operators.
• HasTags supports the '=' operator.
• HasPreviews supports the '=' operator.
• HasDocumentation supports the '=' operator.
• HasTableDataProfiles supports the '=' operator.
• HasColumnsDataProfiles supports the '=' operator.
• HasDescription supports the '=' operator.
• View supports the '=' operator.
• Facets supports the '=' operator.

For example:

    SELECT * FROM Descriptions WHERE CONTAINS(Description,'sakila') AND ObjectType = table;

    SELECT * FROM Descriptions WHERE CONTAINS(Name,'customer') AND HasTags = true;

Columns

Name	Type	Description
Id	String	Id of a description.
Type	String	Type of description.
EffectiveRights	String	Rights a particular annotation has.
PropertyDescription	String	Content in description.
PropertyFromSourceSystem	Boolean	Indicates whether data of an item is derived from a source system or authored by a user.
PropertyKey	String	Key of a description.
Roles	String	Roles of a description.
RoleMembers	String	Members whom roles was assigned.
Timestamp	Datetime	Created time of description.
Name	String	Name of a table, database, object.
ObjectType	String	Type of object. Eg. table, etc.
SourceType	String	Source type. Eg. Jdbc, Odbc, etc.
FriendlyName	String	Check items where the search term appears in the data source friendly name.
Experts	String	Check items where the data source expert matches the search term.
Description	String	Content of a description.
Tags	String	Tags available in descriptions.
HasTags	Boolean	Check items that have a tag.
HasPreviews	Boolean	Check items that contain preview
HasDocumentation	Boolean	Check items that contain documentation.
HasTableDataProfiles	Boolean	Check items that have a table profile.
HasColumnsDataProfiles	Boolean	Check items that have a columns data profile.
HasDescription	Boolean	Check items that have a description.
View	String	Name of the view the client wants to see.
Facets	String	A comma separated field names to facet the results on.

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
LastRegisteredTime	Date	Date and time when the metadata was registered.

Get list of experts of databases, tables, and objects.

Table Specific Information

Select

The connector will use the Azure 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' operators.
• Timestamp supports the '=, <, <=, >, >=, CONTAINS' operators.
• LastRegisteredTime supports the '=, CONTAINS' operators.
• ObjectType supports the '=' operator.
• SourceType supports the '=' operator.
• FriendlyName supports the '=, CONTAINS' operators.
• Experts supports the '=, CONTAINS' operators.
• Description supports the '=, CONTAINS' operators.
• Tags supports the '=, !=, <>, CONTAINS' operators.
• HasTags supports the '=' operator.
• HasPreviews supports the '=' operator.
• HasDocumentation supports the '=' operator.
• HasTableDataProfiles supports the '=' operator.
• HasColumnsDataProfiles supports the '=' operator.
• HasDescription supports the '=' operator.
• View supports the '=' operator.
• Facets supports the '=' operator.

For example:

    SELECT * FROM Experts WHERE ObjectType = 'table' AND CONTAINS(Experts,'support')

    SELECT * FROM Experts WHERE Tags = 'orders' OR Name = 'orders' AND ObjectType = 'table';

Columns

Name	Type	Description
Id	String	Id of an expert.
Type	String	Type of expert.
EffectiveRights	String	Rights a particular annotation has.
FromSourceSystem	Boolean	Indicates whether data of an item is derived from a source system or authored by a user.
Key	String	Key of an expert.
ExpertObjectId	String	Object ID of an expert.
ExpertUPN	String	User Principal Name of an expert.
Roles	String	Roles of an expert.
RoleMembers	String	Members whom roles was assigned.
Timestamp	Datetime	Created time of experts.
Name	String	Name of a table, database, object.
ObjectType	String	Type of object. Eg. table, etc.
SourceType	String	Source type. Eg. Jdbc, Odbc, etc.
FriendlyName	String	Check items where the search term appears in the data source friendly name.
Experts	String	Check items where the data source expert matches the search term.
Description	String	Description of an expert.
Tags	String	Tags available for experts.
HasTags	Boolean	Check items that have a tag.
HasPreviews	Boolean	Check items that contain a preview.
HasDocumentation	Boolean	Check items that contain documentation.
HasTableDataProfiles	Boolean	Check items that have a table profile.
HasColumnsDataProfiles	Boolean	Check items that have a columns data profile.
HasDescription	Boolean	Check items that have a description.
View	String	Name of the view the client wants to see.
Facets	String	A comma separated field names to facet the results on.

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
LastRegisteredTime	Date	Date and time when the metadata was registered.

Get list datasource properties.

Table Specific Information

Select

The connector will use the Azure 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' operators.
• Timestamp supports the '=, <, <=, >, >=, CONTAINS' operators.
• LastRegisteredTime supports the '=, CONTAINS' operators.
• ObjectType supports the '=' operator.
• SourceType supports the '=' operator.
• FriendlyName supports the '=, CONTAINS' operators.
• Experts supports the '=, CONTAINS' operators.
• Description supports the '=, CONTAINS' operators.
• Tags supports the '=, !=, <>, CONTAINS' operators.
• HasTags supports the '=' operator.
• HasPreviews supports the '=' operator.
• HasDocumentation supports the '=' operator.
• HasTableDataProfiles supports the '=' operator.
• HasColumnsDataProfiles supports the '=' operator.
• HasDescription supports the '=' operator.
• View supports the '=' operator.
• Facets supports the '=' operator.

For example:

    SELECT * FROM Objects WHERE Tags <> 'sales';

    SELECT * FROM Objects WHERE Name = 'sales' AND HasTags = true;

    SELECT * FROM Objects WHERE CONTAINS(Tags,'sales') AND CONTAINS(Tags,'customer');

Columns

Name	Type	Description
Id	String	Id of an Object.
Type	String	Type of an Object.
EffectiveRights	String	Rights a particular annotation has.
Name	String	Name of an Object.
ObjectType	String	Type of object. Eg. table, etc.
SourceType	String	Source type. Eg. Jdbc, Odbc, etc.
DslAuthentication	String	Type of authentication used.
DslProtocol	String	Describes a protocol used to communicate with the data source.
FromSourceSystem	Boolean	Indicates whether data of an item is derived from a source system or authored by a user.
LastRegisteredByObjectId	String	Object ID of a user.
LastRegisteredByUpn	String	User Principal Name of a user.
Roles	String	Roles of Database.
RoleMembers	String	Members whom roles was assigned.
Timestamp	Datetime	Created time of an Object.
AccessInstructionsId	String	Id of access instructions.
AccessInstructionsType	String	Type of access instructions.
AccessInstructionsEffectiveRights	String	Rights a particular annotation has.
AccessInstructionsMimeType	String	Mime type of a documentation.
AccessInstructionsContent	String	Content of a documentation.
AccessInstructionsFromSourceSystem	Boolean	Indicates whether data of an item is derived from a source system or authored by a user.
AccessInstructionsRoles	String	Roles of an object.
AccessInstructionsRoleMembers	String	Members whom roles was assigned.
AccessInstructionsTimestamp	Datetime	Created time of an object.
FriendlyName	String	Check items where the search term appears in the data source friendly name.
Experts	String	Check items where the data source expert matches the search term.
Description	String	Description of objects.
Tags	String	Tags available for objects.
HasTags	Boolean	Check items that have a tag.
HasPreviews	Boolean	Check items that contain a preview.
HasDocumentation	Boolean	Check items that contain documentation.
HasTableDataProfiles	Boolean	Check items that have a table profile.
HasColumnsDataProfiles	Boolean	Check items that have a columns data profile.
HasDescription	Boolean	Check items that have a description.
View	String	Name of the view the client wants to see.
Facets	String	A comma separated field names to facet the results on.

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
LastRegisteredTime	String	Date and time when the metadata was registered.

Get details of table schema.

Table Specific Information

Select

The connector will use the Azure 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.

• ItemId supports the '=' operator.

For example:

    SELECT * FROM TableColumns WHERE ItemId = '8a2b7305-b474-45d6-9fba-57e954565070'

Columns

Name	Type	Description
Database	String	Name of the database.
TableName	String	Name of the table.
ColumnName	String	Name of the column or attribute.
Type	String	Data type of the column or attribute. The Allowable types depend on data sourceType of the asset.
MaxLength	Integer	The maximum length allowed for the column or attribute. Derived from data source.
Precision	Integer	The precision for the column or attribute. Derived from data source.
IsNullable	Boolean	Whether the column is allowed to have a null value or not. Derived from data source.
Expression	String	If the value is a calculated column, this field contains the expression that expresses the value. Derived from data source.
ItemId	String	Item ID of a view or table.

Get list of table data profiles.

Table Specific Information

Select

The connector will use the Azure 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' operators.
• Timestamp supports the '=, <, <=, >, >=, CONTAINS' operators.
• LastRegisteredTime supports the '=, CONTAINS' operators.
• ObjectType supports the '=' operator.
• SourceType supports the '=' operator.
• FriendlyName supports the '=, CONTAINS' operators.
• Experts supports the '=, CONTAINS' operators.
• Description supports the '=, CONTAINS' operators.
• Tags supports the '=, !=, <>, CONTAINS' operators.
• HasTags supports the '=' operator.
• HasPreviews supports the '=' operator.
• HasDocumentation supports the '=' operator.
• HasTableDataProfiles supports the '=' operator.
• HasColumnsDataProfiles supports the '=' operator.
• HasDescription supports the '=' operator.
• View supports the '=' operator.
• Facets supports the '=' operator.

For example:

    SELECT * FROM TableDataProfiles WHERE NOT Tags = 'FactProductInventory'

    SELECT * FROM TableDataProfiles WHERE Timestamp > '2019-09-20T04:39:54.0083651Z';

Columns

Name	Type	Description
Id	String	Id of a table data profile.
Type	String	Type of table data profile.
EffectiveRights	String	Rights a particular table data profile has.
Tag	String	Name of the tag.
FromSourceSystem	Boolean	Indicates whether data of an item is derived from a source system or authored by a user.
Key	String	Key of a table data profiles.
Roles	String	Roles of table data profiles.
RoleMembers	String	Members whom roles was assigned.
Timestamp	Datetime	Created time of table data profiles.
SourceType	String	Source type. Eg. Jdbc, Odbc, etc.
FriendlyName	String	Check items where the search term appears in the data source friendly name.
Experts	String	Check items where the data source expert matches the search term.
Description	String	Description of table data profiles.
Tags	String	Tags available in table data profiles.
HasTags	Boolean	Check items that have a tag.
HasPreviews	Boolean	Check items that contain preview
HasDocumentation	Boolean	Check items that contain documentation
HasTableDataProfiles	Boolean	Check items that have a table profile.
HasColumnsDataProfiles	Boolean	Check items that have a columns data profile.
HasDescription	Boolean	Check items that have a description.
View	String	Name of the view the client wants to see.
Facets	String	A comma separated field names to facet the results on.

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
LastRegisteredTime	Date	Date and time when the metadata was registered

Get list of tables in the data asset.

Table Specific Information

Select

The connector will use the Azure 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' operators.
• Timestamp supports the '=, <, <=, >, >=, CONTAINS' operators.
• LastRegisteredTime supports the '=, CONTAINS' operators.
• ObjectType supports the '=' operator.
• SourceType supports the '=' operator.
• FriendlyName supports the '=, CONTAINS' operators.
• Experts supports the '=, CONTAINS' operators.
• Description supports the '=, CONTAINS' operators.
• Tags supports the '=, !=, <>, CONTAINS' operators.
• HasTags supports the '=' operator.
• HasPreviews supports the '=' operator.
• HasDocumentation supports the '=' operator.
• HasTableDataProfiles supports the '=' operator.
• HasColumnsDataProfiles supports the '=' operator.
• HasDescription supports the '=' operator.
• View supports the '=' operator.
• Facets supports the '=' operator.

For example:

    SELECT * FROM Tables WHERE Tags = 'sales' OR Name = 'FactProductInventory';

    SELECT * FROM Tables WHERE Tags != 'FactProductInventory' AND NOT Tags = 'sales';

    SELECT * FROM Tables WHERE NOT Tags = 'FactProductInventory';

Columns

Name	Type	Description
Id	String	Id of a table.
Type	String	Type of table.
EffectiveRights	String	Rights a particular annotation has.
Roles	String	Roles of a table.
RoleMembers	String	Members to whom the role was assigned.
Timestamp	Datetime	Created time of table.
ItemId	String	Item ID of the table or view.
Name	String	Name of a table.
ContainerId	String	Id of a container.
ObjectType	String	Type of object. Eg. table, etc.
SourceType	String	Source type. Eg. Jdbc, Odbc, etc.
DslAddressDatabase	String	Name of the database.
DslAddressObject	String	Object of a table.
DslAddressOptionsDriver	String	Name of the driver.
DslAddressOptionsPort	String	Port number.
DslAddressOptionsServer	String	IP address of the server.
DslAuthentication	String	Type of authentication used.
DslProtocol	String	Describes a protocol used to communicate with the data source.
FromSourceSystem	Boolean	Indicates whether data of an item is derived from a source system or authored by a user.
LastRegisteredByFirstName	String	First name of the registered user.
LastRegisteredByLastName	String	Last name of the registered user.
LastRegisteredByObjectId	String	Object ID of a user.
LastRegisteredByUpn	String	User Principal Name of a user.
AccessInstructionsId	String	Id of access instructions.
AccessInstructionsType	String	Type of access instructions.
AccessInstructionsEffectiveRights	String	Rights a particular annotation has.
AccessInstructionsMimeType	String	Mime type of access instructions.
AccessInstructionsContent	String	Content described in access instructions.
AccessInstructionsFromSourceSystem	Boolean	Indicates whether data of an item is derived from a source system or authored by a user.
AccessInstructionsRoles	String	Roles of table.
AccessInstructionsRoleMembers	String	Members to whom the role was assigned.
AccessInstructionsTimestamp	Datetime	Created time of table.
SchemaId	String	Id of a schema.
SchemaType	String	Type of schema.
SchemaEffectiveRights	String	Rights a particular annotation has.
SchemaFromSourceSystem	Boolean	Indicates whether data of an item is derived from a source system or authored by a user.
SchemaRoles	String	Roles of an schema for table.
SchemaRoleMembers	String	Members whom roles was assigned.
SchemaTimestamp	Datetime	Created time of an schema for table.
DocumentationId	String	Id of a documentation.
DocumentationType	String	Type of documentation.
DocumentationEffectiveRights	String	Rights a particular documentation has.
DocumentationMimeType	String	Mime type of a documentation.
DocumentationContent	String	Content of a documentation.
DocumentationFromSourceSystem	Boolean	Indicates whether data of an item is derived from a source system or authored by a user.
DocumentationRoles	String	Roles of an documentation for table.
DocumentationRoleMembers	String	Members whom roles was assigned.
DocumentationTimestamp	Datetime	Created time of an documentation for table.
FriendlyName	String	Name of a friendly name.
FriendlyNameId	String	Id of a friendly name.
FriendlyNameType	String	Type of friendly name.
FriendlyNameEffectiveRights	String	Rights a particular annotation has.
FriendlyNameFromSourceSystem	Boolean	Indicates whether data of an item is derived from a source system or authored by a user.
FriendlyNameRoles	String	Roles of an friendly name for table.
FriendlyNameRoleMembers	String	Members whom roles was assigned.
FriendlyNameTimestamp	Datetime	Created time of an friendly name for table.
Experts	String	Check items where the data source expert matches the search term.
Description	String	Description of table.
Tags	String	Tags available in tables.
HasTags	Boolean	Check items that have a tag.
HasPreviews	Boolean	Check items that contain preview.
HasDocumentation	Boolean	Check items that contain documentation.
HasTableDataProfiles	Boolean	Check items that have a table profile.
HasColumnsDataProfiles	Boolean	Check items that have a columns data profile.
HasDescription	Boolean	Check items that have a description.
View	String	Name of the view the client wants to see.
Facets	String	A comma separated field names to facet the results on.

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
LastRegisteredTime	Date	Date and time when the metadata was registered.

Get list of tags of databases, tables, and objects.

Table Specific Information

Select

The connector will use the Azure 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' operators.
• Timestamp supports the '=, <, <=, >, >=, CONTAINS' operators.
• LastRegisteredTime supports the '=, CONTAINS' operators.
• ObjectType supports the '=' operator.
• SourceType supports the '=' operator.
• FriendlyName supports the '=, CONTAINS' operators.
• Experts supports the '=, CONTAINS' operators.
• Description supports the '=, CONTAINS' operators.
• Tags supports the '=, !=, <>, CONTAINS' operators.
• HasTags supports the '=' operator.
• HasPreviews supports the '=' operator.
• HasDocumentation supports the '=' operator.
• HasTableDataProfiles supports the '=' operator.
• HasColumnsDataProfiles supports the '=' operator.
• HasDescription supports the '=' operator.
• View supports the '=' operator.
• Facets supports the '=' operator.

For example:

    SELECT * FROM Tags WHERE HasTags = 'true' AND CONTAINS(Name,'sales')

    SELECT * FROM Tags WHERE FriendlyName <> 'sales';

Columns

Name	Type	Description
Id	String	Id of the tag.
Type	String	Type of tag.
EffectiveRights	String	Rights a particular tag has.
Tag	String	Name of the tag.
FromSourceSystem	Boolean	Indicates whether item data is derived from a source system or authored by a user.
Key	String	Key of a tag.
Roles	String	Roles of tag.
RoleMembers	String	Members to whom the role was assigned.
Timestamp	Datetime	Created time of tag.
Name	String	Name of a table, database, object.
ObjectType	String	Type of object. Eg. table, etc.
SourceType	String	Source type. Eg. Jdbc, Odbc, etc.
FriendlyName	String	Check items where the search term appears in the data source friendly name.
Experts	String	Check items where the data source expert matches the search term.
Description	String	Description of the tag.
HasTags	Boolean	Check items that have a tag.
HasPreviews	Boolean	Check items that contain preview.
HasDocumentation	Boolean	Check items that contain documentation.
HasTableDataProfiles	Boolean	Check items that have a table profile.
HasColumnsDataProfiles	Boolean	Check items that have a columns data profile.
HasDescription	Boolean	Check items that have a description.
View	String	Name of the view the client wants to see.
Facets	String	A comma separated field names to facet the results on.

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
LastRegisteredTime	Date	Date and time when the tag was registered.

Stored procedures* are available to complement the data available from the Data Model. It may be necessary to update data available from a view using a stored procedure* because the data does not provide for direct, table-like, two-way updates. In these situations, the retrieval of the data is done using the appropriate view or table, while the update is done by calling a stored procedure. Stored procedures* take a list of parameters and return back a dataset that contains the collection of tuples that constitute the response.

Jitterbit Connector for Azure Data Catalog Stored Procedures

Name	Description
GetAdminConsentURL	Gets the admin consent URL that must be opened separately by an admin of a given domain to grant access to your application. Only needed when using custom OAuth credentials.
GetOAuthAccessToken	Gets an authentication token from AzureDataCatalog.
GetOAuthAuthorizationURL	Gets the authorization URL that must be opened separately by the user to grant access to your application. Only needed when developing Web apps. You will request the OAuthAccessToken from this URL.
RefreshOAuthAccessToken	Refreshes the OAuth access token used for authentication with AzureDataCatalog.

Gets the admin consent URL that must be opened separately by an admin of a given domain to grant access to your application. Only needed when using custom OAuth credentials.

Input

Name	Type	Description
CallbackUrl	String	The URL the user will be redirected to after authorizing your application. This value must match the Reply URL in the Azure AD app settings.
State	String	The same value for state that you sent when you requested the authorization code.

Result Set Columns

Name	Type	Description
URL	String	The authorization URL, entered into a Web browser to obtain the verifier token and authorize your app.

Gets an authentication token from AzureDataCatalog.

Input

Name	Type	Description
AuthMode	String	The type of authentication mode to use. Select App for getting authentication tokens via a desktop app. Select Web for getting authentication tokens via a Web app. The allowed values are APP, WEB. The default value is APP.
Scope	String	A comma-separated list of permissions to request from the user. Please check the AzureDataCatalog API for a list of available permissions. The default value is https://api.azuredatacatalog.com/user_impersonation offline_access.
CallbackUrl	String	The URL the user will be redirected to after authorizing your application. This value must match the Redirect URL you have specified in the AzureDataCatalog app settings. Only needed when the Authmode parameter is Web.
Verifier	String	The verifier returned from AzureDataCatalog after the user has authorized your app to have access to their data. This value will be returned as a parameter to the callback URL.
State	String	Indicates any state which may be useful to your application upon receipt of the response. Your application receives the same value it sent, as this parameter makes a round-trip to the AzureDataCatalog authorization server and back. Uses include redirecting the user to the correct resource in your site, nonces, and cross-site-request-forgery mitigations.
Prompt	String	Defaults to 'select_account' which prompts the user to select account while authenticating. Set to 'None', for no prompt, 'login' to force user to enter their credentials or 'consent' to trigger the OAuth consent dialog after the user signs in, asking the user to grant permissions to the app.

Result Set Columns

Name	Type	Description
OAuthAccessToken	String	The access token used for communication with AzureDataCatalog.
OAuthRefreshToken	String	The OAuth refresh token. This is the same as the access token in the case of AzureDataCatalog.
ExpiresIn	String	The remaining lifetime on the access token. A -1 denotes that it will not expire.

Gets the authorization URL that must be opened separately by the user to grant access to your application. Only needed when developing Web apps. You will request the OAuthAccessToken from this URL.

Input

Name	Type	Description
CallbackUrl	String	The URL the user will be redirected to after authorizing your application. This value must match the Redirect URL in the AzureDataCatalog app settings.
Scope	String	A comma-separated list of scopes to request from the user. Please check the AzureDataCatalog API documentation for a list of available permissions. The default value is https://api.azuredatacatalog.com/user_impersonation offline_access.
State	String	Indicates any state which may be useful to your application upon receipt of the response. Your application receives the same value it sent, as this parameter makes a round-trip to the AzureDataCatalog authorization server and back. Uses include redirecting the user to the correct resource in your site, nonces, and cross-site-request-forgery mitigations.
Prompt	String	Defaults to 'select_account' which prompts the user to select account while authenticating. Set to 'None', for no prompt, 'login' to force user to enter their credentials or 'consent' to trigger the OAuth consent dialog after the user signs in, asking the user to grant permissions to the app.

Result Set Columns

Name	Type	Description
URL	String	The authorization URL, entered into a Web browser to obtain the verifier token and authorize your app.

Refreshes the OAuth access token used for authentication with AzureDataCatalog.

Input

Name	Type	Description
OAuthRefreshToken	String	Set this to the token value that expired.

Result Set Columns

Name	Type	Description
OAuthAccessToken	String	The authentication token returned from AzureDataCatalog. This can be used in subsequent calls to other operations for this particular service.
OAuthRefreshToken	String	This is the same as the access token.
ExpiresIn	String	The remaining lifetime on the access token.

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

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.

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.

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.

Describes the columns of the available tables and views.

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

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

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.

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.

Describes stored procedure* parameters.

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

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

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.
DataTypeName	String	The name of the data type.
DataType	Int32	An integer indicating the data type. This value is determined at run time based on the environment.
Length	Int32	The number of characters allowed for character data. The number of digits allowed for numeric data.
NumericPrecision	Int32	The maximum precision for numeric data. The column length in characters for character and date-time 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.

Describes the primary and foreign keys. The following query retrieves the primary key for the Tables table:

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

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.

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.

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.

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

Name	Type	Description
Name	String	The name of the connection property.
ShortDescription	String	A brief description.
Type	String	The data type of the connection property.
Default	String	The default value if one is not explicitly set.
Values	String	A comma-separated list of possible values. A validation error is thrown if another value is specified.
Value	String	The value you set or a preconfigured default.
Required	Boolean	Whether the property is required to connect.
Category	String	The category of the connection property.
IsSessionProperty	String	Whether the property is a session property, used to save information about the current connection.
Sensitivity	String	The sensitivity level of the property. This informs whether the property is obfuscated in logging and authentication forms.
PropertyName	String	A camel-cased truncated form of the connection property name.
Ordinal	Int32	The index of the parameter.
CatOrdinal	Int32	The index of the parameter category.
Hierarchy	String	Shows dependent properties associated that need to be set alongside this one.
Visible	Boolean	Informs whether the property is visible in the connection UI.
ETC	String	Various miscellaneous information about the property.

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

Collaborative Query Processing

When working with data sources that do not support SQL-92, you can query the sys_sqlinfo view to determine the query capabilities of the underlying APIs, expressed in SQL syntax. The connector offloads as much of the SELECT statement processing as possible to the server and then processes the rest of the query in memory.

Discovering the Data Source's SELECT Capabilities

Below is an example data set of SQL capabilities. The following result set indicates the SELECT functionality that the connector can offload to the data source or process client side. Your data source may support additional SQL syntax. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.

Name	Description	Possible Values
AGGREGATE_FUNCTIONS	Supported aggregation functions.	AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNT	Whether COUNT function is supported.	YES, NO
IDENTIFIER_QUOTE_OPEN_CHAR	The opening character used to escape an identifier.	[
IDENTIFIER_QUOTE_CLOSE_CHAR	The closing character used to escape an identifier.	]
SUPPORTED_OPERATORS	A list of supported SQL operators.	=, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BY	Whether GROUP BY is supported, and, if so, the degree of support.	NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
STRING_FUNCTIONS	Supported string functions.	LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE
NUMERIC_FUNCTIONS	Supported numeric functions.	ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE
TIMEDATE_FUNCTIONS	Supported date/time functions.	NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT
REPLICATION_SKIP_TABLES	Indicates tables skipped during replication.
REPLICATION_TIMECHECK_COLUMNS	A string array containing a list of columns which will be used to check for (in the given order) to use as a modified column during replication.
IDENTIFIER_PATTERN	String value indicating what string is valid for an identifier.
SUPPORT_TRANSACTION	Indicates if the provider supports transactions such as commit and rollback.	YES, NO
DIALECT	Indicates the SQL dialect to use.
KEY_PROPERTIES	Indicates the properties which identify the uniform database.
SUPPORTS_MULTIPLE_SCHEMAS	Indicates if multiple schemas may exist for the provider.	YES, NO
SUPPORTS_MULTIPLE_CATALOGS	Indicates if multiple catalogs may exist for the provider.	YES, NO
DATASYNCVERSION	The Data Sync version needed to access this driver.	Standard, Starter, Professional, Enterprise
DATASYNCCATEGORY	The Data Sync category of this driver.	Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQL	Whether enhanced SQL functionality beyond what is offered by the API is supported.	TRUE, FALSE
SUPPORTS_BATCH_OPERATIONS	Whether batch operations are supported.	YES, NO
SQL_CAP	All supported SQL capabilities for this driver.	SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX
PREFERRED_CACHE_OPTIONS	A string value specifies the preferred cacheOptions.
ENABLE_EF_ADVANCED_QUERY	Indicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side.	YES, NO
PSEUDO_COLUMNS	A string array indicating the available pseudo columns.
MERGE_ALWAYS	If the value is true, The Merge Mode is forcibly executed in Data Sync.	TRUE, FALSE
REPLICATION_MIN_DATE_QUERY	A select query to return the replicate start datetime.
REPLICATION_MIN_FUNCTION	Allows a provider to specify the formula name to use for executing a server side min.
REPLICATION_START_DATE	Allows a provider to specify a replicate startdate.
REPLICATION_MAX_DATE_QUERY	A select query to return the replicate end datetime.
REPLICATION_MAX_FUNCTION	Allows a provider to specify the formula name to use for executing a server side max.
IGNORE_INTERVALS_ON_INITIAL_REPLICATE	A list of tables which will skip dividing the replicate into chunks on the initial replicate.
CHECKCACHE_USE_PARENTID	Indicates whether the CheckCache statement should be done against the parent key column.	TRUE, FALSE
CREATE_SCHEMA_PROCEDURES	Indicates stored procedures* that can be used for generating schema files.

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

SELECT * FROM sys_sqlinfo WHERE Name='SUPPORTED_OPERATORS'

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

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.

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.

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

---

Property	Description
AuthScheme	The type of authentication to use when connecting to Azure Data Catalog.
CatalogName	The name of the catalog to connect to.

Azure Authentication

---

Property	Description
AzureTenant	The Microsoft Online tenant being used to access data. If not specified, your default tentant will be used.
AzureEnvironment	The Azure Environment to use when establishing a connection.

OAuth

---

Property	Description
InitiateOAuth	Set this property to initiate the process to obtain or refresh the OAuth access token when you connect.
OAuthClientId	The client ID assigned when you register your application with an OAuth authorization server.
OAuthClientSecret	The client secret assigned when you register your application with an OAuth authorization server.
OAuthAccessToken	The access token for connecting using OAuth.
CallbackURL	The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings.
OAuthVerifier	The verifier code returned from the OAuth authorization URL.
OAuthRefreshToken	The OAuth refresh token for the corresponding OAuth access token.
OAuthExpiresIn	The lifetime in seconds of the OAuth AccessToken.
OAuthTokenTimestamp	The Unix epoch timestamp in milliseconds when the current Access Token was created.

JWT OAuth

---

Property	Description
OAuthJWTCert	The JWT Certificate store.
OAuthJWTCertType	The type of key store containing the JWT Certificate.
OAuthJWTCertPassword	The password for the OAuth JWT certificate.
OAuthJWTCertSubject	The subject of the OAuth JWT certificate.
OAuthJWTIssuer	The issuer of the Java Web Token.
OAuthJWTSubject	The user subject for which the application is requesting delegated access.

SSL

---

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

Schema

---

Property	Description
Location	A path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemas	This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA, SchemaB, SchemaC.
Tables	This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA, TableB, TableC.
Views	Restricts the views reported to a subset of the available tables. For example, Views=ViewA, ViewB, ViewC.

Miscellaneous

---

Property	Description
MaxRows	Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.
Other	These hidden properties are used only in specific use cases.
Pagesize	The maximum number of results to return per page from Azure Data Catalog.
PseudoColumns	This property indicates whether or not to include pseudo columns as columns to the table.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.

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

---

Property	Description
AuthScheme	The type of authentication to use when connecting to Azure Data Catalog.
CatalogName	The name of the catalog to connect to.

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

Possible Values

AzureAD, AzureMSI, AzureServicePrincipal

Data Type

string

Default Value

"AzureAD"

Remarks

• AzureAD: Set this to perform Azure Active Directory OAuth authentication.
• AzureMSI: Set this to automatically obtain Managed Service Identity credentials when running on an Azure VM.
• AzureServicePrincipal: Set this to authenticate as an Azure Service Principal.

The name of the catalog to connect to.

Data Type

string

Default Value

"defaultcatalog"

Remarks

If left blank, the default catalog will be used. To obtain a given CatalogName, navigate to the Azure Portal home page -> Data Catalog -> Catalog Name.

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

---

Property	Description
AzureTenant	The Microsoft Online tenant being used to access data. If not specified, your default tentant will be used.
AzureEnvironment	The Azure Environment to use when establishing a connection.

The Microsoft Online tenant being used to access data. If not specified, your default tentant will be used.

Data Type

string

Default Value

""

Remarks

The Microsoft Online tenant being used to access data. For instance, contoso.onmicrosoft.com. Alternatively, specify the tenant Id. This value is the directory ID in the Azure Portal > Azure Active Directory > Properties.

Typically it is not necessary to specify the Tenant. This can be automatically determined by Microsoft when using the OAuthGrantType set to CODE (default). However, it may fail in the case that the user belongs to multiple tenants. For instance, if an Admin of domain A invites a user of domain B to be a guest user. The user will now belong to both tenants. It is a good practice to specify the Tenant, although in general things should normally work without having to specify it.

The AzureTenant is required when setting OAuthGrantType to CLIENT. When using client credentials, there is no user context. The credentials are taken from the context of the app itself. While Microsoft still allows client credentials to be obtained without specifying which Tenant, it has a much lower probability of picking the specific tenant you want to work with. For this reason, we require AzureTenant to be explicitly stated for all client credentials connections to ensure you get credentials that are applicable for the domain you intend to connect to.

The Azure Environment to use when establishing a connection.

Possible Values

GLOBAL, CHINA, GERMANY, USGOVT, USGOVTDOD

Data Type

string

Default Value

"GLOBAL"

Remarks

In most cases, leaving the environment set to global will work. However, if your Azure Account has been added to a different environment, the AzureEnvironment may be used to specify which environment. The available values are GLOBAL, CHINA, GERMANY, USGOVT, and USGOVTDOD.

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

---

Property	Description
InitiateOAuth	Set this property to initiate the process to obtain or refresh the OAuth access token when you connect.
OAuthClientId	The client ID assigned when you register your application with an OAuth authorization server.
OAuthClientSecret	The client secret assigned when you register your application with an OAuth authorization server.
OAuthAccessToken	The access token for connecting using OAuth.
CallbackURL	The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings.
OAuthVerifier	The verifier code returned from the OAuth authorization URL.
OAuthRefreshToken	The OAuth refresh token for the corresponding OAuth access token.
OAuthExpiresIn	The lifetime in seconds of the OAuth AccessToken.
OAuthTokenTimestamp	The Unix epoch timestamp in milliseconds when the current Access Token was created.

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.

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.

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.

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.

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.

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 file. Set InitiateOAuth to GETANDREFRESH 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.

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.

The lifetime in seconds of the OAuth AccessToken.

Data Type

string

Default Value

""

Remarks

Pair with OAuthTokenTimestamp to determine when the AccessToken will expire.

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.

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

---

Property	Description
OAuthJWTCert	The JWT Certificate store.
OAuthJWTCertType	The type of key store containing the JWT Certificate.
OAuthJWTCertPassword	The password for the OAuth JWT certificate.
OAuthJWTCertSubject	The subject of the OAuth JWT certificate.
OAuthJWTIssuer	The issuer of the Java Web Token.
OAuthJWTSubject	The user subject for which the application is requesting delegated access.

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:

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

The type of key store containing the JWT Certificate.

Possible Values

USER, MACHINE, PFXFILE, PFXBLOB, JKSFILE, JKSBLOB, PEMKEY_FILE, PEMKEY_BLOB, PUBLIC_KEY_FILE, PUBLIC_KEY_BLOB, SSHPUBLIC_KEY_FILE, SSHPUBLIC_KEY_BLOB, P7BFILE, PPKFILE, XMLFILE, XMLBLOB

Data Type

string

Default Value

"USER"

Remarks

This property can take one of the following values:

USER	For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: This store type is not available in Java.
MACHINE	For Windows, this specifies that the certificate store is a machine store. Note: this store type is not available in Java.
PFXFILE	The certificate store is the name of a PFX (PKCS12) file containing certificates.
PFXBLOB	The certificate store is a string (base-64-encoded) representing a certificate store in PFX (PKCS12) format.
JKSFILE	The certificate store is the name of a Java key store (JKS) file containing certificates. Note: this store type is only available in Java.
JKSBLOB	The certificate store is a string (base-64-encoded) representing a certificate store in Java key store (JKS) format. Note: this store type is only available in Java.
PEMKEY_FILE	The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
PEMKEY_BLOB	The certificate store is a string (base64-encoded) that contains a private key and an optional certificate.
PUBLIC_KEY_FILE	The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
PUBLIC_KEY_BLOB	The certificate store is a string (base-64-encoded) that contains a PEM- or DER-encoded public key certificate.
SSHPUBLIC_KEY_FILE	The certificate store is the name of a file that contains an SSH-style public key.
SSHPUBLIC_KEY_BLOB	The certificate store is a string (base-64-encoded) that contains an SSH-style public key.
P7BFILE	The certificate store is the name of a PKCS7 file containing certificates.
PPKFILE	The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
XMLFILE	The certificate store is the name of a file that contains a certificate in XML format.
XMLBLOB	The certificate store is a string that contains a certificate in XML format.

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.

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.

Field	Meaning
CN	Common Name. This is commonly a host name like www.server.com.
O	Organization
OU	Organizational Unit
L	Locality
S	State
C	Country
E	Email Address

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

The issuer of the Java Web Token.

Data Type

string

Default Value

""

Remarks

The issuer of the Java Web Token. This is typically either the Client ID or Email Address of the OAuth Application.

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. Typically, the user account name or email address.

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

---

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

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:

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

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.

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

---

Property	Description
Location	A path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemas	This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA, SchemaB, SchemaC.
Tables	This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA, TableB, TableC.
Views	Restricts the views reported to a subset of the available tables. For example, Views=ViewA, ViewB, ViewC.

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

Data Type

string

Default Value

"%APPDATA%\\AzureDataCatalog 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%\\AzureDataCatalog Data Provider\Schema" with %APPDATA% being set to the user's configuration directory:

Platform	%APPDATA%
Windows	The value of the APPDATA environment variable
Mac	~/Library/Application Support
Linux	~/.config

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.

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.

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.

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

---

Property	Description
MaxRows	Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.
Other	These hidden properties are used only in specific use cases.
Pagesize	The maximum number of results to return per page from Azure Data Catalog.
PseudoColumns	This property indicates whether or not to include pseudo columns as columns to the table.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.

Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.

Data Type

int

Default Value

-1

Remarks

Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.

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

DefaultColumnSize	Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000.
ConvertDateTimeToGMT	Determines whether to convert date-time values to GMT, instead of the local time of the machine.
RecordToFile=filename	Records the underlying socket data transfer to the specified file.

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

Data Type

int

Default Value

100

Remarks

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

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, "*=*".

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.