Skip to Content

Azure Data Catalog Connection Details

Introduction

Connector Version

This documentation is based on version 23.0.8803 of the connector.

Get Started

Azure Data Catalog Version Support

The connector leverages version 2016-03-30 of the Azure Data Catalog API to enable read access to Azure Data Catalog.

Establish a Connection

Connect 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 catalogis is used.

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

Authenticate to Azure Data Catalog

Azure AD

Azure AD is Microsoft’s multi-tenant, cloud-based directory and identity management service. It is user-based authentication that requires that you set AuthScheme to AzureAD.

Desktop Applications

provides an embedded OAuth application that simplifies authentication at the desktop.

Before you connect, set the following variables:

  • InitiateOAuth: GETANDREFRESH. Used to automatically get and refresh the OAuthAccessToken. provides an embedded OAuth application that simplifies authentication at the desktop; that is, in situations where the user is using a local server not connected to the internet.

    You can also authenticate from the desktop via a custom OAuth application, which you configure and register at the Azure Data Catalog console. For further information, see Creating a Custom OAuth Application.

  • Custom Azure AD applications only:

    • OAuthClientId: The client ID assigned when you registered your custom OAuth application.
    • OAuthClientSecret: The client secret assigned when you registered your custom OAuth application.
    • CallbackURL: The redirect URI defined when you registered your custom OAuth application.

When you connect, the connector opens the Azure Data Catalog's 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. These values persist across connections.

When the access token expires, the connector refreshes it automatically.

Azure Service Principal

Azure Service Principal is role-based application-based authentication. This means that authentication is done per application, rather than per user. All tasks taken on by the application are executed without a default user context, but based on the assigned roles. The application access to the resources is controlled through the assigned roles' permissions.

For information about how to set up Azure Service Principal authentication, see

Create a Custom OAuth Application

Azure Data Catalog supports authentication using Azure AD and Azure Service Principal, both of which are OAuth-based.

This topic describes how to:

  • create and register custom OAuth application for Azure AD or Azure Service Principal
  • provide Admin Consent to a custom OAuth application
  • create a custom OAuth application for use with client credentials
Azure AD

In portal.azure.com:

  1. Log in to https://portal.azure.com.
  2. In the left-hand navigation pane, select Azure Active Directory, then applicationRegistrations.
  3. Click New registration.
  4. Enter a name for the application.
  5. Select the desired tenant setup: single- or multi-tenant, and public or private use.
    • If you select the default option, "Accounts in this organizational directory only", you must set the AzureTenant connection property to the ID of the Azure AD Tenant when establishing a connection with the Azure Data Catalog connector. Otherwise, the authentication attempt fails with an error.
    • If your application is for private use only, specify Accounts in this organization directory only.
    • If you want to distribute your application, choose one of the multi-tenant options.
  6. Set the redirect URL to http://localhost:33333 (the connector's default) OR specify a different port and set CallbackURL to the exact reply URL you defined.
  7. Click Register to register the new application. An application management screen displays.
    Note the value in Application (client) ID as the OAuthClientId and the Directory (tenant) ID as the AzureTenant.
  8. Navigate to Certificates & Secrets and define the application authentication type. There are two types of authentication available: certificate (recommended) or client secret.
    • For certificate authentication: In Certificates & Secrets, select Upload certificate, then upload the certificate from your local machine.
    • For creating a new client secret: In Certificates & Secrets, select New Client Secret for the application and specify its duration. After the client secret is saved, Azure Data Catalog displays the key value. Copy this value, as it is displayed only once. This value becomes the OAuthClientSecret.
  9. Select API Permissions > Add > Delegated permissions.
  10. Select Azure Data Catalog > Delegated Permissions > user_impersonation.
  11. Save your changes.
  12. If you have specified the use of permissions that require admin consent (such as the Application Permissions), you can grant them from the current tenant on the API Permissions page.
Azure Service Principal

To use Azure Service Principal authentication, you must set up the ability to assign a role to the authentication application, then register an application with the Azure AD tenant to create a new Service Principal. That new Service Principal can then leverage the assigned role-based access

control to access resources in your subscription.

In portal.azure.com:

  1. Create a custom OAuth AD application, as described above.
  2. Use the search bar to search for the Subscriptions service.
  3. Open the Subscriptions page.
  4. Select the subscription to which to assign the application.
  5. Open the Access control (IAM).
  6. Select Add > Add role assignment. Azure Data Catalog opens the Add role assignment page.
  7. Assign your custom Azure AD application the role of Owner.

