CData Cloud は、クラウドホスト型のソリューションで、複数の標準サービスやプロトコルにまたがるGoogle Drive へのアクセスを実現します。MySQL またはSQL Server データベースに接続できるアプリケーションであれば、CData Cloud を介してGoogle Drive に接続できます。
CData Cloud により、他のOData エンドポイントや標準SQL Server / MySQL データベースと同じように、Google Drive への接続を標準化し、構成することができます。
このページでは、CData Cloud でのGoogle Drive への接続の確立 のガイド、利用可能なリソースに関する情報、および使用可能な接続プロパティのリファレンスについて説明します。
接続の確立 は、CData Cloud にデータベースを作成するためのGoogle Drive への認証方法と必要な接続プロパティの設定方法について示します。
利用可能な標準サービスを経由してGoogle Drive からデータにアクセスする方法と、CData Cloud の管理については、CData Cloud ドキュメント で詳しく説明します。
Database タブで対応するアイコンを選択して、Google Drive に接続します。必須プロパティはSettings にリストされています。Advanced タブには、通常は必要ない接続プロパティが表示されます。
Cloud は、認証にユーザーアカウントおよびGCP インスタンスアカウントの使用をサポートします。
以下のセクションでは、Google Drive の利用可能な認証スキームについて説明します。
AuthScheme は、すべてのユーザーアカウントフローでOAuth に設定する必要があります。
OAuth アクセストークンの取得
次の接続プロパティを設定し、OAuthAccessToken を取得します。
続いてストアドプロシージャを呼び出し、OAuth 交換を完了します。
アクセストークンとリフレッシュトークンを取得すると、データに接続し、OAuth アクセストークンを自動または手動でリフレッシュすることができるようになります。
OAuth アクセストークンの自動リフレッシュ
ドライバーがOAuth アクセストークンを自動的にリフレッシュするようにするには、最初のデータ接続で次のように設定します。
OAuth アクセストークンの手動リフレッシュ
データ接続時に手動でOAuth アクセストークンをリフレッシュするために必要な値は、OAuth リフレッシュトークンのみです。
GetOAuthAccessToken によって返されたExpiresIn パラメータ値が経過した後に、RefreshOAuthAccessToken ストアドプロシージャを使用し、手動でOAuthAccessToken をリフレッシュします。次の接続プロパティを設定します。
次に、RefreshOAuthAccessToken を呼び出し、OAuthRefreshToken にGetOAuthAccessToken によって返されたOAuth リフレッシュトークンを指定します。新しいトークンが取得できたら、OAuthAccessToken プロパティにRefreshOAuthAccessToken によって返された値を設定し、新しい接続をオープンします。
最後に、OAuth リフレッシュトークンを保存し、OAuth アクセストークンの有効期限が切れた後に手動でリフレッシュできるようにします。
オプション1:Verifier code を取得および交換
Verifier code を取得するには、OAuth Authorization URL で認証する必要があります。
インターネットブラウザに対応したマシンから認証してOAuthVerifier 接続プロパティを取得する方法は次のとおりです。
ヘッドレスマシンでは、次の接続プロパティを設定してOAuth 認証値を取得します。
OAuth 設定ファイルが生成されたら、以下のように接続プロパティをリセットする必要があります。
オプション2:OAuth 設定を転送
ヘッドレスマシンでの接続に先立ち、インターネットブラウザに対応したデバイスでドライバとの接続を作成し、インストールする必要があります。上述の「デスクトップアプリケーション」の説明に従って、接続プロパティを設定します。
「デスクトップアプリケーション」の手順が完了すると、生成された認証値は、OAuthSettingsLocation で指定された場所に暗号化されて書き込まれます。デフォルトのファイル名はOAuthSettings.txt です。
接続が正常にテストされたら、OAuth 設定ファイルをヘッドレスマシンにコピーします。
ヘッドレスマシンで、次の接続プロパティを設定し、データに接続します。
GCP 仮想マシン上で実行している場合は、Cloud は仮想マシンに関連付けられたサービスアカウントを使用して認証できます。 このモードを使用するには、AuthScheme をGCPInstanceAccount に設定します。
(OAuthAccessToken およびその他の設定パラメータを取得および設定する方法についての情報は、「Google Drive への接続」の デスクトップ認証セクションを参照してください。)
ただし、Web 経由で接続するには、カスタムOAuth アプリケーションの作成が必要です。また、カスタムOAuth アプリケーションは、一般的に使用される3つの認証フローをすべてシームレスにサポートするため、これらの認証フロー用にカスタムOAuth アプリケーションを作成(独自のOAuth アプリケーションクレデンシャルを使用)することもできます。
カスタムOAuth アプリケーションは、次のような場合に有用です。
以下のセクションでは、Directory API を有効化し、ユーザーアカウント(OAuth)およびサービスアカウント(OAuth / JWT)用のカスタムOAuth アプリケーションを作成する方法について説明します。
AuthScheme がOAuth であり、Web アプリケーション上で認証する必要があるユーザーの場合は、必ずカスタムOAuth アプリケーションを作成する必要があります。 (デスクトップおよびヘッドレスフローでのカスタムOAuth アプリケーションの作成は任意です。)
以下の手順に従います。
Note: クライアントシークレットはGoogle Cloud コンソールからアクセス可能です。
新しいサービスアカウントを作成するには:
サービスアカウントフローを完了させるには、Google Cloud Console で秘密キーを生成します。サービスアカウントフローにおいて、ドライバーはOAuthAccessToken へのJSON Web Token (JWT) を交換します。秘密キーはJWT の署名に必要です。ドライバーには、サービスアカウントに付与されているのと同じ権限が与えられます。
デフォルトでは、Cloud はサーバーとのTLS のネゴシエーションを試みます。サーバー証明書は、デフォルトのシステム信頼済み証明書ストアで検証されます。SSLServerCert 接続プロパティを使用して、証明書の検証方法をオーバーライドできます。
別の証明書を指定するには、SSLServerCert 接続プロパティを参照してください。
HTTP プロキシへの認証には、以下のように設定します。
次のプロパティを設定します。
CData Cloud は、Google Drive API をリレーショナルテーブル、ビュー、およびストアドプロシージャとしてモデル化します。これらは、簡単なテキストベースのコンフィギュレーションファイルであるスキーマファイルにて定義されます。 このセクションでは、API の制限および要件について説明します。既定のSupportEnhancedSQL 機能を使って、これらの制限の大半を回避できます。
テーブル では、利用可能なテーブルを説明します。
ビュー は変更ができないテーブルです。一般的には、Read-only で更新が不可能なデータはビューとして表されます。
ストアドプロシージャ は、データソースのファンクションライクなインターフェースです。これらを使用して、データソース内の情報を検索、更新、および変更できます。
Cloud はGoogle Drive のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。
Name | Description |
Drives | 特定のユーザーの使用可能なDrives を作成、削除、およびクエリします。 |
Files | ユーザーのGoogleドライブに含まれるファイルおよびフォルダを作成、更新、削除、およびクエリします。 |
Permissions | ユーザーのGoogleドライブのリソースに対する権限を作成、更新、削除、およびクエリします。 |
特定のユーザーの使用可能なDrives を作成、削除、およびクエリします。
Name | Type | ReadOnly | Description |
Id [KEY] | String | True |
ドライブのId。 |
Name | String | False |
ドライブ名。 |
Capabilities | String | True |
このフィールドは、現在のユーザーがドライブに対して持つ有効な機能を示します。 |
CreatedTime | Datetime | True |
ドライブの作成日。 |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
DomainAdminAccess | Boolean |
このフィールドがtrue に設定されている場合、管理者であるドメインのすべてのドライブが返されます。 |
ユーザーのGoogleドライブに含まれるファイルおよびフォルダを作成、更新、削除、およびクエリします。
File テーブルはフィルタリング用にいくつかのカラムのみをサポートします。以下は、これらのカラムを含むテーブルとそれらがサポートする処理です。すべてのフィルタリングは'OR' もしくは'AND' 演算子で接続することができます。
カラム | サポートする演算子 |
Name | contains, =, != |
MIMEType | contains, =, != |
ModifiedTime | <=, <, =, !=, >, >= |
Trashed | =, != |
Starred | =, != |
ParentIds | in |
OwnerEmail | in |
contains 演算子は、name に対してプレフィックスマッチングのみを実行します。
例えば、"HelloWorld" という名前は、'Hello' を含む名前に一致しますが
'World' を含む名前には一致しません。
SELECT * FROM [Files] WHERE ModifiedTime > '2017-01-01' OR CONTAINS(Name, 'CData')
SELECT * FROM [Files] WHERE OwnerEmail IN ('[email protected]') AND Starred = true
SELECT * FROM [Files] WHERE Starred = true
SELECT * FROM [Files] WHERE DriveId = '0ACkq0ZiV0yJCUk9PVA'Note: 特定のドライブからクエリするには、SupportsAllDrives 接続プロパティを'true' に設定する必要があります。
少なくともName およびLocalFile かFileData の値を指定する必要があります。
INSERT INTO Files (Name, LocalFile) VALUES ('MyFile', 'C:\\\\file.txt')
ファイルの更新にはId が必要です。
UPDATE Files SET Name = 'UpdatedName' WHERE Id = '19YFv8wmvKixCYaJJAeE8jN3ROt7x1ZicvXwflswVOrw'
ファイルの内容を更新することも可能です。これは実際の内容を更新しますので注意してください。
UPDATE Files SET LocalFile = 'C:\\\\file.txt' WHERE Id = '19YFv8wmvKixCYaJJAeE8jN3ROt7x1ZicvXwflswVOrw'
File の削除には、Id が必要です。
DELETE FROM [Files] WHERE Id = '1Dx6GTyhgTmTjtoy8GuG0n0qaOsKyhwrOG6MG8A2QQYA'
Name | Type | ReadOnly | Description |
Id [KEY] | String | True |
ファイルのId。 |
Name | String | False |
ファイル名。これはフォルダ内で必ずしもユニークである必要はありません。Team Dries のトップレベルフォルダ、My Drive ルートファイル、Application Data フォルダなどの不変のアイテムは名前が変わることはないので注意してください。 |
DriveId | String | True |
ドライブのId。 |
Description | String | False |
ファイルまたはフォルダの簡単な説明。 |
Extension | String | True |
ファイルの拡張子。 |
MIMEType | String | False |
ファイルのMIME タイプ。 |
CreatedTime | Datetime | True |
ファイルまたはフォルダの作成日。 |
ModifiedTime | Datetime | True |
ファイルまたはフォルダの最終変更日。 |
Size | Long | True |
ファイルのサイズ(バイト)。 |
OwnerName | String | True |
リソースオーナーの名前。 |
OwnerEmail | String | True |
リソースオーナーのE メール。 |
Folder | Boolean | True |
このフィールドは、リソースがフォルダかどうかを示します。 |
Starred | Boolean | False |
このフィールドは、リソースがスター付きかどうかを設定します。 |
Trashed | Boolean | True |
このフィールドは、リソースがごみ箱に移動されているかどうかを設定します。 |
Viewed | Boolean | True |
このフィールドは、リソースが現在のユーザーによって表示されたかどうかを設定します。 |
ParentIds | String | True |
親フォルダーID のカンマ区切りリスト。 |
ChildIds | String | True |
子リソースIDのセミコロン区切りリスト。 |
ChildLinks | String | True |
子リソースリンクのセミコロン区切りリスト。 |
Query | String | True |
このフィールドは、有効なGoogle ドライブSDK クエリを受け入れ、WHERE 句の条件を上書きします。 |
LocalFile | String | False |
アップロードされるファイルのファイル名を含むローカルファイルパス。FileData が指定されていない場合、このフィールドには値が必要です。ファイルの挿入および通信にのみ使われます。 |
FileData | String | False |
インプットが空白の場合、ファイルデータはエンコードインプットで指定されたフォーマットでアウトプットされます。ファイルの挿入および通信にのみ使われます。 |
Encoding | String | False |
FileData のインプットエンコーディングタイプ。ファイルの挿入および通信にのみ使われます。 使用できる値は次のとおりです。NONE, BASE64 デフォルト値はBASE64です。 |
ユーザーのGoogleドライブのリソースに対する権限を作成、更新、削除、およびクエリします。
このテーブルからデータを取得するにはResourceId を指定する必要があります。フィルタリングのサポートはResourceId だけです。
SELECT * FROM Permissions WHERE ResourceId = '0B5AH3NIqjXDKX3pJS3NncTZJa01'
Permissions に挿入するには、少なくともResourceId、Role、Type、およびEmail Address フィールドの値の指定が必要です。
INSERT INTO Permissions (ResourceId, Role, Type, EmailAddress) VALUES ('0B5AH3NIqjXDKX3pJS3NncTZJa01', 'WRITER', 'USER', '[email protected]')
Permission の更新には、PermissionId およびResourceId フィールドが必要です。
UPDATE Permissions SET Role = 'organizer' WHERE PermissionId = '3NIqjXDK' AND ResourceId = '0B5AH3NIqjXDKX3pJS3NncTZJa01'
Permission の削除には、PermissionId およびResourceId フィールドが必要です。
Delete From Permissions WHERE PermissionId = '3NIqjXDK' AND ResourceId = '0B5AH3NIqjXDKX3pJS3NncTZJa01'
Name | Type | ReadOnly | Description |
PermissionId [KEY] | String | True |
リソースの権限のID。 |
ResourceId [KEY] | String | True |
リソース(ファイルまたはフォルダ)のID。 |
Role | String | False |
権限に指定されたロール。次の値のみ設定できます:'READER'、'COMMENTER'、'WRITER'、'OWNER'、'FILE_ORGANIZER'、'ORGANIZER'。 |
Type | String | False |
権限の適用先のタイプエンティティ。次の値のみ設定できます:'USER'、'GROUP'、'DOMAIN'、'ANYONE'。 |
EmailAddress | String | False |
権限が参照するユーザーもしくはグループのE メールアドレス。 |
Domain | String | False |
権限が参照するドメイン。 |
AllowFileDiscovery | Boolean | False |
権限が検索によるファイルまたはフォルダの検出を許容するかどうか。これは、'DOMAIN' または'ANYONE' タイプの権限にのみ適用されます。このフィールドのデフォルト値は'false' です。 |
ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。
クエリは、ビューに対して通常のテーブルと同様に実行することができます。
Name | Description |
Docs | ユーザーのGoogle Drive に含まれるGoogle Docs のクエリ。 |
Folders | ユーザーのGoogle Drive に含まれるフォルダのクエリ。 |
Photos | ユーザーのGoogle Drive に含まれる写真のクエリ。 |
Sheets | ユーザーのGoogle Drive に含まれるGoogle Sheets のクエリ。 |
Videos | ユーザーのGoogle Drive に含まれるGoogle ビデオのクエリ。 |
ユーザーのGoogle Drive に含まれるGoogle Docs のクエリ。
すべてのドキュメントをドライブから取得することもできます。
Note: 特定のドライブからクエリするには、SupportsAllDrives 接続プロパティを'true' に設定する必要があります。
SELECT * FROM Docs WHERE DriveId = '0ACkq0ZiV0yJCUk9PVA'
Name | Type | Description |
Id [KEY] | String | ファイルのId。 |
Name | String | ファイル名。これはフォルダ内で必ずしもユニークである必要はありません。Team Dries のトップレベルフォルダ、My Drive ルートファイル、Application Data フォルダなどの不変のアイテムは名前が変わることはないので注意してください。 |
DriveId | String | ドライブのId。 |
Description | String | ファイルまたはフォルダの簡単な説明。 |
Extension | String | ファイルの拡張子。 |
CreatedTime | Datetime | ファイルまたはフォルダの作成日。 |
ModifiedTime | Datetime | ファイルまたはフォルダの最終変更日。 |
Size | Long | ファイルのサイズ(バイト)。 |
OwnerName | String | リソースオーナーの名前。 |
OwnerEmail | String | リソースオーナーのE メール。 |
Starred | Boolean | このフィールドは、リソースがスター付きかどうかを設定します。 |
Trashed | Boolean | このフィールドは、リソースがごみ箱に移動されているかどうかを設定します。 |
Viewed | Boolean | このフィールドは、リソースが現在のユーザーによって表示されたかどうかを設定します。 |
ParentIds | String | 親フォルダーID のカンマ区切りリスト。 |
ChildIds | String | 子リソースID のセミコロン区切りリスト。 |
ChildLinks | String | 子リソースリンクのセミコロン区切りリスト。 |
Query | String | このフィールドは、有効なGoogle ドライブSDK クエリを受け入れ、WHERE 句の条件をオーバーライドします。 |
ユーザーのGoogle Drive に含まれるフォルダのクエリ。
すべてのフォルダをドライブから取得することもできます。特定のドライブからクエリするには、SupportsAllDrives 接続プロパティを'true' に設定する必要があります。
SELECT * FROM Folders WHERE DriveId = '0ACkq0ZiV0yJCUk9PVA'NOTE: specifying a large set of fields may result in lower performance, so we recommend that you restrict your query to only the columns you need for best results.
Name | Type | Description |
Id [KEY] | String | ファイルのId。 |
Name | String | ファイル名。これはフォルダ内で必ずしもユニークである必要はありません。Team Dries のトップレベルフォルダ、My Drive ルートファイル、Application Data フォルダなどの不変のアイテムは名前が変わることはないので注意してください。 |
DriveId | String | ドライブのId。 |
Description | String | ファイルまたはフォルダの簡単な説明。 |
CreatedTime | Datetime | ファイルまたはフォルダの作成日。 |
ModifiedTime | Datetime | ファイルまたはフォルダの最終変更日。 |
Size | Long | ファイルのサイズ(バイト) |
OwnerName | String | リソースオーナーの名前。 |
OwnerEmail | String | リソースオーナーのE メール。 |
Starred | Boolean | このフィールドは、リソースがスター付きかどうかを設定します。 |
Trashed | Boolean | このフィールドは、リソースがごみ箱に移動されているかどうかを設定します。 |
Viewed | Boolean | このフィールドは、リソースが現在のユーザーによって表示されたかどうかを設定します。 |
ParentIds | String | 親フォルダーIDのカンマ区切りリスト。 |
ChildIds | String | 子リソースIDのセミコロン区切りリスト。 |
ChildLinks | String | 子リソースリンクのセミコロン区切りリスト。 |
Query | String | このフィールドは、有効なGoogle ドライブSDK クエリを受け入れ、WHERE 句の条件をオーバーライドします。 |
ユーザーのGoogle Drive に含まれる写真のクエリ。
すべての写真をドライブから取得することもできます。
Note: 特定のドライブからクエリするには、SupportsAllDrives 接続プロパティを'true' に設定する必要があります。
SELECT * FROM Photos WHERE DriveId = '0ACkq0ZiV0yJCUk9PVA'
Name | Type | Description |
Id [KEY] | String | ファイルのId。 |
Name | String | ファイル名。これはフォルダ内で必ずしもユニークである必要はありません。Team Dries のトップレベルフォルダ、My Drive ルートファイル、Application Data フォルダなどの不変のアイテムは名前が変わることはないので注意してください。 |
DriveId | String | ドライブのId。 |
Description | String | ファイルまたはフォルダの簡単な説明。 |
Extension | String | ファイルの拡張子。 |
CreatedTime | Datetime | ファイルまたはフォルダの作成日。 |
ModifiedTime | Datetime | ファイルまたはフォルダの最終変更日。 |
Size | Long | ファイルのサイズ(バイト)。 |
OwnerName | String | リソースオーナーの名前。 |
OwnerEmail | String | リソースオーナーのE メール。 |
Starred | Boolean | このフィールドは、リソースがスター付きかどうかを設定します。 |
Trashed | Boolean | このフィールドは、リソースがごみ箱に移動されているかどうかを設定します。 |
Viewed | Boolean | このフィールドは、リソースが現在のユーザーによって表示されたかどうかを設定します。 |
ParentIds | String | 親フォルダーIDのカンマ区切りリスト。 |
ChildIds | String | 子リソースIDのセミコロン区切りリスト。 |
ChildLinks | String | 子リソースリンクのセミコロン区切りリスト。 |
Query | String | このフィールドは、有効なGoogle ドライブSDK クエリを受け入れ、WHERE 句の条件をオーバーライドします。 |
ユーザーのGoogle Drive に含まれるGoogle Sheets のクエリ。
すべてのシートをドライブから取得することもできます。
Note: 特定のドライブからクエリするには、SupportsAllDrives 接続プロパティを'true' に設定する必要があります。
SELECT * FROM Sheets WHERE DriveId = '0ACkq0ZiV0yJCUk9PVA'
Name | Type | Description |
Id [KEY] | String | ファイルのId。 |
Name | String | ファイル名。これはフォルダ内で必ずしもユニークである必要はありません。Team Dries のトップレベルフォルダ、My Drive ルートファイル、Application Data フォルダなどの不変のアイテムは名前が変わることはないので注意してください。 |
DriveId | String | ドライブのId。 |
Description | String | ファイルまたはフォルダの簡単な説明。 |
Extension | String | ファイルの拡張子。 |
CreatedTime | Datetime | ファイルまたはフォルダの作成日。 |
ModifiedTime | Datetime | ファイルまたはフォルダの最終変更日。 |
Size | Long | ファイルのサイズ(バイト)。 |
OwnerName | String | リソースオーナーの名前。 |
OwnerEmail | String | リソースオーナーのE メール。 |
Starred | Boolean | このフィールドは、リソースがスター付きかどうかを設定します。 |
Trashed | Boolean | このフィールドは、リソースがごみ箱に移動されているかどうかを設定します。 |
Viewed | Boolean | このフィールドは、リソースが現在のユーザーによって表示されたかどうかを設定します。 |
ParentIds | String | 親フォルダーID のカンマ区切りリスト。 |
ChildIds | String | 子リソースID のセミコロン区切りリスト。 |
ChildLinks | String | 子リソースリンクのセミコロン区切りリスト。 |
Query | String | このフィールドは、有効なGoogle ドライブSDK クエリを受け入れ、WHERE 句の条件をオーバーライドします。 |
ユーザーのGoogle Drive に含まれるGoogle ビデオのクエリ。
すべての動画をドライブから取得することもできます。
Note: 特定のドライブからクエリするには、SupportsAllDrives 接続プロパティを'true' に設定する必要があります。
SELECT * FROM Videos WHERE DriveId = '0ACkq0ZiV0yJCUk9PVA'
Name | Type | Description |
Id [KEY] | String | ファイルのId。 |
Name | String | ファイル名。これはフォルダ内で必ずしもユニークである必要はありません。Team Dries のトップレベルフォルダ、My Drive ルートファイル、Application Data フォルダなどの不変のアイテムは名前が変わることはないので注意してください。 |
DriveId | String | ドライブのId。 |
Description | String | ファイルまたはフォルダの簡単な説明。 |
Extension | String | ファイルの拡張子。 |
CreatedTime | Datetime | ファイルまたはフォルダの作成日。 |
ModifiedTime | Datetime | ファイルまたはフォルダの最終変更日。 |
Size | Long | ファイルのサイズ(バイト)。 |
OwnerName | String | リソースオーナーの名前。 |
OwnerEmail | String | リソースオーナーのE メール |
Starred | Boolean | このフィールドは、リソースがスター付きかどうかを設定します。 |
Trashed | Boolean | このフィールドは、リソースがごみ箱に移動されているかどうかを設定します。 |
Viewed | Boolean | このフィールドは、リソースが現在のユーザーによって表示されたかどうかを設定します。 |
ParentIds | String | 親フォルダーIDのカンマ区切りリスト。 |
ChildIds | String | 子リソースIDのセミコロン区切りリスト。 |
ChildLinks | String | 子リソースリンクのセミコロン区切りリスト。 |
Query | String | このフィールドは、有効なGoogle ドライブSDK クエリを受け入れ、WHERE 句の条件をオーバーライドします。 |
ストアドプロシージャはファンクションライクなインターフェースで、Google Drive の単純なSELECT/INSERT/UPDATE/DELETE 処理にとどまらずCloud の機能を拡張します。
ストアドプロシージャは、パラメータのリストを受け取り、目的の機能を実行し、プロシージャが成功したか失敗したかを示すとともにGoogle Drive から関連するレスポンスデータを返します。
Name | Description |
CopyResource | Copies a resource from the user's Google Drive to a specified location. |
CreateFolder | ユーザーのGoogle Drive にフォルダを作成します。 |
DeleteResource | ユーザーのGoogle Drive からリソースを削除します。 |
EmptyTrash | Empties the user's trash. |
GetAuthenticatedUserInfo | Provides information about the authenticated user. |
MoveResource | Moves a resource to the specified list of parentIDs |
RevokeToken | Revoke access given to an application. |
StopWatchingResources | Stops receiving notifications for a particular channel before it expires. If successful, this method returns an empty response. |
SubscribeToFileChanges | Sets up a notification channel to start watching for changes to a single File resource. |
SubscribeToUserChanges | Sets up a notification channel to start watching for all Changes resources. |
UpdateResource | ユーザーのGoogle Drive のリソースを更新します。 |
Copies a resource from the user's Google Drive to a specified location.
Name | Type | Description |
Id | String | The Id of the resource to be copied. |
NewName | String | The NewName parameter defines the name of the copied file. |
ParentIDs | String | The ParentIds parameter should be a comma-separated list of existing folder Ids to use as parents for the copied file. If left blank, the copied file will inherit the same parents of the original. |
IgnoreDefaultVisibility | Boolean | Whether to ignore the domain's default visibility settings for the created file. Domain administrators can choose to make all uploaded files visible to the domain by default; this parameter bypasses that behavior for the request. Permissions are still inherited from parent folders.
デフォルト値はfalseです。 |
IncludeLabels | String | A comma-separated list of IDs of labels to include in the labelInfo part of the response |
IncludePermissionsForView | String | Specifies which additional view's permissions to include in the response. Only 'published' is supported. |
KeepRevisionForever | Boolean | Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions.
デフォルト値はfalseです。 |
OCRLanguage | String | A language hint for OCR processing during image import (ISO 639-1 code). |
SupportsAllDrives | Boolean | Whether the requesting application supports both My Drives and shared drives.
デフォルト値はfalseです。 |
Name | Type | Description |
CopiedFileID | String | The id of the copied file |
Success | String | This value shows a boolean indication of whether the operation was successful or not. |
ユーザーのGoogle Drive にフォルダを作成します。
Name | Type | Description |
Name | String | フォルダのタイトル。 |
Description | String | フォルダの説明。 |
Starred | Boolean | このパラメータはリソースに星がつくかどうかを定義します。
デフォルト値はFALSEです。 |
ParentIds | String | 新しいフォルダの親フォルダのカンマ区切りのId。 |
Name | Type | Description |
Success | String | このパラメータは、操作が成功したかどうかを設定します。 |
Id | String | フォルダのId。 |
ユーザーのGoogle Drive からリソースを削除します。
Name | Type | Description |
Id | String | 削除するリソースのId。 |
Name | Type | Description |
Success | String | この値は、操作が成功したかどうかをboolean で示します。 |
Empties the user's trash.
Name | Type | Description |
Success | String | This parameter sets whether the operation was successful or not. |
Provides information about the authenticated user.
Name | Type | Description |
Emails | String | Email list of the authenticated user. |
Name | String | The name of the authenticated user. |
PhotoUrl | String | The profile picture of the authenticated user. |
Moves a resource to the specified list of parentIDs
Name | Type | Description |
Id | String | The Id of the resource to be deleted. |
ParentIDs | String | A comma separated list of IDs to be used as parents. Note that resources within a shared drive must always have exactly one parent, and that only shared drive members with the 'file organizer' or 'organizer' roles can move files and folders within a shared drive. |
Name | Type | Description |
Success | String | This value shows a boolean indication of whether the operation was successful or not. |
Revoke access given to an application.
Name | Type | Description |
TokenToRevoke | String | The token to revoke. The token can be an access token or a refresh token. If the token is an access token and it has a corresponding refresh token, the refresh token will also be revoked. Set this to 'thisToken' to revoke the current access token. |
Name | Type | Description |
Success | String | This value shows whether the operation was successful. |
Stops receiving notifications for a particular channel before it expires. If successful, this method returns an empty response.
Name | Type | Description |
Id | String | A required property string that uniquely identifies this new notification channel within your project. |
ResourceId | String | A required opaque ID that identifies the resource being watched on this channel. |
Address | String | An optional property string set to the URL that listens and responds to notifications for this notification channel. This is your Webhook callback URL, and it must use HTTPS. |
ChannelToken | String | An optional token property that specifies an arbitrary string value to use as a channel token. |
Expiration | String | An optional property string set to a Unix timestamp (in ms) of the date and time when you want the Drive API to stop sending messages for this notification channel. |
ResourceURI | String | An optional version-specific identifier for the watched resource. |
Payload | Boolean | An optional boolean value to indicate whether payload is wanted. |
AdditionalParameters | Object | An optional json object used for specifying additional parameters that controll delivery channel behavior. Example : { |
Sets up a notification channel to start watching for changes to a single File resource.
Name | Type | Description |
FileId | String | Required. The file id to subscribe changes to. |
SupportsAllDrives | Boolean | Whether the requesting application supports both My Drives and shared drives.
デフォルト値はfalseです。 |
Id | String | A required property string that uniquely identifies this new notification channel within your project. |
Address | String | A required property string set to the URL that listens and responds to notifications for this notification channel. |
ChannelToken | String | An optional token property that specifies an arbitrary string value to use as a channel token. |
Expiration | String | An optional property string set to a Unix timestamp (in ms) of the date and time when you want the Drive API to stop sending messages for this notification channel. |
ResourceId | String | An optional opaque ID that identifies the resource being watched on this channel. |
ResourceURI | String | An optional version-specific identifier for the watched resource. |
Payload | Boolean | An optional boolean value to indicate whether payload is wanted. |
AdditionalParameters | Object | Optional. A json object used for specifying additional parameters that controll delivery channel behavior. Example : { |
Name | Type | Description |
Kind | String | The id for the file which was uploaded or updated. |
Id | String | ID you specified for this channel. |
ResourceId | String | ID of the watched resource. |
ResourceUri | String | Version-specific ID of the watched resource. |
Token | String | Present only if one was provided. |
Expiration | String | Actual expiration time as Unix timestamp (in ms), if applicable. |
Sets up a notification channel to start watching for all Changes resources.
Name | Type | Description |
Id | String | Requried. A property string that uniquely identifies this new notification channel within your project. |
Address | String | Requried. A property string set to the URL that listens and responds to notifications for this notification channel. |
ChannelToken | String | A token property that specifies an arbitrary string value to use as a channel token. |
Expiration | String | A property string set to a Unix timestamp (in ms) of the date and time when you want the Drive API to stop sending messages for this notification channel. |
ResourceId | String | An opaque ID that identifies the resource being watched on this channel. |
ResourceURI | String | A version-specific identifier for the watched resource. |
Payload | Boolean | An optional boolean value to indicate whether payload is wanted. |
AdditionalParameters | Object | Optional. A json object used for specifying additional parameters that controll delivery channel behavior. Example : { |
Name | Type | Description |
Kind | String | The id for the file which was uploaded or updated. |
Id | String | ID you specified for this channel. |
ResourceId | String | ID of the watched resource. |
ResourceUri | String | Version-specific ID of the watched resource. |
Token | String | Present only if one was provided. |
Expiration | String | Actual expiration time as Unix timestamp (in ms), if applicable. |
ユーザーのGoogle Drive のリソースを更新します。
Name | Type | Description |
Id | String | 更新するリソースのId。 |
Name | String | NewName パラメータが更新ファイルの名前を定義します。 |
Description | String | ファイルまたはフォルダの簡単な説明。 |
MIMEType | String | ファイルのMIME タイプ。 |
Starred | String | このフィールドはリソースに星を付けるかどうかを定義します。 |
LocalFile | String | アップロードされるファイルのファイル名を含むローカルファイルパス。FileData が指定されていない場合、このフィールドには値が必要です。 |
FileData | String | LocalFile インプットが空白の場合、ファイルデータはEncoding インプットで指定されたフォーマットでアウトプットされます。 |
Encoding | String | FileData インプットエンコーディングタイプ。ファイルの挿入および通信にのみ使われます。
使用できる値は次のとおりです。NONE, BASE64 デフォルト値はBASE64です。 |
CopyRequiresWriterPermission | Boolean | このファイルをコピー、印刷、ダウンロードするオプションを、閲覧者と閲覧者(コメント可)に対して無効化するかどうか。
デフォルト値はFALSEです。 |
Name | Type | Description |
Success | String | この値は、操作が成功したかどうかをboolean で示します。 |
このセクションで説明されているシステムテーブルをクエリして、スキーマ情報、データソース機能に関する情報、およびバッチ操作の統計にアクセスできます。
以下のテーブルは、Google Drive のデータベースメタデータを返します。
以下のテーブルは、データソースへの接続方法およびクエリ方法についての情報を返します。
次のテーブルは、データ変更クエリのクエリ統計を返します。
利用可能なデータベースをリストします。
次のクエリは、接続文字列で決定されるすべてのデータベースを取得します。
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 | テーブルが更新可能かどうか。 |
利用可能なテーブルおよびビューのカラムについて説明します。
次のクエリは、Files テーブルのカラムとデータ型を返します。
SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Files'
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 などのプロシージャのタイプ。 |
ストアドプロシージャパラメータについて説明します。
次のクエリは、UploadFile ストアドプロシージャのすべての入力パラメータについての情報を返します。
SELECT * FROM sys_procedureparameters WHERE ProcedureName='UploadFile' 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 | パラメータのインデックス。 |
主キーおよび外部キーについて説明します。
次のクエリは、Files テーブルの主キーを取得します。
SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Files'
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 | インデックスのカラムのシーケンスナンバー。 |
利用可能な接続プロパティと、接続文字列に設定されている接続プロパティに関する情報を返します。
次のクエリは、接続文字列に設定されている、あるいはデフォルト値で設定されているすべての接続プロパティを取得します。
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、またはバッチ内の更新が失敗した場合のエラーメッセージ。 |
利用可能なシステム情報を説明します。
次のクエリは、すべてのカラムを取得します。
SELECT * FROM sys_information
Name | Type | Description |
Product | String | 製品名。 |
Version | String | 製品のバージョン番号。 |
Datasource | String | 製品が接続するデータソースの名前。 |
NodeId | String | 製品がインストールされているマシンの固有識別子。 |
HelpURL | String | 製品のヘルプドキュメントのURL。 |
License | String | 製品のライセンス情報。(この情報が利用できない場合、この項目は空白のままか「N/A」と表示されます。) |
Location | String | 製品のライブラリが格納されているファイルパスの場所。 |
Environment | String | 製品が現在稼働している環境またはランタイムのバージョン。 |
DataSyncVersion | String | 本コネクタを使用するために必要なCData Sync のティア。 |
DataSyncCategory | String | CData Sync 機能のカテゴリ(例:Source、Destination)。 |
プロパティ | 説明 |
AuthScheme | Google Drive に接続する際に使用する認証の種類。 |
プロパティ | 説明 |
OAuthClientId | カスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。(コンシューマーキーとも呼ばれます。)このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。 |
OAuthClientSecret | カスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。( コンシューマーシークレット とも呼ばれます。)このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。 |
DelegatedServiceAccounts | 委任されたリクエストのためのサービスアカウントE メールのスペース区切りのリスト。 |
RequestingServiceAccount | 委任されたリクエストを行うためのサービスアカウントのE メール。 |
プロパティ | 説明 |
OAuthJWTCert | JWT 証明書のストア。 |
OAuthJWTCertType | JWT 証明書を格納するキーストアの種類。 |
OAuthJWTCertPassword | OAuth JWT 証明書のパスワード。パスワードを必要とする証明書ストアにアクセスするために使用されます。証明書ストアがパスワードを必要としない場合は、このプロパティを空白のままにします。 |
OAuthJWTCertSubject | OAuth JWT 証明書のサブジェクトで、ストアで一致する証明書を検索するために使用されます。部分一致と、先頭の証明書を選択するためのワイルドカード '*' をサポートします。 |
OAuthJWTIssuer | Java Web Token の発行者。 |
OAuthJWTSubject | アプリケーションからデリゲートアクセスの要求対象となるユーザーサブジェクト。 |
プロパティ | 説明 |
SSLServerCert | TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。 |
プロパティ | 説明 |
Verbosity | ログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。 |
プロパティ | 説明 |
BrowsableSchemas | レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
プロパティ | 説明 |
AWSWorkloadIdentityConfig | AWS 経由でWorkload Identity Federation を使用する場合に指定する設定プロパティ。 |
MaxRows | 集計やGROUP BY を使用しないクエリで返される最大行数を指定します。 |
PseudoColumns | テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。 |
SupportsAllDrives | すべてのドライブのサポートを有効にするかどうかを決定します。 |
Timeout | provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。 |
WorkloadPoolId | Workload Identity Federation プールのID。 |
WorkloadProjectId | Workload Identity Federation プールをホストするGoogle Cloud プロジェクトのID。 |
WorkloadProviderId | Workload Identity Federation プールプロバイダーのID。 |
このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。
プロパティ | 説明 |
AuthScheme | Google Drive に接続する際に使用する認証の種類。 |
Google Drive に接続する際に使用する認証の種類。
string
"OAuth"
このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。
プロパティ | 説明 |
OAuthClientId | カスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。(コンシューマーキーとも呼ばれます。)このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。 |
OAuthClientSecret | カスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。( コンシューマーシークレット とも呼ばれます。)このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。 |
DelegatedServiceAccounts | 委任されたリクエストのためのサービスアカウントE メールのスペース区切りのリスト。 |
RequestingServiceAccount | 委任されたリクエストを行うためのサービスアカウントのE メール。 |
カスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。(コンシューマーキーとも呼ばれます。)このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。
string
""
OAuthClientId は、ユーザーがOAuth 経由で認証を行う前に設定する必要があるいくつかの接続パラメータの1つです。詳細は接続の確立を参照してください。
カスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。( コンシューマーシークレット とも呼ばれます。)このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。
string
""
OAuthClientSecret は、ユーザーがOAuth 経由で認証を行う前に設定する必要があるいくつかの接続パラメータの1つです。詳細は接続の確立を参照してください。
委任されたリクエストのためのサービスアカウントE メールのスペース区切りのリスト。
string
""
サービスアカウントE メールは、スペース区切りのリストで指定する必要があります。
各サービスアカウントは、チェーン内の次のサービスアカウントのroles/iam.serviceAccountTokenCreator ロールを付与されている必要があります。
チェーンの最後のサービスアカウントは、リクエストするサービスアカウントのroles/iam.serviceAccountTokenCreator ロールが付与されている必要があります。 リクエストするサービスアカウントはRequestingServiceAccount プロパティで指定されたものです。
委任されたリクエストの場合、リクエストするサービスアカウントは、iam.serviceAccounts.getAccessToken 権限を持つ必要があることに注意してください。これは、serviceAccountTokenCreator ロールを介して付与することもできます。
委任されたリクエストを行うためのサービスアカウントのE メール。
string
""
委任されたリクエストで認証情報が要求されたアカウントのサービスアカウントのE メール。DelegatedServiceAccounts の委任されたサービスアカウントのリストを用いて、このプロパティは、委任されたリクエストを行うために使用されます。
このサービスアカウントには、IAM 権限iam.serviceAccounts.getAccessToken が必要です。
このセクションでは、本プロバイダーの接続文字列で設定可能なJWT OAuth プロパティの全リストを提供します。
プロパティ | 説明 |
OAuthJWTCert | JWT 証明書のストア。 |
OAuthJWTCertType | JWT 証明書を格納するキーストアの種類。 |
OAuthJWTCertPassword | OAuth JWT 証明書のパスワード。パスワードを必要とする証明書ストアにアクセスするために使用されます。証明書ストアがパスワードを必要としない場合は、このプロパティを空白のままにします。 |
OAuthJWTCertSubject | OAuth JWT 証明書のサブジェクトで、ストアで一致する証明書を検索するために使用されます。部分一致と、先頭の証明書を選択するためのワイルドカード '*' をサポートします。 |
OAuthJWTIssuer | Java Web Token の発行者。 |
OAuthJWTSubject | アプリケーションからデリゲートアクセスの要求対象となるユーザーサブジェクト。 |
JWT 証明書のストア。
string
""
クライアント証明書のための証明書ストア名。
OAuthJWTCertType フィールドは、OAuthJWTCert により指定された証明書ストアの種類を指定します。 ストアがパスワードで保護されている場合は、OAuthJWTCertPassword でパスワードを指定します。
OAuthJWTCert は、OAuthJWTCertSubject フィールドとともにクライアント証明書を指定するために使われます。 OAuthJWTCert に値がある場合で、OAuthJWTCertSubject が設定されている場合は、証明書の検索が始まります。 詳しくは、OAuthJWTCertSubject フィールドを参照してください。
証明書ストアの指定はプラットフォームに依存します。
Windows の共通のユーザとシステム証明書ストアの指定は以下のとおりです。
MY | 個人証明書と関連付けられた秘密キーを格納している証明書ストア。 |
CA | 証明機関の証明書。 |
ROOT | ルート証明書。 |
SPC | ソフトウェア発行元証明書。 |
Javaでは、証明書ストアは通常、証明書および任意の秘密キーを含むファイルです。
証明書ストアの種類がPFXFile の場合は、このプロパティにファイル名を設定します。 PFXBlob の場合は、このプロパティをPFX ファイルのバイナリコンテンツ(例えば、PKCS12証明書ストア)に設定する必要があります。
JWT 証明書を格納するキーストアの種類。
string
"GOOGLEJSONBLOB"
このプロパティには次の値の一つを設定できます。
USER | Windows の場合、現在のユーザーにより所有された証明書ストアであることを指定します。 Note:この種類はJava では利用できません。 |
MACHINE | Windows の場合、この証明書ストアがシステムストアであることを指定します。 Note:この種類はJava では利用できません。 |
PFXFILE | この証明書ストアは、証明書を含むPFX(PKCS12)ファイルの名前です。 |
PFXBLOB | この証明書ストアは、PFX(PKCS12)形式の証明書ストアを表すBase-64でエンコードされた文字列です。 |
JKSFILE | この証明書ストアは、証明書を含むJava key store(JKS)ファイルの名前です。 Note:この種類はJava のみで利用できます。 |
JKSBLOB | この証明書ストアは、Java key store(JKS)形式の証明書ストアを表すBase-64でエンコードされた文字列です。 Note:この種類はJava のみで利用できます。 |
PEMKEY_FILE | この証明書ストアは、秘密キーと任意の証明書を含むPEM でエンコードされたファイルの名前です。 |
PEMKEY_BLOB | この証明書ストアは、秘密キーと任意の証明書を含むBase-64でエンコードされた文字列です。 |
PUBLIC_KEY_FILE | この証明書ストアは、PEM またはDER でエンコードされた公開キーの証明書を含むファイルの名前です。 |
PUBLIC_KEY_BLOB | この証明書ストアは、PEM またはDER でエンコードされた公開キーの証明書を含むBase-64でエンコードされた文字列です。 |
SSHPUBLIC_KEY_FILE | この証明書ストアは、SSH 公開キーを含むファイルの名前です。 |
SSHPUBLIC_KEY_BLOB | この証明書ストアは、SSH 公開キーを含むBase-64でエンコードされた文字列です。 |
P7BFILE | この証明書ストアは、証明書を含むPKCS7 ファイルの名前です。 |
PPKFILE | この証明書ストアは、PuTTY 秘密キー(PPK)を含むファイルの名前です。 |
XMLFILE | この証明書ストアは、XML 形式の証明書を含むファイルの名前です。 |
XMLBLOB | この証明書ストアは、XML 形式の証明書を含む文字列の名前です。 |
BCFKSFILE | この証明書ストアは、Bouncy Castle キーストアを含むファイルの名前です。 |
BCFKSBLOB | この証明書ストアは、Bouncy Castle キーストアを含む文字列(Base-64エンコード)です。 |
GOOGLEJSON | この証明書ストアは、サービスアカウント情報を含むJSON ファイルの名前です。Google サービスに接続する場合にのみ有効です。 |
GOOGLEJSONBLOB | この証明書ストアは、サービスアカウントのJSON を含む文字列です。Google サービスに接続する場合にのみ有効です。 |
OAuth JWT 証明書のパスワード。パスワードを必要とする証明書ストアにアクセスするために使用されます。証明書ストアがパスワードを必要としない場合は、このプロパティを空白のままにします。
string
""
このプロパティは、証明書ストアを開くために必要なパスワードを指定します。ただし、ストアの種類がパスワードを必要とする場合に限ります。 パスワードが必要かどうかを判断するには、ご利用の証明書ストアのドキュメントまたは設定を参照してください。
GOOGLEJSON OAuthJWTCertType を使用する場合は必要ありません。Google JSON キーは暗号化されていません。
OAuth JWT 証明書のサブジェクトで、ストアで一致する証明書を検索するために使用されます。部分一致と、先頭の証明書を選択するためのワイルドカード '*' をサポートします。
string
"*"
このプロパティの値は、ストアで一致する証明書を検索するために使用されます。検索プロセスは以下のように動作します。
値を '*' に設定すると、ストアの先頭の証明書が自動的に選択されます。 証明書のサブジェクトは識別名フィールドおよび値のカンマ区切りのリストです。 例:CN=www.server.com, OU=test, C=US, [email protected]。一般的なフィールドには以下のものが含まれます。
フィールド | 説明 |
CN | 共通名。一般的には、www.server.com のようなホスト名です。 |
O | 法人名 |
OU | 法人の部署名 |
L | 法人の住所(市町村名) |
S | 法人の住所(都道府県) |
C | 国名 |
E | E メールアドレス |
フィールド値にカンマが含まれる場合は、引用符で囲んでください。例:"O=ACME, Inc."。
Java Web Token の発行者。
string
""
Java Web Token の発行者。 サービスアカウントのE メールアドレスの値を入力します。
GOOGLEJSON OAuthJWTCertType を使用する場合は必要ありません。Google JSON キーには、発行者アカウントのコピーが含まれています。
アプリケーションからデリゲートアクセスの要求対象となるユーザーサブジェクト。
string
""
アプリケーションからデリゲートアクセスの要求対象となるユーザーサブジェクトです。 アプリケーションが委任されたアクセスをリクエストするユーザーのE メールアドレスを入力します。
このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。
プロパティ | 説明 |
SSLServerCert | TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。 |
TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。
string
""
TLS/SSL 接続を使用する場合は、このプロパティを使用して、サーバーが受け入れるTLS/SSL 証明書を指定できます。コンピュータによって信頼されていない他の証明書はすべて拒否されます。
このプロパティは、次のフォームを取ります:
説明 | 例 |
フルPEM 証明書(例では省略されています) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
証明書を保有するローカルファイルへのパス。 | C:\cert.cer |
公開鍵(例では省略されています) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
MD5 Thumbprint (hex 値はスペースおよびコロン区切り) | ecadbdda5a1529c58a1e9e09828d70e4 |
SHA1 Thumbprint (hex 値はスペースおよびコロン区切り) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
これを指定しない場合は、マシンが信用するすべての証明書が受け入れられます。
すべての証明書の受け入れを示すには、'*'を使用します。セキュリティ上の理由から、これはお勧めできません。
このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。
プロパティ | 説明 |
Verbosity | ログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。 |
ログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。
string
"1"
このプロパティは、Cloud がログファイルに含める詳細レベルを定義します。 Verbosity レベルを高くするとログに記録される情報の詳細が増えますが、ログファイルが大きくなり取り込まれるデータが増えるためパフォーマンスが低下する可能性があります。
デフォルトのVerbosity レベルは1で、通常の運用にはこれが推奨されます。 より高いVerbosity レベルは主にデバッグを目的としています。 各レベルの詳細については、ログ を参照してください。
LogModules プロパティと組み合わせることで、Verbosity は特定の情報カテゴリに対するログの詳細度を調整できます。
このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。
プロパティ | 説明 |
BrowsableSchemas | レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
string
""
利用可能なデータベーススキーマをすべてリストすると余分な時間がかかり、パフォーマンスが低下します。 接続文字列にスキーマのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。
このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。
プロパティ | 説明 |
AWSWorkloadIdentityConfig | AWS 経由でWorkload Identity Federation を使用する場合に指定する設定プロパティ。 |
MaxRows | 集計やGROUP BY を使用しないクエリで返される最大行数を指定します。 |
PseudoColumns | テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。 |
SupportsAllDrives | すべてのドライブのサポートを有効にするかどうかを決定します。 |
Timeout | provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。 |
WorkloadPoolId | Workload Identity Federation プールのID。 |
WorkloadProjectId | Workload Identity Federation プールをホストするGoogle Cloud プロジェクトのID。 |
WorkloadProviderId | Workload Identity Federation プールプロバイダーのID。 |
AWS 経由でWorkload Identity Federation を使用する場合に指定する設定プロパティ。
string
""
このプロパティは、Key=Value プロパティのセミコロン区切りリストとしてフォーマットされ、値はオプションで引用符で囲むこともできます。
例えば、この設定はユーザーのルートキーを使用してAWS で認証します:
AWSWorkloadIdentityConfig="AuhtScheme=AwsRootKeys;AccessKey='AKIAABCDEF123456';SecretKey=...;Region=us-east-1"
集計やGROUP BY を使用しないクエリで返される最大行数を指定します。
int
-1
このプロパティは、集計やGROUP BY 句を含まないクエリに対してCloud が返す行数の上限を設定します。 この制限により、クエリがデフォルトで過度に大きな結果セットを返さないようにします。
クエリにLIMIT 句が含まれている場合、クエリで指定された値がMaxRows 設定よりも優先されます。 MaxRows が"-1" に設定されている場合、LIMIT 句が明示的にクエリに含まれていない限り、行の制限は行われません。
このプロパティは、非常に大きなデータセットを返す可能性のあるクエリを実行する際に、パフォーマンスを最適化し過剰なリソース消費を防ぐのに役立ちます。
テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。
string
""
このプロパティを使用すると、Cloud がテーブルカラムとして公開する擬似カラムを定義できます。
個々の擬似カラムを指定するには、以下の形式を使用します。"Table1=Column1;Table1=Column2;Table2=Column3"
すべてのテーブルのすべての擬似カラムを含めるには、次のようにします:"*=*"
すべてのドライブのサポートを有効にするかどうかを決定します。
bool
false
このプロパティを'true' に設定すると、DriveId をフィルタとして使用して特定のドライブからクエリを実行できます。
provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。
int
60
このプロパティは、Cloud が操作をキャンセルする前に操作の完了を待機する最大時間を秒単位で制御します。 操作の完了前にタイムアウト時間が経過すると、Cloud は操作をキャンセルして例外をスローします。
タイムアウトは、クエリや操作全体ではなくサーバーとの個々の通信に適用されます。 例えば、各ページング呼び出しがタイムアウト制限内に完了する場合、クエリは60秒を超えて実行を続けることができます。
このプロパティを0に設定するとタイムアウトが無効になり、操作が成功するか、サーバー側のタイムアウト、ネットワークの中断、またはサーバーのリソース制限などの他の条件で失敗するまで無期限に実行されます。 このプロパティは慎重に使用してください。長時間実行される操作がパフォーマンスを低下させたり、応答しなくなる可能性があるためです。
Workload Identity Federation プールのID。
string
""
Workload Identity Federation プールのID。
Workload Identity Federation プールをホストするGoogle Cloud プロジェクトのID。
string
""
Workload Identity Federation プールをホストするGoogle Cloud プロジェクトのID。
Workload Identity Federation プールプロバイダーのID。
string
""
Workload Identity Federation プールプロバイダーのID。