Cloud

Build 25.0.9539
  • Microsoft OneDrive
    • Getting Started
      • Establishing a Connection
      • Fine-Tuning Data Access
      • SSL Configuration
      • Firewall and Proxy
    • Data Model
      • Views
        • Drives
        • Files
        • FileVersions
        • Folders
        • GroupMembers
        • Groups
        • Permissions
        • SharedResources
        • SharedWithMeResources
        • Users
      • Stored Procedures
        • CopyResource
        • CreateFolder
        • CreateSubscription
        • DeleteResource
        • DeleteSubscription
        • FetchAdditionalUserFields
        • GetAdminConsentURL
        • ModifySubscription
        • MoveResource
        • RenameResource
      • System Tables
        • sys_catalogs
        • sys_schemas
        • sys_tables
        • sys_tablecolumns
        • sys_procedures
        • sys_procedureparameters
        • sys_keycolumns
        • sys_foreignkeys
        • sys_primarykeys
        • sys_indexes
        • sys_connection_props
        • sys_sqlinfo
        • sys_identity
        • sys_information
      • Data Type Mapping
    • Connection String Options
      • Authentication
        • AuthScheme
      • Azure Authentication
        • AzureTenant
        • AzureEnvironment
      • OAuth
        • OAuthClientId
        • OAuthClientSecret
        • Scope
      • JWT OAuth
        • OAuthJWTCert
        • OAuthJWTCertType
        • OAuthJWTCertPassword
        • OAuthJWTCertSubject
      • SSL
        • SSLServerCert
      • Logging
        • Verbosity
      • Schema
        • BrowsableSchemas
      • Miscellaneous
        • DefaultGroups
        • DefaultUser
        • DirectoryRetrievalDepth
        • DriveId
        • GroupId
        • IncludeFoldersWithFiles
        • ListGroupDrives
        • MaxRows
        • Pagesize
        • PseudoColumns
        • ThrowsKeyNotFound
        • Timeout
        • UserId
    • Third Party Copyrights

Microsoft OneDrive - CData Cloud

Overview

CData Cloud offers access to Microsoft OneDrive across several standard services and protocols, in a cloud-hosted solution. Any application that can connect to a SQL Server database can connect to Microsoft OneDrive through CData Cloud.

CData Cloud allows you to standardize and configure connections to Microsoft OneDrive as though it were any other OData endpoint or standard SQL Server.

Key Features

  • Full SQL Support: Microsoft OneDrive appears as standard relational databases, allowing you to perform operations - Filter, Group, Join, etc. - using standard SQL, regardless of whether these operations are supported by the underlying API.
  • CRUD Support: Both read and write operations are supported, restricted only by security settings that you can configure in Cloud or downstream in the source itself.
  • Secure Access: The administrator can create users and define their access to specific databases and read-only operations or grant full read & write privileges.
  • Comprehensive Data Model & Dynamic Discovery: CData Cloud provides comprehensive access to all of the data exposed in the underlying data source, including full access to dynamic data and easily searchable metadata.

CData Cloud

Getting Started

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

Connecting to Microsoft OneDrive

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

Accessing Data from CData Cloud Services

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

CData Cloud

Establishing a Connection

Connect to Microsoft OneDrive by selecting the corresponding icon in the Database tab. Required properties are listed under Settings. The Advanced tab lists connection properties that are not typically required.

Authenticating to Microsoft OneDrive

Microsoft OneDrive uses the OAuth authentication standard. To authenticate using OAuth, you will need to create an app to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL connection properties.

Entra ID (Azure AD)

Note: Microsoft has rebranded Azure AD as Entra ID. In topics that require the user to interact with the Entra ID Admin site, we use the same names Microsoft does. However, there are still CData connection properties whose names or values reference "Azure AD".

Microsoft Entra ID is a multi-tenant, cloud-based identity and access management platform. It supports OAuth-based authentication flows that enable the driver to access Microsoft OneDrive endpoints securely.

Authentication to Entra ID via a web application always requires that you first create and register a custom OAuth application. This enables your application to define its own redirect URI, manage credential scope, and comply with organization-specific security policies.

For full instructions on how to create and register a custom OAuth application, see Creating an Entra ID (Azure AD) Application.

After setting AuthScheme to AzureAD, the steps to authenticate vary, depending on the environment. For details on how to connect from desktop applications, web-based workflows, or headless systems, see the following sections.

Azure Service Principal

The authentication as an Azure Service Principal is handled via the OAuth Client Credentials flow. It does not involve direct user authentication. Instead, credentials are created for just the application itself. All tasks taken by the application are done without a default user context, but based on the assigned roles. The application access to the resources is controlled through the assigned roles' permissions.

Create an AzureAD App and an Azure Service Principal

When authenticating using an Azure Service Principal, you must create and register an Azure AD application with an Azure AD tenant. See Creating an Entra ID (Azure AD) Application for more details.

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

Assign a role to the application

To access resources in your subscription, you must assign a role to the application.

  1. Open the Subscriptions page by searching and selecting the Subscriptions service from the search bar.
  2. Select the subscription to assign the application to.
  3. Open the Access control (IAM) and select Add > Add role assignment to open the Add role assignment page.
  4. Select Owner as the role to assign to your created Azure AD app.
Complete the Authentication Choose whether to use a client secret or a certificate and follow the relevant steps below.

Client Secret

Set these connection properties:

  • AuthScheme: AzureServicePrincipal to use a client secret.
  • InitiateOAuth: GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
  • AzureTenant: The tenant you want to connect to.
  • OAuthClientId: The client Id in your application settings.
  • OAuthClientSecret: The client secret in your application settings.

Certificate

Set these connection properties:

  • AuthScheme: AzureServicePrincipalCert to use a certificate.
  • InitiateOAuth: GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
  • AzureTenant: The tenant you want to connect to.
  • OAuthJWTCert: The JWT Certificate store.
  • OAuthJWTCertType: The type of the certificate store specified by OAuthJWTCert.

You are now ready to connect. Authentication with client credentials takes place automatically like any other connection, except there is no window opened prompting the user. Because there is no user context, there is no need for a browser popup. Connections take place and are handled internally.

Managed Service Identity (MSI)

If you are running Microsoft OneDrive on an Azure VM and want to automatically obtain Managed Service Identity (MSI) credentials to connect, set AuthScheme to AzureMSI.

User-Managed Identities

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

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

CData Cloud

Fine-Tuning Data Access

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

CData Cloud

SSL Configuration

Customizing the SSL Configuration

By default, the Cloud attempts to negotiate TLS with the server. The server certificate is validated against the default system trusted certificate store. You can override how the certificate gets validated using the SSLServerCert connection property.

To specify another certificate, see the SSLServerCert connection property.

CData Cloud

Firewall and Proxy

Connecting Through a Firewall or Proxy

HTTP Proxies

To authenticate to an HTTP proxy, set the following:

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

Other Proxies

Set the following properties:

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

CData Cloud

Data Model

The CData Cloud models Microsoft OneDrive objects as an easy-to-use SQL database, using views and stored procedures. These are defined in schema files, which are simple, easy-to-read text files that define the structure and organization of data. Because the table definitions are dynamically retrieved, any changes to the remote data are immediately reflected in your queries.

Views

The Views section, which lists read-only SQL tables, contains samples from an example OneDrive site. Your data model is obtained dynamically based on your user credentials and OneDrive site.

The sample site includes the following views:

View Description
Drives Displays all OneDrive drives accessible to the current user, including personal and shared drives
Files Provides detailed information about individual files stored in OneDrive drives, including name, size, and metadata.
FileVersions Tracks the version history of each file in OneDrive, allowing review or rollback of previous file states.
Folders Lists all folders within a OneDrive drive, useful for navigation and hierarchical organization analysis.
GroupMembers Displays a list of users assigned to each group, helping manage team or access group memberships.
Groups Shows all security and distribution groups within the connected Microsoft 365 tenant, enabling administrative oversight.
Permissions Details sharing and access permissions for files and folders within a OneDrive drive, identifying owners and collaborators.
SharedResources Identifies all files and folders that have been shared from OneDrive, along with recipients and access levels.
SharedWithMeResources Lists files and folders that have been shared with the signed-in user by others, including metadata such as the owner, sharing permissions, and access details.
Users Lists users with OneDrive accounts in the organization, including user identifiers and profile details.

Stored Procedures

Stored Procedures are SQL scripts that extend beyond standard CRUD operations. They can be used to search, update, and modify information in OneDrive.

CData Cloud

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.

CData Cloud - Microsoft OneDrive Views

Name Description
Drives Displays all OneDrive drives accessible to the current user, including personal and shared drives.
Files Provides detailed information about individual files stored in OneDrive drives, including name, size, and metadata.
FileVersions Tracks the version history of each file in OneDrive, allowing review or rollback of previous file states.
Folders Lists all folders within a OneDrive drive, useful for navigation and hierarchical organization analysis.
GroupMembers Lists the members of the group.
Groups Shows all security and distribution groups within the connected Microsoft 365 tenant, enabling administrative oversight.
Permissions Details sharing and access permissions for files and folders within a OneDrive drive, identifying owners and collaborators.
SharedResources Identifies all files and folders that have been shared from OneDrive, along with recipients and access levels.
SharedWithMeResources Lists files and folders that have been shared with the signed-in user by others, including metadata such as the owner, sharing permissions, and access details.
Users Lists users with OneDrive accounts in the organization, including user identifiers and profile details.

CData Cloud

Drives

Displays all OneDrive drives accessible to the current user, including personal and shared drives.

Table Specific Information

UserId and GroupId connection properties can also be used to filter records. If both are included in the connection string, UserId will take precedence over GroupId.

Due to API limitations, all operators on this view are executed client-side.

Columns

Name Type References Description
driveType String Specifies the classification of the OneDrive drive, such as personal, business, or documentLibrary.
owner_application_displayName String The human-readable name of the application that owns or created the drive.
owner_application_id String The unique ID assigned to the application that owns or manages the drive.
quota_deleted Long The total number of bytes used by deleted items that are still retained in the recycle bin or recovery folder.
quota_remaining Long The total number of bytes still available for use in the drive's allocated storage limit.
quota_state String The current status of the drive's storage capacity, such as normal, nearing, or exceeded.
quota_storagePlanInformation_upgradeAvailable Bool Specifies whether the user is eligible to upgrade their current storage plan based on available tiers.
quota_total Long The maximum number of bytes allocated to the drive under the user's current storage plan.
quota_used Long The total number of bytes currently used in the drive, including active and deleted content.
sharePointIds_listId String The identifier of the SharePoint list associated with the current item, if applicable.
sharePointIds_listItemId String The unique numeric identifier of a specific item within a SharePoint list.
sharePointIds_listItemUniqueId String The globally unique identifier assigned to the list item within the SharePoint environment.
sharePointIds_siteId String The identifier of the SharePoint site that contains the list or library associated with the current item.
sharePointIds_siteUrl String The full URL of the SharePoint site that hosts the associated list or document library.
sharePointIds_tenantId String The Microsoft 365 tenant identifier that owns the SharePoint site where the list or item is stored.
sharePointIds_webId String The identifier of the SharePoint web (subsite) that contains the associated list or item.
Linkedfollowing String A hyperlink to items or folders in OneDrive that the user is actively following for updates or collaboration.
Linkeditems String A hyperlink to the child items contained within a folder or parent item in OneDrive.
Linkedlist String A hyperlink that navigates to the SharePoint list which contains the current item.
Linkedroot String A hyperlink to the root directory of the drive, representing the top-level folder or entry point.
Linkedspecial String A hyperlink to system-defined special folders including Documents, Photos, Camera Roll, or similar.
ParentReference String A reference object containing metadata about the immediate parent item or folder of the current item.
Id [KEY] String A system-generated unique string that identifies the item within the drive.
Name String The file or folder name as it appears in OneDrive, including its original casing and formatting.
Description String A user-defined or system-generated description that provides context about the item's contents or purpose.
owner_user_id String The unique identifier of the OneDrive user who owns or created the drive instance.

CData Cloud

Files

Provides detailed information about individual files stored in OneDrive drives, including name, size, and metadata.

Table Specific Information

Select

Projection is performed server-side. In addition, queries that use the primary key Id with an IN filter are also executed server-side. For example:

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. For example:

 SELECT * FROM Files WHERE  ParentReference_DriveId = 'b!3Yqza-5FJ0usfhyH-2QafkQpf0OC0jlNh8LAETWPK6dNROPDScevTKbV-drnCFHV' And ParentReference_id = '01QFG2V52Z62HOXS5F6RHIHVT36T3Q5GKH' 

Server-side filtering using ParentReference_Id is supported on the root drive when the AuthScheme property is set to AzureAD. However, it is not available for client-credential authentication. For example:

 SELECT * FROM Files WHERE  ParentReference_id = '01QFG2V52Z62HOXS5F6RHIHVT36T3Q5GKH' 

For server-side filtering using ParentReference_Id with client-credential authentication, such as AzureServicePrincipal or AzureServicePrincipalCert, the createdBy_user_id column is required. For example:

 SELECT * FROM Files WHERE  ParentReference_id = '01QFG2V52Z62HOXS5F6RHIHVT36T3Q5GKH' AND createdBy_user_id = '1c67f23f-8681-4c67-9c19-253e628442d5' 