Some custom applications require administrative permissions to operate within an Azure Active Directory tenant. Admin consent can be granted when creating a new custom OAuth application, by adding relevant permissions that are already marked with "Admin Consent Required". Admin consent is also required to use Client Credentials in the OAuth flow.

To grant admin consent:

  1. Have an admin log in to portal.azure.com.
  2. Navigate to App Registrations and find the custom OAuth application you created.
  3. Under API Permissions, click Grant Consent.

This gives your application permissions on the tenant under which it was created.

OAuth supports the use of client credentials to authenticate. In a client credentials OAuth flow, credentials are created for the authenticating application itself. The auth flow acts just like the usual auth flow except that there is no prompt for an associated user to provide credentials.

All tasks accepted by the application are executed outside of the context of a default user.

Note

Since the embedded OAuth credentials authenticate on a per-user basis, you cannot

use them in a client OAuth flow. You must always create a custom OAuth application to use client credentials.

In portal.azure.com:

  1. Create a custom OAuth application, as described above.
  2. Navigate to App Registrations.
  3. Find the application you just created, and open API Permissions.
  4. Select the Microsoft Graph permissions. There are two distinct sets of permissions: Delegated and Application.
  5. Under Application Permissions, select the permissions you require for your integration.

.

Managed Service Identity (MSI)

If you are running Azure Data Catalog on an Azure VM and want to leverage MSI to connect, set AuthScheme to AzureMSI.

User-Managed Identities

To obtain a token for a managed identity, use the OAuthClientId property to specify the managed identity's "client_id".

When your VM has multiple user-assigned managed identities, you must also specify OAuthClientId.

Use Azure Service Principal

Azure Service Principal

Azure Service Principal is role-based application-based authentication. This means that authentication is done per application, rather than per user. 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.

To use Azure Service Principal authentication, you must:

  • Set up the ability to assign a role to the authentication application. To do this, create a custom OAuth AD application, as described in

    Creating a Custom OAuth Application

    Azure Data Catalog supports authentication using Azure AD and Azure Service Principal, both of which are OAuth-based.

    This topic describes how to:

    • create and register custom OAuth application for Azure AD or Azure Service Principal
    • provide Admin Consent to a custom OAuth application
    • create a custom OAuth application for use with client credentials
    Azure AD

    In portal.azure.com:

    1. Log in to https://portal.azure.com.
    2. In the left-hand navigation pane, select Azure Active Directory, then applicationRegistrations.
    3. Click New registration.
    4. Enter a name for the application.
    5. Select the desired tenant setup: single- or multi-tenant, and public or private use.
      • If you select the default option, "Accounts in this organizational directory only", you must set the AzureTenant connection property to the ID of the Azure AD Tenant when establishing a connection with the Azure Data Catalog connector. Otherwise, the authentication attempt fails with an error.
      • If your application is for private use only, specify Accounts in this organization directory only.
      • If you want to distribute your application, choose one of the multi-tenant options.
    6. Set the redirect URL to http://localhost:33333 (the connector's default) OR specify a different port and set CallbackURL to the exact reply URL you defined.
    7. Click Register to register the new application. An application management screen displays.
      Note the value in Application (client) ID as the OAuthClientId and the Directory (tenant) ID as the AzureTenant.
    8. Navigate to Certificates & Secrets and define the application authentication type. There are two types of authentication available: certificate (recommended) or client secret.
      • For certificate authentication: In Certificates & Secrets, select Upload certificate, then upload the certificate from your local machine.
      • For creating a new client secret: In Certificates & Secrets, select New Client Secret for the application and specify its duration. After the client secret is saved, Azure Data Catalog displays the key value. Copy this value, as it is displayed only once. This value becomes the OAuthClientSecret.
    9. Select API Permissions > Add > Delegated permissions.
    10. Select Azure Data Catalog > Delegated Permissions > user_impersonation.
    11. Save your changes.
    12. If you have specified the use of permissions that require admin consent (such as the Application Permissions), you can grant them from the current tenant on the API Permissions page.
    Azure Service Principal

    To use Azure Service Principal authentication, you must set up the ability to assign a role to the authentication application, then register an application with the Azure AD tenant to create a new Service Principal. That new Service Principal can then leverage the assigned role-based access

    control to access resources in your subscription.

    In portal.azure.com:

    1. Create a custom OAuth AD application, as described above.
    2. Use the search bar to search for the Subscriptions service.
    3. Open the Subscriptions page.
    4. Select the subscription to which to assign the application.
    5. Open the Access control (IAM).
    6. Select Add > Add role assignment. Azure Data Catalog opens the Add role assignment page.
    7. Assign your custom Azure AD application the role of Owner.

    Some custom applications require administrative permissions to operate within an Azure Active Directory tenant. Admin consent can be granted when creating a new custom OAuth application, by adding relevant permissions that are already marked with "Admin Consent Required". Admin consent is also required to use Client Credentials in the OAuth flow.

    To grant admin consent:

    1. Have an admin log in to portal.azure.com.
    2. Navigate to App Registrations and find the custom OAuth application you created.
    3. Under API Permissions, click Grant Consent.

    This gives your application permissions on the tenant under which it was created.

    OAuth supports the use of client credentials to authenticate. In a client credentials OAuth flow, credentials are created for the authenticating application itself. The auth flow acts just like the usual auth flow except that there is no prompt for an associated user to provide credentials.

    All tasks accepted by the application are executed outside of the context of a default user.

