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

Connecting to OData

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

Accessing Data from CData Cloud Services

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

Connect to OData 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.

Connecting to OData

To connect to OData, you must set the URL to a valid OData service root URI. If your OData service does not have a root document, have FeedURL point to the specific entity you want to expose as a table.

Authenticating to OData

OData supports authentication via:

• HTTP
• Kerberos
• SharePoint Online
• OAuth
• Azure AD

HTTP Auth Schemes

For authenticating via HTTP, set AuthScheme according to the following table.

Scheme	AuthScheme	Other Settings
None	None	Use if no authentication is desired.
Basic	Basic	User, Password
NTLM (1)	NTLM	User, Password
Digest (if supported)	Digest	User, Password

(1) NTLM is a type of Windows authentication often used across a LAN using your Windows user credentials. Set the User and Password if you are not connecting from a Windows machine, or if your currently logged in user account should not be used for the connection.

Kerberos

To authenticate to OData using Kerberos, set these properties:

• hive.server2.authentication: Kerberos.
• AuthScheme: NEGOTIATE.
• KerberosKDC: The host name or IP Address of your Kerberos KDC machine.
• KerberosSPN: The service and host of the OData Kerberos Principal. Find this value just before the '@' symbol of the principal value.

SharePoint Online

SharePoint Online connections are established by retrieving a SharePoint Online cookie. To authenticate, set these properties:

• AuthScheme: SharePointOnline.
• User: The authenticating SharePoint Online user account.
• Password: The authenticating account's password.

OAuth

To enable this authentication from all OAuth flows in OData, you must create a custom OAuth application, and set AuthScheme to OAuth.

The following subsections describe how to authenticate to OData from three common authentication flows. For information about how to create a custom OAuth application, see Creating a Custom OAuth Application. For a complete list of connection string properties available in OData, see Connection.

Automatic refresh of the OAuth access token:

To have the Cloud automatically refresh the OAuth access token:

1. Before connecting to data for the first time, set these connection parameters:
   • InitiateOAuth: REFRESH.
   • OAuthClientId: The client Id in your custom OAuth application settings.
   • OAuthClientSecret: The client secret in your custom OAuth application settings.
   • OAuthAccessToken: The access token returned by GetOAuthAccessToken.
   • OAuthSettingsLocation: The path where you want the Cloud to save the OAuth values, which persist across connections.
2. On subsequent data connections, set:
   • InitiateOAuth
   • OAuthSettingsLocation

Manual refresh of the OAuth access token:

The only value needed to manually refresh the OAuth access token is the OAuth refresh token.

1. To manually refresh the OAuthAccessToken after the ExpiresIn period (returned by GetOAuthAccessToken) has elapsed, call the RefreshOAuthAccessToken stored procedure.
2. Set these connection properties:
   • OAuthClientId: The Client Id in your custom OAuth application settings.
   • OAuthClientSecret: The Client Secret in your custom OAuth application settings.

3. Call RefreshOAuthAccessToken with OAuthRefreshToken set to the OAuth refresh token returned by GetOAuthAccessToken.
4. After the new tokens have been retrieved, set the OAuthAccessToken property to the value returned by RefreshOAuthAccessToken. This opens a new connection.

Store the OAuth refresh token so that you can use it to manually refresh the OAuth access token after it has expired.

Azure AD

Azure AD supports a form of OAuth that goes through Azure. Set the AuthScheme to AzureAD.

The CData Cloud automatically takes care of known Azure URLs internally, so it is not necessary to specify any of the usual OAuth connection properties, such as OAuthAccessTokenURL, OAuthAuthorizationURL,OAuthRefreshTokenURL, and OAuthRequestTokenURL.

Other connection properties may be required for this connection method including:

• Scope: Must be specified if InitiateOAuth is set to GETANDREFRESH as the Scope is submitted to Microsoft during retrieval of credentials. This varies depending on the service, but is generally a combination of the resource (hostname in the URL) and permission name. For example: https://host/user_impersonation.
• AzureADResource: The specific Azure Resource to authenticate against during Microsoft login. If none is specified, your user account's default resource is used.
• AzureADTenant: The specific Azure Tenant to authenticate against during Microsoft login. If none is specified, your user account's default tenant via the common login endpoint is used. This may not be correct depending on the specific resource you are connecting to, or if the resource is stored on a seperate tenant.

Otherwise, the steps to authenticate are identical to the descriptions of Desktop, Web, and Headless Machine authentication.

For information about how to create a custom OAuth application for use with Azure AD, see Creating a Custom OAuth Application.

Securing OData Connections

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.

Kerberos

To authenticate to OData with Kerberos, set AuthScheme to NEGOTIATE.

Authenticating to OData via Kerberos requires you to define authentication properties and to choose how Kerberos should retrieve authentication tickets.

Retrieve Kerberos Tickets

Kerberos tickets are used to authenticate the requester's identity. The use of tickets instead of formal logins/passwords eliminates the need to store passwords locally or send them over a network. Users are reauthenticated (tickets are refreshed) whenever they log in at their local computer or enter kinit USER at the command prompt.

The Cloud provides three ways to retrieve the required Kerberos ticket, depending on whether or not the KRB5CCNAME and/or KerberosKeytabFile variables exist in your environment.

MIT Kerberos Credential Cache File

This option enables you to use the MIT Kerberos Ticket Manager or kinit command to get tickets. With this option there is no need to set the User or Password connection properties.

This option requires that KRB5CCNAME has been created in your system.

To enable ticket retrieval via MIT Kerberos Credential Cache Files:

1. Ensure that the KRB5CCNAME variable is present in your environment.
2. Set KRB5CCNAME to a path that points to your credential cache file. (For example, C:\krb_cache\krb5cc_0 or /tmp/krb5cc_0.) The credential cache file is created when you use the MIT Kerberos Ticket Manager to generate your ticket.
3. To obtain a ticket:
   1. Open the MIT Kerberos Ticket Manager application.
   2. Click Get Ticket.
   3. Enter your principal name and password.
   4. Click OK.

   If the ticket is successfully obtained, the ticket information appears in Kerberos Ticket Manager and is stored in the credential cache file.

The Cloud uses the cache file to obtain the Kerberos ticket to connect to OData.

Note: If you would prefer not to edit KRB5CCNAME, you can use the KerberosTicketCache property to set the file path manually. After this is set, the Cloud uses the specified cache file to obtain the Kerberos ticket to connect to OData.

Keytab File

If your environment lacks the KRB5CCNAME environment variable, you can retrieve a Kerberos ticket using a Keytab File.

To use this method, set the User property to the desired username, and set the KerberosKeytabFile property to a file path pointing to the keytab file associated with the user.

User and Password

If your environment lacks the KRB5CCNAME environment variable and the KerberosKeytabFile property has not been set, you can retrieve a ticket using a user and password combination.

To use this method, set the User and Password properties to the user/password combination that you use to authenticate with OData.

Enabling Cross-Realm Authentication

More complex Kerberos environments can require cross-realm authentication where multiple realms and KDC servers are used. For example, they might use one realm/KDC for user authentication, and another realm/KDC for obtaining the service ticket.

