Establishing a Connection

Adding a Connection to Azure Data Catalog

To add a connection to Azure Data Catalog:

In the application console, navigate to the Connections page.
At the Add Connections panel, select the icon for the connection you want to add.
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.

For required properties, see the Settings tab.

For connection properties that are not typically required, see the Advanced tab.

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 Microsoft’s multi-tenant, cloud-based directory and identity management service. It is user-based authentication that requires that you set AuthScheme to AzureAD.

Authentication to Azure AD over a Web application always requires the creation of a custom OAuth application .

For details about creating a custom OAuth application, see Creating an Azure AD Application.

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 Creating an Azure AD App with Service Principal.

Managed Service Identity (MSI)

If you are running Azure Data Catalog on an Azure VM and want to automatically obtain Managed Service Identity (MSI) credentials 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.

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

Advanced Features

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

User Defined Views

The Sync App supports the use of user defined views, virtual tables whose contents are decided by a pre-configured user defined query. These views are useful when you cannot directly control queries being issued to the drivers. For an overview of creating and configuring custom views, see User Defined Views .

SSL Configuration

Use SSL Configuration to adjust how Sync App handles TLS/SSL certificate negotiations. You can choose from various certificate formats;. For further information, see the SSLServerCert property under "Connection String Options" .

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

For further information, see Query Processing.

Logging

For an overview of configuration settings that can be used to refine CData logging, see Logging. Only two connection properties are required for basic logging, but there are numerous features that support more refined logging, which enables you to use the LogModules connection property to specify subsets of information to be logged.

SSL Configuration

Customizing the SSL Configuration

By default, the Sync App attempts to negotiate TLS with the server. The server certificate is validated against the default system trusted certificate store. You can override how the certificate gets validated using the SSLServerCert connection property.

To specify another certificate, see the SSLServerCert connection property.

Firewall and Proxy

Connecting Through a Firewall or Proxy

HTTP Proxies

To authenticate to an HTTP proxy, set the following:

ProxyServer: the hostname or IP address of the proxy server that you want to route HTTP traffic through.
ProxyPort: the TCP port that the proxy server is running on.
ProxyAuthScheme: the authentication method the Sync App uses when authenticating to the proxy server.
ProxyUser: the username of a user account registered with the proxy server.
ProxyPassword: the password associated with the ProxyUser.

Other Proxies

Set the following properties:

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

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 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 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 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 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	Specifies the type of authentication to use when connecting to Azure Data Catalog. If this property is left blank, the default authentication is used.
CatalogName	The name of the catalog to connect to.

Azure Authentication

Property	Description
AzureTenant	Identifies the Azure Data Catalog tenant being used to access data, either by name (for example, contoso.omnicrosoft.com) or ID. (Conditional).
AzureEnvironment	Specifies the Azure network environment to which you will connect. Must be the same network to which your Azure account was added.

OAuth

Property	Description
OAuthClientId	Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.
OAuthClientSecret	Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the 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 used to access a certificate store that requires a password. If the certificate store does not require a password, leave this property blank.
OAuthJWTCertSubject	The subject of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '*' to select the first certificate.

SSL

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

Firewall

Property	Description
FirewallType	Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
FirewallServer	Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
FirewallPort	Specifies the TCP port to be used for a proxy-based firewall.
FirewallUser	Identifies the user ID of the account authenticating to a proxy-based firewall.
FirewallPassword	Specifies the password of the user account authenticating to a proxy-based firewall.

Proxy

Property	Description
ProxyAutoDetect	Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
ProxyServer	The hostname or IP address of the proxy server that you want to route HTTP traffic through.
ProxyPort	The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client.
ProxyAuthScheme	Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
ProxyUser	The username of a user account registered with the proxy server specified in the ProxyServer connection property.
ProxyPassword	The password associated with the user specified in the ProxyUser connection property.
ProxySSLType	The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

Logging

Property	Description
LogModules	Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.

Schema

Property	Description
Location	Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
BrowsableSchemas	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
Tables	Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
Views	Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .

Miscellaneous

Property	Description
MaxRows	Specifies the maximum rows returned for queries without aggregation or GROUP BY.
Other	Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.
Pagesize	Specifies the maximum number of results to return from Azure Data Catalog, per page. This setting overrides the default page size set by the datasource, which is optimized for most use cases.
PseudoColumns	Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.
UserDefinedViews	Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.

Authentication

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

Property	Description
AuthScheme	Specifies the type of authentication to use when connecting to Azure Data Catalog. If this property is left blank, the default authentication is used.
CatalogName	The name of the catalog to connect to.

AuthScheme

Specifies the type of authentication to use when connecting to Azure Data Catalog. If this property is left blank, the default authentication is used.

