Cloud

Build 24.0.9175
  • Microsoft Dataverse
    • はじめに
      • 接続の確立
      • SSL の設定
      • ファイアウォールとプロキシ
    • データモデル
      • エンティティデータモデル
        • ビュー
          • MultiSelectPickListAttributeMetaData
          • MultiSelectPickListOptions
          • PickListAttributeMetaData
          • PickListOptions
          • StateAttributeMetadata
          • StateAttributeOptions
          • StatusAttributeMetadata
          • StatusAttributeOptions
        • ストアドプロシージャ
      • システムデータモデル
        • ストアドプロシージャ
          • CreateAssociation
          • ListAssociations
          • ListNavigationProperties
          • RemoveAssociation
      • システムテーブル
        • 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
        • OrganizationURL
        • ApiVersion
      • Azure Authentication
        • AzureTenant
        • AzureEnvironment
      • OAuth
        • OAuthClientId
        • OAuthClientSecret
        • OAuthGrantType
      • JWT OAuth
        • OAuthJWTCert
        • OAuthJWTCertType
        • OAuthJWTCertPassword
        • OAuthJWTCertSubject
      • SSL
        • SSLServerCert
      • Logging
        • Verbosity
      • Schema
        • BrowsableSchemas
        • Schema
      • Miscellaneous
        • ContinueOnError
        • IncludeFormattedValues
        • IncludeLookUpLogicalName
        • IncludeNavigationKeys
        • IncludeNavigationProperties
        • MaxRows
        • PseudoColumns
        • Timeout
        • UseDisplayNames

Microsoft Dataverse - CData Cloud

概要

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

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

主要機能

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

CData Cloud

はじめに

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

Microsoft Dataverse への接続

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

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

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

CData Cloud

接続の確立

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

スキーマ

Microsoft Dataverse はスキーマ値として'System' および'Entities' をサポートしており、Schema プロパティを使用して設定することができます。

Schema プロパティに'System' を使用すると、Web API を使用してエンティティ / テーブルをクエリします。

Schema プロパティに'Entities' を使用すると、EntityDefinitions エンティティセットパスを使用して、EntityMetadata EntityType エンティティ / テーブルに関する情報を取得します。これによって、よりユーザーフレンドリーな名前になることが多いですが、追加のメタデータリクエストが必要になります。

Microsoft Dataverse への接続

Microsoft Dataverse データソースを認証するには、まずOrganizationUrl をhttps://[organization].crm.dynamics.com のような接続先の組織のURL に設定する必要があります。

Azure AD

Azure AD は、OAuth を使用して認証する接続タイプです。OAuth では認証するユーザーにインターネットブラウザでMicrosoft Dataverse との通信を要求します。下記で説明するとおり、Cloud はさまざまな方法でこれをサポートします。 AuthScheme をAzureAD に設定します。以下のAzure AD フローは、すでに設定済みであることを前提として書かれています。

クライアントクレデンシャル

クライアント資格情報は、直接ユーザー認証が行われないOAuth のフローを指します。代わりに、資格情報はアプリ自体のためだけに作成されます。 アプリで実行されるすべてのタスクは、デフォルトユーザーコンテキストなしで実行されます。そのため、認証フローが標準とは少し違ったものになります。

クライアントOAuth フロー

クライアントOAuth フローに関連するすべての権限には、管理者の同意が必要です。これは、CData Cloud が埋め込まれたアプリをクライアントOAuth フローでは使用できないことを意味します。クライアント資格情報を使用するには、独自のOAuth アプリの作成が必要になります。 詳しくは、Azure AD アプリケーションの作成 を参照してください。

portal.azure.com の[アプリの登録]で[API のアクセス許可]に移動し、Microsoft Graph アクセス許可を選択します。アクセス許可には、委任されたアクセス許可とアプリケーションの許可の2つの異なるアクセス許可セットがあります。 クライアントの資格情報認証時に使用されるアクセス許可は、[アプリケーションの許可]の下にあります。インテグレーションに必要なアクセス許可を選択します。

認証タイプに応じて、以下のいずれかの接続プロパティグループを設定すると、接続できるようになります。

  1. クライアントシークレット
    • InitiateOAuth:GETANDREFRESH に設定。InitiateOAuth を使うと、OAuth 交換の繰り返しや、手動でのOAuthAccessToken 設定を避けられます。
    • AzureTenant:接続するテナントに設定。
    • OAuthGrantType:CLIENT に設定。
    • OAuthClientId:アプリ設定のクライアントId に設定。
    • OAuthClientSecret:アプリ設定のクライアントシークレットに設定。
  2. 証明書
    • InitiateOAuth:GETANDREFRESH に設定。InitiateOAuth を使うと、OAuth 交換の繰り返しや、手動でのOAuthAccessToken 設定を避けられます。
    • AzureTenant:接続するテナントに設定。
    • OAuthGrantType:CLIENT に設定。
    • OAuthClientId:アプリ設定のクライアントId に設定。
    • OAuthJWTCert:JWT 証明書ストアに設定。
    • OAuthJWTCertType:OAuthJWTCert で指定された証明書ストアの種類に設定。

クライアント資格情報での認証は、他の接続同様に自動的に行われますが、ユーザーにプロンプトするウィンドウは表示されません。ユーザーコンテキストがないため、ブラウザのポップアップは必要ないからです。 接続が行われ、内部的に処理されます。

Azure サービスプリンシパル

Azure サービスプリンシパルは、ロールに基づいたアプリケーションベースの認証です。これは、認証がユーザーごとではなく、アプリケーションごとに行われることを意味します。 アプリケーションで実行されるすべてのタスクは、デフォルトユーザーコンテキストなしで、割り当てられたロールに基づいて実行されます。 リソースへのアプリケーションのアクセスは、割り当てられたロールの権限によって制御されます。

Azure サービスプリンシパル認証の設定方法については、サービスプリンシパルによるAzure AD アプリの作成 を参照してください。

Managed Service Identity (MSI)

Azure VM 上でMicrosoft Dataverse を実行しており、マネージドID(MSI)認証情報を自動的に取得して接続したい場合は、AuthScheme を AzureMSI に設定します。

User-Managed Identities

マネージドID のトークンを取得するには、OAuthClientId プロパティを使用してマネージドID のclient_id を指定します。

VM に複数のユーザーが割り当てられたマネージドID がある場合は、OAuthClientId も指定する必要があります。

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

データモデル

CData Cloud はMicrosoft Dataverse データをテーブル、ビュー、ストアドプロシージャを備えた使いやすいSQL データベースとしてモデル化します。定義は、接続先のOData サービスから動的に取得されます。サービスに再接続することで、カラムの新規追加や削除、データ型の変更など、メタデータの変更を読み込めます。

Cloud は2つのデータモデルを公開します。

  • エンティティデータモデル では、Microsoft Dataverse への接続に使用できるスキーマについて説明します。テーブルを使用して、ライブMicrosoft Dataverse データを操作できます。
  • システムデータモデル は、セキュリティ、監査、システムレベルの操作など、プラットフォームのコア機能をサポートする基本的なフレームワークを定義します。

CData Cloud が提供するストアドプロシージャを使用して、Microsoft Dataverse データの操作を自動化できます。

