Cloud

Build 25.0.9434
  • Money Forward Expense
    • Getting Started
      • Establishing a Connection
      • Creating a Custom OAuth Application
      • SSL Configuration
      • Firewall and Proxy
    • Data Model
      • Tables
        • Departments
        • MyTransactions
        • OfficeMembers
        • OfficeMemberSettings
        • OfficeMemberWorkflows
        • Positions
        • Projects
      • Views
        • ApprovingReports
        • Excises
        • InvoiceReports
        • Items
        • MyApprovingReports
        • MyInvoiceReports
        • MyReports
        • Offices
        • Reports
        • ReportUnits
        • Transactions
      • Stored Procedures
      • System Tables
        • sys_catalogs
        • sys_schemas
        • sys_tables
        • sys_tablecolumns
        • sys_procedures
        • sys_procedureparameters
        • sys_keycolumns
        • sys_foreignkeys
        • sys_primarykeys
        • sys_indexes
        • sys_connection_props
        • sys_sqlinfo
        • sys_identity
        • sys_information
    • Connection String Options
      • Authentication
        • OfficeId
      • OAuth
        • OAuthClientId
        • OAuthClientSecret
        • Scope
      • SSL
        • SSLServerCert
      • Logging
        • Verbosity
      • Schema
        • BrowsableSchemas
      • Miscellaneous
        • MaxRows
        • PseudoColumns
        • Timeout
    • Third Party Copyrights

Money Forward Expense - CData Cloud

Overview

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

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

Key Features

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

CData Cloud

Getting Started

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

Connecting to Money Forward Expense

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

Accessing Data from CData Cloud Services

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

CData Cloud

Establishing a Connection

Connect to Money Forward Expense 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 Money Forward Expense

Money Forward Expense supports OAuth authentication only. To enable this authentication from all OAuth flows, you must create a custom OAuth application, and you must set AuthScheme to OAuth.

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

Note: In addition to the connection properties listed below, most Money Forward Expense tables also require the user to set OfficeId.

Automatic refresh of the OAuth access token:

To have the Cloud automatically refresh the OAuth access token:

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

Manual refresh of the OAuth access token:

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

  1. To manually refresh the OAuthAccessToken after the ExpiresIn period (returned by GetOAuthAccessToken) has elapsed, call the RefreshOAuthAccessToken stored procedure.
  2. Set these connection properties:

    • OAuthClientId: The Client Id in your application settings.
    • OAuthClientSecret: The Client Secret in your application settings.

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

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

CData Cloud

Creating a Custom OAuth Application

Creating a Custom OAuth Application

The following procedure obtains the OAuth client credentials, the OAuthClientId, OAuthClientSecret, and CallbackURL.

  1. Log into your Money Forward Expense account and click API Linkage under the For Developers section.
  2. Click Create Application.
  3. If you are making a desktop application, set the Redirect URI to https://oauth.cdata.com/oauth/, the default CallbackURL value.
    Note: Money Forward Expense requires an HTTPS redirect URI.

    If you are making a Web application, set the Redirect URI to a page on your Web app where you would like the user to return after authorizing your application.

  4. Set Scopes to office_setting:write user_setting:write transaction:write report:write account:write public_resource:read.
  5. Save your changes. The console displays the settings for the application you just created.

Note the client Id, client secret, and callback URL for future use.

CData Cloud

SSL Configuration

Customizing the SSL Configuration

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

To specify another certificate, see the SSLServerCert connection property.

CData Cloud

Firewall and Proxy

Connecting Through a Firewall or Proxy

HTTP Proxies

To authenticate to an HTTP proxy, set the following:

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

Other Proxies

Set the following properties:

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

CData Cloud

Data Model

The CData Cloud models entities in the Money Forward Expense API as tables, views, and stored procedures. These are defined in schema files, which are text-based, extensible configuration files.

Tables and Views

The following sections provide information on executing SQL to the available API Tables and Views. The Cloud uses the Money Forward Expense API to process supported filters. The Cloud processes other filters client-side within the Cloud.

Stored Procedures

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

CData Cloud

Tables

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

CData Cloud - Money Forward Expense Tables

Name Description
Departments Create, update, delete, and query all the report units for an office.
MyTransactions Create, update, delete, and query your own transactions.
OfficeMembers Query and delete the report units for an office.
OfficeMemberSettings Create, update, and query the settings for an office.
OfficeMemberWorkflows Create, update, delete, and query the workflows for the members of the specified office.
Positions Create, update, delete, and query all the positions for an office.
Projects Create, update, delete, and query projects for an office.

CData Cloud

Departments

Create, update, delete, and query all the report units for an office.

Table Specific Information

SELECT

To get a list of all the departments of an office, the OfficeId column or the OfficeId connection string parameter is required. If not specified, the OfficeId of the first office from the Offices table will be used.

The Cloud uses the Money Forward Expense APIs to process search criteria that refer to OfficeId and processes other filters client-side within the Cloud. For example, following query is processed server side:

SELECT * FROM Departments

Insert

To insert a department the following columns are required: OfficeId and Name.

INSERT INTO Departments (OfficeId, Name, Code, Memo) VALUES ('OfficeId123', 'OfficeName123', 'DepCode123', 'Memo123')

Update

To update a department the following columns are required: OfficeId and Id.

UPDATE Departments SET Name = 'NewDepName', Code = 'NewDepCode', Memo = 'NewDepMemo' WHERE OfficeId = '1234' AND Id = '12345'

Delete

To delete a department, the following columns are required: OfficeId and Id.

DELETE FROM Departments WHERE OfficeId = '12345' AND Id = '123456'

Columns

Name Type ReadOnly Description
Id [KEY] String True

The department Id.

OfficeId [KEY] String False

The office Id.

Name String False

The department name.

Code String False

The department code.

Memo String False

The RootId of the department.

ParentId String False

The ParentId of the department.

RootId String True

The RootId of the project.

CData Cloud

MyTransactions

Create, update, delete, and query your own transactions.

Columns

Name Type ReadOnly Description
Id [KEY] String False

The position Id.

OfficeId [KEY] String False

The transaction Id.

Remark String False

The transaction contents.

Value Double False

The transaction value.

ItemId String False

The Expense item Id.

RecognizedAt Date False

The date of payment.

Number Integer True

The transaction number.

Memo String False

The transaction notes.

JpyRate Double False

The exchange rate.

Currency String False

The transaction currency.

UseCustomJypRate Boolean False

Indicates if the exchange rate is manually set.

AutomaticStatus String True

The transaction status.

ErrorMessage String True

The error message.

WarningMessage String True

The warning message.