Note

Since the embedded OAuth credentials authenticate on a per-user basis, you cannot

use them in a client OAuth flow. You must always create a custom OAuth application to use client credentials.

In portal.azure.com:

  1. Create a custom OAuth application, as described above.
  2. Navigate to App Registrations.
  3. Find the application you just created, and open API Permissions.
  4. Select the Microsoft Graph permissions. There are two distinct sets of permissions: Delegated and Application.
  5. Under Application Permissions, select the permissions you require for your integration.

.

  • Register an application with an Azure AD tenant, to create a new service principal that can be used with the role-based access control, to access resources in your subscription.

Do the following:

  1. Create a custom Azure AD application, as described in

    Creating a Custom OAuth Application

    Azure Data Catalog supports authentication using Azure AD and Azure Service Principal, both of which are OAuth-based.

    This topic describes how to:

    • create and register custom OAuth application for Azure AD or Azure Service Principal
    • provide Admin Consent to a custom OAuth application
    • create a custom OAuth application for use with client credentials
    Azure AD

    In portal.azure.com:

    1. Log in to https://portal.azure.com.
    2. In the left-hand navigation pane, select Azure Active Directory, then applicationRegistrations.
    3. Click New registration.
    4. Enter a name for the application.
    5. Select the desired tenant setup: single- or multi-tenant, and public or private use.
      • If you select the default option, "Accounts in this organizational directory only", you must set the AzureTenant connection property to the ID of the Azure AD Tenant when establishing a connection with the Azure Data Catalog connector. Otherwise, the authentication attempt fails with an error.
      • If your application is for private use only, specify Accounts in this organization directory only.
      • If you want to distribute your application, choose one of the multi-tenant options.
    6. Set the redirect URL to http://localhost:33333 (the connector's default) OR specify a different port and set CallbackURL to the exact reply URL you defined.
    7. Click Register to register the new application. An application management screen displays.
      Note the value in Application (client) ID as the OAuthClientId and the Directory (tenant) ID as the AzureTenant.
    8. Navigate to Certificates & Secrets and define the application authentication type. There are two types of authentication available: certificate (recommended) or client secret.
      • For certificate authentication: In Certificates & Secrets, select Upload certificate, then upload the certificate from your local machine.
      • For creating a new client secret: In Certificates & Secrets, select New Client Secret for the application and specify its duration. After the client secret is saved, Azure Data Catalog displays the key value. Copy this value, as it is displayed only once. This value becomes the OAuthClientSecret.
    9. Select API Permissions > Add > Delegated permissions.
    10. Select Azure Data Catalog > Delegated Permissions > user_impersonation.
    11. Save your changes.
    12. If you have specified the use of permissions that require admin consent (such as the Application Permissions), you can grant them from the current tenant on the API Permissions page.
    Azure Service Principal

    To use Azure Service Principal authentication, you must set up the ability to assign a role to the authentication application, then register an application with the Azure AD tenant to create a new Service Principal. That new Service Principal can then leverage the assigned role-based access

    control to access resources in your subscription.

    In portal.azure.com:

    1. Create a custom OAuth AD application, as described above.
    2. Use the search bar to search for the Subscriptions service.
    3. Open the Subscriptions page.
    4. Select the subscription to which to assign the application.
    5. Open the Access control (IAM).
    6. Select Add > Add role assignment. Azure Data Catalog opens the Add role assignment page.
    7. Assign your custom Azure AD application the role of Owner.

    Some custom applications require administrative permissions to operate within an Azure Active Directory tenant. Admin consent can be granted when creating a new custom OAuth application, by adding relevant permissions that are already marked with "Admin Consent Required". Admin consent is also required to use Client Credentials in the OAuth flow.

    To grant admin consent:

    1. Have an admin log in to portal.azure.com.
    2. Navigate to App Registrations and find the custom OAuth application you created.
    3. Under API Permissions, click Grant Consent.

    This gives your application permissions on the tenant under which it was created.

    OAuth supports the use of client credentials to authenticate. In a client credentials OAuth flow, credentials are created for the authenticating application itself. The auth flow acts just like the usual auth flow except that there is no prompt for an associated user to provide credentials.

    All tasks accepted by the application are executed outside of the context of a default user.