CData Cloud

エンティティデータモデル

Entities データモデルは、ビジネスアプリケーション内の構造化データを定義、格納、管理します。Microsoft Power Platform、Dynamics 365、および外部システムとのデータリレーションシップ、セキュリティ、自動化、統合を実現します。

ビュー

ビュー セクションには読み取り専用SQL テーブルの一覧が記載されています。これらには、Microsoft Dataverse アカウントでのアクセスを想定したサンプルが含まれています。

以下のビューはCloud に同梱されています。

テーブル 説明
MultiSelectPickListAttributeMetaData Stores metadata for attributes that support MultiSelect OptionSet, defining the structure and behavior of multi-option fields.
MultiSelectPickListOptions Contains the possible selectable options for MultiSelect OptionSet attributes, enabling multi-value selections.
PickListAttributeMetaData Holds metadata for attributes of type Picklist, describing the single-option selection fields in the system.
PickListOptions Defines the set of selectable options available for Picklist attributes, supporting user-defined field values.
StateAttributeMetadata Provides metadata for attributes of type State, describing state-related fields used for status tracking or categorization.
StateAttributeOptions Lists the selectable states available for State attributes, representing various predefined states.
StatusAttributeMetadata Contains metadata for attributes of type Status, often used to track the lifecycle or current condition of an entity.
StatusAttributeOptions Defines the set of statuses that can be assigned to Status attributes, supporting status-driven workflows.

ストアドプロシージャ

ストアドプロシージャ は、SQLクエリを介して呼び出されるアクションです。標準的なCRUD 操作だけでなく、OAuth アクセストークンの取得や更新などより高度なタスクも実行します。

CData Cloud

ビュー

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

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

CData Cloud - Microsoft Dataverse ビュー

Name Description
MultiSelectPickListAttributeMetaData Stores metadata for attributes that support MultiSelect OptionSet, defining the structure and behavior of multi-option fields.
MultiSelectPickListOptions Contains the possible selectable options for MultiSelect OptionSet attributes, enabling multi-value selections.
PickListAttributeMetaData Holds metadata for attributes of type Picklist, describing the single-option selection fields in the system.
PickListOptions Defines the set of selectable options available for Picklist attributes, supporting user-defined field values.
StateAttributeMetadata Provides metadata for attributes of type State, describing state-related fields used for status tracking or categorization.
StateAttributeOptions Lists the selectable states available for State attributes, representing various predefined states.
StatusAttributeMetadata Contains metadata for attributes of type Status, often used to track the lifecycle or current condition of an entity.
StatusAttributeOptions Defines the set of statuses that can be assigned to Status attributes, supporting status-driven workflows.

CData Cloud

MultiSelectPickListAttributeMetaData

Stores metadata for attributes that support MultiSelect OptionSet, defining the structure and behavior of multi-option fields.

ビュー固有の情報

Select

Cloud はMicrosoft Dataverse API を使用して、以下のカラムと演算子で作成されたWHERE 句条件を処理します。その他のフィルタはクライアントサイドでCloud 内部で処理されます。

  • TableName は'='、'IN' 演算子をサポートしています。

TableName でフィルタリングしない場合、Cloud は最初に見つかったテーブルの結果を返します。

例えば、次のクエリはサーバーサイドで処理されます。

SELECT * FROM MultiSelectPickListAttributeMetaData WHERE TableName = 'teams'

SELECT * FROM MultiSelectPickListAttributeMetaData WHERE TableName IN ('accounts', 'teams')

Columns

Name Type References Description
ColumnName [KEY] String The name of the column in the table where the multi-select picklist is defined.
MetadataId String The unique identifier for the metadata associated with this attribute.
OptionSet_Description_LocalizedLabels String Localized descriptions of the options in the picklist for different languages.
OptionSet_Description_UserLocalizedLabel_HasChanged String Indicates whether the user-localized description label has been modified.
OptionSet_Description_UserLocalizedLabel_IsManaged Boolean Specifies if the user-localized description label is managed (part of a managed solution).
OptionSet_Description_UserLocalizedLabel_Label String The localized label text for the option set description.
OptionSet_Description_UserLocalizedLabel_LanguageCode Integer The language code corresponding to the localized description label.
OptionSet_Description_UserLocalizedLabel_MetadataId String The unique identifier for the metadata associated with the localized description label.
OptionSet_DisplayName_LocalizedLabels String Localized display names of the picklist options for different languages.
OptionSet_DisplayName_UserLocalizedLabel_HasChanged String Indicates whether the user-localized display name label has been modified.
OptionSet_DisplayName_UserLocalizedLabel_IsManaged Boolean Specifies if the user-localized display name label is managed (part of a managed solution).
OptionSet_DisplayName_UserLocalizedLabel_Label String The localized label text for the option set display name.
OptionSet_DisplayName_UserLocalizedLabel_LanguageCode Integer The language code corresponding to the localized display name label.
OptionSet_DisplayName_UserLocalizedLabel_MetadataId String The unique identifier for the metadata associated with the localized display name label.
OptionSet_ExternalTypeName String The external type name associated with the option set, if applicable.
OptionSet_HasChanged String Indicates if the option set has been modified.
OptionSet_IntroducedVersion String The version of the system in which the option set was introduced.
OptionSet_IsCustomizable_CanBeChanged Boolean Indicates whether the option set can be customized.
OptionSet_IsCustomizable_ManagedPropertyLogicalName String The logical name of the managed property that controls the customizability of the option set.
OptionSet_IsCustomizable_Value Boolean Specifies if the option set is customizable.
OptionSet_IsCustomOptionSet Boolean Indicates whether the option set is custom or part of a managed solution.
OptionSet_IsGlobal Boolean Specifies if the option set is global (shared across entities) or local (specific to one entity).
OptionSet_IsManaged Boolean Indicates if the option set is managed (part of a managed solution).
OptionSet_MetadataId String The unique identifier for the metadata associated with the option set.
OptionSet_Name String The name of the option set.
OptionSet_OptionSetType String The type of the option set (e.g., picklist, multi-select).
OptionSet_ParentOptionSetName String The name of the parent option set, if this option set is part of a hierarchy.
TableName String The name of the table where this multi-select picklist attribute is defined.

CData Cloud

MultiSelectPickListOptions

Contains the possible selectable options for MultiSelect OptionSet attributes, enabling multi-value selections.

ビュー固有の情報

Select

Cloud はMicrosoft Dataverse API を使用して、以下のカラムと演算子で作成されたWHERE 句条件を処理します。その他のフィルタはクライアントサイドでCloud 内部で処理されます。

  • TableName は'='、'IN' 演算子をサポートしています。

TableName でフィルタリングしない場合、Cloud は最初に見つかったテーブルの結果を返します。

例えば、次のクエリはサーバーサイドで処理されます。

SELECT * FROM MultiSelectPickListOptions WHERE TableName = 'teams'

SELECT * FROM MultiSelectPickListOptions WHERE TableName IN ('accounts', 'teams')

Columns

Name Type References Description
ColumnName String

MultiSelectPickListAttributeMetaData.ColumnName

