Cloud

Build 25.0.9434
  • Google Contacts
    • はじめに
      • 接続の確立
      • カスタムOAuth アプリの作成
      • SSL の設定
      • ファイアウォールとプロキシ
    • データモデル
      • テーブル
        • ContactGroups
        • Contacts
      • ビュー
        • ContactOrganizations
        • GroupMembers
        • OtherContacts
        • PeopleConnections
      • ストアドプロシージャ
        • CopyOtherContactsToMyContacts
        • ModifyContactGroupMembers
        • UpdateOrDeleteContactPhoto
      • システムテーブル
        • sys_catalogs
        • sys_schemas
        • sys_tables
        • sys_tablecolumns
        • sys_procedures
        • sys_procedureparameters
        • sys_keycolumns
        • sys_foreignkeys
        • sys_primarykeys
        • sys_indexes
        • sys_connection_props
        • sys_sqlinfo
        • sys_identity
        • sys_information
    • 接続文字列オプション
      • Authentication
        • AuthScheme
      • OAuth
        • OAuthClientId
        • OAuthClientSecret
        • DelegatedServiceAccounts
        • RequestingServiceAccount
        • Scope
      • JWT OAuth
        • OAuthJWTCert
        • OAuthJWTCertType
        • OAuthJWTCertPassword
        • OAuthJWTCertSubject
        • OAuthJWTIssuer
        • OAuthJWTSubject
      • SSL
        • SSLServerCert
      • Logging
        • Verbosity
      • Schema
        • BrowsableSchemas
      • Miscellaneous
        • AWSWorkloadIdentityConfig
        • AzureWorkloadIdentityConfig
        • MaxRows
        • PseudoColumns
        • Timeout
        • WorkloadPoolId
        • WorkloadProjectId
        • WorkloadProviderId
    • Third Party Copyrights

Google Contacts - CData Cloud

概要

CData Cloud は、クラウドホスト型のソリューションで、複数の標準サービスやプロトコルにまたがるGoogleContacts へのアクセスを実現します。SQL Server データベースに接続できるアプリケーションであれば、CData Cloud を介してGoogleContacts に接続できます。

CData Cloud により、他のOData エンドポイントや標準SQL Server と同じように、GoogleContacts への接続を標準化し、構成することができます。

主要機能

  • SQL をフルサポート:GoogleContacts は、標準のリレーショナルデータベースとして表示され、Filter、Group、Join などの操作を実行できます。これらの操作は基盤となるAPI でサポートされているかどうかに関わらず、標準SQL を使用します。
  • CRUD サポート:読み取りと書き込みの両方の操作がサポートされており、Cloud またはデータソースのダウンストリームで設定できるセキュリティ設定によってのみ制限されます。
  • セキュアアクセス:管理者は、ユーザーを作成し、特定のデータベースへのアクセス、読み取り専用操作、または完全な読み書きの権限を定義することができます。
  • 包括的なデータモデルとダイナミックディスカバリー:CData Cloud は、動的データや検索可能なメタデータへのフルアクセスなど、基盤となるデータソースで公開されるすべてのデータへの包括的なアクセスを提供します。

CData Cloud

はじめに

このページでは、CData Cloud でのGoogleContacts への接続の確立 のガイド、利用可能なリソースに関する情報、および使用可能な接続プロパティのリファレンスについて説明します。

GoogleContacts への接続

接続の確立 は、CData Cloud にデータベースを作成するためのGoogleContacts への認証方法と必要な接続プロパティの設定方法について示します。

CData Cloud サービスからデータにアクセス

利用可能な標準サービスを経由してGoogleContacts からデータにアクセスする方法と、CData Cloud の管理については、CData Cloud ドキュメント で詳しく説明します。

CData Cloud

接続の確立

Database タブで対応するアイコンを選択して、GoogleContacts に接続します。必須プロパティはSettings にリストされています。Advanced タブには、通常は必要ない接続プロパティが表示されます。

GoogleContacts への接続

各ユーザーやドメインの代わりに、Cloud がGoogle API にアクセスすることを許可します。

Google API への接続には、OAuth 認証標準を使用します。

GoogleContacts への認証

Cloud は、認証にユーザーアカウントおよびGCP インスタンスアカウントの使用をサポートします。

以下のセクションでは、GoogleContacts の利用可能な認証スキームについて説明します。

  • ユーザーアカウント(OAuth)
  • サービスアカウント(OAuthJWT)
  • GCP インスタンスアカウント

ユーザーアカウント(OAuth)

AuthScheme は、すべてのユーザーアカウントフローでOAuth に設定する必要があります。

Web アプリケーション

Web アプリケーション経由で接続する場合は、GoogleContacts にカスタムOAuth アプリケーションを作成および登録する必要があります。それからCloud を使用してOAuth トークンの値を取得および管理します。カスタムアプリケーションについて詳しくは、カスタムOAuth アプリの作成 を参照してください。

OAuth アクセストークンの取得

次の接続プロパティを設定し、OAuthAccessToken を取得します。

  • OAuthClientId:アプリケーション設定のクライアントId に設定。
  • OAuthClientSecret:アプリケーション設定のクライアントシークレットに設定。

続いてストアドプロシージャを呼び出し、OAuth 交換を完了します。

  1. GetOAuthAuthorizationURL ストアドプロシージャを呼び出します。CallbackURL インプットをアプリケーション設定で指定したコールバックURL に設定します。ストアドプロシージャがOAuth エンドポイントのURL を返します。
  2. ステップ1でストアドプロシージャが返したURL に移動します。カスタムOAuth アプリケーションにログインして、Web アプリケーションを認可します。認証されると、ブラウザはコールバックURL にリダイレクトします。
  3. GetOAuthAccessToken ストアドプロシージャを呼び出します。AuthMode をWEB に、Verifier インプットをコールバックURL のクエリ文字列の"code" パラメータに設定します。

アクセストークンとリフレッシュトークンを取得すると、データに接続し、OAuth アクセストークンを自動または手動でリフレッシュすることができるようになります。

OAuth アクセストークンの自動リフレッシュ

ドライバーがOAuth アクセストークンを自動的にリフレッシュするようにするには、最初のデータ接続で次のように設定します。

  • InitiateOAuth:REFRESH に設定。
  • OAuthClientId:アプリケーション設定のクライアントId に設定。
  • OAuthClientSecret:アプリケーション設定のクライアントシークレットに設定。
  • OAuthAccessToken:GetOAuthAccessToken によって返されたアクセストークンに設定。
  • OAuthRefreshToken:GetOAuthAccessToken によって返されたリフレッシュトークンに設定。
  • OAuthSettingsLocation:Cloud がOAuth トークン値を保存する場所に設定。これは接続間で維持されます。
次回のデータ接続では、OAuthAccessToken およびOAuthRefreshToken の値は、OAuthSettingsLocation から取得されます。

OAuth アクセストークンの手動リフレッシュ

データ接続時に手動でOAuth アクセストークンをリフレッシュするために必要な値は、OAuth リフレッシュトークンのみです。

GetOAuthAccessToken によって返されたExpiresIn パラメータ値が経過した後に、RefreshOAuthAccessToken ストアドプロシージャを使用し、手動でOAuthAccessToken をリフレッシュします。次の接続プロパティを設定します。

  • OAuthClientId:アプリケーション設定のクライアントId に設定。
  • OAuthClientSecret:アプリケーション設定のクライアントシークレットに設定。

次に、RefreshOAuthAccessToken を呼び出し、OAuthRefreshToken にGetOAuthAccessToken によって返されたOAuth リフレッシュトークンを指定します。新しいトークンが取得できたら、OAuthAccessToken プロパティにRefreshOAuthAccessToken によって返された値を設定し、新しい接続をオープンします。

最後に、OAuth リフレッシュトークンを保存し、OAuth アクセストークンの有効期限が切れた後に手動でリフレッシュできるようにします。

ヘッドレスマシン

ヘッドレスマシンのユーザーアカウントでOAuth を使用するようにドライバーを設定するには、インターネットブラウザに対応した別の端末で認証する必要があります。

  1. 以下のオプションから選択します。
    • オプション1:後述の「Verifier code を取得および交換」に従い、OAuthVerifier 値を取得します。
    • オプション2:インターネットブラウザに対応したマシンにCloud をインストールし、後述の「OAuth 設定を転送」の説明に従い、通常のブラウザベースのフローで認証後にOAuth 認証値を転送します。
  2. 次に、ヘッドレスマシンからアクセストークンを自動的にリフレッシュするようにCloud を設定します。

オプション1:Verifier code を取得および交換

Verifier code を取得するには、OAuth Authorization URL で認証する必要があります。

インターネットブラウザに対応したマシンから認証してOAuthVerifier 接続プロパティを取得する方法は次のとおりです。

  1. 以下のオプションから選択します。
    • 埋め込みOAuth アプリケーションを使用する場合は、GoogleContacts OAuth endpoint をクリックし、ブラウザでエンドポイントを開きます。
    • カスタムOAuth アプリケーションを使用するには、以下のプロパティを設定し、認証URL を作成します。
      • InitiateOAuth:OFF に設定。
      • OAuthClientId:アプリケーションの登録時に割り当てられたクライアントId に設定。
      • OAuthClientSecret:アプリケーションの登録時に割り当てられたクライアントシークレットに設定。
      次に、適切なCallbackURL を指定してGetOAuthAuthorizationURL ストアドプロシージャを呼び出します。ストアドプロシージャによって返されたURL をブラウザで開きます。
  2. ログインして、Cloud にアクセス許可を与えます。すると、verifier code を含むコールバックURL にリダイレクトされます。
  3. verifier code の値を保存します。後ほどこれをOAuthVerifier 接続プロパティに設定します。
次に、OAuth verifier code をOAuth リフレッシュトークンおよびアクセストークンと交換する必要があります。次のプロパティを設定します。

ヘッドレスマシンでは、次の接続プロパティを設定してOAuth 認証値を取得します。

  • InitiateOAuth:REFRESH に設定。
  • OAuthVerifier:verifier code に設定。
  • OAuthClientId:(カスタムアプリのみ)カスタムOAuth アプリケーション設定のクライアントId に設定。
  • OAuthClientSecret:(カスタムアプリのみ)カスタムOAuth アプリケーション設定のクライアントシークレットに設定。
  • OAuthSettingsLocation:これを設定すると、暗号化されたOAuth 認証値が指定された場所に永続化されます。

OAuth 設定ファイルが生成されたら、以下のように接続プロパティをリセットする必要があります。

  • InitiateOAuth:REFRESH に設定。
  • OAuthClientId:(カスタムアプリのみ)アプリケーションの登録時に割り当てられたクライアントId に設定。
  • OAuthClientSecret:(カスタムアプリのみ)アプリケーションの登録時に割り当てられたクライアントシークレットに設定。
  • OAuthSettingsLocation:暗号化されたOAuth 認証値を含む場所に設定。アクセストークンの自動リフレッシュを有効にするために、この場所がCloud に読み書きのアクセス許可を与えることを確認してください。

オプション2:OAuth 設定を転送

ヘッドレスマシンでの接続に先立ち、インターネットブラウザに対応したデバイスでドライバとの接続を作成し、インストールする必要があります。上述の「デスクトップアプリケーション」の説明に従って、接続プロパティを設定します。

「デスクトップアプリケーション」の手順が完了すると、生成された認証値は、OAuthSettingsLocation で指定された場所に暗号化されて書き込まれます。デフォルトのファイル名はOAuthSettings.txt です。

接続が正常にテストされたら、OAuth 設定ファイルをヘッドレスマシンにコピーします。

ヘッドレスマシンで、次の接続プロパティを設定し、データに接続します。

  • InitiateOAuth:REFRESH に設定。
  • OAuthClientId:(カスタムアプリのみ)アプリケーションの登録時に割り当てられたクライアントId に設定。
  • OAuthClientSecret:(カスタムアプリのみ)アプリケーションの登録時に割り当てられたクライアントシークレットに設定。
  • OAuthSettingsLocation:OAuth 設定ファイルの場所に設定。アクセストークンの自動リフレッシュを有効にするために、この場所がCloud に読み書きのアクセス許可を与えることを確認してください。

GCP インスタンスアカウント

GCP 仮想マシン上で実行している場合は、Cloud は仮想マシンに関連付けられたサービスアカウントを使用して認証できます。 このモードを使用するには、AuthScheme をGCPInstanceAccount に設定します。

