Getting Started

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

Connecting to Kintone

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

Accessing Data from CData Cloud Services

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

Establishing a Connection

Connect to Kintone 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 Kintone

In addition to the authentication values, set the following parameters to connect to and retrieve data from Kintone:

Url: The URL of your account.
GuestSpaceId: Optional. Set this when using a guest space.

Authenticating to Kintone

Kintone supports the following authentication methods.

Password Authentication

You must set the following to authenticate to Kintone:

User: The username of your account.
Password: The password of your account.
AuthScheme: Set AuthScheme to Password.

API Token

You must set the following to authenticate to Kintone:

APIToken: The API Token.
To generate an API token access the specific app and click on the cog wheel. Proceed to App Settings tab > API Token. Click on the Generate button, an API token will be generated. You can also specify multiple comma-seperated APITokens.
AppId: The Application Ids.
The AppId is the number of that specific app in the sequence under Apps in Kintone UI dashboard. You can also specify multiple comma-seperated AppIds.
AuthScheme: Set AuthScheme to APIToken.

Additional Security

In addition to the mentioned authentication schemese, Kintone offers additional security in the form of both an additional Basic Auth header, and an SSL Certificate.

Using Client SSL

In addition to your authentication information, Kintone may be configured to require an SSL certificate to accept requests. To do so, set the following:

SSLClientCert: The file containing the certificate of the SSL Cert. Or alternatively, the name of the certificate store for the client certificate.
SSLClientCertType: The type of certificate.
SSLClientCertSubject: (Optional) If searching for a certificate in the certificate store, the store is searched for subjects containing the value of the property.
SSLClientCertPassword: If the certificate store is of a type that requires a password, this property is used to specify that password to open the certificate store.

Basic

Kintone environments using basic authentication will need to pass additional basic credentials. To do so, specify the following:

BasicAuthUser: The basic login name.
BasicAuthPassword: The basic password.

Firewall and Proxy

Connecting Through a Firewall or Proxy

HTTP Proxies

To connect through the Windows system proxy, you do not need to set any additional connection properties. To connect to other proxies, set ProxyAutoDetect to false.

In addition, to authenticate to an HTTP proxy, set ProxyAuthScheme, ProxyUser, and ProxyPassword, in addition to ProxyServer and ProxyPort.

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.

Data Model

The Cloud models the Kintone API as relational Tables, Views, and Stored Procedures.

Tables

Using the Cloud, you can work with all the tables in your account. The table schemas can be static or dynamic. The Comments table has a static schema with fixed columns, while other tables are dynamic, reflecting changes in the metadata -- when you connect, the Cloud retrieves table metadata from Kintone to generate the table schemas.

Static schemas are defined in schema files, which makes them easy to extend. Edit the schema file to customize the column behavior of the static Comments table, to change the data type for example. The schema files are located in the db subfolder of the Cloud installation folder.

Sub-Tables

In some Kintone apps, the user can add custom fields containing many records. The Cloud models these fields as dynamic subtables reflecting your changes.

Stored Procedures

Stored Procedures are function-like interfaces to Kintone. They can be used to search, update, and modify information in Kintone. For example, use stored procedures to execute operations on apps or work with files.

Views

The Cloud models apps in the static Apps view.

Tables

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

CData Cloud - Kintone Tables


Name	Description
Comments	Query the available comments in kintone.

Comments

Query the available comments in kintone.

Select

The RecordId and AppId columns are required in the WHERE clause. The Cloud will use the Kintone APIs to filter the results by these columns. The Kintone APIs also support filters on Id. By default, the Cloud will process other filters client-side within the Cloud.

For example, the following queries are processed server side:

SELECT * FROM Comments WHERE RecordId = 1 AND AppId = 5 AND Id = 1

Insert

The AppId and RecordId columns are required in the INSERT statement.

INSERT INTO Comments (AppId, RecordId, Text, MentionsAggregate) VALUES (5, 1, 'To do', '[{"code": "Administrator","type": "USER"}]')

Delete