WaitingMessage String True

The waiting message.

OfficeMemberId String True

The office member Id.

CreditItemId String False

The credit account item Id.

CreditSubItemId String False

The credit account subitem Id.

ExciseId String False

The tax division Id.

DepartmentId String False

The department Id.

ProjectId String False

The project Id.

CreatedAt Datetime True

The date when the transaction was craeted.

UpdatedAt Datetime True

The date when the transaction was last updated.

CData Cloud

OfficeMembers

Query and delete the report units for an office.

Table Specific Information

SELECT

To get a list of all the members of an office, the OfficeId column or the OfficeId connection string parameter is required. If not specified, the OfficeId of the first office from the Offices table will be used. The Cloud uses the Money Forward Expense APIs to process search criteria that refer to OfficeId and processes other filters client-side within the Cloud. For example, following query is processed server side:

SELECT * FROM OfficeMembers

The column PermissionRoleID may take the value of 0 if the member has been created from the UI, and it hasn't been given any permissions.

Insert

To insert an OfficeMember, the following columns are required: OfficeId, Email and PermissionRoleID.
PermissionRoleID can take only these values: 201: general user, 202: recognizer, 203: manager.
-if PermissionRoleID = 201 IsExUser will be set to true
-if PermissionRoleID = 202 IsExUser, IsExAuthorizer will be set to true
-if PermissionRoleID = 203 IsExUser, IsExAuthorizer, IsExAdministrator will be set to true
Departments is a aggregate field, so the value for inserting and updating would be a json string containing an array of objects with its only attribute Department Id

INSERT INTO OfficeMembers (OfficeId, Email, PermissionRoleID) VALUES ('12345', '[email protected]', '201')

INSERT INTO OfficeMembers (OfficeId, Email, PermissionRoleID, PositionID, Departments) VALUES ('23457', '[email protected]', '202', '2457', '[{"id": "7457"},{"id": "24577"}]')

Update

To update an OfficeMember you will need the OfficeMember ID and OfficeID specified:

UPDATE OfficeMembers SET Name = 'hello world', Number = '1245', PermissionRoleID = 203 WHERE ID = '345' AND OfficeID = '123'

UPDATE OfficeMembers SET  Name = 'hey world', Number = '346', PermissionRoleID = 201, PositionID = '2457754', Departments = '[{\"id\": \"457\"},{\"id\": \"346\"}]' WHERE ID = '345' AND OfficeID = '346'

Delete

To delete an OfficeMember, the following columns are required: OfficeId, Id.

DELETE FROM OfficeMembers WHERE OfficeId = '12345' AND Id = '123456'

Columns

Name Type ReadOnly Description
Id [KEY] String False

The report unit Id.

OfficeId [KEY] String True

The report unit Id.

IdentificationCode String True

The office id.

Name String False

The report unit title.

Number Integer False

The report unit title.

CreatedAt Datetime True

The date when the report unit was created.

UpdatedAt Datetime True

The date when the report unit was last updated.

IsExUser Boolean True

The report unit number.

IsExAuthorizer Boolean True

The report unit number.

IsExAdministrator Boolean True

The report unit number.

PositionId String True

The report unit title.

PositionName String True

The report unit title.

PositionPriority Integer True

The report unit title.

PermissionRoleID String False

Permission role ID (Required on insert - 201: general user, 202: recognizer, 203: manager)

Departments String False

Aggregate field representing departments of an office member.

CData Cloud

OfficeMemberSettings

Create, update, and query the settings for an office.

Table Specific Information

SELECT

To get the settings of an office member, the OfficeId and OfficeMemberId columns are required in the WHERE clause. If not specified, the settings of all the office members will be returned.

The Cloud uses the Money Forward Expense APIs to process search criteria that refer to OfficeId and OfficeMemberId. The Cloud processes other filters client-side within the Cloud. For example, the following query is processed server side:

SELECT * FROM OfficeMemberSettings WHERE OfficeId = '1234' AND OfficeMemberId = '12345'

INSERT

INSERTs are not supported for this table.

UPDATE

To update the settings of an office member, the following columns required: OfficeId and OfficeMemberId.

UPDATE OfficeMemberSettings SET UseAgent = false, ApprovingPriority = 1234, ProjectId = '1234', CreditItemId = '1234', CreditSubItemId = '1234', TransportationItemId = '1234', DrivingItemId = '1234' WHERE OfficeMemberId = '1234' AND OfficeId = '123456'

Delete

Deletes are not supported for this table.

Columns

Name Type ReadOnly Description
Id [KEY] String False

The setting Id.

OfficeId [KEY] String False

The office Id.

OfficeMemberId [KEY] String False

The office member Id.

UseAgent Boolean False

Indicates the use agent status.

ApprovingPriority Integer False

The approving priority.

ProjectId String False

The project Id.

ProjectName String True

The project name.

ProjectCode String True

The project code.

CreditItemId String False

The credit item Id.

CreditItemExciseId String True

The credit item excise Id.

CreditItemName String True

The credit item name.

CreditItemCode String True

The credit item code.

CreditSubItemId String False

The credit subitem Id.

CreditSubItemItemId String True

The credit subitem item Id.

CreditSubItemExciseId String True

The credit subitem excise Id.

CreditSubItemName String True

The credit subitem name.

CreditSubItemCode String True

The credit subitem code.

TransportationItemId String False

The transportation item Id.

TransportationItemName String True

The transportation item name.

DrivingItemId String False

The driving item Id.

DrivingItemName String True

The driving item name.

CData Cloud

OfficeMemberWorkflows

Create, update, delete, and query the workflows for the members of the specified office.

Table Specific Information

SELECT

To get a list of the workflows of an office member, the OfficeId and OfficeMemberId columns are required. If not specified, the workflows of all the office members will be returned by the Money Forward Expense server.

The Cloud uses the Money Forward Expense APIs to process search criteria that refer to OfficeId and OfficeMemberId. Other filters the Cloud processes client-side within the Cloud. For example, the following query is processed server side:

SELECT * FROM OfficeMemberWorkflows WHERE OfficeId = '1234' AND OfficeMemberId = '12345'

INSERT

To insert a workflow for an office member, the following columns are required: OfficeId, OfficeMemberId, WorkFlowId, and ReportTypeId

INSERT INTO OfficeMemberWorkflows (OfficeId, OfficeMemberId, WorkFlowId, ReportTypeId) VALUES ('123', '12345', '123456', '1234567')

UPDATE

To update a workflow for an office member, the following columns are required: Id, OfficeId, OfficeMemberId, WorkFlowId, AND ReportTypeId.