UserId and GroupId connection properties can also be used to filter records. If both are included in the connection string, UserId will take precedence over GroupId.

File listing is performed recursively based on the DirectoryRetrievalDepth property. By default, this property is set to 5, which means the driver retrieves data only for the first six levels of the selected drive. This is because level 1 corresponds to DirectoryRetrievalDepth=0.

You can set the value to -1 to retrieve all the files in the drive, regardless of their depth.

Files can be listed in this view, and their contents can be accessed 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 Unique identifier of the file item within the OneDrive drive.
Etag String Entity tag for tracking changes to the file; used for concurrency control.
createdBy_user_id String Identifier of the user who originally created the file.
createdBy_user_displayName String Display name of the user who created the file.
lastModifiedBy_user_id String Identifier of the user who last modified the file.
lastModifiedBy_user_displayName String Display name of the user who last modified the file.
ResourceType String Specifies the type of resource represented, such as file or folder.
createdBy_user_email String Email of the user who created the file.
lastModifiedBy_user_email String Email of the user who last modified the file.
createdBy_application_displayName String Name of the application that created the file.
createdBy_application_id String Unique ID of the application that created the file.
createdDateTime Datetime Timestamp when the file was initially created.
description String User-defined or system-generated description of the file's purpose or contents.
lastModifiedBy_application_displayName String Name of the application that last modified the file.
lastModifiedBy_application_id String Unique ID of the application that last modified the file.
lastModifiedDateTime Datetime Timestamp of the most recent modification to the file.
name String The file's name as it appears in OneDrive.
parentReference_driveId String ID of the parent drive containing the file.
parentReference_driveType String Type of the parent drive, such as personal or documentLibrary.
parentReference_id String Unique ID of the parent folder or item.
parentReference_name String Name of the parent folder or item.
parentReference_path String File system path of the parent item within OneDrive.
webUrl String Direct URL to access the file via a web browser.
audio_album String Name of the album the audio file belongs to.
audio_albumArtist String Name of the album artist associated with the audio file.
audio_artist String Primary artist of the audio file.
audio_bitrate Long Bitrate of the audio file in bits per second.
audio_composers String Comma-separated list of composers (for example, John Williams, Hans Zimmer, or Ennio Morricone).
audio_copyright String Copyright information associated with the audio file.
audio_disc Int Disc number the track is from, if part of a multi-disc album.
audio_discCount Int Total number of discs in the audio collection.
audio_duration Long Duration of the audio file in milliseconds.
audio_genre String Genre of the audio file content, such as Rock, Jazz, or Classical.
audio_hasDrm Bool Indicates whether the audio file is protected by digital rights management.
audio_isVariableBitrate Bool Specifies whether the audio file uses variable bitrate encoding.
audio_title String Title of the audio track.
audio_track Int Track number of the audio file on the disc.
audio_trackCount Int Total number of tracks in the audio collection or album.
audio_year Int Year the audio file was published or recorded.
cTag String Change tag used to detect updates to the file or folder.
file_hashes_crc32Hash String CRC32 checksum used for data validation of the file.
file_hashes_quickXorHash String QuickXor hash for efficient change detection in Office files.
file_hashes_sha1Hash String SHA-1 cryptographic hash of the file.
file_hashes_sha256Hash String SHA-256 cryptographic hash of the file.
file_mimeType String MIME type of the file.
fileSystemInfo_createdDateTime Datetime Filesystem timestamp indicating when the file was created.
fileSystemInfo_lastModifiedDateTime Datetime Filesystem timestamp of the last time the file was modified.
folder_childCount Int Number of items directly within the folder, if the item is a folder.
image_height Int Height of the image in pixels.
image_width Int Width of the image in pixels.
location_altitude Double Altitude at which the photo or file was captured, in meters.
location_latitude Double Latitude coordinate of where the photo or file was captured.
location_longitude Double Longitude coordinate of where the photo or file was captured.
photo_cameraMake String Manufacturer of the camera used to take the photo.
photo_cameraModel String Model of the camera used to capture the photo.
photo_exposureDenominator Double Denominator of the exposure time ratio used to capture the photo.
photo_exposureNumerator Double Numerator of the exposure time ratio used to capture the photo.
photo_fNumber Double Aperture setting (f-number) used when the photo was taken.
photo_focalLength Double Focal length of the lens in millimeters.
photo_iso Int ISO sensitivity setting used when the photo was taken.
photo_orientation Int Numeric value representing the photo's orientation (for example, 1 for normal, 3 for rotated 180).
photo_takenDateTime Datetime Date and time when the photo was captured.
publication_checkedOutBy_application_displayName String Display name of the user who checked out the file.
publication_checkedOutBy_application_id String Identifier of the user who checked out the file.
publication_level String The publication visibility level, such as checkout or published.
publication_versionId String Identifier for the published version of the file.
size Long Total size of the item in bytes, including metadata and content.
video_audioBitsPerSample Int Bits per audio sample in the video file.
video_audioChannels Int Number of audio channels in the video, typically 1 for mono or 2 for stereo.
video_audioFormat String Encoding format used for the audio stream in the video file.
video_audioSamplesPerSecond Int Sample rate for the video's audio stream, in hertz.
video_bitrate Int Total data rate of the video stream, measured in bits per second.
video_duration Long Playback duration of the video in milliseconds.
video_fourCC String Four-character code (FourCC) identifying the video codec (such as H264 or XVID).
video_frameRate Double Number of frames displayed per second in the video.
video_height Int Height of the video in pixels.
video_width Int Width of the video in pixels.

CData Cloud

FileVersions

Tracks the version history of each file in OneDrive, allowing review or rollback of previous file states.

Table Specific Information

SELECT

The Cloud will use the Microsoft OneDrive API to process WHERE clause conditions built with the following column and operator. The filter labeled 'createdBy_user_id' is required to execute the query successfully.

  • FileId supports the '='.
  • DriveId supports the '='.
  • UserId supports the '='.
  • createdBy_user_id supports the '='.
For example:
SELECT * FROM FileVersions WHERE FileId = '01CYQN2MFPR6NIWVZNMNFL3SL4E3KF7IHY' AND DriveId = 'b!GrEGWax2VE-ssnJNr1E8llqoLptvK-BGjFRpceFzFg5Nwp9Bw2xbR62J0NAouP6z' AND createdBy_user_id = '472df319-2978-49d4-9445-9e7019def16f'

SELECT * FROM FileVersions WHERE FileId = '01CYQN2MFPR6NIWVZNMNFL3SL4E3KF7IHY' AND createdBy_user_id = '472df319-2978-49d4-9445-9e7019def16f'

SELECT * FROM FileVersions WHERE createdBy_user_id = '472df319-2978-49d4-9445-9e7019def16f'

Columns

Name Type References Description
FileId [KEY] String Identifier of the original file to which this version belongs.
lastModifiedBy_user_displayName String Display name of the user who made the most recent modification to this file version.
lastModifiedBy_user_id String Unique identifier of the user who last modified this file version.
lastModifiedDateTime Datetime Timestamp indicating when this file version was last modified.
size Long Size of the file version in bytes.
id String Unique identifier assigned to this specific version of the file.
lastModifiedBy_user_email String Email address of the user who last modified this file version.
DriveId String Identifier of the OneDrive or SharePoint drive where the file version is stored.
publication_level String The publication state of the version, such as draft or published.
createdBy_user_id String Unique identifier of the user who originally created this version of the file.

CData Cloud

Folders

Lists all folders within a OneDrive drive, useful for navigation and hierarchical organization analysis.

Table Specific Information

Select

Note: Use the CreateFolder stored procedure to create a new folder.

Projection is performed server-side. In addition, queries that use the primary key Id with an IN filter are also executed server-side. For example:

SELECT Id, Name, Size, Description FROM Folders WHERE Id IN ('B1E6BJ084A9133KB1!122', 'APF9D2K6WFAAPX9') 

Include ParentReference_DriveId and ParentReference_Id in the WHERE clause to get the result for a particular folder. For example:

 SELECT * FROM Folders WHERE  ParentReference_DriveId = 'b!3Yqza-5FJ0usfhyH-2QafkQpf0OC0jlNh8LAETWPK6dNROPDScevTKbV-drnCFHV' And ParentReference_id = '01QFG2V52Z62HOXS5F6RHIHVT36T3Q5GKH' 

Server-side filtering using ParentReference_Id is supported on the root drive when the AuthScheme property is set to AzureAD. However, it is not available for client-credential authentication. For example:

 SELECT * FROM Folders WHERE  ParentReference_id = '01QFG2V52Z62HOXS5F6RHIHVT36T3Q5GKH' 

For server-side filtering using ParentReference_Id with client-credential authentication (such as AzureServicePrincipal or AzureServicePrincipalCert), the createdBy_user_id column is required. For example:

 SELECT * FROM Folders WHERE  ParentReference_id = '01QFG2V52Z62HOXS5F6RHIHVT36T3Q5GKH' AND createdBy_user_id = '1c67f23f-8681-4c67-9c19-253e628442d5' 

UserId and GroupId connection properties can also be used to filter records. If both are included in the connection string, UserId will take precedence over GroupId.

Folder listing is performed recursively using the DirectoryRetrievalDepth property. By default, this property is set to 5, which means it retrieves data for the first six levels of the selected drive. This is because the first level corresponds to DirectoryRetrievalDepth=0.

You can set the value to -1 to retrieve all the folders in the drive, regardless of their depth.

