Establishing a Connection

Create a connection to Azure Data Catalog by navigating to the Connections page in the Sync App application and selecting the corresponding icon in the Add Connections panel. If the Azure Data Catalog icon is not available, click the Add More icon to download and install the Azure Data Catalog connector from the CData site.

Required properties are listed under the Settings tab. The Advanced tab lists connection properties that are not typically required.

Connecting to Azure Data Catalog

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

CatalogName: Set this to the catalog name associated with your Azure Data Catalog. If left blank, the default catalogis is used.
To get your catalog name, navigate to the Azure Portal home page > Data Catalog > Catalog Name

Authenticating to Azure Data Catalog

Azure AD

Azure AD is a connection type that leverages OAuth to authenticate. OAuth requires the authenticating user to interact with Azure Data Catalog using an internet browser. The Sync App facilitates this in several ways as described below. Set your AuthScheme to AzureAD. All AzureAD flows assume that you have done so.

Desktop Applications

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

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

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

OAuthClientId: (custom applications only) Set this to the client Id in your application settings.
OAuthClientSecret: (custom applications only) Set this to the client secret in your application settings.
CallbackURL: Set this to the Redirect URL in your application settings.

When you connect the Sync App opens the OAuth endpoint in your default browser. Log in and grant permissions to the application.

Web Applications

When connecting via a Web application, you need to register a custom OAuth app with Azure Data Catalog. See Creating a Custom AzureAD App. You can then use the Sync App to get and manage the OAuth token values. Get an OAuth Access Token

Set one of the following connection properties groups depending on the authentication type to obtain the OAuthAccessToken:

Authenticating using a Client Secret
- OAuthClientId: Set this to the client Id in your app settings.
- OAuthClientSecret: Set this to the client secret in your app settings.
Authenticating using a Certificate
- OAuthClientId: Set this to the client Id in your app settings.
- OAuthJWTCert: Set this to the JWT Certificate store.
- OAuthJWTCertType: Set this to the type of the certificate store specified by OAuthJWTCert.

You can then call stored procedures to complete the OAuth exchange:

Call the GetOAuthAuthorizationURL stored procedure. Set the AuthMode input to WEB and set the CallbackURL input to the Redirect URI you specified in your app settings. If necessary, set the Permissions parameter to request custom permissions.

The stored procedure returns the URL to the OAuth endpoint.
Open the URL, log in, and authorize the application. You are redirected back to the callback URL.
Call the GetOAuthAccessToken stored procedure. Set the AuthMode input to WEB. Set the Verifier input to the "code" parameter in the query string of the callback URL. If necessary, set the Permissions parameter to request custom permissions.

To connect to data, set the OAuthAccessToken connection property to the access token returned by the stored procedure. When the access token expires after ExpiresIn seconds, call GetOAuthAccessToken again to obtain a new access token.

Admin Consent

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

Admin Consent Permissions

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

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

If your organization has multiple tenants or you need to grant application permissions for other tenants outside your organization, use the GetAdminConsentURL stored procedure to generate the Admin Authorization URL. Unlike the GetOAuthAuthorizationURL, there will be no important information returned from this endpoint. 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 app itself. All tasks taken by the app are done without a default user context. This makes the authentication flow a bit different from standard.

Client OAuth Flow

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

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

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

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

Authentication with client credentials 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.

Azure Service Principal

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

Note: You must create a custom application prior to assigning a role. See Creating a Custom AzureAD App for more information.

When authenticating using an Azure Service Principal, you must register an application with an Azure AD tenant. Follow the steps below to create a new service principal that can be used with the role-based access control.

Assign a role to the application

To access resources in your subscription, you must assign a role to the application.

Open the Subscriptions page by searching and selecting the Subscriptions service from the search bar.
Select the particular subscription to assign the application to.
Open the Access control (IAM) and select Add > Add role assignment to open the Add role assignment page.
Select Owner as the role to assign to your created Azure AD app.

Complete the Authentication

You are ready to connect after setting one of the below connection properties groups, depending on the configured app authentication (client secret or certificate).

In both methods

Before choosing client secret or certicate authentication, follow these steps then continue to the relevant section below:

AuthScheme: Set this to the AzureServicePrincipal in your app settings.
InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
AzureTenant: Set this to the tenant you wish to connect to.
OAuthClientId: Set this to the client Id in your app settings.