UPDATE OfficeMemberWorkflows SET WorkFlowId = '123', ReportTypeId = '1234' WHERE OfficeId = '12345' AND OfficeMemberId = '123456' AND Id = '1234567'

DELETE

Deletes are not supported for this table.

Columns

Name Type ReadOnly Description
Id [KEY] String False

The workflow Id.

OfficeId [KEY] String False

The office Id.

OfficeMemberId [KEY] String False

The workflow name.

WorkflowId String False

The workflow priority.

ReportTypeId String False

The workflow priority.

ReportTypeName String True

The workflow priority.

ReportTypeUseTransactionReserves Boolean True

The workflow priority.

ReportTypeUseTransactionActionAfterApproval String True

The workflow priority.

ReportTypeIsActive Boolean True

The workflow priority.

CData Cloud

Positions

Create, update, delete, and query all the positions for an office.

Table Specific Information

SELECT

To get a list of all the positions of an office, the OfficeId column or the OfficeId connection string parameter is required. If not specified, the OfficeId of the first office from the Offices table will be used.

The Cloud uses the Money Forward Expense APIs to process search criteria that refer to OfficeId and processes other filters client-side within the Cloud. For example, the following query is processed by the Money Forward Expense APIs:

SELECT * FROM Positions

Insert

To insert a position the following columns are required: OfficeId and Name.

INSERT INTO Positions (OfficeId, Name, IsAuthorizer, Priority) VALUES ('OfficeId1234', 'PositionName123', false, 150)

Update

To update a position the following columns are required: OfficeId and Id.

UPDATE Positions SET Name = 'UpdatedPositionName', IsAuthorizer = true, Priority = 170 WHERE OfficeId = '12345' AND Id = '123456'

Delete

To delete a position, the following columns are required: OfficeId and Id.

DELETE FROM Positions WHERE OfficeId = '12345' AND Id = '123456'

Columns

Name Type ReadOnly Description
Id [KEY] String False

The position Id.

OfficeId [KEY] String False

The office Id.

Name String False

The position name.

IsAuthorizer Boolean False

Indicates if the position is an authorizer.

Priority Integer False

The position's priority on the list.

CData Cloud

Projects

Create, update, delete, and query projects for an office.

Table Specific Information

SELECT

To get a list of all the projects of an office, the OfficeId column or the OfficeId connection string parameter is required. If not specified, the OfficeId of the first office from the Offices table will be used. The Cloud uses the Money Forward Expense APIs to process search criteria that refer to OfficeId and processes other filters client-side within the Cloud. For example, the following query is processed server side:

SELECT * FROM Projects

Insert

To insert a project the following columns are required: OfficeId, Name, Code.

INSERT INTO Projects (OfficeId, Name, Code) VALUES ('OfficeId123', 'ProjectName123', 'ProjectCode123')

Update

To update a project the following columns are required: OfficeId, Id.

UPDATE Projects SET Name = 'NewProjectName', Code = 'NewProjectCode' WHERE OfficeId = '12345' AND Id = '123456'

Delete

To delete a project, the following columns are required: OfficeId, Id.

DELETE FROM Projects WHERE OfficeId = '12345' AND Id = '123456'

Columns

Name Type ReadOnly Description
Id [KEY] String False

The project Id.

OfficeId [KEY] String False

The office Id.

Name String False

The project name.

Code String False

The project code.

ParentId String True

The ParentId of the project.

RootId String True

The RootId of the project.

CData Cloud

Views

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

CData Cloud - Money Forward Expense Views

Name Description
ApprovingReports Query the approving reports for an office.
Excises Lists the Excises for an office.
InvoiceReports null
Items Lists the items for an office.
MyApprovingReports Query your own approving reports.
MyInvoiceReports null
MyReports Query your own Reports.
Offices Lists all the offices you belong to.
Reports Lists the reports for an office.
ReportUnits Lists the report units for an office.
Transactions null

CData Cloud

ApprovingReports

Query the approving reports for an office.

Columns

Name Type Description
Id [KEY] String The report Id.
OfficeId String The office Id.
ReportTypeId String The report type Id.
OfficeMemberId String The office member Id.
Number Integer The report number.
Title String The report title.
Status String The report status.
SubmittedAt Datetime The date when the report was subbmited.
ApprovedAt Datetime The date when the report was approved.
CreatedAt Datetime The date when the report was created.
UpdatedAt Datetime The date when the report was last updated.

CData Cloud

Excises

Lists the Excises for an office.

Columns

Name Type Description
Id [KEY] String The Excise Id.
OfficeId [KEY] String The office Id.
Rate String The Excise Rate.
Code String The Excise Code.
LongName String The Excise LongName.

CData Cloud

InvoiceReports

null

Columns

Name Type Description
Id [KEY] String id
CreatedAt Datetime
OfficeId [KEY] String The office id
ApprovedAt Datetime
Number String
SubmittedAt Datetime
Status String
UpdatedAt Datetime
Title String
OfficeMemberId String
NumberWithoutPrefix String number_without_prefix
ReportApprovals String Report Approvals

CData Cloud

Items

Lists the items for an office.

Columns

Name Type Description
Id [KEY] String The project Id.
OfficeId [KEY] String The office Id.
Name String The item name.
SubItemId String The sub item id.

CData Cloud

MyApprovingReports

Query your own approving reports.

Columns

Name Type Description
Id [KEY] String The report Id.
OfficeId String The office Id.
ReportTypeId String The report type Id.
OfficeMemberId String The office member Id.
Number Integer The report number.
Title String The report title.
Status String The report status.
SubmittedAt Datetime The date when the report was subbmited.
ApprovedAt Datetime The date when the report was approved.
CreatedAt Datetime The date when the report was created.
UpdatedAt Datetime The date when the report was last updated.

CData Cloud

MyInvoiceReports

null

Columns

Name Type Description
Id [KEY] String id
CreatedAt Datetime
OfficeId [KEY] String The office id
ApprovedAt Datetime
Number String
SubmittedAt Datetime
Status String
UpdatedAt Datetime
Title String
OfficeMemberId String OfficeMemberId
NumberWithoutPrefix String number_without_prefix
ReportApprovals String Report Approvals

CData Cloud

MyReports

Query your own Reports.

Columns

Name Type Description
Id [KEY] String The report Id.
OfficeId String The office Id.
ReportTypeId String The report type Id.
OfficeMemberId String The office member Id.
Number Integer The report number.
Title String The report title.
Status String The report status.
SubmittedAt Datetime The date when the report was subbmited.
ApprovedAt Datetime The date when the report was approved.
CreatedAt Datetime The date when the report was created.
UpdatedAt Datetime The date when the report was last updated.