CData Cloud

カスタムOAuth アプリの作成

カスタムOAuth アプリケーションの作成

CData はOAuth アプリケーション認証情報を製品に組み込んでおり、デスクトップアプリケーションまたはヘッドレスマシン経由でGoogleContacts に接続する際に使用できます。

(OAuthAccessToken およびその他の設定パラメータを取得および設定する方法についての情報は、「GoogleContacts への接続」の デスクトップ認証セクションを参照してください。)

ただし、Web 経由で接続するには、カスタムOAuth アプリケーションの作成が必要です。また、カスタムOAuth アプリケーションは、一般的に使用される3つの認証フローをすべてシームレスにサポートするため、これらの認証フロー用にカスタムOAuth アプリケーションを作成(独自のOAuth アプリケーションクレデンシャルを使用)することもできます。

カスタムOAuth アプリケーションは、次のような場合に有用です。

  • 認証ダイアログのブランディングをコントロールしたいとき
  • ユーザー認証後にアプリケーションがユーザーをリダイレクトするためのリダイレクトURI をコントロールしたいとき
  • ユーザーからのリクエストに対する許可をカスタマイズしたいとき

以下のセクションでは、Directory API を有効化し、ユーザーアカウント(OAuth)およびサービスアカウント(OAuth / JWT)用のカスタムOAuth アプリケーションを作成する方法について説明します。

People API を有効化

次の手順に従いPeople API を有効化します。

  1. Google Cloud Console に移動します。
  2. 左側のナビゲーションメニューからライブラリを選択します。API ライブラリページが開きます。
  3. 検索ボックスに、「People API」を入力し、検索結果からPeople API を選択します。
  4. People API ページで、有効にするをクリックします。

OAuth アプリケーションの作成

カスタムOAuth アプリケーションを作成して必要なOAuth 接続プロパティを取得するには、以下の手順に従ってください。

ユーザーアカウント(OAuth)

AuthScheme がOAuth であり、Web アプリケーション上で認証する必要があるユーザーの場合は、必ずカスタムOAuth アプリケーションを作成する必要があります。 (デスクトップおよびヘッドレスフローでのカスタムOAuth アプリケーションの作成は任意です。)

以下の手順に従います。

  1. Google Cloud コンソールに移動します。
  2. 新しいプロジェクトを作成するか、既存のプロジェクトを選択します。
  3. 左側のナビゲーションメニューで、認証情報を選択します。
  4. このプロジェクトに同意画面がまだ設定されていない場合は、同意画面を設定 をクリックして作成します。Google Workspace アカウントを使用しない場合、User Type が外部の同意画面の作成に制限され、ユーザーサポートメールとデベロッパーの連絡先情報を指定する必要があります。 追加情報は任意です。
  5. 認証情報ページで認証情報を作成 -> OAuth クライアントID を選択します。
  6. アプリケーションの種類メニューでウェブアプリケーションを選択します。
  7. カスタムOAuth アプリケーションの名前を指定します。
  8. 承認済みのリダイレクトURI の下にあるURI を追加をクリックし、リダイレクトURI を入力します。
  9. Enter をクリックし、続けて作成をクリックします。Cloud コンソールは認証情報ページに戻ります。
    ウィンドウが開き、クライアントId とクライアントシークレットが表示されます。
  10. 後でOAuthClientId とOAuthClientSecret として使用するために、クライアントId とクライアントシークレットを記録しておきます。

Note: クライアントシークレットはGoogle Cloud コンソールからアクセス可能です。

サービスアカウント(OAuthJWT)

サービスアカウント(AuthScheme OAuthJWT)をOAuth フローで使用することで、ドメイン内のユーザーの代わりにGoogle API にアクセスすることができます。 ドメイン管理者はドメイン全体のアクセスをサービスアカウントに委任することができます。

新しいサービスアカウントを作成するには:

  1. Google Cloud コンソールに移動します。
  2. 新しいプロジェクトを作成するか、既存のプロジェクトを選択します。
  3. 左側のナビゲーションメニューで、認証情報を選択します。
  4. 認証情報を作成 -> サービスアカウントを選択します。
  5. サービスアカウントの作成ページで、サービスアカウント名、ID、およびオプションの説明を入力します。
  6. 完了をクリックします。Cloud コンソールは認証情報ページを再表示します。
  7. サービスアカウントセクションで、作成したサービスアカウントを選択します。
  8. 詳細設定セクションをクリックし、ドメイン全体の委任を有効にします。
  9. メイン全体の委任用に表示されるクライアントID を記録します。これは管理コンソールで使用します。
  10. 新しいタブで、Google Admin コンソールに移動します。
  11. セキュリティ -> API の制御 -> ドメイン全体の委任に移動します。
  12. ドメイン全体の委任を管理をクリックし、次に新しく追加をクリックします。
  13. 記録したクライアントID と必要なスコープのリストを入力します。詳しくは、OAuth スコープとエンドポイント を参照してください。
  14. Cloud コンソールに戻り、サービスアカウントのキータブを選択します。
  15. 鍵を追加 -> 新しい鍵を作成 をクリックします。
  16. サポートされているキータイプを選択します(OAuthJWTCert およびOAuthJWTCertType を参照)。
  17. 作成をクリックします。キーは自動的にデバイスにダウンロードされます。
  18. 後で使用するために追加情報を記録します。

サービスアカウントフローでは、Cloud はJSON Web Token(JWT)をOAuthAccessToken と交換します。 上記の手順でダウンロードした秘密鍵は、JWT に署名するために使用されます。 Cloud は、ドメイン全体の委任を通じて設定されたスコープを含む、サービスアカウントに付与された権限を継承します。

CData Cloud

SSL の設定

SSL 設定のカスタマイズ

デフォルトでは、Cloud はサーバーとのTLS のネゴシエーションを試みます。サーバー証明書は、デフォルトのシステム信頼済み証明書ストアで検証されます。SSLServerCert 接続プロパティを使用して、証明書の検証方法をオーバーライドできます。

別の証明書を指定するには、SSLServerCert 接続プロパティを参照してください。

CData Cloud

ファイアウォールとプロキシ

Firewall またはProxy 経由の接続

HTTP プロキシ

HTTP プロキシへの認証には、以下のように設定します。

  • ProxyServer:HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。
  • ProxyPort:プロキシサーバーが起動しているTCP ポート。
  • ProxyAuthScheme:プロキシサーバーに対して認証する際にCloud が使用する認証方法。
  • ProxyUser:プロキシサーバーに登録されているユーザーアカウントのユーザー名。
  • ProxyPassword:ProxyUser に紐付けられたパスワード。

その他のプロキシ

次のプロパティを設定します。

  • プロキシベースのファイヤーウォールを使用するには、FirewallType、FirewallServer、およびFirewallPort を設定します。
  • 接続をトンネルするには、FirewallType をTUNNEL に設定します。
  • 認証するには、FirewallUser とFirewallPassword を設定します。
  • SOCKS プロキシへの認証には、さらにFirewallType をSOCKS5 に設定します。

CData Cloud

データモデル

概要

このセクションでは、利用可能なAPI オブジェクトを示し、GoogleContacts API へのSQL の実行について詳しく説明します。

主要機能

  • Cloud はドキュメント、フォルダ、およびグループなどのGoogleContacts エンティティをリレーショナルビューとしてモデル化し、SQL を記述してGoogleContacts データをクエリできるようにします。
  • ストアドプロシージャを使用するとGoogleContacts の操作を実行できます。
  • これらのオブジェクトへのライブ接続により、Cloud を使用するとGoogleContacts アカウントへのあらゆる変更が即座に反映されます。
  • INSERT は、ContactGroups テーブル、My Contacts テーブル、およびStarred テーブルをサポートします。後者の2つは動的に生成されるため、このドキュメントの対象にはならないことに注意してください。

テーブル

Cloud はGoogleContacts API をリレーショナルテーブル としてモデル化します。

ビュー

ビュー は、GoogleContacts のいくつかの追加的なメタデータ情報を提供します。

ストアドプロシージャ

ストアドプロシージャ は、GoogleContacts のファンクションライクなインターフェースです。ストアドプロシージャを使用すると、オブジェクトのダウンロードやエンベロープの移動など、GoogleContacts の操作を実行できます。

CData Cloud

テーブル

Cloud はGoogleContacts のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。

CData Cloud - Google Contacts テーブル

Name Description
ContactGroups Create, update, delete and query Contact Groups.
Contacts Set the name of this table to any of your ContactGroups(GroupName) to create, update, delete, and query Google contacts.

CData Cloud

ContactGroups

Create, update, delete and query Contact Groups.

テーブル固有の情報

Select

ContactGroups テーブルはWHERE 句でId およびMemberCount カラムをサポートしています。サポートされている演算子はId は '=, in'、MemberCount は'=' です。 次に例を示します。

SELECT * FROM [ContactGroups] WHERE Id = 'myContacts'

SELECT * FROM [ContactGroups] WHERE Id = '45a15a878be3580a'

SELECT * FROM [ContactGroups] WHERE Id = '4fe7dbbd0d26cc95' AND MemberCount = 10

INSERT

新しいContactGroup の作成には、Name が必要です。ClientData カラムにデータを挿入することもできます。

INSERT INTO [ContactGroups] (Name) VALUES ('Contacts Group Test')

ContactGroup のClientData を挿入するには、#TEMP テーブルを使用するか、JSON 構造を作成して挿入する値を指定します。

INSERT INTO ClientData#TEMP (ClientDataKey, ClientDataValue) VALUES ('Client Data 1', 'sfsdfsds45rf')
INSERT INTO ClientData#TEMP (ClientDataKey, ClientDataValue) VALUES ('Client Data 2', '2jfk24g78w2jbdk')
INSERT INTO ContactGroups (Name, ClientData) VALUES ('Insert ClientData to a Contact Group 2', 'ClientData#TEMP')

INSERT INTO ContactGroups (Name, ClientData) VALUES ('Testing Insert ClientData in Contact Group via client data columns', '[{"key": "Client Data 1","value": "sdfjkbq36"},{"key": "Client Data 2","value": "df32jkbk"}]')

Update

ContactGroups 行のName、ClientData を更新することが可能です(My Contacts、Coworkers、およびFriends などのシステムグループ(GroupType As SYSTEM_CONTACT_GROUP)を除く)。

UPDATE [ContactGroups] SET Name = 'Salsa Friends' WHERE Id = '674ddb258de3ef81'

Delete

ContactGroup の削除には、Id が必要です。

DELETE FROM [ContactGroups] WHERE Id = '674ddb258de3ef81'

Columns

Name Type ReadOnly Description
Id [KEY] String True

The Id of the contact group.

ResourceName String True

The ResourceName of the contact group.

ETag String True

The HTTP entity tag of the resource.

Name String False

The name of the contact group.

GroupType String True

The contact group type.

FormattedName String True

The group name formatted in the viewer's account locale.

MemberCount Integer True

The total number of contacts in the group irrespective of max members in specified in the request.

MemberResourceNames String True

The list of contact person resource names that are members of the contact group.

MetadataUpdatedTime Datetime True

The metadata of the contact group.

MetadataDeleted Boolean True

The metadata of the contact group.

ClientData String False

The group's client data.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
ClientDataKey String

The client specified key of the client data.

ClientDataValue String

The client specified value of the client data.

MaxMembers String

Specifies the maximum number of members to return. Defaults to 0 if not set, which will return zero members.

CData Cloud

Contacts

Set the name of this table to any of your ContactGroups(GroupName) to create, update, delete, and query Google contacts.

Select

Contact テーブルはWHERE 句でId をサポートしています。Id でサポートされている演算子は'=, IN' です。 例:

SELECT * FROM [My Contacts] WHERE Id = '567931ee88efc109'

SELECT * FROM [My Contacts] WHERE Id IN ('567931ee88efc109', '79733d1ee88efc109')

SELECT * FROM [My Contacts] WHERE SearchTerms = 'Yash' 

Insert

Contacts テーブルには、read-only でない限り、どの項目でも挿入が可能です。セミコロンで区切られたいくつかの特定のフィールドに複数の値を追加できます。

INSERT INTO [My Contacts] (GivenName, FamilyName, HomeEmailAddresses, WorkEmailAddresses, WorkPhoneNumbers, HomePhoneNumbers, HomeAddresses) VALUES ('Elizabeth', 'Bennet', '[email protected]', '[email protected]', '(206)555-1212', '(206)555-1213', '1600 Amphitheatre Pkwy Mountain View')