Authenticating using a Client Secret

Continue with the following:

OAuthClientId: Set this to the client Id in your app settings.
OAuthClientSecret: Set this to the client secret in your app settings.

Authenticating using a Certificate

Continue with the following:

OAuthJWTCert: Set this to the JWT Certificate store.
OAuthJWTCertType: Set this to the type of the certificate store specified by OAuthJWTCert.

MSI

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

AuthScheme: Set this to AzureMSI.

The MSI credentials are automatically obtained for authentication.

Advanced Features

This section details a selection of advanced features of the Azure Data Catalog Sync App.

User Defined Views

The Sync App 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 Sync App handles TLS/SSL certificate negotiations. You can choose from various certificate formats; see the SSLServerCert property under "Connection String Options" for more information.

Firewall and Proxy

Configure the Sync App for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.

Query Processing

The Sync App 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).

See Query Processing for more information.

Logging

See Logging for an overview of configuration settings that can be used to refine CData logging. For basic logging, you only need to set two connection properties, but there are numerous features that support more refined logging, where you can select subsets of information to be logged using the LogModules connection property.

SSL Configuration

Customizing the SSL Configuration

By default, the Sync App 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.

Firewall and Proxy

Connecting Through a Firewall or Proxy

HTTP Proxies

To connect through the Windows system proxy, you do not need to set any additional connection properties. To connect to other proxies, set ProxyAutoDetect to false.

In addition, to authenticate to an HTTP proxy, set ProxyAuthScheme, ProxyUser, and ProxyPassword, in addition to ProxyServer and ProxyPort.

Other Proxies

Set the following properties:

To use a proxy-based firewall, set FirewallType, FirewallServer, and FirewallPort.
To tunnel the connection, set FirewallType to TUNNEL.
To authenticate, specify FirewallUser and FirewallPassword.
To authenticate to a SOCKS proxy, additionally set FirewallType to SOCKS5.

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

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

Queries can be executed against a view as if it were a normal table, and the data that comes back is similar in that regard.

Dynamic views, such as queries exposed as views, and views for looking up specific combinations of project_team work items are supported.

Azure Data Catalog Connector for CData Sync 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 Sync App 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 Sync App.
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 Sync App.

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

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

Name supports the '=, !=, <>, CONTAINS' operators.
Timestamp supports the '=, <, <=, >, >=, CONTAINS' operators.
LastRegisteredTime supports the '=, CONTAINS' operators.
ObjectType supports the '=' operator.
SourceType supports the '=' operator.
FriendlyName supports the '=, CONTAINS' operators.
Experts supports the '=, CONTAINS' operators.
Description supports the '=, CONTAINS' operators.
Tags supports the '=, !=, <>, CONTAINS' operators.
HasTags supports the '=' operator.
HasPreviews supports the '=' operator.
HasDocumentation supports the '=' operator.
HasTableDataProfiles supports the '=' operator.
HasColumnsDataProfiles supports the '=' operator.
HasDescription supports the '=' operator.
View supports the '=' operator.
Facets supports the '=' operator.

For example:

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

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

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

Columns


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

Pseudo-Columns

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


Name	Type	Description
LastRegisteredTime	Date	Date and time when the metadata was registered.

Descriptions

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

Table Specific Information

Select

The Sync App 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 Sync App.

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

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

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

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

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

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.

Connection String Options

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

For more information on establishing a connection, see Establishing a Connection.

Authentication

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

Azure Authentication

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

OAuth

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

JWT OAuth

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

SSL

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

Firewall

Property	Description
FirewallType	The protocol used by a proxy-based firewall.
FirewallServer	The name or IP address of a proxy-based firewall.
FirewallPort	The TCP port for a proxy-based firewall.
FirewallUser	The user name to use to authenticate with a proxy-based firewall.
FirewallPassword	A password used to authenticate to a proxy-based firewall.

Proxy

Property	Description
ProxyAutoDetect	This indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.
ProxyServer	The hostname or IP address of a proxy to route HTTP traffic through.
ProxyPort	The TCP port the ProxyServer proxy is running on.
ProxyAuthScheme	The authentication type to use to authenticate to the ProxyServer proxy.
ProxyUser	A user name to be used to authenticate to the ProxyServer proxy.
ProxyPassword	A password to be used to authenticate to the ProxyServer proxy.
ProxySSLType	The SSL type to use when connecting to the ProxyServer proxy.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