Folders can be listed in this view, and their contents can be accessed 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 Unique identifier for the item.
Etag String Entity tag for the item used for concurrency control.
createdBy_user_id String ID of the user who created the item.
createdBy_user_displayName String Display name of the user who created the item.
lastModifiedBy_user_id String ID of the user who last modified the item.
lastModifiedBy_user_displayName String Display name of the user who last modified the item.
createdBy_application_displayName String Name of the application that created the item.
createdBy_application_id String ID of the application that created the item.
createdDateTime Datetime Timestamp when the item was created.
description String User-provided description of the item.
lastModifiedBy_application_displayName String Name of the application that last modified the item.
lastModifiedBy_application_id String ID of the application that last modified the item.
lastModifiedDateTime Datetime Timestamp of the last modification to the item.
name String Name of the item (file or folder).
parentReference_driveId String ID of the drive containing the parent item.
parentReference_driveType String Type of the drive (for example, personal, or business).
parentReference_id String ID of the parent item.
parentReference_name String Name of the parent item.
parentReference_path String Path to the parent item.
parentReference_shareId String Sharing ID associated with the parent item.
parentReference_sharepointIds_listId String SharePoint list ID associated with the parent item.
parentReference_sharepointIds_listItemId String SharePoint list item ID for the parent item.
parentReference_sharepointIds_listItemUniqueId String Unique SharePoint list item ID.
parentReference_sharepointIds_siteId String ID of the SharePoint site.
parentReference_sharepointIds_siteUrl String URL of the SharePoint site.
parentReference_sharepointIds_tenantId String Tenant ID for the SharePoint organization.
parentReference_sharepointIds_webId String Web ID of the SharePoint site.
parentReference_siteId String ID of the parent site (OneDrive/SharePoint).
webUrl String URL to access the item in a web browser.
LinkedcreatedByUser String Link to the user entity that created the item.
LinkedlastModifiedByUser String Link to the user entity that last modified the item.
audio_album String Album title of the audio file.
audio_albumArtist String Primary artist of the album.
audio_artist String Performer of the audio content.
audio_bitrate Long Bitrate of the audio in bits per second.
audio_composers String Composer(s) of the audio content.
audio_copyright String Copyright statement for the audio file.
audio_disc Int Disc number of the audio track.
audio_discCount Int Total number of discs in the album.
audio_duration Long Duration of the audio file in milliseconds.
audio_genre String Genre of the audio content.
audio_hasDrm Bool Indicates whether the audio file has digital rights management (DRM).
audio_isVariableBitrate Bool Indicates whether the audio uses variable bitrate encoding.
audio_title String Title of the audio track.
audio_track Int Track number on the album.
audio_trackCount Int Total number of tracks in the album.
audio_year Int Year the audio was released.
content String Base64 or encoded content of the item.
cTag String Change tag used for item versioning and sync detection.
deleted_state String The deletion status (for example, 'deleted', 'restored').
file_hashes_crc32Hash String CRC32 hash of the file content.
file_hashes_quickXorHash String QuickXor hash of the file content used by OneDrive.
file_hashes_sha1Hash String SHA-1 hash of the file content.
file_hashes_sha256Hash String SHA-256 hash of the file content.
file_mimeType String MIME type of the file (for example, 'application/pdf').
file_processingMetadata Bool Indicates whether the file has additional processing metadata (for example, indexing).
fileSystemInfo_createdDateTime Datetime Timestamp when the file was created in the file system.
fileSystemInfo_lastAccessedDateTime Datetime Timestamp of the last access to the file.
fileSystemInfo_lastModifiedDateTime Datetime Timestamp when the file was last modified.
folder_childCount Int Number of items (files/folders) in the folder.
folder_view_sortBy String Default sort field for viewing folder contents.
folder_view_sortOrder String Default sort order (ascending/descending) for folder contents.
folder_view_viewType String Type of view used to display the folder contents (for example, thumbnails).
image_height Int Height of the image in pixels.
image_width Int Width of the image in pixels.
location_altitude Double Altitude (in meters) where the file (typically a photo) was created.
location_latitude Double Latitude coordinate for the file's location.
location_longitude Double Longitude coordinate for the file's location.
package_type String Type of package (for example, OneNote, ZIP).
pendingOperations_pendingContentUpdate_queuedDateTime Datetime Timestamp when a pending update was queued.
photo_cameraMake String Camera manufacturer used to take the photo.
photo_cameraModel String Camera model used to take the photo.
photo_exposureDenominator Double Denominator of the exposure time (for example, 1/60s = 60).
photo_exposureNumerator Double Numerator of the exposure time.
photo_fNumber Double F-number (aperture) used to take the photo.
photo_focalLength Double Focal length of the lens used in millimeters.
photo_iso Int ISO sensitivity used when taking the photo.
photo_orientation Int Orientation of the photo (for example, 1 = normal, 3 = upside down).
photo_takenDateTime Datetime Timestamp when the photo was taken.
publication_level String The publication level for the folder, which can define sharing or access visibility.
publication_versionId String Identifier representing the specific publication version of the folder.
remoteItem_createdBy_application_displayName String Display name of the application that created the remote item.
remoteItem_createdBy_application_id String Unique identifier of the application that created the remote item.
remoteItem_createdDateTime Datetime Timestamp when the remote item was initially created.
remoteItem_file_hashes_crc32Hash String CRC32 checksum used for file integrity verification.
remoteItem_file_hashes_quickXorHash String QuickXor hash used by OneDrive to track file content changes.
remoteItem_file_hashes_sha1Hash String SHA-1 hash of the file used for content validation.
remoteItem_file_hashes_sha256Hash String SHA-256 hash of the file used for secure integrity checking.
remoteItem_file_mimeType String MIME type of the file, such as application/pdf or image/jpeg.
remoteItem_file_processingMetadata Bool Indicates whether the file contains processing metadata such as indexing or tagging.
remoteItem_fileSystemInfo_createdDateTime Datetime Date and time when the file was created in the filesystem.
remoteItem_fileSystemInfo_lastAccessedDateTime Datetime Date and time the file was last accessed in the filesystem.
remoteItem_fileSystemInfo_lastModifiedDateTime Datetime Last modification timestamp of the file within the filesystem.
remoteItem_folder_childCount Int Number of child items contained in the folder.
remoteItem_folder_view_sortBy String Default attribute used to sort items in the folder view.
remoteItem_folder_view_sortOrder String Sorting order (ascending or descending) used in the folder view.
remoteItem_folder_view_viewType String Type of view used for displaying the folder, such as list or thumbnails.
remoteItem_id String Unique identifier of the remote item.
remoteItem_image_height Int Height of the image in pixels.
remoteItem_image_width Int Width of the image in pixels.
remoteItem_lastModifiedDateTime Datetime Timestamp of the last change made to the remote item.
remoteItem_name String Name of the remote item (file or folder).
remoteItem_package_type String Type of package the item belongs to, such as OneNote or ZIP.
remoteItem_parentReference_driveId String Drive ID of the item's parent directory.
remoteItem_parentReference_driveType String Type of drive hosting the item, such as personal or business.
remoteItem_parentReference_id String Identifier of the parent folder or item.
remoteItem_parentReference_name String Name of the parent folder or item.
remoteItem_parentReference_path String Full path to the parent item in the drive.
remoteItem_parentReference_shareId String ID associated with shared access to the parent item.
remoteItem_parentReference_sharepointIds_listId String SharePoint list ID related to the parent item.
remoteItem_parentReference_sharepointIds_listItemId String Item ID within a SharePoint list.
remoteItem_parentReference_sharepointIds_listItemUniqueId String Globally unique identifier (GUID) for the SharePoint list item.
remoteItem_parentReference_sharepointIds_siteId String SharePoint site ID where the item is located.
remoteItem_parentReference_sharepointIds_siteUrl String URL of the SharePoint site hosting the item.
remoteItem_parentReference_sharepointIds_tenantId String Tenant ID of the SharePoint organization.
remoteItem_parentReference_sharepointIds_webId String Web ID for the SharePoint subsite.
remoteItem_parentReference_siteId String Site ID associated with the parent folder or item.
remoteItem_shared_scope String The scope of the shared item, such as organization or anonymous.
remoteItem_shared_sharedDateTime Datetime Date and time when the item was shared.
remoteItem_size Long Size of the item in bytes.
remoteItem_specialFolder_name String Indicates whether the folder is special, such as Documents or Photos.
remoteItem_video_audioBitsPerSample Int Number of audio bits per sample in the video file.
remoteItem_video_audioChannels Int Number of audio channels (for example, mono, stereo) in the video.
remoteItem_video_audioFormat String Format of the audio encoding in the video.
remoteItem_video_audioSamplesPerSecond Int Sample rate of audio in the video, measured in Hz.
remoteItem_video_bitrate Int Bitrate of the video file in bits per second.
remoteItem_video_duration Long Duration of the video in milliseconds.
remoteItem_video_fourCC String Four-character code (FourCC) identifying the video codec.
remoteItem_video_frameRate Double Frame rate of the video in frames per second.
remoteItem_video_height Int Video height in pixels.
remoteItem_video_width Int Video width in pixels.
remoteItem_webDavUrl String WebDAV-compliant URL to access the remote item programmatically.
remoteItem_webUrl String Web URL to view the remote item in a browser.
searchResult_onClickTelemetryUrl String URL used for telemetry tracking when a search result is clicked.
shared_owner_application_displayName String Display name of the application that owns the shared item.
shared_owner_application_id String ID of the application that owns the shared item.
shared_scope String Scope of sharing for the item, such as users, organization, or anonymous.
shared_sharedDateTime Datetime Date and time when the item was shared by the owner.
sharepointIds_listId String Identifier for the SharePoint list.
sharepointIds_listItemId String Item ID in the associated SharePoint list.
sharepointIds_listItemUniqueId String GUID for the SharePoint list item.
sharepointIds_siteId String SharePoint site ID where the item resides.
sharepointIds_siteUrl String URL of the SharePoint site.
sharepointIds_tenantId String ID of the SharePoint tenant.
sharepointIds_webId String Identifier of the SharePoint web object.
size Long Size of the item in bytes.
specialFolder_name String Type of special folder, such as Documents, Music, or Photos.
video_audioBitsPerSample Int Audio depth per sample in the video file.
video_audioChannels Int Number of audio channels in the video (for example, 2 for stereo).
video_audioFormat String Audio codec format used in the video.
video_audioSamplesPerSecond Int Audio sample rate in Hz.
video_bitrate Int Total bitrate of the video file.
video_duration Long Length of the video in milliseconds.
video_fourCC String Codec identifier (FourCC) used for the video stream.
video_frameRate Double Video frame rate in frames per second.
video_height Int Height resolution of the video.
video_width Int Width resolution of the video.
webDavUrl String WebDAV URL for accessing the item via file system protocols.
Linkedanalytics String Link to analytics data related to the folder or item.
Linkedchildren String Link to the child items contained within the folder.
LinkedlistItem String Link to the associated SharePoint list item.
Linkedpermissions String Link to the permissions set on the item.
Linkedsubscriptions String Link to any active subscriptions (for example, webhooks) on the item.
Linkedthumbnails String Link to thumbnail previews for the item.
Linkedversions String Link to version history for the file.
Linkedworkbook String Link to the Excel workbook interface if the file is an Excel document.

CData Cloud

GroupMembers

Lists the members of the group.

Columns

Name Type References Description
GroupId [KEY] String

Groups.Id

Id of the Group.
MemberId [KEY] String

Users.Id

Id of the Member
DisplayName String Display Name of the member.
UserPrincipalName String Principal Name of the member.

CData Cloud

Groups

Shows all security and distribution groups within the connected Microsoft 365 tenant, enabling administrative oversight.

Columns

Name Type References Description
Id [KEY] String Unique identifier for the group object within the directory.
assignedLabels String List of sensitivity labels assigned to the group, used for compliance or classification.
assignedLicenses String Details of licenses that have been assigned to the group members, including service plans.
classification String Custom string used to classify the group, such as Confidential or Internal.
createdDateTime Datetime Date and time when the group was created in the directory.
description String Free-form description of the group, typically used for administrative context.
displayName String Display name of the group as it appears in the address book or directory listings.
expirationDateTime Datetime The date and time when the group is scheduled to expire, if applicable.
groupTypes String List of types associated with the group, such as Unified or DynamicMembership.
hasMembersWithLicenseErrors Bool Indicates whether any group members have license assignment errors.
isAssignableToRole Bool Specifies if the group can be assigned to Azure AD roles for role-based access control.
isManagementRestricted Bool Indicates whether group management is restricted to designated owners or admins.
licenseProcessingState_state String Current state of license processing for the group (for example, 'Enabled', 'Error').
mail String Email address of the group if mail-enabled, used for communication or notifications.
mailEnabled Bool Indicates whether the group is enabled to send or receive email messages.
mailNickname String Mail alias (nickname) for the group, used in email addresses and directory services.
membershipRule String Rule used to dynamically assign members to the group based on directory attributes.
membershipRuleProcessingState String Current processing state of the dynamic membership rule (for example, 'InProgress', 'UpdateComplete').
onPremisesDomainName String Domain name from the on-premises directory if synced from Active Directory.
onPremisesLastSyncDateTime Datetime Last date and time the group was synced from the on-premises directory.
onPremisesNetBiosName String NetBIOS name of the domain from which the group was synced.
onPremisesProvisioningErrors String List of any provisioning errors that occurred during on-premises sync.
onPremisesSamAccountName String Security Accounts Manager (SAM) account name for the group, if synced from on-premises.
onPremisesSecurityIdentifier String Security identifier (SID) for the group, used in access control for Windows systems.
onPremisesSyncEnabled Bool Indicates whether directory sync is enabled for the group from the on-premises environment.
preferredDataLocation String Preferred geographic location for storing data related to the group, such as 'North America'.
preferredLanguage String Preferred language for the group interface, emails, and other localized experiences.
proxyAddresses String List of email addresses associated with the group, including primary and aliases. Each address is separated by a comma and can include smtp, SMTP, or x500.
renewedDateTime Datetime The last time the group was renewed or updated in the directory.
securityEnabled Bool Indicates whether the group is security-enabled and can be used for access control.
securityIdentifier String SID for the group, used for security and identity operations.
serviceProvisioningErrors String Any errors encountered while provisioning services for the group, such as SharePoint or Teams.
theme String Custom UI theme assigned to the group for services like Microsoft Teams.
uniqueName String Globally unique name for the group, used for internal referencing and identification.
unseenCount Int Number of unseen items or notifications associated with the group (for example, in Teams or Outlook).
visibility String Defines group visibility level, such as Public, Private, or HiddenMembership.

CData Cloud

Permissions

Details sharing and access permissions for files and folders within a OneDrive drive, identifying owners and collaborators.

Table Specific Information

UserId and GroupId connection properties can also be used to filter records. If both are included in the connection string, UserId will take precedence over GroupId.

Due to API limitations, all operators on this view are executed client-side.

Columns

Name Type References Description
id [KEY] String Unique identifier for the permission record.
Etag String Entity tag used for concurrency control to track updates to the permission.
ResourceId [KEY] String Identifier of the resource (file or folder) the permission applies to.
grantedTo_user_displayName String Display name of the user who has been granted access to the resource.
grantedTo_user_email String Email address of the user who has been granted access.
grantedTo_user_id String Unique identifier of the user granted access.
expirationDateTime Datetime Timestamp indicating when the permission will expire, if set.
grantedTo_application_displayName String Name of the application granted access to the resource.
grantedTo_application_id String Unique identifier of the application granted access.
grantedToIdentities String List of user or group identities that the permission has been granted to, separated by commas.
hasPassword Bool Indicates whether the shared link is protected by a password.
inheritedFrom_driveId String ID of the drive where the original permission was inherited from.
inheritedFrom_driveType String Type of the originating drive, such as personal or business.
inheritedFrom_id String ID of the resource from which the permission is inherited.
inheritedFrom_name String Name of the resource from which the permission is inherited.
inheritedFrom_path String Path to the source resource from which the permission is inherited.
inheritedFrom_shareId String ID of the sharing link associated with the inherited permission.
inheritedFrom_sharepointIds_listId String SharePoint list ID from which the permission is inherited.
inheritedFrom_sharepointIds_listItemId String ID of the SharePoint list item the permission is derived from.
inheritedFrom_sharepointIds_listItemUniqueId String Globally unique identifier (GUID) of the SharePoint list item.
inheritedFrom_sharepointIds_siteId String SharePoint site ID from which the permission originates.
inheritedFrom_sharepointIds_siteUrl String URL of the SharePoint site associated with the inherited permission.
inheritedFrom_sharepointIds_tenantId String Tenant ID associated with the originating SharePoint environment.
inheritedFrom_sharepointIds_webId String Web ID for the SharePoint subsite containing the original resource.
inheritedFrom_siteId String Site ID of the location from which the permission is inherited.
invitation_email String Email address of the person invited to access the resource.
invitation_invitedBy_application_displayName String Display name of the application that sent the sharing invitation.
invitation_invitedBy_application_id String ID of the application that issued the sharing invitation.
invitation_redeemedBy String Email or identifier of the person who accepted and redeemed the sharing invitation.
invitation_signInRequired Bool Indicates whether the recipient must sign in to access the resource.
link_application_displayName String Display name of the application that created the sharing link.
link_application_id String Unique identifier of the application that created the sharing link.
link_preventsDownload Bool Indicates whether downloading the shared content is restricted for viewers.
link_scope String Defines the access scope of the sharing link, such as anonymous, organization, or specific people.
link_type String Type of sharing link created (for example, view, edit, embed).
link_webHtml String HTML-formatted snippet that renders the sharing link for embedding in web pages.
link_webUrl String Direct web URL to access the shared item.
roles String Comma-separated list of roles granted by the permission, such as read, write, owner.
shareId String Unique identifier for the sharing instance, used to reference and manage shared access.