Remarks

AzureAD: Perform Azure Active Directory (user-based) OAuth authentication.
AzureMSI: Automatically obtain Azure AD Managed Service Identity credentials when running on an Azure VM.
AzureServicePrincipal: Authenticate as an Azure Service Principal (role-based, application-based) using a Client Secret.
AzureServicePrincipalCert: Authenticate as an Azure Service Principal (role-based, application-based) using a Certificate.

For information about creating a custom application to authenticate with Azure AD, see Creating an Azure AD Application.

For information about creating a custom application to authenticate with Azure AD Service Principal, see Creating an Azure AD App with 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	Identifies the Azure Data Catalog tenant being used to access data, either by name (for example, contoso.omnicrosoft.com) or ID. (Conditional).
AzureEnvironment	Specifies the Azure network environment to which you will connect. Must be the same network to which your Azure account was added.

AzureTenant

Identifies the Azure Data Catalog tenant being used to access data, either by name (for example, contoso.omnicrosoft.com) or ID. (Conditional).

Remarks

A tenant is a digital representation of your organization, primarily associated with a domain (for example, microsoft.com). The tenant is managed through a Tenant ID (also known as the directory ID), which is specified whenever you assign users permissions to access or manage Azure resources.

To locate the directory ID in the Azure Portal, navigate to Azure Active Directory > Properties.

Specifying AzureTenant is required when AuthScheme = either AzureServicePrincipal or AzureServicePrincipalCert, or if AuthScheme = AzureAD and the user belongs to more than one tenant.

AzureEnvironment

Specifies the Azure network environment to which you will connect. Must be the same network to which your Azure account was added.

Remarks

Required if your Azure account is part of a different network than the Global network, such as China, USGOVT, or 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	Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.
OAuthClientSecret	Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.

OAuthClientId

Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.

Remarks

OAuthClientId is one of a handful of connection parameters that need to be set before users can authenticate via OAuth. For details, see Establishing a Connection.

OAuthClientSecret

Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.

Remarks

OAuthClientSecret is one of a handful of connection parameters that need to be set before users can authenticate via OAuth. For details, see Establishing a Connection.

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 used to access a certificate store that requires a password. If the certificate store does not require a password, leave this property blank.
OAuthJWTCertSubject	The subject of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '*' to select the first certificate.

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.
BCFKSFILE	The certificate store is the name of a file that contains an Bouncy Castle keystore.
BCFKSBLOB	The certificate store is a string (base-64-encoded) that contains a Bouncy Castle keystore.

OAuthJWTCertPassword

The password for the OAuth JWT certificate used to access a certificate store that requires a password. If the certificate store does not require a password, leave this property blank.

Remarks

This property specifies the password needed to open the certificate store, but only if the store type requires one. To determine if a password is necessary, refer to the documentation or configuration for your specific certificate store.

OAuthJWTCertSubject

The subject of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '*' to select the first certificate.

Remarks

The value of this property is used to locate a matching certificate in the store. The search process works as follows:

If an exact match for the subject is found, the corresponding certificate is selected.
If no exact match is found, the store is searched for certificates whose subjects contain the property value.
If no match is found, no certificate is selected.

You can set the value to '*' to automatically select the first certificate in the store. The certificate subject is a comma-separated list of distinguished name fields and values. For example: CN=www.server.com, OU=test, C=US, [email protected]. Common fields include:


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, enclose it in quotes. For example: "O=ACME, Inc.".

SSL

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

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

SSLServerCert

Specifies 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	Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
FirewallServer	Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
FirewallPort	Specifies the TCP port to be used for a proxy-based firewall.
FirewallUser	Identifies the user ID of the account authenticating to a proxy-based firewall.
FirewallPassword	Specifies the password of the user account authenticating to a proxy-based firewall.

FirewallType

Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

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

The following table provides port number information for each of the supported protocols.


Protocol	Default Port	Description
TUNNEL	80	The port where the Sync App opens a connection to Azure Data Catalog. Traffic flows back and forth via the proxy at this location.
SOCKS4	1080	The port where the Sync App opens a connection to Azure Data Catalog. SOCKS 4 then passes theFirewallUser value to the proxy, which determines whether the connection request should be granted.
SOCKS5	1080	The port where the Sync App sends data to Azure Data Catalog. If the SOCKS 5 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

Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

FirewallPort

Specifies the TCP port to be used for a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

FirewallUser

Identifies the user ID of the account authenticating to a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

FirewallPassword

Specifies the password of the user account authenticating to a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Proxy

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

