Microsoft OneDrive Connection Details¶
Introduction¶
Connector Version
This documentation is based on version 23.0.8804 of the connector.
Get Started¶
Microsoft OneDrive Version Support
Microsoft OneDrive and OneDrive for Business accounts are supported via the Microsoft Graph API v1.0.
Establish a Connection¶
Connect to Microsoft OneDrive¶
Authenticate using Azure Service Principal¶
Azure Service Principal is a connection type that goes through OAuth. Set your AuthScheme
to AzureServicePrincipal
and see Using Azure Service Principal Authentication for an authentication guide.
Use Azure Service Principal¶
Azure Service Principal¶
Azure Service Principal is role-based application-based authentication. This means that authentication is done per application, rather than per user. All tasks taken 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.
To use Azure Service Principal authentication, you must:
-
Set up the ability to assign a role to the authentication application. To do this, create a custom OAuth AD application, as described in
Creating a Custom OAuth Application¶
Microsoft OneDrive 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
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 Microsoft OneDrive 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, Microsoft OneDrive 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 the Microsoft Graph API and then add the delegated permissions Files.ReadWrite.All or Files.Read.All. Hit the 'Grant admin consent' button afterwards for the new permissions to take effect.
- Save your changes.
- If you have specified the use of permissions that require admin consent, 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
. Microsoft OneDrive 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.
.
-
Register an application with an Azure AD tenant, to create a new service principal that can be used with the role-based access control, to access resources in your subscription.
Do the following:
-
Create a custom Azure AD application, as described in
Creating a Custom OAuth Application¶
Microsoft OneDrive 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
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 Microsoft OneDrive 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, Microsoft OneDrive 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 the Microsoft Graph API and then add the delegated permissions Files.ReadWrite.All or Files.Read.All. Hit the 'Grant admin consent' button afterwards for the new permissions to take effect.
- Save your changes.
- If you have specified the use of permissions that require admin consent, 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
. Microsoft OneDrive 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.
.
-
Assign a role to the application:
- 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
. Microsoft OneDrive opens theAdd role assignment
page. - Assign your custom Azure AD application the role of
Owner
.
Admin Consent¶
Admin consent occurs when the Admin for an Azure Active Directory tenant grants permissions to a custom application that explicitly requires an admin to consent to the use case.
When creating a new Azure AD application in the Azure Portal, you must specify which permissions the application requires. Some permissions may be marked as "Admin Consent Required". For example, all Groups permissions require Admin Consent. If your application requires admin consent, there are two ways you can do this.
The easiest way to grant admin consent is to have an admin log into portal.azure.com
and navigate to the application you have created in App Registrations. Under API Permissions
, click Grant Consent
. This gives your application permissions on the tenant under which it was created.
If your organization has multiple tenants or you must grant application permissions for other tenants outside your organization, use the GetAdminConsentURL stored procedure to generate the Admin Authorization URL. Unlike the GetOAuthAuthorizationURL stored procedure, no important information is returned from this endpoint. Rather, after the OAuth application is successfully authorized, it returns a Boolean indicating that permissions have been granted.
After the administrator has approved the OAuth Application, you can continue to authenticate.
Create a Custom OAuth Application¶
Create a Custom OAuth Application¶
Microsoft OneDrive 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
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 Microsoft OneDrive 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, Microsoft OneDrive 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 the Microsoft Graph API and then add the delegated permissions Files.ReadWrite.All or Files.Read.All. Hit the 'Grant admin consent' button afterwards for the new permissions to take effect.
- Save your changes.
- If you have specified the use of permissions that require admin consent, 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
. Microsoft OneDrive 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.
Fine-Tuning Data Access¶
Fine-tune Data Access¶
DirectoryRetrievalDepth
: How many folders deep you want to get results for Folders, Files, SharedResources, and Permissions tables.DriveId
: The ID of the Drive that you want to use when getting data for tables Files, Folders, SharedResources, and Permissions.ListGroupDrives
: Indicates if you would like to list your group drives or not when querying the Drives table. Useful if you're using a OneDrive for Business account.
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 Microsoft OneDrive 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 Microsoft OneDrive and then processes the rest of the query in memory (client-side).
User Defined Views¶
The Microsoft OneDrive 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 Files 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¶
The connector models the Microsoft OneDrive API as relational tables. Any changes to the remote data are immediately reflected in your queries; the table definitions are dynamically retrieved. When you connect, the connector connects to Microsoft OneDrive and gets the list of tables and the metadata for the tables by calling the appropriate Web services.
Key Features
- The connector models Microsoft OneDrive entities like Files and Folders as relational views, allowing you to write SQL to query Microsoft OneDrive data.
- Stored procedures allow you to execute operations to Microsoft OneDrive, including retrieving the access token and keeping it refreshed in OAuth 2.0.
- Live connectivity to these objects means any changes to your Microsoft OneDrive account are immediately reflected when using the connector.
Views
Views shows definitions from a sample OneDrive site. The actual data model
will be obtained dynamically based on your user credentials and site.
Stored Procedures
Stored Procedures are function-like interfaces to OneDrive. They can be used to search, update and modify information in OneDrive.
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.
Microsoft OneDrive Connector Views¶
Name | Description |
---|---|
Drives | The OneDrive view Drives, which lists all the drives the user has access to. |
Files | The OneDrive table Files in which you can view all the files in a drive. |
FileVersions | The OneDrive table Files in which you can view all the files in a drive. |
Folders | The OneDrive table Folders, which shows all the folders on a drive. |
Permissions | The OneDrive table Permissions, which shows all the permissions given to a resource of the drive. |
SharedResources | The OneDrive table SharedResources, which shows all the shared resources on a drive. |
Users | The OneDrive table Users in which an admin user can view the users details. |
Drives¶
The OneDrive view Drives, which lists all the drives the user has access to.
Table Specific Information¶
Due to API limitations, all operators on this view are executed client-side.
Columns¶
Name | Type | References | Description |
---|---|---|---|
driveType | String | ||
owner_application_displayName | String | ||
owner_application_id | String | ||
quota_deleted | Long | ||
quota_remaining | Long | ||
quota_state | String | ||
quota_storagePlanInformation_upgradeAvailable | Bool | ||
quota_total | Long | ||
quota_used | Long | ||
sharePointIds_listId | String | ||
sharePointIds_listItemId | String | ||
sharePointIds_listItemUniqueId | String | ||
sharePointIds_siteId | String | ||
sharePointIds_siteUrl | String | ||
sharePointIds_tenantId | String | ||
sharePointIds_webId | String | ||
Linkedfollowing | String | ||
Linkeditems | String | ||
Linkedlist | String | ||
Linkedroot | String | ||
Linkedspecial | String | ||
ParentReference | String | ||
Id [KEY] | String | ||
Name | String | ||
Description | String | ||
owner_user_id | String |
Files¶
The OneDrive table Files in which you can view all the files in a drive.
Table Specific Information¶
Projection is done server-side. Also, queries that include the primary key ID and IN are executed server-side, e.g.:
SELECT Id, Name, audio_album, audio_title FROM Files WHERE ID IN ('B1E6BJ084A9133KB1!101', 'APF9D2K6WFA524Y')
Include ParentReference_DriveId and ParentReference_Id in the where clause to get the result for a particular folder, e.g.:
SELECT * FROM Files WHERE ParentReference_DriveId = 'b!3Yqza-5FJ0usfhyH-2QafkQpf0OC0jlNh8LAETWPK6dNROPDScevTKbV-drnCFHV' And ParentReference_id = '01QFG2V52Z62HOXS5F6RHIHVT36T3Q5GKH'
File listing is done recursively via the DirectoryRetrievalDepth
property. This property's default value is 5, which means it will get data only for the first 6 levels of the 'Drive' you've chosen (because the first level is located in DirectoryRetrievalDepth=0).
You can specify the value -1 to get all the files in the 'Drive' no matter the depth they're located in.
While files may be listed in this view, the contents of the files may be worked with by using stored procedures such as:
- CopyResource - Copy a file/folder from one directory in your drive to another.
- DeleteResource - Delete a file/folder from your drive.
- DownloadFile - Download an existing file from your drive.
- MoveResource - Move a file/folder from one directory in your drive to another.
- UploadFile - Upload a new file or update content to an existing file.
Columns¶
Name | Type | References | Description |
---|---|---|---|
id [KEY] | String | ||
Etag | String | ||
createdBy_user_id | String | ||
createdBy_user_displayName | String | ||
lastModifiedBy_user_id | String | ||
lastModifiedBy_user_displayName | String | ||
ResourceType | String | ||
createdBy_application_displayName | String | ||
createdBy_application_id | String | ||
createdDateTime | Datetime | ||
description | String | ||
lastModifiedBy_application_displayName | String | ||
lastModifiedBy_application_id | String | ||
lastModifiedDateTime | Datetime | ||
name | String | ||
parentReference_driveId | String | ||
parentReference_driveType | String | ||
parentReference_id | String | Folders.Id | |
parentReference_name | String | ||
parentReference_path | String | ||
parentReference_shareId | String | ||
parentReference_sharepointIds_listId | String | ||
parentReference_sharepointIds_listItemId | String | ||
parentReference_sharepointIds_listItemUniqueId | String | ||
parentReference_sharepointIds_siteId | String | ||
parentReference_sharepointIds_siteUrl | String | ||
parentReference_sharepointIds_tenantId | String | ||
parentReference_sharepointIds_webId | String | ||
parentReference_siteId | String | ||
webUrl | String | ||
LinkedcreatedByUser | String | ||
LinkedlastModifiedByUser | String | ||
audio_album | String | ||
audio_albumArtist | String | ||
audio_artist | String | ||
audio_bitrate | Long | ||
audio_composers | String | ||
audio_copyright | String | ||
audio_disc | Int | ||
audio_discCount | Int | ||
audio_duration | Long | ||
audio_genre | String | ||
audio_hasDrm | Bool | ||
audio_isVariableBitrate | Bool | ||
audio_title | String | ||
audio_track | Int | ||
audio_trackCount | Int | ||
audio_year | Int | ||
content | String | ||
cTag | String | ||
deleted_state | String | ||
file_hashes_crc32Hash | String | ||
file_hashes_quickXorHash | String | ||
file_hashes_sha1Hash | String | ||
file_hashes_sha256Hash | String | ||
file_mimeType | String | ||
file_processingMetadata | Bool | ||
fileSystemInfo_createdDateTime | Datetime | ||
fileSystemInfo_lastAccessedDateTime | Datetime | ||
fileSystemInfo_lastModifiedDateTime | Datetime | ||
folder_childCount | Int | ||
folder_view_sortBy | String | ||
folder_view_sortOrder | String | ||
folder_view_viewType | String | ||
image_height | Int | ||
image_width | Int | ||
location_altitude | Double | ||
location_latitude | Double | ||
location_longitude | Double | ||
package_type | String | ||
pendingOperations_pendingContentUpdate_queuedDateTime | Datetime | ||
photo_cameraMake | String | ||
photo_cameraModel | String | ||
photo_exposureDenominator | Double | ||
photo_exposureNumerator | Double | ||
photo_fNumber | Double | ||
photo_focalLength | Double | ||
photo_iso | Int | ||
photo_orientation | Int | ||
photo_takenDateTime | Datetime | ||
publication_level | String | ||
publication_versionId | String | ||
remoteItem_createdBy_application_displayName | String | ||
remoteItem_createdBy_application_id | String | ||
remoteItem_createdDateTime | Datetime | ||
remoteItem_file_hashes_crc32Hash | String | ||
remoteItem_file_hashes_quickXorHash | String | ||
remoteItem_file_hashes_sha1Hash | String | ||
remoteItem_file_hashes_sha256Hash | String | ||
remoteItem_file_mimeType | String | ||
remoteItem_file_processingMetadata | Bool | ||
remoteItem_fileSystemInfo_createdDateTime | Datetime | ||
remoteItem_fileSystemInfo_lastAccessedDateTime | Datetime | ||
remoteItem_fileSystemInfo_lastModifiedDateTime | Datetime | ||
remoteItem_folder_childCount | Int | ||
remoteItem_folder_view_sortBy | String | ||
remoteItem_folder_view_sortOrder | String | ||
remoteItem_folder_view_viewType | String | ||
remoteItem_id | String | ||
remoteItem_image_height | Int | ||
remoteItem_image_width | Int | ||
remoteItem_lastModifiedDateTime | Datetime | ||
remoteItem_name | String | ||
remoteItem_package_type | String | ||
remoteItem_parentReference_driveId | String | ||
remoteItem_parentReference_driveType | String | ||
remoteItem_parentReference_id | String | ||
remoteItem_parentReference_name | String | ||
remoteItem_parentReference_path | String | ||
remoteItem_parentReference_shareId | String | ||
remoteItem_parentReference_sharepointIds_listId | String | ||
remoteItem_parentReference_sharepointIds_listItemId | String | ||
remoteItem_parentReference_sharepointIds_listItemUniqueId | String | ||
remoteItem_parentReference_sharepointIds_siteId | String | ||
remoteItem_parentReference_sharepointIds_siteUrl | String | ||
remoteItem_parentReference_sharepointIds_tenantId | String | ||
remoteItem_parentReference_sharepointIds_webId | String | ||
remoteItem_parentReference_siteId | String | ||
remoteItem_shared_scope | String | ||
remoteItem_shared_sharedDateTime | Datetime | ||
remoteItem_size | Long | ||
remoteItem_specialFolder_name | String | ||
remoteItem_video_audioBitsPerSample | Int | ||
remoteItem_video_audioChannels | Int | ||
remoteItem_video_audioFormat | String | ||
remoteItem_video_audioSamplesPerSecond | Int | ||
remoteItem_video_bitrate | Int | ||
remoteItem_video_duration | Long | ||
remoteItem_video_fourCC | String | ||
remoteItem_video_frameRate | Double | ||
remoteItem_video_height | Int | ||
remoteItem_video_width | Int | ||
remoteItem_webDavUrl | String | ||
remoteItem_webUrl | String | ||
searchResult_onClickTelemetryUrl | String | ||
shared_owner_application_displayName | String | ||
shared_owner_application_id | String | ||
shared_scope | String | ||
shared_sharedDateTime | Datetime | ||
sharepointIds_listId | String | ||
sharepointIds_listItemId | String | ||
sharepointIds_listItemUniqueId | String | ||
sharepointIds_siteId | String | ||
sharepointIds_siteUrl | String | ||
sharepointIds_tenantId | String | ||
sharepointIds_webId | String | ||
size | Long | ||
specialFolder_name | String | ||
video_audioBitsPerSample | Int | ||
video_audioChannels | Int | ||
video_audioFormat | String | ||
video_audioSamplesPerSecond | Int | ||
video_bitrate | Int | ||
video_duration | Long | ||
video_fourCC | String | ||
video_frameRate | Double | ||
video_height | Int | ||
video_width | Int | ||
webDavUrl | String | ||
Linkedanalytics | String | ||
Linkedchildren | String | ||
LinkedlistItem | String | ||
Linkedpermissions | String | ||
Linkedsubscriptions | String | ||
Linkedthumbnails | String | ||
Linkedversions | String | ||
Linkedworkbook | String |
FileVersions¶
The OneDrive table Files in which you can view all the files in a drive.
Table Specific Information¶
SELECT¶
The connector will use the Microsoft OneDrive API to process WHERE clause conditions built with the following column and operator.
FileId
supports the '='.DriveId
supports the '='.UserId
supports the '='.
For example:
SELECT * FROM FileVersions WHERE FileId = '01CYQN2MFPR6NIWVZNMNFL3SL4E3KF7IHY' AND DriveId = 'b!GrEGWax2VE-ssnJNr1E8llqoLptvK-BGjFRpceFzFg5Nwp9Bw2xbR62J0NAouP6z'
SELECT * FROM FileVersions WHERE FileId = '01CYQN2MFPR6NIWVZNMNFL3SL4E3KF7IHY' AND createdBy_user_id = '472df319-2978-49d4-9445-9e7019def16f'
Columns¶
Name | Type | References | Description |
---|---|---|---|
FileId [KEY] | String | ||
lastModifiedBy_user_displayName | String | ||
lastModifiedBy_user_id | String | ||
lastModifiedDateTime | Datetime | ||
size | Long | ||
id | String | ||
lastModifiedBy_user_email | String | ||
DriveId | String | ||
publication_level | String | ||
createdBy_user_id | String |
Folders¶
The OneDrive table Folders, which shows all the folders on a drive.
Table Specific Information¶
Note: See CreateFolder to create a folder.
Projection is done server-side. Also, queries that include the primary key ID and IN are executed server-side, e.g.:
SELECT Id, Name, Size, Description FROM Folders WHERE ID IN ('B1E6BJ084A9133KB1!122', 'APF9D2K6WFAAPX9')
Folder listing is done recursively via the DirectoryRetrievalDepth
property. This property's default value is 5, which means it will get data only for the first 6 levels of the 'Drive' you've chosen (because the first level is located in DirectoryRetrievalDepth=0).
You can specify the value -1 to get all the folders in the 'Drive' no matter the depth they're located in.
While folders may be listed in this view, the contents of the folders may be worked with by using stored procedures such as:
- CopyResource - Copy a file/folder from one directory in your drive to another.
- DeleteResource - Delete a file/folder from your drive.
- MoveResource - Move a file/folder from one directory in your drive to another.
Columns¶
Name | Type | References | Description |
---|---|---|---|
id [KEY] | String | ||
Etag | String | ||
createdBy_user_id | String | ||
createdBy_user_displayName | String | ||
lastModifiedBy_user_id | String | ||
lastModifiedBy_user_displayName | String | ||
createdBy_application_displayName | String | ||
createdBy_application_id | String | ||
createdDateTime | Datetime | ||
description | String | ||
lastModifiedBy_application_displayName | String | ||
lastModifiedBy_application_id | String | ||
lastModifiedDateTime | Datetime | ||
name | String | ||
parentReference_driveId | String | ||
parentReference_driveType | String | ||
parentReference_id | String | ||
parentReference_name | String | ||
parentReference_path | String | ||
parentReference_shareId | String | ||
parentReference_sharepointIds_listId | String | ||
parentReference_sharepointIds_listItemId | String | ||
parentReference_sharepointIds_listItemUniqueId | String | ||
parentReference_sharepointIds_siteId | String | ||
parentReference_sharepointIds_siteUrl | String | ||
parentReference_sharepointIds_tenantId | String | ||
parentReference_sharepointIds_webId | String | ||
parentReference_siteId | String | ||
webUrl | String | ||
LinkedcreatedByUser | String | ||
LinkedlastModifiedByUser | String | ||
audio_album | String | ||
audio_albumArtist | String | ||
audio_artist | String | ||
audio_bitrate | Long | ||
audio_composers | String | ||
audio_copyright | String | ||
audio_disc | Int | ||
audio_discCount | Int | ||
audio_duration | Long | ||
audio_genre | String | ||
audio_hasDrm | Bool | ||
audio_isVariableBitrate | Bool | ||
audio_title | String | ||
audio_track | Int | ||
audio_trackCount | Int | ||
audio_year | Int | ||
content | String | ||
cTag | String | ||
deleted_state | String | ||
file_hashes_crc32Hash | String | ||
file_hashes_quickXorHash | String | ||
file_hashes_sha1Hash | String | ||
file_hashes_sha256Hash | String | ||
file_mimeType | String | ||
file_processingMetadata | Bool | ||
fileSystemInfo_createdDateTime | Datetime | ||
fileSystemInfo_lastAccessedDateTime | Datetime | ||
fileSystemInfo_lastModifiedDateTime | Datetime | ||
folder_childCount | Int | ||
folder_view_sortBy | String | ||
folder_view_sortOrder | String | ||
folder_view_viewType | String | ||
image_height | Int | ||
image_width | Int | ||
location_altitude | Double | ||
location_latitude | Double | ||
location_longitude | Double | ||
package_type | String | ||
pendingOperations_pendingContentUpdate_queuedDateTime | Datetime | ||
photo_cameraMake | String | ||
photo_cameraModel | String | ||
photo_exposureDenominator | Double | ||
photo_exposureNumerator | Double | ||
photo_fNumber | Double | ||
photo_focalLength | Double | ||
photo_iso | Int | ||
photo_orientation | Int | ||
photo_takenDateTime | Datetime | ||
publication_level | String | ||
publication_versionId | String | ||
remoteItem_createdBy_application_displayName | String | ||
remoteItem_createdBy_application_id | String | ||
remoteItem_createdDateTime | Datetime | ||
remoteItem_file_hashes_crc32Hash | String | ||
remoteItem_file_hashes_quickXorHash | String | ||
remoteItem_file_hashes_sha1Hash | String | ||
remoteItem_file_hashes_sha256Hash | String | ||
remoteItem_file_mimeType | String | ||
remoteItem_file_processingMetadata | Bool | ||
remoteItem_fileSystemInfo_createdDateTime | Datetime | ||
remoteItem_fileSystemInfo_lastAccessedDateTime | Datetime | ||
remoteItem_fileSystemInfo_lastModifiedDateTime | Datetime | ||
remoteItem_folder_childCount | Int | ||
remoteItem_folder_view_sortBy | String | ||
remoteItem_folder_view_sortOrder | String | ||
remoteItem_folder_view_viewType | String | ||
remoteItem_id | String | ||
remoteItem_image_height | Int | ||
remoteItem_image_width | Int | ||
remoteItem_lastModifiedDateTime | Datetime | ||
remoteItem_name | String | ||
remoteItem_package_type | String | ||
remoteItem_parentReference_driveId | String | ||
remoteItem_parentReference_driveType | String | ||
remoteItem_parentReference_id | String | ||
remoteItem_parentReference_name | String | ||
remoteItem_parentReference_path | String | ||
remoteItem_parentReference_shareId | String | ||
remoteItem_parentReference_sharepointIds_listId | String | ||
remoteItem_parentReference_sharepointIds_listItemId | String | ||
remoteItem_parentReference_sharepointIds_listItemUniqueId | String | ||
remoteItem_parentReference_sharepointIds_siteId | String | ||
remoteItem_parentReference_sharepointIds_siteUrl | String | ||
remoteItem_parentReference_sharepointIds_tenantId | String | ||
remoteItem_parentReference_sharepointIds_webId | String | ||
remoteItem_parentReference_siteId | String | ||
remoteItem_shared_scope | String | ||
remoteItem_shared_sharedDateTime | Datetime | ||
remoteItem_size | Long | ||
remoteItem_specialFolder_name | String | ||
remoteItem_video_audioBitsPerSample | Int | ||
remoteItem_video_audioChannels | Int | ||
remoteItem_video_audioFormat | String | ||
remoteItem_video_audioSamplesPerSecond | Int | ||
remoteItem_video_bitrate | Int | ||
remoteItem_video_duration | Long | ||
remoteItem_video_fourCC | String | ||
remoteItem_video_frameRate | Double | ||
remoteItem_video_height | Int | ||
remoteItem_video_width | Int | ||
remoteItem_webDavUrl | String | ||
remoteItem_webUrl | String | ||
searchResult_onClickTelemetryUrl | String | ||
shared_owner_application_displayName | String | ||
shared_owner_application_id | String | ||
shared_scope | String | ||
shared_sharedDateTime | Datetime | ||
sharepointIds_listId | String | ||
sharepointIds_listItemId | String | ||
sharepointIds_listItemUniqueId | String | ||
sharepointIds_siteId | String | ||
sharepointIds_siteUrl | String | ||
sharepointIds_tenantId | String | ||
sharepointIds_webId | String | ||
size | Long | ||
specialFolder_name | String | ||
video_audioBitsPerSample | Int | ||
video_audioChannels | Int | ||
video_audioFormat | String | ||
video_audioSamplesPerSecond | Int | ||
video_bitrate | Int | ||
video_duration | Long | ||
video_fourCC | String | ||
video_frameRate | Double | ||
video_height | Int | ||
video_width | Int | ||
webDavUrl | String | ||
Linkedanalytics | String | ||
Linkedchildren | String | ||
LinkedlistItem | String | ||
Linkedpermissions | String | ||
Linkedsubscriptions | String | ||
Linkedthumbnails | String | ||
Linkedversions | String | ||
Linkedworkbook | String |
Permissions¶
The OneDrive table Permissions, which shows all the permissions given to a resource of the drive.
Table Specific Information¶
Due to API limitations, all operators on this view are executed client-side.
Columns¶
Name | Type | References | Description |
---|---|---|---|
id [KEY] | String | ||
Etag | String | ||
ResourceId [KEY] | String | ||
grantedTo_user_displayName | String | ||
grantedTo_user_email | String | ||
grantedTo_user_id | String | ||
expirationDateTime | Datetime | ||
grantedTo_application_displayName | String | ||
grantedTo_application_id | String | ||
grantedToIdentities | String | ||
hasPassword | Bool | ||
inheritedFrom_driveId | String | ||
inheritedFrom_driveType | String | ||
inheritedFrom_id | String | ||
inheritedFrom_name | String | ||
inheritedFrom_path | String | ||
inheritedFrom_shareId | String | ||
inheritedFrom_sharepointIds_listId | String | ||
inheritedFrom_sharepointIds_listItemId | String | ||
inheritedFrom_sharepointIds_listItemUniqueId | String | ||
inheritedFrom_sharepointIds_siteId | String | ||
inheritedFrom_sharepointIds_siteUrl | String | ||
inheritedFrom_sharepointIds_tenantId | String | ||
inheritedFrom_sharepointIds_webId | String | ||
inheritedFrom_siteId | String | ||
invitation_email | String | ||
invitation_invitedBy_application_displayName | String | ||
invitation_invitedBy_application_id | String | ||
invitation_redeemedBy | String | ||
invitation_signInRequired | Bool | ||
link_application_displayName | String | ||
link_application_id | String | ||
link_preventsDownload | Bool | ||
link_scope | String | ||
link_type | String | ||
link_webHtml | String | ||
link_webUrl | String | ||
roles | String | ||
shareId | String |
SharedResources¶
The OneDrive table SharedResources, which shows all the shared resources on a drive.
Table Specific Information¶
Projection is done server-side. Also, queries that include the primary key ID and IN are executed server-side, e.g.:
SELECT Id, Name, Size, Shared_Scope FROM SharedResources WHERE ID IN ('B1E6BJ084A9133KB1!122', 'APF9D2K6WFAAPX9')
SharedResources listing is done recursively via the DirectoryRetrievalDepth
property. This property's default value is 5, which means it will get data only for the first 6 levels of the 'Drive' you've chosen (because the first level is located in DirectoryRetrievalDepth=0).
You can specify the value -1 to get all the shared resources in the 'Drive' no matter the depth they're located in.
Columns¶
Name | Type | References | Description |
---|---|---|---|
id [KEY] | String | ||
Etag | String | ||
createdBy_user_id | String | ||
createdBy_user_displayName | String | ||
lastModifiedBy_user_id | String | ||
lastModifiedBy_user_displayName | String | ||
createdBy_application_displayName | String | ||
createdBy_application_id | String | ||
createdDateTime | Datetime | ||
description | String | ||
lastModifiedBy_application_displayName | String | ||
lastModifiedBy_application_id | String | ||
lastModifiedDateTime | Datetime | ||
name | String | ||
parentReference_driveId | String | ||
parentReference_driveType | String | ||
parentReference_id | String | ||
parentReference_name | String | ||
parentReference_path | String | ||
parentReference_shareId | String | ||
parentReference_sharepointIds_listId | String | ||
parentReference_sharepointIds_listItemId | String | ||
parentReference_sharepointIds_listItemUniqueId | String | ||
parentReference_sharepointIds_siteId | String | ||
parentReference_sharepointIds_siteUrl | String | ||
parentReference_sharepointIds_tenantId | String | ||
parentReference_sharepointIds_webId | String | ||
parentReference_siteId | String | ||
webUrl | String | ||
LinkedcreatedByUser | String | ||
LinkedlastModifiedByUser | String | ||
audio_album | String | ||
audio_albumArtist | String | ||
audio_artist | String | ||
audio_bitrate | Long | ||
audio_composers | String | ||
audio_copyright | String | ||
audio_disc | Int | ||
audio_discCount | Int | ||
audio_duration | Long | ||
audio_genre | String | ||
audio_hasDrm | Bool | ||
audio_isVariableBitrate | Bool | ||
audio_title | String | ||
audio_track | Int | ||
audio_trackCount | Int | ||
audio_year | Int | ||
content | String | ||
cTag | String | ||
deleted_state | String | ||
file_hashes_crc32Hash | String | ||
file_hashes_quickXorHash | String | ||
file_hashes_sha1Hash | String | ||
file_hashes_sha256Hash | String | ||
file_mimeType | String | ||
file_processingMetadata | Bool | ||
fileSystemInfo_createdDateTime | Datetime | ||
fileSystemInfo_lastAccessedDateTime | Datetime | ||
fileSystemInfo_lastModifiedDateTime | Datetime | ||
folder_childCount | Int | ||
folder_view_sortBy | String | ||
folder_view_sortOrder | String | ||
folder_view_viewType | String | ||
image_height | Int | ||
image_width | Int | ||
location_altitude | Double | ||
location_latitude | Double | ||
location_longitude | Double | ||
package_type | String | ||
pendingOperations_pendingContentUpdate_queuedDateTime | Datetime | ||
photo_cameraMake | String | ||
photo_cameraModel | String | ||
photo_exposureDenominator | Double | ||
photo_exposureNumerator | Double | ||
photo_fNumber | Double | ||
photo_focalLength | Double | ||
photo_iso | Int | ||
photo_orientation | Int | ||
photo_takenDateTime | Datetime | ||
publication_level | String | ||
publication_versionId | String | ||
remoteItem_createdBy_application_displayName | String | ||
remoteItem_createdBy_application_id | String | ||
remoteItem_createdDateTime | Datetime | ||
remoteItem_file_hashes_crc32Hash | String | ||
remoteItem_file_hashes_quickXorHash | String | ||
remoteItem_file_hashes_sha1Hash | String | ||
remoteItem_file_hashes_sha256Hash | String | ||
remoteItem_file_mimeType | String | ||
remoteItem_file_processingMetadata | Bool | ||
remoteItem_fileSystemInfo_createdDateTime | Datetime | ||
remoteItem_fileSystemInfo_lastAccessedDateTime | Datetime | ||
remoteItem_fileSystemInfo_lastModifiedDateTime | Datetime | ||
remoteItem_folder_childCount | Int | ||
remoteItem_folder_view_sortBy | String | ||
remoteItem_folder_view_sortOrder | String | ||
remoteItem_folder_view_viewType | String | ||
remoteItem_id | String | ||
remoteItem_image_height | Int | ||
remoteItem_image_width | Int | ||
remoteItem_lastModifiedDateTime | Datetime | ||
remoteItem_name | String | ||
remoteItem_package_type | String | ||
remoteItem_parentReference_driveId | String | ||
remoteItem_parentReference_driveType | String | ||
remoteItem_parentReference_id | String | ||
remoteItem_parentReference_name | String | ||
remoteItem_parentReference_path | String | ||
remoteItem_parentReference_shareId | String | ||
remoteItem_parentReference_sharepointIds_listId | String | ||
remoteItem_parentReference_sharepointIds_listItemId | String | ||
remoteItem_parentReference_sharepointIds_listItemUniqueId | String | ||
remoteItem_parentReference_sharepointIds_siteId | String | ||
remoteItem_parentReference_sharepointIds_siteUrl | String | ||
remoteItem_parentReference_sharepointIds_tenantId | String | ||
remoteItem_parentReference_sharepointIds_webId | String | ||
remoteItem_parentReference_siteId | String | ||
remoteItem_shared_scope | String | ||
remoteItem_shared_sharedDateTime | Datetime | ||
remoteItem_size | Long | ||
remoteItem_specialFolder_name | String | ||
remoteItem_video_audioBitsPerSample | Int | ||
remoteItem_video_audioChannels | Int | ||
remoteItem_video_audioFormat | String | ||
remoteItem_video_audioSamplesPerSecond | Int | ||
remoteItem_video_bitrate | Int | ||
remoteItem_video_duration | Long | ||
remoteItem_video_fourCC | String | ||
remoteItem_video_frameRate | Double | ||
remoteItem_video_height | Int | ||
remoteItem_video_width | Int | ||
remoteItem_webDavUrl | String | ||
remoteItem_webUrl | String | ||
searchResult_onClickTelemetryUrl | String | ||
shared_owner_application_displayName | String | ||
shared_owner_application_id | String | ||
shared_scope | String | ||
shared_sharedDateTime | Datetime | ||
sharepointIds_listId | String | ||
sharepointIds_listItemId | String | ||
sharepointIds_listItemUniqueId | String | ||
sharepointIds_siteId | String | ||
sharepointIds_siteUrl | String | ||
sharepointIds_tenantId | String | ||
sharepointIds_webId | String | ||
size | Long | ||
specialFolder_name | String | ||
video_audioBitsPerSample | Int | ||
video_audioChannels | Int | ||
video_audioFormat | String | ||
video_audioSamplesPerSecond | Int | ||
video_bitrate | Int | ||
video_duration | Long | ||
video_fourCC | String | ||
video_frameRate | Double | ||
video_height | Int | ||
video_width | Int | ||
webDavUrl | String | ||
Linkedanalytics | String | ||
Linkedchildren | String | ||
LinkedlistItem | String | ||
Linkedpermissions | String | ||
Linkedsubscriptions | String | ||
Linkedthumbnails | String | ||
Linkedversions | String | ||
Linkedworkbook | String |
Users¶
The OneDrive table Users in which an admin user can view the users details.
Users Information¶
Projection is done server-side. Basic select query is supported e.g.:
SELECT * FROM Users
Using this view an admin user can list all other users details.
Columns¶
Name | Type | References | Description |
---|---|---|---|
id [KEY] | String | ||
deletedDateTime | Datetime | ||
accountEnabled | Bool | ||
businessPhones | String | ||
city | String | ||
companyName | String | ||
country | String | ||
createdDateTime | Datetime | ||
department | String | ||
displayName | String | ||
employeeHireDate | Datetime | ||
employeeId | String | ||
employeeOrgData_costCenter | String | ||
employeeOrgData_division | String | ||
employeeType | String | ||
givenName | String | ||
identities | String | ||
imAddresses | String | ||
isResourceAccount | Bool | ||
jobTitle | String | ||
lastPasswordChangeDateTime | Datetime | ||
mail | String | ||
mailNickname | String | ||
mobilePhone | String | ||
officeLocation | String | ||
onPremisesDistinguishedName | String | ||
onPremisesDomainName | String | ||
onPremisesExtensionAttributes_extensionAttribute1 | String | ||
onPremisesExtensionAttributes_extensionAttribute10 | String | ||
onPremisesExtensionAttributes_extensionAttribute11 | String | ||
onPremisesExtensionAttributes_extensionAttribute12 | String | ||
onPremisesExtensionAttributes_extensionAttribute13 | String | ||
onPremisesExtensionAttributes_extensionAttribute14 | String | ||
onPremisesExtensionAttributes_extensionAttribute15 | String | ||
onPremisesExtensionAttributes_extensionAttribute2 | String | ||
onPremisesExtensionAttributes_extensionAttribute3 | String | ||
onPremisesExtensionAttributes_extensionAttribute4 | String | ||
onPremisesExtensionAttributes_extensionAttribute5 | String | ||
onPremisesExtensionAttributes_extensionAttribute6 | String | ||
onPremisesExtensionAttributes_extensionAttribute7 | String | ||
onPremisesExtensionAttributes_extensionAttribute8 | String | ||
onPremisesExtensionAttributes_extensionAttribute9 | String | ||
onPremisesImmutableId | String | ||
onPremisesLastSyncDateTime | Datetime | ||
onPremisesProvisioningErrors | String | ||
onPremisesSamAccountName | String | ||
onPremisesSecurityIdentifier | String | ||
onPremisesSyncEnabled | Bool | ||
onPremisesUserPrincipalName | String | ||
otherMails | String | ||
postalCode | String | ||
preferredLanguage | String | ||
state | String | ||
streetAddress | String | ||
surname | String | ||
userPrincipalName | String | ||
userType | String |
Stored Procedures¶
Stored procedures are function-like interfaces that extend the functionality of the connector beyond simple SELECT operations with Microsoft OneDrive.
Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Microsoft OneDrive, along with an indication of whether the procedure succeeded or failed.
Microsoft OneDrive Connector Stored Procedures¶
Name | Description |
---|---|
CopyResource | Copy a resource from one directory in your drive to another. |
CreateFolder | Create a new folder in your drive. |
CreateSubscription | Subscribes a listener application to receive notifications when data changes. |
DeleteResource | Delete a resource from your drive. |
DeleteSubscription | Subscribes a listener application to receive notifications when data changes. |
DownloadFile | Download an existing file from your drive. |
FetchAdditionalUserFields | Fetch all T1, T2, and T3 fields for a specified user. |
GetAdminConsentURL | Gets the admin consent URL that must be opened separately by an admin of a given domain to grant access to your application. Only needed when using custom OAuth credentials. |
GetOAuthAccessToken | Gets an authentication token from OneDrive. |
GetOAuthAuthorizationURL | Gets the authorization URL that must be opened separately by the user to grant access to your application. Only needed when developing Web apps. You will request the auth token from this URL. |
ModifySubscription | Subscribes a listener application to receive notifications when data changes. |
MoveResource | Move a resource from one directory in your drive to another. |
RefreshOAuthAccessToken | Refreshes the OAuth access token used for authentication with various Office 365 services. |
RenameResource | Rename files from your drive. |
UploadFile | Upload a new file or update content to an existing file. |
CopyResource¶
Copy a resource from one directory in your drive to another.
Input¶
Name | Type | Required | Description |
---|---|---|---|
ParentID | String | True | The ID of the folder you want to copy the resource to. |
NewName | String | False | The new name of the copied resource. If not specified, the resource will be copied with the same name it already has and to the directory it currently is, no matter the value of ParentID. |
ResourcePath | String | False | The location of the resource. |
ResourceId | String | False | ID of the resource. |
SourceDriveId | String | False | The ID of the drive the resource is located in if this is different from the current user drive. |
DestinationDriveId | String | False | The ID of the drive to copy the resource to, if this is different from the SourceDriveId. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
Success | String | File copy results. |
CreateFolder¶
Create a new folder in your drive.
Input¶
Name | Type | Required | Description |
---|---|---|---|
FolderName | String | True | Name of the folder to be created. |
RenameIfExists | String | False | Set this to 'true' when you want to rename the folder when another folder with the same name exists. |
ParentId | String | False | ID of the folder where you want the new folder to be created. |
DriveId | String | False | The ID of the drive the resource is located in if this is different from the currrent user drive. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
Id | String | ID of the Foler created. |
CreateSubscription¶
Subscribes a listener application to receive notifications when data changes.
Input¶
Name | Type | Required | Description |
---|---|---|---|
ChangeType | String | True | Indicates the type of change in the subscribed resource that will raise a change notification. The supported values are: created, updated, deleted. Multiple values can be combined using a comma-separated list. |
NotificationUrl | String | True | The URL of the endpoint that will receive the change notifications. This URL must make use of the HTTPS protocol. |
Resource | String | True | Specifies the resource that will be monitored for changes. Do not include the base URL (https://graph.microsoft.com/v1.0/). |
ExpirationDateTime | String | False | The date and time in UTC that the subscription will expire. Consult the Microsoft documentation for the maximum duration of each endpoint type https://docs.microsoft.com/en-us/graph/api/resources/subscription?view=graph-rest-1.0. |
ClientState | String | False | Specifies the value of the clientState property sent by the service in each change notification. The maximum length is 128 characters. The client can check that the change notification came from the service by comparing the value of the clientState property sent with the subscription with the value of the clientState property received with each change notification. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
Id | String | ID of the subscription created. |
DeleteResource¶
Delete a resource from your drive.
Input¶
Name | Type | Required | Description |
---|---|---|---|
ResourcePath | String | False | The location of the resource. |
ResourceId | String | False | ID of the resource. |
DriveId | String | False | The ID of the drive the resource is located in if this is different from the current user drive. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
Success | String | File delete results. |
DeleteSubscription¶
Subscribes a listener application to receive notifications when data changes.
Input¶
Name | Type | Required | Description |
---|---|---|---|
Id | String | True | ID of the subscription created. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
Success | String | Subscription delete results. |
DownloadFile¶
Download an existing file from your drive.
Input¶
Name | Type | Required | Accepts Output Streams | Description |
---|---|---|---|---|
ResourcePath | String | False | False | The location of the resource. |
ResourceId | String | False | False | The ID of the resource to be downloaded. |
DriveId | String | False | False | The ID of the drive the resource is located in if this is different from the currrent user drive. |
LocalFile | String | False | False | The local file path including the file name for the location where the file will be saved on disk. Leave empty to keep the file in memory. |
Encoding | String | False | False | If the LocalFile input is left empty, the data will be output to FileData in the specified encoding. The allowed values are NONE, BASE64. The default value is BASE64. |
Overwrite | String | False | False | What to do when downloaded file exists. Set true to overwrite. |
FileStream | String | False | True | An instance of an output stream where file data is written to. Only used if DownloadPath is not provided. |
Version | String | False | False | Mention the version of the file except for the latest. |
UserId | String | False | False | The ID of the user who created the file. Mention only if version is given |
Result Set Columns¶
Name | Type | Description |
---|---|---|
FileData | String | If the LocalFile input is empty, file data will be output in the format specified by the Encoding input. |
Success | String | File download results. |
FetchAdditionalUserFields¶
Fetch all T1, T2, and T3 fields for a specified user.
Input¶
Name | Type | Required | Description |
---|---|---|---|
UserId | String | True | The unique identifier of the user. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
\* | String | Results of the query: all the fields of the User object. |
GetAdminConsentURL¶
Gets the admin consent URL that must be opened separately by an admin of a given domain to grant access to your application. Only needed when using custom OAuth credentials.
Input¶
Name | Type | Required | Description |
---|---|---|---|
CallbackUrl | String | False | The URL the user will be redirected to after authorizing your application. This value must match the Reply URL in the Azure AD app settings. |
State | String | False | The same value for state that you sent when you requested the authorization code. |
Scope | String | False | A space-separated list of scopes to request from the Admin. The default value is https://graph.microsoft.com/files.readwrite.all. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
URL | String | The authorization URL, entered into a Web browser to obtain the verifier token and authorize your app. |
GetOAuthAccessToken¶
Gets an authentication token from OneDrive.
Input¶
Name | Type | Required | Description |
---|---|---|---|
AuthMode | String | False | The type of authentication mode to use. Select App for getting authentication tokens via a desktop app. Select Web for getting authentication tokens via a Web app. The allowed values are APP, WEB. The default value is APP. |
CallbackUrl | String | False | The URL the user will be redirected to after authorizing your application. This value must match the Reply URL you have specified in the Azure AD app settings. |
Verifier | String | False | The verifier returned from Azure AD after the user has authorized your app to have access to their data. This value will be returned as a parameter to the callback URL. |
Scope | String | False | A space-separated list of scopes to request from the user when OAuthGrantType='CODE'. When OAuthGrantType='CLIENT', a scope of 'https://graph.microsoft.com/.default' is used. '/.default' picks up whatever permissions your app already has. The default value is offline_access https://graph.microsoft.com/files.readwrite.all. |
State | String | False | An arbitrary string of your choosing that is returned to your app; a successful roundtrip of this string helps ensure that your app initiated the request. |
Prompt | String | False | Defaults to 'select_account' which prompts the user to select account while authenticating. Set to 'None', for no prompt, 'login' to force user to enter their credentials or 'consent' to trigger the OAuth consent dialog after the user signs in, asking the user to grant permissions to the app. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
OAuthAccessToken | String | The access token used for communication with OneDrive. |
ExpiresIn | String | The remaining lifetime on the access token. A -1 denotes that it will not expire. |
OAuthRefreshToken | String | Refresh token to renew the access token. |
GetOAuthAuthorizationURL¶
Gets the authorization URL that must be opened separately by the user to grant access to your application. Only needed when developing Web apps. You will request the auth token from this URL.
Input¶
Name | Type | Required | Description |
---|---|---|---|
CallbackUrl | String | False | The URL the user will be redirected to after authorizing your application. This value must match the Reply URL in the Azure AD app settings. |
State | String | False | The same value for state that you sent when you requested the authorization code. |
Scope | String | False | A space-separated list of scopes to request from the user when OAuthGrantType='CODE'. When OAuthGrantType='CLIENT', a scope of 'https://graph.microsoft.com/.default' is used. '/.default' picks up whatever permissions your app already has. The default value is offline_access https://graph.microsoft.com/files.readwrite.all. |
Prompt | String | False | Defaults to 'select_account' which prompts the user to select account while authenticating. Set to 'None', for no prompt, 'login' to force user to enter their credentials or 'consent' to trigger the OAuth consent dialog after the user signs in, asking the user to grant permissions to the app. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
URL | String | The authorization URL, entered into a Web browser to obtain the verifier token and authorize your app. |
ModifySubscription¶
Subscribes a listener application to receive notifications when data changes.
Input¶
Name | Type | Required | Description |
---|---|---|---|
ExpirationDateTime | String | True | The date and time in UTC that the subscription will expire. |
Id | String | True | ID of the subscription created. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
Id | String | ID of the subscription created. |
ChangeType | String | Name of the folder to be created. |
NotificationUrl | String | The Webhook endpoint which you want to be subscribed to. |
Resource | String | The path of the resource for the subscription details. |
ExpirationDateTime | String | The date and time in UTC that the subscription will expire. |
ClientState | String | Encoded string that contains the view and control states data of the Web page |
MoveResource¶
Move a resource from one directory in your drive to another.
Input¶
Name | Type | Required | Description |
---|---|---|---|
DestinationID | String | True | The ID of the folder you want to move the resource to. |
ResourcePath | String | False | The location of the resource. |
ResourceId | String | False | ID of the resource. |
DriveId | String | False | The ID of the drive the resource is located in if this is different from the current user drive. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
Success | String | File moving results. |
RefreshOAuthAccessToken¶
Refreshes the OAuth access token used for authentication with various Office 365 services.
Input¶
Name | Type | Required | Description |
---|---|---|---|
OAuthRefreshToken | String | True | The refresh token returned from the original authorization code exchange. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
OAuthAccessToken | String | The authentication token returned from Azure AD. This can be used in subsequent calls to other operations for this particular service. |
OAuthRefreshToken | String | A token that may be used to obtain a new access token. |
ExpiresIn | String | The remaining lifetime on the access token. |
RenameResource¶
Rename files from your drive.
Input¶
Name | Type | Required | Description |
---|---|---|---|
ResourceId | String | True | ID of the resource. |
Name | String | True | The new name of the resource. |
DriveId | String | False | The ID of the drive the resource is located in, if this is different from the current user drive. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
Success | String | File rename results. |
UploadFile¶
Upload a new file or update content to an existing file.
Input¶
Name | Type | Required | Accepts Input Streams | Description |
---|---|---|---|---|
ParentId | String | True | False | At what parent to upload the file. |
DriveId | String | False | False | The ID of the drive to upload the file to if this is different from the currrent user drive. |
FileName | String | True | False | Name of the file you'll upload content to. |
Content | String | False | False | File content to be uploaded. |
LocalFile | String | False | False | Local file containing the content to be uploaded. |
ContentStream | String | False | True | File content to be uploaded. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
Success | String | File upload results. |
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 Microsoft OneDrive:
- 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 Files table:
SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Files'
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 DownloadResource stored procedure:
SELECT * FROM sys_procedureparameters WHERE ProcedureName='DownloadResource' 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 Files table:
SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Files'
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:onedrive: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. |
Data Type Mapping¶
Data Type Mappings¶
The connector maps types from the data source to the corresponding data type available in the schema. The table below documents these mappings.
Microsoft OneDrive (OData V4) | Schema |
---|---|
Edm.Binary | binary |
Edm.Boolean | bool |
Edm.Date | datetime |
Edm.DateTimeOffset | datetime |
Edm.Decimal | decimal |
Edm.Double | double |
Edm.Guid | guid |
Edm.Int32 | int |
Edm.String | string |
Edm.TimeOfDay | time |
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 Microsoft OneDrive. |
Property | Description |
---|---|
AzureTenant | The Microsoft Online tenant being used to access data. If not specified, your default tentant will be 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. |
OAuthGrantType | The grant type for the OAuth flow. |
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 |
---|---|
DirectoryRetrievalDepth | Specify how many folders deep you want to get results for Folders, Files, SharedResources, and Permissions tables. The resources directly in the root are located at depth 0. The resources one folder deeper are located at depth 1 and so on. You can specify a value of -1 to get all data in a drive no matter the depth they're in. |
DriveId | The ID of the Drive that you want to use. |
ListGroupDrives | Choose whether to list your group drives or not when querying Drives table. |
MaxRows | Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time. |
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. |
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 Microsoft OneDrive. |
AuthScheme¶
The type of authentication to use when connecting to Microsoft OneDrive. Currently, only AzureServicePrincipal
is supported
Possible Values¶
AzureServicePrincipal
Data Type¶
string
Default Value¶
AzureServicePrincipal
Remarks¶
- AzureServicePrincipal: Set this to authenticate as an Azure Service Principal.
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 tentant will be used.
Data Type¶
string
Default Value¶
""
Remarks¶
The Microsoft Online tenant being used to access data. For instance, "example.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. |
OAuthGrantType | The grant type for the OAuth flow. |
InitiateOAuth¶
Set this property to initiate the process to obtain or refresh the OAuth access token when you connect.
Possible Values¶
GETANDREFRESH
Data Type¶
string
Default Value¶
GETANDREFRESH
Remarks¶
The following option is supported:
GETANDREFRESH
: Indicates that the entire OAuth Flow will be handled by the connector. If no token currently exists, it will be obtained. If a token exists, it will be refreshed when applicable.
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 client secret, also called a consumer secret. Set the client secret as the OAuthClientSecret
property.
You will also receive an OAuthClientId, also called a consumer key.
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.
OAuthGrantType¶
The grant type for the OAuth flow.
Possible Values¶
CLIENT
Data Type¶
string
Default Value¶
CLIENT
Remarks¶
The grant type for the OAuth flow. Only the CLIENT
option is supported.
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.
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.
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%\OneDrive 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.
If left unspecified, the default location is "%APPDATA%\OneDrive 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 |
---|---|
DirectoryRetrievalDepth | Specify how many folders deep you want to get results for Folders, Files, SharedResources and Permissions tables. The resources directly in the root are located at depth 0. The resources one folder deeper are located at depth 1 and so on. You can specify the value -1 to get all the data in a drive no matter the depth they're in. |
DriveId | The ID of the Drive that you want to use. |
IncludeFoldersWithFiles | Choose whether you want to include Folders in the Files view. |
ListGroupDrives | Choose whether to list your group drives or not when querying Drives table. |
MaxRows | Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses. |
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. |
DirectoryRetrievalDepth¶
Specify how many folders deep you want to get results for Folders, Files, SharedResources, and Permissions tables. The resources directly in the root are located at depth 0. The resources one folder deeper are located at depth 1 and so on. You can specify a value of -1 to get all data in a drive no matter the depth they're in.
Data Type¶
string
Default Value¶
5
Remarks¶
This property must be set in the connection string or the driver will use a default of DirectoryRetrievalDepth=5.
DriveId¶
The ID of the Drive that you want to use.
Data Type¶
string
Default Value¶
""
Remarks¶
By default the provider will use the main drive of the logged-in user.
You can find out all possible DriveIDs by querying "Drives" table.
IncludeFoldersWithFiles¶
Choose whether you want to include Folders in the Files view.
Data Type¶
bool
Default Value¶
false
Remarks¶
By default, the folders are not displayed in the Files view. Set this property to true to include Folders in the Files view. You can differentiate between Files and Folders using the ResourceType Column.
ListGroupDrives¶
Choose whether to list your group drives or not when querying Drives table.
Data Type¶
bool
Default Value¶
false
Remarks¶
By default the provider will only show the user's drives.
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.
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 Files 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.