Logging

Property	Description
LogModules	Core modules to be included in the log file.

Schema

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

Miscellaneous

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

Authentication

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

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.

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.

CatalogName

The name of the catalog to connect to.

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 the Azure Authentication properties you can configure in the connection string for this provider.

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

AzureTenant

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

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.

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 the OAuth properties you can configure in the connection string for this provider.

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

OAuthClientId

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

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.

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.

JWT OAuth

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

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

OAuthJWTCert

The JWT Certificate store.

Remarks

The name of the certificate store for the client certificate.

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

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

Designations of certificate stores are platform-dependent.

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


MY	A certificate store holding personal certificates with their associated private keys.
CA	Certifying authority certificates.
ROOT	Root certificates.
SPC	Software publisher certificates.

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

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

OAuthJWTCertType

The type of key store containing the JWT Certificate.

Remarks

This property can take one of the following values:


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

OAuthJWTCertPassword

The password for the OAuth JWT certificate.

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.

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, [email protected]". 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.

OAuthJWTIssuer

The issuer of the Java Web Token.

Remarks

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

OAuthJWTSubject

The user subject for which the application is requesting delegated access.

Remarks

The user subject for which the application is requesting delegated access. Typically, the user account name or email address.

SSL

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

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.

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.

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

Firewall

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

Property	Description
FirewallType	The protocol used by a proxy-based firewall.
FirewallServer	The name or IP address of a proxy-based firewall.
FirewallPort	The TCP port for a proxy-based firewall.
FirewallUser	The user name to use to authenticate with a proxy-based firewall.
FirewallPassword	A password used to authenticate to a proxy-based firewall.

FirewallType

The protocol used by a proxy-based firewall.

Remarks

This property specifies the protocol that the Sync App will use to tunnel traffic through the FirewallServer proxy. Note that by default, the Sync App connects to the system proxy; to disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.


Type	Default Port	Description
TUNNEL	80	When this is set, the Sync App opens a connection to Azure Data Catalog and traffic flows back and forth through the proxy.
SOCKS4	1080	When this is set, the Sync App sends data through the SOCKS 4 proxy specified by FirewallServer and FirewallPort and passes the FirewallUser value to the proxy, which determines if the connection request should be granted.
SOCKS5	1080	When this is set, the Sync App sends data through the SOCKS 5 proxy specified by FirewallServer and FirewallPort. If your proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes.

To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.

FirewallServer

The name or IP address of a proxy-based firewall.

Remarks

This property specifies the IP address, DNS name, or host name of a proxy allowing traversal of a firewall. The protocol is specified by FirewallType: Use FirewallServer with this property to connect through SOCKS or do tunneling. Use ProxyServer to connect to an HTTP proxy.

Note that the Sync App uses the system proxy by default. To use a different proxy, set ProxyAutoDetect to false.

FirewallPort

The TCP port for a proxy-based firewall.

Remarks

This specifies the TCP port for a proxy allowing traversal of a firewall. Use FirewallServer to specify the name or IP address. Specify the protocol with FirewallType.

FirewallUser

The user name to use to authenticate with a proxy-based firewall.

Remarks

The FirewallUser and FirewallPassword properties are used to authenticate against the proxy specified in FirewallServer and FirewallPort, following the authentication method specified in FirewallType.

FirewallPassword

A password used to authenticate to a proxy-based firewall.

Remarks

This property is passed to the proxy specified by FirewallServer and FirewallPort, following the authentication method specified by FirewallType.

Proxy

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

Property	Description
ProxyAutoDetect	This indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.
ProxyServer	The hostname or IP address of a proxy to route HTTP traffic through.
ProxyPort	The TCP port the ProxyServer proxy is running on.
ProxyAuthScheme	The authentication type to use to authenticate to the ProxyServer proxy.
ProxyUser	A user name to be used to authenticate to the ProxyServer proxy.
ProxyPassword	A password to be used to authenticate to the ProxyServer proxy.
ProxySSLType	The SSL type to use when connecting to the ProxyServer proxy.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

ProxyAutoDetect

This indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.

Remarks

This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.

To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.

ProxyServer

The hostname or IP address of a proxy to route HTTP traffic through.

