Adding a Connection to Azure Data Catalog

To add a connection to Azure Data Catalog:

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

Entra ID (Azure AD)

Note: Microsoft has rebranded Azure AD as Entra ID. In topics that require the user to interact with the Entra ID Admin site, we use the same names Microsoft does. However, there are still CData connection properties whose names or values reference "Azure AD".

Microsoft Entra ID is a multi-tenant, cloud-based identity and access management platform. It supports OAuth-based authentication flows that enable the driver to access Azure Data Catalog endpoints securely.

Authentication to Entra ID via a web application always requires that you first create and register a custom OAuth application. This enables your application to define its own redirect URI, manage credential scope, and comply with organization-specific security policies.

For full instructions on how to create and register a custom OAuth application, see Creating an Entra ID (Azure AD) Application.

After setting AuthScheme to AzureAD, the steps to authenticate vary, depending on the environment. For details on how to connect from desktop applications, web-based workflows, or headless systems, see the following sections.

Azure Service Principal

Note: Microsoft has rebranded Azure AD as Entra ID. In topics that require the user to interact with the Entra ID Admin site, we use the same names Microsoft does. However, there are still CData connection properties whose names or values reference "Azure AD".

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 a Service Principal App in Entra ID (Azure AD).

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.

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.

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.

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.

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

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

Get list of tags 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 Tags WHERE HasTags = 'true' AND CONTAINS(Name, 'sales')

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

Columns

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

Pseudo-Columns

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

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

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

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

Azure Data Catalog Connector for CData Sync Stored Procedures

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

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

Input

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

Result Set Columns

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

Gets an authentication token from AzureDataCatalog.

Input

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

Result Set Columns

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

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

Input

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

Result Set Columns

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

Refreshes the OAuth access token used for authentication with AzureDataCatalog.

Input

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

Result Set Columns

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

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. Accepts either the tenant's domain name (for example, contoso.onmicrosoft.com ) or its directory (tenant) ID.
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 (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
OAuthClientSecret	Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).
Scope	Specifies the scope of the authenticating user's access to the application, to ensure they get appropriate access to data. If a custom OAuth application is needed, this is generally specified at the time the application is created.

JWT OAuth

---

Property	Description
OAuthJWTCert	Supplies the name of the client certificate's JWT Certificate store.
OAuthJWTCertType	Identifies the type of key store containing the JWT Certificate.
OAuthJWTCertPassword	Provides the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
OAuthJWTCertSubject	Identifies 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	Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic.
ProxyPort	Identifies the TCP port on your specified proxy server 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	Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property.
ProxyPassword	Specifies the password of the user specified in the ProxyUser connection property.
ProxySSLType	Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
ProxyExceptions	Specifies 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 number of rows returned for queries that do not include either aggregation or GROUP BY.
Other	Specifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues.
Pagesize	Specifies the maximum number of records per page the provider returns when requesting data from Azure Data Catalog.
PseudoColumns	Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
UserDefinedViews	Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file.

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.

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

AuthScheme values include:

• AzureAD (default): 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 Entra ID (Azure AD) Application.

For information about creating a custom application to authenticate with Azure AD Service Principal, see Creating a Service Principal App in Entra ID (Azure AD).

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.

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. Accepts either the tenant's domain name (for example, contoso.onmicrosoft.com ) or its directory (tenant) ID.
AzureEnvironment	Specifies the Azure network environment to which you will connect. Must be the same network to which your Azure account was added.

Identifies the Azure Data Catalog tenant being used to access data. Accepts either the tenant's domain name (for example, contoso.onmicrosoft.com ) or its directory (tenant) ID.

Remarks

A tenant is a digital container for your organization's users and resources, managed through Microsoft Entra ID (formerly Azure AD). Each tenant is associated with a unique directory ID, and often with a custom domain (for example, microsoft.com or contoso.onmicrosoft.com).

To find the directory (tenant) ID in the Microsoft Entra Admin Center, navigate to Microsoft Entra ID > Properties and copy the value labeled "Directory (tenant) ID".

This property is required in the following cases:

• When AuthScheme is set to AzureServicePrincipal or AzureServicePrincipalCert
• When AuthScheme is AzureAD and the user account belongs to multiple tenants

You can provide the tenant value in one of two formats:

• A domain name (for example, contoso.onmicrosoft.com)
• A directory (tenant) ID in GUID format (for example, c9d7b8e4-1234-4f90-bc1a-2a28e0f9e9e0)

Specifying the tenant explicitly ensures that the authentication request is routed to the correct directory, which is especially important when a user belongs to multiple tenants or when using service principal–based authentication.

If this value is omitted when required, authentication may fail or connect to the wrong tenant. This can result in errors such as unauthorized or resource not found.

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.

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 (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
OAuthClientSecret	Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).
Scope	Specifies the scope of the authenticating user's access to the application, to ensure they get appropriate access to data. If a custom OAuth application is needed, this is generally specified at the time the application is created.

Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.

Remarks

This property is required in two cases:

• When using a custom OAuth application, such as in web-based authentication flows, service-based authentication, or certificate-based flows that require application registration.
• If the driver does not provide embedded OAuth credentials.

(When the driver provides embedded OAuth credentials, this value may already be provided by the Sync App and thus not require manual entry.)

OAuthClientId is generally used alongside other OAuth-related properties such as OAuthClientSecret and OAuthSettingsLocation when configuring an authenticated connection.

OAuthClientId is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can usually find this value in your identity provider’s application registration settings. Look for a field labeled Client ID, Application ID, or Consumer Key.

While the client ID is not considered a confidential value like a client secret, it is still part of your application's identity and should be handled carefully. Avoid exposing it in public repositories or shared configuration files.

For more information on how this property is used when configuring a connection, see Establishing a Connection.

Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).

Remarks

This property (sometimes called the application secret or consumer secret) is required when using a custom OAuth application in any flow that requires secure client authentication, such as web-based OAuth, service-based connections, or certificate-based authorization flows. It is not required when using an embedded OAuth application.

The client secret is used during the token exchange step of the OAuth flow, when the driver requests an access token from the authorization server. If this value is missing or incorrect, authentication fails with either an invalid_client or an unauthorized_client error.

OAuthClientSecret is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can obtain this value from your identity provider when registering the OAuth application.

Notes:

• This value should be stored securely and never exposed in public repositories, scripts, or unsecured environments.
• Client secrets may also expire after a set period. Be sure to monitor expiration dates and rotate secrets as needed to maintain uninterrupted access.

For more information on how this property is used when configuring a connection, see Establishing a Connection

Specifies the scope of the authenticating user's access to the application, to ensure they get appropriate access to data. If a custom OAuth application is needed, this is generally specified at the time the application is created.

Remarks

Scopes are set to define what kind of access the authenticating user will have; for example, read, read and write, restricted access to sensitive information. System administrators can use scopes to selectively enable access by functionality or security clearance.

When InitiateOAuth is set to GETANDREFRESH, you must use this property if you want to change which scopes are requested.

When InitiateOAuth is set to either REFRESH or OFF, you can change which scopes are requested using either this property or the Scope input.

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

---

Property	Description
OAuthJWTCert	Supplies the name of the client certificate's JWT Certificate store.
OAuthJWTCertType	Identifies the type of key store containing the JWT Certificate.
OAuthJWTCertPassword	Provides the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
OAuthJWTCertSubject	Identifies 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.

Supplies the name of the client certificate's JWT Certificate store.

Remarks

The OAuthJWTCertType field specifies the type of the certificate store specified in OAuthJWTCert. If the store is password-protected, use OAuthJWTCertPassword to supply the password..

OAuthJWTCert is used in conjunction with the OAuthJWTCertSubject field in order to specify client certificates. If OAuthJWTCert has a value, and OAuthJWTCertSubject is set, the CData Sync App initiates a search for a certificate. For further information, see OAuthJWTCertSubject.

Designations of certificate stores are platform-dependent.

Notes

• The most common User and Machine certificate stores in Windows include:
  • 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).

Identifies the type of key store containing the JWT Certificate.

Remarks