Comments can be deleted by issuing a DELETE statement and specifying the RecordId, AppId, and Id.

DELETE FROM Comments WHERE RecordId = 1 AND AppId = 5 AND Id = 1

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Integer	True		The Comment Id.
AppId [KEY]	Integer	False		The App Id.
RecordId [KEY]	Integer	False		The Record Id.
Text	String	False		The comment including the line feed codes.
CreatorCode	String	True		The user code of the comment creator (log-in name).
CreatorName	String	True		The user name of the comment creator (display name).
CreatedAt	Datetime	True		The created date and time of the comment.
MentionsAggregate	String	False		An array including information of mentioned users.

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


Name	Description
Apps	Query the available apps in kintone.

Apps

Query the available apps in kintone.

Select

By default, the Cloud will use the Kintone APIs to process search criteria that refer to the following columns and will process other filters client-side within the Cloud: the Kintone API supports searches on the AppId, Code, and SpaceId columns. These columns support server-side processing for the = and IN operators while the Name column supports only the LIKE operator. For example, the following query is processed server side:

SELECT * FROM Apps WHERE AppId IN (20, 21, 51, 56) AND Name LIKE '%To Do%'

Columns


Name	Type	References	Description
AppId [KEY]	Integer		The App ID of the kintone application.
Code	String		The App Code of the app. This will be blank if an App Code is not set in the settings of the App.
Name	String		The name of the App. If Localization settings are used, this column will return the localized name dependant on the language settings of the kintone user using this API.
Description	String		The description of the App. If Localization settings are used, this column will return the localized app description dependent on the language settings of the kintone user using this API.
SpaceId	String		If the app was created inside a space, this column will return the space Id. If not, this column returns null.
ThreadId	String		If the app was created inside a space, this column will return the thread Id of the thread of the space it belongs to. For users who have not altered their User Interface Settings to the classic design, apps will automatically belong to the first thread of the space when the app is made in the space. Users who use the classic design will find that they can create apps that are thread-specific instead of space-specific. If the app was not created in a space, null is returned.
CreatedAt	Datetime		The date of when the app was created.
CreatorCode	String		The log-in name of the creator. Nothing is returned for inactive users and deleted users.
CreatorName	String		The display name of the creator. Nothing is returned for inactive users and deleted users.
ModifiedAt	Datetime		The date of when the app was last modified.
ModifierCode	String		The log-in name of the last updater. Nothing is returned for inactive users and deleted users.
ModifierName	String		The display name of the last updater. Nothing is returned for inactive users and deleted users.
Alias	String		The alias name of the App.

Stored Procedures

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

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

CData Cloud - Kintone Stored Procedures


Name	Description
AppsDeployStatus	Get app deployment statuses.
CreateApp	Creates apps.
DeployApps	Deploys apps.
UpdateAssignees	Updates assignees.
UpdateStatus	Updates the status of an app record.

AppsDeployStatus

Get app deployment statuses.

Input


Name	Type	Required	Description
AppIds	String	True	The Id of the app. This can be a list of comma-separated Ids.
GuestSpaceId	String	False	This parameter is used for apps that are in the guest space. Do not add this parameter if the connection property GuestSpaceId is specified in the connection string.

Result Set Columns


Name	Type	Description
AppId	String	The Id of the app.
Status	String	The status of the app.

CreateApp

Creates apps.

Input


Name	Type	Required	Description
Name	String	True	Specify the name of the application in less than 64 characters.
Space	String	False	The Id of the space. Do not specify this if the connection property GuestSpaceId is set in the connection string.
ThreadId	String	False	The Id of the thread. This is required if the Space parameter or the connection property GuestSpaceId is specified.
IsGuestSpace	Boolean	False	This is a boolean value that indicates whether the Space parameter is a normal space or a guest space. Set this value to true for guest spaces. The default value is false.

Result Set Columns


Name	Type	Description
AppId	String	The Id of the app.
Revision	String	The revision of the app.
Success	String	This value shows a boolean indication of whether the operation was successful or not.

DeployApps

Deploys apps.

