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

Connecting to Dropbox

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

Accessing Data from CData Cloud Services

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

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

Connecting to Dropbox

Dropbox uses the OAuth authentication standard.

Dropbox OAuth Scopes

You need to choose between using CData's embedded OAuth app or Creating a Custom OAuth App.

The enabled scopes of the connecting OAuth app determine which tables, views, and stored procedures are accessible using the Cloud.

Specifically, the embedded OAuth app lacks the scopes required to access certain views (namely Events, and Teams, TeamMembers) and a stored procedure (DeletePermanently). To access these, you need to create your own custom app and grant the following permissions:

• team_info.read
• files.permanent_delete
• members.read
• groups.read
• team_data.member
• events.read

When To Create a Custom OAuth Application

CData embeds OAuth Application Credentials with CData branding that can be used when connecting via a .

You may choose to use your own OAuth Application Credentials when you want to

• control branding of the Authentication Dialog
• control the redirect URI that the application redirects the user to after the user authenticates
• customize the permissions that you are requesting from the user

Create a Custom OAuth App

1. Log in to your Dropbox developers dashboard and click Create New App. Select the Dropbox API type. Select the Full Dropbox access for your app.
2. After creating your app, you can view Configuration from the main menu that displays your app settings.
3. On the app Settings tab, note the values of App key and App secret for later Cloud configuration.
4. Set the Redirect URI and store the specified value for later Cloud configuration.
   • When setting up a , set the Redirect URI to http://localhost:33333 or a different port number.
5. On the app Permissions tab, select the scope of user permissions your app will request.

No further values need to be specified in the Dropbox app settings.

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.

Connecting Through a Firewall or Proxy

HTTP Proxies

To authenticate to an HTTP proxy, set the following:

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

Other Proxies

Set the following properties:

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

The CData Cloud models Dropbox data as an easy-to-use SQL database, using tables, 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. Some Dropbox data is related to other data. For instance, in the tables, foreign keys (like matching IDs) show how different records are related.

Tables

The Tables section, which details standard SQL tables, and the Views section, which lists read-only SQL tables, contain samples of what you might have access to in your Dropbox account.

The following tables and views are shipped with the Cloud:

Table	Description
FileLinks	Lists all shared links associated with files in a user's Dropbox, enabling insight into external sharing activity.
Files	Provides detailed information about all files stored in a user's Dropbox, including metadata such as size, path, and last modified time.
FolderLinks	Displays shared links for folders in a user's Dropbox, allowing you to audit folder-level sharing.
Folders	Lists folders within a user's Dropbox account, along with metadata including folder paths and creation details.
DeletedResources	Displays files or folders that have been deleted from a user's Dropbox account, useful for tracking removals or recovering data.
Events	Captures activity logs for a Dropbox Business team, including file sharing, edits, logins, and permission changes.
FileRequests	Shows active and past file requests initiated by the user, including requester details and file submissions.
FileSharedMembers	Returns a list of users who have access to a specific shared file, including their permissions and roles.
FolderSharedMembers	Returns users who have been granted access to a shared folder, along with their permission levels.
SharedFiles	Provides a list of files the user has shared with others, including file paths, access settings, and shared link info.
SharedLinkMetadata	Retrieves metadata about a shared link, such as link visibility, expiration date, and associated resource details.
TeamMembers	Lists all members of a Dropbox Business team, including account details, status, and assigned roles.
Teams	Returns metadata about the current Dropbox Business team, such as team ID, name, and sharing policies.
Users	Retrieves account information for multiple users, helpful for team administration or access audits.

Stored Procedures

Stored Procedures are SQL scripts that extend beyond standard CRUD operations. These stored procedures enable advanced operations such as monitoring asynchronous job status, managing access by adding members to shared files, and facilitating OAuth authentication and token management.

The Cloud models the data in Dropbox as a list of tables in a relational database that can be queried using standard SQL statements.

CData Cloud - Dropbox Tables

Name	Description
FileLinks	Lists all shared links associated with files in a user's Dropbox, enabling insight into external sharing activity.
Files	Provides detailed information about all files stored in a user's Dropbox, including metadata such as size, path, and last modified time.
FolderLinks	Displays shared links for folders in a user's Dropbox, allowing you to audit folder-level sharing.
Folders	Lists folders within a user's Dropbox account, along with metadata including folder paths and creation details.

Lists all shared links associated with files in a user's Dropbox, enabling insight into external sharing activity.

Table Specific Information

The following scopes are required to access this view: sharing.read

Select

The Cloud uses the Dropbox API to process search criteria that refer to the FilePath or Revision columns. The Cloud processes other filters client-side within the Cloud. For example, the following queries are processed server side.

SELECT * FROM FileLinks WHERE FilePath = '/Test Folder'

SELECT * FROM FileLinks WHERE Revision = '4e52306b0'

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	True	A unique identifier for the shared file link.
Url [KEY]	String	False	The URL of the shared Dropbox link for the file.
Name	String	True	The name of the file associated with the shared link, including its extension.
CanRevoke	Boolean	True	Indicates whether the user has permission to revoke (disable) the shared link.
ResolvedVisibilityPermission	String	True	The effective visibility of the link after applying team and shared folder policies. This may differ from the originally requested visibility.
RequestedVisibilityPermission	String	False	The visibility setting requested by the link creator. This may be overridden by team or folder policies. Basic users can only set RequestedVisibility.public as the requested visibility. The allowed values are public, team_only, password.
RevokeFailureReason	String	True	The reason why the shared link cannot be revoked. Present only when the CanRevoke field is False.
ClientModified	Datetime	True	The timestamp when the file was last modified by the desktop client before upload.
ServerModified	Datetime	True	The timestamp of the most recent modification made to the file on Dropbox servers.
Revision	String	True	A unique Id representing the current revision of the file.
Size	Long	True	The size of the file in bytes.
PathLower	String	True	The full Dropbox path to the file in lowercase, used for consistency in path matching.
FilePath	String	False	The original cased path of the file, used for display purposes.
TeamId	String	True	The unique identifier of the Dropbox team the user belongs to.
TeamName	String	True	The registered name of the Dropbox team.
TeamDisplayName	String	True	The display name of the user who shared the file.
TeamMemberId	String	True	The team member Id of the user who created the link; present only if that user belongs to the same team as the current user.
ContentOwnerId	String	True	The unique Id of the team that owns the content being shared.
ContentOwnerName	String	True	The name of the team that owns the content.
RemoveExpiration	Boolean	False	When set to True, removes any expiration date set for the shared link. The default value is False.
RequestedAccess	String	False	The access level (such as viewer or editor) requested for users accessing the shared link. Modifying access on an existing link is not supported. This field is optional. The allowed values are viewer, editor, max.
Expires	Datetime	False	The expiration date and time of the shared link, if one is set. By default, links do not expire. This field is optional. Basic users can only use RequestedVisibility.public.
LinkPassword	String	False	The password required to access the link if RequestedVisibility is set to password. This field is optional.
Audience	String	False	The group of users (such as team members or anyone with the link) who can access the file based on the link's access level. The allowed values are public, team, no_one, password.

Provides detailed information about all files stored in a user's Dropbox, including metadata such as size, path, and last modified time.