Value	Description	Notes
USER	A certificate store owned by the current user.	Only available in Windows.
MACHINE	A machine store.	Not available in Java or other non-Windows environments.
PFXFILE	A PFX (PKCS12) file containing certificates.
PFXBLOB	A string (base-64-encoded) representing a certificate store in PFX (PKCS12) format.
JKSFILE	A Java key store (JKS) file containing certificates.	Only available in Java.
JKSBLOB	A string (base-64-encoded) representing a certificate store in Java key store (JKS) format.	Only available in Java.
PEMKEY_FILE	A PEM-encoded file that contains a private key and an optional certificate.
PEMKEY_BLOB	A string (base64-encoded) that contains a private key and an optional certificate.
PUBLIC_KEY_FILE	A file that contains a PEM- or DER-encoded public key certificate.
PUBLIC_KEY_BLOB	A string (base-64-encoded) that contains a PEM- or DER-encoded public key certificate.
SSHPUBLIC_KEY_FILE	A file that contains an SSH-style public key.
SSHPUBLIC_KEY_BLOB	A string (base-64-encoded) that contains an SSH-style public key.
P7BFILE	A PKCS7 file containing certificates.
PPKFILE	A file that contains a PPK (PuTTY Private Key).
XMLFILE	A file that contains a certificate in XML format.
XMLBLOB	Astring that contains a certificate in XML format.
BCFKSFILE	A file that contains an Bouncy Castle keystore.
BCFKSBLOB	A string (base-64-encoded) that contains a Bouncy Castle keystore.

Provides the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.

Remarks

This property specifies the password needed to open a password-protected certificate store. To determine if a password is necessary, refer to the documentation or configuration for your specific certificate store.

Identifies 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.".

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.

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

Remarks

If you are using a TLS/SSL connection, use this property to specify the TLS/SSL certificate to be accepted from the server. If you specify a value for this property, all other certificates that are not trusted by the machine are 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

Note: It is possible to use '*' to signify that all certificates should be accepted, but due to security concerns this is not recommended.

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.

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.

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.

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.

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.

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.

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	Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic.
ProxyPort	Identifies the TCP port on your specified proxy server 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	Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property.
ProxyPassword	Specifies the password of the user specified in the ProxyUser connection property.
ProxySSLType	Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
ProxyExceptions	Specifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

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. If you want to configure the Sync App to connect to a specific proxy server, set ProxyAutoDetect to False.

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

Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic.

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 (the default), the Sync App instead routes HTTP traffic through the proxy server specified in your system proxy settings.

Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client.

Remarks

The Sync App only routes HTTP traffic through the ProxyServer port specified in this connection property when ProxyAutoDetect is set to False.