To enable this kind of cross-realm authentication, set the KerberosRealm and KerberosKDC properties to the values required for user authentication. Also, set the KerberosServiceRealm and KerberosServiceKDC properties to the values required to obtain the service ticket.

Customizing API Requests

The following properties provide the granular control useful for integrating with nonstandard APIs or to access more advanced OData functionality.

• CustomURLParams: Set this to append query string parameters onto the request that the Cloud builds.

• ContinueOnError: The Cloud builds batch requests to OData 4.0 services when batch APIs in the underlying driver interface are invoked; for example, when your application makes a batch request.

  When this property is set, errors are returned in a temporary table to avoid breaking execution.

• UseEtags: Etags can be used by OData clients to check if a resource has changed on the server and avoid concurrency problems.
  If you do not need to surface this functionality or if your OData service does not return Etags, set this property to false.
• Cookies: If you need to provide cookies obtained outside the Cloud, you can set them in this value.
• CustomHeaders: You can use this property to add any value to any HTTP request header.

Fine Tuning Data Access

Set the following properties to control how the Cloud models OData APIs as a database:

• NavigationPropertiesAsViews: By default, the Cloud models navigation properties as views.
  This enables access to related entities, even though these entities may not be linked by a foreign key in your OData service.
• SupportsExpand: If your API does not support the $expand parameter, set this property to avoid an error when NavigationPropertiesAsViews is set.
  If this is the case for your API, specify the base entity's primary key in the WHERE clause to access navigation properties.
• DataFormat: Set this property to JSON or XML. Otherwise, the Cloud uses the default format defined by the service.
• ODataVersion: Use this to override the version detected by the Cloud. This is useful if your application supports an older OData version.
• UseSimpleNames: Set this to true to return only alphanumeric characters in column names. This can help you to avoid SQL escapes and errors in SQL-based tools.
• ServerTimeZone: By default, the Cloud assumes the server's Edm.DateTime values are GMT and converts them to and from the installed machine's local timezone accordingly.
  If the server's Edm.DateTime values are known to apply to a different timezone, then set this property to that timezone (i.e. EST).

Customizing the SSL Configuration

To enable TLS, set the following:

• URL: Prefix the connection string with https://

With this configuration, 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.

Client SSL Certificates

The OData Cloud also supports setting client certificates. Set the following to connect using a client certificate.

• SSLClientCert: The name of the certificate store for the client certificate.
• SSLClientCertType: The type of key store containing the TLS/SSL client certificate.
• SSLClientCertPassword: The password for the TLS/SSL client certificate.
• SSLClientCertSubject: The subject of the TLS/SSL client certificate.

Connecting Through a Firewall or Proxy

HTTP Proxies

To authenticate to an HTTP proxy, set the following:

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

Other Proxies

Set the following properties:

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

The CData Cloud models OData 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 entity sets and singletons described in the service metadata document as bidirectional Tables.

Views

Some OData entities can only be accessed through Navigation Properties. By default, the Cloud models navigation properties as separate views. You can disable this behavior with NavigationPropertiesAsViews. See Views for more information on querying navigation properties.

Stored Procedures

Stored Procedures are function-like interfaces to the data source. They can be used to search, update, and modify information in the data source.

The Cloud exposes tables for every entity set and singleton defined on the OData service document. Entities on these tables may be inserted, updated, or deleted using standard SQL insert, update, or delete statements.

Executing Deep Inserts with SQL

The Cloud supports OData deep inserts, in which you simultaneously create a base entity and link it to related entities, by specifying navigation properties. To specify Navigation Properties for an entity, you may either submit JSON / XML data, or you may create a temporary table for the navigation property and then reference the temporary table in the insert to the base table. Sumit the XML / JSON or reference the temporary table in the appropriate navigation property column on the base table. Each navigation property column is prefixed with the word "Linked".

Example: Deep Inserts using XML / JSON

To submit XML or JSON data, simply supply the values for the table the navigation property is referencing in XML or JSON format. If you are familiar with the OData standard, you should not be submitting values in the standard. The XML / JSON used here is simply a means of supplying multiple values ot the CData Cloud.

For example, consider the Orders table in Northwind odata.org test service. To create a new Order, you specify the Products ordered, Customer, Employee, and Shipper. To do so, you need to specify the Customer, Order_Details, Shipper, and Employee navigation properties.

• Customer: The following XML represents a new Customer:
  

    <Row>
      <CustomerID>VINET</CustomerID>
  	<CompanyName>Vins et alcools Chevalier</CompanyName>
  	<ContactName>Paul Henriot</ContactName>
  	<ContactTitle>Accounting Manager</ContactTitle>
  	<Address>59 rue de l'Abbaye</Address>
  	<City>Reims</City>
  	<PostalCode>51100</PostalCode>
  	<Country>France</Country>
  	<Phone>26.47.15.10</Phone>
  	<Fax>26.47.15.11</Fax>
    </Row>

• Order_Details: The following JSON add two Products to the Order:
  

    [
      {
  	  "ProductID": 72,
  	  "UnitPrice": 34.80,
  	  "Quantity": 5,
  	  "Discount": 0
  	},
  	{
  	  "ProductID": 42,
  	  "ProductID": 9.80,
  	  "ProductID": 10,
  	  "ProductID": 0
  	}
    ]

• Employee: The following XML specifies the existing Employee:
  

    <Row>
      <EmployeeID>5</EmployeeID>
    </Row>

• Shipper: The following JSON specifies the existing Shipper:
  

    [
      {
        "ShipperID": 3
      }
    ]

In order to execute the insert, simply reference or include as string literals the complete XML / JSON. For example:

INSERT INTO Orders (CustomerID, EmployeeID, ShipVia, ShipName, ShipAddress, ShipCity, ShipPostalCode, ShipCountry, OrderDate, LinkedOrder_Details, LinkedCustomer, LinkedEmployee, LinkedShipper) VALUES ('VINET', 5, 3, 'Paul Henriot', '59 rue de l''Abbaye', 'Reims', '51100', 'France', '07/04/1996', '{ ... }', '<Row>...</Row>', ?, ?)

Example: Deep Inserts using Temporary Tables

If using temporary tables, they must be defined and inserted within the same connection. Closing the connection will clear out any temporary tables in memory. Keeping with the Northwind example, you need to specify the following navigation properties.

Creating Temporary Tables

Insert the related entities into temporary tables that correspond to each navigation property. You can specify an existing entity's primary key or you can insert a new entity.

• Customer: The following statement creates a new Customer:
  

  INSERT INTO Customers#TEMP (CustomerID, CompanyName, ContactName, ContactTitle, Address, City, PostalCode, Country, Phone, Fax) 
  VALUES ('VINET', 'Vins et alcools Chevalier', 'Paul Henriot', 'Accounting Manager', '59 rue de l''Abbaye', 'Reims', '51100', 'France', '26.47.15.10', '26.47.15.11')