The name of the column in the table where the multi-select picklist option is defined.
Color String The color code associated with the picklist option, often used for UI display purposes.
ExternalValue String An external system value mapped to this picklist option, if applicable.
HasChanged String Indicates whether the option has been modified since its creation or last update.
IsManaged Boolean Specifies if the picklist option is managed (part of a managed solution).
Label_LocalizedLabels String Localized labels for the picklist option in different languages.
Label_UserLocalizedLabel_HasChanged String Indicates if the user-customized label for the picklist option has been modified.
Label_UserLocalizedLabel_IsManaged Boolean Specifies if the user-customized label for the picklist option is managed.
Label_UserLocalizedLabel_Label String The user-customized label text for the picklist option.
Label_UserLocalizedLabel_LanguageCode Integer The language code corresponding to the user-customized label.
Label_UserLocalizedLabel_MetadataId String The unique identifier for the metadata of the user-customized label.
Description_LocalizedLabels String Localized descriptions for the picklist option in different languages.
Description_UserLocalizedLabel_HasChanged String Indicates if the user-customized description for the picklist option has been modified.
Description_UserLocalizedLabel_IsManaged Boolean Specifies if the user-customized description for the picklist option is managed.
Description_UserLocalizedLabel_Label String The user-customized description text for the picklist option.
Description_UserLocalizedLabel_LanguageCode Integer The language code corresponding to the user-customized description.
Description_UserLocalizedLabel_MetadataId String The unique identifier for the metadata of the user-customized description.
MetadataId String The unique identifier for the metadata associated with the picklist option.
ParentValues String Specifies the parent values for hierarchical picklist options, if applicable.
Value Integer The integer value associated with this picklist option, used for storage and retrieval.
TableName String The name of the table where this picklist option is defined.

CData Cloud

PickListAttributeMetaData

Holds metadata for attributes of type Picklist, describing the single-option selection fields in the system.

ビュー固有の情報

Select

Cloud はMicrosoft Dataverse API を使用して、以下のカラムと演算子で作成されたWHERE 句条件を処理します。その他のフィルタはクライアントサイドでCloud 内部で処理されます。

  • TableName は'='、'IN' 演算子をサポートしています。

TableName でフィルタリングしない場合、Cloud は最初に見つかったテーブルの結果を返します。

例えば、次のクエリはサーバーサイドで処理されます。

SELECT * FROM PickListAttributeMetaData WHERE TableName = 'teams'

SELECT * FROM PickListAttributeMetaData WHERE TableName IN ('accounts', 'teams')

Columns

Name Type References Description
ColumnName [KEY] String The name of the column in the table where the picklist attribute is defined.
MetadataId String The unique identifier for the metadata associated with this attribute.
OptionSet_Description_LocalizedLabels String Localized descriptions of the options in the picklist for various supported languages.
OptionSet_Description_UserLocalizedLabel_HasChanged String Indicates whether the user-customized description label has been modified.
OptionSet_Description_UserLocalizedLabel_IsManaged Boolean Specifies if the user-customized description label is managed (part of a managed solution).
OptionSet_Description_UserLocalizedLabel_Label String The localized label text for the description of the picklist.
OptionSet_Description_UserLocalizedLabel_LanguageCode Integer The language code associated with the user-localized description label.
OptionSet_Description_UserLocalizedLabel_MetadataId String The unique identifier for the metadata of the user-localized description label.
OptionSet_DisplayName_LocalizedLabels String Localized display names for the picklist options in various languages.
OptionSet_DisplayName_UserLocalizedLabel_HasChanged String Indicates whether the user-customized display name label has been modified.
OptionSet_DisplayName_UserLocalizedLabel_IsManaged Boolean Specifies if the user-customized display name label is managed (part of a managed solution).
OptionSet_DisplayName_UserLocalizedLabel_Label String The localized label text for the display name of the picklist.
OptionSet_DisplayName_UserLocalizedLabel_LanguageCode Integer The language code associated with the user-localized display name label.
OptionSet_DisplayName_UserLocalizedLabel_MetadataId String The unique identifier for the metadata of the user-localized display name label.
OptionSet_ExternalTypeName String The external type name associated with the option set, if applicable.
OptionSet_HasChanged String Indicates if the option set has been modified since its creation or last update.
OptionSet_IntroducedVersion String The version of the system in which the option set was introduced.
OptionSet_IsCustomizable_CanBeChanged Boolean Indicates whether the option set can be customized by the user or administrators.
OptionSet_IsCustomizable_ManagedPropertyLogicalName String The logical name of the managed property controlling customizability of the option set.
OptionSet_IsCustomizable_Value Boolean Specifies if the option set is customizable.
OptionSet_IsCustomOptionSet Boolean Indicates whether the option set is custom or part of a default configuration.
OptionSet_IsGlobal Boolean Specifies if the option set is global (shared across entities) or local (specific to one entity).
OptionSet_IsManaged Boolean Indicates if the option set is managed (part of a managed solution).
OptionSet_MetadataId String The unique identifier for the metadata associated with the option set.
OptionSet_Name String The name of the option set.
OptionSet_OptionSetType String The type of the option set (e.g., picklist, drop-down).
OptionSet_ParentOptionSetName String The name of the parent option set, if this option set is part of a hierarchy.
TableName String The name of the table where the picklist attribute is defined.

CData Cloud

PickListOptions

Defines the set of selectable options available for Picklist attributes, supporting user-defined field values.

ビュー固有の情報

Select

Cloud はMicrosoft Dataverse API を使用して、以下のカラムと演算子で作成されたWHERE 句条件を処理します。その他のフィルタはクライアントサイドでCloud 内部で処理されます。

  • TableName は'='、'IN' 演算子をサポートしています。

TableName でフィルタリングしない場合、Cloud は最初に見つかったテーブルの結果を返します。

例えば、次のクエリはサーバーサイドで処理されます。

SELECT * FROM PickListOptions WHERE TableName = 'teams'

SELECT * FROM PickListOptions WHERE TableName IN ('accounts', 'teams')

Columns

Name Type References Description
ColumnName String

PickListAttributeMetaData.ColumnName

The name of the column in the table where the picklist option is defined.
Color String The color code associated with the picklist option, often used for display purposes in user interfaces.
ExternalValue String An external value associated with this picklist option, used for integration with external systems.
HasChanged String Indicates whether the picklist option has been modified since its creation or last update.
IsManaged Boolean Specifies if the picklist option is managed (part of a managed solution).
Label_LocalizedLabels String Localized labels for the picklist option in multiple languages.
Label_UserLocalizedLabel_HasChanged String Indicates if the user-customized label for the picklist option has been modified.
Label_UserLocalizedLabel_IsManaged Boolean Specifies if the user-customized label for the picklist option is managed (part of a managed solution).
Label_UserLocalizedLabel_Label String The user-customized label text for the picklist option.
Label_UserLocalizedLabel_LanguageCode Integer The language code corresponding to the user-customized label.
Label_UserLocalizedLabel_MetadataId String The unique identifier for the metadata associated with the user-customized label.
Description_LocalizedLabels String Localized descriptions for the picklist option in various supported languages.
Description_UserLocalizedLabel String The user-customized description for the picklist option, providing additional context or meaning.
MetadataId String The unique identifier for the metadata associated with this picklist option.
ParentValues String Specifies the parent values for hierarchical picklist options, if applicable.
Value Integer The integer value associated with this picklist option, used for storage and retrieval.
TableName String The name of the table where this picklist option is defined.