Note

Since the embedded OAuth credentials authenticate on a per-user basis, you cannot

use them in a client OAuth flow. You must always create a custom OAuth application to use client credentials.

In portal.azure.com:

  1. Create a custom OAuth application, as described above.
  2. Navigate to App Registrations.
  3. Find the application you just created, and open API Permissions.
  4. Select the Microsoft Graph permissions. There are two distinct sets of permissions: Delegated and Application.
  5. Under Application Permissions, select the permissions you require for your integration.

.

  1. Assign a role to the application:
    1. Use the search bar to search for the Subscriptions service.
    2. Open the Subscriptions page.
    3. Select the subscription to which to assign the application.
    4. Open the Access control (IAM).
    5. Select Add > Add role assignment. Azure Data Catalog opens the Add role assignment page.
    6. Assign your custom Azure AD application the role of Owner.

Admin consent occurs when the Admin for an Azure Active Directory tenant grants permissions to a custom application that explicitly requires an admin to consent to the use case.

When creating a new Azure AD application in the Azure Portal, you must specify which permissions the application requires. Some permissions may be marked as "Admin Consent Required". For example, all Groups permissions require Admin Consent. If your application requires admin consent, there are two ways you can do this.

The easiest way to grant admin consent is to have an admin log into portal.azure.com and navigate to the application you have created in App Registrations. Under API Permissions, click Grant Consent. This gives your application permissions on the tenant under which it was created.

If your organization has multiple tenants or you must grant application permissions for other tenants outside your organization, use the GetAdminConsentURL stored procedure to generate the Admin Authorization URL. Unlike the GetOAuthAuthorizationURL stored procedure, no important information is returned from this endpoint. Rather, after the OAuth application is successfully authorized, it returns a Boolean indicating that permissions have been granted.

After the administrator has approved the OAuth Application, you can continue to authenticate.

Client Credentials

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

All permissions related to the client OAuth flow require admin consent. This means you cannot use the application embedded with the Azure Data Catalog connector in the client OAuth flow. You must create your own OAuth application to use client credentials. See

Create a Custom OAuth Application

Azure Data Catalog supports authentication using Azure AD and Azure Service Principal, both of which are OAuth-based.

This topic describes how to:

  • create and register custom OAuth application for Azure AD or Azure Service Principal
  • provide Admin Consent to a custom OAuth application
  • create a custom OAuth application for use with client credentials
Azure AD

In portal.azure.com:

  1. Log in to https://portal.azure.com.
  2. In the left-hand navigation pane, select Azure Active Directory, then applicationRegistrations.
  3. Click New registration.
  4. Enter a name for the application.
  5. Select the desired tenant setup: single- or multi-tenant, and public or private use.
    • If you select the default option, "Accounts in this organizational directory only", you must set the AzureTenant connection property to the ID of the Azure AD Tenant when establishing a connection with the Azure Data Catalog connector. Otherwise, the authentication attempt fails with an error.
    • If your application is for private use only, specify Accounts in this organization directory only.
    • If you want to distribute your application, choose one of the multi-tenant options.
  6. Set the redirect URL to http://localhost:33333 (the connector's default) OR specify a different port and set CallbackURL to the exact reply URL you defined.
  7. Click Register to register the new application. An application management screen displays.
    Note the value in Application (client) ID as the OAuthClientId and the Directory (tenant) ID as the AzureTenant.
  8. Navigate to Certificates & Secrets and define the application authentication type. There are two types of authentication available: certificate (recommended) or client secret.
    • For certificate authentication: In Certificates & Secrets, select Upload certificate, then upload the certificate from your local machine.
    • For creating a new client secret: In Certificates & Secrets, select New Client Secret for the application and specify its duration. After the client secret is saved, Azure Data Catalog displays the key value. Copy this value, as it is displayed only once. This value becomes the OAuthClientSecret.
  9. Select API Permissions > Add > Delegated permissions.
  10. Select Azure Data Catalog > Delegated Permissions > user_impersonation.
  11. Save your changes.
  12. If you have specified the use of permissions that require admin consent (such as the Application Permissions), you can grant them from the current tenant on the API Permissions page.