Table Specific Information

The following scopes are required to access this view: files.metadata.read

Select

The Cloud uses the Dropbox API to process search criteria that refer to the Id, FilePath, or ParentId columns. The Cloud processes other filters client-side within the Cloud. For example, the following queries are processed server side.

SELECT * FROM Files WHERE Id = 'id:a4ayc_80_OEAAAAAAAAAYa'

SELECT * FROM Files WHERE ParentId = 'id:a4aad_40_OEACHSBDLKAYa'

SELECT * FROM Files WHERE FilePath = '/TestFolder/test.png'

Note that the FilePath filter will only return data for one specific file, since the FilePath is an absolute path. If you want to get data for all the files underneath a specified folder path, filter using ParentId. ParentId is a unique identifier for the containing folder. You can only retrieve the files that are located directly in this folder, not in its subfolders.

Delete

The Cloud uses the Dropbox API to process search criteria that refer to the Id column in order to perform a DELETE operation on a file. For example, the following queries are processed server side:

DELETE FROM Files WHERE Id = 'id:a4aad_40_OEACHSBDLKAYa'

DELETE FROM Files WHERE Id IN ('id:a4aad_40_OEACHSBDLKAYa', 'id:a4aad_40_OEACHSB3234234')

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	True	A unique identifier for the file in Dropbox.
Name	String	True	The name of the file, including its extension (for example, report.pdf).
ClientModified	Datetime	True	The timestamp when the file was last modified by the client before being uploaded to Dropbox.
ServerModified	Datetime	True	The timestamp of the most recent modification to the file on Dropbox servers.
Revision	String	True	A unique identifier representing the current revision of the file.
Size	Long	True	The size of the file in bytes.
DisplayPath	String	True	The original cased file path, intended for display purposes.
SymlinkInfoTarget	String	True	If the file is a symbolic link (symlink), this field indicates the target path the symlink points to.
HasExplicitSharedMembers	Boolean	True	Indicates whether the file has explicitly assigned shared members.
ContentHash	String	True	A hash value representing the file's contents, used to verify file integrity.
ReadOnly	Boolean	True	True when the file resides in a shared folder where the user has read-only access.
ParentSharedFolderId	String	True	The Id of the shared folder containing this file.
ModifiedBy	String	True	The identifier of the user who last modified the file.
ParentId	String	True	The unique Id of the folder that contains this file. Use this in filters to retrieve files from a specific folder.
FilePath	String	True	The full path of the file in Dropbox. Use this in filters to retrieve a file by its exact path.

Displays shared links for folders in a user's Dropbox, allowing you to audit folder-level sharing.

Table Specific Information

The following scopes are required to access this view: sharing.read

Select

The Cloud uses the Dropbox API to process search criteria that refer to the FolderPath column. The Cloud processes other filters client-side within the Cloud. For example, the following queries are processed server side.

SELECT * FROM FolderLinks WHERE FolderPath = '/Test Folder'

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	True	A unique identifier for the shared folder link.
Url [KEY]	String	False	The URL of the shared Dropbox link for the folder.
Name	String	True	The name of the linked folder. Folder names never contain slashes.
CanRevoke	Boolean	True	Indicates whether the user has permission to revoke (disable) the shared link.
ResolvedVisibilityPermission	String	True	The effective visibility of the link after applying team and shared folder policies. This may differ from the originally requested visibility.
RevokeFailureReason	String	True	The reason the shared link cannot be revoked. Present only when the CanRevoke field is false.
PathLower	String	True	The lowercase version of the full Dropbox path to the folder. Always begins with a slash.
TeamId	String	True	The unique identifier of the Dropbox team that owns the folder.
TeamName	String	True	The registered name of the Dropbox team.
TeamDisplayName	String	True	The display name of the user who created the link.
TeamMemberId	String	True	The team member Id of the user who created the link; present only if that user is part of the current user's team.
ContentOwnerId	String	True	The unique Id of the team that owns the folder.
ContentOwnerName	String	True	The name of the team that owns the folder.
FolderPath	String	False	The Dropbox folder path used to retrieve shared folder links under a specific location. Use this in filters to narrow results.
RemoveExpiration	Boolean	False	If True, removes any expiration date from the shared link. The default value is False.
RequestedVisibilityPermission	String	False	The visibility level originally requested by the link creator. This can be overridden by team or folder policies. Basic users can only set the visibility level to RequestedVisibility.public. The allowed values are public, team_only, password.
RequestedAccess	String	False	The access level (such as viewer or editor) requested for users accessing the shared folder. Changing access level on an existing link is not supported. This field is optional. The allowed values are viewer, editor, max.
Expires	Datetime	False	The expiration date and time of the shared folder link, if set. By default, links do not expire. This field is optional. Basic users can only set RequestedVisibility.public.
LinkPassword	String	False	If the link visibility is set to password, this specifies the password required to access the folder. This field is optional.
Audience	String	False	The group of users (such as anyone with the link or team-only) allowed to access the folder using the shared link, based on the link's access level in the LinkPermissions field. The allowed values are public, team, no_one, password.

Lists folders within a user's Dropbox account, along with metadata including folder paths and creation details.

Table Specific Information

The following scope is required to access this view: files.metadata.read

Select

The Cloud uses the Dropbox API to process search criteria that refer to the Id, FolderPath, or exact matches on the DisplayPath column. Other filters are processed client-side within the Cloud.

For example, the following queries are processed server-side:

-- Retrieves a specific folder by its unique Id
SELECT * FROM Folders WHERE Id = 'id:a4ayc_80_OEAAAAAAAAAXz';

-- Retrieves folders under the specified path (server-side filtering)
SELECT * FROM Folders WHERE FolderPath = '/Test Folder';

-- Retrieves exactly one folder with this display path (server-side filtering)
SELECT * FROM Folders WHERE DisplayPath = '/folder1/folderA/folderB/folderC';

Delete

The Cloud uses the Dropbox API to process search criteria that refer to the Id column in order to perform a DELETE operation on a folder.

For example, the following queries are processed server-side:

-- Deletes a folder by Id
DELETE FROM Folders WHERE Id = 'id:a4ayc_80_OEAAAAAAAAAYa';

-- Deletes multiple folders by Id
DELETE FROM Folders WHERE Id IN ('id:a4ayc_80_OEAAAAAAAAAYa', 'id:a4aad_40_OEACHSB3234234');

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	True	A unique identifier for the folder in Dropbox.
Name	String	True	The name of the folder.
DisplayPath	String	True	The original cased folder path, used for display purposes.
ReadOnly	Boolean	True	True when the folder is located in a shared folder where the user has read-only permissions.
ParentSharedFolderId	String	True	The Id of the shared folder that contains this folder, if applicable.
SharedFolderId	String	True	The Id of the shared folder that is mounted at this location, if this folder is a shared-folder mount point.
TraverseOnly	Boolean	True	True when the user can only traverse the folder path and has limited visibility into its contents, due to restricted access permissions.
NoAccess	Boolean	True	True when the user has no access to the folder and cannot view or interact with its contents.
FolderPath	String	True	The Dropbox folder path used to retrieve subfolders. Use this in filters to return folders under a specified path.

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 - Dropbox Views