CData Cloud

StateAttributeMetadata

Provides metadata for attributes of type State, describing state-related fields used for status tracking or categorization.

ビュー固有の情報

Select

TableName でフィルタリングしない場合、Cloud は最初に見つかったテーブルの結果を返します。

以下の例は、特定のテーブルまたはテーブルのリストに対してビューをクエリする方法を示しています。

SELECT * FROM StateAttributeMetaData WHERE TableName='AccountLeads'

SELECT * FROM StateAttributeMetaData WHERE TableName IN ('Account','AccountLead');

Columns

Name Type References Description
ColumnName [KEY] String The name of the column in the table where the state attribute is defined.
MetadataId String The unique identifier for the metadata associated with this state attribute.
OptionSet_Description_LocalizedLabels String Localized descriptions for the state options in various supported languages.
OptionSet_Description_UserLocalizedLabel_HasChanged String Indicates whether the user-customized description label for the state options has been modified.
OptionSet_Description_UserLocalizedLabel_IsManaged Boolean Specifies if the user-customized description label for the state options is managed (part of a managed solution).
OptionSet_Description_UserLocalizedLabel_Label String The user-customized label text for the description of the state options.
OptionSet_Description_UserLocalizedLabel_LanguageCode Integer The language code associated with the user-customized description label.
OptionSet_Description_UserLocalizedLabel_MetadataId String The unique identifier for the metadata of the user-customized description label.
OptionSet_DisplayName_LocalizedLabels String Localized display names for the state options in various supported languages.
OptionSet_DisplayName_UserLocalizedLabel_HasChanged String Indicates whether the user-customized display name label for the state options has been modified.
OptionSet_DisplayName_UserLocalizedLabel_IsManaged Boolean Specifies if the user-customized display name label for the state options is managed (part of a managed solution).
OptionSet_DisplayName_UserLocalizedLabel_Label String The user-customized label text for the display name of the state options.
OptionSet_DisplayName_UserLocalizedLabel_LanguageCode Integer The language code associated with the user-customized display name label.
OptionSet_DisplayName_UserLocalizedLabel_MetadataId String The unique identifier for the metadata of the user-customized display name label.
OptionSet_ExternalTypeName String The external type name associated with the state options, if applicable.
OptionSet_HasChanged String Indicates whether the state option set has been modified since its creation or last update.
OptionSet_IntroducedVersion String The version of the system in which the state option set was introduced.
OptionSet_IsCustomizable_CanBeChanged Boolean Indicates whether the state option set can be customized by the user or administrators.
OptionSet_IsCustomizable_ManagedPropertyLogicalName String The logical name of the managed property controlling the customizability of the state option set.
OptionSet_IsCustomizable_Value Boolean Specifies if the state option set is customizable.
OptionSet_IsCustomOptionSet Boolean Indicates whether the state option set is custom or part of a default configuration.
OptionSet_IsGlobal Boolean Specifies if the state option set is global (shared across entities) or local (specific to one entity).
OptionSet_IsManaged Boolean Indicates if the state option set is managed (part of a managed solution).
OptionSet_MetadataId String The unique identifier for the metadata associated with the state option set.
OptionSet_Name String The name of the state option set.
OptionSet_OptionSetType String The type of the state option set (e.g., picklist, drop-down).
OptionSet_ParentOptionSetName String The name of the parent option set, if this state option set is part of a hierarchy.
TableName String The name of the table where this state attribute is defined.

CData Cloud

StateAttributeOptions

Lists the selectable states available for State attributes, representing various predefined states.

ビュー固有の情報

Select

TableName でフィルタリングしない場合、Cloud は最初に見つかったテーブルの結果を返します。

以下の例は、特定のテーブルまたはテーブルのリストに対してビューをクエリする方法を示しています。

SELECT * FROM StateAttributeOptions WHERE TableName='AccountLeads'

SELECT * FROM StateAttributeOptions WHERE TableName IN ('Account','AccountLead');

Columns

Name Type References Description
ColumnName String

StateAttributeMetadata.ColumnName

The name of the column in the table where the state option is defined.
Color String The color code associated with the state option, often used for UI representation.
ExternalValue String An external system value mapped to this state option, if applicable.
HasChanged String Indicates whether the state option has been modified since its creation or last update.
IsManaged Boolean Specifies if the state option is managed (part of a managed solution).
Label_LocalizedLabels String Localized labels for the state option in various supported languages.
Label_UserLocalizedLabel_HasChanged String Indicates if the user-customized label for the state option has been modified.
Label_UserLocalizedLabel_IsManaged Boolean Specifies if the user-customized label for the state option is managed (part of a managed solution).
Label_UserLocalizedLabel_Label String The user-customized label text for the state option.
Label_UserLocalizedLabel_LanguageCode Integer The language code corresponding to the user-customized label.
Label_UserLocalizedLabel_MetadataId String The unique identifier for the metadata associated with the user-customized label.
Description_LocalizedLabels String Localized descriptions for the state option in various supported languages.
Description_UserLocalizedLabel String The user-customized description for the state option, providing additional context or details.
MetadataId String The unique identifier for the metadata associated with the state option.
ParentValues String Specifies the parent values for hierarchical state options, if applicable.
Value Integer The integer value associated with this state option, used for storage and retrieval.
TableName String The name of the table where this state option is defined.

CData Cloud

StatusAttributeMetadata

Contains metadata for attributes of type Status, often used to track the lifecycle or current condition of an entity.

ビュー固有の情報

Select

TableName でフィルタリングしない場合、Cloud は最初に見つかったテーブルの結果を返します。

以下の例は、特定のテーブルまたはテーブルのリストに対してビューをクエリする方法を示しています。

SELECT * FROM StatusAttributeMetaData WHERE TableName='AccountLeads'

SELECT * FROM StatusAttributeMetaData WHERE TableName IN ('Account','AccountLead');

Columns

