CData Cloud offers access to Azure Data Catalog across several standard services and protocols, in a cloud-hosted solution. Any application that can connect to a SQL Server database can connect to Azure Data Catalog through CData Cloud.
CData Cloud allows you to standardize and configure connections to Azure Data Catalog as though it were any other OData endpoint or standard SQL Server.
This page provides a guide to Establishing a Connection to Azure Data Catalog in CData Cloud, as well as information on the available resources, and a reference to the available connection properties.
Establishing a Connection shows how to authenticate to Azure Data Catalog and configure any necessary connection properties to create a database in CData Cloud
Accessing data from Azure Data Catalog through the available standard services and CData Cloud administration is documented in further details in the CData Cloud Documentation.
Connect to Azure Data Catalog by selecting the corresponding icon in the Database tab. Required properties are listed under Settings. The Advanced tab lists connection properties that are not typically required.
You can optionally set the following to read the different catalog data returned from Azure Data Catalog.
To get your catalog name, navigate to the Azure Portal home page > Data Catalog > Catalog Name
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.
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).
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.
If your VM has multiple user-assigned managed identities, you must also specify OAuthClientId.
By default, the Cloud 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.
To authenticate to an HTTP proxy, set the following:
Set the following properties:
This section shows the available API objects and provides more information on executing SQL to Azure Data Catalog APIs.
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.
| 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.
The Cloud 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 Cloud.
Note: ItemId is required in order to query ColumnDataProfiles.
SELECT * FROM ColumnDataProfiles WHERE ItemId = '8a2b7305-b474-45d6-9fba-562454045070'
| 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.
No filters are supported server side for this table. All criteria will be handled client side within the Cloud.
| 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.
No filters are supported server side for this table. All criteria will be handled client side within the Cloud.
| 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.
The Cloud 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 Cloud.
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'
| 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 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.
The Cloud 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 Cloud.
SELECT * FROM Descriptions WHERE CONTAINS(Description, 'sakila') AND ObjectType = table;
SELECT * FROM Descriptions WHERE CONTAINS(Name, 'customer') AND HasTags = true;
| 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 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.
The Cloud 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 Cloud.
SELECT * FROM Experts WHERE ObjectType = 'table' AND CONTAINS(Experts, 'support')
SELECT * FROM Experts WHERE Tags = 'orders' OR Name = 'orders' AND ObjectType = 'table';
| 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 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.
The Cloud 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 Cloud.
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');
| 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 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.
The Cloud 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 Cloud.
SELECT * FROM TableColumns WHERE ItemId = '8a2b7305-b474-45d6-9fba-57e954565070'
| 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.
The Cloud 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 Cloud.
SELECT * FROM TableDataProfiles WHERE NOT Tags = 'FactProductInventory'
SELECT * FROM TableDataProfiles WHERE Timestamp > '2019-09-20T04:39:54.0083651Z';
| 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 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.
The Cloud 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 Cloud.
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';
| 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 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.
The Cloud 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 Cloud.
SELECT * FROM Tags WHERE HasTags = 'true' AND CONTAINS(Name, 'sales')
SELECT * FROM Tags WHERE FriendlyName <> 'sales';
| 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 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 Cloud 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.
| 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.
| 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. |
| Name | Type | Description |
| URL | String | The authorization URL, entered into a Web browser to obtain the verifier token and authorize your app. |
You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.
The following tables return database metadata for Azure Data Catalog:
The following tables return information about how to connect to and query the data source:
The following table returns query statistics for data modification queries:
Lists the available databases.
The following query retrieves all databases determined by the connection string:
SELECT * FROM sys_catalogs
| Name | Type | Description |
| CatalogName | String | The database name. |
Lists the available schemas.
The following query retrieves all available schemas:
SELECT * FROM sys_schemas
| Name | Type | Description |
| CatalogName | String | The database name. |
| SchemaName | String | The schema name. |
Lists the available tables.
The following query retrieves the available tables and views:
SELECT * FROM sys_tables
| Name | Type | Description |
| CatalogName | String | The database containing the table or view. |
| SchemaName | String | The schema containing the table or view. |
| TableName | String | The name of the table or view. |
| TableType | String | The table type (table or view). |
| Description | String | A description of the table or view. |
| IsUpdateable | Boolean | Whether the table can be updated. |
Describes the columns of the available tables and views.
The following query returns the columns and data types for the Tables table:
SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Tables'
| Name | Type | Description |
| CatalogName | String | The name of the database containing the table or view. |
| SchemaName | String | The schema containing the table or view. |
| TableName | String | The name of the table or view containing the column. |
| ColumnName | String | The column name. |
| DataTypeName | String | The data type name. |
| DataType | Int32 | An integer indicating the data type. This value is determined at run time based on the environment. |
| Length | Int32 | The storage size of the column. |
| DisplaySize | Int32 | The designated column's normal maximum width in characters. |
| NumericPrecision | Int32 | The maximum number of digits in numeric data. The column length in characters for character and date-time data. |
| NumericScale | Int32 | The column scale or number of digits to the right of the decimal point. |
| IsNullable | Boolean | Whether the column can contain null. |
| Description | String | A brief description of the column. |
| Ordinal | Int32 | The sequence number of the column. |
| IsAutoIncrement | String | Whether the column value is assigned in fixed increments. |
| IsGeneratedColumn | String | Whether the column is generated. |
| IsHidden | Boolean | Whether the column is hidden. |
| IsArray | Boolean | Whether the column is an array. |
| IsReadOnly | Boolean | Whether the column is read-only. |
| IsKey | Boolean | Indicates whether a field returned from sys_tablecolumns is the primary key of the table. |
| ColumnType | String | The role or classification of the column in the schema. Possible values include SYSTEM, LINKEDCOLUMN, NAVIGATIONKEY, REFERENCECOLUMN, and NAVIGATIONPARENTCOLUMN. |
Lists the available stored procedures.
The following query retrieves the available stored procedures:
SELECT * FROM sys_procedures
| Name | Type | Description |
| CatalogName | String | The database containing the stored procedure. |
| SchemaName | String | The schema containing the stored procedure. |
| ProcedureName | String | The name of the stored procedure. |
| Description | String | A description of the stored procedure. |
| ProcedureType | String | The type of the procedure, such as PROCEDURE or FUNCTION. |
Describes stored procedure parameters.
The following query returns information about all of the input parameters for the SelectEntries stored procedure:
SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'SelectEntries' AND Direction = 1 OR Direction = 2
To include result set columns in addition to the parameters, set the IncludeResultColumns pseudo column to True:
SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'SelectEntries' AND IncludeResultColumns='True'
| Name | Type | Description |
| CatalogName | String | The name of the database containing the stored procedure. |
| SchemaName | String | The name of the schema containing the stored procedure. |
| ProcedureName | String | The name of the stored procedure containing the parameter. |
| ColumnName | String | The name of the stored procedure parameter. |
| Direction | Int32 | An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters. |
| DataType | Int32 | An integer indicating the data type. This value is determined at run time based on the environment. |
| DataTypeName | String | The name of the data type. |
| NumericPrecision | Int32 | The maximum precision for numeric data. The column length in characters for character and date-time data. |
| Length | Int32 | The number of characters allowed for character data. The number of digits allowed for numeric data. |
| NumericScale | Int32 | The number of digits to the right of the decimal point in numeric data. |
| IsNullable | Boolean | Whether the parameter can contain null. |
| IsRequired | Boolean | Whether the parameter is required for execution of the procedure. |
| IsArray | Boolean | Whether the parameter is an array. |
| Description | String | The description of the parameter. |
| Ordinal | Int32 | The index of the parameter. |
| Values | String | The values you can set in this parameter are limited to those shown in this column. Possible values are comma-separated. |
| SupportsStreams | Boolean | Whether the parameter represents a file that you can pass as either a file path or a stream. |
| IsPath | Boolean | Whether the parameter is a target path for a schema creation operation. |
| Default | String | The value used for this parameter when no value is specified. |
| SpecificName | String | A label that, when multiple stored procedures have the same name, uniquely identifies each identically-named stored procedure. If there's only one procedure with a given name, its name is simply reflected here. |
| IsCDataProvided | Boolean | Whether the procedure is added/implemented by CData, as opposed to being a native Azure Data Catalog procedure. |
| Name | Type | Description |
| IncludeResultColumns | Boolean | Whether the output should include columns from the result set in addition to parameters. Defaults to False. |
Describes the primary and foreign keys.
The following query retrieves the primary key for the Tables table:
SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Tables'
| Name | Type | Description |
| CatalogName | String | The name of the database containing the key. |
| SchemaName | String | The name of the schema containing the key. |
| TableName | String | The name of the table containing the key. |
| ColumnName | String | The name of the key column. |
| IsKey | Boolean | Whether the column is a primary key in the table referenced in the TableName field. |
| IsForeignKey | Boolean | Whether the column is a foreign key referenced in the TableName field. |
| PrimaryKeyName | String | The name of the primary key. |
| ForeignKeyName | String | The name of the foreign key. |
| ReferencedCatalogName | String | The database containing the primary key. |
| ReferencedSchemaName | String | The schema containing the primary key. |
| ReferencedTableName | String | The table containing the primary key. |
| ReferencedColumnName | String | The column name of the primary key. |
Describes the foreign keys.
The following query retrieves all foreign keys which refer to other tables:
SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
| Name | Type | Description |
| CatalogName | String | The name of the database containing the key. |
| SchemaName | String | The name of the schema containing the key. |
| TableName | String | The name of the table containing the key. |
| ColumnName | String | The name of the key column. |
| PrimaryKeyName | String | The name of the primary key. |
| ForeignKeyName | String | The name of the foreign key. |
| ReferencedCatalogName | String | The database containing the primary key. |
| ReferencedSchemaName | String | The schema containing the primary key. |
| ReferencedTableName | String | The table containing the primary key. |
| ReferencedColumnName | String | The column name of the primary key. |
| ForeignKeyType | String | Designates whether the foreign key is an import (points to other tables) or export (referenced from other tables) key. |
Describes the primary keys.
The following query retrieves the primary keys from all tables and views:
SELECT * FROM sys_primarykeys
| Name | Type | Description |
| CatalogName | String | The name of the database containing the key. |
| SchemaName | String | The name of the schema containing the key. |
| TableName | String | The name of the table containing the key. |
| ColumnName | String | The name of the key column. |
| KeySeq | String | The sequence number of the primary key. |
| KeyName | String | The name of the primary key. |
Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.
The following query retrieves all indexes that are not primary keys:
SELECT * FROM sys_indexes WHERE IsPrimary='false'
| Name | Type | Description |
| CatalogName | String | The name of the database containing the index. |
| SchemaName | String | The name of the schema containing the index. |
| TableName | String | The name of the table containing the index. |
| IndexName | String | The index name. |
| ColumnName | String | The name of the column associated with the index. |
| IsUnique | Boolean | True if the index is unique. False otherwise. |
| IsPrimary | Boolean | True if the index is a primary key. False otherwise. |
| Type | Int16 | An integer value corresponding to the index type: statistic (0), clustered (1), hashed (2), or other (3). |
| SortOrder | String | The sort order: A for ascending or D for descending. |
| OrdinalPosition | Int16 | The sequence number of the column in the index. |
Returns information on the available connection properties and those set in the connection string.
The following query retrieves all connection properties that have been set in the connection string or set through a default value:
SELECT * FROM sys_connection_props WHERE Value <> ''
| Name | Type | Description |
| Name | String | The name of the connection property. |
| ShortDescription | String | A brief description. |
| Type | String | The data type of the connection property. |
| Default | String | The default value if one is not explicitly set. |
| Values | String | A comma-separated list of possible values. A validation error is thrown if another value is specified. |
| Value | String | The value you set or a preconfigured default. |
| Required | Boolean | Whether the property is required to connect. |
| Category | String | The category of the connection property. |
| IsSessionProperty | String | Whether the property is a session property, used to save information about the current connection. |
| Sensitivity | String | The sensitivity level of the property. This informs whether the property is obfuscated in logging and authentication forms. |
| PropertyName | String | A camel-cased truncated form of the connection property name. |
| Ordinal | Int32 | The index of the parameter. |
| CatOrdinal | Int32 | The index of the parameter category. |
| Hierarchy | String | Shows dependent properties associated that need to be set alongside this one. |
| Visible | Boolean | Informs whether the property is visible in the connection UI. |
| ETC | String | Various miscellaneous information about the property. |
Describes the SELECT query processing that the Cloud can offload to the data source.
See SQL Compliance for SQL syntax details.
Below is an example data set of SQL capabilities. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.
| Name | Description | Possible Values |
| AGGREGATE_FUNCTIONS | Supported aggregation functions. | AVG, COUNT, MAX, MIN, SUM, DISTINCT |
| COUNT | Whether COUNT function is supported. | YES, NO |
| IDENTIFIER_QUOTE_OPEN_CHAR | The opening character used to escape an identifier. | [ |
| IDENTIFIER_QUOTE_CLOSE_CHAR | The closing character used to escape an identifier. | ] |
| SUPPORTED_OPERATORS | A list of supported SQL operators. | =, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR |
| GROUP_BY | Whether GROUP BY is supported, and, if so, the degree of support. | NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE |
| OJ_CAPABILITIES | The supported varieties of outer joins supported. | NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS |
| OUTER_JOINS | Whether outer joins are supported. | YES, NO |
| SUBQUERIES | Whether subqueries are supported, and, if so, the degree of support. | NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED |
| STRING_FUNCTIONS | Supported string functions. | LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE |
| NUMERIC_FUNCTIONS | Supported numeric functions. | ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE |
| TIMEDATE_FUNCTIONS | Supported date/time functions. | NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT |
| REPLICATION_SKIP_TABLES | Indicates tables skipped during replication. | |
| REPLICATION_TIMECHECK_COLUMNS | A string array containing a list of columns which will be used to check for (in the given order) to use as a modified column during replication. | |
| IDENTIFIER_PATTERN | String value indicating what string is valid for an identifier. | |
| SUPPORT_TRANSACTION | Indicates if the provider supports transactions such as commit and rollback. | YES, NO |
| DIALECT | Indicates the SQL dialect to use. | |
| KEY_PROPERTIES | Indicates the properties which identify the uniform database. | |
| SUPPORTS_MULTIPLE_SCHEMAS | Indicates if multiple schemas may exist for the provider. | YES, NO |
| SUPPORTS_MULTIPLE_CATALOGS | Indicates if multiple catalogs may exist for the provider. | YES, NO |
| DATASYNCVERSION | The CData Data Sync version needed to access this driver. | Standard, Starter, Professional, Enterprise |
| DATASYNCCATEGORY | The CData Data Sync category of this driver. | Source, Destination, Cloud Destination |
| SUPPORTSENHANCEDSQL | Whether enhanced SQL functionality beyond what is offered by the API is supported. | TRUE, FALSE |
| SUPPORTS_BATCH_OPERATIONS | Whether batch operations are supported. | YES, NO |
| SQL_CAP | All supported SQL capabilities for this driver. | SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX |
| PREFERRED_CACHE_OPTIONS | A string value specifies the preferred cacheOptions. | |
| ENABLE_EF_ADVANCED_QUERY | Indicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side. | YES, NO |
| PSEUDO_COLUMNS | A string array indicating the available pseudo columns. | |
| MERGE_ALWAYS | If the value is true, The Merge Mode is forcibly executed in Data Sync. | TRUE, FALSE |
| REPLICATION_MIN_DATE_QUERY | A select query to return the replicate start datetime. | |
| REPLICATION_MIN_FUNCTION | Allows a provider to specify the formula name to use for executing a server side min. | |
| REPLICATION_START_DATE | Allows a provider to specify a replicate startdate. | |
| REPLICATION_MAX_DATE_QUERY | A select query to return the replicate end datetime. | |
| REPLICATION_MAX_FUNCTION | Allows a provider to specify the formula name to use for executing a server side max. | |
| IGNORE_INTERVALS_ON_INITIAL_REPLICATE | A list of tables which will skip dividing the replicate into chunks on the initial replicate. | |
| CHECKCACHE_USE_PARENTID | Indicates whether the CheckCache statement should be done against the parent key column. | TRUE, FALSE |
| CREATE_SCHEMA_PROCEDURES | Indicates stored procedures that can be used for generating schema files. |
The following query retrieves the operators that can be used in the WHERE clause:
SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'
Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.
| Name | Type | Description |
| NAME | String | A component of SQL syntax, or a capability that can be processed on the server. |
| VALUE | String | Detail on the supported SQL or SQL syntax. |
Returns information about attempted modifications.
The following query retrieves the Ids of the modified rows in a batch operation:
SELECT * FROM sys_identity
| Name | Type | Description |
| Id | String | The database-generated Id returned from a data modification operation. |
| Batch | String | An identifier for the batch. 1 for a single operation. |
| Operation | String | The result of the operation in the batch: INSERTED, UPDATED, or DELETED. |
| Message | String | SUCCESS or an error message if the update in the batch failed. |
Describes the available system information.
The following query retrieves all columns:
SELECT * FROM sys_information
| Name | Type | Description |
| Product | String | The name of the product. |
| Version | String | The version number of the product. |
| Datasource | String | The name of the datasource the product connects to. |
| NodeId | String | The unique identifier of the machine where the product is installed. |
| HelpURL | String | The URL to the product's help documentation. |
| License | String | The license information for the product. (If this information is not available, the field may be left blank or marked as 'N/A'.) |
| Location | String | The file path location where the product's library is stored. |
| Environment | String | The version of the environment or rumtine the product is currently running under. |
| DataSyncVersion | String | The tier of CData Sync required to use this connector. |
| DataSyncCategory | String | The category of CData Sync functionality (e.g., Source, Destination). |
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.
| 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. |
| 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. |
| 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. |
| 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. |
| Property | Description |
| SSLServerCert | Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
| Property | Description |
| Verbosity | Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5. |
| Property | Description |
| BrowsableSchemas | Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC . |
| Property | Description |
| MaxRows | Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY. |
| 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'. |
| ThrowsKeyNotFound | Specifies whether or not throws an exception if there is no rows updated. |
| Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. |
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.
string
"AzureAD"
AuthScheme values include:
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.
string
"defaultcatalog"
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.
string
""
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:
You can provide the tenant value in one of two formats:
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.
string
"GLOBAL"
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.
string
""
This property is required in two cases:
(When the driver provides embedded OAuth credentials, this value may already be provided by the Cloud 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.).
string
""
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:
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.
string
""
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.
string
""
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 Cloud initiates a search for a certificate. For further information, see OAuthJWTCertSubject.
Designations of certificate stores are platform-dependent.
Notes
Identifies the type of key store containing the JWT Certificate.
string
"PEMKEY_BLOB"
| 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.
string
""
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.
string
"*"
The value of this property is used to locate a matching certificate in the store. The search process works as follows:
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.
string
""
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 Logging properties you can configure in the connection string for this provider.
| Property | Description |
| Verbosity | Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5. |
Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.
string
"1"
This property defines the level of detail the Cloud includes in the log file. Higher verbosity levels increase the detail of the logged information, but may also result in larger log files and slower performance due to the additional data being captured.
The default verbosity level is 1, which is recommended for regular operation. Higher verbosity levels are primarily intended for debugging purposes. For more information on each level, refer to Logging.
When combined with the LogModules property, Verbosity can refine logging to specific categories of information.
This section provides a complete list of the Schema properties you can configure in the connection string for this provider.
| Property | Description |
| BrowsableSchemas | Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC . |
Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
string
""
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.
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. |
| 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'. |
| ThrowsKeyNotFound | Specifies whether or not throws an exception if there is no rows updated. |
| Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. |
Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
int
-1
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 the maximum number of records per page the provider returns when requesting data from Azure Data Catalog.
int
100
When processing a query, instead of requesting all of the queried data at once from Azure Data Catalog, the Cloud can request the queried data in pieces called pages.
This connection property determines the maximum number of results that the Cloud requests per page.
Note: Setting large page sizes may improve overall query execution time, but doing so causes the Cloud 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'.
string
""
This property allows you to define which pseudocolumns the Cloud 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 whether or not throws an exception if there is no rows updated.
bool
false
Specifies whether or not throws an exception if there is no rows updated.
Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
int
60
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.
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.