連絡先に組織の詳細を挿入するには、#TEMP テーブルを使用して組織のフィールドを挿入します。組織のフィールドはContactOrganaizations ビューに表示されます。 例:

INSERT INTO ContactOrganizations#TEMP (Current, Department, Domain, JobDescrption, Location, Name, StartDate) VALUES (true, 'Engineering', 'QA', 'Big Data Engineer', 'Bangalore', 'Tech Mahindra', '2021-03-01')
INSERT INTO ContactOrganizations#TEMP (Current, Department, Domain, JobDescrption, Location, Name, StartDate, EndDate) VALUES (false, 'Engineering', 'QA', 'Software Consultant', 'Bangalore', 'CData', '2019-05-23', '2020-02-17')
INSERT INTO [My Contacts] (GivenName, Organizations) VALUES ('Karan', 'ContactOrganizations#TEMP')

複数の連絡先を一度に挿入するには、#TEMP テーブルを使用して挿入します。 例:

INSERT INTO MyContacts#TEMP (GivenName, FamilyName, HomeAddresses) VALUES ('Ankit', 'Singh', 'Bangalore India; Indore India')
INSERT INTO MyContacts#TEMP (GivenName, MiddleName, HomeAddresses) VALUES ('Aman', '', 'Bangalore India; Indore India')
INSERT INTO [My Contacts] (GivenName, HomeAddresses) SELECT GivenName, HomeAddresses FROM MyContacts#TEMP

Update

Contacts テーブルには、read-only でない限り、どの項目でも更新が可能です。セミコロンで区切られたいくつかの特定のフィールドに複数の値を追加できます。

UPDATE [My Contacts] SET GivenName = 'Elizabeth', FamilyName = 'Bennet', MobilePhoneNumbers = '+355696969999;+355676555001' WHERE Id = '48b8b9158b1db34d'

UPDATE [My Contacts] SET HomeAddresses = 'Electronic City Bangalore India; Brilliant Solitaire Indore India' WHERE Id = 'c6545017396039868174'

複数の連絡先の詳細を一度に更新するには、#TEMP テーブルを使用します。 例:

INSERT INTO MyContacts#TEMP (Id, GivenName, HomeAddresses) VALUES ('c9197613024342508599', 'Ankit', 'Bangalore India; Indore India')
INSERT INTO MyContacts#TEMP (Id, GivenName, HomeAddresses) VALUES ('c2042847992816525584', 'Aman', 'Bangalore India; Indore India')
UPDATE [My Contacts] (Id, GivenName, HomeAddresses) SELECT Id, GivenName, HomeAddresses FROM MyContacts#TEMP

Delete

連絡先の削除には、Id が必要です。

DELETE FROM [My Contacts] WHERE Id = '567931ee88efc109'

複数の連絡先を一度に削除するには、#TEMP テーブルを使用します。 例:

INSERT INTO MyContacts#TEMP (Id) VALUES ('c9197613024342508599')
INSERT INTO MyContacts#TEMP (Id) VALUES ('c2042847992816525584')
DELETE FROM [My Contacts] WHERE EXISTS SELECT Id FROM MyContacts#TEMP

Columns

Name Type ReadOnly Description
Id [KEY] String True

The Id of the contact.

ResourceName String True

The ResourceName of the contact.

Etag String True

The ETag of the resource. (Note that the quotation marks are part of the ETag.)

NamePrefix String True

The honorific prefixes, such as Mrs. or Dr.

FullName String True

The display name formatted according to the locale specified by the viewer's account

GivenName String False

The given name of the contact.

MiddleName String False

The middle name of the contact.

FamilyName String False

The family name of the contact.

NameSuffix String False

The honorific suffixes, such as Jr.

PhoneticNamePrefix String True

The Phonetic honorific prefixes, such as Mrs. or Dr.

PhoneticFullName String False

The Phonetic display name formatted according to the locale specified by the viewer's account.

PhoneticGivenName String False

The Phonetic given name of the contact.

PhoneticMiddleName String False

The Phonetic middle name of the contact.

PhoneticFamilyName String False

The Phonetic family name of the contact.

PhoneticNameSuffix String False

The Phonetic honorific suffixes, such as Jr.

NickNames String False

The nickname of the contact.

Birthday Date False

The birthday of the contact. The format of the date is yyyy-mm-dd.

GenderAddressMeAs String False

The type of pronoun that should be used to address the contact.

Gender String False

The gender for the contact.

Photos String True

The contact's photo.

UnlabeledEmailAddresses String False

The unlabeled email addresses of the contact. Multiple email addresses should be separated by semi-colon.

HomeEmailAddresses String False

The home email addresses of the contact. Multiple email addresses should be separated by semi-colon.

WorkEmailAddresses String False

The work email addresses of the contact. Multiple email addresses should be separated by semi-colon.

OtherEmailAddresses String False

The other email addresses of the contact. Multiple email addresses should be separated by semi-colon.

CustomEmailAddressTypes String False

The custom type of the email address. This attribute should be used along with CustomEmailAddresses. Multiple custom types should be separated by semi-colon.

CustomEmailAddresses String False

The custom value of the email address. This attribute should be used along with CustomEmailAddressTypes. Multiple custom emailAddresses should be separated by semi-colon.

UnlabeledPhoneNumbers String False

The unlabeled phone numbers of the contacts. Multiple phone numbers should be separated by semi-colon.

HomePhoneNumbers String False

The home phone numbers of the contacts. Multiple phone numbers should be separated by semi-colon.

WorkPhoneNumbers String False

The work phone numbers of the contacts. Multiple phone numbers should be separated by semi-colon.

MobilePhoneNumbers String False

The mobile phone numbers of the contacts. Multiple phone numbers should be separated by semi-colon.

OtherPhoneNumbers String False

The homeFax phone numbers of the contacts. Multiple phone numbers should be separated by semi-colon.

HomeFaxes String False

The workFax phone numbers of the contacts. Multiple phone numbers should be separated by semi-colon.

WorkFaxes String False

The otherFax phone numbers of the contacts. Multiple phone numbers should be separated by semi-colon.

OtherFaxes String False

The pager phone numbers of the contacts. Multiple phone numbers should be separated by semi-colon.

Pagers String False

The workMobile phone numbers of the contacts. Multiple phone numbers should be separated by semi-colon.

WorkMobilePhoneNumbers String False

The workPager phone numbers of the contacts. Multiple phone numbers should be separated by semi-colon.

WorkPagers String False

The main phone numbers of the contacts. Multiple phone numbers should be separated by semi-colon.

MainPhoneNumbers String False

The googleVoice phone numbers of the contacts. Multiple phone numbers should be separated by semi-colon.

GoogleVoicePhoneNumbers String False

The other phone numbers of the contacts. Multiple phone numbers should be separated by semi-colon.

CustomPhoneNumberTypes String False

The custom type of the phone number. This attribute should be used along with CustomPhoneNumbers. Multiple custom types should be separated by semi-colon.

CustomPhoneNumbers String False

The custom value of the phone number. This attribute should be used along with CustomPhoneNumberTypes. Multiple custom phone numbers should be separated by semi-colon.

UnlabeledAddresses String False

The unlabeled addresses of the contact. Multiple addresses should be separated by semi-colon.

HomeAddresses String False

The home addresses of the contact. Multiple addresses should be separated by semi-colon.

WorkAddresses String False

The work addresses of the contact. Multiple addresses should be separated by semi-colon.

OtherAddresses String False

The other addresses of the contact. Multiple addresses should be separated by semi-colon.

CustomAddressTypes String False

The custom type of the address. This attribute should be used along with CustomAddresses. Multiple custom types should be separated by semi-colon.

CustomAddresses String False

The custom value of the address. This attribute should be used along with CustomAddressTypes. Multiple custom emailAddresses should be separated by semi-colon.

AgeRanges String True

An age range of a contact.

Biography String False

The short biography of the contact.

BiographyContentType String False

The content type of the biography of the contact.

HomeCalendarUrls String True

The home calendar urls of the contact. Multiple calendar urls should be separated by semi-colon.

FreeBusyCalendarUrls String True

The freeBusy calendar urls of the contact. Multiple calendar urls should be separated by semi-colon.

WorkCalendarUrls String True

The work calendar urls of the contact. Multiple calendar urls should be separated by semi-colon.

CustomCalendarUrlTypes String True

The custom type of the address. This attribute should be used along with CustomCalendarUrls. Multiple custom types should be separated by semi-colon.

CustomCalendarUrls String True

The custom value of the address. This attribute should be used along with CustomCalendarUrlTypes. Multiple custom calendar urls should be separated by semi-colon.

ClientData String False

The group's client data.

CoverPhotos String True

A contact's cover photo.

UnlabeledEvents String False

The dates of unlabeled events. Multiple dates should be separated by semi-colon.

AnniversaryEvents String False

The dates of anniversary events. Multiple dates should be separated by semi-colon.

OtherEvents String False

The dates of other events. Multiple dates should be separated by semi-colon.

CustomEventTypes String False

The custom type of an event. Multiple types should be separated by semi-colon.

CustomEvents String False

The custom value of an event. Multiple custom event dates should be separated by semi-colon.

AccountExternalIds String False

The account externalIds of the contact. Multiple externalIds should be separated by semi-colon.

CustomerExternalIds String False

The customer externalIds of the contact. Multiple externalIds should be separated by semi-colon.

LoginIdExternalIds String False

The loginId externalIds of the contact. Multiple externalIds should be separated by semi-colon.

NetworkExternalIds String False

The network externalIds of the contact. Multiple externalIds should be separated by semi-colon.

OrganizationExternalIds String False

The organization externalIds of the contact. Multiple externalIds should be separated by semi-colon.

CustomExternalIdTypes String False

The custom type of the externalId. This attribute should be used along with CustomExternalIds. Multiple types should be separated by semi-colon.

CustomExternalIds String False

The custom value of the externalId. This attribute should be used along with CustomExternalIdTypes. Multiple externalIds should be separated by semi-colon.

FileAses String True

The name that should be used to sort the contact in a list.

ImClientsProtocols String True

The semi-colon separated list of ImClients Protocols. Multiple protocols should be separated by semi-colon.

ImClientsUsernames String True

The semi-colon separated list of ImClients Usernames. Multiple usernames should be separated by semi-colon.

Interests String False

The contact's interests.

Locales String False

The contact's locales.

DeskLocations String False

The desk locations of the contact. Multiple locations should be separated by semi-colon.

GrewUpLocations String False

The grewUp locations of the contact. Multiple locations should be separated by semi-colon.

CustomLocationTypes String False

The custom types of the location. The attribute should be used along with CustomLocations. Multiple locations should be separated by semi-colon.

CustomLocations String False

The custom value of the location. The attribute should be used along with CustomLocationsTypes. Multiple locations should be separated by semi-colon.

Memberships String True

The resource name for the contact group, assigned by the server. Only contactGroupResourceName can be used for modifying memberships. Any contact group membership can be removed, but only user group or 'myContacts' or 'starred' system groups memberships can be added. A contact must always have at least one contact group membership.

MiscKeywordTypes String False

The miscellaneous keyword types. Multiple types should be separated by semi-colon. Allowed Values are : TYPE_UNSPECIFIED, OUTLOOK_BILLING_INFORMATION, OUTLOOK_DIRECTORY_SERVER, OUTLOOK_KEYWORD, OUTLOOK_MILEAGE, OUTLOOK_PRIORITY, OUTLOOK_SENSITIVITY, OUTLOOK_SUBJECT, OUTLOOK_USER, HOME, WORK, OTHER

使用できる値は次のとおりです。TYPE_UNSPECIFIED, OUTLOOK_BILLING_INFORMATION, OUTLOOK_DIRECTORY_SERVER, OUTLOOK_KEYWORD, OUTLOOK_MILEAGE, OUTLOOK_PRIORITY, OUTLOOK_SENSITIVITY, OUTLOOK_SUBJECT, OUTLOOK_USER, HOME, WORK, OTHER

MiscKeywordValues String False

The miscellaneous keywords. Multiple miscellaneous keywords should be separated by semi-colon.

Occupations String False

The contact's occupations

Organizations String False

The organizations of the contact.

RelationshipTypes String True

The contact's relation to the other person. This attribute should be used along with RelationValues. Multiple types should be separated by semi-colon.

RelationshipValues String True