Name Type References Description
ColumnName [KEY] String The name of the column in the table where the status attribute is defined.
MetadataId String The unique identifier for the metadata associated with this status attribute.
OptionSet_Description_LocalizedLabels String Localized descriptions for the status options in various supported languages.
OptionSet_Description_UserLocalizedLabel_HasChanged String Indicates whether the user-customized description label for the status options has been modified.
OptionSet_Description_UserLocalizedLabel_IsManaged Boolean Specifies if the user-customized description label for the status options is managed (part of a managed solution).
OptionSet_Description_UserLocalizedLabel_Label String The user-customized label text for the description of the status options.
OptionSet_Description_UserLocalizedLabel_LanguageCode Integer The language code associated with the user-customized description label.
OptionSet_Description_UserLocalizedLabel_MetadataId String The unique identifier for the metadata of the user-customized description label.
OptionSet_DisplayName_LocalizedLabels String Localized display names for the status options in various supported languages.
OptionSet_DisplayName_UserLocalizedLabel_HasChanged String Indicates whether the user-customized display name label for the status options has been modified.
OptionSet_DisplayName_UserLocalizedLabel_IsManaged Boolean Specifies if the user-customized display name label for the status options is managed (part of a managed solution).
OptionSet_DisplayName_UserLocalizedLabel_Label String The user-customized label text for the display name of the status options.
OptionSet_DisplayName_UserLocalizedLabel_LanguageCode Integer The language code associated with the user-customized display name label.
OptionSet_DisplayName_UserLocalizedLabel_MetadataId String The unique identifier for the metadata of the user-customized display name label.
OptionSet_ExternalTypeName String The external type name associated with the status options, if applicable.
OptionSet_HasChanged String Indicates whether the status option set has been modified since its creation or last update.
OptionSet_IntroducedVersion String The version of the system in which the status option set was introduced.
OptionSet_IsCustomizable_CanBeChanged Boolean Indicates whether the status option set can be customized by the user or administrators.
OptionSet_IsCustomizable_ManagedPropertyLogicalName String The logical name of the managed property controlling the customizability of the status option set.
OptionSet_IsCustomizable_Value Boolean Specifies if the status option set is customizable.
OptionSet_IsCustomOptionSet Boolean Indicates whether the status option set is custom or part of a default configuration.
OptionSet_IsGlobal Boolean Specifies if the status option set is global (shared across entities) or local (specific to one entity).
OptionSet_IsManaged Boolean Indicates if the status option set is managed (part of a managed solution).
OptionSet_MetadataId String The unique identifier for the metadata associated with the status option set.
OptionSet_Name String The name of the status option set.
OptionSet_OptionSetType String The type of the status option set (e.g., picklist, drop-down).
OptionSet_ParentOptionSetName String The name of the parent option set, if this status option set is part of a hierarchy.
TableName String The name of the table where this status attribute is defined.

CData Cloud

StatusAttributeOptions

Defines the set of statuses that can be assigned to Status attributes, supporting status-driven workflows.

ビュー固有の情報

Select

TableName でフィルタリングしない場合、Cloud は最初に見つかったテーブルの結果を返します。

以下の例は、特定のテーブルまたはテーブルのリストに対してビューをクエリする方法を示しています。

SELECT * FROM StatusAttributesOptions WHERE TableName='AccountLeads'

SELECT * FROM StatusAttributesOptions WHERE TableName IN ('Account','AccountLead');

Columns

Name Type References Description
ColumnName String

StatusAttributeMetadata.ColumnName

The name of the column in the table where the status option is defined.
Color String The color code associated with the status option, typically used for visual representation in user interfaces.
ExternalValue String An external system value mapped to this status option, if applicable.
HasChanged String Indicates whether the status option has been modified since its creation or last update.
IsManaged Boolean Specifies if the status option is managed (part of a managed solution).
Label_LocalizedLabels String Localized labels for the status option in various supported languages.
Label_UserLocalizedLabel_HasChanged String Indicates if the user-customized label for the status option has been modified.
Label_UserLocalizedLabel_IsManaged Boolean Specifies if the user-customized label for the status option is managed (part of a managed solution).
Label_UserLocalizedLabel_Label String The user-customized label text for the status option.
Label_UserLocalizedLabel_LanguageCode Integer The language code corresponding to the user-customized label.
Label_UserLocalizedLabel_MetadataId String The unique identifier for the metadata associated with the user-customized label.
Description_LocalizedLabels String Localized descriptions for the status option in various supported languages.
Description_UserLocalizedLabel String The user-customized description for the status option, providing additional context or details.
MetadataId String The unique identifier for the metadata associated with the status option.
ParentValues String Specifies the parent values for hierarchical status options, if applicable.
Value Integer The integer value associated with this status option, used for storage and retrieval.
TableName String The name of the table where this status option is defined.

CData Cloud

ストアドプロシージャ

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

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

CData Cloud - Microsoft Dataverse ストアドプロシージャ

Name Description

CData Cloud

システムデータモデル

System データモデルは、セキュリティ、監査、システムレベルの操作など、プラットフォームのコア機能をサポートする基本的なフレームワークを定義します。メタデータ、ユーザーロール、ワークフロー、バックグラウンドプロセスを管理し、シームレスなデータガバナンスとビジネスアプリケーション間の統合を実現します。

ストアドプロシージャ

ストアドプロシージャ は、SQLクエリを介して呼び出されるアクションです。標準的なCRUD 操作だけでなく、OAuth アクセストークンの取得や更新などより高度なタスクも実行します。

CData Cloud

ストアドプロシージャ

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

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

CData Cloud - Microsoft Dataverse ストアドプロシージャ

Name Description
CreateAssociation ナビゲーションプロパティを使用して、2つのエンティティ間の関連を確立します。接続設定でナビゲーションプロパティが有効になっている必要があります。
ListAssociations 指定されたテーブルとそのナビゲーションプロパティのすべての関連付けを表示し、エンティティのリレーションシップを詳述します。
ListNavigationProperties 指定されたテーブルとその関連テーブルのナビゲーションプロパティをリストし、リレーションシップの発見を支援します。
RemoveAssociation ナビゲーションプロパティで管理されている、2つのエンティティ間の確立済みのリンクを削除します。

CData Cloud

CreateAssociation

ナビゲーションプロパティを使用して、2つのエンティティ間の関連を確立します。接続設定でナビゲーションプロパティが有効になっている必要があります。

Input

Name Type Required Description
FromId String True 関連付けを確立するソースエンティティの一意の識別子(Id)。
FromTable String True ソースエンティティを含むテーブルの名前。例えば、FromId がCustomers テーブルのレコードに属する場合、このパラメータを'Customers' に設定します。
ToNavigationProperty String True リレーションシップを定義するために使用されるナビゲーションプロパティの名前。このプロパティは、ListNavigationProperties プロシージャを使用して取得できます。
ToId String True ナビゲーションプロパティで定義された関連テーブル内のターゲットエンティティの一意の識別子(Id)。

Result Set Columns

Name Type Description
Success Boolean 関連付け作成操作が成功(true)したか失敗(false)したかを示すboolean 値。

CData Cloud

ListAssociations

指定されたテーブルとそのナビゲーションプロパティのすべての関連付けを表示し、エンティティのリレーションシップを詳述します。

Input

Name Type Required Description
FromId String True 関連エンティティのリストを作成するソースエンティティの一意の識別子(Id)。
FromTable String True ソースエンティティを含むテーブルの名前。例えば、FromId がCustomers テーブルのレコードに属する場合、このパラメータを'Customers' に設定します。
NavigationProperty String True 取得したいリレーションシップを表すナビゲーションプロパティの名前。これは、ListNavigationProperties プロシージャを使用して取得できます。

Result Set Columns

Name Type Description
Uri String 指定されたナビゲーションプロパティを通じて関連レコードにアクセスする方法を提供する、関連エンティティへのリンクURL。

CData Cloud

ListNavigationProperties

指定されたテーブルとその関連テーブルのナビゲーションプロパティをリストし、リレーションシップの発見を支援します。

Input

Name Type Required Description
TableName String True 利用可能なナビゲーションプロパティをリストしたいテーブルの名前。このテーブルはリレーションシップのソースを表します。