Name	Description
DeletedResources	Displays files or folders that have been deleted from a user's Dropbox account, useful for tracking removals or recovering data.
Events	Captures activity logs for a Dropbox Business team, including file sharing, edits, logins, and permission changes.
FileRequests	Shows active and past file requests initiated by the user, including requester details and file submissions.
FileSharedMembers	Returns a list of users who have access to a specific shared file, including their permissions and roles.
FolderSharedMembers	Returns users who have been granted access to a shared folder, along with their permission levels.
SharedFiles	Provides a list of files the user has shared with others, including file paths, access settings, and shared link info.
SharedFolders	Returns folders shared with other users, including membership status, access rights, and folder metadata.
SharedLinkMetadata	Retrieves metadata about a shared link, such as link visibility, expiration date, and associated resource details.
TeamMembers	Lists all members of a Dropbox Business team, including account details, status, and assigned roles.
Teams	Returns metadata about the current Dropbox Business team, such as team ID, name, and sharing policies.
Users	Retrieves account information for multiple users, helpful for team administration or access audits.

Displays files or folders that have been deleted from a user's Dropbox account, useful for tracking removals or recovering data.

Table Specific Information

The following scopes are required to access this view: files.metadata.read

Select

The Cloud uses the Dropbox API to process search criteria that refer to the Path column. The Cloud processes other filters client-side within the Cloud. For example, the following queries are processed server side.

SELECT * FROM DeletedResources WHERE Path = '/Test path'

Columns

Name	Type	Description
Name	String	The name of the deleted file or folder, including its file extension if applicable.
Path	String	The full Dropbox path where the file or folder was located before it was deleted.

Captures activity logs for a Dropbox Business team, including file sharing, edits, logins, and permission changes.

Table Specific Information

The following scopes are required to access this view: events.read

Select

The Cloud uses the Dropbox API to process search criteria that refer to the StartTime or EndTime columns. The Cloud processes other filters client-side within the Cloud. For example, the following queries are processed server side.

SELECT * FROM Events WHERE StartTime = '2020-04-05'

SELECT * FROM Events WHERE EndTime = '2020-04-05'

SELECT * FROM Events WHERE StartTime = '2020-04-05' AND EndTime = '2020-06-12'

Columns

Name	Type	Description
Timestamp	Timestamp	The Dropbox timestamp indicating when the event occurred.
Category	String	The general category associated with the type of action performed (for example, file operations, team changes, or sharing).
Type	String	The specific action type that was performed, such as file download, user login, or folder creation.
Description	String	A human-readable summary of the event type.
DetailsTag	String	A schema tag representing additional structured details about the specific event.
ErrorUserFriendlyMessage	String	A user-friendly message describing the error, if the action resulted in an error.
IsEmmManaged	Boolean	Indicates whether the action was performed in an environment managed by an Enterprise Mobility Management (EMM) system.
LoginMethod	String	The method used by the user to log in, such as password, single sign-on, or OAuth.
AppInfoTag	String	Structured tag containing information about the application involved in the action.
AppInfoAppId	String	The unique identifier of the app associated with the event.
AppInfoDisplayName	String	The display name of the app that initiated or was involved in the action.
IsGroupOwner	Boolean	Indicates whether the user is the owner of a group involved in the event.
IsCompanyManaged	Boolean	Indicates whether the company or organization is using Dropbox in a managed enterprise environment.
ActorTag	String	Represents the entity who performed the action. May be missing due to historical data gaps.
ActorAdminTag	String	Structured tag representing administrative information about the actor.
ActorAdminAccountId	String	The account Id of the administrator who performed the action.
ActorAdminDisplayName	String	The display name of the administrator who performed the action.
ActorAdminEmail	String	The email address of the administrator.
ActorAdminTeamMemberId	String	The team member Id of the administrator.
ActorAppTag	String	Structured tag representing the app as the actor.
ActorAppId	String	The unique identifier of the app that performed the action.
ActorAppDisplayName	String	The display name of the app that performed the action.
ContextTag	String	Represents the user or team on whose behalf the action was taken. Can be missing due to historical data gaps.
ContextAccountId	String	The account Id of the user or team in the context of the event.
ContextDisplayName	String	The display name of the user or team associated with the context.
ContextEmail	String	The email address of the user in context.
ContextTeamMemberId	String	The team member Id of the user in context.
AccessMethodTag	String	The method used to access Dropbox, such as web, desktop application, mobile app, or API.
EndUserWebSessionId	String	The session Id for the user's web session during the event.
EndUserDesktopSessionId	String	The session Id for the user's desktop app session during the event.
EndUserMobileSessionId	String	The session Id for the user's mobile app session during the event.
SignInAsWebSessionId	String	The session Id for 'sign-in-as' activity by an admin impersonating another user.
ContentManagerWebSessionId	String	The session Id for the content manager's web session.
AdminConsoleWebSessionId	String	The session Id for the admin console used during the event.
EnterpriseConsoleSessionId	String	The session Id for the enterprise console if used.
ApiSessionRequestId	String	The request Id associated with the API session that triggered the event.
GeoLocationIpAddress	String	The IP address from which the action was performed.
GeoLocationCity	String	The city associated with the IP address where the event occurred.
GeoLocationRegion	String	The geographic region (such as state or province) associated with the IP address.
GeoLocationCountry	String	The country associated with the IP address.
InvolveNonTeamMembers	Boolean	Indicates whether the event involved individuals outside the Dropbox team (non-team members).

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
StartTime	Timestamp	Filter for events that occurred at or after this start timestamp.
EndTime	Timestamp	Filter for events that occurred at or before this end timestamp.

Shows active and past file requests initiated by the user, including requester details and file submissions.

Table Specific Information

The following scopes are required to access this view: file_requests.read

Select

The Cloud uses the Dropbox API to process search criteria that refer to the Id column. The Cloud processes other filters client-side within the Cloud. For example, the following queries are processed server side.

SELECT * FROM FileRequests WHERE Id = '21df34jrksd213'

Columns

Name	Type	Description
Id [KEY]	String	A unique identifier for the file request.
Url	String	The URL of the file request, which can be shared with contributors to upload files.
Title	String	The title or name assigned to the file request, used to identify its purpose.
Created	Datetime	The timestamp indicating when the file request was created.
IsOpen	Boolean	Indicates whether the file request is currently open. If False, no additional files can be submitted.
FileCount	Long	The number of files submitted to this file request.
Destination	String	The Dropbox folder path where uploaded files are stored.
Deadline	Datetime	The deadline after which users can no longer submit files, unless late uploads are allowed.
AllowLateUploads	String	Allows users to upload files after the deadline has passed, if enabled.

Returns a list of users who have access to a specific shared file, including their permissions and roles.

Select

To query the File Shared Members view, FileId must be specified in the WHERE clause. For example:

SELECT * FROM FileSharedMembers WHERE FileId = 'id:yd_M3luYSgoAAAAAAAAADw';

Columns

Name	Type	Description
FileId [KEY]	String	The unique identifier of the shared file to which the member has access.
Email [KEY]	String	The email address of the user or invitee with access to the shared file.
MemberId	String	The unique identifier of the shared member.
MemberType	String	Specifies the type of member, such as User (an existing Dropbox account) or Invitee (a user invited by email who has not yet joined).
AccessType	String	The level of access granted to the member for the shared file, such as viewer or editor.