CData Cloud

SharedResources

Identifies all files and folders that have been shared from OneDrive, along with recipients and access levels.

Table Specific Information

Select

Projection is performed server-side. In addition, queries that use the primary key Id with an IN filter are also executed server-side. For example:

SELECT Id, Name, Size, Shared_Scope FROM SharedResources WHERE Id IN ('B1E6BJ084A9133KB1!122', 'APF9D2K6WFAAPX9') 

Server-side filtering using ParentReference_Id is supported on the root drive when the AuthScheme property is set to AzureAD. However, it is not available for client-credential authentication. For example:

 SELECT * FROM SharedResources WHERE  ParentReference_id = '01QFG2V52Z62HOXS5F6RHIHVT36T3Q5GKH' 

For server-side filtering using ParentReference_Id with client-credential authentication (such as AzureServicePrincipal or AzureServicePrincipalCert), the createdBy_user_id column is required. For example:

 SELECT * FROM SharedResources WHERE  ParentReference_id = '01QFG2V52Z62HOXS5F6RHIHVT36T3Q5GKH' AND createdBy_user_id = '1c67f23f-8681-4c67-9c19-253e628442d5' 

UserId and GroupId connection properties can also be used to filter records. If both are included in the connection string, UserId will take precedence over GroupId.

The listing of SharedResources is done recursively using the DirectoryRetrievalDepth property. By default, this property is set to 5, which allows data retrieval for a total of six levels within the selected drive. This is because the first level corresponds to DirectoryRetrievalDepth=0.

You can set the value to -1 to retrieve all the shared resources in the drive, regardless of their depth.

Columns

Name Type References Description
id [KEY] String Unique identifier for the item in the system.
Etag String Entity tag used for version control and detecting changes to the item.
createdBy_user_id String Identifier of the user who originally created the item.
createdBy_user_displayName String Display name of the user who created the item.
lastModifiedBy_user_id String Identifier of the user who most recently modified the item.
lastModifiedBy_user_displayName String Display name of the user who last modified the item.
createdBy_application_displayName String Display name of the application that created the item.
createdBy_application_id String Unique ID of the application that created the item.
createdDateTime Datetime Timestamp indicating when the item was created.
description String User-defined description or notes about the item.
lastModifiedBy_application_displayName String Display name of the application that last modified the item.
lastModifiedBy_application_id String Unique ID of the application that last modified the item.
lastModifiedDateTime Datetime Timestamp of the most recent modification to the item.
name String Name of the item (file or folder).
parentReference_driveId String ID of the drive where the item's parent is located.
parentReference_driveType String Type of drive hosting the item, such as personal or business.
parentReference_id String ID of the parent folder or item.
parentReference_name String Name of the parent folder or item.
parentReference_path String Full path to the parent folder or item.
parentReference_shareId String Sharing ID associated with the parent item for link-based sharing.
parentReference_sharepointIds_listId String SharePoint list ID where the item resides.
parentReference_sharepointIds_listItemId String Item ID in the SharePoint list for the parent item.
parentReference_sharepointIds_listItemUniqueId String Globally unique ID for the SharePoint list item.
parentReference_sharepointIds_siteId String SharePoint site ID that contains the parent item.
parentReference_sharepointIds_siteUrl String URL of the SharePoint site hosting the item.
parentReference_sharepointIds_tenantId String Tenant ID of the SharePoint organization.
parentReference_sharepointIds_webId String Web ID of the SharePoint subsite containing the item.
parentReference_siteId String ID of the parent site where the item is located.
webUrl String Web-accessible URL to view or access the item.
LinkedcreatedByUser String Link to metadata about the user who created the item.
LinkedlastModifiedByUser String Link to metadata about the user who last modified the item.
audio_album String Album title associated with the audio file.
audio_albumArtist String Primary artist of the album.
audio_artist String Performer or artist of the audio content.
audio_bitrate Long Bitrate of the audio file in bits per second.
audio_composers String Name of the composers for the audio content.
audio_copyright String Copyright information associated with the audio file.
audio_disc Int Disc number if the audio file is part of a multi-disc album.
audio_discCount Int Total number of discs in the audio album.
audio_duration Long Duration of the audio in milliseconds.
audio_genre String Genre or category of the audio content.
audio_hasDrm Bool Indicates whether the audio file is protected by DRM.
audio_isVariableBitrate Bool Indicates whether the audio file uses variable bitrate encoding.
audio_title String Title of the track within the audio file.
audio_track Int Track number in the album or playlist.
audio_trackCount Int Total number of tracks in the album.
audio_year Int Year the audio content was released or created.
content String Raw content of the item, usually encoded.
cTag String Change tag used for sync operations to detect item changes.
deleted_state String Status indicating if the item has been deleted (for example, deleted, notDeleted).
file_hashes_crc32Hash String CRC32 hash for integrity verification of the file content.
file_hashes_quickXorHash String QuickXor hash used by Microsoft to detect file content changes.
file_hashes_sha1Hash String SHA-1 hash for validating file integrity.
file_hashes_sha256Hash String SHA-256 hash for strong integrity verification of the file.
file_mimeType String MIME type of the file.
file_processingMetadata Bool Indicates whether additional processing metadata is present (such as for indexing).
fileSystemInfo_createdDateTime Datetime Timestamp when the file was created in the file system.
fileSystemInfo_lastAccessedDateTime Datetime Timestamp of the last time the file was accessed.
fileSystemInfo_lastModifiedDateTime Datetime Timestamp when the file was last modified in the file system.
folder_childCount Int Number of items contained in the folder.
folder_view_sortBy String Default attribute used to sort items in the folder view.
folder_view_sortOrder String Default sort order (ascending or descending) for the folder view.
folder_view_viewType String Type of view for the folder, such as list, grid, or thumbnails.
image_height Int Height of the image in pixels.
image_width Int Width of the image in pixels.
location_altitude Double Altitude, in meters, where the item was created (for media files).
location_latitude Double Latitude coordinate where the item was created.
location_longitude Double Longitude coordinate where the item was created.
package_type String Type of package or container, such as OneNote or ZIP.
pendingOperations_pendingContentUpdate_queuedDateTime Datetime Timestamp indicating when a pending update was queued for processing.
photo_cameraMake String Manufacturer of the camera used to take the photo.
photo_cameraModel String Model name or number of the camera used.
photo_exposureDenominator Double Denominator of the exposure time (for example, 1/125 ? 125).
photo_exposureNumerator Double Numerator of the exposure time.
photo_fNumber Double Aperture value (f-number) used to take the photo.
photo_focalLength Double Focal length of the lens, in millimeters.
photo_iso Int ISO sensitivity setting used when the photo was taken.
photo_orientation Int Orientation of the photo (for example, upright, rotated).
photo_takenDateTime Datetime Date and time when the photo was taken, from metadata.
publication_level String Level of publication assigned to the shared resource, used to define distribution or access tier.
publication_versionId String Identifier representing the version of the published shared resource.
remoteItem_createdBy_application_displayName String Display name of the application that created the shared remote item.
remoteItem_createdBy_application_id String Application ID of the app that created the shared remote item.
remoteItem_createdDateTime Datetime Timestamp indicating when the remote item was created.
remoteItem_file_hashes_crc32Hash String CRC32 hash value of the file content, used for integrity checks.
remoteItem_file_hashes_quickXorHash String QuickXor hash used by Microsoft services to detect changes in file content.
remoteItem_file_hashes_sha1Hash String SHA-1 hash of the file for verifying content integrity.
remoteItem_file_hashes_sha256Hash String SHA-256 hash of the file for secure content validation.
remoteItem_file_mimeType String MIME type of the file, such as application/pdf, image/png, text/plain.
remoteItem_file_processingMetadata Bool Indicates whether the file includes metadata for processing tasks such as indexing.
remoteItem_fileSystemInfo_createdDateTime Datetime Filesystem timestamp showing when the file was initially created.
remoteItem_fileSystemInfo_lastAccessedDateTime Datetime Timestamp showing the last time the file was accessed.
remoteItem_fileSystemInfo_lastModifiedDateTime Datetime Timestamp showing the last modification to the file in the filesystem.
remoteItem_folder_childCount Int Total number of child items contained within the shared folder.
remoteItem_folder_view_sortBy String Default field used to sort items in the folder view, such as name or dateModified.
remoteItem_folder_view_sortOrder String Sort direction used in the folder view, such as ascending or descending.
remoteItem_folder_view_viewType String Type of folder view, such as list, grid, or thumbnails.
remoteItem_id String Unique identifier of the shared remote item.
remoteItem_image_height Int Image height in pixels for the shared item, if it is an image file.
remoteItem_image_width Int Image width in pixels for the shared item, if it is an image file.
remoteItem_lastModifiedDateTime Datetime Timestamp indicating the last time the remote item was modified.
remoteItem_name String Name of the remote item that has been shared.
remoteItem_package_type String Type of package, such as OneNote or ZIP, associated with the shared item.
remoteItem_parentReference_driveId String Drive ID where the parent folder or item resides.
remoteItem_parentReference_driveType String Drive type where the parent is located, such as personal, business, or documentLibrary.
remoteItem_parentReference_id String ID of the parent item from which the remote item inherits.
remoteItem_parentReference_name String Name of the parent item containing the remote item.
remoteItem_parentReference_path String Path to the parent folder or item in the OneDrive hierarchy.
remoteItem_parentReference_shareId String Sharing ID used to identify the parent folder in shared contexts.
remoteItem_parentReference_sharepointIds_listId String ID of the SharePoint list containing the parent item.
remoteItem_parentReference_sharepointIds_listItemId String ID of the SharePoint list item corresponding to the parent item.
remoteItem_parentReference_sharepointIds_listItemUniqueId String Globally unique ID of the SharePoint list item for the parent.
remoteItem_parentReference_sharepointIds_siteId String Site ID in SharePoint where the parent item is located.
remoteItem_parentReference_sharepointIds_siteUrl String URL of the SharePoint site containing the parent item.
remoteItem_parentReference_sharepointIds_tenantId String Tenant ID associated with the SharePoint site.
remoteItem_parentReference_sharepointIds_webId String Web ID of the SharePoint site or subsite where the item exists.
remoteItem_parentReference_siteId String Site ID of the location where the shared resource resides.
remoteItem_shared_scope String Defines the access scope of the shared item, such as anonymous, organization, or users.
remoteItem_shared_sharedDateTime Datetime Timestamp indicating when the item was shared.
remoteItem_size Long Size of the shared resource in bytes.
remoteItem_specialFolder_name String Indicates whether the folder is a special system folder, such as Documents or Photos.
remoteItem_video_audioBitsPerSample Int Bit depth per audio sample in the video file.
remoteItem_video_audioChannels Int Number of audio channels in the video, such as 1 for mono or 2 for stereo.
remoteItem_video_audioFormat String Format or codec used for the audio track in the video.
remoteItem_video_audioSamplesPerSecond Int Audio sampling rate in Hertz for the video file.
remoteItem_video_bitrate Int Total bitrate of the video in bits per second.
remoteItem_video_duration Long Total duration of the video in milliseconds.
remoteItem_video_fourCC String Four-character code (FourCC) that identifies the video codec.
remoteItem_video_frameRate Double Frame rate of the video, expressed as frames per second.
remoteItem_video_height Int Height of the video frame in pixels.
remoteItem_video_width Int Width of the video frame in pixels.
remoteItem_webDavUrl String WebDAV-compatible URL for programmatic access to the remote item.
remoteItem_webUrl String Public-facing web URL for accessing the shared item.
searchResult_onClickTelemetryUrl String URL used for collecting telemetry when a shared item is clicked in search results.
shared_owner_application_displayName String Name of the application that owns the shared item.
shared_owner_application_id String Application ID of the application that owns the shared item.
shared_scope String Scope of sharing defined for the resource, such as anonymous, organization, or specific users.
shared_sharedDateTime Datetime Timestamp indicating when the sharing action took place.
sharepointIds_listId String Identifier for the SharePoint list containing the shared item.
sharepointIds_listItemId String Item ID within the SharePoint list.
sharepointIds_listItemUniqueId String Globally unique identifier for the SharePoint list item.
sharepointIds_siteId String ID of the SharePoint site hosting the shared resource.
sharepointIds_siteUrl String URL of the SharePoint site where the item resides.
sharepointIds_tenantId String Identifier of the Microsoft 365 tenant for the SharePoint environment.
sharepointIds_webId String ID of the web component in the SharePoint site structure.
size Long Size of the shared resource in bytes.
specialFolder_name String Name of the special folder if applicable, such as Music, Photos, or Videos.
video_audioBitsPerSample Int Bit depth for audio samples in standalone video metadata.
video_audioChannels Int Audio channel count in the video (standalone representation).
video_audioFormat String Audio codec or format used in standalone video metadata.
video_audioSamplesPerSecond Int Sampling rate of audio in standalone video metadata.
video_bitrate Int Bitrate of the standalone video in bits per second.
video_duration Long Duration of the standalone video in milliseconds.
video_fourCC String FourCC used in standalone video metadata to represent the codec.
video_frameRate Double Frame rate of the standalone video in frames per second.
video_height Int Video height in pixels (standalone metadata).
video_width Int Video width in pixels (standalone metadata).
webDavUrl String WebDAV endpoint URL for accessing the shared item using WebDAV clients.
Linkedanalytics String Link to analytics data related to the shared item, such as views or edits.
Linkedchildren String Link to the list of child items within a shared folder.
LinkedlistItem String Link to the corresponding SharePoint list item for the shared content.
Linkedpermissions String Link to permission settings associated with the shared resource.
Linkedsubscriptions String Link to any active subscriptions (such as webhooks) related to the shared item.
Linkedthumbnails String Link to thumbnail images associated with the shared item.
Linkedversions String Link to the version history of the shared item.
Linkedworkbook String Link to the Excel workbook interface if the shared item is an Excel file.