Note: This procedure makes use of indexed parameters. Indexed parameters facilitate providing multiple instances a single parameter as inputs for the procedure.

Suppose there is an input parameter named Param#. To input multiple instances of an indexed parameter like this, execute:

EXEC ProcedureName Param#1 = "value1", Param#2 = "value2", Param#3 = "value3"

In the table below, indexed parameters are denoted with a '#' character at the end of their names.

Input


Name	Type	Required	Description
AppId#	String	True	The App Id. This can be a list of comma-separated Ids.
Revision#	String	False	Specify the revision of the setting that reflects the operational environment. If the specified revision is not up to date, the request will fail.
Revert	Boolean	False	If you want to cancel the change to the application settings, set this to true. The default value is false.
GuestSpaceId	String	False	This parameter is used for apps that are in the guest space. Do not add this parameter if the connection property GuestSpaceid is specified in the connection string.

Result Set Columns


Name	Type	Description
Success	String	This value shows a boolean indication of whether the operation was successful or not.

UpdateAssignees

Updates assignees.

Input


Name	Type	Required	Description
AppId	String	True	The App Id.
RecordId	String	True	The record Id.
Assignees	String	True	The user codes of the assignees. If empty, no users will be assigned. The maximum number of assignees is 100.
Revision	String	False	The revision number of the record before updating the assignees. If the specified revision is not the latest revision, the request will result in an error.
GuestSpaceId	String	False	This parameter is used for apps that are in the guest space. Do not add this parameter if the connection property GuestSpaceId is specified in the connection string.

Result Set Columns


Name	Type	Description
Success	String	This value shows a boolean indication of whether the operation was successful or not.
Revision	String	The revision number of the record after updating the status. The revision number will increase by 2, as two operations are performed - running the action and updating the status.

UpdateStatus

Updates the status of an app record.

Note: This procedure makes use of indexed parameters. Indexed parameters facilitate providing multiple instances a single parameter as inputs for the procedure.

Suppose there is an input parameter named Param#. To input multiple instances of an indexed parameter like this, execute:

EXEC ProcedureName Param#1 = "value1", Param#2 = "value2", Param#3 = "value3"

In the table below, indexed parameters are denoted with a '#' character at the end of their names.

Input


Name	Type	Required	Description
AppId	String	True	The App Id.
RecordId#	String	True	The record Id.
Action#	String	True	The name of the action you want to run. If the localization feature has been used to apply multiple translations of the action, specify the name of the action in the language settings of the user that will run the API.
Assignee#	String	False	The next Assignee. Specify the log-in name of the Assignee.
Revision#	String	False	The revision number of the record before updating the status. If the specified revision is not the latest revision, the request will result in an error.
GuestSpaceId	String	False	This parameter is used for apps that are in the guest space. Do not add this parameter if the connection property GuestSpaceId is specified in the connection string.

Result Set Columns


Name	Type	Description
Success	String	This value shows a boolean indication of whether the operation was successful or not.
Id	String	The record Id.
Revision	String	The revision number of the record after updating the status. The revision number will increase by 2, as two operations are preformed - running the action and updating the status.

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

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

Data Source Tables

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

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

Query Information Tables

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

sys_identity: Returns information about batch operations or single updates.

sys_catalogs

Lists the available databases.

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

SELECT * FROM sys_catalogs

Columns


Name	Type	Description
CatalogName	String	The database name.

sys_schemas

Lists the available schemas.

The following query retrieves all available schemas:

          SELECT * FROM sys_schemas

Columns


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

sys_tables

Lists the available tables.

The following query retrieves the available tables and views:

          SELECT * FROM sys_tables

Columns


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

sys_tablecolumns

Describes the columns of the available tables and views.

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

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

Columns


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

sys_procedures

Lists the available stored procedures.

The following query retrieves the available stored procedures:

          SELECT * FROM sys_procedures

Columns


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

sys_procedureparameters

Describes stored procedure parameters.

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

SELECT * FROM sys_procedureparameters WHERE ProcedureName='DownloadFile' AND Direction=1 OR Direction=2

