CData Cloud は、クラウドホスト型のソリューションで、複数の標準サービスやプロトコルにまたがるKintone へのアクセスを実現します。MySQL またはSQL Server データベースに接続できるアプリケーションであれば、CData Cloud を介してKintone に接続できます。
CData Cloud により、他のOData エンドポイントや標準SQL Server / MySQL データベースと同じように、Kintone への接続を標準化し、構成することができます。
このページでは、CData Cloud でのKintone への接続の確立 のガイド、利用可能なリソースに関する情報、および使用可能な接続プロパティのリファレンスについて説明します。
接続の確立 は、CData Cloud にデータベースを作成するためのKintone への認証方法と必要な接続プロパティの設定方法について示します。
利用可能な標準サービスを経由してKintone からデータにアクセスする方法と、CData Cloud の管理については、CData Cloud ドキュメント で詳しく説明します。
Database タブで対応するアイコンを選択して、Kintone に接続します。必須プロパティはSettings にリストされています。Advanced タブには、通常は必要ない接続プロパティが表示されます。
認証値に加えて、下記のパラメータを使いKintone に接続しデータを取得します。
Kintone は、以下の認証メソッドをサポートしています。
Kintone への認証には、以下を設定する必要があります。
Kintone への認証には、以下を設定する必要があります。
API トークンを生成するには、特定のアプリにアクセスして歯車アイコンをクリックしてください。[設定]->[APIトークン]に移動します。[生成する]ボタンをクリックすると、API トークンが生成されます。 APIToken をカンマ区切りで複数指定することもできます。
AppId はkintone UI ダッシュボードの[アプリ]内に並んだ特定のアプリの番号です。 AppId をカンマ区切りで複数指定することもできます。
これまでに説明した認証スキームに加えて、Kintone はBasic 認証ヘッダーおよびSSL 証明書の形で追加のセキュリティを提供します。
認証情報に加えて、リクエストの受け入れにSSL 証明書が必須となるようKintone を設定することができます。そのためには、次を設定してください。
Basic 認証を使用しているkintone 環境では、追加のBasic 資格情報を渡す必要があります。そのためには、次を設定してください。
Windows のシステムプロキシ経由の接続では、接続プロパティを追加で設定する必要はありません。他のプロキシに接続するには、ProxyAutoDetect をfalse に設定します。
さらにHTTP プロキシへの認証には、ProxyServer とProxyPort に加えてProxyAuthScheme、ProxyUser、およびProxyPassword を設定します。
次のプロパティを設定します。
Cloud は、Kintone API をリレーショナルテーブル、ビュー、およびストアドプロシージャ としてモデル化します。
Cloud を使用すると、アカウント内のすべてのテーブルを操作できます。テーブルスキーマは静的または動的になります。Comments テーブルには、固定カラムを持つ静的スキーマがあります。他のテーブルは動的で、メタデータの変更を反映します。接続すると、Cloud はKintone のテーブルメタデータを取得してテーブルスキーマを生成します。
静的スキーマは、容易に拡張できるスキーマファイルで定義されます。例えばデータ型を変更するなどComments 静的テーブルの動作をカスタマイズするには、スキーマファイルを編集します。スキーマファイルは、Cloud インストールフォルダのdb サブフォルダにあります。
いくつかのKintone アプリでは、ユーザーは多くのレコードを含むカスタムフィールドを追加できます。Cloud はこれらのフィールドを、変更を反映する動的なサブテーブルとしてモデル化します。
ストアドプロシージャ は、Kintone のファンクションライクなインターフェースです。これらを使用して、Kintone 内の情報を検索、更新、および変更できます。 例えば、ストアドプロシージャを使用してアプリの操作を実行したりファイルで作業したりします。
Cloud は静的なApps ビューのアプリをモデル化します。
Cloud はKintone のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。
Name | Description |
Comments | kintone で利用可能なコメントをクエリします。 |
kintone で利用可能なコメントをクエリします。
WHERE 句ではRecordId およびAppId カラムが必須です。Cloud はKintone API を使用してこれらのカラムによる結果をフィルタリングします。また、Kintone API はId のフィルタもサポートしています。 デフォルトでは、Cloud はクライアント側でCloud 内で他のフィルタを処理します。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM Comments WHERE RecordId = 1 AND AppId = 5 AND Id = 1
INSERT ステートメントでは、AppId およびRecordId カラムが必須です。
INSERT INTO Comments (AppId, RecordId, Text, MentionsAggregate) VALUES (5, 1, 'To do', '[{"code": "Administrator","type": "USER"}]')
Comments を削除するには、RecordId、AppId、およびId を指定してDELETE ステートメントを発行します。
DELETE FROM Comments WHERE RecordId = 1 AND AppId = 5 AND Id = 1
Name | Type | ReadOnly | References | Description |
Id [KEY] | Integer | True |
コメントID。 | |
AppId [KEY] | Integer | False |
アプリID。 | |
RecordId [KEY] | Integer | False |
レコードID。 | |
Text | String | False |
改行コードを含むコメント。 | |
CreatorCode | String | True |
コメント作成者のユーザーコード(ログイン名)。 | |
CreatorName | String | True |
コメント作成者のユーザー名(表示名)。 | |
CreatedAt | Datetime | True |
コメントの作成日時。 | |
MentionsAggregate | String | False |
メンションされたユーザーの情報を含む配列。 |
ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。
クエリは、ビューに対して通常のテーブルと同様に実行することができます。
Name | Description |
Apps | kintone で利用可能なアプリをクエリします。 |
kintone で利用可能なアプリをクエリします。
デフォルトでは、Cloud はKintone API を使用して以下のカラムを参照する検索条件を処理し、クライアント側でCloud 内で他のフィルタを処理します。Kintone API は、AppId、Code、およびSpaceId カラムの検索をサポートしています。これらのカラムは= およびIN 演算子のサーバー側処理をサポートしますが、Name カラムがサポートするのはLIKE 演算子のみです。例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM Apps WHERE AppId IN (20, 21, 51, 56) AND Name LIKE '%To Do%'
Name | Type | References | Description |
AppId [KEY] | Integer | kintone アプリケーションのアプリID。 | |
Code | String | アプリのアプリコード。アプリの設定でアプリコードが設定されていない場合は空になります。 | |
Name | String | アプリの名前。ローカライズの設定が使われている場合、このカラムはこのAPI を使用しているkintone ユーザーの言語設定に従ってローカライズされた名前を返します。 | |
Description | String | アプリの説明。ローカライズの設定が使われている場合、このカラムはこのAPI を使用しているkintone ユーザーの言語設定に従ってローカライズされたアプリの説明を返します。 | |
SpaceId | String | アプリがスペース内で作成された場合、このカラムはスペースID を返します。そうでない場合はnull を返します。 | |
ThreadId | String | アプリがスペース内で作成された場合、このカラムはアプリが属するスペースのスレッドのスレッドID を返します。ユーザーインターフェースの設定をクラシックデザインに変更していないユーザーは、スペース内でアプリが作成される際、アプリは自動的にスペースの最初のスレッドに属します。クラシックデザインを使用しているユーザーは、スペーススペシフィックではなく、スレッドスペシフィックなアプリを作成することができます。アプリがスペースで作成されなかった場合は、null が返されます。 | |
CreatedAt | Datetime | アプリが作成された日付。 | |
CreatorCode | String | 作成したユーザーのログイン名。停止ユーザーおよび削除ユーザーの場合は何も返されません。 | |
CreatorName | String | 作成したユーザーの表示名。停止ユーザーおよび削除ユーザーの場合は何も返されません。 | |
ModifiedAt | Datetime | アプリが最後に変更された日付。 | |
ModifierCode | String | 最後に更新したユーザーのログイン名。停止ユーザーおよび削除ユーザーの場合は何も返されません。 | |
ModifierName | String | 最後に更新したユーザーの表示名。停止ユーザーおよび削除ユーザーの場合は何も返されません。 | |
Alias | String | アプリのエイリアス名。 |
ストアドプロシージャはファンクションライクなインターフェースで、Kintone の単純なSELECT/INSERT/UPDATE/DELETE 処理にとどまらずCloud の機能を拡張します。
ストアドプロシージャは、パラメータのリストを受け取り、目的の機能を実行し、プロシージャが成功したか失敗したかを示すとともにKintone から関連するレスポンスデータを返します。
Name | Description |
AppsDeployStatus | アプリの展開ステータスを取得します。 |
CreateApp | アプリを作成します。 |
DeployApps | アプリをデプロイします。 |
UpdateAssignees | アサイニーを更新します。 |
UpdateStatus | アプリのレコードのステータスを更新します。 |
アプリの展開ステータスを取得します。
Name | Type | Required | Description |
AppIds | String | True | アプリのID。ID のカンマ区切りリストの場合もあります。 |
GuestSpaceId | String | False | このパラメータは、ゲストスペース内のアプリで使用します。接続文字列にプロパティGuestSpaceId が指定されている場合は、このパラメータを追加しないでください。 |
Name | Type | Description |
AppId | String | アプリのID。 |
Status | String | アプリのステータス。 |
アプリを作成します。
Name | Type | Required | Description |
Name | String | True | アプリケーションの名前を64文字未満で指定します。 |
Space | String | False | スペースのID。接続文字列にプロパティGuestSpaceId が設定されている場合は、このパラメータを指定しないでください。 |
ThreadId | String | False | スレッドのID。これはSpace パラメータ、または接続プロパティ内のGuestSpaceId が指定されている場合は、必須です。 |
IsGuestSpace | Boolean | False | これは、Space パラメータが通常のスペースかゲストスペースかを示すboolean 値です。true に設定するとゲストスペースとして作成します。
デフォルト値はfalseです。 |
Name | Type | Description |
AppId | String | アプリのID。 |
Revision | String | アプリの改訂。 |
Success | String | 処理が成功したかどうかを示すboolean。 |
アプリをデプロイします。
Note:このプロシージャは、インデックス付きパラメータを使用します。 インデックス付きパラメータは、プロシージャの入力として単一のパラメータを複数のインスタンスに提供することを容易にします。
Param# という名前の入力パラメータがあるとします。このようなインデックス付きパラメータの複数のインスタンスを入力するには、次のように実行します。
EXEC ProcedureName Param#1 = "value1", Param#2 = "value2", Param#3 = "value3"
以下の表では、インデックス付きの入力パラメータは、名前の末尾に '#' 文字が付きます。
Name | Type | Required | Description |
AppId# | String | True | アプリID。ID のカンマ区切りリストの場合もあります。 |
Revision# | String | False | 運用環境を反映する設定の改訂を指定します。指定された改訂版が最新でない場合は、リクエストは失敗します。 |
Revert | Boolean | False | アプリケーション設定の変更をキャンセルしたい場合は、true に設定します。
デフォルト値はfalseです。 |
GuestSpaceId | String | False | このパラメータは、ゲストスペース内のアプリで使用します。接続文字列にプロパティGuestSpaceId が指定されている場合は、このパラメータを追加しないでください。 |
Name | Type | Description |
Success | String | 処理が成功したかどうかを示すboolean。 |
アサイニーを更新します。
Name | Type | Required | Description |
AppId | String | True | アプリID。 |
RecordId | String | True | レコードID。 |
Assignees | String | True | アサイニーのユーザーコード。空の場合は、どのユーザーにも割り当てられません。アサイニーの最大数は100です。 |
Revision | String | False | アサイニー更新前のレコードの改訂番号。指定された改訂が最新版でない場合は、リクエストはエラーになります。 |
GuestSpaceId | String | False | このパラメータは、ゲストスペース内のアプリで使用します。接続文字列にプロパティGuestSpaceId が指定されている場合は、このパラメータを追加しないでください。 |
Name | Type | Description |
Success | String | 処理が成功したかどうかを示すboolean。 |
Revision | String | ステータス更新後のレコードの改訂番号。改定番号は2ずつ増加します。これは、アクションの実行およびステータスの更新の2つのオペレーションが実行されるためです。 |
アプリのレコードのステータスを更新します。
Note:このプロシージャは、インデックス付きパラメータを使用します。 インデックス付きパラメータは、プロシージャの入力として単一のパラメータを複数のインスタンスに提供することを容易にします。
Param# という名前の入力パラメータがあるとします。このようなインデックス付きパラメータの複数のインスタンスを入力するには、次のように実行します。
EXEC ProcedureName Param#1 = "value1", Param#2 = "value2", Param#3 = "value3"
以下の表では、インデックス付きの入力パラメータは、名前の末尾に '#' 文字が付きます。
Name | Type | Required | Description |
AppId | String | True | アプリID。 |
RecordId# | String | True | レコードID。 |
Action# | String | True | 実行したいアクションの名前。アクションの複数トランザクションの適用にローカリゼーション機能が使われている場合は、API を実行するユーザーの言語設定でアクション名を指定します。 |
Assignee# | String | False | 次のアサイニー。アサイニーのログイン名を指定します。 |
Revision# | String | False | ステータス更新前のレコードの改訂番号。指定された改訂が最新版でない場合は、リクエストはエラーになります。 |
GuestSpaceId | String | False | このパラメータは、ゲストスペース内のアプリで使用します。接続文字列にプロパティGuestSpaceId が指定されている場合は、このパラメータを追加しないでください。 |
Name | Type | Description |
Success | String | 処理が成功したかどうかを示すboolean。 |
Id | String | レコードID。 |
Revision | String | ステータス更新後のレコードの改訂番号。改定番号は2ずつ増加します。これは、アクションの実行およびステータスの更新の2つのオペレーションが実行されるためです。 |
このセクションで説明されているシステムテーブルをクエリして、スキーマ情報、データソース機能に関する情報、およびバッチ操作の統計にアクセスできます。
以下のテーブルは、Kintone のデータベースメタデータを返します。
以下のテーブルは、データソースへの接続方法およびクエリ方法についての情報を返します。
次のテーブルは、データ変更クエリ(バッチ処理を含む)のクエリ統計を返します。
利用可能なデータベースをリストします。
次のクエリは、接続文字列で決定されるすべてのデータベースを取得します。
SELECT * FROM sys_catalogs
Name | Type | Description |
CatalogName | String | データベース名。 |
利用可能なスキーマをリストします。
次のクエリは、すべての利用可能なスキーマを取得します。
SELECT * FROM sys_schemas
Name | Type | Description |
CatalogName | String | データベース名。 |
SchemaName | String | スキーマ名。 |
利用可能なテーブルをリストします。
次のクエリは、利用可能なテーブルおよびビューを取得します。
SELECT * FROM sys_tables
Name | Type | Description |
CatalogName | String | テーブルまたはビューを含むデータベース。 |
SchemaName | String | テーブルまたはビューを含むスキーマ。 |
TableName | String | テーブル名またはビュー名。 |
TableType | String | テーブルの種類(テーブルまたはビュー)。 |
Description | String | テーブルまたはビューの説明。 |
IsUpdateable | Boolean | テーブルが更新可能かどうか。 |
利用可能なテーブルおよびビューのカラムについて説明します。
次のクエリは、Comments テーブルのカラムとデータ型を返します。
SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Comments'
Name | Type | Description |
CatalogName | String | テーブルまたはビューを含むデータベースの名前。 |
SchemaName | String | テーブルまたはビューを含むスキーマ。 |
TableName | String | カラムを含むテーブルまたはビューの名前。 |
ColumnName | String | カラム名。 |
DataTypeName | String | データ型の名前。 |
DataType | Int32 | データ型を示す整数値。この値は、実行時に環境に基づいて決定されます。 |
Length | Int32 | カラムのストレージサイズ。 |
DisplaySize | Int32 | 指定されたカラムの通常の最大幅(文字数)。 |
NumericPrecision | Int32 | 数値データの最大桁数。文字データおよび日時データの場合は、カラムの長さ(文字数)。 |
NumericScale | Int32 | カラムのスケール(小数点以下の桁数)。 |
IsNullable | Boolean | カラムがNull を含められるかどうか。 |
Description | String | カラムの簡単な説明。 |
Ordinal | Int32 | カラムのシーケンスナンバー。 |
IsAutoIncrement | String | カラムに固定増分値が割り当てられるかどうか。 |
IsGeneratedColumn | String | 生成されたカラムであるかどうか。 |
IsHidden | Boolean | カラムが非表示かどうか。 |
IsArray | Boolean | カラムが配列かどうか。 |
IsReadOnly | Boolean | カラムが読み取り専用かどうか。 |
IsKey | Boolean | sys_tablecolumns から返されたフィールドがテーブルの主キーであるかどうか。 |
利用可能なストアドプロシージャをリストします。
次のクエリは、利用可能なストアドプロシージャを取得します。
SELECT * FROM sys_procedures
Name | Type | Description |
CatalogName | String | ストアドプロシージャを含むデータベース。 |
SchemaName | String | ストアドプロシージャを含むスキーマ。 |
ProcedureName | String | ストアドプロシージャの名前。 |
Description | String | ストアドプロシージャの説明。 |
ProcedureType | String | PROCEDURE やFUNCTION などのプロシージャのタイプ。 |
ストアドプロシージャパラメータについて説明します。
次のクエリは、DownloadFile ストアドプロシージャのすべての入力パラメータについての情報を返します。
SELECT * FROM sys_procedureparameters WHERE ProcedureName='DownloadFile' AND Direction=1 OR Direction=2
Name | Type | Description |
CatalogName | String | ストアドプロシージャを含むデータベースの名前。 |
SchemaName | String | ストアドプロシージャを含むスキーマの名前。 |
ProcedureName | String | パラメータを含むストアドプロシージャの名前。 |
ColumnName | String | ストアドプロシージャパラメータの名前。 |
Direction | Int32 | パラメータのタイプに対応する整数値:input (1)。input/output (2)、またはoutput(4)。input/output タイプパラメータは、入力パラメータと出力パラメータの両方になれます。 |
DataTypeName | String | データ型の名前。 |
DataType | Int32 | データ型を示す整数値。この値は、実行時に環境に基づいて決定されます。 |
Length | Int32 | 文字データの場合は、許可される文字数。数値データの場合は、許可される桁数。 |
NumericPrecision | Int32 | 数値データの場合は最大精度。文字データおよび日時データの場合は、カラムの長さ(文字数)。 |
NumericScale | Int32 | 数値データの小数点以下の桁数。 |
IsNullable | Boolean | パラメータがNull を含められるかどうか。 |
IsRequired | Boolean | プロシージャの実行にパラメータが必要かどうか。 |
IsArray | Boolean | パラメータが配列かどうか。 |
Description | String | パラメータの説明。 |
Ordinal | Int32 | パラメータのインデックス。 |
主キーおよび外部キーについて説明します。
次のクエリは、Comments テーブルの主キーを取得します。
SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Comments'
Name | Type | Description |
CatalogName | String | キーを含むデータベースの名前。 |
SchemaName | String | キーを含むスキーマの名前。 |
TableName | String | キーを含むテーブルの名前。 |
ColumnName | String | キーカラムの名前 |
IsKey | Boolean | カラムがTableName フィールドで参照されるテーブル内の主キーかどうか。 |
IsForeignKey | Boolean | カラムがTableName フィールドで参照される外部キーかどうか。 |
PrimaryKeyName | String | 主キーの名前。 |
ForeignKeyName | String | 外部キーの名前。 |
ReferencedCatalogName | String | 主キーを含むデータベース。 |
ReferencedSchemaName | String | 主キーを含むスキーマ。 |
ReferencedTableName | String | 主キーを含むテーブル。 |
ReferencedColumnName | String | 主キーのカラム名。 |
外部キーについて説明します。
次のクエリは、他のテーブルを参照するすべての外部キーを取得します。
SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
名前 | タイプ | 説明 |
CatalogName | String | キーを含むデータベースの名前。 |
SchemaName | String | キーを含むスキーマの名前。 |
TableName | String | キーを含むテーブルの名前。 |
ColumnName | String | キーカラムの名前 |
PrimaryKeyName | String | 主キーの名前。 |
ForeignKeyName | String | 外部キーの名前。 |
ReferencedCatalogName | String | 主キーを含むデータベース。 |
ReferencedSchemaName | String | 主キーを含むスキーマ。 |
ReferencedTableName | String | 主キーを含むテーブル。 |
ReferencedColumnName | String | 主キーのカラム名。 |
ForeignKeyType | String | 外部キーがインポート(他のテーブルを指す)キーかエクスポート(他のテーブルから参照される)キーかを指定します。 |
主キーについて説明します。
次のクエリは、すべてのテーブルとビューから主キーを取得します。
SELECT * FROM sys_primarykeys
Name | Type | Description |
CatalogName | String | キーを含むデータベースの名前。 |
SchemaName | String | キーを含むスキーマの名前。 |
TableName | String | キーを含むテーブルの名前。 |
ColumnName | String | キーカラムの名前。 |
KeySeq | String | 主キーのシーケンス番号。 |
KeyName | String | 主キーの名前。 |
利用可能なインデックスについて説明します。インデックスをフィルタリングすることで、より高速なクエリ応答時間でセレクティブクエリを記述できます。
次のクエリは、主キーでないすべてのインデックスを取得します。
SELECT * FROM sys_indexes WHERE IsPrimary='false'
Name | Type | Description |
CatalogName | String | インデックスを含むデータベースの名前。 |
SchemaName | String | インデックスを含むスキーマの名前。 |
TableName | String | インデックスを含むテーブルの名前。 |
IndexName | String | インデックス名。 |
ColumnName | String | インデックスに関連付けられたカラムの名前。 |
IsUnique | Boolean | インデックスが固有の場合はTrue。そうでない場合はFalse。 |
IsPrimary | Boolean | インデックスが主キーの場合はTrue。そうでない場合はFalse。 |
Type | Int16 | インデックスタイプに対応する整数値:statistic (0)、clustered (1)、hashed (2)、またはother (3)。 |
SortOrder | String | 並べ替え順序:A が昇順、D が降順。 |
OrdinalPosition | Int16 | インデックスのカラムのシーケンスナンバー。 |
利用可能な接続プロパティと、接続文字列に設定されている接続プロパティに関する情報を返します。
このテーブルをクエリする際は、config 接続文字列を使用する必要があります。
jdbc:cdata:kintone:config:
この接続文字列を使用すると、有効な接続がなくてもこのテーブルをクエリできます。
次のクエリは、接続文字列に設定されている、あるいはデフォルト値で設定されているすべての接続プロパティを取得します。
SELECT * FROM sys_connection_props WHERE Value <> ''
Name | Type | Description |
Name | String | 接続プロパティ名。 |
ShortDescription | String | 簡単な説明。 |
Type | String | 接続プロパティのデータ型。 |
Default | String | 明示的に設定されていない場合のデフォルト値。 |
Values | String | 可能な値のカンマ区切りリスト。別な値が指定されていると、検証エラーがスローされます。 |
Value | String | 設定した値またはあらかじめ設定されたデフォルト。 |
Required | Boolean | プロパティが接続に必要かどうか。 |
Category | String | 接続プロパティのカテゴリ。 |
IsSessionProperty | String | プロパティが、現在の接続に関する情報を保存するために使用されるセッションプロパティかどうか。 |
Sensitivity | String | プロパティの機密度。これは、プロパティがロギングおよび認証フォームで難読化されているかどうかを通知します。 |
PropertyName | String | キャメルケースの短縮形の接続プロパティ名。 |
Ordinal | Int32 | パラメータのインデックス。 |
CatOrdinal | Int32 | パラメータカテゴリのインデックス。 |
Hierarchy | String | このプロパティと一緒に設定する必要がある、関連のある依存プロパティを表示します。 |
Visible | Boolean | プロパティが接続UI に表示されるかどうかを通知します。 |
ETC | String | プロパティに関するその他のさまざまな情報。 |
Cloud がデータソースにオフロードできるSELECT クエリ処理について説明します。
SQL 構文の詳細については、SQL 準拠 を参照してください。
以下はSQL 機能のサンプルデータセットです。 SELECT 機能のいくつかの側面がサポートされている場合には、カンマ区切りのリストで返されます。サポートされていない場合、カラムにはNO が入ります。
名前 | 説明 | 有効な値 |
AGGREGATE_FUNCTIONS | サポートされている集計関数。 | AVG, COUNT, MAX, MIN, SUM, DISTINCT |
COUNT | COUNT 関数がサポートされているかどうか。 | YES, NO |
IDENTIFIER_QUOTE_OPEN_CHAR | 識別子をエスケープするための開始文字。 | [ |
IDENTIFIER_QUOTE_CLOSE_CHAR | 識別子をエスケープするための終了文字。 | ] |
SUPPORTED_OPERATORS | サポートされているSQL 演算子。 | =, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR |
GROUP_BY | GROUP BY がサポートされているかどうか。サポートされている場合、どのレベルでサポートされているか。 | NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE |
OJ_CAPABILITIES | サポートされている外部結合の種類。 | NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS |
OUTER_JOINS | 外部結合がサポートされているかどうか。 | YES, NO |
SUBQUERIES | サブクエリがサポートされているかどうか。サポートされていれば、どのレベルでサポートされているか。 | NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED |
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 | サポートされている数値関数。 | 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 | サポートされている日付および時刻関数。 | 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 | レプリケーション中にスキップされたテーブルを示します。 | |
REPLICATION_TIMECHECK_COLUMNS | レプリケーション中に更新判断のカラムとして使用するかどうかを、(指定された順に)チェックするカラムのリストを含む文字列の配列。 | |
IDENTIFIER_PATTERN | 識別子としてどの文字列が有効かを示す文字列値。 | |
SUPPORT_TRANSACTION | プロバイダーが、コミットやロールバックなどのトランザクションをサポートしているかどうかを示します。 | YES, NO |
DIALECT | 使用するSQL ダイアレクトを示します。 | |
KEY_PROPERTIES | Uniform データベースを特定するプロパティを示します。 | |
SUPPORTS_MULTIPLE_SCHEMAS | プロバイダー用に複数のスキームが存在するかどうかを示します。 | YES, NO |
SUPPORTS_MULTIPLE_CATALOGS | プロバイダー用に複数のカタログが存在するかどうかを示します。 | YES, NO |
DATASYNCVERSION | このドライバーにアクセスするために必要な、CData Sync のバージョン。 | Standard, Starter, Professional, Enterprise |
DATASYNCCATEGORY | このドライバーのCData Sync カテゴリ。 | Source, Destination, Cloud Destination |
SUPPORTSENHANCEDSQL | API で提供されている以上の、追加SQL 機能がサポートされているかどうか。 | TRUE, FALSE |
SUPPORTS_BATCH_OPERATIONS | バッチ操作がサポートされているかどうか。 | YES, NO |
SQL_CAP | このドライバーでサポートされているすべてのSQL 機能。 | 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 | 使用したいcacheOptions を指定する文字列値。 | |
ENABLE_EF_ADVANCED_QUERY | ドライバーがEntity Framework の高度なクエリをサポートしているかどうかを示します。サポートしていなければ、クエリはクライアントサイドで処理されます。 | YES, NO |
PSEUDO_COLUMNS | 利用可能な疑似カラムを示す文字列の配列。 | |
MERGE_ALWAYS | 値がtrue であれば、CData Sync 内でMerge Model が強制的に実行されます。 | TRUE, FALSE |
REPLICATION_MIN_DATE_QUERY | レプリケート開始日時を返すSELECT クエリ。 | |
REPLICATION_MIN_FUNCTION | サーバーサイドでmin を実行するために使用する式名を、プロバイダーが指定できるようになります。 | |
REPLICATION_START_DATE | レプリケート開始日を、プロバイダーが指定できるようになります。 | |
REPLICATION_MAX_DATE_QUERY | レプリケート終了日時を返すSELECT クエリ。 | |
REPLICATION_MAX_FUNCTION | サーバーサイドでmax を実行するために使用する式名を、プロバイダーが指定できるようになります。 | |
IGNORE_INTERVALS_ON_INITIAL_REPLICATE | 初回のレプリケートで、レプリケートをチャンクに分割しないテーブルのリスト。 | |
CHECKCACHE_USE_PARENTID | CheckCache 構文を親キーカラムに対して実行するかどうかを示します。 | TRUE, FALSE |
CREATE_SCHEMA_PROCEDURES | スキーマファイルの生成に使用できる、ストアドプロシージャを示します。 |
次のクエリは、WHERE 句で使用できる演算子を取得します。
SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'
WHERE 句では、個々のテーブルの制限や要件が異なる場合がありますので注意してください。詳しくは、データモデル セクションを参照してください。
Name | Type | Description |
NAME | String | SQL 構文のコンポーネント、またはサーバー上で処理できる機能。 |
VALUE | String | サポートされるSQL またはSQL 構文の詳細。 |
試行された変更に関する情報を返します。
次のクエリは、バッチ処理で変更された行のId を取得します。
SELECT * FROM sys_identity
Name | Type | Description |
Id | String | データ変更処理から返された、データベース生成Id。 |
Batch | String | バッチの識別子。1 は単一処理。 |
Operation | String | バッチ内の処理の結果:INSERTED、UPDATED、またはDELETED。 |
Message | String | SUCCESS、またはバッチ内の更新が失敗した場合のエラーメッセージ。 |
プロパティ | 説明 |
AuthScheme | Kintone にUser / Password で接続するかAPIToken で接続するか。 |
URL | Kintone URL。次に例を示します。 https://SUBDOMAIN_NAME.cybozu.com |
User | 認証で使用されるKintone ユーザーアカウント。 |
Password | ユーザーの認証で使用されるパスワード。 |
BasicAuthUser | Basic 認証を使用するドメインに必要な追加のユーザー名。 |
BasicAuthPassword | Basic 認証を使用するドメインに必要な追加のパスワード。 |
AppId | 認証時にAPI トークンとともに使用するアプリID。 |
APIToken | 認証時に使用するAPI トークン。 |
プロパティ | 説明 |
Verbosity | ログファイルの記述をどの程度の詳細さで記載するかを決定するverbosity レベル。 |
プロパティ | 説明 |
BrowsableSchemas | このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
プロパティ | 説明 |
AllowSpecialCharacters | 特殊文字を許容するかどうかを決定します。True の場合、特殊文字は置き換えられません。 |
CheckForSubtablesIn | サブテーブルを取得するKintone アプリのカンマ区切りリスト。 |
GuestSpaceId | クエリ結果をゲストスペースに制限します。 |
MaxRows | クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。 |
NumberMapToDouble | 数値フィールドのデータ型をdecimal からdouble に変更するかどうかを決定します。 |
Pagesize | Kintone から返されるページあたりの結果の最大数。 |
SubtableSeparatorCharacter | tablename + char + subtable 形式のサブテーブルからテーブルを分割するために使用される文字。 |
Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
UseCodeForFieldName | フィールド名にLabel かCode のどちらを使用するかを決定します。 |
UseCursor | カーソルを使用してレコードを取得するかどうかを決定するboolean。 |
UseSimpleNames | テーブルとカラムに簡略名を使用するかどうかを決定するboolean。 |
UseUnitForNumericField | フィールド名に単位を表示するかどうかを決定します。 |
このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。
プロパティ | 説明 |
AuthScheme | Kintone にUser / Password で接続するかAPIToken で接続するか。 |
URL | Kintone URL。次に例を示します。 https://SUBDOMAIN_NAME.cybozu.com |
User | 認証で使用されるKintone ユーザーアカウント。 |
Password | ユーザーの認証で使用されるパスワード。 |
BasicAuthUser | Basic 認証を使用するドメインに必要な追加のユーザー名。 |
BasicAuthPassword | Basic 認証を使用するドメインに必要な追加のパスワード。 |
AppId | 認証時にAPI トークンとともに使用するアプリID。 |
APIToken | 認証時に使用するAPI トークン。 |
Kintone にUser / Password で接続するかAPIToken で接続するか。
string
"Password"
Kintone URL。次に例を示します。 https://SUBDOMAIN_NAME.cybozu.com
string
""
Kintone URL。次に例を示します。
https://SUBDOMAIN_NAME.cybozu.com
認証で使用されるKintone ユーザーアカウント。
string
""
このフィールドは、Password とともに、Kintone サーバーに対して認証をするために使われます。
Basic 認証を使用するドメインに必要な追加のユーザー名。
string
""
Basic 認証が有効なドメインに接続するために使用するBasic 認証のユーザー名。Basic 認証は2段階認証です。Basic 認証を使用するドメインに接続する場合は、User とPassword に加えてBasicAuthUser とBasicAuthPassword を設定します。
Basic 認証を使用するドメインに必要な追加のパスワード。
string
""
Basic 認証が有効なドメインに接続するために使用するBasic 認証のパスワード。Basic 認証は2段階認証です。Basic 認証を使用するドメインに接続する場合は、User とPassword に加えてBasicAuthUser とBasicAuthPassword を設定します。
認証時にAPI トークンとともに使用するアプリID。
string
""
AppId は、kintone UI ダッシュボードの[アプリ]の下にあるシーケンス内の特定のアプリの番号です。
AppId をカンマ区切りで複数指定することもできます。
認証時に使用するAPI トークン。
string
""
認証時に使用するAPI トークン。API トークンを作成するには、API トークンを作成する特定のアプリにアクセスして歯車アイコンをクリックします。[アプリの設定]->[設定]タブ->[APIトークン]に進み、[生成する]ボタンをクリックすると、API トークンが生成されます。
また、Lookup フィールドやRelated Record フィールドを含む操作の場合は、APIToken をカンマ区切りで複数指定することができます。
このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。
プロパティ | 説明 |
Verbosity | ログファイルの記述をどの程度の詳細さで記載するかを決定するverbosity レベル。 |
このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。
プロパティ | 説明 |
BrowsableSchemas | このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
string
""
スキーマをデータベースからリストすると、負荷がかかる可能性があります。接続文字列でスキーマのリストを提供すると、 パフォーマンスが向上します。
このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。
プロパティ | 説明 |
AllowSpecialCharacters | 特殊文字を許容するかどうかを決定します。True の場合、特殊文字は置き換えられません。 |
CheckForSubtablesIn | サブテーブルを取得するKintone アプリのカンマ区切りリスト。 |
GuestSpaceId | クエリ結果をゲストスペースに制限します。 |
MaxRows | クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。 |
NumberMapToDouble | 数値フィールドのデータ型をdecimal からdouble に変更するかどうかを決定します。 |
Pagesize | Kintone から返されるページあたりの結果の最大数。 |
SubtableSeparatorCharacter | tablename + char + subtable 形式のサブテーブルからテーブルを分割するために使用される文字。 |
Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
UseCodeForFieldName | フィールド名にLabel かCode のどちらを使用するかを決定します。 |
UseCursor | カーソルを使用してレコードを取得するかどうかを決定するboolean。 |
UseSimpleNames | テーブルとカラムに簡略名を使用するかどうかを決定するboolean。 |
UseUnitForNumericField | フィールド名に単位を表示するかどうかを決定します。 |
特殊文字を許容するかどうかを決定します。True の場合、特殊文字は置き換えられません。
bool
false
特殊文字を許容するかどうかを決定します。True の場合、特殊文字は置き換えられません。
サブテーブルを取得するKintone アプリのカンマ区切りリスト。
string
"*"
すべてのKintone アプリのサブテーブルを確認するには、このフィールドを* に設定します。サブテーブルを検索しない場合は、このフィールドを'None' に設定します。Kintone サブテーブルは別々のテーブルとして公開されており、API からすべてのサブテーブルのリストを取得するのは時間がかかります。この フィールドにいくつかのアプリ名のみを指定することで、Cloud のパフォーマンスが向上します。このフィールドを* に設定して、すべてのKintone アプリのサブテーブルを確認することもできますが、アプリ数が多い場合はテーブルをリストするにははるかに時間がかかります。
クエリ結果をゲストスペースに制限します。
string
""
この接続プロパティは、クエリ結果を指定したゲストスペースに制限します。
GuestSpaceId は、Apps テーブルのSpaceId カラムにあるCloud で確認できます。あるいは、作成したスペースに移動するときにURL からGuestSpaceId を取得します。例えば、次のURL では、GuestSpaceId は"3" になります。
https://xlqc1.cybozu.com/k/guest/3/#/space/3/thread/3
クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
int
-1
クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
数値フィールドのデータ型をdecimal からdouble に変更するかどうかを決定します。
bool
false
数値フィールドのデータ型をdecimal からdouble に変更するかどうかを決定します。True に設定すると、データ型がdecimal からdouble に変更されます。
Kintone から返されるページあたりの結果の最大数。
int
500
Pagesize プロパティは、Kintone から返されるページあたりの結果の最大数に影響を与えます。より大きい値を設定すると、1ページあたりの消費メモリが増える代わりに、パフォーマンスが向上する場合があります。
tablename + char + subtable 形式のサブテーブルからテーブルを分割するために使用される文字。
string
"_"
アプリにサブテーブルがある場合、それは別のテーブルとして表示されます。名前は、AppName + SubtableSeparatorCharacter + SubtableName になります。 このプロパティを使用して、カスタム文字をセパレータとして設定し、アプリからサブテーブルを簡単に識別します。このプロパティを使用すると、 アプリの命名規則を破らずにサブテーブル名に異なる特殊文字を設定できます。
タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
int
60
Timeout が0に設定されている場合は、操作がタイムアウトしません。処理が正常に完了するか、エラー状態になるまで実行されます。
Timeout の有効期限が切れても処理が完了していない場合は、Cloud は例外をスローします。
フィールド名にLabel かCode のどちらを使用するかを決定します。
bool
false
true に設定すると、フィールド名にCode が使用されます。
カーソルを使用してレコードを取得するかどうかを決定するboolean。
bool
true
カーソルを使用してレコードを取得するかどうかを決定するboolean。
テーブルとカラムに簡略名を使用するかどうかを決定するboolean。
bool
false
Kintone テーブルおよびカラムでは、 通常のデータベースでは使うことが認められていない特殊記号・文字を名前に使うことができます。UseSimpleNames を使用すると、Cloud を従来のデータベースツールでより簡単に使用できるようになります。
UseSimpleNames をtrue に設定し、返されるテーブル名およびカラム名をシンプルにします。表示されるテーブル名 およびカラム名においてアルファベット文字およびアンダースコアのみを有効とするネーミングスキームを強制します。 英数字以外の文字はすべて、アンダースコアに変換されます。
フィールド名に単位を表示するかどうかを決定します。
bool
true
false を指定するとフィールド名に単位は表示されません。