The name of the other person this relation refers to. This attribute should be used along with RelationTypes. Multiple names should be separated by semi-colon.

UnlabeledSipAddresses String False

The dates of anniversary events. Multiple dates should be separated by semi-colon.

HomeSipAddresses String False

The home sipAddresses of the contact. Multiple sipAddresses should be separated by semi-colon.

WorkSipAddresses String False

The work sipAddresses of the contact. Multiple sipAddresses should be separated by semi-colon.

MobileSipAddresses String False

The mobile sipAddresses of the contact. Multiple sipAddresses should be separated by semi-colon.

OtherSipAddresses String False

The other sipAddresses of the contact. Multiple sipAddresses should be separated by semi-colon.

CustomSipAddressTypes String False

The custom type of the sipAddress. This attribute should be used along with CustomSipAddresses. Multiple types should be separated by semi-colon.

CustomSipAddresses String False

The custom value of the sipAddress. This attribute should be used along with CustomSipAddressTypes. Multiple sipAddresses should be separated by semi-colon.

Skills String True

The skills that the contact has.

UnlabeledUrls String False

The unlabeled website urls of the contact. Multiple urls should be separated by semi-colon.

HomeUrls String False

The home website urls of the contact. Multiple urls should be separated by semi-colon.

WorkUrls String False

The work website urls of the contact. Multiple urls should be separated by semi-colon.

BlogUrls String False

The blog website urls of the contact. Multiple urls should be separated by semi-colon.

ProfileUrls String False

The profile website urls of the contact. Multiple urls should be separated by semi-colon.

HomePageUrls String False

The homePage website urls of the contact. Multiple urls should be separated by semi-colon.

FtpUrls String False

The ftp website urls of the contact. Multiple urls should be separated by semi-colon.

ReservationsUrls String False

The reservations website urls of the contact. Multiple urls should be separated by semi-colon.

OtherUrls String False

The appInstall Page website urls of the contact. Multiple urls should be separated by semi-colon.

AppInstallPageUrls String False

The other website urls of the contact. Multiple urls should be separated by semi-colon.

CustomUrlTypes String False

The custom type of the website url. This attribute values should be used along with CustomUrls. Multiple urls should be separated by semi-colon.

CustomUrls String False

The custom value of the website url. This attribute values should be used along with CustomUrlTypes. Multiple urls should be separated by semi-colon.

UnlabeledCountry String True

The unlabeled country of the contact. Multiple addresses should be separated by semi-colon.

UnlabeledCity String True

The unlabeled city of the contact. Multiple addresses should be separated by semi-colon.

UnlabeledCountryCode String True

The unlabeled country code of the contact. Multiple addresses should be separated by semi-colon.

UnlabeledExtendedAddress String True

The unlabeled extended address of the contact. Multiple addresses should be separated by semi-colon.

UnlabeledPostalCode String True

The unlabeled postal code of the contact. Multiple addresses should be separated by semi-colon.

UnlabeledRegion String True

The unlabeled region of the contact. Multiple addresses should be separated by semi-colon.

UnlabeledStreetAddress String True

The unlabeled street address of the contact. Multiple addresses should be separated by semi-colon.

HomeCountry String True

The home country of the contact. Multiple addresses should be separated by semi-colon.

HomeCity String True

The home city of the contact. Multiple addresses should be separated by semi-colon.

HomeCountryCode String True

The home country code of the contact. Multiple addresses should be separated by semi-colon.

HomeExtendedAddress String True

The home extended address of the contact. Multiple addresses should be separated by semi-colon.

HomePostalCode String True

The home postal code of the contact. Multiple addresses should be separated by semi-colon.

HomeRegion String True

The home region of the contact. Multiple addresses should be separated by semi-colon.

HomeStreetAddress String True

The home street address of the contact. Multiple addresses should be separated by semi-colon.

WorkCountry String True

The work country of the contact. Multiple addresses should be separated by semi-colon.

WorkCity String True

The work city of the contact. Multiple addresses should be separated by semi-colon.

WorkCountryCode String True

The work country code of the contact. Multiple addresses should be separated by semi-colon.

WorkExtendedAddress String True

The work extended address of the contact. Multiple addresses should be separated by semi-colon.

WorkPostalCode String True

The work postal code of the contact. Multiple addresses should be separated by semi-colon.

WorkRegion String True

The work region of the contact. Multiple addresses should be separated by semi-colon.

WorkStreetAddress String True

The work street address of the contact. Multiple addresses should be separated by semi-colon.

OtherCountry String True

The other country of the contact. Multiple addresses should be separated by semi-colon.

OtherCity String True

The other city of the contact. Multiple addresses should be separated by semi-colon.

OtherCountryCode String True

The other country code of the contact. Multiple addresses should be separated by semi-colon.

OtherExtendedAddress String True

The other extended address of the contact. Multiple addresses should be separated by semi-colon.

OtherPostalCode String True

The other postal code of the contact. Multiple addresses should be separated by semi-colon.

OtherRegion String True

The other region of the contact. Multiple addresses should be separated by semi-colon.

OtherStreetAddress String True

The other street address of the contact. Multiple addresses should be separated by semi-colon.

CustomCountry String True

The custom country of the contact. Multiple addresses should be separated by semi-colon.

CustomCity String True

The custom city of the contact. Multiple addresses should be separated by semi-colon.

CustomCountryCode String True

The custom country code of the contact. Multiple addresses should be separated by semi-colon.

CustomExtendedAddress String True

The custom extended address of the contact. Multiple addresses should be separated by semi-colon.

CustomPostalCode String True

The custom postal code of the contact. Multiple addresses should be separated by semi-colon.

CustomRegion String True

The custom region of the contact. Multiple addresses should be separated by semi-colon.

CustomStreetAddress String True

The custom street address of the contact. Multiple addresses should be separated by semi-colon.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
SearchTerms String

The query matches on a contact's names, nickNames, emailAddresses, phoneNumbers, and organizations fields that are from the CONTACT source. Maximum 10 matching rows will be returned.

ClientDataKey String

The client specified key of the client data.

ClientDataValue String

The client specified value of the client data.

CData Cloud

ビュー

ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。

クエリは、ビューに対して通常のテーブルと同様に実行することができます。

CData Cloud - Google Contacts ビュー

Name Description
ContactOrganizations This view specifies all the details of the Contact's Organizations
GroupMembers Query contact group resource names
OtherContacts The view specifies all the details of Other Contacts
PeopleConnections This view specifies all the details of People Connections

CData Cloud

ContactOrganizations

This view specifies all the details of the Contact's Organizations

Select

ContactOrganizations ビューはWHERE 句でId カラムをサポートしています。Id でサポートされている演算子は'=, IN' です。 例:

SELECT * FROM [ContactOrganizations] WHERE Id = '567931ee88efc109'

SELECT * FROM [ContactOrganizations] WHERE Id IN ('567931ee88efc109', '79733d1ee88efc109')

Columns

Name Type Description
Id String The Id of the contact.
ResourceName String The resource name of the contact.
Current Boolean True if organization is the person's current organization
Department String The person's department at the organization.
Domain String The domain name associated with the organization
FormattedType String The type of the organization translated and formatted in the viewer's account locale
JobDescription String The person's job description at the organization.
Location String The location of the organization office the person works at.
Name String The name of the organization.
PhoneticName String The phonetic name of the organization.
StartDate Date The start date when the person joined the organization.
EndDate Date The end date when the person left the organization.
Symbol String The symbol associated with the organization.
Title String The contact's job title at the organization.
Type String The type of the organization.

CData Cloud

GroupMembers

Query contact group resource names

テーブル固有の情報

Select

GroupMembers ビューはWHERE 句でId およびMemberCount カラムをサポートしています。このビューにはId が必須です。 次に例を示します。

SELECT * FROM [GroupMembers] WHERE Id = '4fe7dbbd0d26cc95'

Columns

Name Type Description
Id String The Id of the contact group.
MemberCount Integer The total number of contacts in the group irrespective of max members in specified in the request.
ContactId String The list of contact person resource names that are members of the contact group.

CData Cloud

OtherContacts

The view specifies all the details of Other Contacts

テーブル固有の情報

Select

次に例を示します。
SELECT * FROM [OtherContacts] WHERE SearchTerms = 'Yash'

Columns

Name Type Description
Id [KEY] String The Id of the contact.
ResourceName String The ResourceName of the contact.
Etag String The ETag of the resource. (Note that the quotation marks are part of the ETag.)
NamePrefix String The honorific prefixes, such as Mrs. or Dr.
FullName String The display name formatted according to the locale specified by the viewer's account
GivenName String The given name of the contact.
MiddleName String The middle name of the contact.
FamilyName String The family name of the contact.
NameSuffix String The honorific suffixes, such as Jr.
PhoneticNamePrefix String The Phonetic honorific prefixes, such as Mrs. or Dr.
PhoneticFullName String The Phonetic display name formatted according to the locale specified by the viewer's account.
PhoneticGivenName String The Phonetic given name of the contact.
PhoneticMiddleName String The Phonetic middle name of the contact.
PhoneticFamilyName String The Phonetic family name of the contact.
PhoneticNameSuffix String The Phonetic honorific suffixes, such as Jr.
UnlabeledEmailAddresses String The unlabeled email addresses of the contact. Multiple email addresses should be separated by comma.
HomeEmailAddresses String The home email addresses of the contact. Multiple email addresses should be separated by comma.
WorkEmailAddresses String The work email addresses of the contact. Multiple email addresses should be separated by comma.
OtherEmailAddresses String The other email addresses of the contact. Multiple email addresses should be separated by comma.
CustomEmailAddressTypes String The custom type of the email address. This attribute should be used along with CustomEmailAddresses. Multiple custom types should be separated by comma.
CustomEmailAddresses String The custom value of the email address. This attribute should be used along with CustomEmailAddressTypes. Multiple custom emailAddresses should be separated by comma.
UnlabeledPhoneNumbers String The unlabeled phone numbers of the contacts. Multiple phone numbers should be separated by comma.
HomePhoneNumbers String The home phone numbers of the contacts. Multiple phone numbers should be separated by comma.
WorkPhoneNumbers String The work phone numbers of the contacts. Multiple phone numbers should be separated by comma.
MobilePhoneNumbers String The mobile phone numbers of the contacts. Multiple phone numbers should be separated by comma.
HomeFaxes String The homeFax phone numbers of the contacts. Multiple phone numbers should be separated by comma.
WorkFaxes String The workFax phone numbers of the contacts. Multiple phone numbers should be separated by comma.
OtherFaxes String The otherFax phone numbers of the contacts. Multiple phone numbers should be separated by comma.
Pagers String The pager phone numbers of the contacts. Multiple phone numbers should be separated by comma.
WorkMobilePhoneNumbers String The workMobile phone numbers of the contacts. Multiple phone numbers should be separated by comma.
WorkPagers String The workPager phone numbers of the contacts. Multiple phone numbers should be separated by comma.
MainPhoneNumbers String The main phone numbers of the contacts. Multiple phone numbers should be separated by comma.
GoogleVoicePhoneNumbers String The googleVoice phone numbers of the contacts. Multiple phone numbers should be separated by comma.
OtherPhoneNumbers String The other phone numbers of the contacts. Multiple phone numbers should be separated by comma.
CustomPhoneNumberTypes String The custom type of the phone number. This attribute should be used along with CustomPhoneNumbers. Multiple custom types should be separated by comma.
CustomPhoneNumbers String The custom value of the phone number. This attribute should be used along with CustomPhoneNumberTypes. Multiple custom phone numbers should be separated by comma.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
SearchTerms String The query matches on a contact's names, emailAddresses, and phoneNumbers fields that are from the OTHER_CONTACT source. Maximum 10 matching rows will be returned.

CData Cloud

PeopleConnections

This view specifies all the details of People Connections

Columns