Result Set Columns

Name Type Description
Name String 指定されたテーブル内のリレーションシップまたは関連付けを定義するナビゲーションプロパティの名前。
AssociatedTable String ナビゲーションプロパティがリンクするテーブルの名前で、リレーションシップのターゲットエンティティを表します。

CData Cloud

RemoveAssociation

ナビゲーションプロパティで管理されている、2つのエンティティ間の確立済みのリンクを削除します。

Input

Name Type Required Description
FromId String True 関連付けを削除したいソースエンティティの一意の識別子(Id)。
FromTable String True ソースエンティティを含むテーブルの名前。例えば、FromId がCustomers テーブルのレコードに属する場合、このパラメータを'Customers' に設定します。
ToNavigationProperty String True 削除したいリレーションシップを表すナビゲーションプロパティの名前。このプロパティは、ListNavigationProperties プロシージャを使用して取得できます。
ToId String True ナビゲーションプロパティで定義された関連テーブル内のターゲットエンティティの一意の識別子(Id)。

Result Set Columns

Name Type Description
Success Boolean 関連付け削除操作が成功(true)したか失敗(false)したかを示すboolean 値。

CData Cloud

システムテーブル

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

スキーマテーブル

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

  • 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

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

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

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

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 から返されたフィールドがテーブルの主キーであるかどうか。

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

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

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

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

Columns

Name Type Description
CatalogName String ストアドプロシージャを含むデータベースの名前。
SchemaName String ストアドプロシージャを含むスキーマの名前。
ProcedureName String パラメータを含むストアドプロシージャの名前。
ColumnName String ストアドプロシージャパラメータの名前。
Direction Int32 パラメータのタイプに対応する整数値:input (1)。input/output (2)、またはoutput(4)。input/output タイプパラメータは、入力パラメータと出力パラメータの両方になれます。
DataTypeName String データ型の名前。
DataType Int32 データ型を示す整数値。この値は、実行時に環境に基づいて決定されます。
Length Int32 文字データの場合は、許可される文字数。数値データの場合は、許可される桁数。
NumericPrecision Int32 数値データの場合は最大精度。文字データおよび日時データの場合は、カラムの長さ(文字数)。
NumericScale Int32 数値データの小数点以下の桁数。
IsNullable Boolean パラメータがNull を含められるかどうか。
IsRequired Boolean プロシージャの実行にパラメータが必要かどうか。
IsArray Boolean パラメータが配列かどうか。
Description String パラメータの説明。
Ordinal Int32 パラメータのインデックス。

CData Cloud

sys_keycolumns

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

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

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

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

データ型マッピング

データ型のマッピング

Cloud は、データソースの型を、スキーマで使用可能な対応するデータ型にマッピングします。以下のテーブルはこれらのマッピングを説明します。

Microsoft Dataverse (OData V4) CData スキーマ
Edm.Binary binary
Edm.Boolean bool
Edm.Date datetime
Edm.DateTimeOffset datetime
Edm.Decimal decimal
Edm.Double double
Edm.Guid guid
Edm.Int32 int
Edm.String string
Edm.TimeOfDay time

CData Cloud

接続文字列オプション

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

Authentication


プロパティ説明
AuthSchemeMicrosoft Dataverse に接続する際に使用する認証の種類を指定します。このプロパティが空白の場合は、デフォルトの認証が使用されます。
OrganizationURLDynamics 365 組織のURL。リソースとも呼ばれます。お使いのMicrosoft Dataverse インスタンスの正確なURL を見つけるには、Web Services ページを検索してください。
ApiVersion使用されているAPI のバージョンを示します。認証時に利用可能なAPI 機能の全範囲にアクセスできるように、この設定を最新の状態に保ってください。

Azure Authentication


プロパティ説明
AzureTenantデータにアクセスするために使用されるMicrosoft Dataverse テナントを、名前(例えば、contoso.omnicrosoft.com)またはID で識別します。(条件付き)
AzureEnvironment接続するAzure ネットワーク環境を指定します。Azure アカウントが追加されたネットワークと同じである必要があります。

OAuth


プロパティ説明
OAuthClientIdカスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。(コンシューマーキーとも呼ばれます。)このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。
OAuthClientSecretカスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。( コンシューマーシークレット とも呼ばれます。)このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。
OAuthGrantType選択したOAuth フローのグラント種別を指定します。 この値は、OAuth カスタムアプリケーション作成時に設定されたグラント種別と同じである必要があります。

JWT OAuth


プロパティ説明
OAuthJWTCertJWT 証明書のストア。
OAuthJWTCertTypeJWT 証明書を格納するキーストアの種類。
OAuthJWTCertPasswordOAuth JWT 証明書のパスワード。パスワードを必要とする証明書ストアにアクセスするために使用されます。証明書ストアがパスワードを必要としない場合は、このプロパティを空白のままにします。
OAuthJWTCertSubjectOAuth JWT 証明書のサブジェクトで、ストアで一致する証明書を検索するために使用されます。部分一致と、先頭の証明書を選択するためのワイルドカード '*' をサポートします。

SSL


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

Logging


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

Schema


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

Miscellaneous


プロパティ説明
ContinueOnErrorエラーが発生した後にバッチリクエストを続行するかどうかを指定します。(OData 4.0 以降のみ。)
IncludeFormattedValuesSpecifies whether columns that hold formatted values should be exposed.
IncludeLookUpLogicalNameIndicates if the referenced entity name for a LookUp field should be exposed.
IncludeNavigationKeysSpecifies whether the column listing should include the primary keys of navigation properties. (JSON responses only)
IncludeNavigationPropertiesSpecifies whether the column listing should include navigation properties.
MaxRows集計やGROUP BY を使用しないクエリで返される最大行数を指定します。
PseudoColumnsテーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。
Timeoutprovider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。
UseDisplayNamesIf set to true, the provider will use display names for some operations.
CData Cloud

Authentication

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


プロパティ説明
AuthSchemeMicrosoft Dataverse に接続する際に使用する認証の種類を指定します。このプロパティが空白の場合は、デフォルトの認証が使用されます。
OrganizationURLDynamics 365 組織のURL。リソースとも呼ばれます。お使いのMicrosoft Dataverse インスタンスの正確なURL を見つけるには、Web Services ページを検索してください。
ApiVersion使用されているAPI のバージョンを示します。認証時に利用可能なAPI 機能の全範囲にアクセスできるように、この設定を最新の状態に保ってください。
CData Cloud

AuthScheme

Microsoft Dataverse に接続する際に使用する認証の種類を指定します。このプロパティが空白の場合は、デフォルトの認証が使用されます。

Possible Values

AzureAD, AzureServicePrincipal, AzureServicePrincipalCert

データ型

string

デフォルト値

"AzureAD"

解説

  • AzureAD:Azure Active Directory(ユーザーベース)のOAuth 認証を実行します。
  • AzureMSI:Azure VM で実行している際に、Azure AD マネージドサービスID の資格情報を自動的に取得します。
  • AzureServicePrincipal:クライアントシークレットを使用してAzure サービスプリンシパル(ロールベース、アプリケーションベース)として認証します。
  • AzureServicePrincipalCert:証明書を使用してAzure サービスプリンシパル(ロールベース、アプリケーションベース)として認証します。