Returns users who have been granted access to a shared folder, along with their permission levels.

Select

To query the Folder Shared Members view, FolderId must be specified in the WHERE clause. For example:

SELECT * FROM FolderSharedMembers WHERE FolderId = '12765611987';

Columns

Name	Type	Description
FolderId [KEY]	String	The unique identifier of the shared folder to which the member has been granted access.
Email [KEY]	String	The email address of the user or invitee who has access to the shared folder.
MemberId	String	The unique identifier of the shared member.
MemberType	String	Indicates whether the member is a User (existing Dropbox account) or an Invitee (invited via email but not yet joined).
AccessType	String	The level of access granted to the member for the shared folder, such as viewer or editor.

Provides a list of files the user has shared with others, including file paths, access settings, and shared link info.

Table Specific Information

The following scopes are required to access this view: sharing.read

Select

The Cloud uses the Dropbox API to process search criteria that refer to the Id column. The Cloud processes other filters client-side within the Cloud. For example, the following queries are processed server side.

SELECT * FROM SharedFiles WHERE Id = 'id:3kmLmQFnf1AAAAAAAAAAAw'

Columns

Name	Type	Description
Id [KEY]	String	The unique identifier of the shared file.
Name	String	The name of the shared file.
AclUpdatePolicy	String	Defines who is allowed to add or remove members from the shared file or its parent folder.
SharedLinkPolicy	String	Specifies whose shared links can be used or reshared for this file.
MemberPolicy	String	Indicates who can be a member of the shared folder, based on the folder-level setting.
ResolvedMemberPolicy	String	The effective membership policy for the shared folder, taking into account both the folder's setting and the team-wide policy.
ViewerInfoPolicy	String	Specifies who can enable or disable viewer info (such as who viewed the file) for this shared file.
PreviewUrl	String	A URL that can be used to open a web-based preview of the shared file.
AccessType	String	The access level of the current user for the shared file (for example, viewer or editor).
OwnerDisplayName	String	The display name of the file owner. Multiple names may appear if there are multiple owners.
OwnerTeamId	String	The unique identifier of the team that owns the file.
OwnerTeamName	String	The name of the team that owns the file.
ParentSharedFolderId	String	The Id of the shared folder that contains this file, if applicable.
PathDisplay	String	The original cased Dropbox path of the file, intended for display purposes.
PathLower	String	The lowercase version of the full Dropbox path to the file. Not present for unmounted files.
TimeInvited	Datetime	The timestamp indicating when the current user was invited to access the shared file.

Returns folders shared with other users, including membership status, access rights, and folder metadata.

Table Specific Information

The following scopes are required to access this view: sharing.read

Select

The Cloud uses the Dropbox API to process search criteria that refer to the Id column. The Cloud processes other filters client-side within the Cloud. For example, the following queries are processed server side.

SELECT * FROM SharedFolders WHERE Id = '4336523543654'

Columns