If ProxyAutoDetect is set to True (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.

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

Remarks

Supported authentication types :

• 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: Signifies that 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.

Provides 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 username of a user registered with the proxy server.
DIGEST	The username 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.

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

Specifies the password of 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.

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

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

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

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.

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

The Sync App writes details about each operation it performs into the logfile specified by the Logfile connection property.

Each of these logged operations are assigned to a themed category called a module, and each module has a corresponding short code used to labels individual Sync App operations as belonging to that module.

When this connection property is set to a semicolon-separated list of module codes, only operations belonging to the specified modules are written to the logfile. Note that this only affects which operations are logged moving forward and doesn't retroactively alter the existing contents of the logfile. For example: INFO;EXEC;SSL;META;

By default, logged operations from all modules are included.

You can explicitly exclude a module by prefixing it with a "-". For example: -HTTP

To apply filters to submodules, identify them with the syntax <module name>.<submodule name>. For example, the following value causes the Sync App to only log actions belonging to the HTTP module, and further refines it to exclude actions belonging to the Res submodule of the HTTP module: HTTP;-HTTP.Res

Note that the logfile filtering triggered by the Verbosity connection property takes precedence over the filtering imposed by this connection property. This means that operations of a higher verbosity level than the level specified in the Verbosity connection property are not printed in the logfile, even if they belong to one of the modules specified in this connection property.

The available modules and submodules are:

Module Name	Module Description	Submodules
INFO	General Information. Includes the connection string, product version (build number), and initial connection messages.	Connec – Information related to creating or destroying connections. Messag – Generic label for messages pertaining to connections, the connection string, and product version. These messages are typically specific to the Sync App, rather than being received and passed along directly from the service.
EXEC	Query Execution. Includes execution messages for user-written SQL queries, parsed SQL queries, and normalized SQL queries. Success/failure messages for queries and query pages appear here as well.	Messag – Messages pertaining to query execution. These messages are typically specific to the Sync App, rather than being received and passed along directly from the service. Normlz – Query normalization steps. Query normalization is when the product takes the user-submitted query and rewrites the query to get the same results with optimal performance. Origin – This label applies to any messages recording a user's original query (the exact, unaltered, non-normalized query executed by the user). Page – Messages related to query paging. Parsed – Query parsing steps. Parsing is the process of converting the user-submitted query into a standardized format for easier processing.
HTTP	HTTP protocol messages. Includes HTTP requests/responses (including POST messages), as well as Kerberos related messages.	KERB – HTTP requests related to Kerberos. Messag – Messages pertaining to HTTP protocols. These messages are typically specific to the Sync App, rather than being received and passed along directly from the service. Unpack – This label applies to messages about zipped data being returned from the service API and unpacked by the product. Res – Messages containing HTTP responses. Req – Messages containing HTTP requests.
WSDL	Messages pertaining to the generation of WSDL/XSD files.	—
SSL	SSL certificate messages.	Certif – Messages pertaining to SSL certificates.
AUTH	Authentication related failure/success messages.	Messag – Messages pertaining to authentication. These messages are typically specific to the Sync App, rather than being received and passed along directly from the service. OAuth – Messages related to OAuth authentication. Krbros – Kerberos-related authentication messages.
SQL	Includes SQL transactions, SQL bulk transfer messages, and SQL result set messages.	Bulk – Messages pertaining to bulk query execution. Cache – Messages related to reading row data from and writing row data to the product's cache for better performance. Messag – Messages pertaining to SQL transactions. These messages are typically specific to the Sync App, rather than being received and passed along directly from the service. ResSet – Query resultsets. Transc – Messages related to handling transactions, including information about the number of jobs executed and backup table handling.
META	Metadata cache and schema messages.	Cache – Messages related to reading from and modifying column and table definitions in the product's cache for better performance. Schema – Messages related to retrieving metadata from or modifying the service schema. MemSto – Messages related to writing to or reading from in-memory metadata cache. Storag – Messages relating to storing metadata on disk or in an external data store, rather than in memory.
FUNC	Information related to executing SQL functions.	Errmsg – Error messages related to executing SQL functions.
TCP	Incoming and outgoing raw bytes on TCP transport layer messages.	Send – Raw data sent via the TCP protocol. Receiv – Raw data received via the TCP protocol.
FTP	Messages pertaining to the File Transfer Protocol.	Info – Status messages related to communication in the FTP protocol. Client – Messages related to actions taken by the FTP client (the product) during FTP communication. Server – Messages related to actions taken by the FTP server during FTP communication.
SFTP	Messages pertaining to the Secure File Transfer Protocol.	Info – Status messages related to communication in the SFTP protocol. To_Server – Messages related to actions taken by the SFTP client (the product) during SFTP communication. From_Server – Messages related to actions taken by the SFTP server during SFTP communication.
POP	Messages pertaining to data transferred via the Post Office Protocol.	Client – Messages related to actions taken by the POP client (the product) during POP communication. Server – Messages related to actions taken by the POP server during POP communication. Status – Status messages related to communication in the POP protocol.
SMTP	Messages pertaining to data transferred via the Simple Mail Transfer Protocol.	Client – Messages related to actions taken by the SMTP client (the product) during SMTP communication. Server – Messages related to actions taken by the SMTP server during SMTP communication. Status – Status messages related to communication in the SMTP protocol.
CORE	Messages relating to various internal product operations not covered by other modules.	—
DEMN	Messages related to SQL remoting.	—
CLJB	Messages about bulk data uploads (cloud job).	Commit – Submissions for bulk data uploads.
SRCE	Miscellaneous messages produced by the product that don't belong in any other module.	—
TRANCE	Advanced messages concerning low-level product operations.	—

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 .

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

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.

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.

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.

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 number of rows returned for queries that do not include either aggregation or GROUP BY.
Other	Specifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues.
Pagesize	Specifies the maximum number of records per page the provider returns when requesting data from Azure Data Catalog.
PseudoColumns	Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
UserDefinedViews	Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file.

Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.

Remarks

The default value for this property, -1, means that no row limit is enforced unless the query explicitly includes a LIMIT clause. (When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting.)

Setting MaxRows to a whole number greater than 0 ensures that queries do not return excessively large result sets by default.

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

Specifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues.

Remarks

This property allows advanced users to configure hidden properties for specialized situations, with the advice of our Support team. These settings are not required for normal use cases but can address unique requirements or provide additional functionality. To define multiple properties, use 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.

Integration and Formatting

Property	Description
DefaultColumnSize	Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000.
ConvertDateTimeToGMT=True	Converts date-time values to GMT, instead of the local time of the machine. The default value is False (use local time).
RecordToFile=filename	Records the underlying socket data transfer to the specified file.

Specifies the maximum number of records per page the provider returns when requesting data from Azure Data Catalog.

Remarks

When processing a query, instead of requesting all of the queried data at once from Azure Data Catalog, the Sync App can request the queried data in pieces called pages.

This connection property determines the maximum number of results that the Sync App requests per page.

Note: Setting large page sizes may improve overall query execution time, but doing so causes the Sync App to use more memory when executing queries and risks triggering a timeout.

Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.

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:

*=*

Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.

Remarks

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.

Timeout is set to 60 seconds by default. To disable timeouts, set this property to 0.

Disabling the timeout allows 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.

Note: Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.

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

Remarks

UserDefinedViews 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 use this property to define multiple views in a single file and specify the filepath. For example:

UserDefinedViews=C:\Path\To\UserDefinedViews.json

When you specify a view in UserDefinedViews, the Sync App only sees that view.

For further information, see User Defined Views.

LZMA from 7Zip LZMA SDK

LZMA SDK is placed in the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or distribute the original LZMA SDK code, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.

LZMA2 from XZ SDK

Version 1.9 and older are in the public domain.

Xamarin.Forms

Xamarin SDK

The MIT License (MIT)

Copyright (c) .NET Foundation Contributors

All rights reserved.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

NSIS 3.10

Copyright (C) 1999-2025 Contributors THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS COMMON PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.

1. DEFINITIONS

"Contribution" means:

a) in the case of the initial Contributor, the initial code and documentation distributed under this Agreement, and b) in the case of each subsequent Contributor:

i) changes to the Program, and

ii) additions to the Program;

where such changes and/or additions to the Program originate from and are distributed by that particular Contributor. A Contribution 'originates' from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include additions to the Program which: (i) are separate modules of software distributed in conjunction with the Program under their own license agreement, and (ii) are not derivative works of the Program.

"Contributor" means any person or entity that distributes the Program.

"Licensed Patents " mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program.

"Program" means the Contributions distributed in accordance with this Agreement.

"Recipient" means anyone who receives the Program under this Agreement, including all Contributors.

2. GRANT OF RIGHTS

a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, distribute and sublicense the Contribution of such Contributor, if any, and such derivative works, in source code and object code form.

b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in source code and object code form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder.

c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program.

d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement.

3. REQUIREMENTS

A Contributor may choose to distribute the Program in object code form under its own license agreement, provided that:

a) it complies with the terms and conditions of this Agreement; and

b) its license agreement:

i) effectively disclaims on behalf of all Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose;

ii) effectively excludes on behalf of all Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits;

iii) states that any provisions which differ from this Agreement are offered by that Contributor alone and not by any other party; and

iv) states that source code for the Program is available from such Contributor, and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange.

When the Program is made available in source code form:

a) it must be made available under this Agreement; and

b) a copy of this Agreement must be included with each copy of the Program.

Contributors may not remove or alter any copyright notices contained within the Program.

Each Contributor must identify itself as the originator of its Contribution, if any, in a manner that reasonably allows subsequent Recipients to identify the originator of the Contribution.

4. COMMERCIAL DISTRIBUTION

Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense.

For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages.

5. NO WARRANTY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations.

6. DISCLAIMER OF LIABILITY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

7. GENERAL

If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.

If Recipient institutes patent litigation against a Contributor with respect to a patent applicable to software (including a cross-claim or counterclaim in a lawsuit), then any patent licenses granted by that Contributor to such Recipient under this Agreement shall terminate as of the date such litigation is filed. In addition, if Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed.

All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive.

Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. IBM is the initial Agreement Steward. IBM may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to distribute the Program (including its Contributions) under the new version. Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved.

This Agreement is governed by the laws of the State of New York and the intellectual property laws of the United States of America. No party to this Agreement will bring a legal action under this Agreement more than one year after the cause of action arose. Each party waives its rights to a jury trial in any resulting litigation.