Azure AD で認証するためのカスタムアプリケーションの作成方法については、Azure AD アプリケーションの作成 を参照してください。

Azure AD サービスプリンシパルで認証するためのカスタムアプリケーションの作成方法については、サービスプリンシパルによるAzure AD アプリの作成 を参照してください。

CData Cloud

OrganizationURL

Dynamics 365 組織のURL。リソースとも呼ばれます。お使いのMicrosoft Dataverse インスタンスの正確なURL を見つけるには、Web Services ページを検索してください。

データ型

string

デフォルト値

""

解説

リソースのURL 形式は通常https://abc123.cloudax.dynamics.com/ に類似していますが、Edition がHumanResources の場合は異なります。 HumanResources のURL は通常次のようになります:https://{cluster}.hr.talent.dynamics.com/namespaces/{namespace_guid}/。

CData Cloud

ApiVersion

使用されているAPI のバージョンを示します。認証時に利用可能なAPI 機能の全範囲にアクセスできるように、この設定を最新の状態に保ってください。

データ型

string

デフォルト値

"9.2"

解説

サービスAPI は、データモデルの新機能にアクセスする手段を提供します。 ApiVersion を変更すると、ドライバーによって公開されるテーブルやカラムを定義するために使用されるサービスドキュメントが変更されます。

CData Cloud

Azure Authentication

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


プロパティ説明
AzureTenantデータにアクセスするために使用されるMicrosoft Dataverse テナントを、名前(例えば、contoso.omnicrosoft.com)またはID で識別します。(条件付き)
AzureEnvironment接続するAzure ネットワーク環境を指定します。Azure アカウントが追加されたネットワークと同じである必要があります。
CData Cloud

AzureTenant

データにアクセスするために使用されるMicrosoft Dataverse テナントを、名前(例えば、contoso.omnicrosoft.com)またはID で識別します。(条件付き)

データ型

string

デフォルト値

""

解説

テナントは、主にドメイン(例えば、microsoft.com)に関連付けられた、組織のデジタル表現です。 テナントは、Tenant ID(ディレクトリID とも呼ばれる)によって管理されます。これは、Azure リソースへのアクセスや管理権限をユーザーに割り当てる際に指定します。

Azure ポータルでディレクトリID を見つけるには、Azure Active Directory -> プロパティに移動します。

AuthScheme = AzureServicePrincipal またはAzureServicePrincipalCert のいずれかである場合、またはAzureTenant = AzureAD であり、ユーザーが複数のテナントに属している場合は、AzureTenant を指定する必要があります。

CData Cloud

AzureEnvironment

接続するAzure ネットワーク環境を指定します。Azure アカウントが追加されたネットワークと同じである必要があります。

Possible Values

GLOBAL, CHINA, USGOVT, USGOVTDOD

データ型

string

デフォルト値

"GLOBAL"

解説

Azure アカウントがGlobal ネットワークとは異なるネットワーク(China、USGOVT、USGOVTDOD など)の一部である場合は、必要です。

CData Cloud

OAuth

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


プロパティ説明
OAuthClientIdカスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。(コンシューマーキーとも呼ばれます。)このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。
OAuthClientSecretカスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。( コンシューマーシークレット とも呼ばれます。)このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。
OAuthGrantType選択したOAuth フローのグラント種別を指定します。 この値は、OAuth カスタムアプリケーション作成時に設定されたグラント種別と同じである必要があります。
CData Cloud

OAuthClientId

カスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。(コンシューマーキーとも呼ばれます。)このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。

データ型

string

デフォルト値

""

解説

OAuthClientId は、ユーザーがOAuth 経由で認証を行う前に設定する必要があるいくつかの接続パラメータの1つです。詳細は接続の確立を参照してください。

CData Cloud

OAuthClientSecret

カスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。( コンシューマーシークレット とも呼ばれます。)このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。

データ型

string

デフォルト値

""

解説

OAuthClientSecret は、ユーザーがOAuth 経由で認証を行う前に設定する必要があるいくつかの接続パラメータの1つです。詳細は接続の確立を参照してください。

CData Cloud

OAuthGrantType

選択したOAuth フローのグラント種別を指定します。 この値は、OAuth カスタムアプリケーション作成時に設定されたグラント種別と同じである必要があります。

Possible Values

CODE, CLIENT, PASSWORD

データ型

string

デフォルト値

"CODE"

解説

ほとんどの場合、デフォルトのグラント種別は変更すべきではありません。 最も一般的なOAuth グラント種別とそれぞれのメリット・デメリットについては、https://oauth.net/2/grant-types/ を参照してください。

CData Cloud

JWT OAuth

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


プロパティ説明
OAuthJWTCertJWT 証明書のストア。
OAuthJWTCertTypeJWT 証明書を格納するキーストアの種類。
OAuthJWTCertPasswordOAuth JWT 証明書のパスワード。パスワードを必要とする証明書ストアにアクセスするために使用されます。証明書ストアがパスワードを必要としない場合は、このプロパティを空白のままにします。
OAuthJWTCertSubjectOAuth JWT 証明書のサブジェクトで、ストアで一致する証明書を検索するために使用されます。部分一致と、先頭の証明書を選択するためのワイルドカード '*' をサポートします。
CData Cloud

OAuthJWTCert

JWT 証明書のストア。

データ型

string

デフォルト値

""

解説

クライアント証明書のための証明書ストア名。

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

OAuthJWTCert は、OAuthJWTCertSubject フィールドとともにクライアント証明書を指定するために使われます。 OAuthJWTCert に値がある場合で、OAuthJWTCertSubject が設定されている場合は、証明書の検索が始まります。 詳しくは、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"

解説

このプロパティには次の値の一つを設定できます。

USERWindows の場合、現在のユーザーにより所有された証明書ストアであることを指定します。 Note:この種類はJava では利用できません。
MACHINEWindows の場合、この証明書ストアがシステムストアであることを指定します。 Note:この種類はJava では利用できません。
PFXFILEこの証明書ストアは、証明書を含むPFX(PKCS12)ファイルの名前です。
PFXBLOBこの証明書ストアは、PFX(PKCS12)形式の証明書ストアを表すBase-64でエンコードされた文字列です。
JKSFILEこの証明書ストアは、証明書を含むJava key store(JKS)ファイルの名前です。 Note:この種類はJava のみで利用できます。
JKSBLOBこの証明書ストアは、Java key store(JKS)形式の証明書ストアを表すBase-64でエンコードされた文字列です。 Note:この種類はJava のみで利用できます。
PEMKEY_FILEこの証明書ストアは、秘密キーと任意の証明書を含むPEM でエンコードされたファイルの名前です。
PEMKEY_BLOBこの証明書ストアは、秘密キーと任意の証明書を含むBase-64でエンコードされた文字列です。
PUBLIC_KEY_FILEこの証明書ストアは、PEM またはDER でエンコードされた公開キーの証明書を含むファイルの名前です。
PUBLIC_KEY_BLOBこの証明書ストアは、PEM またはDER でエンコードされた公開キーの証明書を含むBase-64でエンコードされた文字列です。
SSHPUBLIC_KEY_FILEこの証明書ストアは、SSH 公開キーを含むファイルの名前です。
SSHPUBLIC_KEY_BLOBこの証明書ストアは、SSH 公開キーを含むBase-64でエンコードされた文字列です。
P7BFILEこの証明書ストアは、証明書を含むPKCS7 ファイルの名前です。
PPKFILEこの証明書ストアは、PuTTY 秘密キー(PPK)を含むファイルの名前です。
XMLFILEこの証明書ストアは、XML 形式の証明書を含むファイルの名前です。
XMLBLOBこの証明書ストアは、XML 形式の証明書を含む文字列の名前です。
BCFKSFILEこの証明書ストアは、Bouncy Castle キーストアを含むファイルの名前です。
BCFKSBLOBこの証明書ストアは、Bouncy Castle キーストアを含む文字列(Base-64エンコード)です。

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

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