Name	Type	Description
Id [KEY]	String	A unique identifier for the shared folder.
AccessType	String	The current user's access level for this shared folder, such as viewer or editor.
IsInsideTeamFolder	Boolean	True when this shared folder is located inside a team folder.
IsTeamFolder	Boolean	True when this folder is designated as a team folder.
Name	String	The name of the shared folder.
AclUpdatePolicy	String	Specifies who is allowed to add or remove members from this shared folder.
SharedLinkPolicy	String	Defines whose shared links can be used or reshared for content in this folder.
MemberPolicy	String	Indicates who can be a member of this shared folder based on folder-level settings.
ResolvedMemberPolicy	String	The effective membership policy for the folder, factoring in both folder-level and team-wide policies.
ViewerInfoPolicy	String	Specifies who can enable or disable viewer information (such as who viewed the folder's contents).
PreviewUrl	String	A URL for displaying a web-based preview of the shared folder.
TimeInvited	Datetime	The timestamp when the current user was invited to join the shared folder.
OwnerDisplayName	String	The display names of the users who own the folder. Multiple owners may be listed.
OwnerTeamId	String	The unique identifier of the team that owns the folder.
OwnerTeamName	String	The name of the team that owns the folder.
ParentSharedFolderId	String	The Id of the parent shared folder, if this folder is nested within another shared folder.
PathLower	String	The lowercase version of the full Dropbox path to the shared folder. Not present for unmounted folders.
AccessInheritance	String	Indicates whether the folder inherits its membership from the parent folder.

Retrieves metadata about a shared link, such as link visibility, expiration date, and associated resource details.

Select

To query the Shared Link Metadata view, Url must be specified in the WHERE clause. For example:

SELECT * FROM SharedLinkMetadata WHERE Url = 'https://www.dropbox.com/scl/fo/fdc98vi57mlxv7wt6suc7/AI7kXKLxhDUJIx04RfDqvTQ?rlkey=cjafltizui04c28w1t4n0in4f&st=z0t9vo0v&dl=0';

Columns

Name	Type	Description
Type	String	The type of the linked entry: file or folder.
ClientModified	Timestamp	The timestamp when the file was last modified by the desktop client before being uploaded to Dropbox.
Id	String	A unique identifier for the file or folder referenced by the shared link.
AllowComments	Boolean	Indicates whether comments are allowed on the shared link.
AllowDownload	Boolean	Indicates whether users can download the file or folder from the shared link.
AudienceOptions	String	Specifies the audience settings that determine who can access the shared link.
CanAllowDownload	Boolean	Indicates whether download permission can be enabled for the shared link.
CanDisallowDownload	Boolean	Indicates whether download permission can be disabled for the shared link.
CanRemoveExpiry	Boolean	Indicates whether the expiration date on the shared link can be removed.
CanRemovePassword	Boolean	Indicates whether password protection can be removed from the shared link.
CanRevoke	Boolean	Indicates whether the shared link can be revoked by the user.
CanSetExpiry	Boolean	Indicates whether an expiration date can be set on the shared link.
CanSetPassword	Boolean	Indicates whether a password can be set for the shared link.
RequirePassword	Boolean	Indicates whether a password is required to access the shared link.
ResolvedVisibility	String	The final visibility setting of the link after applying all folder and team-level sharing policies.
RevokeFailureReason	String	The reason the link cannot be revoked, if applicable.
TeamRestrictsComments	Boolean	Indicates whether the team has restricted commenting on shared links.
VisibilityPolicies	String	Details the visibility policies that govern how the link can be shared.
Name	String	The name of the file or folder associated with the shared link.
PathLower	String	The full Dropbox path of the file or folder, in lowercase format.
Rev	String	The revision identifier for the file, used to track changes over time.
ServerModified	Timestamp	The timestamp when the file was last modified on Dropbox servers.
Size	String	The size of the file in bytes.
OwnerDisplayName	String	The display name of the user who owns the file or folder.
OwnerMemberId	String	The member Id of the file or folder owner.
OwnerTeamId	String	The unique Id of the team that owns the file or folder.
OwnerTeamName	String	The name of the team that owns the file or folder.
Url [KEY]	String	The URL of the shared link.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
Password	String	The password protecting the shared link, if one is set.

Lists all members of a Dropbox Business team, including account details, status, and assigned roles.

Table Specific Information

The following scopes are required to access this view: members.read

Columns

Name	Type	Description
Id	String	The unique Id of the user as a member of the team.
Email	String	The email address associated with the user's Dropbox account.
EmailVerified	Boolean	Indicates whether the user's email address has been verified as belonging to them.
Status	String	The user's current status within the team, such as active, suspended, or invited.
GivenName	String	The user's given name (first name).
Surname	String	The user's surname (last name or family name).
FamiliarName	String	A locale-specific familiar name. In the US, typically the given name; in other locales, it may combine given name and surname.
DisplayName	String	The full name displayed for the user in Dropbox interfaces.
AbbreviatedName	String	An abbreviated version of the user's name, typically consisting of their initials.
MembershipType	String	Indicates the user's type of membership in the team (such as full member or limited access).
MemberFolderId	String	The namespace Id of the user's root folder within the team space.
ExternalId	String	An optional external identifier assigned by the team or application for internal tracking purposes.
AccountId	String	The unique account identifier for the user in Dropbox.
JoinedOn	Timestamp	The timestamp indicating when the user joined the team.
ProfilePhotoURL	String	The URL of the user's profile photo, if one has been uploaded.
Role	String	The user's role in the team, such as Member or Admin.

Returns metadata about the current Dropbox Business team, such as team ID, name, and sharing policies.

Table Specific Information

The following scopes are required to access this view: team_info.read

Columns

Name	Type	Description
Id	String	The unique identifier of the Dropbox team.
Name	String	The name assigned to the team.
NumLicensedUsers	Integer	The number of user licenses available to the team.
NumProvisionedUsers	Integer	The number of user accounts that have been invited or are currently active members of the team.
EmmState	String	The current Enterprise Mobility Management (EMM) state for the team, indicating whether EMM is enabled, disabled, or enforced.
OfficeAddin	String	The admin-defined policy controlling the use of the Dropbox Office Add-In for this team.
SharedFolderMemberPolicy	String	Defines who is allowed to be added to folders shared by team members.
SharedFolderJoinPolicy	String	Specifies which shared folders team members are permitted to join.
SharedLinkCreatePolicy	String	Controls who can view or access shared links owned by team members.

Retrieves account information for multiple users, helpful for team administration or access audits.

Table Specific Information

The following scopes are required to access this view: account_info.read

Select

The Cloud uses the Dropbox API to process search criteria that refer to the Id column. The Cloud processes other filters client-side within the Cloud. For example, the following queries are processed server side.

SELECT * FROM Users WHERE Id = 'dbid:23443532432'

Columns

Name	Type	Description
Id [KEY]	String	The unique Dropbox identifier for the user.
FirstName	String	The user's given name (first name).
LastName	String	The user's surname (last name or family name).
FamiliarName	String	The user's locale-dependent familiar name. This may vary by region.
DisplayName	String	The user's full display name as shown in Dropbox interfaces.
AbbreviatedName	String	An abbreviated form of the user's name, typically consisting of initials.
Email	String	The user's email address.
IsEmailVerified	Boolean	True when the user's email address has been verified.
Disabled	Boolean	True when the user's Dropbox account has been disabled.
Locale	String	The language setting chosen by the user.
ReferralLink	String	The user's personal referral link for inviting others to Dropbox.
IsPaired	Boolean	True when the user has both a personal and a work account paired.
AccountType	String	The type of Dropbox account the user has, such as Basic, Plus, or Business.
ProfilePicUrl	String	The URL to the user's profile picture, if one has been set.
Country	String	The user's two-letter country code, if available.
TeamMemberId	String	The unique team member Id for the user. Present only if the user is part of a team.
TeamRootInfoRootNamespaceId	String	The namespace Id for the user's root namespace within the team.
TeamRootInfoHomeNamespaceId	String	The namespace Id for the user's home directory under the team structure.
TeamRootInfoHomePath	String	The path to the user's home folder within the shared team space.
UserRootInfoRootNamespaceId	String	The root namespace Id for the user's personal Dropbox space.
UserRootInfoHomeNamespaceId	String	The namespace Id for the user's personal home directory.
TeamId	String	The unique Id of the team the user belongs to.
TeamName	String	The name of the team the user is part of.
TeamSharedFolderMemberPolicy	String	Specifies who can be added to folders shared by team members.
TeamSharedFolderJoinPolicy	String	Defines which shared folders team members are allowed to join.
TeamSharedLinkCreatePolicy	String	Controls who can view or access shared links created by team members.
TeamOfficeAddinPolicy	String	The team's policy on the use of the Dropbox Office Add-In.

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

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

CData Cloud - Dropbox Stored Procedures

Name	Description
AddSharedFileMember	Grants a user access to a shared file by adding them as a member, assuming the caller has the appropriate permissions.
AddSharedFolderMember	Adds a user to a shared folder, allowing them to access its contents based on the specified permission level.
CheckJobStatus	Checks the progress of an asynchronous sharing or file operation, such as adding or removing users.
CopyResource	Creates a copy of a file or folder at a new Dropbox location; entire folder trees are duplicated if a folder is specified.
CreateFolder	Creates a new folder or multiple folders at specified Dropbox paths; supports batch folder creation via structured input.
DeletePermanently	Permanently deletes a file or folder from Dropbox with no recovery option; requires elevated deletion scope.
DeleteResource	Deletes a file or folder and its contents (if applicable) from Dropbox, moving it to the deleted state.
GetSpaceUsage	Returns current and total storage usage statistics for the Dropbox account, including shared and team-used space.
MoveResource	Moves a file or folder to a different path within the user's Dropbox. This operation supports moving entire folder contents.
RemoveSharedFileMember	Revokes a user's access to a shared file, removing them from the file's member list.
RemoveSharedFolderMember	Removes a member from a shared folder, provided the caller has the appropriate role and permissions.
RenameResource	Renames a file or folder by specifying the current path and a new name; path casing changes are not supported.
SearchFilesAndFolders	Searches for files and folders in a Dropbox account based on specified criteria.
SetAccessInheritance	Modifies whether a shared folder inherits access permissions from its parent, applicable in team-based Dropbox setups.
ShareFolder	Initiates sharing for a folder, allowing others to be invited with specified access roles; requires write-sharing privileges.
UnshareFolder	Removes all sharing permissions from a folder, making it private again; applicable only with sharing permissions.
UpdateProperties	Updates custom properties on a file or folder, including adding, editing, or removing property templates and key-value pairs.
UpdateSharedFileMember	Changes a member's role or permissions for a shared file, such as read-only or edit access.
UpdateSharedFolderMember	Modifies the access level of a user in a shared folder, such as promoting them to editor or revoking edit rights.

Grants a user access to a shared file by adding them as a member, assuming the caller has the appropriate permissions.

Input

Name	Type	Required	Description
FileId	String	True	The unique identifier of the file to which a new member is added.
Email	String	False	The email address of the user to be invited to the shared file.
DropboxId	String	False	The Dropbox Id of the user, team member, or group being granted access to the file.
AccessLevel	String	False	The permission level to assign to the new member (such as viewer, editor, or owner). The default is viewer.
CustomMessage	String	False	An optional message to include in the sharing invitation sent to the member.
AddMessageAsComment	Boolean	False	When set to True, the custom message is added as a comment on the file. The default value is false.
Quiet	Boolean	False	When set to True, suppresses email and device notifications typically sent when a member is added. The default value is false.

Result Set Columns

Name	Type	Description
Success	String	Returns a value of True when the member is successfully added to the file; otherwise, returns False.

Adds a user to a shared folder, allowing them to access its contents based on the specified permission level.

Input

Name	Type	Required	Description
FolderId	String	True	The unique identifier of the shared folder to which a new member is added.
Email	String	False	The email address of the user to be invited to the shared folder.
DropboxId	String	False	The Dropbox Id of the user, team member, or group being granted access to the folder.
AccessLevel	String	False	The permission level to assign to the new member (such as viewer, editor, or owner). The default is viewer.
CustomMessage	String	False	An optional message included in the sharing invitation sent to the member.
Quiet	Boolean	False	When set to true, suppresses email and device notifications that would normally be sent when a member is added. The default value is False.

Result Set Columns

Name	Type	Description
Success	String	Returns a value of True when the member is successfully added to the folder; otherwise, returns False.

Checks the progress of an asynchronous sharing or file operation, such as adding or removing users.

Input

Name	Type	Required	Description
JobId	String	True	The unique identifier of the asynchronous job whose status is being queried.

Result Set Columns

Name	Type	Description
Status	String	The current status of the job, such as in_progress, complete, or failed.

Creates a copy of a file or folder at a new Dropbox location; entire folder trees are duplicated if a folder is specified.

Input

Name	Type	Required	Description
From_Path	String	False	The full path of the file or folder in the user's Dropbox that should be copied or moved.
To_Path	String	False	The destination path in the user's Dropbox where the copied or moved item should be placed.
Autorename	Boolean	False	When set to true, Dropbox will automatically rename the file or folder to avoid conflicts at the destination. The default value is False.
Allow_Ownership_Transfer	Boolean	False	When set to true, permits the owner to move content even if the action would result in a change of ownership. This setting applies only to move operations, not copies. The default value is False.
ObjectPathsAggregate	String	False	An aggregate of object paths to be copied or moved. This can also reference a #TEMP table containing the paths.

Result Set Columns

Name	Type	Description
Success	String	Returns a value of True when the operation completed successfully; otherwise, returns False.

Creates a new folder or multiple folders at specified Dropbox paths; supports batch folder creation via structured input.

Input

Name	Type	Required	Description
Path	String	False	The full path in the user's Dropbox where the new folder should be created.
AutoRename	Boolean	False	When set to true, Dropbox will automatically rename the folder to avoid name conflicts with existing folders. The default value is false.
ForceAsync	Boolean	False	When set to true, forces the folder creation to run asynchronously. This option is available only when using ObjectPathsAggregate. The default value is false.
ObjectPathsAggregate	String	False	A JSON-formatted aggregate representing the folder paths to be created. This can also reference a #TEMP table containing the paths.

Result Set Columns

Name	Type	Description
Id	String	The unique identifier of the newly created folder.

Permanently deletes a file or folder from Dropbox with no recovery option; requires elevated deletion scope.

Behavior and Usage Notes

By default, this procedure only deletes items that are already in the Dropbox Deleted files section (the recycle bin). To delete items that are still active, set the ForceDelete input to true.

• Set ForceDelete to true to permanently delete any file or folder, regardless of its deletion status.
• Set ForceDelete to false only if the item has already been deleted and is in the recycle bin.
• To delete active files without setting ForceDelete, use DeleteResource then DeletePermanently.

Input

Name	Type	Required	Description
ForceDelete	String	False	When set to true, permanently deletes the file or folder even if its metadata has not been removed. Use with caution. The default value is false.
Path	String	False	The full path of the file or folder in Dropbox to be permanently deleted.
ObjectPathAggregate	String	False	An aggregate of file or folder paths to delete. Can be provided in XML, JSON, or as a #TEMP table.

Result Set Columns

Name	Type	Description
Success	String	Returns a value of True when the deletion is successful; otherwise, returns False.

Deletes a file or folder and its contents (if applicable) from Dropbox, moving it to the deleted state.

Input

Name	Type	Required	Description
Path	String	False	The full Dropbox path of the file or folder to be deleted.
ObjectPathsAggregate	String	False	An aggregate of file or folder paths to delete. Can also reference a #TEMP table containing the paths.

Result Set Columns

Name	Type	Description
Success	String	Returns a value of True when the file or folder is successfully deleted; otherwise, returns False.

Returns current and total storage usage statistics for the Dropbox account, including shared and team-used space.

Result Set Columns

Name	Type	Description
Used	String	The total amount of storage space currently used in the user's Dropbox account, measured in bytes.
Allocated	String	The total storage capacity allocated to the user's Dropbox account, measured in bytes.

Moves a file or folder to a different path within the user's Dropbox. This operation supports moving entire folder contents.

Input

Name	Type	Required	Description
From_Path	String	False	The full Dropbox path of the file or folder to be moved.
To_Path	String	False	The destination Dropbox path where the file or folder should be moved.
Autorename	Boolean	False	When set to true, Dropbox will automatically rename the file or folder to avoid name conflicts at the destination. The default value is False.
Allow_Ownership_Transfer	Boolean	False	When set to true, allows the owner to move content even if it results in a change of ownership. This setting applies only to move operations, not copies. Not supported for batch moves. The default value is False.
ObjectPathsAggregate	String	False	An aggregate of object paths to be moved. This can also refer to a #TEMP table containing the paths.

Result Set Columns

Name	Type	Description
Success	String	Returns a value of True when the move operation is completed successfully; otherwise, returns False.

Revokes a user's access to a shared file, removing them from the file's member list.

Input

Name	Type	Required	Description
FileId	String	True	The unique identifier of the shared file from which the member is removed.
Email	String	False	The email address of the user to be removed from the shared file.
DropboxId	String	False	The Dropbox Id of the user, team member, or group to be removed.

Result Set Columns

Name	Type	Description
Success	String	Returns a value of True when the member is successfully removed from the file; otherwise, returns False.

Removes a member from a shared folder, provided the caller has the appropriate role and permissions.

Input

Name	Type	Required	Description
FolderId	String	True	The unique identifier of the shared folder from which the member is removed.
Email	String	False	The email address of the user to be removed from the shared folder.
DropboxId	String	False	The Dropbox Id of the user, team member, or group to be removed.
LeaveACopy	Boolean	True	When set to true, the removed user will retain a copy of the folder in their Dropbox, provided it was mounted. Must be set to False when removing a group or when the folder is inside a team folder or another shared folder.

Result Set Columns

Name	Type	Description
Success	String	Returns a value of True when the member is successfully removed from the folder; otherwise, returns False.

Renames a file or folder by specifying the current path and a new name; path casing changes are not supported.

Input

Name	Type	Required	Description
Path	String	False	The full Dropbox path of the file or folder to be renamed (for example, /MyFolder/sample.txt).
NewName	String	False	The new name to assign to the file or folder (for example, SampleDocument.txt).

Result Set Columns

Name	Type	Description
Success	String	Returns a value of True when the rename operation is successful; otherwise, returns False.

Searches for files and folders in a Dropbox account based on specified criteria.

Input

Name	Type	Required	Description
Name	String	True	The name of the file or folder.
FileStatus	String	False	Filter files by their status (active, deleted, etc.).
FilenameOnly	Boolean	False	When true, search only by file name. The default value is true.
Path	String	False	The path to search in (defaults to root if not specified).
FileExtensions	String	False	Comma-separated list of file extensions to filter by.
FileCategories	String	False	Comma-separated list of file categories to filter by.
AccountId	String	False	Account ID to search within a team space.
IncludeHighlights	Boolean	False	Whether to include highlight span from file title. The default for this field is False.

Result Set Columns

Name	Type	Description
Id	String	Unique identifier for the file or folder.
Name	String	The name of the file or folder.
Type	String	Type of item (file or folder).
PathDisplay	String	The canonical path to display.
ClientModified	Datetime	Timestamp of last client modification.
ContentHash	String	A hash of the file's content.
HasExplicitSharedMembers	Boolean	Whether the file has explicitly shared members.
IsDownloadable	Boolean	Whether the file can be downloaded.
PathLower	String	The lowercase version of the path.
Rev	String	A unique identifier for the current revision.
ServerModified	Datetime	Timestamp of last server modification.
Size	Number	Size of the file in bytes.
SharingInfoModifiedBy	String	ID of user who last modified sharing.
SharingInfoParentSharedFolderId	String	ID of parent shared folder.
SharingInfoReadOnly	Boolean	Whether the file is read-only.
HighlightSpans	String	Highlight span of a file title.

Modifies whether a shared folder inherits access permissions from its parent, applicable in team-based Dropbox setups.

Input

Name	Type	Required	Description
AccessInheritance	String	True	Specifies the access inheritance setting for the folder. Possible values include inherit (inherits permissions from the parent) or no_inherit (removes inherited permissions).
FolderId	String	True	The unique identifier of the shared folder whose access inheritance setting is updated.

Result Set Columns

Name	Type	Description
Success	String	Returns a value of True when the access inheritance setting is successfully updated; otherwise, returns False.

Initiates sharing for a folder, allowing others to be invited with specified access roles; requires write-sharing privileges.

Input

Name	Type	Required	Description
Path	String	True	The full Dropbox path of the folder to be shared.
AclUpdatePolicy	String	False	Specifies who is allowed to add or remove members from the shared folder.
MemberPolicy	String	False	Defines who can be a member of the shared folder (for example, team-only or anyone).
SharedLinkPolicy	String	False	Specifies the rules for creating shared links for content within this folder.
ViewerInfoPolicy	String	False	Indicates who can enable or disable viewer information for this shared folder.
ForceAsync	String	False	When set to true, forces the sharing operation to be performed asynchronously. The default value is false.

Result Set Columns

Name	Type	Description
Status	String	Returns the status of the share operation, such as complete or in_progress.
AsyncJobId	String	The Id of the asynchronous job used to monitor the progress of the share operation.

Removes all sharing permissions from a folder, making it private again; applicable only with sharing permissions.

Input

Name	Type	Required	Description
FolderId	String	True	The unique identifier of the shared folder to be unshared.
LeaveCopy	String	False	When set to true, members will retain a personal copy of the folder's contents after it is unshared. If False, the folder is removed from their accounts. The default value is false.

Result Set Columns

Name	Type	Description
Status	String	Returns the status of the unshare operation, such as complete or failed.

Updates custom properties on a file or folder, including adding, editing, or removing property templates and key-value pairs.

Input

Name	Type	Required	Description
Path	String	False	The full Dropbox path of the file or folder whose properties are updated.
Remove_Fields	String	False	A list of property field names (as strings) to remove if they exist. This field is optional.
Template_Id	String	False	The unique identifier of the property template associated with the file or folder.
AddorUpdateFields	String	False	An aggregate of property fields to add or update. Must be a JSON object or the name of a #TEMP table containing the fields and values.

Result Set Columns

Name	Type	Description
Success	String	Returns a value of True when the properties are successfully updated; otherwise, returns False.

Changes a member's role or permissions for a shared file, such as read-only or edit access.

Input

Name	Type	Required	Description
FileId	String	True	The unique identifier of the shared file whose member access is being updated.
Email	String	False	The email address of the user whose access level is being modified.
DropboxId	String	False	The Dropbox Id of the user, team member, or group whose access is being updated.
AccessLevel	String	True	The new access level to assign to the member, such as viewer or editor.

Result Set Columns

Name	Type	Description
Success	String	Returns a value of True when the member's access is successfully updated; otherwise, returns False.

Modifies the access level of a user in a shared folder, such as promoting them to editor or revoking edit rights.

Input

Name	Type	Required	Description
FolderId	String	True	The unique identifier of the shared folder whose member access is being updated.
Email	String	False	The email address of the user whose access to the shared folder is being modified.
DropboxId	String	False	The Dropbox Id of the user, team member, or group whose access level is being updated.
AccessLevel	String	True	The new access level to assign to the member, such as viewer or editor.

Result Set Columns

Name	Type	Description
Success	String	Returns a value of True when the member's access level is successfully updated; otherwise, returns False.

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

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

Data Source Tables

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

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

Query Information Tables

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

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

Lists the available databases.

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

SELECT * FROM sys_catalogs

Columns

Name	Type	Description
CatalogName	String	The database name.

Lists the available schemas.

The following query retrieves all available schemas:

          SELECT * FROM sys_schemas
          

Columns

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

Lists the available tables.

The following query retrieves the available tables and views:

          SELECT * FROM sys_tables
          

Columns

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

Describes the columns of the available tables and views.

The following query returns the columns and data types for the 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.

Lists the available stored procedures.

The following query retrieves the available stored procedures:

          SELECT * FROM sys_procedures
          

Columns

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

Describes stored procedure parameters.

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

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'ShareFolder' 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 = 'ShareFolder' 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 Dropbox procedure.

Pseudo-Columns

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

Describes the primary and foreign keys.

The following query retrieves the primary key for the 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.

Describes the foreign keys.

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

         SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
          

Columns

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

Describes the primary keys.

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

         SELECT * FROM sys_primarykeys
          

Columns

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

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

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

          SELECT * FROM sys_indexes WHERE IsPrimary='false'
          

Columns

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

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

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

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns

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

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

See SQL Compliance for SQL syntax details.

Discovering the Data Source's SELECT Capabilities

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

Name	Description	Possible Values
AGGREGATE_FUNCTIONS	Supported aggregation functions.	AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNT	Whether COUNT function is supported.	YES, NO
IDENTIFIER_QUOTE_OPEN_CHAR	The opening character used to escape an identifier.	[
IDENTIFIER_QUOTE_CLOSE_CHAR	The closing character used to escape an identifier.	]
SUPPORTED_OPERATORS	A list of supported SQL operators.	=, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BY	Whether GROUP BY is supported, and, if so, the degree of support.	NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
OJ_CAPABILITIES	The supported varieties of outer joins supported.	NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS
OUTER_JOINS	Whether outer joins are supported.	YES, NO
SUBQUERIES	Whether subqueries are supported, and, if so, the degree of support.	NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED
STRING_FUNCTIONS	Supported string functions.	LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE
NUMERIC_FUNCTIONS	Supported numeric functions.	ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE
TIMEDATE_FUNCTIONS	Supported date/time functions.	NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT
REPLICATION_SKIP_TABLES	Indicates tables skipped during replication.
REPLICATION_TIMECHECK_COLUMNS	A string array containing a list of columns which will be used to check for (in the given order) to use as a modified column during replication.
IDENTIFIER_PATTERN	String value indicating what string is valid for an identifier.
SUPPORT_TRANSACTION	Indicates if the provider supports transactions such as commit and rollback.	YES, NO
DIALECT	Indicates the SQL dialect to use.
KEY_PROPERTIES	Indicates the properties which identify the uniform database.
SUPPORTS_MULTIPLE_SCHEMAS	Indicates if multiple schemas may exist for the provider.	YES, NO
SUPPORTS_MULTIPLE_CATALOGS	Indicates if multiple catalogs may exist for the provider.	YES, NO
DATASYNCVERSION	The CData Data Sync version needed to access this driver.	Standard, Starter, Professional, Enterprise
DATASYNCCATEGORY	The CData Data Sync category of this driver.	Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQL	Whether enhanced SQL functionality beyond what is offered by the API is supported.	TRUE, FALSE
SUPPORTS_BATCH_OPERATIONS	Whether batch operations are supported.	YES, NO
SQL_CAP	All supported SQL capabilities for this driver.	SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX
PREFERRED_CACHE_OPTIONS	A string value specifies the preferred cacheOptions.
ENABLE_EF_ADVANCED_QUERY	Indicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side.	YES, NO
PSEUDO_COLUMNS	A string array indicating the available pseudo columns.
MERGE_ALWAYS	If the value is true, The Merge Mode is forcibly executed in Data Sync.	TRUE, FALSE
REPLICATION_MIN_DATE_QUERY	A select query to return the replicate start datetime.
REPLICATION_MIN_FUNCTION	Allows a provider to specify the formula name to use for executing a server side min.
REPLICATION_START_DATE	Allows a provider to specify a replicate startdate.
REPLICATION_MAX_DATE_QUERY	A select query to return the replicate end datetime.
REPLICATION_MAX_FUNCTION	Allows a provider to specify the formula name to use for executing a server side max.
IGNORE_INTERVALS_ON_INITIAL_REPLICATE	A list of tables which will skip dividing the replicate into chunks on the initial replicate.
CHECKCACHE_USE_PARENTID	Indicates whether the CheckCache statement should be done against the parent key column.	TRUE, FALSE
CREATE_SCHEMA_PROCEDURES	Indicates stored procedures that can be used for generating schema files.

The following query retrieves the operators that can be used in the WHERE clause:

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'

Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.

Columns

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

Returns information about attempted modifications.

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

         SELECT * FROM sys_identity
          

Columns

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

Describes the available system information.

The following query retrieves all columns:

SELECT * FROM sys_information

Columns

Name	Type	Description
Product	String	The name of the product.
Version	String	The version number of the product.
Datasource	String	The name of the datasource the product connects to.
NodeId	String	The unique identifier of the machine where the product is installed.
HelpURL	String	The URL to the product's help documentation.
License	String	The license information for the product. (If this information is not available, the field may be left blank or marked as 'N/A'.)
Location	String	The file path location where the product's library is stored.
Environment	String	The version of the environment or rumtine the product is currently running under.
DataSyncVersion	String	The tier of CData Sync required to use this connector.
DataSyncCategory	String	The category of CData Sync functionality (e.g., Source, Destination).

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.

Connection

---

Property	Description
IncludeTeamResources	Specifies whether the provider includes Dropbox team folders and files in query results.
IncludeSubDirectories	Specifies whether the provider includes subdirectories when listing files and folders.
ImpersonateUserMode	Specifies the impersonation mode the provider uses when making API calls on behalf of a user or admin.
ImpersonateUserId	Specifies the Dropbox User ID to impersonate when acting on behalf of a team member or admin.

OAuth

---

Property	Description
OAuthClientId	Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
OAuthClientSecret	Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).

