This page provides a guide to Establishing a Connection to Microsoft Dataverse in CData Cloud, as well as information on the available resources, and a reference to the available connection properties.

Connecting to Microsoft Dataverse

Establishing a Connection shows how to authenticate to Microsoft Dataverse and configure any necessary connection properties to create a database in CData Cloud

Accessing Data from CData Cloud Services

Accessing data from Microsoft Dataverse through the available standard services and CData Cloud administration is documented in further details in the CData Cloud Documentation.

Connect to Microsoft Dataverse 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.

Schema

Microsoft Dataverse supports schema values of 'System' and 'Entities' and can be set using the Schema property.

Using 'System' for Schema property uses the Web API to query entities/tables.

Using 'Entities' for Schema property uses the EntityDefinitions entity set path and retrieves information about EntityMetadata EntityType entities/tables. This will often result in more user friendly names, though requires extra metadata requests.

Connecting to Microsoft Dataverse

To authenticate to the Microsoft Dataverse source, you should first set the OrganizationUrl to the URL of the organization you are connecting to, such as https://[organization].crm.dynamics.com.

Azure AD

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

Client Credentials

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

Client OAuth Flow

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

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

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

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

Authentication with client credentials will take place automatically like any other connection, except there will be no window opened prompting the user. Because there is no user context, there is no need for a browser popup. Connections will take place and be handled internally.

Azure Service Principal

Azure Service Principal is 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 Custom OAuth Application.

Managed Service Identity (MSI)

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

User-Managed Identities

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

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

Customizing the SSL Configuration

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

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

Connecting Through a Firewall or Proxy

HTTP Proxies

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

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

Other Proxies

Set the following properties:

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

Overview

This section shows the available API objects and provides more information on executing SQL to Microsoft Dataverse APIs.

The CData Cloud models Microsoft Dataverse entities in relational Tables, Views, and Stored Procedures. The table definitions are dynamically obtained from the OData service you connect to. Any changes in the metadata, such as added or removed columns or changes in data type, can be loaded by reconnecting.

Tables

The Cloud models the writable entities described in the service metadata document as bidirectional tables.

Stored Procedures

Are function-like interfaces to the data source. They can be used to perform additional operations that fall outside of the standard CRUD model such as retrieving an OAuth access token.

Microsoft Dataverse Entities Data Model

Entities Data Model describes the schemas available to connect to Microsoft Dataverse. You can use tables to work with live Microsoft Dataverse data. You can use stored procedures provided by CData Cloud to automate working with Microsoft Dataverse data.

Microsoft Dataverse System Data Model

System Data Model describes the schemas available to connect to Microsoft Dataverse. You can use tables to work with live Microsoft Dataverse data. You can use stored procedures provided by CData Cloud to automate working with Microsoft Dataverse data.

Views

Views describes the available views.

Stored Procedures

Stored Procedures are function-like interfaces to Microsoft Dataverse. Stored procedures allow you to execute operations to Microsoft Dataverse, such as retrieving the OAuth Access Token.

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.

CData Cloud - Microsoft Dataverse Views

Name	Description
MultiSelectPickListAttributeMetaData	Contains the Picklist metadata for an attribute type MultiSelect OptionSet.
MultiSelectPickListOptions	Contains the Options Value of MultiSelect PicklistMetadata.
PickListAttributeMetaData	Contains the metadata for an attribute type Picklist.
PickListOptions	Contains the Options value of PickListMetaData
StateAttributeMetadata	Contains the metadata for an attribute type State.
StateAttributeOptions	Contains the Options value of the State Attribute.
StatusAttributeMetadata	Contains the metadata for an attribute type Status.
StatusAttributeOptions	Contains the Options value of the Status Attribute.

Contains the Picklist metadata for an attribute type MultiSelect OptionSet.

Columns