Columns


Name	Type	Description
CatalogName	String	The name of the database containing the stored procedure.
SchemaName	String	The name of the schema containing the stored procedure.
ProcedureName	String	The name of the stored procedure containing the parameter.
ColumnName	String	The name of the stored procedure parameter.
Direction	Int32	An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters.
DataTypeName	String	The name of the data type.
DataType	Int32	An integer indicating the data type. This value is determined at run time based on the environment.
Length	Int32	The number of characters allowed for character data. The number of digits allowed for numeric data.
NumericPrecision	Int32	The maximum precision for numeric data. The column length in characters for character and date-time data.
NumericScale	Int32	The number of digits to the right of the decimal point in numeric data.
IsNullable	Boolean	Whether the parameter can contain null.
IsRequired	Boolean	Whether the parameter is required for execution of the procedure.
IsArray	Boolean	Whether the parameter is an array.
Description	String	The description of the parameter.
Ordinal	Int32	The index of the parameter.

sys_keycolumns

Describes the primary and foreign keys.

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

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

Columns


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

sys_foreignkeys

Describes the foreign keys.

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

         SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'

Columns


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

sys_primarykeys

Describes the primary keys.

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

         SELECT * FROM sys_primarykeys

Columns


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

sys_indexes

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

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

          SELECT * FROM sys_indexes WHERE IsPrimary='false'

Columns


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

sys_connection_props

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

When querying this table, the config connection string should be used:

jdbc:cdata:kintone:config:

This connection string enables you to query this table without a valid connection.

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

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns


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

sys_sqlinfo

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

See SQL Compliance for SQL syntax details.

Discovering the Data Source's SELECT Capabilities

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


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

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

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'

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

Columns


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

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.

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

Property	Description
AuthScheme	Whether to connect to Kintone with User/Password or APIToken.
URL	The Kintone URL. For example: https://SUBDOMAIN_NAME.cybozu.com .
User	The Kintone user account used to authenticate.
Password	The password used to authenticate the user.
BasicAuthUser	The additional username required for domains using basic authentication.
BasicAuthPassword	The additional password required for domains using basic authentication.
AppId	The AppId used along with the APIToken for authentication.
APIToken	The APIToken used for authentication.

Logging

Property	Description
Verbosity	The verbosity level that determines the amount of detail included in the log file.

Schema

Property	Description
BrowsableSchemas	This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Miscellaneous

Property	Description
AllowSpecialCharacters	Determines whether or not to allow special characters. If true special characters will not be replaced.
CheckForSubtablesIn	A comma-separated list of Kintone apps to retrieve subtables from.
GuestSpaceId	Restrict query results to a guest space.
MaxRows	Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
NumberMapToDouble	Determines whether or not to change the datatype of number fields from decimal to double.
Pagesize	The maximum number of results to return per page from Kintone.
SubtableSeparatorCharacter	The character used for dividing tables from subtables in the format tablename + char + subtable.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.
UseCodeForFieldName	Determines whether to use Label or Code for Field Name.
UseCursor	Boolean determining if cursors should be used to retrieve records.
UseSimpleNames	Boolean determining if simple names should be used for tables and columns.
UseUnitForNumericField	Determines whether to display unit with Field Name.

Authentication

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

Property	Description
AuthScheme	Whether to connect to Kintone with User/Password or APIToken.
URL	The Kintone URL. For example: https://SUBDOMAIN_NAME.cybozu.com .
User	The Kintone user account used to authenticate.
Password	The password used to authenticate the user.
BasicAuthUser	The additional username required for domains using basic authentication.
BasicAuthPassword	The additional password required for domains using basic authentication.
AppId	The AppId used along with the APIToken for authentication.
APIToken	The APIToken used for authentication.

AuthScheme

Whether to connect to Kintone with User/Password or APIToken.

Possible Values

Password, APIToken

Data Type

string

Default Value

"Password"

Remarks

Password: Set this to perform Password authentication.
APIToken: Set this to perform APIToken authentication.