これを指定しない場合は、マシンが信用するすべての証明書が受け入れられます。

すべての証明書の受け入れを示すには、'*'を使用します。セキュリティ上の理由から、これはお勧めできません。

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 です。
SchemaMicrosoft Dataverse からメタデータをリストする際に使用するスキーマを指定します。
CData Cloud

BrowsableSchemas

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

データ型

string

デフォルト値

""

解説

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

CData Cloud

Schema

Microsoft Dataverse からメタデータをリストする際に使用するスキーマを指定します。

Possible Values

System, Entities

データ型

string

デフォルト値

"System"

解説

この接続プロパティには、以下の値を設定できます。

  • System:Microsoft Dataverse オブジェクトを、あまり詳細でないメタデータとともに公開します。テーブルはシステムレベルの名前を使用します。返されるメタデータが比較的単純なため、このスキーマからのデータ取得はより高速です。デフォルトではこのスキーマが選択されています。
  • Entities:Microsoft Dataverse オブジェクトを、より詳細なメタデータ(アノテーションやデータ型の詳細を含む)と、よりユーザーフレンドリーなテーブル名で公開します。返されるメタデータが複雑になっているため、このスキーマからのデータ取得には時間がかかります。

CData Cloud

Miscellaneous

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


プロパティ説明
ContinueOnErrorエラーが発生した後にバッチリクエストを続行するかどうかを指定します。(OData 4.0 以降のみ。)
IncludeFormattedValuesSpecifies whether columns that hold formatted values should be exposed.
IncludeLookUpLogicalNameIndicates if the referenced entity name for a LookUp field should be exposed.
IncludeNavigationKeysSpecifies whether the column listing should include the primary keys of navigation properties. (JSON responses only)
IncludeNavigationPropertiesSpecifies whether the column listing should include navigation properties.
MaxRows集計やGROUP BY を使用しないクエリで返される最大行数を指定します。
PseudoColumnsテーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。
Timeoutprovider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。
UseDisplayNamesIf set to true, the provider will use display names for some operations.
CData Cloud

ContinueOnError

エラーが発生した後にバッチリクエストを続行するかどうかを指定します。(OData 4.0 以降のみ。)

データ型

bool

デフォルト値

false

解説

ContinueOnError がtrue に設定されている場合、エラーが発生したバッチ操作は完了し、エラー応答を含む結果テーブルが作成されます。 ContinueOnError がfalse に設定されている場合、エラーが発生したバッチ操作は中止され、エラーメッセージが表示されます。

CData Cloud

IncludeFormattedValues

Specifies whether columns that hold formatted values should be exposed.

データ型

bool

デフォルト値

false

解説

If set to true, an extra column named columnname_display is added beside each column. If the column contains a formatted value, the new column exposes that formatted values. If the field does not have a formatted value, columname_display is null.

CData Cloud

IncludeLookUpLogicalName

Indicates if the referenced entity name for a LookUp field should be exposed.

データ型

bool

デフォルト値

false

解説

For each key column, an extra one is added to expose the LookUp logical name value. New columns will have "_lookuplogicalname" postfix.

CData Cloud

IncludeNavigationKeys

Specifies whether the column listing should include the primary keys of navigation properties. (JSON responses only)

データ型

bool

デフォルト値

false

解説

This property is provided to make it simpler to retrieve JSON record references where possible. When true, the $prod; pushes a set of fields for each table relation.

These properties are not available for use in INSERT or UPDATE operations. (Use the Linked* navigation columns for that).

If your service supports both XML/ATOM and JSON and you want to use this property, be sure to set DataFormat to JSON.

CData Cloud

IncludeNavigationProperties

Specifies whether the column listing should include navigation properties.

データ型

bool

デフォルト値

false

解説

Navigation properties provide a way to navigate an association between two entity types. Every object can have a navigation property for every relationship in which it participates.

Navigation properties enable you to navigate and manage relationships in two ways:

  • Two-directional navigation returns either a reference object (if the relationship is either 1 or 0-or-1) or a collection (if the relationship is 1-to-many).
  • One-directional navigation enables you to define the navigation property on just one of the types that participates in the relationship, but not both.

When retrieving data, the navigation properties in a cell do not populate with information. Rather, they act to bind the content to an existing resource during inserts or updates. For example:

INSERT INTO accounts (_primarycontactid_value) VALUES ('123456')

To specify multiple values, use a comma-separated list. For instance:

INSERT INTO accounts (lead_customer_accounts) VALUES ('123,456')

CData Cloud

MaxRows

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

データ型

int

デフォルト値

-1

解説

このプロパティは、集計やGROUP BY 句を含まないクエリに対してCloud が返す行数の上限を設定します。 この制限により、クエリがデフォルトで過度に大きな結果セットを返さないようにします。

クエリにLIMIT 句が含まれている場合、クエリで指定された値がMaxRows 設定よりも優先されます。 MaxRows が"-1" に設定されている場合、LIMIT 句が明示的にクエリに含まれていない限り、行の制限は行われません。

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

CData Cloud

PseudoColumns

テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。

データ型

string

デフォルト値

""

解説

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

個々の擬似カラムを指定するには、以下の形式を使用します。"Table1=Column1;Table1=Column2;Table2=Column3"

すべてのテーブルのすべての擬似カラムを含めるには、次のようにします:"*=*"

CData Cloud

Timeout

provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。

データ型

int

デフォルト値

60

解説

このプロパティは、Cloud が操作をキャンセルする前に操作の完了を待機する最大時間を秒単位で制御します。 操作の完了前にタイムアウト時間が経過すると、Cloud は操作をキャンセルして例外をスローします。

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

このプロパティを0に設定するとタイムアウトが無効になり、操作が成功するか、サーバー側のタイムアウト、ネットワークの中断、またはサーバーのリソース制限などの他の条件で失敗するまで無期限に実行されます。 このプロパティは慎重に使用してください。長時間実行される操作がパフォーマンスを低下させたり、応答しなくなる可能性があるためです。

CData Cloud

UseDisplayNames

If set to true, the provider will use display names for some operations.

データ型

bool

デフォルト値

false

解説

If set to true, the Cloud will use display names for some operations. This property is used only for Entities schema.

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