Azure Service Principal

To use Azure Service Principal authentication, you must set up the ability to assign a role to the authentication application, then register an application with the Azure AD tenant to create a new Service Principal. That new Service Principal can then leverage the assigned role-based access

control to access resources in your subscription.

In portal.azure.com:

  1. Create a custom OAuth AD application, as described above.
  2. Use the search bar to search for the Subscriptions service.
  3. Open the Subscriptions page.
  4. Select the subscription to which to assign the application.
  5. Open the Access control (IAM).
  6. Select Add > Add role assignment. Azure Data Catalog opens the Add role assignment page.
  7. Assign your custom Azure AD application the role of Owner.

Some custom applications require administrative permissions to operate within an Azure Active Directory tenant. Admin consent can be granted when creating a new custom OAuth application, by adding relevant permissions that are already marked with "Admin Consent Required". Admin consent is also required to use Client Credentials in the OAuth flow.

To grant admin consent:

  1. Have an admin log in to portal.azure.com.
  2. Navigate to App Registrations and find the custom OAuth application you created.
  3. Under API Permissions, click Grant Consent.

This gives your application permissions on the tenant under which it was created.

OAuth supports the use of client credentials to authenticate. In a client credentials OAuth flow, credentials are created for the authenticating application itself. The auth flow acts just like the usual auth flow except that there is no prompt for an associated user to provide credentials.

All tasks accepted by the application are executed outside of the context of a default user.

Note

Since the embedded OAuth credentials authenticate on a per-user basis, you cannot

use them in a client OAuth flow. You must always create a custom OAuth application to use client credentials.

In portal.azure.com:

  1. Create a custom OAuth application, as described above.
  2. Navigate to App Registrations.
  3. Find the application you just created, and open API Permissions.
  4. Select the Microsoft Graph permissions. There are two distinct sets of permissions: Delegated and Application.
  5. Under Application Permissions, select the permissions you require for your integration.

for more information.

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 permissions and Application permissions. The permissions used during client credential authentication are under "Application Permissions".

Select the permissions you require for your integration. After you do this, set the following connection properties:

  • AuthScheme: AzureServicePrincipal.
  • InitiateOAuth: GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
  • AzureTenant: The tenant you wish to connect to.
  • OAuthGrantType: CLIENT.
  • OAuthClientId: The client ID in your application settings.
  • OAuthClientSecret: The client secret in your application settings.

Authentication with client credentials takes place automatically like any other connection, except there is 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.

Create a Custom OAuth Application

Create a Custom OAuth Application

Azure Data Catalog supports authentication using Azure AD and Azure Service Principal, both of which are OAuth-based.

This topic describes how to:

  • create and register custom OAuth application for Azure AD or Azure Service Principal
  • provide Admin Consent to a custom OAuth application
  • create a custom OAuth application for use with client credentials
Azure AD