Name	Type	References	Description
ColumnName [KEY]	String
MetadataId	String
OptionSet_Description_LocalizedLabels	String
OptionSet_Description_UserLocalizedLabel_HasChanged	String
OptionSet_Description_UserLocalizedLabel_IsManaged	Boolean
OptionSet_Description_UserLocalizedLabel_Label	String
OptionSet_Description_UserLocalizedLabel_LanguageCode	Integer
OptionSet_Description_UserLocalizedLabel_MetadataId	String
OptionSet_DisplayName_LocalizedLabels	String
OptionSet_DisplayName_UserLocalizedLabel_HasChanged	String
OptionSet_DisplayName_UserLocalizedLabel_IsManaged	Boolean
OptionSet_DisplayName_UserLocalizedLabel_Label	String
OptionSet_DisplayName_UserLocalizedLabel_LanguageCode	Integer
OptionSet_DisplayName_UserLocalizedLabel_MetadataId	String
OptionSet_ExternalTypeName	String
OptionSet_HasChanged	String
OptionSet_IntroducedVersion	String
OptionSet_IsCustomizable_CanBeChanged	Boolean
OptionSet_IsCustomizable_ManagedPropertyLogicalName	String
OptionSet_IsCustomizable_Value	Boolean
OptionSet_IsCustomOptionSet	Boolean
OptionSet_IsGlobal	Boolean
OptionSet_IsManaged	Boolean
OptionSet_MetadataId	String
OptionSet_Name	String
OptionSet_OptionSetType	String
OptionSet_ParentOptionSetName	String
TableName	String

Contains the Options Value of MultiSelect PicklistMetadata.

Columns

Name	Type	References	Description
ColumnName	String	MultiSelectPickListAttributeMetaData.ColumnName
Color	String
ExternalValue	String
HasChanged	String
IsManaged	Boolean
Label_LocalizedLabels	String
Label_UserLocalizedLabel_HasChanged	String
Label_UserLocalizedLabel_IsManaged	Boolean
Label_UserLocalizedLabel_Label	String
Label_UserLocalizedLabel_LanguageCode	Integer
Label_UserLocalizedLabel_MetadataId	String
Description_LocalizedLabels	String
Description_UserLocalizedLabel_HasChanged	String
Description_UserLocalizedLabel_IsManaged	Boolean
Description_UserLocalizedLabel_Label	String
Description_UserLocalizedLabel_LanguageCode	Integer
Description_UserLocalizedLabel_MetadataId	String
MetadataId	String
ParentValues	String
Value	Integer
TableName	String

Contains the metadata for an attribute type Picklist.

Columns

Name	Type	References	Description
ColumnName [KEY]	String
MetadataId	String
OptionSet_Description_LocalizedLabels	String
OptionSet_Description_UserLocalizedLabel_HasChanged	String
OptionSet_Description_UserLocalizedLabel_IsManaged	Boolean
OptionSet_Description_UserLocalizedLabel_Label	String
OptionSet_Description_UserLocalizedLabel_LanguageCode	Integer
OptionSet_Description_UserLocalizedLabel_MetadataId	String
OptionSet_DisplayName_LocalizedLabels	String
OptionSet_DisplayName_UserLocalizedLabel_HasChanged	String
OptionSet_DisplayName_UserLocalizedLabel_IsManaged	Boolean
OptionSet_DisplayName_UserLocalizedLabel_Label	String
OptionSet_DisplayName_UserLocalizedLabel_LanguageCode	Integer
OptionSet_DisplayName_UserLocalizedLabel_MetadataId	String
OptionSet_ExternalTypeName	String
OptionSet_HasChanged	String
OptionSet_IntroducedVersion	String
OptionSet_IsCustomizable_CanBeChanged	Boolean
OptionSet_IsCustomizable_ManagedPropertyLogicalName	String
OptionSet_IsCustomizable_Value	Boolean
OptionSet_IsCustomOptionSet	Boolean
OptionSet_IsGlobal	Boolean
OptionSet_IsManaged	Boolean
OptionSet_MetadataId	String
OptionSet_Name	String
OptionSet_OptionSetType	String
OptionSet_ParentOptionSetName	String
TableName	String