• Order Details: The following statements add two Products to the Order:
  

  INSERT INTO Order_Details#TEMP (ProductID, UnitPrice, Quantity, Discount) VALUES (72, 34.80, 5, 0)
  
  INSERT INTO Order_Details#TEMP (ProductID, UnitPrice, Quantity, Discount) VALUES (42, 9.80, 10, 0)

• Employee: The following statement specifies the existing Employee:
  

  INSERT INTO Employees#TEMP (EmployeeID) 
  VALUES (5)

• Shipper: The following statement specifies the existing Shipper:
  

  INSERT INTO Shippers#TEMP (ShipperID) VALUES (3) 

The CData Cloud will assume that the Shipper and Employee already exist and will only link to the existing references since only the primary keys were specified for either. When more than just the primary key is defined, such as the examples for Customer and Order_Details, the CData Cloud will attempt to create new entries - triggering the deep insert.

Inserting the Entity

In the INSERT statement for the base entity, reference the temporary tables in the LinkedOrder_Details, LinkedCustomer, LinkedEmployee, and LinkedShipper columns:

INSERT INTO Orders (CustomerID, EmployeeID, ShipVia, ShipName, ShipAddress, ShipCity, ShipPostalCode, ShipCountry, OrderDate, LinkedOrder_Details, LinkedCustomer, LinkedEmployee, LinkedShipper) VALUES ('VINET', 5, 3, 'Paul Henriot', '59 rue de l''Abbaye', 'Reims', '51100', 'France', '07/04/1996', 'Order_Details#TEMP', 'Customers#TEMP', 'Employees#TEMP', 'Shippers#TEMP')

Modeling Navigation Properties

By default, the Cloud models Navigation Properties as separate views. The views are named in the format ParentTable_NavigationProperty. You can disable this behavior with NavigationPropertiesAsViews.

Querying Navigation Properties

For an example of working with a navigation property as a view, consider the Northwind sample service from odata.org. In this service, the Categories entity set has a Products navigation property. The CData Cloud will display a view called Categories_Products for this service. Retrieving data from Categories_Products will display all of the Products associated with a given Category. The Categories_Products view has a primary key made up of the Id of the parent entity and the Id of the related entity.

Support for navigation properties is limited in some OData services. See NavigationPropertiesAsViews and SupportsExpand for more information on API restrictions when querying navigation properties.

In OData, a navigation property is a property on an entity that is itself either a single entity or list of entities.

A single-entity navigation property signifies a one-to-one relationship; for example, an OData service might allow a Product to have only one Category. In this service, Category might be a navigation property on Products.

An entity set navigation property signifies a one-to-many relationship; for example, many Products can belong in the same Category. In this service, Products might be a navigation property on Categories.

Working with Navigation Properties Relationally

Navigation properties in OData link related entities. Similarly, in a relational database, a foreign key serves to link tables. For example, a Product record might have a CategoryId column, which uniquely identifies what Category the Product belongs to. However, there is no requirement in OData that an entity must contain a foreign key reference to a related entity. This means sometimes you will get navigation properties without having a foreign key reference to that entity on the parent or back to the parent from the related entity. In cases without a foreign key reference, the navigation property's existence is the only thing that can be used to identify a relationship between the two entities.

Select

NavigationPropertiesAsViews is useful for accessing data in OData services that lack foreign key references. Likewise, it can be used to retrieve related entites that do not exist by themselves such as LineItems on an Invoice. See Views for more information on querying navigation properties.

INSERT

The Cloud supports OData deep inserts. See Tables for more information on specifying navigation properties when you create an entity.

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

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

CData Cloud - OData Stored Procedures

Name	Description
CreateAssociation	Creates an association between two entities based on a navigation property.
GetSAPCSRFToken	Returns a CSRF token and cookie for authentication to SAP.
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.
RequestRawValue	Request the raw value of a property by providing the full path to the resource.

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

Input

Name	Type	Description
FromId	String	The Id of the entity you are creating an associations for.
UrlId	String	An alternative to specifying the FromId. This is the complete url to the resource for which the association is being created. It is required to be specified in the case that the navigation property is an abstract, or to specify more specific child types where the navigation property entity type is used as a basetype.
FromTable	String	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	The navigation property you are creating an association on. It can be obtained from ListNavigationProperties.
ToId	String	The id of the navigation entity. This will come from the table associated with the navigation property.
ToUrlId	String	An alternative to specifying the ToId. This is the complete url to the resource to be associated. It is required to be specified in the case that the navigation property is an abstract, or to specify more specific child types where the navigation property entity type is used as a basetype.
HttpMethod	String	An override for the http method to use when creating the association in case the OData source being used does not follow the specifications.

Result Set Columns

Name	Type	Description
Success	Boolean	This value shows a boolean indication of whether the operation was successful or not.

Returns a CSRF token and cookie for authentication to SAP.

Input

Name	Type	Description
URL	String	The base URL of the SAP OData service.
TokenHeader	String	The name of the HTTP header for the SAP CSRF token. The default value is x-csrf-token.

Result Set Columns

Name	Type	Description
Success	String	Whether or not the request was successful.
CSRFToken	String	The Cross-Site Request Forgery token to be set in the header for subsequent requests.
Cookie	String	The SAP cookie to be set in the header for subsequent requests.

Lists associations for a given table and navigation property.

Input

Name	Type	Description
FromId	String	The Id of the entity you are listing associations for.
UrlId	String	An alternative to specifying the FromId. This is the complete url to the resource you are listing the associations for. It is required to be specified in the case that the navigation property is an abstract, or to specify more specific child types where the navigation property entity type is used as a basetype.
FromTable	String	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	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	Description
TableName	String	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	Description
FromId	String	The Id of the entity you are removing an associations for.
UrlId	String	An alternative to specifying the FromId. This is the complete url to the resource you are removing an associations for. It is required to be specified in the case that the navigation property is an abstract, or to specify more specific child types where the navigation property entity type is used as a basetype.
FromTable	String	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	The navigation property you are removing an association on. It can be obtained from ListNavigationProperties.
ToId	String	The id of the navigation entity. This will come from the table associated with the navigation property.
ToUrlId	String	An alternative to specifying the ToId. This is the complete url to the resource to be associated. It is required to be specified in the case that the navigation property is an abstract, or to specify more specific child types where the navigation property entity type is used as a basetype.

Result Set Columns

Name	Type	Description
Success	Boolean	This value shows a boolean indication of whether the operation was successful or not.

Request the raw value of a property by providing the full path to the resource.

Input

Name	Type	Description
MediaReadLink	String	The url to the resource. This can be the full url to a stream resource or to a primitive property
FileName	String	The name of the file where the data from the stream will be written to. EX: C:\\Users\\Public\\document.pdf

Result Set Columns

Name	Type	Description
FileData	String	If neither FileName or FileStream are provided, the content will be displayed here as Base64Encoded
Success	String	Whether the procedure was successful or not

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 OData:

• 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 Lead table:

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

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

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 ListNavigationProperties stored procedure:

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'ListNavigationProperties' 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 = 'ListNavigationProperties' AND IncludeResultColumns='True'

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