CData Cloud

Offices

Lists all the offices you belong to.

Table Specific Information

SELECT

The Cloud processes all filters on this table client-side within the Cloud. For example, the following query is the only query processed by the Money Forward Expense APIs and returns a list of all the offices you belong to.

SELECT * FROM Offices

Columns

Name Type Description
Id [KEY] String The office Id.
IdentificationCode String The identification code for the office.
Name String The office name.
OfficeTypeId String The office type Id.

CData Cloud

Reports

Lists the reports for an office.

Table Specific Information

SELECT

To get a list of all the reports of an office, the OfficeId column or the OfficeId connection string parameter is required. If not specified, the OfficeId of the first office from the Offices table will be used. The Cloud uses the Money Forward Expense APIs to process search criteria that refer to OfficeId and processes other filters client-side within the Cloud. For example, the following query is processed server side:


SELECT * FROM Reports

Columns

Name Type Description
Id [KEY] String The report Id.
OfficeId String The office Id.
ReportTypeId String The report type Id.
OfficeMemberId String The office member Id.
Number Integer The report number.
Title String The report title.
Status String The report status.
SubmittedAt Datetime The date when the report was subbmited.
ApprovedAt Datetime The date when the report was approved.
CreatedAt Datetime The date when the report was created.
UpdatedAt Datetime The date when the report was last updated.

CData Cloud

ReportUnits

Lists the report units for an office.

Table Specific Information

SELECT

To get a list of all the report units of an office, the OfficeId column or the OfficeId connection string parameter is required. If not specified, the OfficeId of the first office from the Offices table will be used.

The Cloud uses the Money Forward Expense APIs to process search criteria that refer to OfficeId and processes other filters client-side within the Cloud. For example, the following query is processed server side:

SELECT * FROM ReportUnits

Columns

Name Type Description
Id [KEY] String The report unit Id.
OfficeId String The office id.
Title String The report unit title.
CreatedAt Datetime The date when the report unit was created.
UpdatedAt Datetime The date when the report unit was last updated.
Number String The report unit number.

CData Cloud

Transactions

null

Table Specific Information

SELECT

To get a list of all the transactions of an office, the OfficeId column or the OfficeId connection string parameter and a range of RecognizedAt column is required. If OfficeId is not specified, the OfficeId of the first office from the Offices table will be used.

The Cloud uses the Money Forward Expense APIs to process search criteria that refer to OfficeId and processes other filters client-side within the Cloud. For example, the following query is processed server side:

SELECT * FROM Transactions WHERE RecognizedAt <= '2020-04-30' AND RecognizedAt >= '2020-04-01' 

Insert

To insert a transaction the following columns are required: OfficeId, Remark, ItemId, Value, RecognizedAt.

INSERT INTO Transactions (OfficeId, Remark, ItemId, Value, RecognizedAt, Memo, JpyRate, Currency, UseCustomJpyRate, CreditItemId, CreditSubItemId, ExciseId, DepartmentId, ProjectId) VALUES ('OfficeId123', 'RemarkValue', 'ItemId1234', 100.11, '01-01-2017', 'MemoValue', 100.123, 'JPY', false, 'CreditItemId213', 'CreditSubItemId213', 'ExciseId123', 'DepartmentId123', 'ProjectId123')

Update

To update a transaction the following columns are required: OfficeId, Id. You can update the transactions that belong the authenticated user, but not those that belong to the other office members.

UPDATE Transactions SET Remark = 'NewRemark', ItemId = 'NewItemId', Value = 123.123, Memo = 'NewMemo', UseCustomJypRate = false, RecognizedAt = '01-02-2018', Currency = 'USD', ExciseId = 'NewExciseId', CreditItemId = 'NewCreditItemId', CreditSubItemId = 'NewCreditSubItemId', DepartmentId = 'NewDepartmentId', ProjectId = 'NewProjectId' WHERE OfficeId = '12345' AND Id = '123456'

Delete

To delete a transaction, the following columns are required: OfficeId, Id. You can delete the transactions that belong the authenticated user, but not those that belong to the other office members.

DELETE FROM Transactions WHERE OfficeId = '12345' AND Id = '123456'

Columns