CData Cloud

SharedWithMeResources

Lists files and folders that have been shared with the signed-in user by others, including metadata such as the owner, sharing permissions, and access details.

Table Specific Information

Due to API limitations, all operators on this view are executed client-side.

SharedWithMeResources 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 Unique identifier of the shared file or folder.
Etag String Entity tag used to detect changes to the shared item.
createdBy_user_id String ID of the user who originally created the shared item.
createdBy_user_displayName String Display name of the user who created the shared item.
lastModifiedBy_user_id String ID of the user who last modified the item.
lastModifiedBy_user_displayName String Display name of the user who last modified the item.
createdBy_application_displayName String Display name of the user who created the shared item.
createdBy_application_id String ID of the application that created the item.
createdDateTime Datetime Date and time when the item was created.
description String Optional description provided by the item owner.
lastModifiedBy_application_displayName String Name of the application that last modified the item.
lastModifiedBy_application_id String ID of the application that last modified the item.
lastModifiedDateTime Datetime Date and time of the last modification.
name String Name of the shared file or folder.
parentReference_driveId String ID of the drive where the shared item resides.
parentReference_driveType String Type of drive the item is shared from (for example, business or personal).
parentReference_id String ID of the parent folder that contains the shared item.
parentReference_name String Name of the parent folder containing the item.
parentReference_path String Path of the shared item within its source drive.
parentReference_shareId String Identifier used to access the shared resource.
parentReference_sharepointIds_listId String SharePoint list ID if the item is part of a list.
parentReference_sharepointIds_listItemId String SharePoint list item ID for the shared item.
parentReference_sharepointIds_listItemUniqueId String Unique SharePoint list item ID across the site.
parentReference_sharepointIds_siteId String ID of the SharePoint site that owns the item.
parentReference_sharepointIds_siteUrl String URL of the SharePoint site where the item is hosted.
parentReference_sharepointIds_tenantId String Tenant ID of the organization that shared the item.
parentReference_sharepointIds_webId String Web ID of the SharePoint subsite.
parentReference_siteId String ID of the overall site the item was shared from.
webUrl String Direct link to open the shared item in OneDrive.
LinkedcreatedByUser String Indicates whether the item is linked to its original creator.
LinkedlastModifiedByUser String Indicates whether the item is linked to the user who last modified it.
audio_album String Title of the album the audio file belongs to.
audio_albumArtist String Name of the album's primary artist.
audio_artist String Artist credited with the audio track.
audio_bitrate Long Bitrate of the audio file, measured in kilobits per second.
audio_composers String List of composers credited for the track.
audio_copyright String Copyright notice associated with the audio file.
audio_disc Int Disc number of the audio album, if part of a multi-disc set.
audio_discCount Int Total number of discs in the audio album.
audio_duration Long Duration of the audio file in milliseconds.
audio_genre String Genre classification of the audio content.
audio_hasDrm Bool Indicates whether the audio file is protected by Digital Rights Management (DRM).
audio_isVariableBitrate Bool Indicates whether the audio file uses variable bitrate encoding.
audio_title String Title of the audio track.
audio_track Int Track number of the audio file within its album.
audio_trackCount Int Total number of tracks in the album.
audio_year Int Year the audio track was released.
bundle_album_coverImageItemId String ID of the item used as the album's cover image.
bundle_childCount Int Number of child items (files or folders) in a bundled collection.
content String Binary content stream of the shared file. This field cannot be updated directly.
cTag String Tag used to represent the current state of the item's content.
deleted_state String Indicates whether the item is in a deleted or recycled state.
file_hashes_crc32Hash String CRC32 checksum of the file for basic integrity verification.
file_hashes_quickXorHash String QuickXor hash used for efficient file integrity checks.
file_hashes_sha1Hash String SHA-1 hash of the file used for content validation.
file_hashes_sha256Hash String SHA-256 hash of the file for secure content validation.
file_mimeType String MIME type describing the format of the file.
file_processingMetadata Bool Indicates whether the file includes metadata related to processing.
fileSystemInfo_createdDateTime Datetime Timestamp when the file was originally created.
fileSystemInfo_lastAccessedDateTime Datetime Timestamp of the most recent access to the file.
fileSystemInfo_lastModifiedDateTime Datetime Timestamp of the last modification to the file.
folder_childCount Int Number of items (files and subfolders) in the folder.
folder_view_sortBy String Field used to sort the folder's contents.
folder_view_sortOrder String Sort direction used (ascending or descending).
folder_view_viewType String Preferred display layout for the folder (for example, thumbnails or list).
image_height Int Height of the image in pixels.
image_width Int Width of the image in pixels.
location_altitude Double Altitude where the item, (such as a photo) was captured.
location_latitude Double Latitude where the item was captured.
location_longitude Double Longitude where the item was captured.
malware_description String Description of any malware detected in the file.
package_type String Type of package represented by the item (for example, notebook or folder).
pendingOperations_pendingContentUpdate_queuedDateTime Datetime Timestamp when a pending content update was queued.
photo_cameraMake String Camera manufacturer used to capture the photo.
photo_cameraModel String Camera model used to capture the photo.
photo_exposureDenominator Double Denominator of the exposure setting used (for example, 60 for 1/60 sec).
photo_exposureNumerator Double Numerator of the exposure setting used.
photo_fNumber Double F-number (aperture value) used to capture the photo.
photo_focalLength Double Focal length of the camera lens in millimeters.
photo_iso Int ISO sensitivity setting used when the photo was taken.
photo_orientation Int Orientation flag indicating how the image should be rotated or displayed.
photo_takenDateTime Datetime Timestamp when the photo was taken.
publication_checkedOutBy_application_displayName String Display name of the application that checked out the item.
publication_checkedOutBy_application_id String ID of the application that checked out the item.
publication_level String Publication level of the item (for example, draft or published).
publication_versionId String Version identifier of the published item.
remoteItem_createdBy_application_displayName String Name of the app that created the original file on a different drive.
remoteItem_createdBy_application_id String ID of the app that created the original file on a different drive.
remoteItem_createdDateTime Datetime Timestamp when the remote item was created.
remoteItem_file_hashes_crc32Hash String CRC32 checksum of the remote file for integrity validation.
remoteItem_file_hashes_quickXorHash String QuickXor hash used for fast integrity checks on the remote file.
remoteItem_file_hashes_sha1Hash String SHA-1 hash of the remote file content for validation.
remoteItem_file_hashes_sha256Hash String SHA-256 hash of the remote file content for secure verification.
remoteItem_file_mimeType String MIME type indicating the content format of the remote file.
remoteItem_file_processingMetadata Bool Indicates whether the remote file includes metadata used during processing.
remoteItem_fileSystemInfo_createdDateTime Datetime Timestamp indicating when the remote file was originally created.
remoteItem_fileSystemInfo_lastAccessedDateTime Datetime Timestamp of the most recent access to the remote file.
remoteItem_fileSystemInfo_lastModifiedDateTime Datetime Timestamp of the last modification made to the remote file.
remoteItem_folder_childCount Int Number of child items (files or subfolders) contained in the remote folder
remoteItem_folder_view_sortBy String Field used to sort the remote folder's contents (for example, name or date).
remoteItem_folder_view_sortOrder String Direction in which the remote folder�s contents are sorted (ascending or descending).
remoteItem_folder_view_viewType String Preferred display layout for viewing the contents of the remote folder (for example, list or thumbnails).
remoteItem_id String Unique identifier of the remote item that was shared.
remoteItem_image_height Int Height of the remote image file in pixels.
remoteItem_image_width Int Width of the remote image file in pixels.
remoteItem_lastModifiedDateTime Datetime Timestamp when the remote item was last modified.
remoteItem_name String Name of the remote file or folder.
remoteItem_package_type String Type of package the item represents (for example, notebook or folder).
remoteItem_parentReference_driveId String ID of the drive that hosts the shared remote item.
remoteItem_parentReference_driveType String Type of drive the remote item resides in (for example, personal or business).
remoteItem_parentReference_id String ID of the parent item or folder containing the remote item.
remoteItem_parentReference_name String Name of the parent item or folder.
remoteItem_parentReference_path String Full path to the remote item within the drive.
remoteItem_parentReference_shareId String Share ID that identifies the shared reference for the remote item.
remoteItem_parentReference_sharepointIds_listId String SharePoint list ID associated with the remote item.
remoteItem_parentReference_sharepointIds_listItemId String ID of the item within a SharePoint list.
remoteItem_parentReference_sharepointIds_listItemUniqueId String Globally Unique ID (GUID) of the SharePoint list item.
remoteItem_parentReference_sharepointIds_siteId String ID of the SharePoint site that contains the item.
remoteItem_parentReference_sharepointIds_siteUrl String URL of the SharePoint site hosting the remote item.
remoteItem_parentReference_sharepointIds_tenantId String ID of the Microsoft 365 tenant that owns the SharePoint content.
remoteItem_parentReference_sharepointIds_webId String Web ID of the SharePoint site collection.
remoteItem_parentReference_siteId String ID of the overall site associated with the remote item.
remoteItem_shared_scope String Scope of the remote item's sharing (for example, organization or users).
remoteItem_shared_sharedDateTime Datetime Timestamp of when the remote item was shared.
remoteItem_size Long Size of the remote item in bytes.
remoteItem_specialFolder_name String Name of the special folder type (for example, Documents or Photos) the remote item belongs to.
remoteItem_video_audioBitsPerSample Int Bit depth of the audio track, indicating the number of bits used to represent each audio sample.
remoteItem_video_audioChannels Int Number of audio channels in the video file, such as 2 for stereo or 6 for surround sound.
remoteItem_video_audioFormat String Format of the audio track in the video. For example, AAC or MP3.
remoteItem_video_audioSamplesPerSecond Int Audio sample rate, showing how many audio samples are captured per second (measured in hertz).
remoteItem_video_bitrate Int Bitrate of the video file, representing how much data is processed per second.
remoteItem_video_duration Long Length of the video in milliseconds.
remoteItem_video_fourCC String Four-character code (FourCC) identifying the video codec used.
remoteItem_video_frameRate Double Frame rate of the video, indicating how many frames are displayed per second.
remoteItem_video_height Int Height of the video resolution in pixels.
remoteItem_video_width Int Width of the video resolution in pixels.
remoteItem_webDavUrl String URL used to access the remote item via Web Distributed Authoring and Versioning (WebDAV).
remoteItem_webUrl String Web link to view the remote item in a browser.
searchResult_onClickTelemetryUrl String URL used for tracking clicks on search results, primarily for telemetry purposes.
shared_owner_application_displayName String Display name of the application that originally shared the item.
shared_owner_application_id String Unique ID of the application that originally shared the item.
shared_scope String Scope of sharing, such as whether the item is shared with specific users or more broadly across an organization.
shared_sharedDateTime Datetime Date and time the item was shared with the signed-in user.
sharepointIds_listId String ID of the SharePoint list containing the item.
sharepointIds_listItemId String ID of the specific item within the SharePoint list.
sharepointIds_listItemUniqueId String GUID for the list item across the SharePoint environment.
sharepointIds_siteId String ID of the SharePoint site that owns the item.
sharepointIds_siteUrl String URL of the SharePoint site where the item resides.
sharepointIds_tenantId String ID of the Microsoft 365 tenant associated with the SharePoint content.
sharepointIds_webId String ID of the web within the SharePoint site collection.
size Long Size of the shared item in bytes.
specialFolder_name String Name of the special folder category the item belongs to, such as Documents or Photos.
video_audioBitsPerSample Int Bit depth of the video's audio track.
video_audioChannels Int Number of audio channels in the video (for example, mono or stereo).
video_audioFormat String Audio codec used in the video file.
video_audioSamplesPerSecond Int Audio sampling rate of the video, measured in hertz.
video_bitrate Int Total bitrate of the video file.
video_duration Long Total duration of the video in milliseconds.
video_fourCC String FourCC identifying the video codec.
video_frameRate Double Number of frames per second in the video.
video_height Int Height of the video resolution in pixels.
video_width Int Width of the video resolution in pixels.
webDavUrl String WebDAV URL for accessing the item.
Linkedanalytics String Provides access to usage analytics for the shared item, such as views and interactions.
Linkedchildren String Lists child items contained within a folder.
LinkedlistItem String References the list item associated with the file if it is part of a SharePoint list.
Linkedpermissions String Lists the permissions granted on the shared item.
LinkedretentionLabel String Provides information about the retention label applied to the item for compliance.
Linkedsubscriptions String References any subscriptions related to the item, such as webhook notifications.
Linkedthumbnails String Provides access to image thumbnails associated with the item.
Linkedversions String Lists previous versions of the file for version history tracking.
Linkedworkbook String Reference to the Excel workbook object if the file is an Excel document.