Contains the Options value of PickListMetaData

Columns

Name	Type	References	Description
ColumnName	String	PickListAttributeMetaData.ColumnName
Color	String
ExternalValue	String
HasChanged	String
IsManaged	Boolean
Label_LocalizedLabels	String
Label_UserLocalizedLabel_HasChanged	String
Label_UserLocalizedLabel_IsManaged	Boolean
Label_UserLocalizedLabel_Label	String
Label_UserLocalizedLabel_LanguageCode	Integer
Label_UserLocalizedLabel_MetadataId	String
Description_LocalizedLabels	String
Description_UserLocalizedLabel	String
MetadataId	String
ParentValues	String
Value	Integer
TableName	String

Contains the metadata for an attribute type State.

Columns

Name	Type	References	Description
ColumnName [KEY]	String
MetadataId	String
OptionSet_Description_LocalizedLabels	String
OptionSet_Description_UserLocalizedLabel_HasChanged	String
OptionSet_Description_UserLocalizedLabel_IsManaged	Boolean
OptionSet_Description_UserLocalizedLabel_Label	String
OptionSet_Description_UserLocalizedLabel_LanguageCode	Integer
OptionSet_Description_UserLocalizedLabel_MetadataId	String
OptionSet_DisplayName_LocalizedLabels	String
OptionSet_DisplayName_UserLocalizedLabel_HasChanged	String
OptionSet_DisplayName_UserLocalizedLabel_IsManaged	Boolean
OptionSet_DisplayName_UserLocalizedLabel_Label	String
OptionSet_DisplayName_UserLocalizedLabel_LanguageCode	Integer
OptionSet_DisplayName_UserLocalizedLabel_MetadataId	String
OptionSet_ExternalTypeName	String
OptionSet_HasChanged	String
OptionSet_IntroducedVersion	String
OptionSet_IsCustomizable_CanBeChanged	Boolean
OptionSet_IsCustomizable_ManagedPropertyLogicalName	String
OptionSet_IsCustomizable_Value	Boolean
OptionSet_IsCustomOptionSet	Boolean
OptionSet_IsGlobal	Boolean
OptionSet_IsManaged	Boolean
OptionSet_MetadataId	String
OptionSet_Name	String
OptionSet_OptionSetType	String
OptionSet_ParentOptionSetName	String
TableName	String

Contains the Options value of the State Attribute.

Columns

Name	Type	References	Description
ColumnName	String	StateAttributeMetadata.ColumnName
Color	String
ExternalValue	String
HasChanged	String
IsManaged	Boolean
Label_LocalizedLabels	String
Label_UserLocalizedLabel_HasChanged	String
Label_UserLocalizedLabel_IsManaged	Boolean
Label_UserLocalizedLabel_Label	String
Label_UserLocalizedLabel_LanguageCode	Integer
Label_UserLocalizedLabel_MetadataId	String
Description_LocalizedLabels	String
Description_UserLocalizedLabel	String
MetadataId	String
ParentValues	String
Value	Integer
TableName	String

Contains the metadata for an attribute type Status.

Columns

Name	Type	References	Description
ColumnName [KEY]	String
MetadataId	String
OptionSet_Description_LocalizedLabels	String
OptionSet_Description_UserLocalizedLabel_HasChanged	String
OptionSet_Description_UserLocalizedLabel_IsManaged	Boolean
OptionSet_Description_UserLocalizedLabel_Label	String
OptionSet_Description_UserLocalizedLabel_LanguageCode	Integer
OptionSet_Description_UserLocalizedLabel_MetadataId	String
OptionSet_DisplayName_LocalizedLabels	String
OptionSet_DisplayName_UserLocalizedLabel_HasChanged	String
OptionSet_DisplayName_UserLocalizedLabel_IsManaged	Boolean
OptionSet_DisplayName_UserLocalizedLabel_Label	String
OptionSet_DisplayName_UserLocalizedLabel_LanguageCode	Integer
OptionSet_DisplayName_UserLocalizedLabel_MetadataId	String
OptionSet_ExternalTypeName	String
OptionSet_HasChanged	String
OptionSet_IntroducedVersion	String
OptionSet_IsCustomizable_CanBeChanged	Boolean
OptionSet_IsCustomizable_ManagedPropertyLogicalName	String
OptionSet_IsCustomizable_Value	Boolean
OptionSet_IsCustomOptionSet	Boolean
OptionSet_IsGlobal	Boolean
OptionSet_IsManaged	Boolean
OptionSet_MetadataId	String
OptionSet_Name	String
OptionSet_OptionSetType	String
OptionSet_ParentOptionSetName	String
TableName	String