Name Type Description
Id [KEY] String The Transaction Id.
OfficeId [KEY] String The Office Id.
DepartmentId String The DepartmentId.
InvoiceRegistrationNumber String InvoiceRegistrationNumber
Number Int Number
Currency String Currency
ExTransactionCustomFieldValuesValue String ExTransactionCustomFieldValuesValue
Value Decimal Value
UseCustomJpyRate Bool UseCustomJpyRate
ExReportNumber Int ExReportNumber
Remark String Remark
Memo String Memo
OfficeMemberReimburseBankAccountNumber String OfficeMemberReimburseBankAccountNumber
OfficeMemberNumber String OfficeMemberNumber
ExReportUnitNumber Int ExReportUnitNumber
PurchaseTaxCredit Int PurchaseTaxCredit
ExReportUnitPaymentDate Date ExReportUnitPaymentDate
ExReportUnitUpdatedAt Datetime ExReportUnitUpdatedAt
ExReportUnitOfficeId String ExReportUnitOfficeId
ExReportUnitCreatedAt Datetime ExReportUnitCreatedAt
ExReportUnitTitle String ExReportUnitTitle
ExReportUnitId String ExReportUnitId
SpecialExceptionStatus String SpecialExceptionStatus
ReportNumber String ReportNumber
ExciseValue Int ExciseValue
OfficeMemberId String OfficeMemberId
OfficeMemberCreatedAt Datetime OfficeMemberCreatedAt
OfficeMemberIsExAuthorizer Bool OfficeMemberIsExAuthorizer
OfficeMemberName String OfficeMemberName
OfficeMemberId2 String OfficeMemberId2
OfficeMemberIsExAdministrator Bool OfficeMemberIsExAdministrator
OfficeMemberIdentificationCode String OfficeMemberIdentificationCode
OfficeMemberPositionName String OfficeMemberPositionName
OfficeMemberPositionPriority Int OfficeMemberPositionPriority
OfficeMemberPositionId String OfficeMemberPositionId
OfficeMemberPositionIsAuthorizer Bool OfficeMemberPositionIsAuthorizer
OfficeMemberReimburseBankAccountBankBranchName String OfficeMemberReimburseBankAccountBankBranchName
OfficeMemberReimburseBankAccountBankBranchNameKana String OfficeMemberReimburseBankAccountBankBranchNameKana
OfficeMemberReimburseBankAccountBankBranchCode String OfficeMemberReimburseBankAccountBankBranchCode
OfficeMemberReimburseBankAccountBankName String OfficeMemberReimburseBankAccountBankName
OfficeMemberReimburseBankAccountBankNameKana String OfficeMemberReimburseBankAccountBankNameKana
OfficeMemberReimburseBankAccountBankCode String OfficeMemberReimburseBankAccountBankCode
OfficeMemberReimburseBankAccountHolderName String OfficeMemberReimburseBankAccountHolderName
OfficeMemberReimburseBankAccountId String OfficeMemberReimburseBankAccountId
OfficeMemberReimburseBankAccountAccountType Int OfficeMemberReimburseBankAccountAccountType
OfficeMemberReimburseBankAccountHolderNameKana String OfficeMemberReimburseBankAccountHolderNameKana
OfficeMemberUpdatedAt Datetime OfficeMemberUpdatedAt
OfficeMemberIsExUser Bool OfficeMemberIsExUser
OfficeMemberExOfficeMemberSettingDefaultDrivingExpenseItemName String OfficeMemberExOfficeMemberSettingDefaultDrivingExpenseItemName
OfficeMemberExOfficeMemberSettingDefaultDrivingExpenseItemId String OfficeMemberExOfficeMemberSettingDefaultDrivingExpenseItemId
OfficeMemberExOfficeMemberSettingDefaultDrivingExpenseItemCode String OfficeMemberExOfficeMemberSettingDefaultDrivingExpenseItemCode
OfficeMemberExOfficeMemberSettingDefaultDrivingExpenseItemSubItemId String OfficeMemberExOfficeMemberSettingDefaultDrivingExpenseItemSubItemId
OfficeMemberExOfficeMemberSettingDefaultDrivingExpenseItemIsActive Bool OfficeMemberExOfficeMemberSettingDefaultDrivingExpenseItemIsActive
OfficeMemberExOfficeMemberSettingDefaultDrivingExpenseItemSubItemExciseId String OfficeMemberExOfficeMemberSettingDefaultDrivingExpenseItemSubItemExciseId
OfficeMemberExOfficeMemberSettingDefaultDrivingExpenseItemSubItemItemId String OfficeMemberExOfficeMemberSettingDefaultDrivingExpenseItemSubItemItemId
OfficeMemberExOfficeMemberSettingDefaultDrivingExpenseItemSubItemName String OfficeMemberExOfficeMemberSettingDefaultDrivingExpenseItemSubItemName
OfficeMemberExOfficeMemberSettingDefaultDrivingExpenseItemSubItemCode String OfficeMemberExOfficeMemberSettingDefaultDrivingExpenseItemSubItemCode
OfficeMemberExOfficeMemberSettingDefaultDrivingExpenseItemSubItemId2 String OfficeMemberExOfficeMemberSettingDefaultDrivingExpenseItemSubItemId2
OfficeMemberExOfficeMemberSettingDefaultDrivingExpenseItemDefaultExciseRate Decimal OfficeMemberExOfficeMemberSettingDefaultDrivingExpenseItemDefaultExciseRate
OfficeMemberExOfficeMemberSettingDefaultDrivingExpenseItemDefaultExciseCode String OfficeMemberExOfficeMemberSettingDefaultDrivingExpenseItemDefaultExciseCode
OfficeMemberExOfficeMemberSettingDefaultDrivingExpenseItemDefaultExciseLongName String OfficeMemberExOfficeMemberSettingDefaultDrivingExpenseItemDefaultExciseLongName
OfficeMemberExOfficeMemberSettingDefaultDrivingExpenseItemDefaultExciseId String OfficeMemberExOfficeMemberSettingDefaultDrivingExpenseItemDefaultExciseId
OfficeMemberExOfficeMemberSettingDefaultDrivingExpenseItemItemExciseId String OfficeMemberExOfficeMemberSettingDefaultDrivingExpenseItemItemExciseId
OfficeMemberExOfficeMemberSettingDefaultDrivingExpenseItemItemName String OfficeMemberExOfficeMemberSettingDefaultDrivingExpenseItemItemName
OfficeMemberExOfficeMemberSettingDefaultDrivingExpenseItemItemCode String OfficeMemberExOfficeMemberSettingDefaultDrivingExpenseItemItemCode
OfficeMemberExOfficeMemberSettingDefaultDrivingExpenseItemItemId String OfficeMemberExOfficeMemberSettingDefaultDrivingExpenseItemItemId
OfficeMemberExOfficeMemberSettingDefaultDrivingExpenseItemItemId2 String OfficeMemberExOfficeMemberSettingDefaultDrivingExpenseItemItemId2
OfficeMemberExOfficeMemberSettingDefaultDrivingExpenseItemDefaultExciseId2 String OfficeMemberExOfficeMemberSettingDefaultDrivingExpenseItemDefaultExciseId2
OfficeMemberExOfficeMemberSettingDefaultCreditSubItemExciseId String OfficeMemberExOfficeMemberSettingDefaultCreditSubItemExciseId
OfficeMemberExOfficeMemberSettingDefaultCreditSubItemItemId String OfficeMemberExOfficeMemberSettingDefaultCreditSubItemItemId
OfficeMemberExOfficeMemberSettingDefaultCreditSubItemName String OfficeMemberExOfficeMemberSettingDefaultCreditSubItemName
OfficeMemberExOfficeMemberSettingDefaultCreditSubItemCode String OfficeMemberExOfficeMemberSettingDefaultCreditSubItemCode
OfficeMemberExOfficeMemberSettingDefaultCreditSubItemId String OfficeMemberExOfficeMemberSettingDefaultCreditSubItemId
OfficeMemberExOfficeMemberSettingIsTemplateOnDisplay Bool OfficeMemberExOfficeMemberSettingIsTemplateOnDisplay
OfficeMemberExOfficeMemberSettingDefaultCreditExciseId String OfficeMemberExOfficeMemberSettingDefaultCreditExciseId
OfficeMemberExOfficeMemberSettingDefaultCreditName String OfficeMemberExOfficeMemberSettingDefaultCreditName
OfficeMemberExOfficeMemberSettingDefaultCreditCode String OfficeMemberExOfficeMemberSettingDefaultCreditCode
OfficeMemberExOfficeMemberSettingDefaultCreditId String OfficeMemberExOfficeMemberSettingDefaultCreditId
OfficeMemberExOfficeMemberSettingDefaultProjectName String OfficeMemberExOfficeMemberSettingDefaultProjectName
OfficeMemberExOfficeMemberSettingDefaultProjectPriority Int OfficeMemberExOfficeMemberSettingDefaultProjectPriority
OfficeMemberExOfficeMemberSettingDefaultProjectCode String OfficeMemberExOfficeMemberSettingDefaultProjectCode
OfficeMemberExOfficeMemberSettingDefaultProjectIsActive Bool OfficeMemberExOfficeMemberSettingDefaultProjectIsActive
OfficeMemberExOfficeMemberSettingDefaultProjectParentId String OfficeMemberExOfficeMemberSettingDefaultProjectParentId
OfficeMemberExOfficeMemberSettingDefaultProjectRootId String OfficeMemberExOfficeMemberSettingDefaultProjectRootId
OfficeMemberExOfficeMemberSettingDefaultProjectId String OfficeMemberExOfficeMemberSettingDefaultProjectId
OfficeMemberExOfficeMemberSettingExMemberRoleId Int OfficeMemberExOfficeMemberSettingExMemberRoleId
OfficeMemberExOfficeMemberSettingIsAutoUpdateDefaultDepartmentId Bool OfficeMemberExOfficeMemberSettingIsAutoUpdateDefaultDepartmentId
OfficeMemberExOfficeMemberSettingIsCreditOnDisplay Bool OfficeMemberExOfficeMemberSettingIsCreditOnDisplay
OfficeMemberExOfficeMemberSettingIsExpenseSubAccountOnDisplay Bool OfficeMemberExOfficeMemberSettingIsExpenseSubAccountOnDisplay
OfficeMemberExOfficeMemberSettingApprovingPriority Int OfficeMemberExOfficeMemberSettingApprovingPriority
OfficeMemberExOfficeMemberSettingId String OfficeMemberExOfficeMemberSettingId
OfficeMemberExOfficeMemberSettingIsExciseOnDisplay Bool OfficeMemberExOfficeMemberSettingIsExciseOnDisplay
OfficeMemberExOfficeMemberSettingDefaultTransportationItemName String OfficeMemberExOfficeMemberSettingDefaultTransportationItemName
OfficeMemberExOfficeMemberSettingDefaultTransportationItemId String OfficeMemberExOfficeMemberSettingDefaultTransportationItemId
OfficeMemberExOfficeMemberSettingDefaultTransportationItemCode String OfficeMemberExOfficeMemberSettingDefaultTransportationItemCode
OfficeMemberExOfficeMemberSettingDefaultTransportationItemSubItemId String OfficeMemberExOfficeMemberSettingDefaultTransportationItemSubItemId
OfficeMemberExOfficeMemberSettingDefaultTransportationItemIsActive Bool OfficeMemberExOfficeMemberSettingDefaultTransportationItemIsActive
OfficeMemberExOfficeMemberSettingDefaultTransportationItemSubItemExciseId String OfficeMemberExOfficeMemberSettingDefaultTransportationItemSubItemExciseId
OfficeMemberExOfficeMemberSettingDefaultTransportationItemSubItemItemId String OfficeMemberExOfficeMemberSettingDefaultTransportationItemSubItemItemId
OfficeMemberExOfficeMemberSettingDefaultTransportationItemSubItemName String OfficeMemberExOfficeMemberSettingDefaultTransportationItemSubItemName
OfficeMemberExOfficeMemberSettingDefaultTransportationItemSubItemCode String OfficeMemberExOfficeMemberSettingDefaultTransportationItemSubItemCode
OfficeMemberExOfficeMemberSettingDefaultTransportationItemSubItemId2 String OfficeMemberExOfficeMemberSettingDefaultTransportationItemSubItemId2
OfficeMemberExOfficeMemberSettingDefaultTransportationItemDefaultExciseRate Decimal OfficeMemberExOfficeMemberSettingDefaultTransportationItemDefaultExciseRate
OfficeMemberExOfficeMemberSettingDefaultTransportationItemDefaultExciseCode String OfficeMemberExOfficeMemberSettingDefaultTransportationItemDefaultExciseCode
OfficeMemberExOfficeMemberSettingDefaultTransportationItemDefaultExciseLongName String OfficeMemberExOfficeMemberSettingDefaultTransportationItemDefaultExciseLongName
OfficeMemberExOfficeMemberSettingDefaultTransportationItemDefaultExciseId String OfficeMemberExOfficeMemberSettingDefaultTransportationItemDefaultExciseId
OfficeMemberExOfficeMemberSettingDefaultTransportationItemItemExciseId String OfficeMemberExOfficeMemberSettingDefaultTransportationItemItemExciseId
OfficeMemberExOfficeMemberSettingDefaultTransportationItemItemName String OfficeMemberExOfficeMemberSettingDefaultTransportationItemItemName
OfficeMemberExOfficeMemberSettingDefaultTransportationItemItemCode String OfficeMemberExOfficeMemberSettingDefaultTransportationItemItemCode
OfficeMemberExOfficeMemberSettingDefaultTransportationItemItemId String OfficeMemberExOfficeMemberSettingDefaultTransportationItemItemId
OfficeMemberExOfficeMemberSettingDefaultTransportationItemItemId2 String OfficeMemberExOfficeMemberSettingDefaultTransportationItemItemId2
OfficeMemberExOfficeMemberSettingDefaultTransportationItemDefaultExciseId2 String OfficeMemberExOfficeMemberSettingDefaultTransportationItemDefaultExciseId2
OfficeMemberExOfficeMemberSettingDefaultDepartmentDispOrder Int OfficeMemberExOfficeMemberSettingDefaultDepartmentDispOrder
OfficeMemberExOfficeMemberSettingDefaultDepartmentAncestryDepth Int OfficeMemberExOfficeMemberSettingDefaultDepartmentAncestryDepth
OfficeMemberExOfficeMemberSettingDefaultDepartmentName String OfficeMemberExOfficeMemberSettingDefaultDepartmentName
OfficeMemberExOfficeMemberSettingDefaultDepartmentId String OfficeMemberExOfficeMemberSettingDefaultDepartmentId
OfficeMemberExOfficeMemberSettingDefaultDepartmentCode String OfficeMemberExOfficeMemberSettingDefaultDepartmentCode
OfficeMemberExOfficeMemberSettingDefaultDepartmentIsActive Bool OfficeMemberExOfficeMemberSettingDefaultDepartmentIsActive
OfficeMemberExOfficeMemberSettingDefaultDepartmentParentId String OfficeMemberExOfficeMemberSettingDefaultDepartmentParentId
OfficeMemberExOfficeMemberSettingDefaultDepartmentRootId String OfficeMemberExOfficeMemberSettingDefaultDepartmentRootId
OfficeMemberExOfficeMemberSettingDefaultDepartmentExJournalDepartmentId String OfficeMemberExOfficeMemberSettingDefaultDepartmentExJournalDepartmentId
OfficeMemberExOfficeMemberSettingUseAgent Bool OfficeMemberExOfficeMemberSettingUseAgent
OfficeMemberExOfficeMemberSettingIsReportNumberOnDisplay Bool OfficeMemberExOfficeMemberSettingIsReportNumberOnDisplay
OfficeMemberExOfficeMemberSettingIsProjectOnDisplay Bool OfficeMemberExOfficeMemberSettingIsProjectOnDisplay
OfficeMemberExOfficeMemberSettingIsDepartmentOnDisplay Bool OfficeMemberExOfficeMemberSettingIsDepartmentOnDisplay
OfficeMemberExActivatedAt Datetime OfficeMemberExActivatedAt
OfficeMemberDepartmentDispOrder Int OfficeMemberDepartmentDispOrder
OfficeMemberDepartmentAncestryDepth Int OfficeMemberDepartmentAncestryDepth
OfficeMemberDepartmentName String OfficeMemberDepartmentName
OfficeMemberDepartmentId String OfficeMemberDepartmentId
OfficeMemberDepartmentCode String OfficeMemberDepartmentCode
OfficeMemberDepartmentIsActive Bool OfficeMemberDepartmentIsActive
OfficeMemberDepartmentParentId String OfficeMemberDepartmentParentId
OfficeMemberDepartmentRootId String OfficeMemberDepartmentRootId
OfficeMemberDepartmentExJournalDepartmentId String OfficeMemberDepartmentExJournalDepartmentId
ErrorMessage String ErrorMessage
MfFileUpdatedAt Datetime MfFileUpdatedAt
MfFileName String MfFileName
MfFileContentType String MfFileContentType
MfFileCreatedAt Datetime MfFileCreatedAt
MfFileId String MfFileId
ProjectId String ProjectId
ItemId String ItemId
ProjectName String ProjectName
ProjectPriority Int ProjectPriority
ProjectCode String ProjectCode
ProjectIsActive Bool ProjectIsActive
ProjectParentId String ProjectParentId
ProjectRootId String ProjectRootId
ProjectId2 String ProjectId2
FamilyState Int FamilyState
UpdatedAt Datetime UpdatedAt
ReceiptType String ReceiptType
CreditId String CreditId
ExReportSuspensePaymentReports String ExReportSuspensePaymentReports
ExReportCreatedAt Datetime ExReportCreatedAt
ExReportExReportTypeId String ExReportExReportTypeId
ExReportApprovedAt Datetime ExReportApprovedAt
ExReportId String ExReportId
ExReportSubmittedAt Datetime ExReportSubmittedAt
ExReportStatus String ExReportStatus
ExReportUpdatedAt Datetime ExReportUpdatedAt
ExReportTitle String ExReportTitle
ExReportOfficeMemberId String ExReportOfficeMemberId
DepartmentDispOrder Int DepartmentDispOrder
DepartmentAncestryDepth Int DepartmentAncestryDepth
DepartmentName String DepartmentName
DepartmentId2 String DepartmentId2
DepartmentCode String DepartmentCode
DepartmentIsActive Bool DepartmentIsActive
DepartmentParentId String DepartmentParentId
DepartmentRootId String DepartmentRootId
DepartmentExJournalDepartmentId String DepartmentExJournalDepartmentId
Jpyrate Decimal Jpyrate
CreditExciseId String CreditExciseId
CreditName String CreditName
CreditCode String CreditCode
CreditId2 String CreditId2
CreatedAt Datetime CreatedAt
AutomaticStatus String AutomaticStatus
ItemName String ItemName
ItemId2 String ItemId2
ItemCode String ItemCode
ItemSubItemId String ItemSubItemId
ItemIsActive Bool ItemIsActive
ItemSubItemExciseId String ItemSubItemExciseId
ItemSubItemItemId String ItemSubItemItemId
ItemSubItemName String ItemSubItemName
ItemSubItemCode String ItemSubItemCode
ItemSubItemId2 String ItemSubItemId2
ItemDefaultExciseRate Decimal ItemDefaultExciseRate
ItemDefaultExciseCode String ItemDefaultExciseCode
ItemDefaultExciseLongName String ItemDefaultExciseLongName
ItemDefaultExciseId String ItemDefaultExciseId
ItemItemExciseId String ItemItemExciseId
ItemItemName String ItemItemName
ItemItemCode String ItemItemCode
ItemItemId String ItemItemId
ItemItemId2 String ItemItemId2
ItemDefaultExciseId2 String ItemDefaultExciseId2
ExTransactionCustomFieldValuesExTransactionCustomFieldId String ExTransactionCustomFieldValuesExTransactionCustomFieldId
ExTransactionCustomFieldValuesName String ExTransactionCustomFieldValuesName
ExTransactionCustomFieldValuesExTransactionCustomFieldLabel String ExTransactionCustomFieldValuesExTransactionCustomFieldLabel
ExTransactionCustomFieldValuesExTransactionCustomFieldType String ExTransactionCustomFieldValuesExTransactionCustomFieldType
ExTransactionCustomFieldValuesDisplayValue String ExTransactionCustomFieldValuesDisplayValue
CreditSubItemExciseId String CreditSubItemExciseId
CreditSubItemItemId String CreditSubItemItemId
CreditSubItemName String CreditSubItemName
CreditSubItemCode String CreditSubItemCode
CreditSubItemId String CreditSubItemId
InvoiceKind Int InvoiceKind
RecognizedAt Date RecognizedAt
WaitingMessage String WaitingMessage
ExciseId String ExciseId
CreditSubItemId2 String CreditSubItemId2
ExciseCode String ExciseCode
WarningMessage String WarningMessage
ExciseRate Decimal ExciseRate
ExciseCode2 String ExciseCode2
ExciseLongName String ExciseLongName
ExciseId2 String ExciseId2
Departments String Aggregate field representing departments of an office member.