SSL

---

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

Logging

---

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

Schema

---

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

Miscellaneous

---

Property	Description
MaxRows	Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
PseudoColumns	Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.

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

---

Property	Description
IncludeTeamResources	Specifies whether the provider includes Dropbox team folders and files in query results.
IncludeSubDirectories	Specifies whether the provider includes subdirectories when listing files and folders.
ImpersonateUserMode	Specifies the impersonation mode the provider uses when making API calls on behalf of a user or admin.
ImpersonateUserId	Specifies the Dropbox User ID to impersonate when acting on behalf of a team member or admin.

Specifies whether the provider includes Dropbox team folders and files in query results.

Data Type

bool

Default Value

false

Remarks

This property determines whether the Cloud includes Dropbox team resources, such as shared team folders and files, in its queries.

If this property is set to true, the Cloud includes all team folders and files accessible through your Dropbox Business account.

If this property is set to false, only files and folders owned by the authenticated user are included.

Use this property when your organization relies on team folders for shared document access.

Specifies whether the provider includes subdirectories when listing files and folders.

Data Type

bool

Default Value

true

Remarks

This property determines whether the Cloud includes subdirectories when listing files and folders from Dropbox.

If this property is set to true, the Cloud includes files and folders from all subdirectories beneath the target directory.

If this property is set to false, only the contents of the specified directory are included. Subdirectories are ignored.