Contains the Options value of the Status Attribute.

Columns

Name	Type	References	Description
ColumnName	String	StatusAttributeMetadata.ColumnName
Color	String
ExternalValue	String
HasChanged	String
IsManaged	Boolean
Label_LocalizedLabels	String
Label_UserLocalizedLabel_HasChanged	String
Label_UserLocalizedLabel_IsManaged	Boolean
Label_UserLocalizedLabel_Label	String
Label_UserLocalizedLabel_LanguageCode	Integer
Label_UserLocalizedLabel_MetadataId	String
Description_LocalizedLabels	String
Description_UserLocalizedLabel	String
MetadataId	String
ParentValues	String
Value	Integer
TableName	String

Stored procedures are function-like interfaces that extend the functionality of the Cloud beyond simple SELECT/INSERT/UPDATE/DELETE operations with Microsoft Dataverse.

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

CData Cloud - Microsoft Dataverse Stored Procedures

Name	Description

Views

Describes the available views.

Stored Procedures

Stored Procedures are function-like interfaces to Microsoft Dataverse. Stored procedures allow you to execute operations to Microsoft Dataverse, such as retrieving the OAuth Access Token.

Stored procedures are function-like interfaces that extend the functionality of the Cloud beyond simple SELECT/INSERT/UPDATE/DELETE operations with Microsoft Dataverse.

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

CData Cloud - Microsoft Dataverse Stored Procedures

Name	Description
CreateAssociation	Creates an association between two entities based on a navigation property.
ListAssociations	Lists associations for a given table and navigation property.
ListNavigationProperties	Lists navigation properties for a given table and the tables they are associated with. Navigation properties are used by the Association stored procedures.
RemoveAssociation	Removes an association between two entities based on a navigation property.

Creates an association between two entities based on a navigation property.

Input

Name	Type	Required	Description
FromId	String	True	The Id of the entity you are creating an associations for.
FromTable	String	True	The table where the entity comes from that you are creating an association for. For example, if the FromId was from a table called Customers, set this parameter to: Customers.
ToNavigationProperty	String	True	The navigation property you are creating an association on. It can be obtained from ListNavigationProperties.
ToId	String	True	The id of the navigation entity. This will come from the table associated with the navigation property.

Lists associations for a given table and navigation property.

Input

Name	Type	Required	Description
FromId	String	True	The Id of the entity you are listing associations for.
FromTable	String	True	The table where the entity comes from that you are listing entities for. For example, if the FromId was from a table called Customers, set this parameter to: Customers.
NavigationProperty	String	True	The navigation property you are listing assications for. It can be obtained from ListNavigationProperties.

Result Set Columns

Name	Type	Description
Uri	String	The linked url.

Lists navigation properties for a given table and the tables they are associated with. Navigation properties are used by the Association stored procedures.

Input

Name	Type	Required	Description
TableName	String	True	The name of the table to list navigation properties for.

Result Set Columns

Name	Type	Description
Name	String	The name of the navigation property.
AssociatedTable	String	The table the navigation property is associated with.

Removes an association between two entities based on a navigation property.

Input