Name Type Description
Id [KEY] String The Id of the contact.
ResourceName String The ResourceName of the contact.
Etag String The ETag of the resource. (Note that the quotation marks are part of the ETag.)
NamePrefix String The honorific prefixes, such as Mrs. or Dr.
FullName String The display name formatted according to the locale specified by the viewer's account
GivenName String The given name of the contact.
MiddleName String The middle name of the contact.
FamilyName String The family name of the contact.
NameSuffix String The honorific suffixes, such as Jr.
PhoneticNamePrefix String The Phonetic honorific prefixes, such as Mrs. or Dr.
PhoneticFullName String The Phonetic display name formatted according to the locale specified by the viewer's account.
PhoneticGivenName String The Phonetic given name of the contact.
PhoneticMiddleName String The Phonetic middle name of the contact.
PhoneticFamilyName String The Phonetic family name of the contact.
PhoneticNameSuffix String The Phonetic honorific suffixes, such as Jr.
NickNames String The nickname of the contact.
Birthday Date The birthday of the contact. The format of the date is yyyy-mm-dd.
GenderAddressMeAs String The type of pronoun that should be used to address the contact.
Gender String The gender for the contact.
Photos String The contact's photo.
UnlabeledEmailAddresses String The unlabeled email addresses of the contact. Multiple email addresses should be separated by semi-colon.
HomeEmailAddresses String The home email addresses of the contact. Multiple email addresses should be separated by semi-colon.
WorkEmailAddresses String The work email addresses of the contact. Multiple email addresses should be separated by semi-colon.
OtherEmailAddresses String The other email addresses of the contact. Multiple email addresses should be separated by semi-colon.
CustomEmailAddressTypes String The custom type of the email address. This attribute should be used along with CustomEmailAddresses. Multiple custom types should be separated by semi-colon.
CustomEmailAddresses String The custom value of the email address. This attribute should be used along with CustomEmailAddressTypes. Multiple custom emailAddresses should be separated by semi-colon.
UnlabeledPhoneNumbers String The unlabeled phone numbers of the contacts. Multiple phone numbers should be separated by semi-colon.
HomePhoneNumbers String The home phone numbers of the contacts. Multiple phone numbers should be separated by semi-colon.
WorkPhoneNumbers String The work phone numbers of the contacts. Multiple phone numbers should be separated by semi-colon.
MobilePhoneNumbers String The mobile phone numbers of the contacts. Multiple phone numbers should be separated by semi-colon.
OtherPhoneNumbers String The homeFax phone numbers of the contacts. Multiple phone numbers should be separated by semi-colon.
HomeFaxes String The workFax phone numbers of the contacts. Multiple phone numbers should be separated by semi-colon.
WorkFaxes String The otherFax phone numbers of the contacts. Multiple phone numbers should be separated by semi-colon.
OtherFaxes String The pager phone numbers of the contacts. Multiple phone numbers should be separated by semi-colon.
Pagers String The workMobile phone numbers of the contacts. Multiple phone numbers should be separated by semi-colon.
WorkMobilePhoneNumbers String The workPager phone numbers of the contacts. Multiple phone numbers should be separated by semi-colon.
WorkPagers String The main phone numbers of the contacts. Multiple phone numbers should be separated by semi-colon.
MainPhoneNumbers String The googleVoice phone numbers of the contacts. Multiple phone numbers should be separated by semi-colon.
GoogleVoicePhoneNumbers String The other phone numbers of the contacts. Multiple phone numbers should be separated by semi-colon.
CustomPhoneNumberTypes String The custom type of the phone number. This attribute should be used along with CustomPhoneNumbers. Multiple custom types should be separated by semi-colon.
CustomPhoneNumbers String The custom value of the phone number. This attribute should be used along with CustomPhoneNumberTypes. Multiple custom phone numbers should be separated by semi-colon.
UnlabeledAddresses String The unlabeled addresses of the contact. Multiple addresses should be separated by semi-colon.
HomeAddresses String The home addresses of the contact. Multiple addresses should be separated by semi-colon.
WorkAddresses String The work addresses of the contact. Multiple addresses should be separated by semi-colon.
OtherAddresses String The other addresses of the contact. Multiple addresses should be separated by semi-colon.
CustomAddressTypes String The custom type of the address. This attribute should be used along with CustomAddresses. Multiple custom types should be separated by semi-colon.
CustomAddresses String The custom value of the address. This attribute should be used along with CustomAddressTypes. Multiple custom emailAddresses should be separated by semi-colon.
AgeRanges String An age range of a contact.
Biography String The short biography of the contact.
BiographyContentType String The content type of the biography of the contact.
HomeCalendarUrls String The home calendar urls of the contact. Multiple calendar urls should be separated by semi-colon.
FreeBusyCalendarUrls String The freeBusy calendar urls of the contact. Multiple calendar urls should be separated by semi-colon.
WorkCalendarUrls String The work calendar urls of the contact. Multiple calendar urls should be separated by semi-colon.
CustomCalendarUrlTypes String The custom type of the address. This attribute should be used along with CustomCalendarUrls. Multiple custom types should be separated by semi-colon.
CustomCalendarUrls String The custom value of the address. This attribute should be used along with CustomCalendarUrlTypes. Multiple custom calendar urls should be separated by semi-colon.
ClientData String The group's client data.
CoverPhotos String A contact's cover photo.
UnlabeledEvents String The dates of unlabeled events. Multiple dates should be separated by semi-colon.
AnniversaryEvents String The dates of anniversary events. Multiple dates should be separated by semi-colon.
OtherEvents String The dates of other events. Multiple dates should be separated by semi-colon.
CustomEventTypes String The custom type of an event. Multiple types should be separated by semi-colon.
CustomEvents String The custom value of an event. Multiple custom event dates should be separated by semi-colon.
AccountExternalIds String The account externalIds of the contact. Multiple externalIds should be separated by semi-colon.
CustomerExternalIds String The customer externalIds of the contact. Multiple externalIds should be separated by semi-colon.
LoginIdExternalIds String The loginId externalIds of the contact. Multiple externalIds should be separated by semi-colon.
NetworkExternalIds String The network externalIds of the contact. Multiple externalIds should be separated by semi-colon.
OrganizationExternalIds String The organization externalIds of the contact. Multiple externalIds should be separated by semi-colon.
CustomExternalIdTypes String The custom type of the externalId. This attribute should be used along with CustomExternalIds. Multiple types should be separated by semi-colon.
CustomExternalIds String The custom value of the externalId. This attribute should be used along with CustomExternalIdTypes. Multiple externalIds should be separated by semi-colon.
FileAses String The name that should be used to sort the contact in a list.
ImClientsProtocols String The custom type of the imClient. This attribute should be used along with CustomImClients. Multiple custom types should be separated by semi-colon.
ImClientsUsernames String The custom value of the imClient. This attribute should be used along with CustomImClientTypes. Multiple custom imClients should be separated by semi-colon.
Interests String The contact's interests.
Locales String The contact's locales.
DeskLocations String The desk locations of the contact. Multiple locations should be separated by semi-colon.
GrewUpLocations String The grewUp locations of the contact. Multiple locations should be separated by semi-colon.
CustomLocationTypes String The custom types of the location. The attribute should be used along with CustomLocations. Multiple locations should be separated by semi-colon.
CustomLocations String The custom value of the location. The attribute should be used along with CustomLocationsTypes. Multiple locations should be separated by semi-colon.
Memberships String The resource name for the contact group, assigned by the server. Only contactGroupResourceName can be used for modifying memberships. Any contact group membership can be removed, but only user group or 'myContacts' or 'starred' system groups memberships can be added. A contact must always have at least one contact group membership.
MiscKeywordTypes String The miscellaneous keyword types. Multiple types should be separated by semi-colon. Allowed Values are : TYPE_UNSPECIFIED, OUTLOOK_BILLING_INFORMATION, OUTLOOK_DIRECTORY_SERVER, OUTLOOK_KEYWORD, OUTLOOK_MILEAGE, OUTLOOK_PRIORITY, OUTLOOK_SENSITIVITY, OUTLOOK_SUBJECT, OUTLOOK_USER, HOME, WORK, OTHER

使用できる値は次のとおりです。TYPE_UNSPECIFIED, OUTLOOK_BILLING_INFORMATION, OUTLOOK_DIRECTORY_SERVER, OUTLOOK_KEYWORD, OUTLOOK_MILEAGE, OUTLOOK_PRIORITY, OUTLOOK_SENSITIVITY, OUTLOOK_SUBJECT, OUTLOOK_USER, HOME, WORK, OTHER

MiscKeywordValues String The miscellaneous keywords. Multiple miscellaneous keywords should be separated by semi-colon.
Occupations String The contact's occupations
Organizations String The organizations of the contact.
RelationshipTypes String The contact's relation to the other person. This attribute should be used along with RelationValues. Multiple types should be separated by semi-colon.
RelationshipValues String The name of the other person this relation refers to. This attribute should be used along with RelationTypes. Multiple names should be separated by semi-colon.
UnlabeledSipAddresses String The unlabeled sipAddresses of the contact. Multiple sipAddresses should be separated by semi-colon.
HomeSipAddresses String The home sipAddresses of the contact. Multiple sipAddresses should be separated by semi-colon.
WorkSipAddresses String The work sipAddresses of the contact. Multiple sipAddresses should be separated by semi-colon.
MobileSipAddresses String The mobile sipAddresses of the contact. Multiple sipAddresses should be separated by semi-colon.
OtherSipAddresses String The other sipAddresses of the contact. Multiple sipAddresses should be separated by semi-colon.
CustomSipAddressTypes String The custom type of the sipAddress. This attribute should be used along with CustomSipAddresses. Multiple types should be separated by semi-colon.
CustomSipAddresses String The custom value of the sipAddress. This attribute should be used along with CustomSipAddressTypes. Multiple sipAddresses should be separated by semi-colon.
Skills String The skills that the contact has.
UnlabeledUrls String The unlabeled website urls of the contact. Multiple urls should be separated by semi-colon.
HomeUrls String The home website urls of the contact. Multiple urls should be separated by semi-colon.
WorkUrls String The work website urls of the contact. Multiple urls should be separated by semi-colon.
BlogUrls String The blog website urls of the contact. Multiple urls should be separated by semi-colon.
ProfileUrls String The profile website urls of the contact. Multiple urls should be separated by semi-colon.
HomePageUrls String The homePage website urls of the contact. Multiple urls should be separated by semi-colon.
FtpUrls String The ftp website urls of the contact. Multiple urls should be separated by semi-colon.
ReservationsUrls String The reservations website urls of the contact. Multiple urls should be separated by semi-colon.
OtherUrls String The appInstall Page website urls of the contact. Multiple urls should be separated by semi-colon.
AppInstallPageUrls String The other website urls of the contact. Multiple urls should be separated by semi-colon.
CustomUrlTypes String The custom type of the website url. This attribute values should be used along with CustomUrls. Multiple urls should be separated by semi-colon.
CustomUrls String The custom value of the website url. This attribute values should be used along with CustomUrlTypes. Multiple urls should be separated by semi-colon.

CData Cloud

ストアドプロシージャ

ストアドプロシージャはファンクションライクなインターフェースで、GoogleContacts の単純なSELECT/INSERT/UPDATE/DELETE 処理にとどまらずCloud の機能を拡張します。

ストアドプロシージャは、パラメータのリストを受け取り、目的の機能を実行し、プロシージャが成功したか失敗したかを示すとともにGoogleContacts から関連するレスポンスデータを返します。

CData Cloud - Google Contacts ストアドプロシージャ

Name Description
CopyOtherContactsToMyContacts Copies an 'Other contact' to a new contact in the user's 'myContacts' group
ModifyContactGroupMembers Modify the members of a contact group owned by the authenticated user.
UpdateOrDeleteContactPhoto Update or Delete a contact's photo.

CData Cloud

CopyOtherContactsToMyContacts

Copies an 'Other contact' to a new contact in the user's 'myContacts' group

ストアドプロシージャ固有の情報

その他の連絡先を連絡先にコピーするプロセス

GoogleContacts は、EXEC クエリでは、大きいカラムサブセットを扱うことを許可していません。これらのカラムは、通常= 比較でのみ使用できます。CopyOtherContactsToMyContacts で利用可能なカラムはId、FieldsToCopy、およびSources です。 次に例を示します。

EXECUTE CopyOtherContactsToMyContacts Id = 'c2583603548064626314', FieldsToCopy = 'emailAddresses, names, phoneNumbers', Sources = 'READ_SOURCE_TYPE_CONTACT'

Input

Name Type Required Description
Id String True The Id of the 'Other contact' to copy.
FieldsToCopy String True The fields to restrict which fields are copied into the new contact. Valid values are: emailAddresses,names,phoneNumbers
Sources String True A mask of what source types to return. Valid values are: READ_SOURCE_TYPE_UNSPECIFIED, READ_SOURCE_TYPE_PROFILE, READ_SOURCE_TYPE_CONTACT, READ_SOURCE_TYPE_DOMAIN_CONTACT