Pseudo-Columns

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 Lead table:

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

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.

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.

Describes the available system information.

The following query retrieves all columns:

SELECT * FROM sys_information

Columns

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

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.

OData V2	OData V3	OData V4	CData Schema
Edm.Binary	Edm.Binary	Edm.Binary	binary
Edm.Boolean	Edm.Boolean	Edm.Boolean	bool
Edm.DateTime	Edm.DateTime	Edm.DateTimeOffset	datetime
Edm.Decimal	Edm.Decimal	Edm.Decimal	decimal
Edm.Double	Edm.Double	Edm.Double	double
Edm.Guid	Edm.Guid	Edm.Guid	guid
Edm.Int16	Edm.Int16	Edm.Int16	int
Edm.Int32	Edm.Int32	Edm.Int32	int
Edm.Int64	Edm.Int64	Edm.Int64	bigint
Edm.String	Edm.String	Edm.String	string
Edm.Time	Edm.Time	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
URL	Specifies the root URL of the OData service, also called the service root URL. For example, http://services.odata.org/V4/Northwind/Northwind.svc.
AuthScheme	Specifies the authentication scheme to use for connecting to OData.
User	Specifies the authenticating user's user ID.
Password	Specifies the authenticating user's password.
FeedURL	URL to the OData entity set. For example, http://MySite/MyOrganization/EntitySet.
SharePointUseSSO	Specifies whether to use single sign-on (SSO) to authenticate to SharePoint Online.

Azure Authentication

---

Property	Description
AzureADTenant	Specifies the Azure Active Directory tenant to authenticate against. Used only with Azure AD OAuth authentication.
AzureTenant	Identifies the OData tenant being used to access data. Accepts either the tenant's domain name (for example, contoso.onmicrosoft.com ) or its directory (tenant) ID.
AzureResource	The Azure Active resource to authenticate to (used during Azure OAuth exchange).

SSO

---

Property	Description
SharePointSSODomain	Specifies the user domain for SSO in OData when it differs from the domain configured in the SSO service.

OAuth

---

Property	Description
OAuthClientId	Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
OAuthClientSecret	Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).
OAuthAccessToken	Specifies the OAuth access token used to authenticate requests to the data source. This token is issued by the authorization server after a successful OAuth exchange.
OAuthAccessTokenSecret	The OAuth access token secret for connecting using OAuth.
OAuthPasswordGrantMode	Specifies how the OAuth Client ID and Client Secret are sent to the authorization server.
OAuthAuthorizationURL	The authorization URL for the OAuth service.
OAuthAccessTokenURL	The URL from which the OAuth access token is retrieved.
OAuthRefreshTokenURL	The URL to refresh the OAuth token from.
AuthToken	The authentication token used to request and obtain the OAuth Access Token.
AuthKey	The authentication secret used to request and obtain the OAuth Access Token.
OAuthParams	A comma-separated list of other parameters to submit in the request for the OAuth access token in the format paramname=value.

SSL

---

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

Logging

---

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.

Schema

---

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

Miscellaneous

---

Property	Description
AllowNavigationDisassociation	Specifies whether the provider binds navigation properties to null values.
ContinueOnError	Specifies whether batch requests should continue after encountering an error. (OData 4.0 and higher only.).
Cookies	This property can be manually specified in the format of name=value pairs, which are separated by semicolons.
CustomHeaders	Specifies additional HTTP headers to append to the request headers created from other properties, such as ContentType and From. Use this property to customize requests for specialized or nonstandard APIs.
CustomURLParams	A string of custom URL parameters to be included with the HTTP request, in the form field1=value1&field2=value2&field3=value3.
DataFormat	Specifies the formatting of data when interacting with an OData service. The two formats supported are ATOM and JSON.
DecodeXMLNames	Specifies whether to decode column names containing Unicode characters.
EnableAtomicBatchOperations	This property indicates that all Create, Update, and Delete (CUD) requests in a batch are handled as a single action. The success of the entire batch depends on the outcome of all requests. If any single request fails, the whole batch fails and no changes are applied.
ExcludeControlInformationRootType	Indicates whether OData should use the odata.type control information for the root element.
ExpandAsterisk	The OData service should return everything if the $select query parameter is not specified by default. In certain cases, this functionality can be set to true, allowing retrieval of every column from the specified dataset. This applies specifically to SQL queries.
IncludeNavigationParentColumns	Specifies whether the columns that serve as parent navigational elements should be incorporated within the navigation views.
IncludeReferenceColumn	Adds an input-only ParentReference column designed for bulk INSERT operations, ensuring that child records are correctly linked to their respective parents during a deep INSERT process.
MaxFilterLength	Specifies the maximum number of characters permitted in the $filter query parameter of a OData request.
MaxRows	Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
MaxSelectLength	This property limits the number of characters allowed in the $select query option. If the length of the generated $select parameter exceeds the values specified, the column selection is instead processed client-side. Setting this property to 0 prevents the provider from submitting the $select parameter to the service, which is useful for services that do not support it.
NavigationPropertiesAsViews	A boolean indicating navigation properties should be promoted to full views.
ODataVersion	The version of OData that should be utilized. By default, the provider is designed to automatically detect and adapt to the appropriate version, ensuring seamless integration and functionality.
Pagesize	Specifies the maximum number of records per page the provider returns when requesting data from OData.
PseudoColumns	Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
ServerTimeZone	The timezone for representing or interpreting the server's Edm.DateTime values. The value of this property affects how Edm.DateTime filters and results are converted between the server and the client.
StoredProceduresAsViews	A boolean value indicating whether stored procedures returning collections of entities should be treated as views.
SupportsExpand	Determines whether navigation properties can be retrieved from the base entity set, which is more accurate. If this property is false, it prevents the provider from retrieving navigation properties.
SupportsFilter	Specifies whether the OData service supports the $filter query parameter.
SupportsFormulas	A boolean indicating if the odata service supports server side formulas.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
UseClientSidePaging	Specifies whether or not OData should return data using client-side paging, if your source supports it. To use client-side paging, set this to True. To use server-side paging, set this to False.
UseEtags	The purpose of this property is to optionally hide the Etag column if the service does not return a value for it. Otherwise, it will be included but remain empty.
UseSimpleNames	Specifies whether or not simple names should be used for tables and columns.

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

---

Property	Description
URL	Specifies the root URL of the OData service, also called the service root URL. For example, http://services.odata.org/V4/Northwind/Northwind.svc.
AuthScheme	Specifies the authentication scheme to use for connecting to OData.
User	Specifies the authenticating user's user ID.
Password	Specifies the authenticating user's password.
FeedURL	URL to the OData entity set. For example, http://MySite/MyOrganization/EntitySet.
SharePointUseSSO	Specifies whether to use single sign-on (SSO) to authenticate to SharePoint Online.

Specifies the root URL of the OData service, also called the service root URL. For example, http://services.odata.org/V4/Northwind/Northwind.svc.

Data Type

string

Default Value

""

Remarks

The service root is the base portion of a URL before the resource path and any query options.