CData Cloud

Stored Procedures

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

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

CData Cloud - Money Forward Expense Stored Procedures

Name Description

CData Cloud

System Tables

You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.

Schema Tables

The following tables return database metadata for Money Forward Expense:

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

Data Source Tables

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

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

Query Information Tables

The following table returns query statistics for data modification queries:

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

CData Cloud

sys_catalogs

Lists the available databases.

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

SELECT * FROM sys_catalogs

Columns

Name Type Description
CatalogName String The database name.

CData Cloud

sys_schemas

Lists the available schemas.

The following query retrieves all available schemas:

          SELECT * FROM sys_schemas
          

Columns

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

CData Cloud

sys_tables

Lists the available tables.

The following query retrieves the available tables and views:

          SELECT * FROM sys_tables
          

Columns

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

CData Cloud

sys_tablecolumns

Describes the columns of the available tables and views.

The following query returns the columns and data types for the Offices table:

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

Columns

Name Type Description
CatalogName String The name of the database containing the table or view.
SchemaName String The schema containing the table or view.
TableName String The name of the table or view containing the column.
ColumnName String The column name.
DataTypeName String The data type name.
DataType Int32 An integer indicating the data type. This value is determined at run time based on the environment.
Length Int32 The storage size of the column.
DisplaySize Int32 The designated column's normal maximum width in characters.
NumericPrecision Int32 The maximum number of digits in numeric data. The column length in characters for character and date-time data.
NumericScale Int32 The column scale or number of digits to the right of the decimal point.
IsNullable Boolean Whether the column can contain null.
Description String A brief description of the column.
Ordinal Int32 The sequence number of the column.
IsAutoIncrement String Whether the column value is assigned in fixed increments.
IsGeneratedColumn String Whether the column is generated.
IsHidden Boolean Whether the column is hidden.
IsArray Boolean Whether the column is an array.
IsReadOnly Boolean Whether the column is read-only.
IsKey Boolean Indicates whether a field returned from sys_tablecolumns is the primary key of the table.
ColumnType String The role or classification of the column in the schema. Possible values include SYSTEM, LINKEDCOLUMN, NAVIGATIONKEY, REFERENCECOLUMN, and NAVIGATIONPARENTCOLUMN.