Property	Description
ProxyAutoDetect	Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
ProxyServer	The hostname or IP address of the proxy server that you want to route HTTP traffic through.
ProxyPort	The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client.
ProxyAuthScheme	Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
ProxyUser	The username of a user account registered with the proxy server specified in the ProxyServer connection property.
ProxyPassword	The password associated with the user specified in the ProxyUser connection property.
ProxySSLType	The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

ProxyAutoDetect

Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.

Remarks

When this connection property is set to True, the Sync App checks your system proxy settings for existing proxy server configurations (no need to manually supply proxy server details).

This connection property takes precedence over other proxy settings. Set to False if you want to manually configure the Sync App to connect to a specific proxy server.

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 the proxy server that you want to route HTTP traffic through.

Remarks

The Sync App only routes HTTP traffic through the proxy server specified in this connection property when ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead routes HTTP traffic through the proxy server specified in your system proxy settings.

ProxyPort

The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client.

Remarks

The Sync App only routes HTTP traffic through the proxy server port specified in this connection property when ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead routes HTTP traffic through the proxy server port specified in your system proxy settings.

For other proxy types, see FirewallType.

ProxyAuthScheme

Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.

Remarks

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.
NTLM: The Sync App retrieves an NTLM token.
NEGOTIATE: The Sync App retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
NONE: Set this when the ProxyServer does not require authentication.

For all values other than "NONE", you must also set the ProxyUser and ProxyPassword connection properties.

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

ProxyUser

The username of a user account registered with the proxy server specified in the ProxyServer connection property.

Remarks

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

After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:


ProxyAuthScheme Value	Value to set for ProxyUser
BASIC	The user name of a user registered with the proxy server.
DIGEST	The user name of a user registered with the proxy server.
NEGOTIATE	The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format `user@domain` or `domain\user`.
NTLM	The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format `user@domain` or `domain\user`.
NONE	Do not set the ProxyPassword connection property.

The Sync App only uses this username if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead uses the username specified in your system proxy settings.

ProxyPassword

The password associated with the user specified in the ProxyUser connection property.

Remarks

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

After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:


ProxyAuthScheme Value	Value to set for ProxyPassword
BASIC	The password associated with the proxy server user specified in ProxyUser.
DIGEST	The password associated with the proxy server user specified in ProxyUser.
NEGOTIATE	The password associated with the Windows user account specified in ProxyUser.
NTLM	The password associated with the Windows user account specified in ProxyUser.
NONE	Do not set the ProxyPassword connection property.

For SOCKS 5 authentication or tunneling, see FirewallType.

The Sync App only uses this password if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead uses the password specified in your system proxy settings.

ProxySSLType

The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.

Remarks

This property determines when to use SSL for the connection to the HTTP proxy specified by ProxyServer. You can set this connection property to the following values :


AUTO	Default setting. If ProxyServer is set to an HTTPS URL, the Sync App uses the TUNNEL option. If ProxyServer is set to an HTTP URL, the component uses the NEVER option.
ALWAYS	The connection is always SSL enabled.
NEVER	The connection is not SSL enabled.
TUNNEL	The connection is made 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 proxy server set in the ProxyServer connection property.

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, set ProxyAutoDetect to False.

Logging

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

Property	Description
LogModules	Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.

LogModules

Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.

Remarks

This property lets you customize the log file content by specifying the logging modules to include. Logging modules categorize logged information into distinct areas, such as query execution, metadata, or SSL communication. Each module is represented by a four-character code, with some requiring a trailing space for three-letter names.

For example, EXEC logs query execution, and INFO logs general provider messages. To include multiple modules, separate their names with semicolons as follows: INFO;EXEC;SSL.

The Verbosity connection property takes precedence over the module-based filtering specified by this property. Only log entries that meet the verbosity level and belong to the specified modules are logged. Leave this property blank to include all available modules in the log file.

For a complete list of available modules and detailed guidance on configuring logging, refer to the Advanced Logging section in Logging.

Schema

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

Property	Description
Location	Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
BrowsableSchemas	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
Tables	Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
Views	Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .

Location

Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.

Remarks

The Location property is only needed if you want to either customize definitions (for example, change a column name, ignore a column, etc.) 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, where %APPDATA% is set to the user's configuration directory:


Platform	%APPDATA%
Windows	The value of the APPDATA environment variable
Linux	~/.config

BrowsableSchemas

Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .

Remarks

Listing all available database schemas can take extra time, thus degrading performance. Providing a list of schemas in the connection string saves time and improves performance.

Tables

Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .

Remarks

Listing all available tables from some databases can take extra time, thus degrading performance. Providing a list of tables in the connection string saves time and improves performance.

If there are lots of tables available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those tables. To do this, 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: If you are connecting to a data source with multiple schemas or catalogs, you must specify each table you want to view by its fully qualified name. This avoids ambiguity between tables that may exist in multiple catalogs or schemas.