Name	Type	Required	Description
FromId	String	True	The Id of the entity you are removing an associations for.
FromTable	String	True	The table where the entity comes from that you are removing an association for. For example, if the FromId was from a table called Customers, set this parameter to: Customers.
ToNavigationProperty	String	True	The navigation property you are removing an association on. It can be obtained from ListNavigationProperties.
ToId	String	True	The id of the navigation entity. This will come from the table associated with the navigation property.

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

Schema Tables

The following tables return database metadata for Microsoft Dataverse:

• sys_catalogs: Lists the available databases.
• sys_schemas: Lists the available schemas.
• sys_tables: Lists the available tables and views.
• sys_tablecolumns: Describes the columns of the available tables and views.
• sys_procedures: Describes the available stored procedures.
• sys_procedureparameters: Describes stored procedure parameters.
• sys_keycolumns: Describes the primary and foreign keys.
• sys_indexes: Describes the available indexes.

Data Source Tables

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

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

Query Information Tables

The following table returns query statistics for data modification queries, including batch operations::

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

Lists the available databases.

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

SELECT * FROM sys_catalogs

Columns

Name	Type	Description
CatalogName	String	The database name.

Lists the available schemas.

The following query retrieves all available schemas:

          SELECT * FROM sys_schemas
          

Columns

Name	Type	Description
CatalogName	String	The database name.
SchemaName	String	The schema name.

Lists the available tables.

The following query retrieves the available tables and views:

          SELECT * FROM sys_tables
          

Columns

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

Describes the columns of the available tables and views.

The following query returns the columns and data types for the Accounts table:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Accounts' 

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the table or view.
SchemaName	String	The schema containing the table or view.
TableName	String	The name of the table or view containing the column.
ColumnName	String	The column name.
DataTypeName	String	The data type name.
DataType	Int32	An integer indicating the data type. This value is determined at run time based on the environment.
Length	Int32	The storage size of the column.
DisplaySize	Int32	The designated column's normal maximum width in characters.
NumericPrecision	Int32	The maximum number of digits in numeric data. The column length in characters for character and date-time data.
NumericScale	Int32	The column scale or number of digits to the right of the decimal point.
IsNullable	Boolean	Whether the column can contain null.
Description	String	A brief description of the column.
Ordinal	Int32	The sequence number of the column.
IsAutoIncrement	String	Whether the column value is assigned in fixed increments.
IsGeneratedColumn	String	Whether the column is generated.
IsHidden	Boolean	Whether the column is hidden.
IsArray	Boolean	Whether the column is an array.
IsReadOnly	Boolean	Whether the column is read-only.
IsKey	Boolean	Indicates whether a field returned from sys_tablecolumns is the primary key of the table.

Lists the available stored procedures.

The following query retrieves the available stored procedures:

          SELECT * FROM sys_procedures
          

Columns

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

Describes stored procedure parameters.

The following query returns information about all of the input parameters for the GetOAuthAccessToken stored procedure:

SELECT * FROM sys_procedureparameters WHERE ProcedureName='GetOAuthAccessToken' AND Direction=1 OR Direction=2

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the stored procedure.
SchemaName	String	The name of the schema containing the stored procedure.
ProcedureName	String	The name of the stored procedure containing the parameter.
ColumnName	String	The name of the stored procedure parameter.
Direction	Int32	An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters.
DataTypeName	String	The name of the data type.
DataType	Int32	An integer indicating the data type. This value is determined at run time based on the environment.
Length	Int32	The number of characters allowed for character data. The number of digits allowed for numeric data.
NumericPrecision	Int32	The maximum precision for numeric data. The column length in characters for character and date-time data.
NumericScale	Int32	The number of digits to the right of the decimal point in numeric data.
IsNullable	Boolean	Whether the parameter can contain null.
IsRequired	Boolean	Whether the parameter is required for execution of the procedure.
IsArray	Boolean	Whether the parameter is an array.
Description	String	The description of the parameter.
Ordinal	Int32	The index of the parameter.

Describes the primary and foreign keys.