CData Cloud

sys_procedures

Lists the available stored procedures.

The following query retrieves the available stored procedures:

          SELECT * FROM sys_procedures
          

Columns

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

CData Cloud

sys_procedureparameters

Describes stored procedure parameters.

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

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'SelectEntries' 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 = 'SelectEntries' 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 Money Forward Expense procedure.

Pseudo-Columns

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

CData Cloud

sys_keycolumns

Describes the primary and foreign keys.

The following query retrieves the primary key for the Offices table:

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

Columns

Name Type Description
CatalogName String The name of the database containing the key.
SchemaName String The name of the schema containing the key.
TableName String The name of the table containing the key.
ColumnName String The name of the key column.
IsKey Boolean Whether the column is a primary key in the table referenced in the TableName field.
IsForeignKey Boolean Whether the column is a foreign key referenced in the TableName field.
PrimaryKeyName String The name of the primary key.
ForeignKeyName String The name of the foreign key.
ReferencedCatalogName String The database containing the primary key.
ReferencedSchemaName String The schema containing the primary key.
ReferencedTableName String The table containing the primary key.
ReferencedColumnName String The column name of the primary key.

CData Cloud

sys_foreignkeys

Describes the foreign keys.

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

         SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
          

Columns

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

CData Cloud

sys_primarykeys