CData Cloud

Users

Lists users with OneDrive accounts in the organization, including user identifiers and profile 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 Unique identifier for the user object in the directory.
deletedDateTime Datetime Timestamp indicating when the user was deleted, if applicable.
accountEnabled Bool Indicates whether the user's account is currently active and can sign in.
businessPhones String List of business phone numbers associated with the user, separated by commas.
city String City specified in the user's business or work address.
companyName String Name of the user's employer or organization.
country String Country or region specified in the user's address.
createdDateTime Datetime Timestamp when the user account was created in the directory.
department String Department the user belongs to within the organization.
displayName String Full display name of the user, shown in directories and address books.
employeeHireDate Datetime Date the user was hired, used in HR and compliance contexts.
employeeId String Internal employee identifier assigned by the organization.
employeeOrgData_costCenter String Cost center to which the user is assigned for accounting or budgeting purposes.
employeeOrgData_division String Organizational division the user belongs to, such as Engineering or Sales.
employeeType String Type of employment, such as FullTime, Contractor, or Temporary.
givenName String User's first name or given name.
identities String List of sign-in identities (such as email, user ID) associated with the user.
imAddresses String List of instant messaging addresses (such as Skype or Teams), separated by commas.
isResourceAccount Bool Indicates whether the account is used as a resource, such as a conference room or shared mailbox.
jobTitle String Job title or role of the user in the organization.
lastPasswordChangeDateTime Datetime Date and time the user last changed their password.
mail String Primary email address of the user.
mailNickname String Alias or mail nickname used in email routing and internal references.
mobilePhone String User's mobile or cell phone number.
officeLocation String User's office room number or location description.
onPremisesDistinguishedName String Distinguished Name (DN) of the user in the on-premises Active Directory.
onPremisesDomainName String Domain name of the on-premises environment where the user is managed.
onPremisesExtensionAttributes_extensionAttribute1 String Custom extension attribute 1 from on-premises Active Directory.
onPremisesExtensionAttributes_extensionAttribute10 String Custom extension attribute 10 from on-premises Active Directory.
onPremisesExtensionAttributes_extensionAttribute11 String Custom extension attribute 11 from on-premises Active Directory.
onPremisesExtensionAttributes_extensionAttribute12 String Custom extension attribute 12 from on-premises Active Directory.
onPremisesExtensionAttributes_extensionAttribute13 String Custom extension attribute 13 from on-premises Active Directory.
onPremisesExtensionAttributes_extensionAttribute14 String Custom extension attribute 14 from on-premises Active Directory.
onPremisesExtensionAttributes_extensionAttribute15 String Custom extension attribute 15 from on-premises Active Directory.
onPremisesExtensionAttributes_extensionAttribute2 String Custom extension attribute 2 from on-premises Active Directory.
onPremisesExtensionAttributes_extensionAttribute3 String Custom extension attribute 3 from on-premises Active Directory.
onPremisesExtensionAttributes_extensionAttribute4 String Custom extension attribute 4 from on-premises Active Directory.
onPremisesExtensionAttributes_extensionAttribute5 String Custom extension attribute 5 from on-premises Active Directory.
onPremisesExtensionAttributes_extensionAttribute6 String Custom extension attribute 6 from on-premises Active Directory.
onPremisesExtensionAttributes_extensionAttribute7 String Custom extension attribute 7 from on-premises Active Directory.
onPremisesExtensionAttributes_extensionAttribute8 String Custom extension attribute 8 from on-premises Active Directory.
onPremisesExtensionAttributes_extensionAttribute9 String Custom extension attribute 9 from on-premises Active Directory.
onPremisesImmutableId String Unique ID used to map the cloud user to the on-premises AD user object.
onPremisesLastSyncDateTime Datetime Timestamp of the last sync operation from on-premises Active Directory.
onPremisesProvisioningErrors String List of errors that occurred during provisioning or sync from on-premises AD.
onPremisesSamAccountName String Security Account Manager (SAM) name used in Windows logon scenarios.
onPremisesSecurityIdentifier String Security identifier (SID) for the user in the on-premises AD environment.
onPremisesSyncEnabled Bool Indicates whether the user object is synchronized from on-premises Active Directory.
onPremisesUserPrincipalName String User principal name (UPN) used in the on-premises environment.
otherMails String List of additional email addresses associated with the user, separated by commas.
postalCode String Postal or ZIP code of the user's business address.
preferredLanguage String Preferred language for communications and system interfaces.
state String State or province listed in the user's address.
streetAddress String Street portion of the user's business address.
surname String User's last name or family name.
userPrincipalName String UPN used to log in, typically in the format [email protected].
userType String Type of user account, such as Member, Guest, or External.

CData Cloud

Stored Procedures

Stored procedures are function-like interfaces that extend the functionality of the Cloud 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.

CData Cloud - Microsoft OneDrive Stored Procedures

Name Description
CopyResource Copies a specified file or folder from one location in OneDrive to another, preserving content and structure.
CreateFolder Creates a new folder at a specified path within OneDrive to organize content.
CreateSubscription Registers a webhook subscription to receive notifications for changes to OneDrive content (for example, file updates).
DeleteResource Permanently deletes a specified file or folder from OneDrive, removing it from all views and history.
DeleteSubscription Removes an existing webhook subscription to stop receiving change notifications from OneDrive.
FetchAdditionalUserFields Retrieves tiered metadata fields (T1, T2, T3) for a specific user, typically for profiling or auditing.
GetAdminConsentURL Generates a URL that an admin must visit to grant tenant-wide OAuth permissions to your app; used when setting up enterprise integrations.
ModifySubscription Creates or updates a webhook subscription to listen for changes in OneDrive files, folders, or other resources.
MoveResource Relocates a file or folder within the OneDrive directory structure, maintaining metadata and permissions.
RenameResource Changes the name of a specified file or folder in OneDrive without affecting its contents or location.

CData Cloud

CopyResource

Copies a specified file or folder from one location in OneDrive to another, preserving content and structure.

Input

Name Type Required Description
ParentID String True ID of the destination folder where the resource should be copied. Required if the resource is being moved to a different location.
NewName String False Optional new name for the copied resource. If not provided, the resource retains its original name and can be copied to its current location regardless of ParentID.
ResourcePath String False Path to the resource being copied. Either ResourcePath or ResourceId must be provided to identify the source file or folder.
ResourceId String False Unique ID of the resource to be copied. Either ResourceId or ResourcePath must be provided.
SourceDriveId String False ID of the source drive where the resource currently resides. Only required when the resource is in a different drive than the user's default.
DestinationDriveId String False ID of the target drive where the resource should be copied. Needed when the destination is in a different drive than the source.

Result Set Columns

Name Type Description
Success String Indicates whether the copy operation was successful. Returns success status or error details.

CData Cloud

CreateFolder

Creates a new folder at a specified path within OneDrive to organize content.

Input

Name Type Required Description
FolderName String True Name to assign to the new folder being created.
RenameIfExists String False Set to 'true' to automatically rename the new folder if a folder with the same name already exists in the target location.
ParentId String False ID of the parent folder where the new folder should be created.
DriveId String False ID of the target drive where the new folder will be created. Use this when creating the folder in a drive other than the user's default drive.

Result Set Columns

Name Type Description
Id String Unique identifier assigned to the newly created folder.

CData Cloud

CreateSubscription

Registers a webhook subscription to receive notifications for changes to OneDrive content (for example, file updates).

Input

Name Type Required Description
ChangeType String True Specifies the types of changes to monitor for the resource. Supported values are: created, updated, deleted. Multiple values can be provided as a comma-separated list, with a space after each comma.
NotificationUrl String True HTTPS endpoint URL that will receive change notifications when the specified resource changes.
Resource String True Path to the resource to monitor for changes. The path should not include the base URL such as https://graph.microsoft.com/v1.0/.
ExpirationDateTime String True UTC timestamp indicating when the subscription should expire. The maximum allowed duration depends on the resource type being monitored.
ClientState String False Custom string value, up to 128 characters, sent back with each notification to help validate that the notification came from the expected source.

Result Set Columns

Name Type Description
Id String Unique identifier assigned to the newly created subscription.

CData Cloud

DeleteResource

Permanently deletes a specified file or folder from OneDrive, removing it from all views and history.

Input

Name Type Required Description
ResourcePath String False Path to the resource that should be deleted. Either ResourcePath or ResourceId must be provided to identify the item.
ResourceId String False Unique ID of the resource to be deleted. Either ResourceId or ResourcePath must be provided.
DriveId String False ID of the drive that contains the resource. Specify this only if the resource is in a drive other than the current user's default drive.
Permanently Boolean False Set to 'true' to permanently delete the resource. If not specified or set to 'false', the resource is moved to the recycle bin instead.

The default value is false.

Result Set Columns

Name Type Description
Success String Indicates whether the delete operation was successful. Returns success status or error information.

CData Cloud

DeleteSubscription

Removes an existing webhook subscription to stop receiving change notifications from OneDrive.

Input

Name Type Required Description
Id String True Unique identifier of the subscription to be deleted.

Result Set Columns

Name Type Description
Success String Indicates the result of the delete operation. Returns success status or error details if the subscription could not be removed.

CData Cloud

FetchAdditionalUserFields

Retrieves tiered metadata fields (T1, T2, T3) for a specific user, typically for profiling or auditing.

Input

Name Type Required Description
UserId String True Unique identifier of the user whose additional fields are being retrieved.
IncludeFields String False Comma-separated list of specific user fields to include in the results. Add 1 space after each comma in the list.
ExcludeFields String False Comma-separated list of specific user fields to exclude from the results. Add 1 space after each comma in the list.

Result Set Columns

Name Type Description
* String Returns all user fields available in the schema, including any requested additional fields and excluding any specified in ExcludeFields.

CData Cloud

GetAdminConsentURL

Generates a URL that an admin must visit to grant tenant-wide OAuth permissions to your app; used when setting up enterprise integrations.

Input

Name Type Required Description
CallbackUrl String False The URL to which the user is redirected after authorizing the application. This must exactly match the reply URL configured in the Azure AD application settings.
State String False Space-separated list of permissions the application is requesting from the administrator. Each scope defines a level of access.
Scope String False Space-separated list of permissions the application is requesting from the administrator. Each scope defines a level of access.

The default value is https://graph.microsoft.com/files.readwrite.all.

Result Set Columns

Name Type Description
URL String The full authorization URL that should be opened in a web browser to prompt the admin for consent and return an authorization code.

CData Cloud

ModifySubscription

Creates or updates a webhook subscription to listen for changes in OneDrive files, folders, or other resources.

Input

Name Type Required Description
ExpirationDateTime String True UTC timestamp indicating the new expiration time for the subscription.
Id String True Unique identifier of the subscription to be modified.

Result Set Columns

Name Type Description
Id String Unique identifier of the updated subscription.
ChangeType String Type of change that triggers the subscription. Possible values include created, updated, deleted.
NotificationUrl String Webhook URL that receives notifications when the subscribed resource changes.
Resource String Relative path of the resource the subscription applies to. Does not include the base Microsoft Graph URL.
ExpirationDateTime String Updated UTC expiration timestamp of the subscription.
ClientState String Custom string provided at subscription creation, returned in each change notification to verify source authenticity.

CData Cloud

MoveResource

Relocates a file or folder within the OneDrive directory structure, maintaining metadata and permissions.

Stored Procedure Specific Information

Microsoft OneDrive allows only a small subset of columns to be used in the Exec query. DestinationID and either of ResourcePath or ResourceId is required to move the resource. These columns can typically be used with only = comparison.

If file is present in the root folder of a OneDrive account, then mention the file name directly for the value of ResourcePath. For example:

EXECUTE MoveResource ResourcePath = 'Book.xlsx', DestinationID = '01JSGDQ3MFCITWE4PQKFAY6KH5LHJKPYU5'

If file is present inside a child folder of a OneDrive account, then you need to specify the path of the file starting from child folder name for the value of ResourcePath. For example:

EXECUTE MoveResource ResourcePath = 'Notebooks/test.png', DestinationID = '01JSGDQ3MFCITWE4PQKFAY6KH5LHJKPYU5'

You can also move the resource by providing the ResourceId and DestinationID as well. For example:

EXECUTE MoveResource ResourceId = '01CYQN2MFPR6NIWVZNMNFL3SL4E3KF7IHY', DestinationID = '01JSGDQ3MFCITWE4PQKFAY6KH5LHJKPYU5'

Input

Name Type Required Description
DestinationID String True ID of the destination folder where the resource should be moved.
ResourcePath String False Path to the resource to be moved. Either ResourcePath or ResourceId must be provided to identify the item.
ResourceId String False Unique identifier of the resource to move. Either ResourceId or ResourcePath must be provided.
DriveId String False ID of the drive containing the resource. Required only if the resource is located in a drive different from the user's default drive.

Result Set Columns

Name Type Description
Success String Indicates whether the move operation was successful. Returns success status or error details.

CData Cloud

RenameResource

Changes the name of a specified file or folder in OneDrive without affecting its contents or location.

Input

Name Type Required Description
ResourceId String True Unique identifier of the resource to be renamed.
Name String True New name to assign to the resource.
DriveId String False ID of the drive where the resource is located. Specify this only if the resource is not in the current user's default drive.

Result Set Columns

Name Type Description
Success String Indicates whether the rename operation was successful. Returns success status or error details.

CData Cloud

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

CData Cloud

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.

CData Cloud

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.

CData Cloud

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.

CData Cloud

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.
ColumnType String The role or classification of the column in the schema. Possible values include SYSTEM, LINKEDCOLUMN, NAVIGATIONKEY, REFERENCECOLUMN, and NAVIGATIONPARENTCOLUMN.

CData Cloud

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.

CData Cloud

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

To include result set columns in addition to the parameters, set the IncludeResultColumns pseudo column to True:

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'DownloadResource' AND IncludeResultColumns='True'

Columns

Name Type Description
CatalogName String The name of the database containing the stored procedure.
SchemaName String The name of the schema containing the stored procedure.
ProcedureName String The name of the stored procedure containing the parameter.
ColumnName String The name of the stored procedure parameter.
Direction Int32 An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters.
DataType Int32 An integer indicating the data type. This value is determined at run time based on the environment.
DataTypeName String The name of the data type.
NumericPrecision Int32 The maximum precision for numeric data. The column length in characters for character and date-time data.
Length Int32 The number of characters allowed for character data. The number of digits allowed for numeric data.
NumericScale Int32 The number of digits to the right of the decimal point in numeric data.
IsNullable Boolean Whether the parameter can contain null.
IsRequired Boolean Whether the parameter is required for execution of the procedure.
IsArray Boolean Whether the parameter is an array.
Description String The description of the parameter.
Ordinal Int32 The index of the parameter.
Values String The values you can set in this parameter are limited to those shown in this column. Possible values are comma-separated.
SupportsStreams Boolean Whether the parameter represents a file that you can pass as either a file path or a stream.
IsPath Boolean Whether the parameter is a target path for a schema creation operation.
Default String The value used for this parameter when no value is specified.
SpecificName String A label that, when multiple stored procedures have the same name, uniquely identifies each identically-named stored procedure. If there's only one procedure with a given name, its name is simply reflected here.
IsCDataProvided Boolean Whether the procedure is added/implemented by CData, as opposed to being a native Microsoft OneDrive procedure.

Pseudo-Columns

Name Type Description
IncludeResultColumns Boolean Whether the output should include columns from the result set in addition to parameters. Defaults to False.

CData Cloud

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.

CData Cloud

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.

CData Cloud

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.

CData Cloud

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.

CData Cloud

sys_connection_props

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

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

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns

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

CData Cloud

sys_sqlinfo

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

See SQL Compliance for SQL syntax details.

Discovering the Data Source's SELECT Capabilities

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

NameDescriptionPossible Values
AGGREGATE_FUNCTIONSSupported aggregation functions.AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNTWhether COUNT function is supported.YES, NO
IDENTIFIER_QUOTE_OPEN_CHARThe opening character used to escape an identifier.[
IDENTIFIER_QUOTE_CLOSE_CHARThe closing character used to escape an identifier.]
SUPPORTED_OPERATORSA list of supported SQL operators.=, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BYWhether GROUP BY is supported, and, if so, the degree of support.NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
OJ_CAPABILITIESThe supported varieties of outer joins supported.NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS
OUTER_JOINSWhether outer joins are supported.YES, NO
SUBQUERIESWhether subqueries are supported, and, if so, the degree of support.NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED
STRING_FUNCTIONSSupported 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_FUNCTIONSSupported 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_FUNCTIONSSupported 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_TABLESIndicates tables skipped during replication.
REPLICATION_TIMECHECK_COLUMNSA 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_PATTERNString value indicating what string is valid for an identifier.
SUPPORT_TRANSACTIONIndicates if the provider supports transactions such as commit and rollback.YES, NO
DIALECTIndicates the SQL dialect to use.
KEY_PROPERTIESIndicates the properties which identify the uniform database.
SUPPORTS_MULTIPLE_SCHEMASIndicates if multiple schemas may exist for the provider.YES, NO
SUPPORTS_MULTIPLE_CATALOGSIndicates if multiple catalogs may exist for the provider.YES, NO
DATASYNCVERSIONThe CData Data Sync version needed to access this driver.Standard, Starter, Professional, Enterprise
DATASYNCCATEGORYThe CData Data Sync category of this driver.Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQLWhether enhanced SQL functionality beyond what is offered by the API is supported.TRUE, FALSE
SUPPORTS_BATCH_OPERATIONSWhether batch operations are supported.YES, NO
SQL_CAPAll 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_OPTIONSA string value specifies the preferred cacheOptions.
ENABLE_EF_ADVANCED_QUERYIndicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side.YES, NO
PSEUDO_COLUMNSA string array indicating the available pseudo columns.
MERGE_ALWAYSIf the value is true, The Merge Mode is forcibly executed in Data Sync.TRUE, FALSE
REPLICATION_MIN_DATE_QUERYA select query to return the replicate start datetime.
REPLICATION_MIN_FUNCTIONAllows a provider to specify the formula name to use for executing a server side min.
REPLICATION_START_DATEAllows a provider to specify a replicate startdate.
REPLICATION_MAX_DATE_QUERYA select query to return the replicate end datetime.
REPLICATION_MAX_FUNCTIONAllows a provider to specify the formula name to use for executing a server side max.
IGNORE_INTERVALS_ON_INITIAL_REPLICATEA list of tables which will skip dividing the replicate into chunks on the initial replicate.
CHECKCACHE_USE_PARENTIDIndicates whether the CheckCache statement should be done against the parent key column.TRUE, FALSE
CREATE_SCHEMA_PROCEDURESIndicates 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.

CData Cloud

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.

CData Cloud

sys_information

Describes the available system information.

The following query retrieves all columns:

SELECT * FROM sys_information

Columns

NameTypeDescription
ProductStringThe name of the product.
VersionStringThe version number of the product.
DatasourceStringThe name of the datasource the product connects to.
NodeIdStringThe unique identifier of the machine where the product is installed.
HelpURLStringThe URL to the product's help documentation.
LicenseStringThe license information for the product. (If this information is not available, the field may be left blank or marked as 'N/A'.)
LocationStringThe file path location where the product's library is stored.
EnvironmentStringThe version of the environment or rumtine the product is currently running under.
DataSyncVersionStringThe tier of CData Sync required to use this connector.
DataSyncCategoryStringThe category of CData Sync functionality (e.g., Source, Destination).

CData Cloud

Data Type Mapping

Data Type Mappings

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

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

CData Cloud

Connection String Options

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

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

Authentication


PropertyDescription
AuthSchemeSpecifies the type of authentication to use when connecting to Microsoft OneDrive. If this property is left blank, the default authentication is used.

Azure Authentication


PropertyDescription
AzureTenantIdentifies the Microsoft OneDrive tenant being used to access data. Accepts either the tenant's domain name (for example, contoso.onmicrosoft.com ) or its directory (tenant) ID.
AzureEnvironmentSpecifies the Azure network environment to which you will connect. Must be the same network to which your Azure account was added.

OAuth


PropertyDescription
OAuthClientIdSpecifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
OAuthClientSecretSpecifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).
ScopeSpecifies the scope of the authenticating user's access to the application, to ensure they get appropriate access to data. If a custom OAuth application is needed, this is generally specified at the time the application is created.

JWT OAuth


PropertyDescription
OAuthJWTCertSupplies the name of the client certificate's JWT Certificate store.
OAuthJWTCertTypeIdentifies the type of key store containing the JWT Certificate.
OAuthJWTCertPasswordProvides the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
OAuthJWTCertSubjectIdentifies the subject of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '*' to select the first certificate.

SSL


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

Logging


PropertyDescription
VerbositySpecifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.

Schema


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

Miscellaneous


PropertyDescription
DefaultGroupsDetermines whether to use the /me/memberOf or /groups endpoint for user authentication.
DefaultUserDetermines whether to use the /me or /users endpoint for user authentication.
DirectoryRetrievalDepthThis property specifies how many folder levels deep to retrieve results for the Folders, Files, SharedResources, and Permissions tables.
DriveIdSpecifies the unique identifier (Id) of the Microsoft OneDrive drive to query or interact with. Use this property to target a specific drive when multiple drives are available for the authenticated user.
GroupIdSpecify a default GroupId.
IncludeFoldersWithFilesSpecifies whether folders should be included in the results when retrieving files.
ListGroupDrivesSpecifies whether to include group (shared) drives when querying the Drives table.
MaxRowsSpecifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
PagesizeThe maximum number of results to return per page from Microsoft OneDrive.
PseudoColumnsSpecifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
ThrowsKeyNotFoundSpecifies whether or not throws an exception if there is no rows updated.
TimeoutSpecifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
UserIdSpecify a default UserId.
CData Cloud

Authentication

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


PropertyDescription
AuthSchemeSpecifies the type of authentication to use when connecting to Microsoft OneDrive. If this property is left blank, the default authentication is used.
CData Cloud

AuthScheme

Specifies the type of authentication to use when connecting to Microsoft OneDrive. If this property is left blank, the default authentication is used.

Possible Values

AzureAD, AzureServicePrincipal, AzureServicePrincipalCert

Data Type

string

Default Value

"AzureAD"

Remarks

AuthScheme values include:

  • AzureAD (default): Perform Azure Active Directory (user-based) OAuth authentication.
  • AzureMSI: Automatically obtain Azure AD Managed Service Identity credentials when running on an Azure VM.
  • AzureServicePrincipal: Authenticate as an Azure Service Principal (role-based, application-based) using a Client Secret.
  • AzureServicePrincipalCert: Authenticate as an Azure Service Principal (role-based, application-based) using a Certificate.

For information about creating a custom application to authenticate with Azure AD, see Creating an Entra ID (Azure AD) Application.

For information about creating a custom application to authenticate with Azure AD Service Principal, see Creating a Service Principal App in Entra ID (Azure AD).

CData Cloud

Azure Authentication

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


PropertyDescription
AzureTenantIdentifies the Microsoft OneDrive tenant being used to access data. Accepts either the tenant's domain name (for example, contoso.onmicrosoft.com ) or its directory (tenant) ID.
AzureEnvironmentSpecifies the Azure network environment to which you will connect. Must be the same network to which your Azure account was added.
CData Cloud

AzureTenant

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

Data Type

string

Default Value

""

Remarks

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

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

This property is required in the following cases:

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

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

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

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

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

CData Cloud

AzureEnvironment

Specifies the Azure network environment to which you will connect. Must be the same network to which your Azure account was added.

Possible Values

GLOBAL, CHINA, USGOVT, USGOVTDOD

Data Type

string

Default Value

"GLOBAL"

Remarks

Required if your Azure account is part of a different network than the Global network, such as China, USGOVT, or USGOVTDOD.

CData Cloud

OAuth

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


PropertyDescription
OAuthClientIdSpecifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
OAuthClientSecretSpecifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).
ScopeSpecifies the scope of the authenticating user's access to the application, to ensure they get appropriate access to data. If a custom OAuth application is needed, this is generally specified at the time the application is created.
CData Cloud

OAuthClientId

Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.

Data Type

string

Default Value

""

Remarks

This property is required in two cases:

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

(When the driver provides embedded OAuth credentials, this value may already be provided by the Cloud and thus not require manual entry.)

OAuthClientId is generally used alongside other OAuth-related properties such as OAuthClientSecret and OAuthSettingsLocation when configuring an authenticated connection.

OAuthClientId is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can usually find this value in your identity provider’s application registration settings. Look for a field labeled Client ID, Application ID, or Consumer Key.

While the client ID is not considered a confidential value like a client secret, it is still part of your application's identity and should be handled carefully. Avoid exposing it in public repositories or shared configuration files.

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

CData Cloud

OAuthClientSecret

Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).

Data Type

string

Default Value

""

Remarks

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

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

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

Notes:

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

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

CData Cloud

Scope

Specifies the scope of the authenticating user's access to the application, to ensure they get appropriate access to data. If a custom OAuth application is needed, this is generally specified at the time the application is created.