For example, in the URL: http://host:port/path/SampleService.svc/Categories(1)/Products?$top=2$orderby=Name

• The service root URL is http://host:port/path/SampleService.svc/.
• The resource path is Categories(1)/Products?.
• The query options are $top=2$orderby=Name.

Specifies the authentication scheme to use for connecting to OData.

Possible Values

None, AzureAD, Basic, OAuth, OAuthPassword, OAuthClient, SharePointOnline

Data Type

string

Default Value

"None"

Remarks

• None: No authentication for this service.
• AzureAD: Set this to perform Azure Active Directory OAuth authentication.
• Basic: Set this to use HTTP Basic authentication.
• Digest: Set this to use HTTP Digest authentication.
• Negotiate: If AuthScheme is set to NEGOTIATE, the Cloud negotiates an authentication mechanism with the server. Set AuthScheme to NEGOTIATE if you want to use Kerberos authentication.
• NTLM: Set this to use your Windows credentials for authentication.
• OAuth: Set this to establish an OAuth connection.
• OAuthPassword: Set this to establish an OAuth connection with the password grant type.
• OAuthClient: Set this to establish an OAuth connection with the client grant type.
• SharePointOnline: Set this to use SharePoint Online authentication.

Specifies the authenticating user's user ID.

Data Type

string

Default Value

""

Remarks

The authenticating server requires both User and Password to validate the user's identity.

Specifies the authenticating user's password.

Data Type

string

Default Value

""

Remarks

The authenticating server requires both User and Password to validate the user's identity.

URL to the OData entity set. For example, http://MySite/MyOrganization/EntitySet.

Data Type

string

Default Value

""

Remarks

URL to the OData entity set. For example, http://MySite/MyOrganization/EntitySet. You can use this property when the OData service does not have a root document.

Specifies whether to use single sign-on (SSO) to authenticate to SharePoint Online.

Data Type

bool

Default Value

false

Remarks

When set to true, the Cloud uses single sign-on (SSO) to authenticate to SharePoint Online with the account specified by User and Password. AD FS, OneLogin, and OKTA identity providers are supported.

When set to false, SSO is not used, and authentication relies on the method configured for the connection.

SharePointSSODomain may be required if the SSO domain differs from the User domain.

SSO is only supported for SharePoint Online when AuthScheme is set to SHAREPOINTONLINE. It is not available for OAuth connections to SharePoint.

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

---

Property	Description
AzureADTenant	Specifies the Azure Active Directory tenant to authenticate against. Used only with Azure AD OAuth authentication.
AzureTenant	Identifies the OData tenant being used to access data. Accepts either the tenant's domain name (for example, contoso.onmicrosoft.com ) or its directory (tenant) ID.
AzureResource	The Azure Active resource to authenticate to (used during Azure OAuth exchange).

Specifies the Azure Active Directory tenant to authenticate against. Used only with Azure AD OAuth authentication.

Data Type

string

Default Value

""

Remarks

This property is required when using Azure Active Directory OAuth authentication.

The tenant determines who can sign in to the application. Set this property to one of the following:

• The tenant name, such as contoso.onmicrosoft.com
• The tenant ID, such as 8eaef023-2b34-4da1-9baa-8bc8c9d6a490
• The word common to allow users from any Azure AD tenant

You can find your tenant name and ID in the Azure portal under Entra ID > Overview.

Use this property to ensure the OAuth token is issued for the intended tenant when authenticating to the OData.

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

Data Type

string

Default Value

""

Remarks

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

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

This property is required in the following cases:

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

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

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

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

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

The Azure Active resource to authenticate to (used during Azure OAuth exchange).

Data Type

string

Default Value

""

Remarks

The resource must be specified if using Azure OAuth. It should be set to the App Id URI of the web API (secured resource).

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

---

Property	Description
SharePointSSODomain	Specifies the user domain for SSO in OData when it differs from the domain configured in the SSO service.

Specifies the user domain for SSO in OData when it differs from the domain configured in the SSO service.

Data Type

string

Default Value

""

Remarks

When SharePointUseSSO is set to true, set this property if the domain of the User (for example, [email protected]) is different from the domain configured within the SSO service (for example, [email protected]).

When set, the Cloud uses this domain for authentication instead of the User domain. When not set, the Cloud uses the User domain by default.

This property may be required for AD FS, OneLogin, or OKTA SSO services.

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.).
OAuthAccessToken	Specifies the OAuth access token used to authenticate requests to the data source. This token is issued by the authorization server after a successful OAuth exchange.
OAuthAccessTokenSecret	The OAuth access token secret for connecting using OAuth.
OAuthPasswordGrantMode	Specifies how the OAuth Client ID and Client Secret are sent to the authorization server.
OAuthAuthorizationURL	The authorization URL for the OAuth service.
OAuthAccessTokenURL	The URL from which the OAuth access token is retrieved.
OAuthRefreshTokenURL	The URL to refresh the OAuth token from.
AuthToken	The authentication token used to request and obtain the OAuth Access Token.
AuthKey	The authentication secret used to request and obtain the OAuth Access Token.
OAuthParams	A comma-separated list of other parameters to submit in the request for the OAuth access token in the format paramname=value.

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.

Data Type

string

Default Value

""

Remarks

This property is required in two cases:

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

(When the driver provides embedded OAuth credentials, this value may already be provided by the 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.).

Data Type

string

Default Value

""

Remarks

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

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

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

Notes:

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

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

Specifies the OAuth access token used to authenticate requests to the data source. This token is issued by the authorization server after a successful OAuth exchange.

Data Type

string

Default Value

""

Remarks

OAuthAccessToken is a temporary credential that authorizes access to protected resources. It is typically returned by the identity provider after the user or client application completes an OAuth authentication flow. This property is most commonly used in automated workflows or custom OAuth implementations where you want to manage token handling outside of the driver.

The OAuth access token has a server-dependent timeout, limiting user access. The timeout is set using the OAuthExpiresIn property. However, it can be reissued between requests to keep access alive as long as the user keeps working.

If InitiateOAuth is set to REFRESH, we recommend that you also set both OAuthExpiresIn and OAuthTokenTimestamp. The Cloud uses these properties to determine when the token expires so it can refresh most efficiently. If OAuthExpiresIn and OAuthTokenTimestamp are not specified, the Cloud refreshes the token immediately.

Note: Access tokens should be treated as sensitive credentials and stored securely. Avoid exposing them in logs, scripts, or configuration files that are not access-controlled.

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

The OAuth access token secret for connecting using OAuth.

Data Type

string

Default Value

""

Remarks

The OAuthAccessTokenSecret property is used to connect and authenticate using OAuth. The OAuthAccessTokenSecret is retrieved from the OAuth server as part of the authentication process. It is used with the OAuthAccessToken and can be used for multiple requests until it times out.

Specifies how the OAuth Client ID and Client Secret are sent to the authorization server.

Possible Values

Post, Basic

Data Type

string

Default Value

"Post"

Remarks

The OAuth RFC provides two methods of passing the OAuthClientId and OAuthClientSecret:

• POST: Sends the OAuthClientId and OAuthClientSecret in the POST body of the token request. This is the most commonly supported method and works with most OAuth flows.
• BASIC: Sends the OAuthClientId and OAuthClientSecret in the HTTP Authorization header using Basic authentication. Some OAuth servers require this method for added compliance or security.

The authorization URL for the OAuth service.

Data Type

string

Default Value

""

Remarks

The authorization URL for the OAuth service. At this URL, the user logs into the server and grants permissions to the application. In OAuth 1.0, if permissions are granted, the request token is authorized.

The URL from which the OAuth access token is retrieved.

Data Type

string

Default Value

""

Remarks

In OAuth 1.0, the authorized request token is exchanged for the access token at this URL.

The URL to refresh the OAuth token from.

Data Type

string

Default Value

""

Remarks

The URL to refresh the OAuth token from. In OAuth 2.0, this URL is where the refresh token is exchanged for a new access token when the old access token expires.

The authentication token used to request and obtain the OAuth Access Token.

Data Type

string

Default Value

""

Remarks

This property is required only when performing headless authentication in OAuth 1.0. It can be obtained from the GetOAuthAuthorizationUrl stored procedure.

It can be supplied alongside the AuthKey in the GetOAuthAccessToken stored procedure to obtain the OAuthAccessToken.

The authentication secret used to request and obtain the OAuth Access Token.

Data Type

string

Default Value

""

Remarks

This property is required only when performing headless authentication in OAuth 1.0. It can be obtained from the GetOAuthAuthorizationUrl stored procedure.

It can be supplied alongside the AuthToken in the GetOAuthAccessToken stored procedure to obtain the OAuthAccessToken.

A comma-separated list of other parameters to submit in the request for the OAuth access token in the format paramname=value.

Data Type

string

Default Value

""

Remarks

A comma-separated list of other parameters to submit in the request for the OAuth access token in the format paramname=value.

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.

Data Type

string

Default Value

""

Remarks

If you are using a TLS/SSL connection, use this property to specify the TLS/SSL certificate to be accepted from the server. If you specify a value for this property, all other certificates that are not trusted by the machine are rejected.

This property can take the following forms:

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

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

This section provides a complete list of the 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.

Data Type

string

Default Value

"1"

Remarks

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 .

Data Type

string

Default Value

""

Remarks

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

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

---

Property	Description
AllowNavigationDisassociation	Specifies whether the provider binds navigation properties to null values.
ContinueOnError	Specifies whether batch requests should continue after encountering an error. (OData 4.0 and higher only.).
Cookies	This property can be manually specified in the format of name=value pairs, which are separated by semicolons.
CustomHeaders	Specifies additional HTTP headers to append to the request headers created from other properties, such as ContentType and From. Use this property to customize requests for specialized or nonstandard APIs.
CustomURLParams	A string of custom URL parameters to be included with the HTTP request, in the form field1=value1&field2=value2&field3=value3.
DataFormat	Specifies the formatting of data when interacting with an OData service. The two formats supported are ATOM and JSON.
DecodeXMLNames	Specifies whether to decode column names containing Unicode characters.
EnableAtomicBatchOperations	This property indicates that all Create, Update, and Delete (CUD) requests in a batch are handled as a single action. The success of the entire batch depends on the outcome of all requests. If any single request fails, the whole batch fails and no changes are applied.
ExcludeControlInformationRootType	Indicates whether OData should use the odata.type control information for the root element.
ExpandAsterisk	The OData service should return everything if the $select query parameter is not specified by default. In certain cases, this functionality can be set to true, allowing retrieval of every column from the specified dataset. This applies specifically to SQL queries.
IncludeNavigationParentColumns	Specifies whether the columns that serve as parent navigational elements should be incorporated within the navigation views.
IncludeReferenceColumn	Adds an input-only ParentReference column designed for bulk INSERT operations, ensuring that child records are correctly linked to their respective parents during a deep INSERT process.
MaxFilterLength	Specifies the maximum number of characters permitted in the $filter query parameter of a OData request.
MaxRows	Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
MaxSelectLength	This property limits the number of characters allowed in the $select query option. If the length of the generated $select parameter exceeds the values specified, the column selection is instead processed client-side. Setting this property to 0 prevents the provider from submitting the $select parameter to the service, which is useful for services that do not support it.
NavigationPropertiesAsViews	A boolean indicating navigation properties should be promoted to full views.
ODataVersion	The version of OData that should be utilized. By default, the provider is designed to automatically detect and adapt to the appropriate version, ensuring seamless integration and functionality.
Pagesize	Specifies the maximum number of records per page the provider returns when requesting data from OData.
PseudoColumns	Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
ServerTimeZone	The timezone for representing or interpreting the server's Edm.DateTime values. The value of this property affects how Edm.DateTime filters and results are converted between the server and the client.
StoredProceduresAsViews	A boolean value indicating whether stored procedures returning collections of entities should be treated as views.
SupportsExpand	Determines whether navigation properties can be retrieved from the base entity set, which is more accurate. If this property is false, it prevents the provider from retrieving navigation properties.
SupportsFilter	Specifies whether the OData service supports the $filter query parameter.
SupportsFormulas	A boolean indicating if the odata service supports server side formulas.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
UseClientSidePaging	Specifies whether or not OData should return data using client-side paging, if your source supports it. To use client-side paging, set this to True. To use server-side paging, set this to False.
UseEtags	The purpose of this property is to optionally hide the Etag column if the service does not return a value for it. Otherwise, it will be included but remain empty.
UseSimpleNames	Specifies whether or not simple names should be used for tables and columns.

Specifies whether the provider binds navigation properties to null values.

Data Type

bool

Default Value

false

Remarks

In OData, navigation properties represent relationships between entities. Disassociating a navigation property removes the relationship, and some services support doing this by binding the property to a null value.

When set to true, the Cloud binds navigation properties to null in INSERT or UPDATE requests when those properties are set to null and the OData supports null binding. This can be used to disassociate navigation properties.

When set to false, navigation properties set to null or an empty string are omitted from the request body.

This property is useful when you need to explicitly remove or disassociate related entities through null binding.

Specifies whether batch requests should continue after encountering an error. (OData 4.0 and higher only.).

Data Type

bool

Default Value

true

Remarks

When ContinueOnError is set to true and an error occurs in a batch, it will proceed to the next batch and provide status information for the failed one.

When ContinueOnError is false, the process will stop further batch processing if an error occurs. All changes made before the error will remain intact.

This property can be manually specified in the format of name=value pairs, which are separated by semicolons.

Data Type

string

Default Value

""

Remarks

Typically, the Cookies property does not need to be configured. However, since there are various types of OData services, manual specification of cookies may be required if the solution relies on cookies not obtained through the CData JDBC Cloud for OData. Cookies can be entered in the format of name=value pairs, separated by semicolons. For example: Cookie1=value; Cookie2=value2.

This property is useful for authentication, session tracking, and personalization purposes.

Specifies additional HTTP headers to append to the request headers created from other properties, such as ContentType and From. Use this property to customize requests for specialized or nonstandard APIs.