The following query retrieves the primary key for the Accounts table:

         SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Accounts' 
          

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
IsKey	Boolean	Whether the column is a primary key in the table referenced in the TableName field.
IsForeignKey	Boolean	Whether the column is a foreign key referenced in the TableName field.
PrimaryKeyName	String	The name of the primary key.
ForeignKeyName	String	The name of the foreign key.
ReferencedCatalogName	String	The database containing the primary key.
ReferencedSchemaName	String	The schema containing the primary key.
ReferencedTableName	String	The table containing the primary key.
ReferencedColumnName	String	The column name of the primary key.

Describes the foreign keys.

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

         SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
          

Columns

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

Describes the primary keys.

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

         SELECT * FROM sys_primarykeys
          

Columns

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

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

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

          SELECT * FROM sys_indexes WHERE IsPrimary='false'
          

Columns

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

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

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

jdbc:cdata:cds:config:

This connection string enables you to query this table without a valid connection.

The following query retrieves all connection properties that have been set in the connection string or set through a default value:

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns

Name	Type	Description
Name	String	The name of the connection property.
ShortDescription	String	A brief description.
Type	String	The data type of the connection property.
Default	String	The default value if one is not explicitly set.
Values	String	A comma-separated list of possible values. A validation error is thrown if another value is specified.
Value	String	The value you set or a preconfigured default.
Required	Boolean	Whether the property is required to connect.
Category	String	The category of the connection property.
IsSessionProperty	String	Whether the property is a session property, used to save information about the current connection.
Sensitivity	String	The sensitivity level of the property. This informs whether the property is obfuscated in logging and authentication forms.
PropertyName	String	A camel-cased truncated form of the connection property name.
Ordinal	Int32	The index of the parameter.
CatOrdinal	Int32	The index of the parameter category.
Hierarchy	String	Shows dependent properties associated that need to be set alongside this one.
Visible	Boolean	Informs whether the property is visible in the connection UI.
ETC	String	Various miscellaneous information about the property.

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

See SQL Compliance for SQL syntax details.

Discovering the Data Source's SELECT Capabilities

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

Name	Description	Possible Values
AGGREGATE_FUNCTIONS	Supported aggregation functions.	AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNT	Whether COUNT function is supported.	YES, NO
IDENTIFIER_QUOTE_OPEN_CHAR	The opening character used to escape an identifier.	[
IDENTIFIER_QUOTE_CLOSE_CHAR	The closing character used to escape an identifier.	]
SUPPORTED_OPERATORS	A list of supported SQL operators.	=, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BY	Whether GROUP BY is supported, and, if so, the degree of support.	NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
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.

Columns

Name	Type	Description
NAME	String	A component of SQL syntax, or a capability that can be processed on the server.
VALUE	String	Detail on the supported SQL or SQL syntax.

Returns information about attempted modifications.

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

         SELECT * FROM sys_identity
          

Columns

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

Data Type Mappings

The Cloud maps types from the data source to the corresponding data type available in the schema. The table below documents these mappings.

Microsoft Dataverse (OData V4)	CData Schema
Edm.Binary	binary
Edm.Boolean	bool
Edm.Date	datetime
Edm.DateTimeOffset	datetime
Edm.Decimal	decimal
Edm.Double	double
Edm.Guid	guid
Edm.Int32	int
Edm.String	string
Edm.TimeOfDay	time

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

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

Authentication

---

Property	Description
AuthScheme	The type of authentication to use when connecting to Microsoft Dataverse.
OrganizationURL	The URL to your Microsoft Dataverse data. For instance, https://abc123.crm.dynamics.com/.
Tenant	The Microsoft tenant being used to access data. If not specified, your default tenant is used.

Azure Authentication

---

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

OAuth

---

Property	Description
OAuthClientId	The client Id assigned when you register your application with an OAuth authorization server.
OAuthClientSecret	The client secret assigned when you register your application with an OAuth authorization server.
OAuthGrantType	The grant type for the OAuth flow.

JWT OAuth

---