Data Type

string

Default Value

""

Remarks

Scopes are set to define what kind of access the authenticating user will have; for example, read, read and write, restricted access to sensitive information. System administrators can use scopes to selectively enable access by functionality or security clearance.

When InitiateOAuth is set to GETANDREFRESH, you must use this property if you want to change which scopes are requested.

When InitiateOAuth is set to either REFRESH or OFF, you can change which scopes are requested using either this property or the Scope input.

CData Cloud

JWT OAuth

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


PropertyDescription
OAuthJWTCertSupplies the name of the client certificate's JWT Certificate store.
OAuthJWTCertTypeIdentifies the type of key store containing the JWT Certificate.
OAuthJWTCertPasswordProvides the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
OAuthJWTCertSubjectIdentifies the subject of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '*' to select the first certificate.
CData Cloud

OAuthJWTCert

Supplies the name of the client certificate's JWT Certificate store.

Data Type

string

Default Value

""

Remarks

The OAuthJWTCertType field specifies the type of the certificate store specified in OAuthJWTCert. If the store is password-protected, use OAuthJWTCertPassword to supply the password..

OAuthJWTCert is used in conjunction with the OAuthJWTCertSubject field in order to specify client certificates. If OAuthJWTCert has a value, and OAuthJWTCertSubject is set, the CData Cloud initiates a search for a certificate. For further information, see OAuthJWTCertSubject.

Designations of certificate stores are platform-dependent.

Notes

  • The most common User and Machine certificate stores in Windows include:
    • 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).

CData Cloud

OAuthJWTCertType

Identifies the type of key store containing the JWT Certificate.

Possible Values

PFXBLOB, JKSBLOB, PEMKEY_BLOB, PUBLIC_KEY_BLOB, SSHPUBLIC_KEY_BLOB, XMLBLOB, BCFKSBLOB

Data Type

string

Default Value

"PEMKEY_BLOB"

Remarks

ValueDescriptionNotes
USERA certificate store owned by the current user. Only available in Windows.
MACHINEA machine store.Not available in Java or other non-Windows environments.
PFXFILEA PFX (PKCS12) file containing certificates.
PFXBLOBA string (base-64-encoded) representing a certificate store in PFX (PKCS12) format.
JKSFILEA Java key store (JKS) file containing certificates.Only available in Java.
JKSBLOBA string (base-64-encoded) representing a certificate store in Java key store (JKS) format. Only available in Java.
PEMKEY_FILEA PEM-encoded file that contains a private key and an optional certificate.
PEMKEY_BLOBA string (base64-encoded) that contains a private key and an optional certificate.
PUBLIC_KEY_FILEA file that contains a PEM- or DER-encoded public key certificate.
PUBLIC_KEY_BLOBA string (base-64-encoded) that contains a PEM- or DER-encoded public key certificate.
SSHPUBLIC_KEY_FILEA file that contains an SSH-style public key.
SSHPUBLIC_KEY_BLOBA string (base-64-encoded) that contains an SSH-style public key.
P7BFILEA PKCS7 file containing certificates.
PPKFILEA file that contains a PPK (PuTTY Private Key).
XMLFILEA file that contains a certificate in XML format.
XMLBLOBAstring that contains a certificate in XML format.
BCFKSFILEA file that contains an Bouncy Castle keystore.
BCFKSBLOBA string (base-64-encoded) that contains a Bouncy Castle keystore.

CData Cloud

OAuthJWTCertPassword

Provides the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.

Data Type

string

Default Value

""

Remarks

This property specifies the password needed to open a password-protected certificate store. To determine if a password is necessary, refer to the documentation or configuration for your specific certificate store.

CData Cloud

OAuthJWTCertSubject

Identifies the subject of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '*' to select the first certificate.

Data Type

string

Default Value

"*"

Remarks

The value of this property is used to locate a matching certificate in the store. The search process works as follows:

  • If an exact match for the subject is found, the corresponding certificate is selected.
  • If no exact match is found, the store is searched for certificates whose subjects contain the property value.
  • If no match is found, no certificate is selected.

You can set the value to '*' to automatically select the first certificate in the store. The certificate subject is a comma-separated list of distinguished name fields and values. For example: CN=www.server.com, OU=test, C=US, [email protected].

Common fields include:

FieldMeaning
CNCommon Name. This is commonly a host name like www.server.com.
OOrganization
OUOrganizational Unit
LLocality
SState
CCountry
EEmail Address

If a field value contains a comma, enclose it in quotes. For example: "O=ACME, Inc.".

CData Cloud

SSL

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


PropertyDescription
SSLServerCertSpecifies the certificate to be accepted from the server when connecting using TLS/SSL.
CData Cloud

SSLServerCert

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

Data Type

string

Default Value

""

Remarks

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

This property can take the following forms:

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

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

CData Cloud

Logging

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


PropertyDescription
VerbositySpecifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.
CData Cloud

Verbosity

Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.

Data Type

string

Default Value

"1"

Remarks

This property defines the level of detail the Cloud includes in the log file. Higher verbosity levels increase the detail of the logged information, but may also result in larger log files and slower performance due to the additional data being captured.

The default verbosity level is 1, which is recommended for regular operation. Higher verbosity levels are primarily intended for debugging purposes. For more information on each level, refer to Logging.

When combined with the LogModules property, Verbosity can refine logging to specific categories of information.

CData Cloud

Schema

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


PropertyDescription
BrowsableSchemasOptional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
CData Cloud

BrowsableSchemas

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

Data Type

string

Default Value

""

Remarks

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

CData Cloud

Miscellaneous

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


PropertyDescription
DefaultGroupsDetermines whether to use the /me/memberOf or /groups endpoint for user authentication.
DefaultUserDetermines whether to use the /me or /users endpoint for user authentication.
DirectoryRetrievalDepthThis property specifies how many folder levels deep to retrieve results for the Folders, Files, SharedResources, and Permissions tables.
DriveIdSpecifies the unique identifier (Id) of the Microsoft OneDrive drive to query or interact with. Use this property to target a specific drive when multiple drives are available for the authenticated user.
GroupIdSpecify a default GroupId.
IncludeFoldersWithFilesSpecifies whether folders should be included in the results when retrieving files.
ListGroupDrivesSpecifies whether to include group (shared) drives when querying the Drives table.
MaxRowsSpecifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
PagesizeThe maximum number of results to return per page from Microsoft OneDrive.
PseudoColumnsSpecifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
ThrowsKeyNotFoundSpecifies whether or not throws an exception if there is no rows updated.
TimeoutSpecifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
UserIdSpecify a default UserId.
CData Cloud

DefaultGroups

Determines whether to use the /me/memberOf or /groups endpoint for user authentication.

Possible Values

AllGroups, CurrentUser

Data Type

string

Default Value

"AllGroups"

Remarks

Determines whether to use the /me/memberOf or /groups endpoint for user authentication.

Supported values are:

  • CurrentUser: Uses the /me/memberOf endpoint for user authentication.
  • AllGroups: Uses the /groups endpoint for user authentication.

CData Cloud

DefaultUser

Determines whether to use the /me or /users endpoint for user authentication.

Possible Values

AllUsers, CurrentUser

Data Type

string

Default Value

"CurrentUser"

Remarks

Determines whether to use the /me or /users endpoint for user authentication.

Supported values are:

  • CurrentUser: Uses the /me endpoint for user authentication.
  • AllUsers: Uses the /users endpoint for user authentication.

CData Cloud

DirectoryRetrievalDepth

This property specifies how many folder levels deep to retrieve results for the Folders, Files, SharedResources, and Permissions tables.

Data Type

string

Default Value

"5"

Remarks

If not specified, the Cloud uses a default value of DirectoryRetrievalDepth=5. If set to -1, all files and folders on the drive are retrieved, regardless of depth.

Resources located directly in the root are at depth 0, while resources one folder deeper are at depth 1, and so forth.

CData Cloud

DriveId

Specifies the unique identifier (Id) of the Microsoft OneDrive drive to query or interact with. Use this property to target a specific drive when multiple drives are available for the authenticated user.

Data Type

string

Default Value

""

Remarks

By default, the provider uses the main drive of the logged-in user.

To list all available Drive Ids, query the Drives table.

CData Cloud

GroupId

Specify a default GroupId.

Data Type

string

Default Value

""

Remarks

Specify a default GroupId.

CData Cloud

IncludeFoldersWithFiles

Specifies whether folders should be included in the results when retrieving files.

Data Type

bool

Default Value

false

Remarks

By default, folders are not included in the files view.

Set this property to True to include folders along with files. Use the ResourceType column to distinguish between files and folders.

CData Cloud

ListGroupDrives

Specifies whether to include group (shared) drives when querying the Drives table.

Data Type

bool

Default Value

false

Remarks

By default, Microsoft OneDrive will only include the user's drives.

If set to True, Microsoft OneDrive will include group drives in the results.

CData Cloud

MaxRows

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

Data Type

int

Default Value

-1

Remarks

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

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

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

CData Cloud

Pagesize

The maximum number of results to return per page from Microsoft OneDrive.

Data Type

int

Default Value

1000

Remarks

The Pagesize property affects the maximum number of results to return per page from Microsoft OneDrive. While the data source optimizes the default page size for most use cases, you may need to adjust this value depending on the specific object or service endpoint you are querying. Increasing the page size may improve performance, but it could also result in higher memory consumption per page.

The maximum allowed value for pagesize for Users, Groups and GroupMembers views is 999. For others it is 5000.

CData Cloud

PseudoColumns

Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.

Data Type

string

Default Value

""

Remarks

This property allows you to define which pseudocolumns the Cloud exposes as table columns.

To specify individual pseudocolumns, use the following format:

Table1=Column1;Table1=Column2;Table2=Column3

To include all pseudocolumns for all tables use:

*=*

CData Cloud

ThrowsKeyNotFound

Specifies whether or not throws an exception if there is no rows updated.

Data Type

bool

Default Value

false

Remarks

Specifies whether or not throws an exception if there is no rows updated.

CData Cloud

Timeout

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

Data Type

int

Default Value

60

Remarks

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

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

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

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

CData Cloud

UserId

Specify a default UserId.

Data Type

string

Default Value

""

Remarks

Specify a default UserId.

CData Cloud

Third Party Copyrights

LZMA from 7Zip LZMA SDK

LZMA SDK is placed in the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or distribute the original LZMA SDK code, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.

LZMA2 from XZ SDK

Version 1.9 and older are in the public domain.

Xamarin.Forms

Xamarin SDK

The MIT License (MIT)

Copyright (c) .NET Foundation Contributors

All rights reserved.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

NSIS 3.10

Copyright (C) 1999-2025 Contributors THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS COMMON PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.

1. DEFINITIONS

"Contribution" means:

a) in the case of the initial Contributor, the initial code and documentation distributed under this Agreement, and b) in the case of each subsequent Contributor:

i) changes to the Program, and

ii) additions to the Program;

where such changes and/or additions to the Program originate from and are distributed by that particular Contributor. A Contribution 'originates' from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include additions to the Program which: (i) are separate modules of software distributed in conjunction with the Program under their own license agreement, and (ii) are not derivative works of the Program.

"Contributor" means any person or entity that distributes the Program.

"Licensed Patents " mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program.

"Program" means the Contributions distributed in accordance with this Agreement.

"Recipient" means anyone who receives the Program under this Agreement, including all Contributors.

2. GRANT OF RIGHTS

a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, distribute and sublicense the Contribution of such Contributor, if any, and such derivative works, in source code and object code form.

b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in source code and object code form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder.

c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program.

d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement.

3. REQUIREMENTS

A Contributor may choose to distribute the Program in object code form under its own license agreement, provided that:

a) it complies with the terms and conditions of this Agreement; and

b) its license agreement:

i) effectively disclaims on behalf of all Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose;

ii) effectively excludes on behalf of all Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits;

iii) states that any provisions which differ from this Agreement are offered by that Contributor alone and not by any other party; and

iv) states that source code for the Program is available from such Contributor, and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange.

When the Program is made available in source code form:

a) it must be made available under this Agreement; and

b) a copy of this Agreement must be included with each copy of the Program.

Contributors may not remove or alter any copyright notices contained within the Program.

Each Contributor must identify itself as the originator of its Contribution, if any, in a manner that reasonably allows subsequent Recipients to identify the originator of the Contribution.

4. COMMERCIAL DISTRIBUTION

Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense.

For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages.

5. NO WARRANTY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations.

6. DISCLAIMER OF LIABILITY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

7. GENERAL

If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.

If Recipient institutes patent litigation against a Contributor with respect to a patent applicable to software (including a cross-claim or counterclaim in a lawsuit), then any patent licenses granted by that Contributor to such Recipient under this Agreement shall terminate as of the date such litigation is filed. In addition, if Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed.

All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive.

Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. IBM is the initial Agreement Steward. IBM may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to distribute the Program (including its Contributions) under the new version. Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved.

This Agreement is governed by the laws of the State of New York and the intellectual property laws of the United States of America. No party to this Agreement will bring a legal action under this Agreement more than one year after the cause of action arose. Each party waives its rights to a jury trial in any resulting litigation.

Copyright (c) 2026 CData Software, Inc. - All rights reserved.
Build 25.0.9539