Remarks

The hostname or IP address of a proxy to route HTTP traffic through. The Sync App can use the HTTP, Windows (NTLM), or Kerberos authentication types to authenticate to an HTTP proxy.

If you need to connect through a SOCKS proxy or tunnel the connection, see FirewallType.

By default, the Sync App uses the system proxy. If you need to use another proxy, set ProxyAutoDetect to false.

ProxyPort

The TCP port the ProxyServer proxy is running on.

Remarks

The port the HTTP proxy is running on that you want to redirect HTTP traffic through. Specify the HTTP proxy in ProxyServer. For other proxy types, see FirewallType.

ProxyAuthScheme

The authentication type to use to authenticate to the ProxyServer proxy.

Remarks

This value specifies the authentication type to use to authenticate to the HTTP proxy specified by ProxyServer and ProxyPort.

Note that the Sync App will use the system proxy settings by default, without further configuration needed; if you want to connect to another proxy, you will need to set ProxyAutoDetect to false, in addition to ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

The authentication type can be one of the following:

BASIC: The Sync App performs HTTP BASIC authentication.
DIGEST: The Sync App performs HTTP DIGEST authentication.
NEGOTIATE: The Sync App retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
PROPRIETARY: The Sync App does not generate an NTLM or Kerberos token. You must supply this token in the Authorization header of the HTTP request.

If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.

ProxyUser

A user name to be used to authenticate to the ProxyServer proxy.

Remarks

The ProxyUser and ProxyPassword options are used to connect and authenticate against the HTTP proxy specified in ProxyServer.

You can select one of the available authentication types in ProxyAuthScheme. If you are using HTTP authentication, set this to the user name of a user recognized by the HTTP proxy. If you are using Windows or Kerberos authentication, set this property to a user name in one of the following formats:

user@domain
domain\user

ProxyPassword

A password to be used to authenticate to the ProxyServer proxy.

Remarks

This property is used to authenticate to an HTTP proxy server that supports NTLM (Windows), Kerberos, or HTTP authentication. To specify the HTTP proxy, you can set ProxyServer and ProxyPort. To specify the authentication type, set ProxyAuthScheme.

If you are using HTTP authentication, additionally set ProxyUser and ProxyPassword to HTTP proxy.

If you are using NTLM authentication, set ProxyUser and ProxyPassword to your Windows password. You may also need these to complete Kerberos authentication.

For SOCKS 5 authentication or tunneling, see FirewallType.

By default, the Sync App uses the system proxy. If you want to connect to another proxy, set ProxyAutoDetect to false.

ProxySSLType

The SSL type to use when connecting to the ProxyServer proxy.

Remarks

This property determines when to use SSL for the connection to an HTTP proxy specified by ProxyServer. This value can be AUTO, ALWAYS, NEVER, or TUNNEL. The applicable values are the following:


AUTO	Default setting. If the URL is an HTTPS URL, the Sync App will use the TUNNEL option. If the URL is an HTTP URL, the component will use the NEVER option.
ALWAYS	The connection is always SSL enabled.
NEVER	The connection is not SSL enabled.
TUNNEL	The connection is through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy.

ProxyExceptions

A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

Remarks

The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.

Note that the Sync App uses the system proxy settings by default, without further configuration needed; if you want to explicitly configure proxy exceptions for this connection, you need to set ProxyAutoDetect = false, and configure ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

Logging

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

Property	Description
LogModules	Core modules to be included in the log file.

LogModules

Core modules to be included in the log file.

Remarks

Only the modules specified (separated by ';') will be included in the log file. By default all modules are included.

See the Logging page for an overview.

Schema

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

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.

Remarks

The path to a directory which contains the schema files for the Sync App (.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%\\CData\\AzureDataCatalog Data Provider\\Schema" with %APPDATA% being set to the user's configuration directory:

BrowsableSchemas

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

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.

Remarks

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

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.

Remarks

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

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 the Miscellaneous properties you can configure in the connection string for this provider.

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

MaxRows

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

Remarks

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

Other

These hidden properties are used only in specific use cases.

Remarks

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

Specify multiple properties in a semicolon-separated list.

Integration and Formatting


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

Pagesize

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

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.

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.

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 Sync App throws an exception.

UserDefinedViews

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

Remarks

User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The Sync App 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 Sync App.

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"