URL

The Kintone URL. For example: https://SUBDOMAIN_NAME.cybozu.com .

Data Type

string

Default Value

""

Remarks

The Kintone URL. For example:

https://SUBDOMAIN_NAME.cybozu.com

You can also specify multiple comma-seperated AppIds.

APIToken

The APIToken used for authentication.

Data Type

string

Default Value

""

Remarks

The APIToken used for authentication.To create an API token. Access the specific app to create the API tokens for and click on the cog wheel. Proceed to App Settings tab > API Token > click on the Generate button, an API token will be generated.

You can also specify multiple comma-seperated APITokens in case of operations involving Lookup fields or Related Record fields.

Logging

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

Property	Description
Verbosity	The verbosity level that determines the amount of detail included in the log file.

Verbosity

The verbosity level that determines the amount of detail included in the log file.

Data Type

string

Default Value

"1"

Remarks

The verbosity level determines the amount of detail that the Cloud reports to the Logfile. Verbosity levels from 1 to 5 are supported. These are detailed in the Logging page.

Schema

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

Property	Description
BrowsableSchemas	This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

BrowsableSchemas

This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Data Type

string

Default Value

""

Remarks

Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.

Miscellaneous

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

Property	Description
AllowSpecialCharacters	Determines whether or not to allow special characters. If true special characters will not be replaced.
CheckForSubtablesIn	A comma-separated list of Kintone apps to retrieve subtables from.
GuestSpaceId	Restrict query results to a guest space.
MaxRows	Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
NumberMapToDouble	Determines whether or not to change the datatype of number fields from decimal to double.
Pagesize	The maximum number of results to return per page from Kintone.
SubtableSeparatorCharacter	The character used for dividing tables from subtables in the format tablename + char + subtable.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.
UseCodeForFieldName	Determines whether to use Label or Code for Field Name.
UseCursor	Boolean determining if cursors should be used to retrieve records.
UseSimpleNames	Boolean determining if simple names should be used for tables and columns.
UseUnitForNumericField	Determines whether to display unit with Field Name.

AllowSpecialCharacters

Remarks

Kintone tables and columns can use special characters in names that are normally not allowed in standard databases. UseSimpleNames makes the Cloud easier to use with traditional database tools.

Setting UseSimpleNames to true will simplify the names of tables and columns returned. It will enforce a naming scheme such that only alphanumeric characters and the underscore are valid for the displayed table and column names. Any nonalphanumeric characters will be converted to an underscore.

UseUnitForNumericField

Determines whether to display unit with Field Name.

Data Type

bool

Default Value

true

Remarks

If set to false, Unit will not be displayed with Field Name.

Cloud

Kintone - CData Cloud

Overview

Key Features

Getting Started

Connecting to Kintone

Accessing Data from CData Cloud Services

Establishing a Connection

Connecting to Kintone

Authenticating to Kintone

Password Authentication

API Token

Additional Security

Using Client SSL

Basic

Firewall and Proxy

Connecting Through a Firewall or Proxy

HTTP Proxies

Other Proxies

Data Model

Tables

Sub-Tables

Stored Procedures

Views

Tables

CData Cloud - Kintone Tables

Comments

Select

Insert

Delete

Columns

Views

CData Cloud - Kintone Views

Apps

Select

Columns

Stored Procedures

CData Cloud - Kintone Stored Procedures

AppsDeployStatus

Input

Result Set Columns

CreateApp

Input

Result Set Columns

DeployApps

Input

Result Set Columns

UpdateAssignees

Input

Result Set Columns

UpdateStatus

Input

Result Set Columns

System Tables

Schema Tables

Data Source Tables

Query Information Tables

sys_catalogs

Columns

sys_schemas

Columns

sys_tables

Columns

sys_tablecolumns

Columns

sys_procedures

Columns

sys_procedureparameters

Columns

sys_keycolumns

Columns

sys_foreignkeys

Columns

sys_primarykeys

Columns

sys_indexes

Columns

sys_connection_props

Columns

sys_sqlinfo