Describes the primary keys.

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

         SELECT * FROM sys_primarykeys
          

Columns

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

CData Cloud

sys_indexes

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

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

          SELECT * FROM sys_indexes WHERE IsPrimary='false'
          

Columns

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

CData Cloud

sys_connection_props

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

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

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns

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

CData Cloud

sys_sqlinfo

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

See SQL Compliance for SQL syntax details.

Discovering the Data Source's SELECT Capabilities

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

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

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

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'
Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.

Columns

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

CData Cloud

sys_identity

Returns information about attempted modifications.

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

         SELECT * FROM sys_identity
          

Columns

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

CData Cloud

sys_information

Describes the available system information.

The following query retrieves all columns:

SELECT * FROM sys_information

Columns

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

CData Cloud

Connection String Options

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

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

Authentication


PropertyDescription
OfficeIdId of the office. Required for most queries.

OAuth


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

SSL


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

Logging


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

Schema


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

Miscellaneous


PropertyDescription
MaxRowsSpecifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
PseudoColumnsSpecifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
TimeoutSpecifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
CData Cloud

Authentication

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


PropertyDescription
OfficeIdId of the office. Required for most queries.
CData Cloud

OfficeId

Id of the office. Required for most queries.

Data Type

string

Default Value

""

Remarks

Id of the office. Required for most queries. This value restricts query results to the specified office. If you do not have direct access to the SQL query, you can set this connection property instead.

If you do have access to the query, you can override the connection property value for a specific query by setting the OfficeId pseudo column.

CData Cloud

OAuth

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


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

OAuthClientId

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

Data Type

string

Default Value

""

Remarks

This property is required in two cases:

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

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

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

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

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

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

CData Cloud

OAuthClientSecret

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

Data Type

string

Default Value

""

Remarks

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

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

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

Notes:

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

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

CData Cloud

Scope

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

Data Type

string

Default Value

""

Remarks

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

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

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

CData Cloud

SSL

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


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

SSLServerCert

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

Data Type

string

Default Value

""

Remarks

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

This property can take the following forms:

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

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

CData Cloud

Logging

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


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

Verbosity

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

Data Type

string

Default Value

"1"

Remarks

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

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

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

CData Cloud

Schema

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


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

BrowsableSchemas

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

Data Type

string

Default Value

""

Remarks

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

CData Cloud

Miscellaneous

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


PropertyDescription
MaxRowsSpecifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
PseudoColumnsSpecifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
TimeoutSpecifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
CData Cloud

MaxRows

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

Data Type

int

Default Value

-1

Remarks

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

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

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

CData Cloud

PseudoColumns

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

Data Type

string

Default Value

""

Remarks

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

To specify individual pseudocolumns, use the following format:

Table1=Column1;Table1=Column2;Table2=Column3

To include all pseudocolumns for all tables use:

*=*

CData Cloud

Timeout

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

Data Type

int

Default Value

60

Remarks

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

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

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

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

CData Cloud

Third Party Copyrights

LZMA from 7Zip LZMA SDK

LZMA SDK is placed in the public domain.

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

LZMA2 from XZ SDK

Version 1.9 and older are in the public domain.

Xamarin.Forms

Xamarin SDK

The MIT License (MIT)

Copyright (c) .NET Foundation Contributors

All rights reserved.

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

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

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

NSIS 3.10

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

1. DEFINITIONS

"Contribution" means:

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

i) changes to the Program, and

ii) additions to the Program;

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

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

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

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

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

2. GRANT OF RIGHTS

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

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

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

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

3. REQUIREMENTS

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

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

b) its license agreement:

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

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

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

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

When the Program is made available in source code form:

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

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

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

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

4. COMMERCIAL DISTRIBUTION

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

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

5. NO WARRANTY

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

6. DISCLAIMER OF LIABILITY

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

7. GENERAL

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

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

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

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

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

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9434