Data Type

string

Default Value

""

Remarks

Use this property to add custom headers to HTTP requests sent by the Cloud.

This property is useful when fine-tuning requests to interact with APIs that require additional or nonstandard headers. Headers must follow the format "header: value" as described in the HTTP specifications and each header line must be separated by the carriage return and line feed (CRLF) characters. Important: Use caution when setting this property. Supplying invalid headers may cause HTTP requests to fail.

A string of custom URL parameters to be included with the HTTP request, in the form field1=value1&field2=value2&field3=value3.

Data Type

string

Default Value

""

Remarks

This property enables you to specify custom query string parameters that are included with the HTTP request. The parameters must be encoded as a query string in the form field1=value1&field2=value2&field3=value3, where each value is URL encoded. URL encoding converts the characters in the string that can be transmitted over the internet as follows:

• Non-ASCII characters are replaced with their equivalent in the form of a "%" followed by two hexadecimal digits.
• Spaces are replaced with either a plus sign (+) or %20.

Specifies the formatting of data when interacting with an OData service. The two formats supported are ATOM and JSON.

Possible Values

AUTO, ATOM, JSON

Data Type

string

Default Value

"AUTO"

Remarks

The DataFormat defines the data format (either JSON or XML) for the request body in INSERT, UPDATE, or DELETE (if any) operations and the accepted response format for SELECT operations via the Accept header. It ensures that the driver correctly handles both request and response formats.

This property helps ensure compatibility with the client's preferred format.

Specifies whether to decode column names containing Unicode characters.

Data Type

bool

Default Value

false

Remarks

When set to true, the Cloud displays all Unicode characters in column names as human-readable characters.

When set to false, the Cloud displays all Unicode characters in column names in a hex-encoded format.

This property is useful when you prefer readable column names over encoded names, especially when working with metadata that contains non-ASCII characters.

This property indicates that all Create, Update, and Delete (CUD) requests in a batch are handled as a single action. The success of the entire batch depends on the outcome of all requests. If any single request fails, the whole batch fails and no changes are applied.

Data Type

bool

Default Value

true

Remarks

The behavior of the Cloud is dependent on both EnableAtomicBatchOperation and ContinueOnError. The ContinueOnError option is effective only when EnableAtomicBatchOperation is set to false.

When the EnableAtomicBatchOperations property is set to true, the Create, Update, and Delete (CUD) operations within a transaction are completed successfully as a single unit. If any part of the transaction fails, the entire transaction is aborted, and the database is left unchanged. Therefore, when atomic batch operations are enabled, ContinueOnError will be ignored.

ContinueOnError can be used in conjunction with EnableAtomicBatchOperations set to true. When EnableAtomicBatchOperations is set to true, the API will ensure that if any request in the batch fails, the entire batch will be rolled back.

Indicates whether OData should use the odata.type control information for the root element.

Data Type

bool

Default Value

false

Remarks

The OData specification requires that the root element in a POST or PATCH request include the control information annotation odata.type. However, some services do not accept this annotation. In these cases, you can set this property to true, which will omit the annotation from the request.

The ExcludeControlInformationRootType property is only applicable when the DataFormat property is set to JSON or when it is set to AUTO and a JSON format is detected.

This is an example of how this annotation appears on request post data:

{
  "@odata.type": "#NorthwindModel.Category",
  "CategoryName": "Electronics"
}

The OData service should return everything if the $select query parameter is not specified by default. In certain cases, this functionality can be set to true, allowing retrieval of every column from the specified dataset. This applies specifically to SQL queries.

Data Type

bool

Default Value

false

Remarks

When ExpandAsterisk is true, all columns reported as queryable from the service will be included in the $select query parameter.

For example:

SELECT * FROM Items

All columns will be listed in projection.

SELECT col1,col2, ... , coln FROM Items

This property helps you quickly retrieve object graphs and makes debugging easier. However, it can create large data loads and costly queries when there is a lot of deep nesting. For OData entities labeled as OpenType, the Returns columns are not defined in the metadata document and do not appear in the table definition.
Therefore, when the ExpandAsterisk property is set to true, these columns will not be automatically appended to the $Select query parameter unless they are explicitly requested.

Specifies whether the columns that serve as parent navigational elements should be incorporated within the navigation views.

Data Type

bool

Default Value

false

Remarks

When the IncludeNavigationParentColumns is set to true, the view's parent columns from the navigation property are displayed. Displaying these columns may be beneficial as it allows for filtering based on information from the parent.

When set to false, the primary keys of the parent will still be shown to enable joining back to the parent, but other columns will not be displayed.

Adds an input-only ParentReference column designed for bulk INSERT operations, ensuring that child records are correctly linked to their respective parents during a deep INSERT process.

Data Type

bool

Default Value

false

Remarks

IncludeReferenceColumn creates an input-only ParentReference column for bulk INSERTs, ensuring proper association of children during deep inserts with the same parent.

This property is useful for establishing relationships during bulk INSERT operations.

Specifies the maximum number of characters permitted in the $filter query parameter of a OData request.

Data Type

int

Default Value

-1

Remarks

Certain APIs impose restrictions on the number of characters that can be included in a URL. When the filter becomes too long, some services can return an error or become unresponsive. The purpose of this property is to process filters client-side if the filter parameter exceeds this value, thus avoiding errors or hangs.

If MaxFilterLength is set to a positive number, the driver will ensure we do not send a filter to the service that exceeds the character length set in MaxFilterLength. If exceeded, the filter will be processed entirely on the client side. This should only be changed if the services limit the character length; otherwise, it should remain unlimited by default.

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

Data Type

int

Default Value

-1

Remarks

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

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

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

This property limits the number of characters allowed in the $select query option. If the length of the generated $select parameter exceeds the values specified, the column selection is instead processed client-side. Setting this property to 0 prevents the provider from submitting the $select parameter to the service, which is useful for services that do not support it.

Data Type

int

Default Value

1000

Remarks

Some APIs require that the list of columns be specified in the $select query parameter. In these cases, it is recommended to use the ExpandAsterisk connection property.

If the MaxSelectLength is exceeded, we will try to default to $select=*. However, APIs that do not support this will trigger a validation error, so customers will need to manually limit the selection list. Depending on the OData version, using $select=* and omitting the $select parameter completely considered the same.

A boolean indicating navigation properties should be promoted to full views.

Data Type

bool

Default Value

false

Remarks

This property can be useful for OData services that can return related collections of entities, or navigation properties. Some OData entities can only be accessed through navigation properties. NavigationPropertiesAsViews will cause all of the discovered navigation properties to be added as views in the format ParentTable_NavigationProperty.

Retrieving Data from Limited OData APIs

In most cases, NavigationPropertiesAsViews can be left on and the resulting views can be accessed with any SELECT query. However, some OData APIs have limitations that require you to specify the primary key of the parent record when querying a navigation property.

For example:

SELECT * FROM Categories_Products WHERE Categories_CategoryId='1'

You will also need to set SupportsExpand to false. You can find more information on this API limitation in the documentation for the property.

