Azure Data Lake Storage Connection Details¶
Introduction¶
Connector Version
This documentation is based on version 23.0.8852 of the connector.
Get Started¶
Azure Data Lake Storage Version Support
The connector leverages the Azure Data Lake Storage API to enable bidirectional access to Azure Data Lake Storage.
Stream Azure Data Lake Storage Data¶
The Azure Data Lake Storage connector is designed for navigating the Azure Data Lake Storage metadata
only. A variety of of stored procedures relevant to Azure Data Lake Storage data are supported as well.
This metadata typically includes details about stored objects, such as file and folder names, and excludes the actual content of the discoverable files.
If access to both the file metadata and the actual file content is needed, then the Azure Data Lake Storage connector must be used in tandem with the associated file streaming driver(s) for the filetypes stored in Azure Data Lake Storage.
The following file streaming drivers are available:
- Avro
- CSV
- Excel
- JSON
- Parquet
- REST
- XML
See the relevant file streaming driver's documentation for a configuration guide for connecting to files stored in Azure Data Lake Storage.
Establish a Connection¶
Connect to Azure DataLakeStorage Gen 1¶
To connect to a Gen 1 DataLakeStorage account, you should first set the following properties:
Schema
: Set this toADLSGen1
.Account
: Set this to the name of the account.AzureTenant
: Set this to the tenant Id. See the property for more information on how to acquire this.Directory
: (Optional) Set this to the path which will be used to store the replicated file. If not specified, the root directory will be used.
Authenticate to Azure DataLakeStorage Gen 1¶
Gen 1 supports the following authentication methods: Azure Active Directory OAuth (AzureAD) and Managed Service Identity (AzureMSI).
Azure AD¶
Azure AD is a connection type that leverages OAuth to authenticate. OAuth requires the authenticating user to interact with Azure Data Lake Storage using an internet browser. The connector facilitates this in several ways as described below. Set your AuthScheme
to AzureAD
. The rest of the AzureAD flows assume that you have done so.
Desktop Applications¶
An embedded OAuth application is provided that simplifies OAuth desktop Authentication. Alternatively, you can create a custom OAuth application. See Creating a Custom OAuth Application for information about creating custom applications and reasons for doing so.
For authentication, the only difference between the two methods is that you must set two additional connection properties when using custom OAuth applications.
After setting the following connection properties, you are ready to connect:
InitiateOAuth
: Set this toGETANDREFRESH
. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting theOAuthAccessToken
.OAuthClientId
: (custom applications only) Set this to the client ID in your application settings.OAuthClientSecret
: (custom applications only) Set this to the client secret in your application settings.CallbackURL
: Set this to the Redirect URL in your application settings.
When you connect the connector opens the OAuth endpoint in your default browser. Log in and grant permissions to the application. The connector then completes the OAuth process:
- Extracts the access token from the callback URL and authenticates requests.
- Obtains a new access token when the old one expires.
- Saves OAuth values in
OAuthSettingsLocation
that persist across connections.
Admin Consent¶
Admin consent refers to when the Admin for an Azure Active Directory tenant grants permissions to an application which requires an admin to consent to the use case. The embedded app within the Azure Data Lake Storage connector, contains no permissions that require admin consent. Therefore, this information applies only to custom applications.
Admin Consent Permissions
When creating a new OAuth app in the Azure Portal, you must specify which permissions the app will require. Some permissions may be marked stating "Admin Consent Required". For example, all Groups permissions require Admin Consent. If your app requires admin consent, there are a couple of ways this can be done.
The easiest way to grant admin consent is to just have an admin log into portal.azure.com and navigate to the app you have created in App Registrations. Under API Permissions, there will be a button for Grant Consent. You can consent here for your app to have permissions on the tenant it was created under.
If your organization has multiple tenants or the app needs to be granted permissions for other tenants outside your organization, the adminconsenturlproc may be used to generate the Admin Authorization URL. Unlike the GetOAuthAuthorizationURL, there will be no important information returned from this endpoint. If the grants access, it will simply return a boolean indicating that permissions were granted.
Once an admin grants consent, authentication may be performed as normal.
Client Credentials¶
Client credentials refers to a flow in OAuth where there is no direct user authentication taking place. Instead, credentials are created for just the app itself.
All tasks taken by the app are done without a default user context. This makes the authentication flow a bit different from standard.
Client OAuth Flow
All permissions related to the client oauth flow require admin consent. This means the app embedded with the Azure Data Lake Storage connector cannot be used in the client oauth flow. You must create your own OAuth app in order to use client credentials. See Creating a Custom OAuth Application for more details.
In your App Registration in portal.azure.com, navigate to API Permissions and select the Microsoft Graph permissions. There are two distinct sets of permissions - Delegated and Application permissions. The permissions used during client credential authentication are under Application Permissions. Select the applicable permissions you require for your integration.
You are ready to connect after setting one of the below connection properties groups depending on the authentication type.
Client Secret
InitiateOAuth
: Set this toGETANDREFRESH
. You can cuse InitiateOAuth to avoid repeating the OAuth exchange and manually setting theOAuthAccessToken
.AzureTenant
: Set this to the tenant you wish to connet to.OAuthGrantType
: Set this to CLIENT.OAuthClientId
: Set this to the Client ID in your app settings.OAuthClientSecret
: Set this to the Client Secret in your app settings.
Certificate
InitiateOAuth
: Set this toGETANDREFRESH
. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting theOAuthAccessToken
.AzureTenant
: Set this to the tenant you wish to connect to.OAuthGrantType
: Set this to CLIENT.OAuthClientId
: Set this to the Client ID in your app settings.OAuthJWTCert
: Set this to the JWT Certificate store.OAuthJWTCertType
: Set this to the type of the certificate store specified byOAuthJWTCert
.
Authentication with client credentials will take place automatically like any other connection, except there will be no window opened prompting the user. Because there is no user context, there is no need for a browser popup. Connections will take place and be handled internally.
Azure Service Principal¶
The authentication as an Azure Service Principal is handled via the OAuth Client Credentials flow. It does not involve direct user authentication. Instead, credentials are created for just the application itself. All tasks taken by the app are done without a default user context, but based on the assigned roles. The application access to the resources is controlled through the assigned roles' permissions.
Create an AzureAD App and an Azure Service Principal
When authenticating using an Azure Service Principal, you must create and register an Azure AD application with an Azure AD tenant. See Creating a Custom OAuth Application for more details.
In your App Registration in portal.azure.com
, navigate to API Permissions and select the Microsoft Graph permissions
. There are two distinct sets of permissions: Delegated permissions and Application permissions. The permissions used during client credential authentication are under Application Permissions.
Assign a role to the application
To access resources in your subscription, you must assign a role to the application.
- Open the
Subscriptions
page by searching and selecting the Subscriptions service from the search bar. - Select the subscription to assign the application to.
- Open the
Access control (IAM)
and selectAdd > Add role assignment
to open theAdd role assignment
page. - Select
Owner
as the role to assign to your created Azure AD app.
Complete the Authentication
Choose whether to use a client secret or a certificate and follow the relevant steps below.
Client Secret
Set these connection properties:
AuthScheme
:AzureServicePrincipal
to use a client secret.InitiateOAuth
:GETANDREFRESH
. You can useInitiateOAuth
to avoid repeating the OAuth exchange and manually setting theOAuthAccessToken
.AzureTenant
: The tenant you want to connect to.OAuthClientId
: The client ID in your application settings.OAuthClientSecret
: The client secret in your application settings.
Certificate
Set these connection properties:
AuthScheme
:AzureServicePrincipalCert
to use a certificate.InitiateOAuth
:GETANDREFRESH
. You can useInitiateOAuth
to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.AzureTenant
: The tenant you want to connect to.OAuthJWTCert
: The JWT Certificate store.OAuthJWTCertType
: The type of the certificate store specified byOAuthJWTCert
.
You are now ready to connect. Authentication with client credentials takes place automatically like any other connection, except there is no window opened prompting the user. Because there is no user context, there is no need for a browser popup. Connections take place and are handled internally.
Managed Service Identity (MSI)¶
If you are running Azure Data Lake Storage on an Azure VM and want to leverage MSI to connect, set AuthScheme
to AzureMSI
.
User-Managed Identities¶
To obtain a token for a managed identity, use the OAuthClientId
property to specify the managed identity's "client_id".
When your VM has multiple user-assigned managed identities, you must also specify OAuthClientId
.
Connect to Azure DataLakeStorage Gen 2¶
To connect to a Gen 2 DataLakeStorage account, you should first set the following properties:
Schema
: Set this toADLSGen2
.Account
: Set this to the name of the storage account.FileSystem
: Set this to the file system name which will be used for this account. For example, the name of an Azure Blob ContainerDirectory
: (Optional) Set this to the path which will be used to store the replicated file. If not specified, the root directory will be used.
Authenticate to Azure DataLakeStorage Gen 2¶
Gen 2 supports the following authentication methods: using an AccessKey, using a Shared Access Signature, Azure Active Directory OAuth (AzureAD), Managed Service Identity (AzureMSI).
Authenticate using an Access Key¶
To connect using a Shared Access Signature set the AccessKey
property and the AuthScheme
to AccessKey
.
You can obtain an access key for the ADLS Gen2 storage account using the Azure portal:
- Go to your ADLS Gen2 Storage Account in the Azure portal.
- Under Settings, select Access keys.
- Copy the value for one of the available access keys to the
AccessKey
connection property.
Shared Access Signature (SAS)¶
To connect using a Shared Access Signature set the SharedAccessSignature
property to a valid signature of a resource to connect to and the AuthScheme
to SAS
. The SharedAccessSignature
may be generated with a tool such as Azure Storage Explorer.
Azure AD¶
Azure AD is a connection type that leverages OAuth to authenticate. OAuth requires the authenticating user to interact with Azure Data Lake Storage using an internet browser. The connector facilitates this in several ways as described below. Set your AuthScheme
to AzureAD
. The rest of the AzureAD flows assume that you have done so.
Desktop Applications¶
An embedded OAuth application is provided that simplifies OAuth desktop Authentication. Alternatively, you can create a custom OAuth application. See Creating a Custom OAuth Application for information about creating custom applications and reasons for doing so.
For authentication, the only difference between the two methods is that you must set two additional connection properties when using custom OAuth applications.
After setting the following connection properties, you are ready to connect:
InitiateOAuth
: Set this toGETANDREFRESH
. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting theOAuthAccessToken
.OAuthClientId
: (custom applications only) Set this to the client ID in your application settings.OAuthClientSecret
: (custom applications only) Set this to the client secret in your application settings.CallbackURL
: Set this to the Redirect URL in your application settings.
When you connect the connector opens the OAuth endpoint in your default browser. Log in and grant permissions to the application. The connector then completes the OAuth process:
- Extracts the access token from the callback URL and authenticates requests.
- Obtains a new access token when the old one expires.
- Saves OAuth values in
OAuthSettingsLocation
that persist across connections.
Admin Consent¶
Admin consent refers to when the Admin for an Azure Active Directory tenant grants permissions to an application which requires an admin to consent to the use case. The embedded app within the Azure Data Lake Storage connector, contains no permissions that require admin consent. Therefore, this information applies only to custom applications.
Admin Consent Permissions
When creating a new OAuth app in the Azure Portal, you must specify which permissions the app will require. Some permissions may be marked stating "Admin Consent Required". For example, all Groups permissions require Admin Consent. If your app requires admin consent, there are a couple of ways this can be done.
The easiest way to grant admin consent is to just have an admin log into portal.azure.com and navigate to the app you have created in App Registrations. Under API Permissions, there will be a button for Grant Consent. You can consent here for your app to have permissions on the tenant it was created under.
If your organization has multiple tenants or the app needs to be granted permissions for other tenants outside your organization, the adminconsenturlproc may be used to generate the Admin Authorization URL. Unlike the GetOAuthAuthorizationURL, there will be no important information returned from this endpoint. If the grants access, it will simply return a boolean indicating that permissions were granted.
Once an admin grants consent, authentication may be performed as normal.
Client Credentials¶
Client credentials refers to a flow in OAuth where there is no direct user authentication taking place. Instead, credentials are created for just the app itself.
All tasks taken by the app are done without a default user context. This makes the authentication flow a bit different from standard.
Client OAuth Flow
All permissions related to the client oauth flow require admin consent. This means the app embedded with the Azure Data Lake Storage connector cannot be used in the client oauth flow. You must create your own OAuth app in order to use client credentials. See Creating a Custom OAuth Application for more details.
In your App Registration in portal.azure.com, navigate to API Permissions and select the Microsoft Graph permissions. There are two distinct sets of permissions - Delegated and Application permissions. The permissions used during client credential authentication are under Application Permissions. Select the applicable permissions you require for your integration.
You are ready to connect after setting one of the below connection properties groups depending on the authentication type.
Client Secret
InitiateOAuth
: Set this toGETANDREFRESH
. You can cuse InitiateOAuth to avoid repeating the OAuth exchange and manually setting theOAuthAccessToken
.AzureTenant
: Set this to the tenant you wish to connet to.OAuthGrantType
: Set this to CLIENT.OAuthClientId
: Set this to the Client ID in your app settings.OAuthClientSecret
: Set this to the Client Secret in your app settings.
Certificate
InitiateOAuth
: Set this toGETANDREFRESH
. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting theOAuthAccessToken
.AzureTenant
: Set this to the tenant you wish to connect to.OAuthGrantType
: Set this to CLIENT.OAuthClientId
: Set this to the Client ID in your app settings.OAuthJWTCert
: Set this to the JWT Certificate store.OAuthJWTCertType
: Set this to the type of the certificate store specified byOAuthJWTCert
.
Authentication with client credentials will take place automatically like any other connection, except there will be no window opened prompting the user. Because there is no user context, there is no need for a browser popup. Connections will take place and be handled internally.
Azure Service Principal¶
The authentication as an Azure Service Principal is handled via the OAuth Client Credentials flow. It does not involve direct user authentication. Instead, credentials are created for just the application itself. All tasks taken by the app are done without a default user context, but based on the assigned roles. The application access to the resources is controlled through the assigned roles' permissions.
Create an AzureAD App and an Azure Service Principal
When authenticating using an Azure Service Principal, you must create and register an Azure AD application with an Azure AD tenant. See Creating a Custom OAuth Application for more details.
In your App Registration in portal.azure.com
, navigate to API Permissions and select the Microsoft Graph permissions
. There are two distinct sets of permissions: Delegated permissions and Application permissions. The permissions used during client credential authentication are under Application Permissions.
Assign a role to the application
To access resources in your subscription, you must assign a role to the application.
- Open the
Subscriptions
page by searching and selecting the Subscriptions service from the search bar. - Select the subscription to assign the application to.
- Open the
Access control (IAM)
and selectAdd > Add role assignment
to open theAdd role assignment
page. - Select
Owner
as the role to assign to your created Azure AD app.
Complete the Authentication
Choose whether to use a client secret or a certificate and follow the relevant steps below.
Client Secret
Set these connection properties:
AuthScheme
:AzureServicePrincipal
to use a client secret.InitiateOAuth
:GETANDREFRESH
. You can useInitiateOAuth
to avoid repeating the OAuth exchange and manually setting theOAuthAccessToken
.AzureTenant
: The tenant you want to connect to.OAuthClientId
: The client ID in your application settings.OAuthClientSecret
: The client secret in your application settings.
Certificate
Set these connection properties:
AuthScheme
:AzureServicePrincipalCert
to use a certificate.InitiateOAuth
:GETANDREFRESH
. You can useInitiateOAuth
to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.AzureTenant
: The tenant you want to connect to.OAuthJWTCert
: The JWT Certificate store.OAuthJWTCertType
: The type of the certificate store specified byOAuthJWTCert
.
You are now ready to connect. Authentication with client credentials takes place automatically like any other connection, except there is no window opened prompting the user. Because there is no user context, there is no need for a browser popup. Connections take place and are handled internally.
Managed Service Identity (MSI)¶
If you are running Azure Data Lake Storage on an Azure VM and want to leverage MSI to connect, set AuthScheme
to AzureMSI
.
User-Managed Identities¶
To obtain a token for a managed identity, use the OAuthClientId
property to specify the managed identity's "client_id".
When your VM has multiple user-assigned managed identities, you must also specify OAuthClientId
.
Create a Custom OAuth Application¶
Create a Custom OAuth Application¶
Azure Data Lake Storage supports authentication using Azure AD and Azure Service Principal, both of which are OAuth-based.
This topic describes how to:
- create and register custom OAuth application for Azure AD or Azure Service Principal
- provide Admin Consent to a custom OAuth application
- create a custom OAuth application for use with client credentials
Azure AD¶
In portal.azure.com
:
- Log in to
https://portal.azure.com
. - In the left-hand navigation pane, select
Azure Active Directory
, thenapplicationRegistrations
. - Click
New registration
. - Enter a name for the application.
- Select the desired tenant setup: single- or multi-tenant, and public or private use.
- If you select the default option, "Accounts in this organizational directory only", you must set the
AzureTenant
connection property to the ID of the Azure AD Tenant when establishing a connection with the Azure Data Lake Storage connector. Otherwise, the authentication attempt fails with an error. - If your application is for private use only, specify
Accounts in this organization directory only
. - If you want to distribute your application, choose one of the multi-tenant options.
- If you select the default option, "Accounts in this organizational directory only", you must set the
- Set the redirect URL to
http://localhost:33333
(the connector's default) OR specify a different port and setCallbackURL
to the exact reply URL you defined. - Click
Register
to register the new application. An application management screen displays.
Note the value inApplication (client) ID
as theOAuthClientId
and theDirectory (tenant) ID
as theAzureTenant
. - Navigate to
Certificates & Secrets
and define the application authentication type. There are two types of authentication available: certificate (recommended) or client secret.- For certificate authentication: In
Certificates & Secrets
, selectUpload certificate
, then upload the certificate from your local machine. - For creating a new client secret: In
Certificates & Secrets
, selectNew Client Secret
for the application and specify its duration. After the client secret is saved, Azure Data Lake Storage displays the key value. Copy this value, as it is displayed only once. This value becomes theOAuthClientSecret
.
- For certificate authentication: In
- Select
API Permissions > Add > Delegated permissions
. - Select 'Windows Azure Service Management API' along with 'Azure Data Lake' and add the
Have full access to the Azure Data Lake service
permission. - Save your changes.
- If you have specified the use of permissions that require admin consent (such as the Application Permissions), you can grant them from the current tenant on the API Permissions page.
Azure Service Principal¶
To use Azure Service Principal authentication, you must set up the ability to assign a role to the authentication application, then register an application with the Azure AD tenant to create a new Service Principal. That new Service Principal can then leverage the assigned role-based access
control to access resources in your subscription.
In portal.azure.com
:
- Create a custom OAuth AD application, as described above.
- Use the search bar to search for the Subscriptions service.
- Open the
Subscriptions
page. - Select the subscription to which to assign the application.
- Open the
Access control (IAM)
. - Select
Add > Add role assignment
. Azure Data Lake Storage opens theAdd role assignment
page. - Assign your custom Azure AD application the role of
Owner
.
Admin Consent¶
Some custom applications require administrative permissions to operate within an Azure Active Directory tenant. Admin consent can be granted when creating a new custom OAuth application, by adding relevant permissions that are already marked with "Admin Consent Required". Admin consent is also required to use Client Credentials in the OAuth flow.
To grant admin consent:
- Have an admin log in to
portal.azure.com
. - Navigate to
App Registrations
and find the custom OAuth application you created. - Under
API Permissions
, clickGrant Consent
.
This gives your application permissions on the tenant under which it was created.
Consent for Client Credentials¶
OAuth supports the use of client credentials to authenticate. In a client credentials OAuth flow, credentials are created for the authenticating application itself. The auth flow acts just like the usual auth flow except that there is no prompt for an associated user to provide credentials.
All tasks accepted by the application are executed outside of the context of a default user.
Note
Since the embedded OAuth credentials authenticate on a per-user basis, you cannot
use them in a client OAuth flow. You must always create a custom OAuth application to use client credentials.
In portal.azure.com
:
- Create a custom OAuth application, as described above.
- Navigate to
App Registrations
. - Find the application you just created, and open
API Permissions
. - Select the Microsoft Graph permissions. There are two distinct sets of permissions: Delegated and Application.
- Under
Application Permissions
, select the permissions you require for your integration.
Fine-Tuning Data Access¶
Fine Tuning Data Access¶
You can use the following properties to gain more control over the data returned from Azure Data Lake Storage:
DirectoryRetrievalDepth
: For theADLSGen1
schema. Specifies how many subfolders will be recursively scanned before stopping.IncludeSubDirectories
: For theADLSGen2
schema. Whether the connector should list the subdirectories' paths in the Resources view.
Important Notes¶
Configuration Files and Their Paths¶
- All references to adding configuration files and their paths refer to files and locations on the Jitterbit agent where the connector is installed. These paths are to be adjusted as appropriate depending on the agent and the operating system. If multiple agents are used in an agent group, identical files will be required on each agent.
Advanced Features¶
This section details a selection of advanced features of the Azure Data Lake Storage connector.
User Defined Views
The connector allows you to define virtual tables, called user defined views, whose contents are decided by a pre-configured query. These views are useful when you cannot directly control queries being issued to the drivers. See User Defined Views for an overview of creating and configuring custom views.
SSL Configuration
Use SSL Configuration to adjust how connector handles TLS/SSL certificate negotiations. You can choose from various certificate formats; see the SSLServerCert
property under "Connection String Options" for more information.
Proxy
To configure the connector using private agent proxy settings, select the Use Proxy Settings
checkbox on the connection configuration screen.
Query Processing
The connector offloads as much of the SELECT statement processing as possible to Azure Data Lake Storage and then processes the rest of the query in memory (client-side).
See Query Processing for more information.
User Defined Views¶
The Azure Data Lake Storage connector allows you to define a virtual table whose contents are decided by a pre-configured query. These are called User Defined Views, which are useful in situations where you cannot directly control the query being issued to the driver, e.g. when using the driver from Jitterbit. The User Defined Views can be used to define predicates that are always applied. If you specify additional predicates in the query to the view, they are combined with the query already defined as part of the view.
There are two ways to create user defined views:
- Create a JSON-formatted configuration file defining the views you want.
- DDL statements.
Define Views Using a Configuration File¶
User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json
. The connector automatically detects the views specified in this file.
You can also have multiple view definitions and control them using the UserDefinedViews
connection property. When you use this property, only the specified views are seen by the connector.
This User Defined View configuration file is formatted as follows:
- Each root element defines the name of a view.
- Each root element contains a child element, called
query
, which contains the custom SQL query for the view.
For example:
{
"MyView": {
"query": "SELECT * FROM Resources WHERE MyColumn = 'value'"
},
"MyView2": {
"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
}
}
Use the UserDefinedViews
connection property to specify the location of your JSON configuration file. For example:
"UserDefinedViews", "C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json"
Define Views Using DDL Statements¶
The connector is also capable of creating and altering the schema via DDL Statements such as CREATE LOCAL VIEW, ALTER LOCAL VIEW, and DROP LOCAL VIEW.
Create a View¶
To create a new view using DDL statements, provide the view name and query as follows:
CREATE LOCAL VIEW [MyViewName] AS SELECT * FROM Customers LIMIT 20;
If no JSON file exists, the above code creates one. The view is then created in the JSON configuration file and is now discoverable. The JSON file location is specified by the UserDefinedViews
connection property.
Alter a View¶
To alter an existing view, provide the name of an existing view alongside the new query you would like to use instead:
ALTER LOCAL VIEW [MyViewName] AS SELECT * FROM Customers WHERE TimeModified > '3/1/2020';
The view is then updated in the JSON configuration file.
Drop a View¶
To drop an existing view, provide the name of an existing schema alongside the new query you would like to use instead.
DROP LOCAL VIEW [MyViewName]
This removes the view from the JSON configuration file. It can no longer be queried.
Schema for User Defined Views¶
User Defined Views are exposed in the UserViews
schema by default. This is done to avoid the view's name clashing with an actual entity in the data model. You can change the name of the schema used for UserViews by setting the UserViewsSchemaName
property.
Work with User Defined Views¶
For example, a SQL statement with a User Defined View called UserViews.RCustomers
only lists customers in Raleigh:
SELECT * FROM Customers WHERE City = 'Raleigh';
An example of a query to the driver:
SELECT * FROM UserViews.RCustomers WHERE Status = 'Active';
Resulting in the effective query to the source:
SELECT * FROM Customers WHERE City = 'Raleigh' AND Status = 'Active';
That is a very simple example of a query to a User Defined View that is effectively a combination of the view query and the view definition. It is possible to compose these queries in much more complex patterns. All SQL operations are allowed in both queries and are combined when appropriate.
SSL Configuration¶
Customize the SSL Configuration¶
By default, the connector 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.
Data Model¶
Overview
This section shows the available API objects and provides more information on executing SQL to Azure Data Lake Storage APIs.
Key Features
- The connector models Azure Data Lake Storage entities like documents, folders, and groups as relational views, allowing you to write SQL to query Azure Data Lake Storage data.
- Stored procedures allow you to execute operations to Azure Data Lake Storage.
- Live connectivity to these objects means any changes to your Azure Data Lake Storage account are immediately reflected when using the connector.
Views
Views describes the available views. Views are statically defined to model Resources and Permissions.
Stored Procedures
Stored Procedures are function-like interfaces to Azure Data Lake Storage. Stored procedures allow you to execute operations to Azure Data Lake Storage, including downloading documents and moving envelopes.
Views¶
Views are similar to tables in the way that data is represented; however, views are read-only.
Queries can be executed against a view as if it were a normal table.
Azure Data Lake Storage Connector Views¶
Name | Description |
---|---|
FileSystems | Lists all filesystems. |
Resources | Lists the contents of the supplied path. |
FileSystems¶
Lists all filesystems.
Columns¶
Name | Type | Behavior | Description |
---|---|---|---|
ETag | String | Unique identifier of the filesystem. | |
Name [KEY] | String | The name of the filesystem. | |
LastModified | Timestamp | The timestamp when the filesystem was modified for the last time. |
Resources¶
Lists the contents of the supplied path.
Columns¶
Name | Type | Behavior | Description |
---|---|---|---|
Name [KEY] | String | The path of the file or folder. | |
Directory | String | The directory path of the file or folder. | |
IsDirectory | String | Determines if the resource is a folder or a file. | |
ContentLength | Long | Determines the size of the file in bytes. | |
LastModified | Timestamp | The timestamp when the file was modified for the last time. | |
Owner | String | The name of the owner. | |
Permissions | String | The permissions set to the file. | |
ETag | String | Unique identifier of the file or folder. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
Recursive | Boolean | Set this to true to retrieve all sub folders and files. The default value is false. |
Stored Procedures¶
Stored procedures are function-like interfaces that extend the functionality of the connector beyond simple SELECT operations with Azure Data Lake Storage.
Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Azure Data Lake Storage, along with an indication of whether the procedure succeeded or failed.
Azure Data Lake Storage Connector Stored Procedures¶
Name | Description |
---|---|
CopyFile | Copy a file from a source to a destination. |
CreateFile | Create a file. Path is required for a successful operation. |
CreateFileSystem | Create a filesystem by specifying the name. |
CreateFolder | Create a folder. Path is required for a successful operation. |
DeleteFileSystem | Delete a filesystem. The name of the filesystem for a successful operation. |
DeleteObject | Delete a file or a folder. Path is required for a successful operation. |
DownloadFile | Download a file. Path and DownloadPath are required for a successful operation. |
GetFileSystemProperties | Get the properties of a filesystem. The name of the filesystem is required for a successful operation. |
GetOAuthAccessToken | Gets the OAuth access token from SharePoint. |
GetOAuthAuthorizationURL | Gets the SharePoint authorization URL. Access the URL returned in the output in a Web browser. This requests the access token that can be used as part of the connection string to SharePoint. |
LeaseBlob | The LeaseBlob operation creates and manages a lock on a blob for write and delete operations. |
RefreshOAuthAccessToken | Refreshes the OAuth access token used for authentication with SharePoint. |
RenameObject | Rename a file or a directory. Path and RenameTo are required for a successful operation. |
SetFileSystemProperties | Set the properties for a filesystem. The name of the filesystem is required for a successful operation. |
UploadFile | Upload a File. Path and FilePath are required for a successful operation. |
CopyFile¶
Copy a file from a source to a destination.
Input¶
Name | Type | Description |
---|---|---|
SourcePath | String | Required. The path of the file which will be copied. |
DestinationPath | String | Required. The path of the file where it will be copied. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
Success | String | Determines if the operation was successful or not. |
CreateFile¶
Create a file. Path is required for a successful operation.
Input¶
Name | Type | Description |
---|---|---|
Path | String | The path of the file which will be created. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
Success | String | Determines if the operation was successful or not. |
CreateFileSystem¶
Create a filesystem by specifying the name.
Input¶
Name | Type | Description |
---|---|---|
FileSystem | String | The name for the new filesystem. |
Properties | String | Properties to set to the filesystem. |
DefaultEncryptionScope | String | Default encryption scopes to set to the filesystem. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
Success | String | Determines if the operation was successful or not. |
ETag | String | Unique identifier of the filesystem. |
CreateFolder¶
Create a folder. Path is required for a successful operation.
Input¶
Name | Type | Description |
---|---|---|
Path | String | The path of the folder which will be created. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
Success | String | Determines if the operation was successful or not. |
DeleteFileSystem¶
Delete a filesystem. The name of the filesystem for a successful operation.
Input¶
Name | Type | Description |
---|---|---|
FileSystem | String | The name of the filesystem which will be deleted. |
ModifiedSince | Datetime | A date and time value that sets condition to perform the operation only if the resource has been modified since the specified date and time. |
UnmodifiedSince | Datetime | A date and time value that sets condition to perform the operation only if the resource has not been modified since the specified date and time. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
Success | Boolean | Determines if the operation was successful or not. |
DeleteObject¶
Delete a file or a folder. Path is required for a successful operation.
Input¶
Name | Type | Description |
---|---|---|
Path | String | The path of the file or folder to be deleted. |
Recursive | Boolean | Set this to true to delete a folder with all of it content. The default value is false. |
DeleteType | String | Set this to FILESANDFOLDERS to delete the file or folder specified in the Path parameter. Set this to FILES to delete only the files inside the folder specified in the Path parameter. The allowed values are FILES, FILESANDFOLDERS. The default value is FILESANDFOLDERS. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
Success | String | Determines if the operation was successful or not. |
DownloadFile¶
Download a file. Path and DownloadPath are required for a successful operation.
Input¶
Name | Type | Description |
---|---|---|
Path | String | The path of the file which will be downloaded. |
DownloadPath | String | The path where the file will be downloaded. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
FileData | String | File data that will be outputted encoded in Base64 if the DownloadPath and FileStream inputs are empty. |
Success | String | Whether the operation was successful. |
GetFileSystemProperties¶
Get the properties of a filesystem. The name of the filesystem is required for a successful operation.
Input¶
Name | Type | Description |
---|---|---|
FileSystem | String | The path of the file which will be created. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
Success | String | Determines if the operation was successful or not. |
ETag | String | Unique identifier of the filesystem. |
Properties | String | Properties of the filesystem. |
DefaultEncryptionScope | String | Default encryption scopes of the filesystem. |
DenyEncryptionScopeOverride | Boolean | Determines if encryption scope override is denied for the filesystem. |
LastModified | Datetime | The timestamp when the filesystem was modified for the last time. |
GetOAuthAccessToken¶
Gets the OAuth access token from SharePoint.
Input¶
Name | Type | Description |
---|---|---|
AuthMode | String | The type of authentication mode to use. The allowed values are APP, WEB. |
Verifier | String | The verifier token returned by SharePoint after using the URL obtained with GetOAuthAuthorizationURL. Required for only the Web AuthMode. |
CallbackUrl | String | The URL the user will be redirected to after authorizing your application. |
State | String | Any value that you wish to be sent with the callback. |
Prompt | String | Defaults to 'select_account' which prompts the user to select account while authenticating. Set to 'None', for no prompt, 'login' to force user to enter their credentials or 'consent' to trigger the OAuth consent dialog after the user signs in, asking the user to grant permissions to the app. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
OAuthAccessToken | String | The authentication token returned from SharePoint. |
OAuthRefreshToken | String | A token that may be used to obtain a new access token. |
ExpiresIn | String | The remaining lifetime for the access token in seconds. |
GetOAuthAuthorizationURL¶
Gets the SharePoint authorization URL. Access the URL returned in the output in a Web browser. This requests the access token that can be used as part of the connection string to SharePoint.
Input¶
Name | Type | Description |
---|---|---|
CallbackUrl | String | The URL that Sharepoint will return to after the user has authorized your app. |
State | String | Any value that you wish to be sent with the callback. |
Prompt | String | Defaults to 'select_account' which prompts the user to select account while authenticating. Set to 'None', for no prompt, 'login' to force user to enter their credentials or 'consent' to trigger the OAuth consent dialog after the user signs in, asking the user to grant permissions to the app. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
URL | String | The URL to be entered into a Web browser to obtain the verifier token and authorize the data provider with. |
LeaseBlob¶
The LeaseBlob operation creates and manages a lock on a blob for write and delete operations.
Input¶
Name | Type | Description |
---|---|---|
Path | String | The path of the file which will be created. |
LeaseAction | String | Specifies the lease action to execute The allowed values are Acquire, Renew, Change, Release, Break. |
LeaseId | String | Required to Renew, Change, or Release the lease. |
LeaseBreak | Integer | For a Break operation, this is the proposed duration of seconds that the lease should continue before it is broken, between 0 and 60 seconds. |
LeaseDuration | Integer | Only allowed and required on an Acquire operation. Specifies the duration of the lease, in seconds, or negative one (-1) for a lease that never expires. A non-infinite lease can be between 15 and 60 seconds. A lease duration can't be changed by using renew or change. |
ProposedLeaseId | String | Optional for Acquire, and required for Change. Proposed lease ID, in a GUID string format. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
LeaseId | String | The ID of the lease. |
Success | String | Determines if the operation was successful or not. |
RefreshOAuthAccessToken¶
Refreshes the OAuth access token used for authentication with SharePoint.
Input¶
Name | Type | Description |
---|---|---|
OAuthRefreshToken | String | The old token to be refreshed. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
OAuthAccessToken | String | The authentication token returned from SharePoint. |
ExpiresIn | String | The remaining lifetime on the access token. |
RenameObject¶
Rename a file or a directory. Path and RenameTo are required for a successful operation.
Input¶
Name | Type | Description |
---|---|---|
Path | String | The path which will be renamed. |
RenameTo | String | The new name of the file/folder. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
Success | Boolean | Whether the operation completed successfully or not. |
SetFileSystemProperties¶
Set the properties for a filesystem. The name of the filesystem is required for a successful operation.
Input¶
Name | Type | Description |
---|---|---|
FileSystem | String | The name of the filesystem for which the properties will be set. |
Properties | String | User-defined properties to be stored with the filesystem, in the format of a comma-separated list of name and value pairs |
ETag | String | Unique identifier of the filesystem used to set a condition to perform the operation on the basis that it matches with the current value of the filesystem. Only one conditional parameter is allowed per operation. |
ModifiedSince | Datetime | A date and time value that sets condition to perform the operation only if the resource has been modified since the specified date and time. Only one conditional parameter is allowed per operation. |
UnmodifiedSince | Datetime | A date and time value that sets condition to perform the operation only if the resource has not been modified since the specified date and time. Only one conditional parameter is allowed per operation. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
Success | String | Determines if the operation was successful or not. |
ETag | String | Unique identifier of the filesystem. |
UploadFile¶
Upload a File. Path and FilePath are required for a successful operation.
Input¶
Name | Type | Description |
---|---|---|
Path | String | Set this to the path of the file where it will be uploaded. |
FilePath | String | Set this to the path of the file which will be uploaded. Example: C:/Users/User/Desktop/SampleUploadtest.txt. This parameter takes priority over others. |
FileContent | String | Base64 encoded content of the file to be added. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
Success | Boolean | Whether the operation completed successfully or not. |
System Tables¶
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 Azure Data Lake Storage:
- 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 connector can offload to the data source.
Query Information Tables¶
The following table returns query statistics for data modification queries:
- sys_identity: Returns information about batch operations or single updates.
sys_catalogs¶
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. |
sys_schemas¶
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. |
sys_tables¶
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. |
sys_tablecolumns¶
Describes the columns of the available tables and views.
The following query returns the columns and data types for the Resources table:
SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Resources'
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. |
sys_procedures¶
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. |
sys_procedureparameters¶
Describes stored procedure parameters.
The following query returns information about all of the input parameters for the DownloadFile stored procedure:
SELECT * FROM sys_procedureparameters WHERE ProcedureName='DownloadFile' AND Direction=1 OR Direction=2
Columns¶
Name | Type | Description |
---|---|---|
CatalogName | String | The name of the database containing the stored procedure. |
SchemaName | String | The name of the schema containing the stored procedure. |
ProcedureName | String | The name of the stored procedure containing the parameter. |
ColumnName | String | The name of the stored procedure parameter. |
Direction | Int32 | An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters. |
DataTypeName | String | The name of the data type. |
DataType | Int32 | An integer indicating the data type. This value is determined at run time based on the environment. |
Length | Int32 | The number of characters allowed for character data. The number of digits allowed for numeric data. |
NumericPrecision | Int32 | The maximum precision for numeric data. The column length in characters for character and date-time data. |
NumericScale | Int32 | The number of digits to the right of the decimal point in numeric data. |
IsNullable | Boolean | Whether the parameter can contain null. |
IsRequired | Boolean | Whether the parameter is required for execution of the procedure. |
IsArray | Boolean | Whether the parameter is an array. |
Description | String | The description of the parameter. |
Ordinal | Int32 | The index of the parameter. |
sys_keycolumns¶
Describes the primary and foreign keys.
The following query retrieves the primary key for the Resources table:
SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Resources'
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. |
sys_foreignkeys¶
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. |
sys_primarykeys¶
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. |
sys_indexes¶
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. |
sys_connection_props¶
Returns information on the available connection properties and those set in the connection string.
When querying this table, the config connection string should be used:
jdbc:cdata:adls:config:
This connection string enables you to query this table without a valid connection.
The following query retrieves all connection properties that have been set in the connection string or set through a default value:
SELECT * FROM sys_connection_props WHERE Value <> ''
Columns¶
Name | Type | Description |
---|---|---|
Name | String | The name of the connection property. |
ShortDescription | String | A brief description. |
Type | String | The data type of the connection property. |
Default | String | The default value if one is not explicitly set. |
Values | String | A comma-separated list of possible values. A validation error is thrown if another value is specified. |
Value | String | The value you set or a preconfigured default. |
Required | Boolean | Whether the property is required to connect. |
Category | String | The category of the connection property. |
IsSessionProperty | String | Whether the property is a session property, used to save information about the current connection. |
Sensitivity | String | The sensitivity level of the property. This informs whether the property is obfuscated in logging and authentication forms. |
PropertyName | String | A camel-cased truncated form of the connection property name. |
Ordinal | Int32 | The index of the parameter. |
CatOrdinal | Int32 | The index of the parameter category. |
Hierarchy | String | Shows dependent properties associated that need to be set alongside this one. |
Visible | Boolean | Informs whether the property is visible in the connection UI. |
ETC | String | Various miscellaneous information about the property. |
sys_sqlinfo¶
Describes the SELECT query processing that the connector can offload to the data source.
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 |
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 Data Sync version needed to access this driver. | Standard , Starter , Professional , Enterprise |
DATASYNCCATEGORY | The 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. |
sys_identity¶
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. |
Advanced Configurations Properties¶
The advanced configurations 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. Click the links for further details.
Property | Description |
---|---|
AuthScheme | The type of authentication to use when connecting to Azure Data Lake Storage. |
Account | This property specifies the name of the Azure Data Lake storage account. |
AccessKey | Your Azure DataLakeStorage Gen 2 storage account access key. |
FileSystem | This property specifies the name of the FileSystem which will be used in a Gen 2 storage account. For Example, the name of your Azure Blob container. |
SharedAccessSignature | A shared access key signature that may be used for authentication. |
Property | Description |
---|---|
Directory | This property specifies the root path of Azure Data Lake Storage to list files and folders. |
IncludeSubDirectories | Choose if the subdirectories paths should be listed in the Resources view in the ADLSGen2 Schema. |
Property | Description |
---|---|
AzureTenant | The Microsoft Online tenant being used to access data. If not specified, your default tenant is used. |
AzureEnvironment | The Azure Environment to use when establishing a connection. |
Property | Description |
---|---|
InitiateOAuth | Set this property to initiate the process to obtain or refresh the OAuth access token when you connect. |
OAuthClientId | The client ID assigned when you register your application with an OAuth authorization server. |
OAuthClientSecret | The client secret assigned when you register your application with an OAuth authorization server. |
OAuthAccessToken | The access token for connecting using OAuth. |
OAuthSettingsLocation | The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH. Alternatively, you can hold this location in memory by specifying a value starting with 'memory://' . |
OAuthSettingsLocation | The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH . Alternatively, you can hold this location in memory by specifying a value starting with 'memory://' . |
CallbackURL | The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings. |
OAuthGrantType | The grant type for the OAuth flow. |
OAuthVerifier | The verifier code returned from the OAuth authorization URL. |
OAuthRefreshToken | The OAuth refresh token for the corresponding OAuth access token. |
OAuthExpiresIn | The lifetime in seconds of the OAuth AccessToken. |
OAuthTokenTimestamp | The Unix epoch timestamp in milliseconds when the current Access Token was created. |
Property | Description |
---|---|
OAuthJWTCert | The JWT Certificate store. |
OAuthJWTCertType | The type of key store containing the JWT Certificate. |
OAuthJWTCertPassword | The password for the OAuth JWT certificate. |
OAuthJWTCertSubject | The subject of the OAuth JWT certificate. |
Property | Description |
---|---|
SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
Property | Description |
---|---|
Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA, SchemaB, SchemaC. |
Tables | This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA, TableB, TableC. |
Views | Restricts the views reported to a subset of the available tables. For example, Views=ViewA, ViewB, ViewC. |
Property | Description |
---|---|
ChunkSize | The size of chunks (in Mb) to use when uploading large files. |
MaxRows | Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses. |
MaxThreads | Specifies the number of concurrent requests. |
Other | These hidden properties are used only in specific use cases. |
PseudoColumns | This property indicates whether or not to include pseudo columns as columns to the table. |
Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
UserDefinedViews | A filepath pointing to the JSON configuration file containing your custom views. |
Authentication¶
This section provides a complete list of authentication properties you can configure.
Property | Description |
---|---|
AuthScheme | The type of authentication to use when connecting to Azure Data Lake Storage. |
Account | This property specifies the name of the Azure Data Lake storage account. |
AccessKey | Your Azure DataLakeStorage Gen 2 storage account access key. |
FileSystem | This property specifies the name of the FileSystem which will be used in a Gen 2 storage account. For Example, the name of your Azure Blob container. |
SharedAccessSignature | A shared access key signature that may be used for authentication. |
AuthScheme¶
The type of authentication to use when connecting to Azure Data Lake Storage.
Possible Values¶
AzureMSI
, Auto
, AccessKey
, AzureAD
, SAS
, AzureServicePrincipal
, AzureServicePrincipalCert
Data Type¶
string
Default Value¶
Auto
Remarks¶
- Auto: Lets the Azure Data Lake Storage connector determine what to do based on other connection properties.
- AzureAD: Set this to perform Azure Active Directory OAuth authentication.
- AzureServicePrincipal: Set this to authenticate as an Azure Service Principal.
- AzureServicePrincipalCert: Set this to authenticate as an Azure Service Principal using a Certificate.
- AzureMSI: Set this to automatically obtain Managed Service Identity credentials when running on an Azure VM.
- AccessKey: Set this to authenticate the calls to the API by setting the AccessKey to your Access Key. This is applicable only for the
ADLSGen2
Schema. - SAS: Set this to authenticate the calls to the API by setting the SharedAccessSignature to your Shared Access Signature (SAS). This is applicable only for the
ADLSGen2
Schema.
Account¶
This property specifies the name of the Azure Data Lake storage account.
Data Type¶
string
Default Value¶
""
Remarks¶
This property specifies the name of the Azure Data Lake storage account.
AccessKey¶
Your Azure DataLakeStorage Gen 2 storage account access key.
Data Type¶
string
Default Value¶
""
Remarks¶
Your Azure DataLakeStorage Gen 2 storage account access key. Use this only for Gen 2 authentication. You can retrieve it as follows:
- Sign into the azure portal with the credentials for your root account. (https://portal.azure.com/)
- Click on storage accounts and select the storage account you want to use.
- Under settings, click Access keys.
- Your storage account name and key will be displayed on that page.
FileSystem¶
This property specifies the name of the FileSystem which will be used in a Gen 2 storage account. For Example, the name of your Azure Blob container.
Data Type¶
string
Default Value¶
""
Remarks¶
This property specifies the name of the FileSystem which will be used in a Gen 2 storage account. For Example, the name of your Azure Blob container.
SharedAccessSignature¶
A shared access key signature that may be used for authentication.
Data Type¶
string
Default Value¶
""
Remarks¶
A shared access signature. May be used instead of a AccessKey to access resources.
Connection¶
This section provides a complete list of connection properties you can configure.
Property | Description |
---|---|
Directory | This property specifies the root path of Azure Data Lake Storage to list files and folders. |
IncludeSubDirectories | Choose if the subdirectories paths should be listed in the Resources view in the ADLSGen2 Schema. |
Directory¶
This property specifies the root path of Azure Data Lake Storage to list files and folders.
Data Type¶
string
Default Value¶
""
Remarks¶
This property specifies the root path of Azure Data Lake Storage to list files and folders.
IncludeSubDirectories¶
Choose if the subdirectories paths should be listed in the Resources view in the ADLSGen2 Schema.
Data Type¶
bool
Default Value¶
false
Remarks¶
Choose if the subdirectories paths should be listed in the Resources view in the ADLSGen2 Schema.
Azure Authentication¶
This section provides a complete list of Azure authentication properties you can configure.
Property | Description |
---|---|
AzureTenant | The Microsoft Online tenant being used to access data. If not specified, your default tenant is used. |
AzureEnvironment | The Azure Environment to use when establishing a connection. |
AzureTenant¶
The Microsoft Online tenant being used to access data. If not specified, your default tenant is used.
Data Type¶
string
Default Value¶
""
Remarks¶
The Microsoft Online tenant being used to access data. For instance, contoso.onmicrosoft.com. Alternatively, specify the tenant Id. This value is the directory ID in the Azure Portal > Azure Active Directory > Properties.
Typically it is not necessary to specify the Tenant. This can be automatically determined by Microsoft when using the OAuthGrantType set to CODE (default). However, it may fail in the case that the user belongs to multiple tenants. For instance, if an Admin of domain A invites a user of domain B to be a guest user. The user will now belong to both tenants. It is a good practice to specify the Tenant, although in general things should normally work without having to specify it.
The AzureTenant
is required when setting OAuthGrantType to CLIENT. When using client credentials, there is no user context. The credentials are taken from the context of the app itself. While Microsoft still allows client credentials to be obtained without specifying which Tenant, it has a much lower probability of picking the specific tenant you want to work with. For this reason, we require AzureTenant
to be explicitly stated for all client credentials connections to ensure you get credentials that are applicable for the domain you intend to connect to.
AzureEnvironment¶
The Azure Environment to use when establishing a connection.
Possible Values¶
GLOBAL
, CHINA
, USGOVT
, USGOVTDOD
Data Type¶
string
Default Value¶
GLOBAL
Remarks¶
In most cases, leaving the environment set to global will work. However, if your Azure Account has been added to a different environment, the AzureEnvironment
may be used to specify which environment. The available values are GLOBAL, CHINA, USGOVT, USGOVTDOD.
OAuth¶
This section provides a complete list of OAuth properties you can configure.
Property | Description |
---|---|
InitiateOAuth | Set this property to initiate the process to obtain or refresh the OAuth access token when you connect. |
OAuthClientId | The client ID assigned when you register your application with an OAuth authorization server. |
OAuthClientSecret | The client secret assigned when you register your application with an OAuth authorization server. |
OAuthAccessToken | The access token for connecting using OAuth. |
OAuthSettingsLocation | The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH. Alternatively, you can hold this location in memory by specifying a value starting with 'memory://' . |
OAuthSettingsLocation | The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH . Alternatively, you can hold this location in memory by specifying a value starting with 'memory://' . |
CallbackURL | The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings. |
OAuthGrantType | The grant type for the OAuth flow. |
OAuthVerifier | The verifier code returned from the OAuth authorization URL. |
OAuthRefreshToken | The OAuth refresh token for the corresponding OAuth access token. |
OAuthExpiresIn | The lifetime in seconds of the OAuth AccessToken. |
OAuthTokenTimestamp | The Unix epoch timestamp in milliseconds when the current Access Token was created. |
InitiateOAuth¶
Set this property to initiate the process to obtain or refresh the OAuth access token when you connect.
Possible Values¶
OFF
, GETANDREFRESH
, REFRESH
Data Type¶
string
Default Value¶
OFF
Remarks¶
The following options are available:
OFF
: Indicates that the OAuth flow will be handled entirely by the user. An OAuthAccessToken will be required to authenticate.GETANDREFRESH
: Indicates that the entire OAuth Flow will be handled by the connector. If no token currently exists, it will be obtained by prompting the user via the browser. If a token exists, it will be refreshed when applicable.REFRESH
: Indicates that the connector will only handle refreshing the OAuthAccessToken. The user will never be prompted by the connector to authenticate via the browser. The user must handle obtaining the OAuthAccessToken and OAuthRefreshToken initially.
OAuthClientId¶
The client ID assigned when you register your application with an OAuth authorization server.
Data Type¶
string
Default Value¶
""
Remarks¶
As part of registering an OAuth application, you will receive the OAuthClientId
value, sometimes also called a consumer key, and a client secret, the OAuthClientSecret.
OAuthClientSecret¶
The client secret assigned when you register your application with an OAuth authorization server.
Data Type¶
string
Default Value¶
""
Remarks¶
As part of registering an OAuth application, you will receive the OAuthClientId, also called a consumer key. You will also receive a client secret, also called a consumer secret. Set the client secret in the OAuthClientSecret
property.
OAuthAccessToken¶
The access token for connecting using OAuth.
Data Type¶
string
Default Value¶
""
Remarks¶
The OAuthAccessToken
property is used to connect using OAuth. The OAuthAccessToken
is retrieved from the OAuth server as part of the authentication process. It has a server-dependent timeout and can be reused between requests.
The access token is used in place of your user name and password. The access token protects your credentials by keeping them on the server.
OAuthSettingsLocation¶
The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH. Alternatively, you can hold this location in memory by specifying a value starting with 'memory://'
.
Data Type¶
string
Default Value¶
%APPDATA%\\CData\\Acumatica Data Provider\\OAuthSettings.txt
Remarks¶
When InitiateOAuth is set to GETANDREFRESH
or REFRESH
, the driver saves OAuth values to avoid requiring the user to manually enter OAuth connection properties and to allow the credentials to be shared across connections or processes.
Instead of specifying a file path, you can use memory storage. Memory locations are specified by using a value starting with 'memory://'
followed by a unique identifier for that set of credentials (for example, memory://user1). The identifier can be anything you choose but should be unique to the user. Unlike file-based storage, where credentials persist across connections, memory storage loads the credentials into static memory, and the credentials are shared between connections using the same identifier for the life of the process. To persist credentials outside the current process, you must manually store the credentials prior to closing the connection. This enables you to set them in the connection when the process is started again. You can retrieve OAuth property values with a query to the sys_connection_props
system table. If there are multiple connections using the same credentials, the properties are read from the previously closed connection.
The default location is "%APPDATA%\\CData\\Acumatica Data Provider\\OAuthSettings.txt" with %APPDATA%
set to the user's configuration directory. The default values are
- Windows: "
register://%DSN
" - Unix: "%AppData%..."
where DSN is the name of the current DSN used in the open connection.
The following table lists the value of %APPDATA%
by OS:
Platform | %APPDATA% |
---|---|
Windows | The value of the APPDATA environment variable |
Linux | ~/.config |
CallbackURL¶
The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings.
Data Type¶
string
Default Value¶
""
Remarks¶
During the authentication process, the OAuth authorization server redirects the user to this URL. This value must match the callback URL you specify in your app settings.
OAuthGrantType¶
The grant type for the OAuth flow.
Possible Values¶
CLIENT
, CODE
Data Type¶
string
Default Value¶
CLIENT
Remarks¶
The following options are available: CLIENT,CODE
OAuthVerifier¶
The verifier code returned from the OAuth authorization URL.
Data Type¶
string
Default Value¶
""
Remarks¶
The verifier code returned from the OAuth authorization URL. This can be used on systems where a browser cannot be launched such as headless systems.
Authentication on Headless Machines¶
See to obtain the OAuthVerifier
value.
Set OAuthSettingsLocation along with OAuthVerifier
. When you connect, the connector exchanges the OAuthVerifier
for the OAuth authentication tokens and saves them, encrypted, to the specified location. Set InitiateOAuth to GETANDREFRESH to automate the exchange.
Once the OAuth settings file has been generated, you can remove OAuthVerifier
from the connection properties and connect with OAuthSettingsLocation set.
To automatically refresh the OAuth token values, set OAuthSettingsLocation and additionally set InitiateOAuth to REFRESH.
OAuthRefreshToken¶
The OAuth refresh token for the corresponding OAuth access token.
Data Type¶
string
Default Value¶
""
Remarks¶
The OAuthRefreshToken
property is used to refresh the OAuthAccessToken when using OAuth authentication.
OAuthExpiresIn¶
The lifetime in seconds of the OAuth AccessToken.
Data Type¶
string
Default Value¶
""
Remarks¶
Pair with OAuthTokenTimestamp to determine when the AccessToken will expire.
OAuthTokenTimestamp¶
The Unix epoch timestamp in milliseconds when the current Access Token was created.
Data Type¶
string
Default Value¶
""
Remarks¶
Pair with OAuthExpiresIn to determine when the AccessToken will expire.
JWT OAuth¶
This section provides a complete list of JWT OAuth properties you can configure.
Property | Description |
---|---|
OAuthJWTCert | The JWT Certificate store. |
OAuthJWTCertType | The type of key store containing the JWT Certificate. |
OAuthJWTCertPassword | The password for the OAuth JWT certificate. |
OAuthJWTCertSubject | The subject of the OAuth JWT certificate. |
OAuthJWTCert¶
The JWT Certificate store.
Data Type¶
string
Default Value¶
""
Remarks¶
The name of the certificate store for the client certificate.
The OAuthJWTCertType field specifies the type of the certificate store specified by OAuthJWTCert
. If the store is password protected, specify the password in OAuthJWTCertPassword.
OAuthJWTCert
is used in conjunction with the OAuthJWTCertSubject
field in order to specify client certificates. If OAuthJWTCert
has a value, and OAuthJWTCertSubject is set, a search for a certificate is initiated. Please refer to the OAuthJWTCertSubject field for details.
Designations of certificate stores are platform-dependent.
The following are designations of the most common User and Machine certificate stores in Windows:
Property | Description |
---|---|
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
SPC | Software publisher certificates. |
In Java, the certificate store normally is a file containing certificates and optional private keys.
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).
OAuthJWTCertType¶
The type of key store containing the JWT Certificate.
Possible Values¶
USER
, MACHINE
, PFXFILE
, PFXBLOB
, JKSFILE
, JKSBLOB
, PEMKEY_FILE
, PEMKEY_BLOB
, PUBLIC_KEY_FILE
, PUBLIC_KEY_BLOB
, SSHPUBLIC_KEY_FILE
, SSHPUBLIC_KEY_BLOB
, P7BFILE
, PPKFILE
, XMLFILE
, XMLBLOB
Data Type¶
string
Default Value¶
USER
Remarks¶
This property can take one of the following values:
Property | Description |
---|---|
USER | For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: This store type is not available in Java. |
MACHINE | For Windows, this specifies that the certificate store is a machine store. Note: this store type is not available in Java. |
PFXFILE | The certificate store is the name of a PFX (PKCS12) file containing certificates. |
PFXBLOB | The certificate store is a string (base-64-encoded) representing a certificate store in PFX (PKCS12) format. |
JKSFILE | The certificate store is the name of a Java key store (JKS) file containing certificates. Note: this store type is only available in Java. |
JKSBLOB | The certificate store is a string (base-64-encoded) representing a certificate store in Java key store (JKS) format. Note: this store type is only available in Java. |
PEMKEY_FILE | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
PEMKEY_BLOB | The certificate store is a string (base64-encoded) that contains a private key and an optional certificate. |
PUBLIC_KEY_FILE | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
PUBLIC_KEY_BLOB | The certificate store is a string (base-64-encoded) that contains a PEM- or DER-encoded public key certificate. |
SSHPUBLIC_KEY_FILE | The certificate store is the name of a file that contains an SSH-style public key. |
SSHPUBLIC_KEY_BLOB | The certificate store is a string (base-64-encoded) that contains an SSH-style public key. |
P7BFILE | The certificate store is the name of a PKCS7 file containing certificates. |
PPKFILE | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
XMLFILE | The certificate store is the name of a file that contains a certificate in XML format. |
XMLBLOB | The certificate store is a string that contains a certificate in XML format. |
OAuthJWTCertPassword¶
The password for the OAuth JWT certificate.
Data Type¶
string
Default Value¶
""
Remarks¶
If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.
OAuthJWTCertSubject¶
The subject of the OAuth JWT certificate.
Data Type¶
string
Default Value¶
*
Remarks¶
When loading a certificate the subject is used to locate the certificate in the store.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks the first certificate in the certificate store.
The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, E=example@jbexample.com". Common fields and their meanings are displayed below.
Field | Meaning |
---|---|
CN | Common Name. This is commonly a host name like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma it must be quoted.
SSL¶
This section provides a complete list of SSL properties you can configure.
Property | Description |
---|---|
SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
SSLServerCert¶
The certificate to be accepted from the server when connecting using TLS/SSL.
Data Type¶
string
Default Value¶
""
Remarks¶
If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.
This property can take the following forms:
Description | Example |
---|---|
A full PEM Certificate (example shortened for brevity) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
A path to a local file containing the certificate | C:\\cert.cer |
The public key (example shortened for brevity) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
The MD5 Thumbprint (hex values can also be either space or colon separated) | ecadbdda5a1529c58a1e9e09828d70e4 |
The SHA1 Thumbprint (hex values can also be either space or colon separated) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
If not specified, any certificate trusted by the machine is accepted.
Certificates are validated as trusted by the machine based on the System's trust store. The trust store used is the 'javax.net.ssl.trustStore' value specified for the system. If no value is specified for this property, Java's default trust store is used (for example, JAVA_HOME\lib\security\cacerts).
Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.
Schema¶
This section provides a complete list of schema properties you can configure.
Property | Description |
---|---|
Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA, SchemaB, SchemaC. |
Tables | This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA, TableB, TableC. |
Views | Restricts the views reported to a subset of the available tables. For example, Views=ViewA, ViewB, ViewC. |
Location¶
A path to the directory that contains the schema files defining tables, views, and stored procedures.
Data Type¶
string
Default Value¶
%APPDATA%\ADLS Data Provider\Schema
Remarks¶
The path to a directory which contains the schema files for the connector (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location
property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) or extend the data model with new tables, views, or stored procedures.
Note
Given that this connector supports multiple schemas, the structure for Azure Data Lake Storage custom schema files is as follows:
- Each schema is given a folder corresponding to that schema name.
- These schema folders are contained in a parent folder.
- The
parent folder
should be set as theLocation
, not an individual schema's folder.
If left unspecified, the default location is "%APPDATA%\ADLS Data Provider\Schema" with %APPDATA%
being set to the user's configuration directory:
Platform | %APPDATA% |
---|---|
Windows | The value of the APPDATA environment variable |
Mac | ~/Library/Application Support |
Linux | ~/.config |
BrowsableSchemas¶
This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Data Type¶
string
Default Value¶
""
Remarks¶
Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.
Tables¶
This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Data Type¶
string
Default Value¶
""
Remarks¶
Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the connector.
This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.
Specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.
Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.
Views¶
Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.
Data Type¶
string
Default Value¶
""
Remarks¶
Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the connector.
This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.
Specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.
Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.
Miscellaneous¶
This section provides a complete list of miscellaneous properties you can configure.
Property | Description |
---|---|
ChunkSize | The size of chunks (in Mb) to use when uploading large files. |
MaxRows | Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses. |
MaxThreads | Specifies the number of concurrent requests. |
Other | These hidden properties are used only in specific use cases. |
PseudoColumns | This property indicates whether or not to include pseudo columns as columns to the table. |
Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
UserDefinedViews | A filepath pointing to the JSON configuration file containing your custom views. |
ChunkSize¶
The size of chunks (in Mb) to use when uploading large files.
Data Type¶
int
Default Value¶
64
Remarks¶
The size of chunks (in Mb) to use when uploading large files.
MaxRows¶
Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
Data Type¶
int
Default Value¶
-1
Remarks¶
Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
MaxThreads¶
Specifies the number of concurrent requests.
Data Type¶
string
Default Value¶
5
Remarks¶
This property allows you to issue multiple requests simultaneously, thereby improving performance.
Other¶
These hidden properties are used only in specific use cases.
Data Type¶
string
Default Value¶
""
Remarks¶
The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.
Specify multiple properties in a semicolon-separated list.
Integration and Formatting¶
Property | Description |
---|---|
DefaultColumnSize | Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000. |
ConvertDateTimeToGMT | Determines whether to convert date-time values to GMT, instead of the local time of the machine. |
RecordToFile=filename | Records the underlying socket data transfer to the specified file. |
PseudoColumns¶
This property indicates whether or not to include pseudo columns as columns to the table.
Data Type¶
string
Default Value¶
""
Remarks¶
This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".
Timeout¶
The value in seconds until the timeout error is thrown, canceling the operation.
Data Type¶
int
Default Value¶
60
Remarks¶
If Timeout
= 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.
If Timeout
expires and the operation is not yet complete, the connector throws an exception.
UserDefinedViews¶
A filepath pointing to the JSON configuration file containing your custom views.
Data Type¶
string
Default Value¶
""
Remarks¶
User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json
. The connector automatically detects the views specified in this file.
You can also have multiple view definitions and control them using the UserDefinedViews
connection property. When you use this property, only the specified views are seen by the connector.
This User Defined View configuration file is formatted as follows:
- Each root element defines the name of a view.
- Each root element contains a child element, called
query
, which contains the custom SQL query for the view.
For example:
{
"MyView": {
"query": "SELECT * FROM Resources WHERE MyColumn = 'value'"
},
"MyView2": {
"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
}
}
Use the UserDefinedViews
connection property to specify the location of your JSON configuration file. For example:
"UserDefinedViews", C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json
Note that the specified path is not embedded in quotation marks.