Property	Description
OAuthJWTCert	The JWT Certificate store.
OAuthJWTCertType	The type of key store containing the JWT Certificate.
OAuthJWTCertPassword	The password for the OAuth JWT certificate.
OAuthJWTCertSubject	The subject of the OAuth JWT certificate.

SSL

---

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

Logging

---

Property	Description
Verbosity	The verbosity level that determines the amount of detail included in the log file.

Schema

---

Property	Description
BrowsableSchemas	This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Schema	Schema to use System, Entities.

Miscellaneous

---

Property	Description
ApiVersion	The API version being used. This can be specified to access a new version of the API once it is released.
IncludeFormattedValues	Indicates if columns that hold formatted values should be exposed.
MaxRows	Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
PseudoColumns	This property indicates whether or not to include pseudo columns as columns to the table.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.
UseDisplayNames	If set to true, the provider will use display names for some operations.

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

---

Property	Description
AuthScheme	The type of authentication to use when connecting to Microsoft Dataverse.
OrganizationURL	The URL to your Microsoft Dataverse data. For instance, https://abc123.crm.dynamics.com/.
Tenant	The Microsoft tenant being used to access data. If not specified, your default tenant is used.

The type of authentication to use when connecting to Microsoft Dataverse.

Possible Values

AzureAD, AzureServicePrincipal, AzureServicePrincipalCert

Data Type

string

Default Value

"AzureAD"

Remarks

• AzureAD: Set this to perform Azure Active Directory OAuth authentication.
• AzureMSI: Set this to automatically obtain Managed Service Identity credentials when running on an Azure VM.
• AzureServicePrincipal: Set this to authenticate as an Azure Service Principal using a Client Secret.
• AzureServicePrincipalCert: Set this to authenticate as an Azure Service Principal using a Certificate.

The URL to your Microsoft Dataverse data. For instance, https://abc123.crm.dynamics.com/.

Data Type

string

Default Value

""

Remarks

The URL you use to log into your Microsoft Dataverse data. For instance, https://abc123.crm.dynamics.com/. This may also be known as the resource.

The Microsoft tenant being used to access data. If not specified, your default tenant is used.

Data Type

string

Default Value

""

Remarks

The Microsoft tenant being used to access data. For instance, contoso.onmicrosoft.com. Alternatively, specify the tenant id. This value is the directory Id in the Azure Portal > Azure Active Directory > Properties.

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

---

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

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

Data Type

string

Default Value

""

Remarks

The Microsoft Online tenant being used to access data. For instance, contoso.onmicrosoft.com. Alternatively, specify the tenant Id. This value is the directory Id in the Azure Portal > Azure Active Directory > Properties.

Typically it is not necessary to specify the Tenant. This can be automatically determined by Microsoft when using the OAuthGrantType set to CODE (default). However, it may fail in the case that the user belongs to multiple tenants. For instance, if an Admin of domain A invites a user of domain B to be a guest user. The user will now belong to both tenants. It is a good practice to specify the Tenant, although in general things should normally work without having to specify it.

The AzureTenant is required when setting OAuthGrantType to CLIENT. When using client credentials, there is no user context. The credentials are taken from the context of the app itself. While Microsoft still allows client credentials to be obtained without specifying which Tenant, it has a much lower probability of picking the specific tenant you want to work with. For this reason, we require AzureTenant to be explicitly stated for all client credentials connections to ensure you get credentials that are applicable for the domain you intend to connect to.

The Azure Environment to use when establishing a connection.

Possible Values

GLOBAL, CHINA, USGOVT, USGOVTDOD

Data Type

string

Default Value

"GLOBAL"

Remarks

In most cases, leaving the environment set to global will work. However, if your Azure Account has been added to a different environment, the AzureEnvironment may be used to specify which environment. The available values are GLOBAL, CHINA, USGOVT, USGOVTDOD.

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

---