Views

Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .

Remarks

Listing all available views from some databases can take extra time, thus degrading performance. Providing a list of views in the connection string saves time and improves performance.

If there are lots of views available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those views. To do this, 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: If you are connecting to a data source with multiple schemas or catalogs, you must specify each view you want to examine by its fully qualified name. This avoids ambiguity between views that may 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	Specifies the maximum rows returned for queries without aggregation or GROUP BY.
Other	Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.
Pagesize	Specifies the maximum number of results to return from Azure Data Catalog, per page. This setting overrides the default page size set by the datasource, which is optimized for most use cases.
PseudoColumns	Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.
UserDefinedViews	Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.

MaxRows

Specifies the maximum rows returned for queries without aggregation or GROUP BY.

Remarks

This property sets an upper limit on the number of rows the Sync App returns for queries that do not include aggregation or GROUP BY clauses. This limit ensures that queries do not return excessively large result sets by default.

When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting. If MaxRows is set to "-1", no row limit is enforced unless a LIMIT clause is explicitly included in the query.

This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.

Other

Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.

Remarks

This property allows advanced users to configure hidden properties for specialized scenarios. These settings are not required for normal use cases but can address unique requirements or provide additional functionality. Multiple properties can be defined in a semicolon-separated list.

Note: It is strongly recommended to set these properties only when advised by the support team to address specific scenarios or issues.

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

Specifies the maximum number of results to return from Azure Data Catalog, per page. This setting overrides the default page size set by the datasource, which is optimized for most use cases.

Remarks

You may want to adjust the default pagesize to optimize results for a particular object or service endpoint you are querying. Be aware that increasing the page size may improve performance, but it could also result in higher memory consumption per page.

PseudoColumns

Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.

Remarks

This property allows you to define which pseudocolumns the Sync App exposes as table columns.

To specify individual pseudocolumns, use the following format: "Table1=Column1;Table1=Column2;Table2=Column3"

To include all pseudocolumns for all tables use: "*=*"

Timeout

Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.

Remarks

This property controls the maximum time, in seconds, that the Sync App waits for an operation to complete before canceling it. If the timeout period expires before the operation finishes, the Sync App cancels the operation and throws an exception.

The timeout applies to each individual communication with the server rather than the entire query or operation. For example, a query could continue running beyond 60 seconds if each paging call completes within the timeout limit.

Setting this property to 0 disables the timeout, allowing operations to run indefinitely until they succeed or fail due to other conditions such as server-side timeouts, network interruptions, or resource limits on the server. Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.

UserDefinedViews

Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.

Remarks

This property allows you to define and manage custom views through a JSON-formatted configuration file called UserDefinedViews.json. These views are automatically recognized by the Sync App and enable you to execute custom SQL queries as if they were standard database views. The JSON file defines each view as a root element with a child element called "query", which contains the 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)"
	}
}

You can define multiple views in a single file and specify the filepath using this property. For example: UserDefinedViews=C:\Path\To\UserDefinedViews.json. When you use this property, only the specified views are seen by the Sync App.

Refer to User Defined Views for more information.

Azure Data Catalog Connector for CData Sync

Azure Data Catalog Connector for CData Sync

Overview

Azure Data Catalog Version Support

Establishing a Connection

Adding a Connection to Azure Data Catalog

Connecting to Azure Data Catalog

Authenticating to Azure Data Catalog

Azure AD

Azure Service Principal

Managed Service Identity (MSI)

User-Managed Identities

Advanced Features

User Defined Views

SSL Configuration

Firewall and Proxy

Query Processing

Logging

SSL Configuration

Customizing the SSL Configuration

Firewall and Proxy

Connecting Through a Firewall or Proxy

HTTP Proxies

Other Proxies

Data Model

Overview

Key Features

Views

Views

Azure Data Catalog Connector for CData Sync Views

ColumnDataProfiles

Table Specific Information

Select

Columns

CustomDataSourceProperties

Table Specific Information

Select

Columns

CustomDataSources

Table Specific Information

Select

Columns

Databases

Table Specific Information

Select

Columns

Pseudo-Columns

Descriptions

Table Specific Information

Select

Columns

Pseudo-Columns

Experts

Table Specific Information

Select

Columns

Pseudo-Columns

Objects

Table Specific Information

Select

Columns

Pseudo-Columns

TableColumns

Table Specific Information

Select

Columns

TableDataProfiles

Table Specific Information

Select

Columns

Pseudo-Columns

Tables

Table Specific Information

Select

Columns

Pseudo-Columns

Tags

Table Specific Information

Select

Columns