Result Set Columns

Name Type Description
Success String Returns True if contact group has been modified.

CData Cloud

ModifyContactGroupMembers

Modify the members of a contact group owned by the authenticated user.

ストアドプロシージャ固有の情報

連絡先グループメンバーを変更するプロセス

GoogleContacts は、EXEC クエリでは、大きいカラムサブセットを扱うことを許可していません。これらのカラムは、通常= 比較でのみ使用できます。ModifyContactGroupMembers で利用可能なカラムはId、ResourceIdsToAdd、およびResourceIdsToRemove です。

Note:メンバーを追加できるシステム連絡先グループは、contactGroups/myContacts とcontactGroups/starred のみです。その他のシステム連絡先グループは非推奨で、連絡先の削除のみ可能です。 次に例を示します。

EXECUTE ModifyContactGroupMembers Id = 'starred', ResourceIdsToAdd = 'c8493601355484697130, c8493601355484697130', ResourceIdsToRemove = ''

Input

Name Type Required Description
Id String True The Id of the contact group to modify.
ResourceIdsToAdd String False A comma separated list of ids of the contact people to add.
ResourceIdsToRemove String False A comma separated list of ids of the contact people to remove.

Result Set Columns

Name Type Description
Success String Returns True if contact group has been modified.

CData Cloud

UpdateOrDeleteContactPhoto

Update or Delete a contact's photo.

ストアドプロシージャ固有の情報

連絡先の写真を更新/削除するプロセス

GoogleContacts は、EXEC クエリでは、大きいカラムサブセットを扱うことを許可していません。これらのカラムは、通常= 比較でのみ使用できます。UpdateOrDeleteContactPhoto で利用可能なカラムはId、Action、FileSource、およびUrl です。

Note:Id カラムが必須です。Action 属性は実行する操作を定義します。Action でサポートされている操作は'UPDATE、Delete' です。連絡先の写真を更新するには、FileSource またはURL のいずれかを指定する必要があります。 次に例を示します。

EXECUTE UpdateOrDeleteContactPhoto Id = 'c2845916184580148264', Action = 'Update', FileSource = 'D:\GooglePeople_API_Outputs\contactphoto.png'

EXECUTE UpdateOrDeleteContactPhoto Id = 'c2845916184580148264', Action = 'Update', Url = 'https://play-lh.googleusercontent.com/-Xqd3k7aJqZY/AAAAAAAAAAI/AAAAAAAAAAA/AMZuuckWFzqX627ygMhiilKbqmIA-T_AsQ/photo.jpg'

EXECUTE UpdateOrDeleteContactPhoto Id = 'c2845916184580148264', Action = 'Delete'

Input

Name Type Required Description
Id String True The Id of the contact.
Action String True Update or Delete operation you want to perform on Contact Photo. Possible values: Update, Delete.
FileSource String False The complete filepath of the photo to be uploaded. You need to specify either this field or URL.
URL String False An accessible URL the image will be downloaded from and then posted to the target. You need to specify either this field or FileSource.

Result Set Columns

Name Type Description
Success String Returns True if contact group has been modified.

CData Cloud

システムテーブル

このセクションで説明されているシステムテーブルをクエリして、スキーマ情報、データソース機能に関する情報、およびバッチ操作の統計にアクセスできます。

スキーマテーブル

以下のテーブルは、GoogleContacts のデータベースメタデータを返します。

  • sys_catalogs:利用可能なデータベースをリスト。
  • sys_schemas:利用可能なスキーマをリスト。
  • sys_tables:利用可能なテーブルおよびビューをリスト。
  • sys_tablecolumns:利用可能なテーブルおよびビューのカラムについて説明。
  • sys_procedures:利用可能なストアドプロシージャについて説明。
  • sys_procedureparameters:ストアドプロシージャパラメータについて説明。
  • sys_keycolumns:主キーおよび外部キーについて説明。
  • sys_indexes:利用可能なインデックスについて説明。

データソーステーブル

以下のテーブルは、データソースへの接続方法およびクエリ方法についての情報を返します。

  • sys_connection_props:利用可能な接続プロパティについての情報を返す。
  • sys_sqlinfo:Cloud がデータソースにオフロードできるSELECT クエリについて説明。

クエリ情報テーブル

次のテーブルは、データ変更クエリ(バッチ処理を含む)のクエリ統計を返します。

  • sys_identity:バッチ処理または単一の更新に関する情報を返す。

CData Cloud

sys_catalogs

利用可能なデータベースをリストします。

次のクエリは、接続文字列で決定されるすべてのデータベースを取得します。

SELECT * FROM sys_catalogs

Columns

Name Type Description
CatalogName String データベース名。

CData Cloud

sys_schemas

利用可能なスキーマをリストします。

次のクエリは、すべての利用可能なスキーマを取得します。

          SELECT * FROM sys_schemas
          

Columns

Name Type Description
CatalogName String データベース名。
SchemaName String スキーマ名。

CData Cloud

sys_tables

利用可能なテーブルをリストします。

次のクエリは、利用可能なテーブルおよびビューを取得します。

          SELECT * FROM sys_tables
          

Columns

Name Type Description
CatalogName String テーブルまたはビューを含むデータベース。
SchemaName String テーブルまたはビューを含むスキーマ。
TableName String テーブル名またはビュー名。
TableType String テーブルの種類(テーブルまたはビュー)。
Description String テーブルまたはビューの説明。
IsUpdateable Boolean テーブルが更新可能かどうか。

CData Cloud

sys_tablecolumns

利用可能なテーブルおよびビューのカラムについて説明します。

次のクエリは、[My Contacts] テーブルのカラムとデータ型を返します。

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='[My Contacts]' 

Columns

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 から返されたフィールドがテーブルの主キーであるかどうか。
ColumnType String スキーマ内のカラムの役割または分類。可能な値は、SYSTEM、LINKEDCOLUMN、NAVIGATIONKEY、REFERENCECOLUMN、およびNAVIGATIONPARENTCOLUMN が含まれます。

CData Cloud

sys_procedures

利用可能なストアドプロシージャをリストします。

次のクエリは、利用可能なストアドプロシージャを取得します。

          SELECT * FROM sys_procedures
          

Columns

Name Type Description
CatalogName String ストアドプロシージャを含むデータベース。
SchemaName String ストアドプロシージャを含むスキーマ。
ProcedureName String ストアドプロシージャの名前。
Description String ストアドプロシージャの説明。
ProcedureType String PROCEDURE やFUNCTION などのプロシージャのタイプ。

CData Cloud

sys_procedureparameters

ストアドプロシージャパラメータについて説明します。

次のクエリは、ModifyContactGroupMembers ストアドプロシージャのすべての入力パラメータについての情報を返します。

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

パラメータに加えて結果セットのカラムを含めるには、IncludeResultColumns 擬似カラムをTrue に設定します。

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'ModifyContactGroupMembers' AND IncludeResultColumns='True'

Columns

Name Type Description
CatalogName String ストアドプロシージャを含むデータベースの名前。
SchemaName String ストアドプロシージャを含むスキーマの名前。
ProcedureName String パラメータを含むストアドプロシージャの名前。
ColumnName String ストアドプロシージャパラメータの名前。
Direction Int32 パラメータのタイプに対応する整数値:input (1)。input/output (2)、またはoutput(4)。input/output タイプパラメータは、入力パラメータと出力パラメータの両方になれます。
DataType Int32 データ型を示す整数値。この値は、実行時に環境に基づいて決定されます。
DataTypeName String データ型の名前。
NumericPrecision Int32 数値データの場合は最大精度。文字データおよび日時データの場合は、カラムの長さ(文字数)。
Length Int32 文字データの場合は、許可される文字数。数値データの場合は、許可される桁数。
NumericScale Int32 数値データの小数点以下の桁数。
IsNullable Boolean パラメータがNull を含められるかどうか。
IsRequired Boolean プロシージャの実行にパラメータが必要かどうか。
IsArray Boolean パラメータが配列かどうか。
Description String パラメータの説明。
Ordinal Int32 パラメータのインデックス。
Values String このパラメータで設定できる値は、このカラムに表示されるものに限られます。指定できる値はカンマ区切りです。
SupportsStreams Boolean パラメータがファイルを表すかどうか。ファイルは、ファイルパスとして渡すことも、ストリームとして渡すこともできます。
IsPath Boolean パラメータがスキーマ作成操作のターゲットパスかどうか。
Default String 何も値が指定されていない場合に、このパラメータで使用される値。
SpecificName String 複数のストアドプロシージャが同じ名前を持つ場合、それぞれの同名のストアドプロシージャを一意に識別するラベル。特定の名前を持つプロシージャが1つだけの場合は、その名前がここに単純に反映されます。
IsCDataProvided Boolean プロシージャがネイティブのGoogleContacts プロシージャではなく、CData によって追加 / 実装されているかどうか。

Pseudo-Columns

Name Type Description
IncludeResultColumns Boolean 出力にパラメータに加えて結果セットのカラムを含めるかどうか。デフォルトはFalse です。

CData Cloud

sys_keycolumns

主キーおよび外部キーについて説明します。

次のクエリは、[My Contacts] テーブルの主キーを取得します。

         SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='[My Contacts]' 
          

Columns

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 主キーのカラム名。

CData Cloud

sys_foreignkeys

外部キーについて説明します。

次のクエリは、他のテーブルを参照するすべての外部キーを取得します。

         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 外部キーがインポート(他のテーブルを指す)キーかエクスポート(他のテーブルから参照される)キーかを指定します。

CData Cloud

sys_primarykeys

主キーについて説明します。

次のクエリは、すべてのテーブルとビューから主キーを取得します。

         SELECT * FROM sys_primarykeys
          

Columns

Name Type Description
CatalogName String キーを含むデータベースの名前。
SchemaName String キーを含むスキーマの名前。
TableName String キーを含むテーブルの名前。
ColumnName String キーカラムの名前。
KeySeq String 主キーのシーケンス番号。
KeyName String 主キーの名前。

CData Cloud

sys_indexes

利用可能なインデックスについて説明します。インデックスをフィルタリングすることで、より高速なクエリ応答時間でセレクティブクエリを記述できます。

次のクエリは、主キーでないすべてのインデックスを取得します。

          SELECT * FROM sys_indexes WHERE IsPrimary='false'
          

Columns

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 インデックスのカラムのシーケンスナンバー。

CData Cloud

sys_connection_props

利用可能な接続プロパティと、接続文字列に設定されている接続プロパティに関する情報を返します。

次のクエリは、接続文字列に設定されている、あるいはデフォルト値で設定されているすべての接続プロパティを取得します。

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns

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 プロパティに関するその他のさまざまな情報。

CData Cloud

sys_sqlinfo

Cloud がデータソースにオフロードできるSELECT クエリ処理について説明します。

SQL 構文の詳細については、SQL 準拠 を参照してください。

データソースのSELECT 機能

以下はSQL 機能のサンプルデータセットです。 SELECT 機能のいくつかの側面がサポートされている場合には、カンマ区切りのリストで返されます。サポートされていない場合、カラムにはNO が入ります。

名前説明有効な値
AGGREGATE_FUNCTIONSサポートされている集計関数。AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNTCOUNT 関数がサポートされているかどうか。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_BYGROUP 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_PROPERTIESUniform データベースを特定するプロパティを示します。
SUPPORTS_MULTIPLE_SCHEMASプロバイダー用に複数のスキームが存在するかどうかを示します。YES, NO
SUPPORTS_MULTIPLE_CATALOGSプロバイダー用に複数のカタログが存在するかどうかを示します。YES, NO
DATASYNCVERSIONこのドライバーにアクセスするために必要な、CData Sync のバージョン。Standard, Starter, Professional, Enterprise
DATASYNCCATEGORYこのドライバーのCData Sync カテゴリ。Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQLAPI で提供されている以上の、追加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_PARENTIDCheckCache 構文を親キーカラムに対して実行するかどうかを示します。TRUE, FALSE
CREATE_SCHEMA_PROCEDURESスキーマファイルの生成に使用できる、ストアドプロシージャを示します。

次のクエリは、WHERE 句で使用できる演算子を取得します。

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'
WHERE 句では、個々のテーブルの制限や要件が異なる場合がありますので注意してください。詳しくは、データモデル セクションを参照してください。

Columns

Name Type Description
NAME String SQL 構文のコンポーネント、またはサーバー上で処理できる機能。
VALUE String サポートされるSQL またはSQL 構文の詳細。