Use this property when you need to retrieve full directory trees instead of flat folder listings.

Specifies the impersonation mode the provider uses when making API calls on behalf of a user or admin.

Possible Values

User, Admin, None

Data Type

string

Default Value

"None"

Remarks

This property determines whether the Cloud impersonates a team user or team admin in Dropbox Business.

If this property is set to User, the Cloud includes the Dropbox-API-Select-User header to act on behalf of the user specified in ImpersonateUserId.

If this property is set to Admin, the Cloud uses the Dropbox-API-Select-Admin header to act with team admin privileges on behalf of the specified user.

If this property is set to None, the Cloud does not include impersonation headers and connects as the authorized user tied to the access token.

This property is required to enable impersonation and must be used in conjunction with ImpersonateUserId.

Specifies the Dropbox User ID to impersonate when acting on behalf of a team member or admin.

Data Type

string

Default Value

""

Remarks

Set this property to impersonate a specific user in your Dropbox Business team environment.

This property has no effect unless ImpersonateUserMode is set to User or Admin.

You can retrieve user IDs using the Dropbox Admin Console.

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

---

Property	Description
OAuthClientId	Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
OAuthClientSecret	Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).

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

Data Type

string

Default Value

""

Remarks

This property is required in two cases:

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

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

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

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

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

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

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

Data Type

string

Default Value

""

Remarks

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

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

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

Notes:

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

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

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

---

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

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

Data Type

string

Default Value

""

Remarks

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

This property can take the following forms:

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

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

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

---

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

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

Data Type

string

Default Value

"1"

Remarks

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

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

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

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

---

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

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

Data Type

string

Default Value

""

Remarks

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

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

---

Property	Description
MaxRows	Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
PseudoColumns	Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.

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.

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:

*=*

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.

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.