The version of OData that should be utilized. By default, the provider is designed to automatically detect and adapt to the appropriate version, ensuring seamless integration and functionality.

Possible Values

AUTO, 2.0, 3.0, 4.0

Data Type

string

Default Value

"AUTO"

Remarks

When ODataVersion is set to Auto, the version will be detected automatically. In instances where the version cannot be determined, the Cloud will revert to using version 3.0 as a safe fallback. Additionally, there is the option to manually specify the desired version if needed.

Specifies the maximum number of records per page the provider returns when requesting data from OData.

Data Type

int

Default Value

1000

Remarks

When processing a query, instead of requesting all of the queried data at once from OData, 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'.

Data Type

string

Default Value

""

Remarks

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:

*=*

The timezone for representing or interpreting the server's Edm.DateTime values. The value of this property affects how Edm.DateTime filters and results are converted between the server and the client.

Data Type

string

Default Value

""

Remarks

By default, Edm.DateTime values on the server are assumed to be in GMT. However, both time zone abbreviations and names are supported, with a recommendation to use the time zone name, such as America/New_York. The Cloud will convert any filters derived from Edm.DateTime values from the machine's local time zone to the specified server time zone. Conversely, values returned by the OData server will be converted from the specified time zone to the local time zone of the machine before being presented in the result set.

When Edm.DateTime values are sent to the server, they are treated according to the time zone established by the ServerTimeZone. When the server returns Edm.DateTime values, it formats them based on the ServerTimeZone. This method ensures that Edm.DateTime values are consistently interpreted by both the client and the server.

A boolean value indicating whether stored procedures returning collections of entities should be treated as views.

Data Type

bool

Default Value

false

Remarks

When this property is set to true, stored procedures that return result sets can be exposed as entity sets in the service model. These entity sets will function as read-only views. Thus, operations such as INSERT, UPDATE, and DELETE are not supported because these are user-facing operations.

Determines whether navigation properties can be retrieved from the base entity set, which is more accurate. If this property is false, it prevents the provider from retrieving navigation properties.

Data Type

bool

Default Value

true

Remarks

This property determines whether navigation properties can be retrieved from the base entity set.

If you use the connection property NavigationPropertiesAsViews, you will create a new view for each relationship. If SupportsExpand is set to false, querying these relationships will not work. In this case, you will see an exception message.

For example, the following query does not work when SupportsExpand is false:

SELECT * FROM navigationView

However, the following query will work:

SELECT * FROM navigationView WHERE parentKey = 'some value'

When the connection property IncludeNavigationProperties is set to true and this property is enabled, foreign keys for each relationship in every table will be included. However, if SupportsExpand is false, this information will not be available, as expansion is necessary to retrieve the actual key values.

For more on navigation properties, see Data Model.

Working with Limited APIs

In OData, the $expand parameter is used to expand specified navigation properties when requesting data from a given entity set. In SQL, this makes it possible to execute a SELECT * to a navigation property view.

If $expand is not supported, a different request must be made to retrieve a navigation property, one that specifies the primary key of the base entity set. This API restriction is reflected in SQL: You will need to specify the base entity's primary key in the WHERE clause.

For example, consider two entities with a one-to-many relationship in the Northwind sample service, Categories and Products. In OData, the Products associated with a given Category could be represented as a navigation property on the base Category entity set. The Cloud models the Products navigation property as a Categories_Products view.

If $expand is not supported, use a query like the following for this view:

SELECT       * 
FROM         Categories_Products
WHERE        (Categories_CategoryID = 1)

Specifies whether the OData service supports the $filter query parameter.

Data Type

bool

Default Value

true

Remarks

Set this property to true if your OData service supports filtering using the $filter query parameter.

When this property is set to true, the Cloud attempts to push filter logic to the OData service, reducing the volume of data retrieved and improving performance. However, the actual behavior depends on the capabilities of the OData service as some filter expressions may still be handled client-side if the service does not support them.

If your OData service does not support the $filter parameter, set this property to false. When this property is set to false, all requested data is retrieved from the service and filtered locally. This can significantly impact performance, so use this setting only when necessary.

For example, if $filter is not supported, the following query is processed client-side:

SELECT       * 
FROM         Categories_Products
WHERE        (Categories_CategoryID = 1)

This property is typically used with OData services that have partial or no support for filtering operations.

A boolean indicating if the odata service supports server side formulas.

Data Type

bool

Default Value

false

Remarks

OData has a number of server side formulas that are built into the specifications. However, many services do not natively support them and will return errors when these formulas are appended to the $filter parameter. These formulas can be used to make some queries that use them execute much faster. If your OData service supports formulas, change this connection property to true. Otherwise, leave it as false.

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

Data Type

int

Default Value

60

Remarks

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

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

Disabling the timeout allows operations to run indefinitely until they succeed or fail due to other conditions such as server-side timeouts, network interruptions, or resource limits on the server.

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

Specifies whether or not OData should return data using client-side paging, if your source supports it. To use client-side paging, set this to True. To use server-side paging, set this to False.

Data Type

bool

Default Value

false

Remarks

Pagination is the process of batching data so that the data retrieved is displayed in batches of a particular size. To keep paging through the data, ask for "more". The data continues to display until all the retrieved data has been shown.

Client-Side Paging

In client-side paging, the client specifies how many records to return in each request, and the order of the requests. If UseClientSidePaging is set to True, the limit/offset is calculated at the client and the requests are sent concurrently, as multiple threads.

If you set UseClientSidePaging to True, ensure that the value of PageSize is not set higher than the maximum value supported by the service. Setting PageSize to a higher value than supported may result in missing information.

Server-Side Paging

In server-side paging, the server returns only a subset of the data requested by the client. It also provides statistics on how large the full set of requested data is, and how much of the requested data set was not displayed. Server-side pagination is best for large data sets.

Server-side paging requires traversing the data set both backward and forward. Not all data sources support that natively. To explicitly enable server-side paging with a data source that does not support it natively, you must configure your server to return a limited number of records per request, along with metadata about the total number of records. For details, see your data source's API documentation.

The purpose of this property is to optionally hide the Etag column if the service does not return a value for it. Otherwise, it will be included but remain empty.

Data Type

bool

Default Value

true

Remarks

When the UseEtags property is set to true, a new column called Etag will be exposed for each table. This column will display the Etag value for the specified row. If the service does not support ETags, the value in this column will be NULL. In such cases, it is recommended to set this property to false to remove the column entirely.

This property is useful for keeping track of record updates.

Specifies whether or not simple names should be used for tables and columns.

Data Type

bool

Default Value

false

Remarks

OData tables can include special characters in their names that are typically not allowed in standard databases. This property makes the Cloud easier to use with traditional database tools.

Setting UseSimpleNames to True simplifies the names of the columns that are returned. It enforces a naming scheme where only alphanumeric characters and underscores are valid for displayed column names.

Notes:

• Any non-alphanumeric characters are converted to underscores.
• If the column or table names exceed 128 characters in length they are truncated to 128 characters to comply with SQL Server standards.

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.