CData Cloud

sys_identity

試行された変更に関する情報を返します。

次のクエリは、バッチ処理で変更された行のId を取得します。

         SELECT * FROM sys_identity
          

Columns

Name Type Description
Id String データ変更処理から返された、データベース生成Id。
Batch String バッチの識別子。1 は単一処理。
Operation String バッチ内の処理の結果:INSERTED、UPDATED、またはDELETED。
Message String SUCCESS、またはバッチ内の更新が失敗した場合のエラーメッセージ。

CData Cloud

sys_information

利用可能なシステム情報を説明します。

次のクエリは、すべてのカラムを取得します。

SELECT * FROM sys_information

Columns

NameTypeDescription
ProductString製品名。
VersionString製品のバージョン番号。
DatasourceString製品が接続するデータソースの名前。
NodeIdString製品がインストールされているマシンの固有識別子。
HelpURLString製品のヘルプドキュメントのURL。
LicenseString製品のライセンス情報。(この情報が利用できない場合、この項目は空白のままか「N/A」と表示されます。)
LocationString製品のライブラリが格納されているファイルパスの場所。
EnvironmentString製品が現在稼働している環境またはランタイムのバージョン。
DataSyncVersionString本コネクタを使用するために必要なCData Sync のティア。
DataSyncCategoryStringCData Sync 機能のカテゴリ(例:Source、Destination)。

CData Cloud

接続文字列オプション

接続文字列プロパティは、接続を確立するために使用できるさまざまなオプションです。このセクションでは、本プロバイダーの接続文字列で設定できるオプションの一覧を示します。詳細については各リンクをクリックしてください。

Authentication


プロパティ説明
AuthSchemeGoogleContacts への接続に使用する認証方法を指定します。

OAuth


プロパティ説明
OAuthClientIdカスタムOAuth アプリケーションに割り当てられたクライアントID(コンシューマーキーとも呼ばれます)を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。
OAuthClientSecretカスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。(カスタムOAuth アプリケーションのみ)
DelegatedServiceAccounts委任されたリクエストのためのサービスアカウントE メールをスペース区切りで指定します。
RequestingServiceAccount委任されたリクエストを行うためのサービスアカウントのE メールを指定します。
ScopeSpecify scope to obtain the initial access and refresh token.

JWT OAuth


プロパティ説明
OAuthJWTCertクライアント証明書のJWT 証明書ストアの名前を指定します。
OAuthJWTCertTypeJWT 証明書を格納しているキーストアの種類を指定します。
OAuthJWTCertPasswordパスワードで保護された証明書ストアにアクセスするために使用されるOAuth JWT 証明書のパスワードを指定します。証明書ストアがパスワードを必要としない場合は、このプロパティを空白のままにします。
OAuthJWTCertSubjectストアで一致する証明書を検索するために使用される、OAuth JWT 証明書のサブジェクトを指定します。部分一致と、先頭の証明書を選択するためのワイルドカード '*' をサポートします。
OAuthJWTIssuerJava Web Token の発行者。
OAuthJWTSubjectアプリケーションからデリゲートアクセスの要求対象となるユーザーサブジェクト。

SSL


プロパティ説明
SSLServerCertTLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。

Logging


プロパティ説明
VerbosityログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。

Schema


プロパティ説明
BrowsableSchemasレポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

Miscellaneous


プロパティ説明
AWSWorkloadIdentityConfigAWS 経由でWorkload Identity Federation を使用する場合に指定する設定プロパティ。
AzureWorkloadIdentityConfigAzure 経由でWorkload Identity Federation を使用する場合に指定する設定プロパティ。
MaxRows集計やGROUP BY を含まないクエリで返される最大行数を指定します。
PseudoColumnsテーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。
Timeoutprovider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。
WorkloadPoolIdWorkload Identity Federation プールのID。
WorkloadProjectIdWorkload Identity Federation プールをホストするGoogle Cloud プロジェクトのID。
WorkloadProviderIdWorkload Identity Federation プールプロバイダーのID。
CData Cloud

Authentication

このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。


プロパティ説明
AuthSchemeGoogleContacts への接続に使用する認証方法を指定します。
CData Cloud

AuthScheme

GoogleContacts への接続に使用する認証方法を指定します。

Possible Values

OAuth, OAuthJWT, AWSWorkloadIdentity, AzureWorkloadIdentity

データ型

string

デフォルト値

"OAuth"

解説

  • OAuth:標準のユーザーアカウントを使用してOAuth 認証を実行する場合に設定。
  • OAuthJWT:OAuth サービスアカウントを使用してOAuth 認証を実行する場合に設定。
  • GCPInstanceAccount:Google Cloud Platform インスタンスからアクセストークンを取得する場合に設定。
  • AWSWorkloadIdentity:AWS 経由でWorkload Identity Federation を使用して認証する場合に設定。 Cloud はAWSWorkloadIdentityConfig に従ってAWS を認証し、Google Security Token Serivce に認証トークンを提供します。 Google STS はこのトークンを検証し、Google のサービスにアクセスできるOAuth トークンを生成します。
  • AzureWorkloadIdentity:Azure 経由でWorkload Identity Federation を使用して認証する場合に設定。 Cloud はAzureWorkloadIdentityConfig に従ってAzure を認証し、Google Security Token Serivce に認証トークンを提供します。 Google STS はこのトークンを検証し、Google のサービスにアクセスできるOAuth トークンを生成します。

CData Cloud

OAuth

このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。


プロパティ説明
OAuthClientIdカスタムOAuth アプリケーションに割り当てられたクライアントID(コンシューマーキーとも呼ばれます)を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。
OAuthClientSecretカスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。(カスタムOAuth アプリケーションのみ)
DelegatedServiceAccounts委任されたリクエストのためのサービスアカウントE メールをスペース区切りで指定します。
RequestingServiceAccount委任されたリクエストを行うためのサービスアカウントのE メールを指定します。
ScopeSpecify scope to obtain the initial access and refresh token.
CData Cloud

OAuthClientId

カスタムOAuth アプリケーションに割り当てられたクライアントID(コンシューマーキーとも呼ばれます)を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。

データ型

string

デフォルト値

""

解説

このプロパティは2つのケースで必要となります:

  • カスタムOAuth アプリケーションを使用する場合。たとえば、Web ベースの認証フロー、サービスベースの認証、またはアプリケーションの登録が必要な証明書ベースのフローなどが該当します。
  • ドライバーが埋め込みOAuth 資格情報を提供しない場合。

(ドライバーが埋め込みOAuth 資格情報を提供する場合、この値はすでにCloud によって設定されており、手動で入力する必要がないことがあります。)

OAuthClientId は、認証付きの接続を構成する際に、OAuthClientSecret やOAuthSettingsLocation などの他のOAuth 関連プロパティと一緒に使用されるのが一般的です。

OAuthClientId は、ユーザーがOAuth 経由で認証を行う前に設定する必要がある、主要な接続パラメータの1つです。 この値は、通常、ID プロバイダーのアプリケーション登録設定で確認できます。 Client ID、Application ID、Consumer Key などとラベル付けされた項目を探してください。

クライアントID は、クライアントシークレットのような機密情報とは見なされませんが、アプリケーションの識別情報の一部であるため、慎重に取り扱う必要があります。公開リポジトリや共有設定ファイルでこの値を露出させないようにしてください。

接続設定時にこのプロパティを使用する方法の詳細については、接続の確立 を参照してください。

CData Cloud

OAuthClientSecret

カスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。(カスタムOAuth アプリケーションのみ)

データ型

string

デフォルト値

""

解説

このプロパティ(アプリケーションシークレットまたはコンシューマシークレットとも呼ばれます)は、安全なクライアント認証を必要とするすべてのフローでカスタムOAuth アプリケーションを使用する場合に必要です。たとえば、Web ベースのOAuth、サービスベースの接続、証明書ベースの認可フローなどが該当します。 組み込みOAuth アプリケーションを使用する場合は必要ありません。

クライアントシークレットは、OAuth フローのトークン交換ステップで使用されます。このステップでは、ドライバーが認可サーバーにアクセストークンを要求します。 この値が欠落しているか正しくない場合、認証はinvalid_client またはunauthorized_client エラーで失敗します。

OAuthClientSecret は、ユーザーがOAuth 経由で認証を行う前に設定する必要がある、主要な接続パラメータの1つです。この値は、OAuth アプリケーションを登録する際にID プロバイダーから取得できます。

Notes:

  • この値は安全に保管し、公開リポジトリやスクリプト、安全でない環境では決して公開しないようにしてください。
  • クライアントシークレットは、一定期間が経過すると有効期限が切れる場合もあります。 アクセスを中断させないために、有効期限を常に監視し、必要に応じてシークレットをローテーションするようにしてください。

接続設定時にこのプロパティを使用する方法の詳細については、接続の確立 を参照してください。

CData Cloud

DelegatedServiceAccounts

委任されたリクエストのためのサービスアカウントE メールをスペース区切りで指定します。

データ型

string

デフォルト値

""

解説

サービスアカウントE メールは、スペース区切りのリストで指定する必要があります。

各サービスアカウントは、チェーン内の次のサービスアカウントのroles/iam.serviceAccountTokenCreator ロールを付与されている必要があります。

チェーンの最後のサービスアカウントは、リクエストするサービスアカウントのroles/iam.serviceAccountTokenCreator ロールが付与されている必要があります。 リクエストするサービスアカウントはRequestingServiceAccount プロパティで指定されたものです。

委任されたリクエストの場合、リクエストするサービスアカウントは、iam.serviceAccounts.getAccessToken 権限を持つ必要があることに注意してください。これは、serviceAccountTokenCreator ロールを介して付与することもできます。

CData Cloud

RequestingServiceAccount

委任されたリクエストを行うためのサービスアカウントのE メールを指定します。

データ型

string

デフォルト値

""

解説

委任されたリクエストで認証情報が要求されたアカウントのサービスアカウントのE メール。DelegatedServiceAccounts の委任されたサービスアカウントのリストを用いて、このプロパティは、委任されたリクエストを行うために使用されます。

このサービスアカウントには、IAM 権限iam.serviceAccounts.getAccessToken が必要です。

CData Cloud

Scope

Specify scope to obtain the initial access and refresh token.

データ型

string

デフォルト値

"https://www.googleapis.com/auth/contacts.other.readonly https://www.googleapis.com/auth/contacts.readonly https://www.googleapis.com/auth/user.gender.read https://www.googleapis.com/auth/user.emails.read https://www.googleapis.com/auth/user.birthday.read https://www.googleapis.com/auth/user.addresses.read https://www.googleapis.com/auth/profile.language.read https://www.googleapis.com/auth/profile.agerange.read https://www.googleapis.com/auth/user.organization.read https://www.googleapis.com/auth/user.phonenumbers.read"

解説

スコープは、認証ユーザーがどのようなアクセス権を持つかを定義するために設定されます。例えば、読み取り、読み取りと書き込み、機密情報への制限付きアクセスなどです。システム管理者は、スコープを使用して機能またはセキュリティクリアランスによるアクセスを選択的に有効化できます。

InitiateOAuth がGETANDREFRESH に設定されている場合、要求するスコープを変更したい場合はこのプロパティを使用する必要があります。

InitiateOAuth がREFRESH またはOFF のいずれかに設定されている場合、このプロパティまたはScope 入力を使用して、要求するスコープを変更できます。

Specify scope to obtain the initial access and refresh token.

CData Cloud

JWT OAuth

このセクションでは、本プロバイダーの接続文字列で設定可能なJWT OAuth プロパティの全リストを提供します。


プロパティ説明
OAuthJWTCertクライアント証明書のJWT 証明書ストアの名前を指定します。
OAuthJWTCertTypeJWT 証明書を格納しているキーストアの種類を指定します。
OAuthJWTCertPasswordパスワードで保護された証明書ストアにアクセスするために使用されるOAuth JWT 証明書のパスワードを指定します。証明書ストアがパスワードを必要としない場合は、このプロパティを空白のままにします。
OAuthJWTCertSubjectストアで一致する証明書を検索するために使用される、OAuth JWT 証明書のサブジェクトを指定します。部分一致と、先頭の証明書を選択するためのワイルドカード '*' をサポートします。
OAuthJWTIssuerJava Web Token の発行者。
OAuthJWTSubjectアプリケーションからデリゲートアクセスの要求対象となるユーザーサブジェクト。
CData Cloud

