CData Cloud は、クラウドホスト型のソリューションで、複数の標準サービスやプロトコルにまたがるGoogle Directory へのアクセスを実現します。SQL Server データベースに接続できるアプリケーションであれば、CData Cloud を介してGoogle Directory に接続できます。
CData Cloud により、他のOData エンドポイントや標準SQL Server と同じように、Google Directory への接続を標準化し、構成することができます。
このページでは、CData Cloud でのGoogle Directory への接続の確立 のガイド、利用可能なリソースに関する情報、および使用可能な接続プロパティのリファレンスについて説明します。
接続の確立 は、CData Cloud にデータベースを作成するためのGoogle Directory への認証方法と必要な接続プロパティの設定方法について示します。
利用可能な標準サービスを経由してGoogle Directory からデータにアクセスする方法と、CData Cloud の管理については、CData Cloud ドキュメント で詳しく説明します。
Database タブで対応するアイコンを選択して、Google Directory に接続します。必須プロパティはSettings にリストされています。Advanced タブには、通常は必要ない接続プロパティが表示されます。
Cloud は、認証にユーザーアカウントおよびGCP インスタンスアカウントの使用をサポートします。
以下のセクションでは、Google Directory の利用可能な認証スキームについて説明します。
AuthScheme は、すべてのユーザーアカウントフローでOAuth に設定する必要があります。
OAuth アクセストークンの取得
次の接続プロパティを設定し、OAuthAccessToken を取得します。
続いてストアドプロシージャを呼び出し、OAuth 交換を完了します。
アクセストークンとリフレッシュトークンを取得すると、データに接続し、OAuth アクセストークンを自動または手動でリフレッシュすることができるようになります。
OAuth アクセストークンの自動リフレッシュ
ドライバーがOAuth アクセストークンを自動的にリフレッシュするようにするには、最初のデータ接続で次のように設定します。
OAuth アクセストークンの手動リフレッシュ
データ接続時に手動でOAuth アクセストークンをリフレッシュするために必要な値は、OAuth リフレッシュトークンのみです。
GetOAuthAccessToken によって返されたExpiresIn パラメータ値が経過した後に、RefreshOAuthAccessToken ストアドプロシージャを使用し、手動でOAuthAccessToken をリフレッシュします。次の接続プロパティを設定します。
次に、RefreshOAuthAccessToken を呼び出し、OAuthRefreshToken にGetOAuthAccessToken によって返されたOAuth リフレッシュトークンを指定します。新しいトークンが取得できたら、OAuthAccessToken プロパティにRefreshOAuthAccessToken によって返された値を設定し、新しい接続をオープンします。
最後に、OAuth リフレッシュトークンを保存し、OAuth アクセストークンの有効期限が切れた後に手動でリフレッシュできるようにします。
オプション1：Verifier code を取得および交換
Verifier code を取得するには、OAuth Authorization URL で認証する必要があります。
インターネットブラウザに対応したマシンから認証してOAuthVerifier 接続プロパティを取得する方法は次のとおりです。
ヘッドレスマシンでは、次の接続プロパティを設定してOAuth 認証値を取得します。
OAuth 設定ファイルが生成されたら、以下のように接続プロパティをリセットします。
オプション2：OAuth 設定を転送
ヘッドレスマシンでの接続に先立ち、インターネットブラウザに対応したデバイスでドライバーとの接続を作成し、インストールする必要があります。上述の「デスクトップアプリケーション」の説明に従って、接続プロパティを設定します。
「デスクトップアプリケーション」の手順が完了すると、生成された認証値は、OAuthSettingsLocation で指定された場所に暗号化されて書き込まれます。デフォルトのファイル名はOAuthSettings.txt です。
接続が正常にテストされたら、OAuth 設定ファイルをヘッドレスマシンにコピーします。
ヘッドレスマシンで、次の接続プロパティを設定し、データに接続します。
GCP 仮想マシン上で実行している場合は、Cloud は仮想マシンに関連付けられたサービスアカウントを使用して認証できます。 このモードを使用するには、AuthScheme をGCPInstanceAccount に設定します。
（OAuthAccessToken およびその他の設定パラメータを取得および設定する方法についての情報は、「Google Directory への接続」の デスクトップ認証セクションを参照してください。）
ただし、Web 経由で接続するには、カスタムOAuth アプリケーションの作成が必要です。また、カスタムOAuth アプリケーションは、一般的に使用される3つの認証フローをすべてシームレスにサポートするため、これらの認証フロー用にカスタムOAuth アプリケーションを作成（独自のOAuth アプリケーションクレデンシャルを使用）することもできます。
カスタムOAuth アプリケーションは、次のような場合に有用です。
以下のセクションでは、Directory API を有効化し、ユーザーアカウント（OAuth）およびサービスアカウント（OAuth / JWT）用のカスタムOAuth アプリケーションを作成する方法について説明します。
AuthScheme がOAuth であり、Web アプリケーション上で認証する必要があるユーザーの場合は、必ずカスタムOAuth アプリケーションを作成する必要があります。 （デスクトップおよびヘッドレスフローでのカスタムOAuth アプリケーションの作成は任意です。）
以下の手順に従います。
Note： クライアントシークレットはGoogle Cloud コンソールからアクセス可能です。
新しいサービスアカウントを作成するには：
サービスアカウントフローでは、Cloud はJSON Web Token（JWT）をOAuthAccessToken と交換します。 上記の手順でダウンロードした秘密鍵は、JWT に署名するために使用されます。 Cloud は、ドメイン全体の委任を通じて設定されたスコープを含む、サービスアカウントに付与された権限を継承します。
これらの権限はアクセススコープによって定義され、アプリケーションがアクセス可能なデータと実行可能なアクションを決定します。
このトピックでは、Google Directory プロバイダーに必要なアクセススコープとエンドポイントドメインについての情報を提供します。
スコープは、ユーザーのデータへのアプリケーションによるアクセスを制限するための手段です。これは、アプリケーションがユーザーに代わって実行できる特定のアクションを定義します。
例えば、読み取り専用スコープではアプリケーションにデータの閲覧を許可し、フルアクセススコープではデータの変更を許可することができます。
| Scope | Description |
| googleapis.com/auth/admin.directory.resource.calendar.readonly | Read-only access to calendar resources. |
| googleapis.com/auth/admin.directory.domain.readonly | Read-only access to domains associated with the account. |
| googleapis.com/auth/admin.directory.customer.readonly | Read-only access to customer information. |
| googleapis.com/auth/admin.directory.userschema.readonly | Read-only access to user schemas. |
| googleapis.com/auth/admin.directory.rolemanagement.readonly | Read-only access to roles and role assignments. |
| googleapis.com/auth/admin.directory.user.alias.readonly | Read-only access to user aliases. |
| googleapis.com/auth/admin.directory.user.readonly | Read-only access to user information. |
| googleapis.com/auth/admin.directory.orgunit.readonly | Read-only access to organizational unit structure. |
| googleapis.com/auth/admin.directory.group.readonly | Read-only access to groups. |
| googleapis.com/auth/admin.directory.group.member.readonly | Read-only access to group members. |
| googleapis.com/auth/admin.directory.device.mobile.readonly | Read-only access to mobile device information. |
| googleapis.com/auth/admin.directory.device.chromeos.readonly | Read-only access to ChromeOS device information. |
| googleapis.com/auth/admin.directory.resource.calendar | Full access to manage calendar resources. |
| googleapis.com/auth/admin.directory.domain | Full access to manage domains. |
| googleapis.com/auth/admin.directory.customer | Full access to manage customer information. |
| googleapis.com/auth/admin.directory.userschema | Full access to manage user schemas. |
| googleapis.com/auth/admin.directory.rolemanagement | Full access to manage roles and role assignments. |
| googleapis.com/auth/admin.directory.user.alias | Full access to manage user aliases. |
| googleapis.com/auth/admin.directory.user | Full access to manage users. |
| googleapis.com/auth/admin.directory.orgunit | Full access to manage organizational units. |
| googleapis.com/auth/admin.directory.group | Full access to manage groups. |
| googleapis.com/auth/admin.directory.group.member | Full access to manage group members. |
| googleapis.com/auth/admin.directory.device.mobile | Full access to manage mobile devices. |
| googleapis.com/auth/admin.directory.device.chromeos | Full access to manage ChromeOS devices. |
エンドポイントドメインとは、アプリケーションが認証、レコードの取得、その他の重要な操作を実行するために通信する必要がある特定のURL を指します。
これらのドメインを許可することで、アプリケーションとAPI 間のネットワークトラフィックがファイアウォールやセキュリティ設定によってブロックされることがなくなります。
Note： ほとんどのユーザーは特別な設定をする必要はありません。許可リストは通常、送信ネットワークトラフィックの制限など、厳格なセキュリティ対策が施された環境でのみ必要となります。
| Domain | Always Required | Description |
| accounts.google.com | TRUE | The subdomain used for OAuth. |
| googleapis.com | TRUE | The domain used for accessing various services. |
| admin.googleapis.com | TRUE | Used for Admin SDK Directory API endpoints. |
デフォルトでは、Cloud はサーバーとのTLS のネゴシエーションを試みます。サーバー証明書は、デフォルトのシステム信頼済み証明書ストアで検証されます。SSLServerCert 接続プロパティを使用して、証明書の検証方法をオーバーライドできます。
別の証明書を指定するには、SSLServerCert 接続プロパティを参照してください。
HTTP プロキシへの認証には、以下のように設定します。
次のプロパティを設定します。
CData Cloud は、Google Directory API をリレーショナルテーブル、ビュー、およびストアドプロシージャとしてモデル化します。 使用可能なオブジェクトのAPI の制限事項および要件について、このセクションで説明します。
Cloud プロバイダーは、Google Directory API をリレーショナルテーブル としてモデル化します。
ビュー は、Google Directory のいくつかの追加情報を提供します。
ストアドプロシージャ は、データソースのファンクションライクなインターフェースです。
Cloud はGoogle Directory のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。
| Name | Description |
| ChromeOsDevices | Retrieve all Chrome devices for an account. |
| DomainAliases | Create, update, and query aliases of a domain. |
| Domains | Create, delete, and query the domains for a user. |
| GroupAliases | Create, delete, and query aliases for a group. |
| GroupMembers | Create, update, delete, and query the members for a group. |
| Groups | Create, update, delete, and query groups. |
| Notifications | Update, delete, and query notifications for a customer. |
| OrganizationUnits | Create, update, delete, and query the organization units for a customer. |
| RoleAssignments | Create, delete, and query roles assigned to users. |
| Tokens | Query and delete tokens for a user. |
| UserAliases | Lists aliases, which are alternative email addresses for a user. |
| Users | Query user information. |
Retrieve all Chrome devices for an account.
To get a list of all Chrome devices for an account, the CustomerId column is required. It can be set in the connection string or in the WHERE clause condition. If not specified, the CustomerId of the current account will be used.
For example, the following query is processed server side by the Google Directory APIs:
SELECT * FROM ChromeOsDevices
INSERTs are not supported for this table.
Updates a device's annotatedUser, annotatedLocation, or notes properties. To update a notification, the following columns are required: CustomerId and Id. If not specified, the CustomerId of the current account will be used.
UPDATE ChromeOsDevices SET AnnotatedUser = 'User_2' WHERE Id = '12345' AND CustomerId = '1234'.
Deletes are not supported for this table.
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | True |
The unique ID of the Chrome device. |
| SerialNumber | String | True |
The Chrome device serial number entered when the device was enabled. This value is the same as the Admin console's Serial Number in the Chrome OS Devices tab. |
| Model | String | True |
The device's model information. If the device does not have this information, this property is not included in the response. |
| MEID | String | True |
The Mobile Equipment Identifier (MEID) for the 3G mobile card in a mobile device. A MEID is typically used when adding a device to a wireless carrier's post-pay service plan. If the device does not have this information, this property is not included in the response. |
| LastSync | Datetime | True |
The date and time the device was last enrolled. |
| AnnotatedUser | String | False |
The user of the device as noted by the administrator. Maximum length is 100 characters. Empty values are allowed. |
| AnnotatedLocation | String | False |
The address or location of the device as noted by the administrator. Maximum length is 200 characters. Empty values are allowed. |
| AnnotatedAssetId | String | False |
The asset identifier as noted by an administrator or specified during enrollment. |
| Notes | String | False |
Notes about this device added by the administrator. This property can be searched with the list method's query parameter. Maximum length is 500 characters. Empty values are allowed. |
| OrgUnitPath | String | False |
The full parent path with the organizational unit's name associated with the device. Path names are case insensitive. If the parent organizational unit is the top-level organization, it is represented as a forward slash, /. This property can be updated using the API |
| OrderNumber | String | True |
The device's order number. Only devices directly purchased from Google have an order number. |
| MacAddress | String | True |
The device's wireless MAC address. If the device does not have this information, it is not included in the response. |
| WillAutoRenew | Boolean | True |
Determines if the device will auto renew its support after the support end date. This is a read-only property. |
| OsVersion | String | True |
The Chrome device's operating system version. |
| PlatformVersion | String | True |
The Chrome device's platform version. |
| FirmwareVersion | String | True |
The Chrome device's firmware version. |
| BootMode | String | True |
The boot mode for the device. |
| LastEnrollmentTime | String | True |
The date and time the device was last enrolled. |
| TmpVersionInfoAggr | String | True |
Trusted Platform Module (TPM). |
| ActiveTimeRangesAggr | String | True |
List of active time ranges. |
| RecentUsersAggr | String | True |
List of recent device users, in descending order, by last login time. |
| DeviceFilesAggr | String | True |
List of device files to download. |
| ETag | String | True |
ETag of the resource. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| CustomerId | String |
Id of the customer |
Create, update, and query aliases of a domain.
To get a list of all the aliases for a domain, the CustomerId column is required. It can be set in the connection string or in the WHERE clause condition. If not specified, the CustomerId of the current account will be used.
For example, the following query is processed server side by the Google Directory APIs:
SELECT * FROM DomainAliases
To insert an alias, the following columns are required: CustomerId, ParentDomain, and DomainAliasName.
INSERT INTO DomainAliases (CustomerId, DomainAliasName, ParentDomain) VALUES ('12345', 'Alias', 'parentdomain.com')
UPDATEs are not supported for this table.
To delete an alias, the following columns are required: CustomerId and DomainAliasName.
DELETE FROM DomainAliases WHERE CustomerId = 'C020vaw0q' AND DomainAliasName = 'Alias'
| Name | Type | ReadOnly | Description |
| DomainAliasName [KEY] | String | False |
The domain alias name. |
| ParentDomain | String | False |
The parent domain name that the domain alias is associated with. |
| IsVerified | Boolean | True |
Indicates the verification state of a domain alias. |
| CreationDate | Timestamp | True |
Creation date timestamp of the domain alias in milliseconds. |
| ETag | String | True |
ETag of the resource |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| CustomerId | String |
Id of the customer |
Create, delete, and query the domains for a user.
To get a list of all the domains, the CustomerId column is required. It can be set in the connection string or in the WHERE clause condition. If not specified, the CustomerId of the current account will be used, as in the following query.
For example, the following query is processed server side by the Google Directory APIs:
SELECT * FROM Domains
To insert a domain, the following columns are required: CustomerId and DomainName.
INSERT INTO Domains (CustomerId, DomainName) VALUES ('12345', 'exampledomain.com')
UPDATEs are not supported for this table.
To delete a domain, the DomainName column is required.
DELETE FROM Domains WHERE DomainName = 'exampledomain.com'
| Name | Type | ReadOnly | Description |
| DomainName [KEY] | String | False |
The domain name. |
| IsPrimary | Boolean | True |
Indicates if the domain is a primary domain. |
| IsVerified | Boolean | True |
Indicates the verification state of a domain. |
| CreationDate | Datetime | True |
The creation date of the domain. |
| Aliases | String | True |
The aliases of the domain. |
| ETag | String | True |
ETag of the resource. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| CustomerId | String |
Id of the customer |
Create, delete, and query aliases for a group.
To get a list of all the aliases for a group, the GroupId column is required. If not specified, the GroupId of the first group from the Groups table will be used.
The following query shows the only filter processed server side by the Google Directory API:
SELECT * FROM GroupAliases WHERE GroupId = '12345'
To insert an alias, the following columns are required: GroupId and Alias.
INSERT INTO GroupAliases (GroupId, Alias) VALUES ('12345', 'Alias')
UPDATEs are not supported for this table.
To delete an alias, the following columns are required: GroupId and Alias.
DELETE FROM GroupAliases WHERE GroupId = '12345' AND Alias = 'Alias'
| Name | Type | ReadOnly | Description |
| Alias [KEY] | String | False |
The alias email address. |
| GroupId | String | True |
Id of the group. |
| PrimaryEmail | String | True |
PrimaryEmail of the group. |
| ETag | String | True |
ETag of the resource. |
Create, update, delete, and query the members for a group.
To get a list of all the members of a group, the GroupId column is required. If not specified, the Id of the first group from the Groups table will be used.
The following query shows the only filter processed server side by the Google Directory API:
SELECT * FROM GroupMembers WHERE GroupId = '12345'
To insert a member, the following columns are required: Email and GroupId.
The Role column only accepts the following values: MEMBER, MANAGER, and OWNER.
INSERT INTO GroupMembers (Email, GroupId, Role) VALUES ('[email protected]', '12345', 'MEMBER')
To update a member, the following columns are required: GroupId and Id.
UPDATE GroupMembers SET Role = 'MEMBER' WHERE GroupId = '1234' AND Id = '12345'
To delete a member, the following columns are required: GroupId and Id.
DELETE FROM GroupMembers WHERE GroupId = '1234' AND Id = '12345'
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
The unique identifier for the member. |
| GroupId | String | True |
The unique identifier for the member. |
| String | False |
The email of the member. | |
| Role | String | False |
The name of the member. |
| Status | String | True |
The status of the member. |
| Type | String | True |
The type of members. |
| ETag | String | True |
ETag of the resource |
Create, update, delete, and query groups.
To get a list of all the groups, the CustomerId is required. You can either set it in the connection string or in the WHERE clause condition. If not specified, the CustomerId of the current account will be used.
For example, the following query is processed server side by the Google Directory API:
SELECT * FROM Groups
To insert a group, the Email column is required.
INSERT INTO Groups (Email, Name, Description) VALUES ('[email protected]', 'Group Example Name', 'Example Description')
To update a group, the Id is required.
UPDATE Groups SET Email = '[email protected]', Name = 'Group', Description = 'Description' WHERE Id = 1231
To delete a group, the Id column is required.
DELETE FROM Groups WHERE Id = '12345'
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | True |
The unique identifier for the group. |
| String | False |
The email of the group. | |
| Name | String | False |
The name of the group. |
| MembersCount | Long | True |
The number of members. |
| Description | String | False |
Description of the group. |
| Aliases | String | True |
Aliases of the group. |
| AdminCreated | Boolean | True |
Indicates if the group was created by an admin. |
| ETag | String | True |
ETag of the resource |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| CustomerId | String |
The customer Id of the group. |
| Domain | String |
Domain name. |
Update, delete, and query notifications for a customer.
To get a list of all the notifications, the CustomerId column is required. It can be set in the connection string or in the WHERE clause condition. If not specified, the CustomerId of the current account will be used.
For example, the following query is processed server side by the Google Directory APIs:
SELECT * FROM Notifications
INSERTs are not supported for this table.
To update a notification, the following columns are required: CustomerId and Id. If not specified, the CustomerId of the current account will be used.
UPDATE Notifications SET IsUnread = true WHERE Id = '12345' AND CustomerId = '1234'.
To delete a notification, the following columns are required: CustomerId and Id. If not specified, the CustomerId of the current account will be used.
DELETE FROM Notifications WHERE CustomerId = '1234' AND Id = '12345'
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | True |
Id of the notification |
| Subject | String | False |
Subject of the notification |
| Body | String | True |
The body of the notification |
| SendDate | Datetime | True |
The date when the notification was sent |
| FromAddress | String | True |
The address from which the notification is recieved |
| IsUnread | Boolean | False |
Indicates wether the notification is unread or not |
| ETag | String | True |
ETag of the resource |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| CustomerId | String |
Id of the customer |
Create, update, delete, and query the organization units for a customer.
To get a list of all the organization units, the CustomerId column is required. It can be set in the connection string or in the WHERE clause condition. If not specified, the CustomerId of the current account will be used.
For example, the following query is processed server side by the Google Directory APIs:
SELECT * FROM OrganizationUnits
To insert an organization unit, the following columns are required: CustomerId, Name, and ParentOrgUnitId. If not specified, the CustomerId of the current account will be used.
INSERT INTO OrganizationUnits (CustomerId, Name, Description, OrgUnitPath, ParentOrgUnitId, ParentOrgUnitPath) VALUES ('12345', 'OrgUnit Name', 'OrgUnit Description', 'Path', '123456', 'ParentPath', '1234')
To update an organization unit, the following columns are required: CustomerId and Id. If not specified, the CustomerId of the current account will be used.
UPDATE OrganizationUnits SET Name = 'OrgUnit Name', 'Description = 'OrgUnit Description', OrgUnitPath = 'Path', ParentOrgUnitId = '123456', ParentOrgUnitPath = 'ParentPath' WHERE CustomerId = '1234' AND Id = '12345'
To delete an organization unit, the following columns are required: CustomerId and Id. If not specified, the CustomerId of the current account will be used.
DELETE FROM OrganizationUnits WHERE CustomerId = '1234' AND Id = '12345'
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | True |
Id of the Organization Unit. |
| Name | String | False |
Name of the Organization Unit. |
| Description | String | False |
Description of the Organization Unit. |
| OrgUnitPath | String | False |
Path of the OrgOrganization Unit.Unit |
| ParentOrgUnitPath | String | False |
Path of the Organization Unit's parent. |
| ParentOrgUnitId | String | False |
Id of the Organization Unit's parent |
| ETag | String | True |
ETag of the resource. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| CustomerId | String |
Id of the customer |
Create, delete, and query roles assigned to users.
To get a list of all the roles assigned to users, the CustomerId column is required. If not specified, the CustomerId of the current account will be used.
For example, the following query is processed server side by the Google Directory APIs:
SELECT * FROM RoleAssignments
To assign a role to a user, the following columns are required: RoleId, UserId, ScopeType, and CustomerId. If not specified, the CustomerId of the current account will be used.
ScopeType has only two acceptable values : CUSTOMER and ORG_UNIT.
INSERT INTO RoleAssignments (RoleId, UserId, ScopeType) VALUES ('12345', '123456', 'CUSTOMER')
UPDATEs are not supported for this table.
To remove an assigned role from a user, the Id and CustomerId columns are required. If not specified, the CustomerId of the current account will be used.
DELETE FROM RoleAssignments WHERE Id = '12345'
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | True |
The unique identifier of the role assignment. |
| RoleId | String | False |
The Id of the role that is assigned. |
| UserId | String | False |
The Id of the user this role is assigned to. |
| OrgUnitId | String | False |
If the role is restricted to an organizational unit, this contains the ID for the organizational unit the exercise of this role is restricted to. |
| ScopeType | String | False |
The scope in which this role is assigned. Acceptable values are 'CUSTOMER' and 'ORG_UNIT'. |
| Etag | String | True |
Etag of the resource. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| CustomerId | String |
Id of the customer |
Query and delete tokens for a user.
To get a current set of tokens a specified user has issued to 3rd party applications, the UserId column is required. It can be set in the connection string or in the WHERE clause condition. If not specified, the Id of the first user from the Users table will be used.
For example, the following query is processed server side by the Google Directory APIs:
SELECT * FROM Tokens
INSERTs are not supported for this table.
UPDATEs are not supported for this table.
To delete a token, the UserId and Id columns are required.
DELETE FROM Tokens WHERE UserId = '12345' AND Id = '123456'
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
The Client ID of the application the token is issued to. |
| UserId | String | False |
Aggregate of child privileges. |
| DisplayText | String | False |
The displayable name of the application the token is issued to. |
| IsAnonymous | Boolean | False |
Indicates if the name of the privilege. |
| IsNativeApp | Boolean | False |
Indicates if the token is issued to an installed application. |
| ScopesAggregate | String | False |
Aggregate of child privileges. |
| Etag | String | False |
Etag of the resource. |
Lists aliases, which are alternative email addresses for a user.
To get a list of all the aliases for a user, the UserId column is required. It can be set in the connection string or in the WHERE clause condition. Otherwise, the Cloud will automatically use the Id of the first user from the Users table.
For example, the following query is processed server side by the Google Directory APIs:
SELECT * FROM Aliases
To insert an alias, the following columns are required: UserId and Alias.
INSERT INTO Aliases (UserId, Alias) VALUES ('12345', 'Alias')
UPDATEs are not supported for this table.
To delete an alias, the following columns are required: UserId and Alias.
DELETE FROM Aliases WHERE Id = '12345' AND Alias = 'Alias'
| Name | Type | ReadOnly | Description |
| Alias [KEY] | String | False |
The alias email address. |
| UserId | String | True |
Id of the user. |
| PrimaryEmail | String | True |
PrimaryEmail of the user. |
| ETag | String | True |
ETag of the resource. |
Query user information.
To get a list of all the users, CustomerId is required. You can either set it in the connection string or in the WHERE clause condition. If not specified, the CustomerId of the current account will be used.
For example, the following query is processed server side by the Google Directory APIs:
SELECT * FROM Users
To insert a user, the following columns are required: PrimaryEmail, FirstName, Surname, and Password.
INSERT INTO Users (PrimaryEmail, FirstName, Surname, Password, Suspended) VALUES ('[email protected]', 'John', 'Doe', '12345', true)
To update a user, the Id column is required.
UPDATE Users SET PrimaryEmail = '[email protected]', FirstName = 'John', Surname = 'Doe', Suspended = true WHERE Id = 1231
To delete users, the Id column is required.
DELETE FROM Users WHERE Id = '12345'
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | True |
The unique identifier for the user. |
| CustomerId | String | True |
The customer Id of the user. |
| PrimaryEmail | String | False |
The primary email of the user. |
| FirstName | String | False |
The first name of the user. |
| Surname | String | False |
The surname of the user. |
| Aliases | String | True |
The aliases of the user. |
| IsAdmin | Boolean | True |
Indicates if the user is an admin. |
| IsDelegatedAdmin | Boolean | True |
Indicates if the user is a delegated admin. |
| LastLoginDate | Datetime | True |
Last time the user logged on. |
| CreationDate | Datetime | True |
Creation date of the user. |
| DeletionDate | Datetime | True |
Deletion date of the user. |
| AgreedToTerms | Boolean | True |
Indicates if the user agreed to the terms or not. |
| Suspended | Boolean | False |
Indicates if the user got supsended. |
| SuspensionReason | String | True |
The reason the user got supsended. |
| OrgUnitPath | String | False |
The full path of the parent organization associated with the user. If the parent organization is the top-level, it is represented as a forward slash (/). |
| IsMailBoxSetup | Boolean | True |
Indicates if the user's Google mailbox is created. This property is only applicable if the user has been assigned a Gmail license. |
| IsEnrolledIn2Sv | Boolean | True |
Indicates if the user is enrolled in 2-step verification. |
| IsEnforcedIn2Sv | Boolean | True |
Indicates if the user is enforced in 2-step verification. |
| IncludeInGlobalAddressList | Boolean | True |
Indicates if the user's profile is visible in the G Suite global address list when the contact sharing feature is enabled for the domain. |
| ThumbnailPhotoUrl | String | True |
Photo Url of the user |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| Password | String |
The password of the user. |
| Domain | String |
Domain name |
ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。
クエリは、ビューに対して通常のテーブルと同様に実行することができます。
| Name | Description |
| AppSpecificPasswords | Lists all Application Specific Passwords (passwords that are used with applications that do not accept verification codes) issued by a user. |
| MobileDevices | Lists mobile devices for an account. |
| Privileges | Lists all Privileges. |
| Roles | Lists roles in a domain. |
| UserAddresses | Lists the addresses for a user. |
| UserEmails | Query the emails for a user. |
| UserInstantMessagingAccounts | Query the IM accounts for a user. |
| UserLocations | Query the locations for a user. |
| UserOrganizations | Query the organizations for a user. |
| UserPhones | Query the phone numbers for a user. |
| UserWebsites | Retrieve a list of the websites of a user. |
| VerificationCodes | Query verification codes for a user. |
Lists all Application Specific Passwords (passwords that are used with applications that do not accept verification codes) issued by a user.
To get a list of all the application specific tokens issued by a user, the UserId column is required. It can be set in the connection string or in the WHERE clause condition. If not specified, the Id of the first user from the Users table will be used.
For example, the following query is processed server side by the Google Directory API:
SELECT * FROM AppSpecificPasswords
| Name | Type | Description |
| Id [KEY] | String | The unique identifier of the ASP. |
| UserId | String | The unique identifier of the user who issued the ASP. |
| Name | String | Name of the ASP. |
| CreationDate | Datetime | The date when the ASP was created. |
| LastTimeUsed | Datetime | The time when the ASP was last used. |
| Etag | String | Etag of the resource. |
Lists mobile devices for an account.
To get a list of all mobile devices for an account, the CustomerId column is required. It can be set in the connection string or in the WHERE clause condition. If not specified, the CustomerId of the current account will be used.
For example, the following query is processed server side by the Google Directory APIs:
SELECT * FROM MobileDevices
| Name | Type | Description |
| Id [KEY] | String | The serial number for a Google Sync mobile device. For Android and iOS devices, this is a software generated unique identifier. |
| ResourceId | String | The unique ID the API service uses to identify the mobile device. |
| Name | String | List of the owner's usernames. |
| AccountsList | String | List of accounts added on device. |
| String | List of the owner's emails. | |
| Model | String | The mobile device's model name. |
| OS | String | The mobile device's operating system |
| Type | String | The type of mobile device. |
| Status | String | The device's status. |
| HardwareId | String | The IMEI/MEID unique identifier for Android hardware. |
| FirstSyncDate | Datetime | The date and time the device was initially synchronized with the policy settings in the Admin console. |
| LastSyncDate | Datetime | The date and time the device was last synchronized with the policy settings in the Admin console. |
| UserAgent | String | Gives information about the device such as os version. |
| SerialNumber | String | The device's serial number. |
| IMEI | String | The device's IMEI number. |
| MEID | String | The device's MEID number. |
| WiFiMacAddress | String | The device's MAC address on Wi-Fi networks. |
| NetworkOperator | String | Mobile Device mobile or network operator. |
| DefaultLanguage | String | The default langauge used on the device. |
| DeviceCompromisedStatus | String | The compromised device status. |
| BuildNumber | String | The device's operating system build number. |
| KernelVersion | String | The device's kernel version. |
| BasebandVersion | String | The device's baseband version. |
| Manufacturer | String | The device's manufacturer. |
| ReleaseVersion | String | Mobile Device release version version. |
| SecurityPatchLevel | String | The device's security patch level. |
| Brand | String | The device's brand. |
| BootloaderVersion | String | The device's bootloader version. |
| Hardware | String | The device's hardware. |
| EncryptionStatus | String | The device's encryption status. |
| DevicePasswordStatus | String | The device's password status |
| Privilege | String | DMAgentPermission. |
| UnknownSourcesStatus | Boolean | Indicates if unknown sources are enabled or disabled on device |
| AdbStatus | Boolean | Indicates if adb(USB debugging) is enabled or disabled on device |
| IsOnOwnerProfile | Boolean | Indicates if this account is on owner/primary profile or not. |
| SupportsWorkProfile | Boolean | Indicates if work profile is supported on device. |
| Etag | String | Etag of the resource |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| CustomerId | String | The Id of the customer |
Lists all Privileges.
To get a list of all privileges for an account, the CustomerId column is required. It can be set in the connection string or in the WHERE clause condition. If not specified, the CustomerId of the current account will be used.
For example, the following query is processed server side by the Google Directory APIs:
SELECT * FROM Privileges
| Name | Type | Description |
| ServiceId [KEY] | String | The obfuscated ID of the service this privilege is for. |
| ServiceName [KEY] | String | The name of the service this privilege is for. |
| PrivilegeName | String | The name of the privilege. |
| ParentServiceId | String | The service Id of the parent privilege. |
| ParentPrivilegeName | String | The privilege name of the parent privilege. |
| IsOrganizationUnitRestrictable | Boolean | Indicates if the privilege can be restricted to an organization unit. |
| Etag | String | Etag of the resource. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| CustomerId | String | Id of the customer |
Lists roles in a domain.
To get a list of all the roles, the CustomerId column is required. It can be set in the connection string or in the WHERE clause condition. If not specified, the CustomerId of the current account will be used.
For example, the following query is processed server side by the Google Directory APIs:
SELECT * FROM Roles
| Name | Type | Description |
| Id [KEY] | String | The unique identifier for the role. |
| Name | String | Name of the role. |
| Description | String | A short description of the role. |
| PrivilegeName | String | The name of the privilege. |
| ServiceId | String | The ID of the service the privilege is for. |
| IsSystemRole | Boolean | Indicates if it is a pre-defined system role. |
| IsSuperAdminRole | Boolean | Indicates if the role is a super admin role. |
| Etag | String | Etag of the resource. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| CustomerId | String | Id of the customer |
Lists the addresses for a user.
To get a list of addresses for a user, the UserId column is required. It can be set in the connection string or in the WHERE clause condition. Otherwise, the Cloud will automatically use the UserId of the first user from the Users table.
For example, the following query is processed server side by the Google Directory APIs:
SELECT * FROM UserAddresses
| Name | Type | Description |
| UserId | String | The unique identifier for the user. |
| Type | String | The address type. |
| CustomType | String | The custom type of the address. |
| FormattedAddress | String | The full unstructured postal address. |
| PoBox | String | Post office box of the address. |
| ExtendedAddress | String | The extended address |
| StreetAddress | String | The street address |
| Locality | String | The town or city of the address. |
| Region | String | The abbreviated province or state. |
| PostalCode | String | The ZIP or postal code, if applicable. |
| Country | String | Country in the address. |
| CountryCode | String | The country code. Uses the ISO 3166-1 standard. |
| IsPrimary | Boolean | Indicates if this is the primary address of the user |
Query the emails for a user.
To get a list of email addresses for a user, the UserId column is required. It can be set in the connection string or in the WHERE clause condition. Otherwise, the Cloud will automatically use the Id of the first user from the Users table.
For example, the following query is processed server side by the Google Directory APIs:
SELECT * FROM UserEmails
| Name | Type | Description |
| Address | String | The user's email address |
| UserId | String | The unique identifier for the user. |
| IsPrimary | String | Indicates if this is the user's primary email. |
| CustomType | String | The custom type of the email. |
| Type | String | The type of the email account. |
Query the IM accounts for a user.
To get a list of IM accounts for a user, the UserId column is required. It can be set in the connection string or in the WHERE clause condition. Otherwise, the Cloud will automatically use the Id of the first user from the Users table.
For example, the following query is processed server side by the Google Directory APIs:
SELECT * FROM UserInstantMessagingAccounts
| Name | Type | Description |
| IM | String | The user's IM network ID. |
| UserId | String | The unique identifier for the user. |
| Protocol | String | The IM protocol identifies the IM network. |
| CustomProtocol | String | The custom type of the IM protcol. |
| IsPrimary | String | Indicates if this is the user's primary IM. |
| CustomType | String | The custom type of the IM account. |
| Type | String | The type of the IM account. |
Query the locations for a user.
To get a list of locations for a user, the UserId column is required. It can be set in the connection string or in the WHERE clause condition. Otherwise, the Cloud will automatically use the Id of the first user from the Users table.
For example, the following query is processed server side by the Google Directory APIs:
SELECT * FROM UserLocations
| Name | Type | Description |
| Area | String | Textual location of the user. |
| UserId | String | The unique identifier for the user. |
| BuildingId | String | The building identifier. |
| DeskCode | String | The desk location. |
| FloorName | String | The floor name/number |
| FloorSection | String | The floor section. |
| CustomType | String | The custom type of the location. |
| Type | String | The type of the location. |
Query the organizations for a user.
To get a list of organizations for a user, the UserId column is required. It can be set in the connection string or in the WHERE clause condition. Otherwise, the Cloud will automatically use the Id of the first user from the Users table.
For example, the following query is processed server side by the Google Directory APIs:
SELECT * FROM UserOrganizations
| Name | Type | Description |
| Name | String | The name of the organization. |
| UserId | String | The unique identifier for the user. |
| OrganizationDomain | String | The domain the organization belongs to. |
| Department | String | Specifies the department within the organization. |
| Description | String | The description of the organization. |
| Title | String | The user's title within the organization. |
| CostCenter | String | The cost center of the user's organization. |
| Location | String | The physical location of the organization. |
| IsPrimary | Boolean | Indicates if this is the user's primary organization. |
| Symbol | String | Text string symbol of the organization. |
| Type | String | Country in the address. |
| CustomType | String | If the value of type is custom, this property contains the custom type. |
Query the phone numbers for a user.
To get a list of phones for a user, the UserId column is required. It can be set in the connection string or in the WHERE clause condition. Otherwise, the Cloud will automatically use the Id of the first user from the Users table.
For example, the following query is processed server side by the Google Directory APIs:
SELECT * FROM UserPhones
| Name | Type | Description |
| PhoneNumber | String | The user's phone number. |
| UserId | String | The unique identifier for the user. |
| IsPrimary | String | Indicates if this is the user's primary IM. |
| CustomType | String | The custom type of the phone number. |
| Type | String | The type of the phone number. |
Retrieve a list of the websites of a user.
To get a list of websites for a user, the UserId column is required. It can be set in the connection string or in the WHERE clause condition. Otherwise, the Cloud will automatically use the Id of the first user from the Users table.
For example, the following query is processed server side by the Google Directory APIs:
SELECT * FROM UserWebsites
| Name | Type | Description |
| URL | String | The URL of the website. |
| UserId | String | The unique identifier for the user. |
| CustomType | String | The custom type of the website. |
| Type | String | The type of the website. |
| IsPrimary | Boolean | Indicates if this is the user's primary website or not |
Query verification codes for a user.
To get a current set of valid backup verification codes for a specified user, the UserId column is required. It can be set in the connection string or in the WHERE clause condition. If not specified, the Id of the first user from the Users table will be used.
For example, the following query is processed server side by the Google Directory APIs:
SELECT * FROM VerificationCodes
| Name | Type | Description |
| UserId | String | The unique ID of the user. |
| VerificationCode | String | A current verification code for the user. |
| Etag | String | Etag of the resource. |
ストアドプロシージャはファンクションライクなインターフェースで、Google Directory の単純なSELECT/INSERT/UPDATE/DELETE 処理にとどまらずCloud の機能を拡張します。
ストアドプロシージャは、パラメータのリストを受け取り、目的の機能を実行し、プロシージャが成功したか失敗したかを示すとともにGoogle Directory から関連するレスポンスデータを返します。
| Name | Description |
| ChangeAdminStatus | Change the admin status of a user. |
| GenerateVerificationCodes | Generate verification codes for a user. |
| InvalidateVerificationCodes | Invalidate verification codes for a user. |
Change the admin status of a user.
| Name | Type | Description |
| UserId | String | Id of the user. The value can be the user's primary email address, alias email address, or unique user ID. |
| Status | String | New admin status of the user. |
Generate verification codes for a user.
| Name | Type | Description |
| UserId | String | Id of the user. |
Invalidate verification codes for a user.
| Name | Type | Description |
| UserId | String | Id of the user. |
このセクションで説明されているシステムテーブルをクエリして、スキーマ情報、データソース機能に関する情報、およびバッチ操作の統計にアクセスできます。
以下のテーブルは、Google Directory のデータベースメタデータを返します。
以下のテーブルは、データソースへの接続方法およびクエリ方法についての情報を返します。
次のテーブルは、データ変更クエリのクエリ統計を返します。
利用可能なデータベースをリストします。
次のクエリは、接続文字列で決定されるすべてのデータベースを取得します。
SELECT * FROM sys_catalogs
| Name | Type | Description |
| CatalogName | String | データベース名。 |
利用可能なスキーマをリストします。
次のクエリは、すべての利用可能なスキーマを取得します。
SELECT * FROM sys_schemas
| Name | Type | Description |
| CatalogName | String | データベース名。 |
| SchemaName | String | スキーマ名。 |
利用可能なテーブルをリストします。
次のクエリは、利用可能なテーブルおよびビューを取得します。
SELECT * FROM sys_tables
| Name | Type | Description |
| CatalogName | String | テーブルまたはビューを含むデータベース。 |
| SchemaName | String | テーブルまたはビューを含むスキーマ。 |
| TableName | String | テーブル名またはビュー名。 |
| TableType | String | テーブルの種類（テーブルまたはビュー）。 |
| Description | String | テーブルまたはビューの説明。 |
| IsUpdateable | Boolean | テーブルが更新可能かどうか。 |
利用可能なテーブルおよびビューのカラムについて説明します。
次のクエリは、Group テーブルのカラムとデータ型を返します。
SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Group'
| 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 が含まれます。 |
利用可能なストアドプロシージャをリストします。
次のクエリは、利用可能なストアドプロシージャを取得します。
SELECT * FROM sys_procedures
| Name | Type | Description |
| CatalogName | String | ストアドプロシージャを含むデータベース。 |
| SchemaName | String | ストアドプロシージャを含むスキーマ。 |
| ProcedureName | String | ストアドプロシージャの名前。 |
| Description | String | ストアドプロシージャの説明。 |
| ProcedureType | String | PROCEDURE やFUNCTION などのプロシージャのタイプ。 |
ストアドプロシージャパラメータについて説明します。
次のクエリは、RefreshOAuthAccessToken ストアドプロシージャのすべての入力パラメータについての情報を返します。
SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'RefreshOAuthAccessToken' AND Direction = 1 OR Direction = 2
パラメータに加えて結果セットのカラムを含めるには、IncludeResultColumns 擬似カラムをTrue に設定します。
SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'RefreshOAuthAccessToken' AND IncludeResultColumns='True'
| 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 | プロシージャがネイティブのGoogle Directory プロシージャではなく、CData によって追加 / 実装されているかどうか。 |
| Name | Type | Description |
| IncludeResultColumns | Boolean | 出力にパラメータに加えて結果セットのカラムを含めるかどうか。デフォルトはFalse です。 |
主キーおよび外部キーについて説明します。
次のクエリは、Group テーブルの主キーを取得します。
SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Group'
| Name | Type | Description |
| CatalogName | String | キーを含むデータベースの名前。 |
| SchemaName | String | キーを含むスキーマの名前。 |
| TableName | String | キーを含むテーブルの名前。 |
| ColumnName | String | キーカラムの名前 |
| IsKey | Boolean | カラムがTableName フィールドで参照されるテーブル内の主キーかどうか。 |
| IsForeignKey | Boolean | カラムがTableName フィールドで参照される外部キーかどうか。 |
| PrimaryKeyName | String | 主キーの名前。 |
| ForeignKeyName | String | 外部キーの名前。 |
| ReferencedCatalogName | String | 主キーを含むデータベース。 |
| ReferencedSchemaName | String | 主キーを含むスキーマ。 |
| ReferencedTableName | String | 主キーを含むテーブル。 |
| ReferencedColumnName | String | 主キーのカラム名。 |
外部キーについて説明します。
次のクエリは、他のテーブルを参照するすべての外部キーを取得します。
SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
| 名前 | タイプ | 説明 |
| CatalogName | String | キーを含むデータベースの名前。 |
| SchemaName | String | キーを含むスキーマの名前。 |
| TableName | String | キーを含むテーブルの名前。 |
| ColumnName | String | キーカラムの名前 |
| PrimaryKeyName | String | 主キーの名前。 |
| ForeignKeyName | String | 外部キーの名前。 |
| ReferencedCatalogName | String | 主キーを含むデータベース。 |
| ReferencedSchemaName | String | 主キーを含むスキーマ。 |
| ReferencedTableName | String | 主キーを含むテーブル。 |
| ReferencedColumnName | String | 主キーのカラム名。 |
| ForeignKeyType | String | 外部キーがインポート（他のテーブルを指す）キーかエクスポート（他のテーブルから参照される）キーかを指定します。 |
主キーについて説明します。
次のクエリは、すべてのテーブルとビューから主キーを取得します。
SELECT * FROM sys_primarykeys
| Name | Type | Description |
| CatalogName | String | キーを含むデータベースの名前。 |
| SchemaName | String | キーを含むスキーマの名前。 |
| TableName | String | キーを含むテーブルの名前。 |
| ColumnName | String | キーカラムの名前。 |
| KeySeq | String | 主キーのシーケンス番号。 |
| KeyName | String | 主キーの名前。 |
利用可能なインデックスについて説明します。インデックスをフィルタリングすることで、より高速なクエリ応答時間でセレクティブクエリを記述できます。
次のクエリは、主キーでないすべてのインデックスを取得します。
SELECT * FROM sys_indexes WHERE IsPrimary='false'
| Name | Type | Description |
| CatalogName | String | インデックスを含むデータベースの名前。 |
| SchemaName | String | インデックスを含むスキーマの名前。 |
| TableName | String | インデックスを含むテーブルの名前。 |
| IndexName | String | インデックス名。 |
| ColumnName | String | インデックスに関連付けられたカラムの名前。 |
| IsUnique | Boolean | インデックスが固有の場合はTrue。そうでない場合はFalse。 |
| IsPrimary | Boolean | インデックスが主キーの場合はTrue。そうでない場合はFalse。 |
| Type | Int16 | インデックスタイプに対応する整数値：statistic (0)、clustered (1)、hashed (2)、またはother (3)。 |
| SortOrder | String | 並べ替え順序：A が昇順、D が降順。 |
| OrdinalPosition | Int16 | インデックスのカラムのシーケンスナンバー。 |
利用可能な接続プロパティと、接続文字列に設定されている接続プロパティに関する情報を返します。
次のクエリは、接続文字列に設定されている、あるいはデフォルト値で設定されているすべての接続プロパティを取得します。
SELECT * FROM sys_connection_props WHERE Value <> ''
| Name | Type | Description |
| Name | String | 接続プロパティ名。 |
| ShortDescription | String | 簡単な説明。 |
| Type | String | 接続プロパティのデータ型。 |
| Default | String | 明示的に設定されていない場合のデフォルト値。 |
| Values | String | 可能な値のカンマ区切りリスト。別な値が指定されていると、検証エラーがスローされます。 |
| Value | String | 設定した値またはあらかじめ設定されたデフォルト。 |
| Required | Boolean | プロパティが接続に必要かどうか。 |
| Category | String | 接続プロパティのカテゴリ。 |
| IsSessionProperty | String | プロパティが、現在の接続に関する情報を保存するために使用されるセッションプロパティかどうか。 |
| Sensitivity | String | プロパティの機密度。これは、プロパティがロギングおよび認証フォームで難読化されているかどうかを通知します。 |
| PropertyName | String | キャメルケースの短縮形の接続プロパティ名。 |
| Ordinal | Int32 | パラメータのインデックス。 |
| CatOrdinal | Int32 | パラメータカテゴリのインデックス。 |
| Hierarchy | String | このプロパティと一緒に設定する必要がある、関連のある依存プロパティを表示します。 |
| Visible | Boolean | プロパティが接続UI に表示されるかどうかを通知します。 |
| ETC | String | プロパティに関するその他のさまざまな情報。 |
Cloud がデータソースにオフロードできるSELECT クエリ処理について説明します。
SQL 構文の詳細については、SQL 準拠 を参照してください。
以下はSQL 機能のサンプルデータセットです。 SELECT 機能のいくつかの側面がサポートされている場合には、カンマ区切りのリストで返されます。サポートされていない場合、カラムにはNO が入ります。
| 名前 | 説明 | 有効な値 |
| AGGREGATE_FUNCTIONS | サポートされている集計関数。 | AVG, COUNT, MAX, MIN, SUM, DISTINCT |
| COUNT | COUNT 関数がサポートされているかどうか。 | YES, NO |
| IDENTIFIER_QUOTE_OPEN_CHAR | 識別子をエスケープするための開始文字。 | [ |
| IDENTIFIER_QUOTE_CLOSE_CHAR | 識別子をエスケープするための終了文字。 | ] |
| SUPPORTED_OPERATORS | サポートされているSQL 演算子。 | =, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR |
| GROUP_BY | GROUP BY がサポートされているかどうか。サポートされている場合、どのレベルでサポートされているか。 | NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE |
| OJ_CAPABILITIES | サポートされている外部結合の種類。 | NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS |
| OUTER_JOINS | 外部結合がサポートされているかどうか。 | YES, NO |
| SUBQUERIES | サブクエリがサポートされているかどうか。サポートされていれば、どのレベルでサポートされているか。 | NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED |
| STRING_FUNCTIONS | サポートされている文字列関数。 | LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE |
| NUMERIC_FUNCTIONS | サポートされている数値関数。 | ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE |
| TIMEDATE_FUNCTIONS | サポートされている日付および時刻関数。 | NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT |
| REPLICATION_SKIP_TABLES | レプリケーション中にスキップされたテーブルを示します。 | |
| REPLICATION_TIMECHECK_COLUMNS | レプリケーション中に更新判断のカラムとして使用するかどうかを、（指定された順に）チェックするカラムのリストを含む文字列の配列。 | |
| IDENTIFIER_PATTERN | 識別子としてどの文字列が有効かを示す文字列値。 | |
| SUPPORT_TRANSACTION | プロバイダーが、コミットやロールバックなどのトランザクションをサポートしているかどうかを示します。 | YES, NO |
| DIALECT | 使用するSQL ダイアレクトを示します。 | |
| KEY_PROPERTIES | Uniform データベースを特定するプロパティを示します。 | |
| SUPPORTS_MULTIPLE_SCHEMAS | プロバイダー用に複数のスキームが存在するかどうかを示します。 | YES, NO |
| SUPPORTS_MULTIPLE_CATALOGS | プロバイダー用に複数のカタログが存在するかどうかを示します。 | YES, NO |
| DATASYNCVERSION | このドライバーにアクセスするために必要な、CData Sync のバージョン。 | Standard, Starter, Professional, Enterprise |
| DATASYNCCATEGORY | このドライバーのCData Sync カテゴリ。 | Source, Destination, Cloud Destination |
| SUPPORTSENHANCEDSQL | API で提供されている以上の、追加SQL 機能がサポートされているかどうか。 | TRUE, FALSE |
| SUPPORTS_BATCH_OPERATIONS | バッチ操作がサポートされているかどうか。 | YES, NO |
| SQL_CAP | このドライバーでサポートされているすべてのSQL 機能。 | SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX |
| PREFERRED_CACHE_OPTIONS | 使用したいcacheOptions を指定する文字列値。 | |
| ENABLE_EF_ADVANCED_QUERY | ドライバーがEntity Framework の高度なクエリをサポートしているかどうかを示します。サポートしていなければ、クエリはクライアントサイドで処理されます。 | YES, NO |
| PSEUDO_COLUMNS | 利用可能な疑似カラムを示す文字列の配列。 | |
| MERGE_ALWAYS | 値がtrue であれば、CData Sync 内でMerge Model が強制的に実行されます。 | TRUE, FALSE |
| REPLICATION_MIN_DATE_QUERY | レプリケート開始日時を返すSELECT クエリ。 | |
| REPLICATION_MIN_FUNCTION | サーバーサイドでmin を実行するために使用する式名を、プロバイダーが指定できるようになります。 | |
| REPLICATION_START_DATE | レプリケート開始日を、プロバイダーが指定できるようになります。 | |
| REPLICATION_MAX_DATE_QUERY | レプリケート終了日時を返すSELECT クエリ。 | |
| REPLICATION_MAX_FUNCTION | サーバーサイドでmax を実行するために使用する式名を、プロバイダーが指定できるようになります。 | |
| IGNORE_INTERVALS_ON_INITIAL_REPLICATE | 初回のレプリケートで、レプリケートをチャンクに分割しないテーブルのリスト。 | |
| CHECKCACHE_USE_PARENTID | CheckCache 構文を親キーカラムに対して実行するかどうかを示します。 | TRUE, FALSE |
| CREATE_SCHEMA_PROCEDURES | スキーマファイルの生成に使用できる、ストアドプロシージャを示します。 |
次のクエリは、WHERE 句で使用できる演算子を取得します。
SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'
WHERE 句では、個々のテーブルの制限や要件が異なる場合がありますので注意してください。詳しくは、データモデル セクションを参照してください。
| Name | Type | Description |
| NAME | String | SQL 構文のコンポーネント、またはサーバー上で処理できる機能。 |
| VALUE | String | サポートされるSQL またはSQL 構文の詳細。 |
試行された変更に関する情報を返します。
次のクエリは、バッチ処理で変更された行のId を取得します。
SELECT * FROM sys_identity
| Name | Type | Description |
| Id | String | データ変更処理から返された、データベース生成Id。 |
| Batch | String | バッチの識別子。1 は単一処理。 |
| Operation | String | バッチ内の処理の結果：INSERTED、UPDATED、またはDELETED。 |
| Message | String | SUCCESS、またはバッチ内の更新が失敗した場合のエラーメッセージ。 |
利用可能なシステム情報を説明します。
次のクエリは、すべてのカラムを取得します。
SELECT * FROM sys_information
| Name | Type | Description |
| Product | String | 製品名。 |
| Version | String | 製品のバージョン番号。 |
| Datasource | String | 製品が接続するデータソースの名前。 |
| NodeId | String | 製品がインストールされているマシンの固有識別子。 |
| HelpURL | String | 製品のヘルプドキュメントのURL。 |
| License | String | 製品のライセンス情報。（この情報が利用できない場合、この項目は空白のままか「N/A」と表示されます。） |
| Location | String | 製品のライブラリが格納されているファイルパスの場所。 |
| Environment | String | 製品が現在稼働している環境またはランタイムのバージョン。 |
| DataSyncVersion | String | 本コネクタを使用するために必要なCData Sync のティア。 |
| DataSyncCategory | String | CData Sync 機能のカテゴリ（例：Source、Destination）。 |
| プロパティ | 説明 |
| AuthScheme | Google Directory への接続に使用する認証方法を指定します。 |
| プロパティ | 説明 |
| OAuthClientId | カスタムOAuth アプリケーションに割り当てられたクライアントID（コンシューマーキーとも呼ばれます）を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。 |
| OAuthClientSecret | カスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。（カスタムOAuth アプリケーションのみ） |
| DelegatedServiceAccounts | 委任されたリクエストのためのサービスアカウントE メールをスペース区切りで指定します。 |
| RequestingServiceAccount | 委任されたリクエストを行うためのサービスアカウントのE メールを指定します。 |
| Scope | データへの適切なアクセスを確実にするために、認証ユーザーのアプリケーションへのアクセス範囲を指定します。 カスタムOAuth アプリケーションが必要な場合は、通常、アプリケーションの作成時に指定します。 |
| プロパティ | 説明 |
| OAuthJWTCert | クライアント証明書のJWT 証明書ストアの名前を指定します。 |
| OAuthJWTCertType | JWT 証明書を格納しているキーストアの種類を指定します。 |
| OAuthJWTCertPassword | パスワードで保護された証明書ストアにアクセスするために使用されるOAuth JWT 証明書のパスワードを指定します。証明書ストアがパスワードを必要としない場合は、このプロパティを空白のままにします。 |
| OAuthJWTCertSubject | ストアで一致する証明書を検索するために使用される、OAuth JWT 証明書のサブジェクトを指定します。部分一致と、先頭の証明書を選択するためのワイルドカード '*' をサポートします。 |
| OAuthJWTIssuer | Java Web Token の発行者。 |
| OAuthJWTSubject | アプリケーションからデリゲートアクセスの要求対象となるユーザーサブジェクト。 |
| プロパティ | 説明 |
| SSLServerCert | TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。 |
| プロパティ | 説明 |
| Verbosity | ログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。 |
| プロパティ | 説明 |
| BrowsableSchemas | レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
| プロパティ | 説明 |
| AWSWorkloadIdentityConfig | AWS 経由でWorkload Identity Federation を使用する場合に指定する設定プロパティ。 |
| AzureWorkloadIdentityConfig | Azure 経由でWorkload Identity Federation を使用する場合に指定する設定プロパティ。 |
| CustomerId | Restrict query results to this customer. |
| Domain | Restrict queries to this domain. |
| GroupId | Restrict query results to this group. |
| MaxRows | 集計やGROUP BY を含まないクエリで返される最大行数を指定します。 |
| Pagesize | provider がGoogle Directory にデータをリクエストするときに返す、ページあたりの最大レコード数を指定します。 |
| PseudoColumns | テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。 |
| Timeout | provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。 |
| UserId | Restrict query results to this user. |
| WorkloadPoolId | Workload Identity Federation プールのID。 |
| WorkloadProjectId | Workload Identity Federation プールをホストするGoogle Cloud プロジェクトのID。 |
| WorkloadProviderId | Workload Identity Federation プールプロバイダーのID。 |
このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。
| プロパティ | 説明 |
| AuthScheme | Google Directory への接続に使用する認証方法を指定します。 |
Google Directory への接続に使用する認証方法を指定します。
string
"OAuth"
このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。
| プロパティ | 説明 |
| OAuthClientId | カスタムOAuth アプリケーションに割り当てられたクライアントID（コンシューマーキーとも呼ばれます）を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。 |
| OAuthClientSecret | カスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。（カスタムOAuth アプリケーションのみ） |
| DelegatedServiceAccounts | 委任されたリクエストのためのサービスアカウントE メールをスペース区切りで指定します。 |
| RequestingServiceAccount | 委任されたリクエストを行うためのサービスアカウントのE メールを指定します。 |
| Scope | データへの適切なアクセスを確実にするために、認証ユーザーのアプリケーションへのアクセス範囲を指定します。 カスタムOAuth アプリケーションが必要な場合は、通常、アプリケーションの作成時に指定します。 |
カスタムOAuth アプリケーションに割り当てられたクライアントID（コンシューマーキーとも呼ばれます）を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。
string
""
このプロパティは2つのケースで必要となります：
（ドライバーが埋め込みOAuth 資格情報を提供する場合、この値はすでにCloud によって設定されており、手動で入力する必要がないことがあります。）
OAuthClientId は、認証付きの接続を構成する際に、OAuthClientSecret やOAuthSettingsLocation などの他のOAuth 関連プロパティと一緒に使用されるのが一般的です。
OAuthClientId は、ユーザーがOAuth 経由で認証を行う前に設定する必要がある、主要な接続パラメータの1つです。 この値は、通常、ID プロバイダーのアプリケーション登録設定で確認できます。 Client ID、Application ID、Consumer Key などとラベル付けされた項目を探してください。
クライアントID は、クライアントシークレットのような機密情報とは見なされませんが、アプリケーションの識別情報の一部であるため、慎重に取り扱う必要があります。公開リポジトリや共有設定ファイルでこの値を露出させないようにしてください。
接続設定時にこのプロパティを使用する方法の詳細については、接続の確立 を参照してください。
カスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。（カスタムOAuth アプリケーションのみ）
string
""
このプロパティ（アプリケーションシークレットまたはコンシューマシークレットとも呼ばれます）は、安全なクライアント認証を必要とするすべてのフローでカスタムOAuth アプリケーションを使用する場合に必要です。たとえば、Web ベースのOAuth、サービスベースの接続、証明書ベースの認可フローなどが該当します。 組み込みOAuth アプリケーションを使用する場合は必要ありません。
クライアントシークレットは、OAuth フローのトークン交換ステップで使用されます。このステップでは、ドライバーが認可サーバーにアクセストークンを要求します。 この値が欠落しているか正しくない場合、認証はinvalid_client またはunauthorized_client エラーで失敗します。
OAuthClientSecret は、ユーザーがOAuth 経由で認証を行う前に設定する必要がある、主要な接続パラメータの1つです。この値は、OAuth アプリケーションを登録する際にID プロバイダーから取得できます。
Notes：
接続設定時にこのプロパティを使用する方法の詳細については、接続の確立 を参照してください。
委任されたリクエストのためのサービスアカウントE メールをスペース区切りで指定します。
string
""
サービスアカウントE メールは、スペース区切りのリストで指定する必要があります。
各サービスアカウントは、チェーン内の次のサービスアカウントのroles/iam.serviceAccountTokenCreator ロールを付与されている必要があります。
チェーンの最後のサービスアカウントは、リクエストするサービスアカウントのroles/iam.serviceAccountTokenCreator ロールが付与されている必要があります。 リクエストするサービスアカウントはRequestingServiceAccount プロパティで指定されたものです。
委任されたリクエストの場合、リクエストするサービスアカウントは、iam.serviceAccounts.getAccessToken 権限を持つ必要があることに注意してください。これは、serviceAccountTokenCreator ロールを介して付与することもできます。
委任されたリクエストを行うためのサービスアカウントのE メールを指定します。
string
""
委任されたリクエストで認証情報が要求されたアカウントのサービスアカウントのE メール。DelegatedServiceAccounts の委任されたサービスアカウントのリストを用いて、このプロパティは、委任されたリクエストを行うために使用されます。
このサービスアカウントには、IAM 権限iam.serviceAccounts.getAccessToken が必要です。
データへの適切なアクセスを確実にするために、認証ユーザーのアプリケーションへのアクセス範囲を指定します。 カスタムOAuth アプリケーションが必要な場合は、通常、アプリケーションの作成時に指定します。
string
""
スコープは、認証ユーザーがどのようなアクセス権を持つかを定義するために設定されます。例えば、読み取り、読み取りと書き込み、機密情報への制限付きアクセスなどです。システム管理者は、スコープを使用して機能またはセキュリティクリアランスによるアクセスを選択的に有効化できます。
InitiateOAuth がGETANDREFRESH に設定されている場合、要求するスコープを変更したい場合はこのプロパティを使用する必要があります。
InitiateOAuth がREFRESH またはOFF のいずれかに設定されている場合、このプロパティまたはScope 入力を使用して、要求するスコープを変更できます。
このセクションでは、本プロバイダーの接続文字列で設定可能なJWT OAuth プロパティの全リストを提供します。
| プロパティ | 説明 |
| OAuthJWTCert | クライアント証明書のJWT 証明書ストアの名前を指定します。 |
| OAuthJWTCertType | JWT 証明書を格納しているキーストアの種類を指定します。 |
| OAuthJWTCertPassword | パスワードで保護された証明書ストアにアクセスするために使用されるOAuth JWT 証明書のパスワードを指定します。証明書ストアがパスワードを必要としない場合は、このプロパティを空白のままにします。 |
| OAuthJWTCertSubject | ストアで一致する証明書を検索するために使用される、OAuth JWT 証明書のサブジェクトを指定します。部分一致と、先頭の証明書を選択するためのワイルドカード '*' をサポートします。 |
| OAuthJWTIssuer | Java Web Token の発行者。 |
| OAuthJWTSubject | アプリケーションからデリゲートアクセスの要求対象となるユーザーサブジェクト。 |
クライアント証明書のJWT 証明書ストアの名前を指定します。
string
""
OAuthJWTCertType フィールドは、OAuthJWTCert により指定された証明書ストアの種類を指定します。 ストアがパスワードで保護されている場合は、OAuthJWTCertPassword を使用してパスワードを指定します。
OAuthJWTCert は、OAuthJWTCertSubject フィールドとともにクライアント証明書を指定するために使われます。 OAuthJWTCert に値が設定され、かつOAuthJWTCertSubject が設定されている場合、CData Cloud は証明書の検索を開始します。 詳しくは、OAuthJWTCertSubject を参照してください。
証明書ストアの指定はプラットフォームに依存します。
注記
JWT 証明書を格納しているキーストアの種類を指定します。
string
"GOOGLEJSONBLOB"
| 値 | 説明 | 注記 |
| USER | 現在のユーザーが所有する証明書ストア。 | Windows のみ使用可能です。 |
| MACHINE | マシンストア。 | Java やその他の非Windows 環境では使用できません。 |
| PFXFILE | 証明書を含むPFX（PKCS12）ファイル。 | |
| PFXBLOB | PFX（PKCS12）形式の証明書ストアをbase-64 でエンコードした文字列。 | |
| JKSFILE | 証明書を含むJava キーストア（JKS）ファイル。 | Java 専用。 |
| JKSBLOB | Java キーストア（JKS）形式の証明書ストアをbase-64 でエンコードした文字列。 | Java 専用。 |
| PEMKEY_FILE | 秘密鍵とオプションの証明書を含むPEM でエンコードされたファイル。 | |
| PEMKEY_BLOB | 秘密鍵とオプションの証明書をbase-64 でエンコードした文字列。 | |
| PUBLIC_KEY_FILE | PEM またはDER でエンコードされた公開鍵証明書を含むファイル。 | |
| PUBLIC_KEY_BLOB | PEM またはDER でエンコードされた公開鍵証明書をbase-64 でエンコードした文字列。 | |
| SSHPUBLIC_KEY_FILE | SSH 形式の公開鍵を含むファイル。 | |
| SSHPUBLIC_KEY_BLOB | SSH 形式の公開鍵ををbase-64 でエンコードした文字列。 | |
| P7BFILE | 証明書を含むPKCS7 ファイル。 | |
| PPKFILE | PuTTY 秘密キー（PPK）を含むファイル。 | |
| XMLFILE | XML 形式の証明書を含むファイル。 | |
| XMLBLOB | XML 形式の証明書を含む文字列。 | |
| BCFKSFILE | Bouncy Castle キーストアを含むファイル。 | |
| BCFKSBLOB | Bouncy Castle キーストアを含む文字列（base-64エンコード）。 | |
| GOOGLEJSON | サービスアカウント情報を含むJSON ファイル。 | Google サービスに接続する場合にのみ有効。 |
| GOOGLEJSONBLOB | サービスアカウントのJSON を含む文字列。 | Google サービスに接続する場合にのみ有効。 |
パスワードで保護された証明書ストアにアクセスするために使用されるOAuth JWT 証明書のパスワードを指定します。証明書ストアがパスワードを必要としない場合は、このプロパティを空白のままにします。
string
""
このプロパティは、パスワードで保護された証明書ストアを開くために必要なパスワードを指定します。 パスワードが必要かどうかを判断するには、ご利用の証明書ストアのドキュメントまたは設定を参照してください。
GOOGLEJSON OAuthJWTCertType を使用する場合は必要ありません。Google JSON キーは暗号化されていません。
ストアで一致する証明書を検索するために使用される、OAuth JWT 証明書のサブジェクトを指定します。部分一致と、先頭の証明書を選択するためのワイルドカード '*' をサポートします。
string
"*"
このプロパティの値は、ストアで一致する証明書を検索するために使用されます。検索プロセスは以下のように動作します。
値を '*' に設定すると、ストアの先頭の証明書が自動的に選択されます。 証明書のサブジェクトは識別名フィールドおよび値のカンマ区切りのリストです。 例：CN=www.server.com, OU=test, C=US, [email protected]。
一般的なフィールドには以下のものが含まれます。
| フィールド | 説明 |
| CN | 共通名。一般的には、www.server.com のようなホスト名です。 |
| O | 法人名 |
| OU | 法人の部署名 |
| L | 法人の住所（市町村名） |
| S | 法人の住所（都道府県） |
| C | 国名 |
| E | E メールアドレス |
フィールド値にカンマが含まれる場合は、引用符で囲んでください。例："O=ACME, Inc."。
Java Web Token の発行者。
string
""
Java Web Token の発行者。 サービスアカウントのE メールアドレスの値を入力します。
GOOGLEJSON OAuthJWTCertType を使用する場合は必要ありません。Google JSON キーには、発行者アカウントのコピーが含まれています。
アプリケーションからデリゲートアクセスの要求対象となるユーザーサブジェクト。
string
""
アプリケーションからデリゲートアクセスの要求対象となるユーザーサブジェクトです。 アプリケーションが委任されたアクセスをリクエストするユーザーのE メールアドレスを入力します。
このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。
| プロパティ | 説明 |
| SSLServerCert | TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。 |
TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。
string
""
TLS/SSL 接続を使用している場合は、このプロパティを使用して、サーバーが受け入れるTLS/SSL 証明書を指定できます。このプロパティに値を指定すると、マシンによって信頼されていない他の証明書はすべて拒否されます。
このプロパティは、次のフォームを取ります：
| 説明 | 例 |
| フルPEM 証明書（例では省略されています） | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
| 証明書を保有するローカルファイルへのパス。 | C:\cert.cer |
| 公開鍵（例では省略されています） | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
| MD5 Thumbprint（hex 値はスペースまたはコロン区切り） | ecadbdda5a1529c58a1e9e09828d70e4 |
| SHA1 Thumbprint（hex 値はスペースまたはコロン区切り） | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
Note：'*' を使用してすべての証明書を受け入れるように指定することも可能ですが、セキュリティ上の懸念があるため推奨されません。
このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。
| プロパティ | 説明 |
| Verbosity | ログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。 |
ログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。
string
"1"
このプロパティは、Cloud がログファイルに含める詳細レベルを定義します。 Verbosity レベルを高くするとログに記録される情報の詳細が増えますが、ログファイルが大きくなり取り込まれるデータが増えるためパフォーマンスが低下する可能性があります。
デフォルトのVerbosity レベルは1で、通常の運用にはこれが推奨されます。 より高いVerbosity レベルは主にデバッグを目的としています。 各レベルの詳細については、ログ を参照してください。
LogModules プロパティと組み合わせることで、Verbosity は特定の情報カテゴリに対するログの詳細度を調整できます。
このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。
| プロパティ | 説明 |
| BrowsableSchemas | レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
string
""
利用可能なデータベーススキーマをすべてリストすると余分な時間がかかり、パフォーマンスが低下します。 接続文字列にスキーマのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。
このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。
| プロパティ | 説明 |
| AWSWorkloadIdentityConfig | AWS 経由でWorkload Identity Federation を使用する場合に指定する設定プロパティ。 |
| AzureWorkloadIdentityConfig | Azure 経由でWorkload Identity Federation を使用する場合に指定する設定プロパティ。 |
| CustomerId | Restrict query results to this customer. |
| Domain | Restrict queries to this domain. |
| GroupId | Restrict query results to this group. |
| MaxRows | 集計やGROUP BY を含まないクエリで返される最大行数を指定します。 |
| Pagesize | provider がGoogle Directory にデータをリクエストするときに返す、ページあたりの最大レコード数を指定します。 |
| PseudoColumns | テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。 |
| Timeout | provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。 |
| UserId | Restrict query results to this user. |
| WorkloadPoolId | Workload Identity Federation プールのID。 |
| WorkloadProjectId | Workload Identity Federation プールをホストするGoogle Cloud プロジェクトのID。 |
| WorkloadProviderId | Workload Identity Federation プールプロバイダーのID。 |
AWS 経由でWorkload Identity Federation を使用する場合に指定する設定プロパティ。
string
""
このプロパティは、Key=Value プロパティのセミコロン区切りリストとしてフォーマットされ、値はオプションで引用符で囲むこともできます。
例えば、この設定はユーザーのルートキーを使用してAWS で認証します：
AWSWorkloadIdentityConfig="AuthScheme=AwsRootKeys;AccessKey='AKIAABCDEF123456';SecretKey=...;Region=us-east-1"
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;"
Restrict query results to this customer.
string
"my_customer"
This property can be set in the connection string or query. Otherwise, the Cloud will use the Customer Id of the authenticated user. You can also get this value from the Users table.
Restrict queries to this domain.
string
""
The domain name (e.g., cdata.com). Use this connection property to get results from only one domain.
Restrict query results to this group.
string
""
This property must be set in the connection string or query. Otherwise, the Cloud will use the first found Group Id. You can get this value from the Groups table.
集計やGROUP BY を含まないクエリで返される最大行数を指定します。
int
-1
このプロパティのデフォルト値である-1 は、クエリに明示的にLIMIT 句が含まれていない限り、行の制限が適用されないことを意味します。 （クエリにLIMIT 句が含まれている場合、クエリで指定された値がMaxRows 設定よりも優先されます。）
MaxRows を0より大きい整数に設定することで、クエリがデフォルトで過度に大きな結果セットを返さないようにします。
このプロパティは、非常に大きなデータセットを返す可能性のあるクエリを実行する際に、パフォーマンスを最適化し、過剰なリソース消費を防ぐのに役立ちます。
provider がGoogle Directory にデータをリクエストするときに返す、ページあたりの最大レコード数を指定します。
int
100
クエリを処理する際、Google Directory でクエリされたデータすべてを一度にリクエストする代わりに、Cloud はクエリされたデータをページと呼ばれる部分ごとにリクエストすることができます。
この接続プロパティは、Cloud がページごとにリクエストする結果の最大数を決定します。
Note：大きなページサイズを設定すると全体的なクエリ実行時間が短縮される可能性がありますが、その場合、クエリ実行時にCloud がより多くのメモリを使用することになり、タイムアウトが発生するリスクがあります。
テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。
string
""
このプロパティを使用すると、Cloud がテーブルカラムとして公開する擬似カラムを定義できます。
個々の擬似カラムを指定するには、以下の形式を使用します。
Table1=Column1;Table1=Column2;Table2=Column3
すべてのテーブルのすべての擬似カラムを含めるには、次を使用してください：
*=*
provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。
int
60
タイムアウトは、クエリや操作全体ではなくサーバーとの個々の通信に適用されます。 例えば、各ページング呼び出しがタイムアウト制限内に完了する場合、クエリは60秒を超えて実行を続けることができます。
タイムアウトはデフォルトで60秒に設定されています。タイムアウトを無効にするには、このプロパティを0に設定します。
タイムアウトを無効にすると、操作が成功するか、サーバー側のタイムアウト、ネットワークの中断、またはサーバーのリソース制限などの他の条件で失敗するまで無期限に実行されます。
Note： このプロパティは慎重に使用してください。長時間実行される操作がパフォーマンスを低下させたり、応答しなくなる可能性があるためです。
Restrict query results to this user.
string
""
The Id of the user. If not specified, the first user from the Users table will be used.
Workload Identity Federation プールのID。
string
""
Workload Identity Federation プールのID。
Workload Identity Federation プールをホストするGoogle Cloud プロジェクトのID。
string
""
Workload Identity Federation プールをホストするGoogle Cloud プロジェクトのID。
Workload Identity Federation プールプロバイダーのID。
string
""
Workload Identity Federation プールプロバイダーのID。
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.