Property	Description
OAuthClientId	The client Id assigned when you register your application with an OAuth authorization server.
OAuthClientSecret	The client secret assigned when you register your application with an OAuth authorization server.
OAuthGrantType	The grant type for the OAuth flow.

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

Data Type

string

Default Value

""

Remarks

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

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

Data Type

string

Default Value

""

Remarks

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

The grant type for the OAuth flow.

Possible Values

CODE, CLIENT, PASSWORD

Data Type

string

Default Value

"CODE"

Remarks

The following options are available: CODE,CLIENT,PASSWORD

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

---

Property	Description
OAuthJWTCert	The JWT Certificate store.
OAuthJWTCertType	The type of key store containing the JWT Certificate.
OAuthJWTCertPassword	The password for the OAuth JWT certificate.
OAuthJWTCertSubject	The subject of the OAuth JWT certificate.

The JWT Certificate store.

Data Type

string

Default Value

""

Remarks

The name of the certificate store for the client certificate.

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

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

Designations of certificate stores are platform-dependent.

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

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

The type of key store containing the JWT Certificate.

Data Type

string

Default Value

"PEMKEY_BLOB"

Remarks

This property can take one of the following values:

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

The password for the OAuth JWT certificate.

Data Type

string

Default Value

""

Remarks

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

The subject of the OAuth JWT certificate.

Data Type

string

Default Value

"*"

Remarks

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

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

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

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

The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, [email protected]". Common fields and their meanings are displayed below.

Field	Meaning
CN	Common Name. This is commonly a host name like www.server.com.
O	Organization
OU	Organizational Unit
L	Locality
S	State
C	Country
E	Email Address

If a field value contains a comma it must be quoted.

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

---

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

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

Data Type

string

Default Value

""

Remarks

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

This property can take the following forms:

Description	Example
A full PEM Certificate (example shortened for brevity)	-----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
A path to a local file containing the certificate	C:\cert.cer
The public key (example shortened for brevity)	-----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
The MD5 Thumbprint (hex values can also be either space or colon separated)	ecadbdda5a1529c58a1e9e09828d70e4
The SHA1 Thumbprint (hex values can also be either space or colon separated)	34a929226ae0819f2ec14b4a3d904f801cbb150d

If not specified, any certificate trusted by the machine is accepted.

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

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

---

Property	Description
Verbosity	The verbosity level that determines the amount of detail included in the log file.

The verbosity level that determines the amount of detail included in the log file.

Data Type

string

Default Value

"1"

Remarks

The verbosity level determines the amount of detail that the Cloud reports to the Logfile. Verbosity levels from 1 to 5 are supported. These are detailed in the Logging page.

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

---

Property	Description
BrowsableSchemas	This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Schema	Schema to use System, Entities.

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

Data Type

string

Default Value

""

Remarks

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

Schema to use System, Entities.

Possible Values

System, Entities

Data Type

string

Default Value

"System"

Remarks

Schema to use System, Entities

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

---

Property	Description
ApiVersion	The API version being used. This can be specified to access a new version of the API once it is released.
IncludeFormattedValues	Indicates if columns that hold formatted values should be exposed.
MaxRows	Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
PseudoColumns	This property indicates whether or not to include pseudo columns as columns to the table.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.
UseDisplayNames	If set to true, the provider will use display names for some operations.

The API version being used. This can be specified to access a new version of the API once it is released.

Data Type

string

Default Value

"9.0"

Remarks

The API version being used. This can be specified to access a new version of the API once it is released. Otherwise, you can use the default.

Indicates if columns that hold formatted values should be exposed.

Data Type

bool

Default Value

false

Remarks

For each column, an extra one is added to expose the formatted value. New columns will have "_display" postfix.

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

Data Type

int

Default Value

-1

Remarks

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

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

Data Type

string

Default Value

""

Remarks

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

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

Data Type

int

Default Value

60

Remarks

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

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

If set to true, the provider will use display names for some operations.

Data Type

bool

Default Value

false

Remarks

If set to true, the Cloud will use display names for some operations. This property is used only for Entities schema.