In portal.azure.com:

  1. Log in to https://portal.azure.com.
  2. In the left-hand navigation pane, select Azure Active Directory, then applicationRegistrations.
  3. Click New registration.
  4. Enter a name for the application.
  5. Select the desired tenant setup: single- or multi-tenant, and public or private use.
    • If you select the default option, "Accounts in this organizational directory only", you must set the AzureTenant connection property to the ID of the Azure AD Tenant when establishing a connection with the Azure Data Catalog connector. Otherwise, the authentication attempt fails with an error.
    • If your application is for private use only, specify Accounts in this organization directory only.
    • If you want to distribute your application, choose one of the multi-tenant options.
  6. Set the redirect URL to http://localhost:33333 (the connector's default) OR specify a different port and set CallbackURL to the exact reply URL you defined.
  7. Click Register to register the new application. An application management screen displays.
    Note the value in Application (client) ID as the OAuthClientId and the Directory (tenant) ID as the AzureTenant.
  8. Navigate to Certificates & Secrets and define the application authentication type. There are two types of authentication available: certificate (recommended) or client secret.
    • For certificate authentication: In Certificates & Secrets, select Upload certificate, then upload the certificate from your local machine.
    • For creating a new client secret: In Certificates & Secrets, select New Client Secret for the application and specify its duration. After the client secret is saved, Azure Data Catalog displays the key value. Copy this value, as it is displayed only once. This value becomes the OAuthClientSecret.
  9. Select API Permissions > Add > Delegated permissions.
  10. Select Azure Data Catalog > Delegated Permissions > user_impersonation.
  11. Save your changes.
  12. If you have specified the use of permissions that require admin consent (such as the Application Permissions), you can grant them from the current tenant on the API Permissions page.
Azure Service Principal

To use Azure Service Principal authentication, you must set up the ability to assign a role to the authentication application, then register an application with the Azure AD tenant to create a new Service Principal. That new Service Principal can then leverage the assigned role-based access

control to access resources in your subscription.

In portal.azure.com:

  1. Create a custom OAuth AD application, as described above.
  2. Use the search bar to search for the Subscriptions service.
  3. Open the Subscriptions page.
  4. Select the subscription to which to assign the application.
  5. Open the Access control (IAM).
  6. Select Add > Add role assignment. Azure Data Catalog opens the Add role assignment page.
  7. Assign your custom Azure AD application the role of Owner.

Some custom applications require administrative permissions to operate within an Azure Active Directory tenant. Admin consent can be granted when creating a new custom OAuth application, by adding relevant permissions that are already marked with "Admin Consent Required". Admin consent is also required to use Client Credentials in the OAuth flow.

To grant admin consent:

  1. Have an admin log in to portal.azure.com.
  2. Navigate to App Registrations and find the custom OAuth application you created.
  3. Under API Permissions, click Grant Consent.

This gives your application permissions on the tenant under which it was created.

OAuth supports the use of client credentials to authenticate. In a client credentials OAuth flow, credentials are created for the authenticating application itself. The auth flow acts just like the usual auth flow except that there is no prompt for an associated user to provide credentials.

All tasks accepted by the application are executed outside of the context of a default user.

Note

Since the embedded OAuth credentials authenticate on a per-user basis, you cannot

use them in a client OAuth flow. You must always create a custom OAuth application to use client credentials.

In portal.azure.com:

  1. Create a custom OAuth application, as described above.
  2. Navigate to App Registrations.
  3. Find the application you just created, and open API Permissions.
  4. Select the Microsoft Graph permissions. There are two distinct sets of permissions: Delegated and Application.
  5. Under Application Permissions, select the permissions you require for your integration.

Important Notes

Configuration Files and Their Paths

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

Advanced Features

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

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 (client-side).

User Defined Views

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

There are two ways to create user defined views:

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

Define Views Using a Configuration File

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

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

This User Defined View configuration file is formatted as follows:

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

For example:

{
    "MyView": {
        "query": "SELECT * FROM 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"

Define Views Using DDL Statements

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

Create a View

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

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

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

Alter a View

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

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

The view is then updated in the JSON configuration file.

Drop a View

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

DROP LOCAL VIEW [MyViewName]

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

Schema for User Defined Views

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

Work with User Defined Views

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

SELECT * FROM Customers WHERE City = 'Raleigh';

An example of a query to the driver:

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

Resulting in the effective query to the source:

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

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

SSL Configuration

Customize the SSL Configuration

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

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

Data Model

Overview

This section shows the available API objects and provides more information on executing SQL to 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.

Views

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

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

ColumnDataProfiles

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.

CustomDataSourceProperties

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.

CustomDataSources

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.

Databases

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

Descriptions

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.

Experts

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.

Objects

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.

TableColumns

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.

TableDataProfiles

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.

Tables

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.

Tags

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

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

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

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

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.

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.

GetOAuthAccessToken

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.

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.

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.

RefreshOAuthAccessToken

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.

System Tables

You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.

Schema Tables

The following tables return database metadata for Azure Data Catalog:

Data Source Tables

The following tables return information about how to connect to and query the data source:

  • sys_connection_props: Returns information on the available connection properties.
  • sys_sqlinfo: Describes the SELECT queries that the connector can offload to the data source.

Query Information Tables

The following table returns query statistics for data modification queries:

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

sys_catalogs

Lists the available databases.

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

SELECT * FROM sys_catalogs
Columns
Name Type Description
CatalogName String The database name.

sys_schemas

Lists the available schemas.

The following query retrieves all available schemas:

SELECT * FROM sys_schemas
Columns
Name Type Description
CatalogName String The database name.
SchemaName String The schema name.

sys_tables

Lists the available tables.

The following query retrieves the available tables and views:

SELECT * FROM sys_tables
Columns
Name Type Description
CatalogName String The database containing the table or view.
SchemaName String The schema containing the table or view.
TableName String The name of the table or view.
TableType String The table type (table or view).
Description String A description of the table or view.
IsUpdateable Boolean Whether the table can be updated.

sys_tablecolumns

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.
IsReadOnly Boolean Whether the column is read-only.
IsKey Boolean Indicates whether a field returned from sys_tablecolumns is the primary key of the table.

sys_procedures

Lists the available stored procedures.

The following query retrieves the available stored procedures:

SELECT * FROM sys_procedures
Columns
Name Type Description
CatalogName String The database containing the stored procedure.
SchemaName String The schema containing the stored procedure.
ProcedureName String The name of the stored procedure.
Description String A description of the stored procedure.
ProcedureType String The type of the procedure, such as PROCEDURE or FUNCTION.

sys_procedureparameters

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.

sys_keycolumns

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.

sys_foreignkeys

Describes the foreign keys.

The following query retrieves all foreign keys which refer to other tables:

SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
Columns
Name Type Description
CatalogName String The name of the database containing the key.
SchemaName String The name of the schema containing the key.
TableName String The name of the table containing the key.
ColumnName String The name of the key column.
PrimaryKeyName String The name of the primary key.
ForeignKeyName String The name of the foreign key.
ReferencedCatalogName String The database containing the primary key.
ReferencedSchemaName String The schema containing the primary key.
ReferencedTableName String The table containing the primary key.
ReferencedColumnName String The column name of the primary key.
ForeignKeyType String Designates whether the foreign key is an import (points to other tables) or export (referenced from other tables) key.

sys_primarykeys

Describes the primary keys.

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

SELECT * FROM sys_primarykeys
Columns
Name Type Description
CatalogName String The name of the database containing the key.
SchemaName String The name of the schema containing the key.
TableName String The name of the table containing the key.
ColumnName String The name of the key column.
KeySeq String The sequence number of the primary key.
KeyName String The name of the primary key.

sys_indexes

Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.

The following query retrieves all indexes that are not primary keys:

SELECT * FROM sys_indexes WHERE IsPrimary='false'
Columns
Name Type Description
CatalogName String The name of the database containing the index.
SchemaName String The name of the schema containing the index.
TableName String The name of the table containing the index.
IndexName String The index name.
ColumnName String The name of the column associated with the index.
IsUnique Boolean True if the index is unique. False otherwise.
IsPrimary Boolean True if the index is a primary key. False otherwise.
Type Int16 An integer value corresponding to the index type: statistic (0), clustered (1), hashed (2), or other (3).
SortOrder String The sort order: A for ascending or D for descending.
OrdinalPosition Int16 The sequence number of the column in the index.

sys_connection_props

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

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

jdbc:cdata: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.

sys_sqlinfo

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

Discovering the Data Source's SELECT Capabilities

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

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.

sys_identity

Returns information about attempted modifications.

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

SELECT * FROM sys_identity
Columns
Name Type Description
Id String The database-generated ID returned from a data modification operation.
Batch String An identifier for the batch. 1 for a single operation.
Operation String The result of the operation in the batch: INSERTED, UPDATED, or DELETED.
Message String SUCCESS or an error message if the update in the batch failed.

Advanced Configurations Properties

The advanced configurations properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure. Click the links for further details.

Authentication

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 tenant is 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.
OAuthGrantType The grant type for the OAuth flow.
OAuthSettingsLocation The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH. Alternatively, you can hold this location in memory by specifying a value starting with 'memory://'.
OAuthSettingsLocation The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH . Alternatively, you can hold this location in memory by specifying a value starting with 'memory://'.
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.

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 when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
Other These hidden properties are used only in specific use cases.
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.
UserDefinedViews A filepath pointing to the JSON configuration file containing your custom views.

Authentication

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.

AuthScheme

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

Possible Values

AzureAD, AzureMSI, AzureServicePrincipal, AzureServicePrincipalCert

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 using a Client Secret.
  • AzureServicePrincipalCert: Set this to authenticate as an Azure Service Principal using a Certificate.

CatalogName

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.

Azure Authentication

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 tenant is used.
AzureEnvironment The Azure Environment to use when establishing a connection.

AzureTenant

The Microsoft Online tenant being used to access data. If not specified, your default tenant is 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.

AzureEnvironment

The Azure Environment to use when establishing a connection.

Possible Values

GLOBAL, CHINA, 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, USGOVT, USGOVTDOD.

OAuth

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.
OAuthGrantType The grant type for the OAuth flow.
OAuthSettingsLocation The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH. Alternatively, you can hold this location in memory by specifying a value starting with 'memory://'.
OAuthSettingsLocation The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH . Alternatively, you can hold this location in memory by specifying a value starting with 'memory://'.
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.

InitiateOAuth

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

Possible Values

OFF, GETANDREFRESH, REFRESH

Data Type

string

Default Value

OFF

Remarks

The following options are available:

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

OAuthClientId

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

Data Type

string

Default Value

""

Remarks

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

OAuthClientSecret

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

Data Type

string

Default Value

""

Remarks

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

OAuthAccessToken

The access token for connecting using OAuth.

Data Type

string

Default Value

""

Remarks

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

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

OAuthSettingsLocation

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

Data Type

string

Default Value

%APPDATA%\AzureDataCatalog Data Provider\OAuthSettings.txt

Remarks

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

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

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

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

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

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

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

CallbackURL

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

Data Type

string

Default Value

""

Remarks

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

OAuthVerifier

The verifier code returned from the OAuth authorization URL.

Data Type

string

Default Value

""

Remarks

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

Authentication on Headless Machines

See to obtain the OAuthVerifier value.

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

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

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

OAuthRefreshToken

The OAuth refresh token for the corresponding OAuth access token.

Data Type

string

Default Value

""

Remarks

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

OAuthExpiresIn

The lifetime in seconds of the OAuth AccessToken.

Data Type

string

Default Value

""

Remarks

Pair with OAuthTokenTimestamp to determine when the AccessToken will expire.

OAuthTokenTimestamp

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

Data Type

string

Default Value

""

Remarks

Pair with OAuthExpiresIn to determine when the AccessToken will expire.

JWT OAuth

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

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.

OAuthJWTCert

The JWT Certificate store.

Data Type

string

Default Value

""

Remarks

The name of the certificate store for the client certificate.

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

OAuthJWTCert is used in conjunction with the OAuthJWTCertSubject

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

Designations of certificate stores are platform-dependent.

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

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

OAuthJWTCertType

The type of key store containing the JWT Certificate.

Data Type

string

Default Value

USER

Remarks

This property can take one of the following values:

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

OAuthJWTCertPassword

The password for the OAuth JWT certificate.

Data Type

string

Default Value

""

Remarks

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

OAuthJWTCertSubject

The subject of the OAuth JWT certificate.

Data Type

string

Default Value

*

Remarks

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

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

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

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

The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, E=example@jbexample.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.

SSL

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.

SSLServerCert

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

Data Type

string

Default Value

""

Remarks

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

This property can take the following forms:

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.

Schema

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.

Location

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

BrowsableSchemas

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

Data Type

string

Default Value

""

Remarks

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

Tables

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

Data Type

string

Default Value

""

Remarks

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

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

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

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

Views

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

Data Type

string

Default Value

""

Remarks

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

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

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

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

Miscellaneous

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

Property Description
MaxRows Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
Other These hidden properties are used only in specific use cases.
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.
UserDefinedViews A filepath pointing to the JSON configuration file containing your custom views.

MaxRows

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

Data Type

int

Default Value

-1

Remarks

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

Other

These hidden properties are used only in specific use cases.

Data Type

string

Default Value

""

Remarks

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

Specify multiple properties in a semicolon-separated list.

Integration and Formatting
Property Description
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.

Pagesize

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.

PseudoColumns

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

Data Type

string

Default Value

""

Remarks

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

Timeout

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

Data Type

int

Default Value

60

Remarks

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

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

UserDefinedViews

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

Data Type

string

Default Value

""

Remarks

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

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

This User Defined View configuration file is formatted as follows:

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

For example:

{
    "MyView": {
        "query": "SELECT * FROM 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

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