OAuthJWTCert

クライアント証明書のJWT 証明書ストアの名前を指定します。

データ型

string

デフォルト値

""

解説

OAuthJWTCertType フィールドは、OAuthJWTCert により指定された証明書ストアの種類を指定します。 ストアがパスワードで保護されている場合は、OAuthJWTCertPassword を使用してパスワードを指定します。

OAuthJWTCert は、OAuthJWTCertSubject フィールドとともにクライアント証明書を指定するために使われます。 OAuthJWTCert に値が設定され、かつOAuthJWTCertSubject が設定されている場合、CData Cloud は証明書の検索を開始します。 詳しくは、OAuthJWTCertSubject を参照してください。

証明書ストアの指定はプラットフォームに依存します。

注記

  • Windows の共通のユーザーとシステム証明書ストアは以下のとおりです。
    • MY:個人証明書と関連付けられた秘密キーを 格納している証明書ストア。
    • CA:証明機関の証明書。
    • ROOT:ルート証明書。
    • SPC:ソフトウェア発行元証明書。
  • Javaでは、証明書ストアは通常、証明書および 任意の秘密キーを含むファイルです。
  • 証明書ストアの種類がPFXFile の場合は、 このプロパティにファイル名を設定します。
  • PFXBlob の場合は、このプロパティをPFX ファイルのバイナリコンテンツ(例えば、PKCS12証明書ストア)に設定する必要があります。

CData Cloud

OAuthJWTCertType

JWT 証明書を格納しているキーストアの種類を指定します。

Possible Values

PFXBLOB, JKSBLOB, PEMKEY_BLOB, PUBLIC_KEY_BLOB, SSHPUBLIC_KEY_BLOB, XMLBLOB, BCFKSBLOB

データ型

string

デフォルト値

"PEMKEY_BLOB"

解説

値説明注記
USER現在のユーザーが所有する証明書ストア。 Windows のみ使用可能です。
MACHINEマシンストア。Java やその他の非Windows 環境では使用できません。
PFXFILE証明書を含むPFX(PKCS12)ファイル。
PFXBLOBPFX(PKCS12)形式の証明書ストアをbase-64 でエンコードした文字列。
JKSFILE証明書を含むJava キーストア(JKS)ファイル。Java 専用。
JKSBLOBJava キーストア(JKS)形式の証明書ストアをbase-64 でエンコードした文字列。 Java 専用。
PEMKEY_FILE秘密鍵とオプションの証明書を含むPEM でエンコードされたファイル。
PEMKEY_BLOB秘密鍵とオプションの証明書をbase-64 でエンコードした文字列。
PUBLIC_KEY_FILEPEM またはDER でエンコードされた公開鍵証明書を含むファイル。
PUBLIC_KEY_BLOBPEM またはDER でエンコードされた公開鍵証明書をbase-64 でエンコードした文字列。
SSHPUBLIC_KEY_FILESSH 形式の公開鍵を含むファイル。
SSHPUBLIC_KEY_BLOBSSH 形式の公開鍵ををbase-64 でエンコードした文字列。
P7BFILE証明書を含むPKCS7 ファイル。
PPKFILEPuTTY 秘密キー(PPK)を含むファイル。
XMLFILEXML 形式の証明書を含むファイル。
XMLBLOBXML 形式の証明書を含む文字列。
BCFKSFILEBouncy Castle キーストアを含むファイル。
BCFKSBLOBBouncy Castle キーストアを含む文字列(base-64エンコード)。

CData Cloud

OAuthJWTCertPassword

パスワードで保護された証明書ストアにアクセスするために使用されるOAuth JWT 証明書のパスワードを指定します。証明書ストアがパスワードを必要としない場合は、このプロパティを空白のままにします。

データ型

string

デフォルト値

""

解説

このプロパティは、パスワードで保護された証明書ストアを開くために必要なパスワードを指定します。 パスワードが必要かどうかを判断するには、ご利用の証明書ストアのドキュメントまたは設定を参照してください。

CData Cloud

OAuthJWTCertSubject

ストアで一致する証明書を検索するために使用される、OAuth JWT 証明書のサブジェクトを指定します。部分一致と、先頭の証明書を選択するためのワイルドカード '*' をサポートします。

データ型

string

デフォルト値

"*"

解説

このプロパティの値は、ストアで一致する証明書を検索するために使用されます。検索プロセスは以下のように動作します。

  • サブジェクトに完全に一致する証明書が見つかれば、該当する証明書が選択されます。
  • 完全に一致するものがない場合、ストアは、サブジェクトがプロパティ値を含む証明書を検索します。
  • 一致する証明書がない場合、証明書は選択されません。

値を '*' に設定すると、ストアの先頭の証明書が自動的に選択されます。 証明書のサブジェクトは識別名フィールドおよび値のカンマ区切りのリストです。 例:CN=www.server.com, OU=test, C=US, [email protected]。

一般的なフィールドには以下のものが含まれます。

フィールド説明
CN共通名。一般的には、www.server.com のようなホスト名です。
O法人名
OU法人の部署名
L法人の住所(市町村名)
S法人の住所(都道府県)
C国名
EE メールアドレス

フィールド値にカンマが含まれる場合は、引用符で囲んでください。例:"O=ACME, Inc."。

CData Cloud

OAuthJWTIssuer

Java Web Token の発行者。

データ型

string

デフォルト値

""

解説

Java Web Token の発行者。 サービスアカウントのE メールアドレスの値を入力します。

CData Cloud

OAuthJWTSubject

アプリケーションからデリゲートアクセスの要求対象となるユーザーサブジェクト。

データ型

string

デフォルト値

""

解説

アプリケーションからデリゲートアクセスの要求対象となるユーザーサブジェクトです。 アプリケーションが委任されたアクセスをリクエストするユーザーのE メールアドレスを入力します。

CData Cloud

SSL

このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。


プロパティ説明
SSLServerCertTLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。
CData Cloud

SSLServerCert

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

Note:'*' を使用してすべての証明書を受け入れるように指定することも可能ですが、セキュリティ上の懸念があるため推奨されません。

CData Cloud

Logging

このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。


プロパティ説明
VerbosityログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。
CData Cloud

Verbosity

ログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。

データ型

string

デフォルト値

"1"

解説

このプロパティは、Cloud がログファイルに含める詳細レベルを定義します。 Verbosity レベルを高くするとログに記録される情報の詳細が増えますが、ログファイルが大きくなり取り込まれるデータが増えるためパフォーマンスが低下する可能性があります。

デフォルトのVerbosity レベルは1で、通常の運用にはこれが推奨されます。 より高いVerbosity レベルは主にデバッグを目的としています。 各レベルの詳細については、ログ を参照してください。

LogModules プロパティと組み合わせることで、Verbosity は特定の情報カテゴリに対するログの詳細度を調整できます。

CData Cloud

Schema

このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。


プロパティ説明
BrowsableSchemasレポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
CData Cloud

BrowsableSchemas

レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

データ型

string

デフォルト値

""

解説

利用可能なデータベーススキーマをすべてリストすると余分な時間がかかり、パフォーマンスが低下します。 接続文字列にスキーマのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。

CData Cloud

Miscellaneous

このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。


プロパティ説明
AWSWorkloadIdentityConfigAWS 経由でWorkload Identity Federation を使用する場合に指定する設定プロパティ。
AzureWorkloadIdentityConfigAzure 経由でWorkload Identity Federation を使用する場合に指定する設定プロパティ。
MaxRows集計やGROUP BY を含まないクエリで返される最大行数を指定します。
PseudoColumnsテーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。
Timeoutprovider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。
WorkloadPoolIdWorkload Identity Federation プールのID。
WorkloadProjectIdWorkload Identity Federation プールをホストするGoogle Cloud プロジェクトのID。
WorkloadProviderIdWorkload Identity Federation プールプロバイダーのID。
CData Cloud

AWSWorkloadIdentityConfig

AWS 経由でWorkload Identity Federation を使用する場合に指定する設定プロパティ。

データ型

string

デフォルト値

""

解説

このプロパティは、Key=Value プロパティのセミコロン区切りリストとしてフォーマットされ、値はオプションで引用符で囲むこともできます。 例えば、この設定はユーザーのルートキーを使用してAWS で認証します:

AWSWorkloadIdentityConfig="AuthScheme=AwsRootKeys;AccessKey='AKIAABCDEF123456';SecretKey=...;Region=us-east-1"

CData Cloud

AzureWorkloadIdentityConfig

Azure 経由でWorkload Identity Federation を使用する場合に指定する設定プロパティ。

データ型

string

デフォルト値

""

解説

このプロパティは、Key=Value プロパティのセミコロン区切りリストとしてフォーマットされ、値はオプションで引用符で囲むこともできます。 例えば、この設定はクライアント資格情報を使用してAzure で認証します:

AzureWorkloadIdentityConfig="AuthScheme=AzureServicePrincipal;AzureTenant=directory (tenant) id;OAuthClientID=application (client) id;OAuthClientSecret=client secret;AzureResource=application id uri;"

CData Cloud

MaxRows

集計やGROUP BY を含まないクエリで返される最大行数を指定します。

データ型

int

デフォルト値

-1

解説

このプロパティのデフォルト値である-1 は、クエリに明示的にLIMIT 句が含まれていない限り、行の制限が適用されないことを意味します。 (クエリにLIMIT 句が含まれている場合、クエリで指定された値がMaxRows 設定よりも優先されます。)

MaxRows を0より大きい整数に設定することで、クエリがデフォルトで過度に大きな結果セットを返さないようにします。

このプロパティは、非常に大きなデータセットを返す可能性のあるクエリを実行する際に、パフォーマンスを最適化し、過剰なリソース消費を防ぐのに役立ちます。

CData Cloud

PseudoColumns

テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。

データ型

string

デフォルト値

""

解説

このプロパティを使用すると、Cloud がテーブルカラムとして公開する擬似カラムを定義できます。

個々の擬似カラムを指定するには、以下の形式を使用します。

Table1=Column1;Table1=Column2;Table2=Column3

すべてのテーブルのすべての擬似カラムを含めるには、次を使用してください:

*=*

CData Cloud

Timeout

provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。

データ型

int

デフォルト値

60

解説

タイムアウトは、クエリや操作全体ではなくサーバーとの個々の通信に適用されます。 例えば、各ページング呼び出しがタイムアウト制限内に完了する場合、クエリは60秒を超えて実行を続けることができます。

タイムアウトはデフォルトで60秒に設定されています。タイムアウトを無効にするには、このプロパティを0に設定します。

タイムアウトを無効にすると、操作が成功するか、サーバー側のタイムアウト、ネットワークの中断、またはサーバーのリソース制限などの他の条件で失敗するまで無期限に実行されます。

Note: このプロパティは慎重に使用してください。長時間実行される操作がパフォーマンスを低下させたり、応答しなくなる可能性があるためです。

CData Cloud

WorkloadPoolId

Workload Identity Federation プールのID。

データ型

string

デフォルト値

""

解説

Workload Identity Federation プールのID。

CData Cloud

WorkloadProjectId

Workload Identity Federation プールをホストするGoogle Cloud プロジェクトのID。

データ型

string

デフォルト値

""

解説

Workload Identity Federation プールをホストするGoogle Cloud プロジェクトのID。

CData Cloud

WorkloadProviderId

Workload Identity Federation プールプロバイダーのID。

データ型

string

デフォルト値

""

解説

Workload Identity Federation プールプロバイダーのID。

CData Cloud

Third Party Copyrights

LZMA from 7Zip LZMA SDK

LZMA SDK is placed in the public domain.

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

LZMA2 from XZ SDK

Version 1.9 and older are in the public domain.

Xamarin.Forms

Xamarin SDK

The MIT License (MIT)

Copyright (c) .NET Foundation Contributors

All rights reserved.

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

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

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

NSIS 3.10

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

1. DEFINITIONS

"Contribution" means:

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

i) changes to the Program, and

ii) additions to the Program;

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

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

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

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

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

2. GRANT OF RIGHTS

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

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

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

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

3. REQUIREMENTS

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

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

b) its license agreement:

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

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

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

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

When the Program is made available in source code form:

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

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

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

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

4. COMMERCIAL DISTRIBUTION

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

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

5. NO WARRANTY

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

6. DISCLAIMER OF LIABILITY

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

7. GENERAL

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

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

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

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

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

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