CData Sync App は、Azure Data Catalog データをデータベース、データレイク、またはデータウェアハウスに継続的にパイプライン化する簡単な方法を提供し、分析、レポート、AI、および機械学習で簡単に利用できるようにします。
Azure Data Catalog コネクタはCData Sync アプリケーションから使用可能で、Azure Data Catalog からデータを取得して、サポートされている任意の同期先に移動できます。
Sync App は、Azure Data Catalog API のバージョン2016-03-30 を利用してAzure Data Catalog への読み出しアクセスを実現します。
必須プロパティについては、設定タブを参照してください。
通常必須ではない接続プロパティについては、高度な設定タブを参照してください。
以下をオプションで設定して、Azure Data Catalog から返された異なるカタログデータを読み出すことができます。
カタログ名を取得するには、[Azure Portal ホームページ]>[データカタログ]>[カタログ名]に移動します。
Web アプリケーションを介したAzure AD への認証には、 常にカスタムOAuth アプリケーションの作成が必要です。
カスタムOAuthアプリケーションの作成の詳細については、Azure AD アプリケーションの作成 を参照してください。
Azure サービスプリンシパルは、ロールに基づいたアプリケーションベースの認証です。これは、認証がユーザーごとではなく、アプリケーションごとに行われることを意味します。 アプリケーションで実行されるすべてのタスクは、デフォルトユーザーコンテキストなしで、割り当てられたロールに基づいて実行されます。 リソースへのアプリケーションのアクセスは、割り当てられたロールの権限によって制御されます。
Azure サービスプリンシパル認証の設定方法については、サービスプリンシパルによるAzure AD アプリの作成 を参照してください。
Azure VM 上でAzure Data Catalog を実行しており、マネージドID(MSI)認証情報を自動的に取得して接続したい場合は、AuthScheme を AzureMSI に設定します。
VM に複数のユーザーが割り当てられたマネージドID がある場合は、OAuthClientId も指定する必要があります。
このセクションでは、Azure Data Catalog Sync App の高度な機能を厳選して説明します。
Sync App はユーザー定義ビューの使用をサポートします。これは事前設定されたユーザー定義クエリによって内容が決定される仮想テーブルです。 このビューは、ドライバーに発行されるクエリを直接制御できない場合に有効です。 カスタムビューの作成と設定の概要については、ユーザー定義ビュー を参照してください。
SSL の設定 を使用して、Sync App が証明書のネゴシエーションをどのように扱うかを調整します。さまざまな証明書形式を選択できます。詳しくは、「接続文字列オプション」にあるSSLServerCert プロパティを参照してください。
Windows プロキシとHTTP プロキシを含むファイアウォールとプロキシ に合致するようSync App を設定します。トンネル接続を設定することもできます。
詳しくは、クエリ処理 を参照してください。
デフォルトでは、Sync App はサーバーとのTLS のネゴシエーションを試みます。サーバー証明書は、デフォルトのシステム信頼済み証明書ストアで検証されます。SSLServerCert 接続プロパティを使用して、証明書の検証方法をオーバーライドできます。
別の証明書を指定するには、SSLServerCert 接続プロパティを参照してください。
HTTP プロキシへの認証には、以下のように設定します。
次のプロパティを設定します。
このセクションでは、利用可能なAPI オブジェクトを示し、Azure Data Catalog API へのSQL の実行について詳しく説明します。
ビュー では、利用可能なビューを説明します。ビューは、カスタムデータソース、データ資産、データ資産注釈などを静的にモデル化するように定義されています。
ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。
クエリは、ビューに対して通常のテーブルと同様に実行することができます。
| Name | Description |
| ColumnDataProfiles | Get list of column data profiles. |
| CustomDataSourceProperties | Get Identity properties of Custom Data Sources. |
| CustomDataSources | Retrieves list of custom data sources, which are registered with the catalog. |
| Databases | Get list of databases. |
| Descriptions | Get list of descriptions of databases, tables, and objects. |
| Experts | Get list of experts of databases, tables, and objects. |
| Objects | Get list datasource properties. |
| TableColumns | Get details of table schema. |
| TableDataProfiles | Get list of table data profiles. |
| Tables | Get list of tables in the data asset. |
| Tags | Get list of tags of databases, tables, and objects. |
Get list of column data profiles.
The Sync App will use the Azure Data Catalog API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
Note: ItemId is required in order to query ColumnDataProfiles.
SELECT * FROM ColumnDataProfiles WHERE ItemId = '8a2b7305-b474-45d6-9fba-562454045070'
| Name | Type | Description |
| ItemId [KEY] | String | Item Id of a view or table. |
| ColumnName | String | The name of the column. |
| Type | String | The type of the column. |
| Min | String | The minimum value in the data set. |
| Max | String | The maximum value in the data set. |
| Avg | Decimal | The average value in the data set. |
| Stdev | Double | The standard deviation for the data set. |
| NullCount | Integer | The count of null values in the data set. |
| DistinctCount | Integer | The count of distinct values in the data set. |
Get Identity properties of Custom Data Sources.
No filters are supported server side for this table. All criteria will be handled client side within the Sync App.
| Name | Type | Description |
| Namespace | String | Qualified name of the custom data source protocol. |
| Name | String | Name of the custom data source property. |
| Type | String | Data type of the custom data source property. |
Retrieves list of custom data sources, which are registered with the catalog.
No filters are supported server side for this table. All criteria will be handled client side within the Sync App.
| Name | Type | Description |
| Id | String | Id of a custom data source. |
| Name | String | Name of a custom data source. |
| Namespace | String | Qualified name of the custom data source protocol. |
| Timestamp | Datetime | It contains the date and time at which an event occurred. |
| IdentitySets | String | Property of identity sets. |
Get list of databases.
The Sync App will use the Azure Data Catalog API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
SELECT * FROM Databases WHERE HasDocumentation = false AND HasDescription = false AND HasTags = true;
SELECT * FROM Databases WHERE Timestamp > '2019-09-19T04:39:54.0083651Z'
SELECT * FROM Databases WHERE Tags = 'sales' OR Name = 'FactProductInventory'
| Name | Type | Description |
| Id | String | Id of a database. |
| Type | String | Type of database. |
| EffectiveRights | String | Rights a particular annotation has. |
| Roles | String | Roles of a database. |
| RoleMembers | String | Members whom roles was assigned. |
| Timestamp | Datetime | Created time of database. |
| Name | String | Name of a property. |
| ObjectType | String | Type of object. Eg. table, etc. |
| SourceType | String | Source type. Eg. Jdbc, Odbc, etc. |
| DslAddressDatabase | String | DSL address of a database. |
| DslAuthentication | String | Type of authentication used. |
| DslProtocol | String | Describes a protocol used to communicate with the data source. |
| FromSourceSystem | Boolean | Indicates whether data of an item is derived from a source system or authored by a user. |
| LastRegisteredByObjectId | String | Object Id of a last registered user. |
| LastRegisteredByUpn | String | Upn of last registered user. |
| AccessInstructionsId | String | Id of an access instructions. |
| AccessInstructionsType | String | Type of an access instructions. |
| AccessInstructionsEffectiveRights | String | Effective rights of a particular access instructions. |
| AccessInstructionsMimeType | String | Mime type of access instructions. |
| AccessInstructionsContent | String | Content of an access instructions. |
| AccessInstructionsFromSourceSystem | Boolean | Indicates whether data of an item is derived from a source system or authored by a user. |
| AccessInstructionsRoles | String | Roles of Database. |
| AccessInstructionsRoleMembers | String | Members whom roles was assigned. |
| AccessInstructionsTimestamp | Datetime | Created time of access instructions. |
| DocumentationType | String | Type of documentation. |
| DocumentationId | String | Id of a documentation. |
| DocumentationEffectiveRights | String | Rights a particular documentation has. |
| DocumentationMimeType | String | Mime type a documentation. |
| DocumentationContent | String | Content of a documentation. |
| DocumentationFromSourceSystem | Boolean | Indicates whether data of an item is derived from a source system or authored by a user. |
| DocumentationRoles | String | Roles of a documentation. |
| DocumentationRoleMembers | String | Members whom roles was assigned. |
| DocumentationTimestamp | Datetime | Created time of documentation. |
| FriendlyName | String | Name of a friendly name. |
| FriendlyNameId | String | Id of a friendly name. |
| FriendlyNameType | String | Type of friendly name. |
| FriendlyNameEffectiveRights | String | Rights a particular friendly name has. |
| FriendlyNameFromSourceSystem | Boolean | Indicates whether data of an item is derived from a source system or authored by a user. |
| FriendlyNameRoles | String | Roles of friendly name. |
| FriendlyNameRoleMembers | String | Members whom roles was assigned. |
| FriendlyNameTimestamp | Datetime | Created time of friendly name. |
| Experts | String | Check items where the data source expert matches the search term. |
| Description | String | Description of databases. |
| Tags | String | Tags available in databases. |
| Facets | String | A comma separated field names to facet the results on. |
| View | String | Name of the view the client wants to see. |
| HasTags | Boolean | Check items that have a tag. |
| HasPreviews | Boolean | Check items that contain a preview. |
| HasDocumentation | Boolean | Check items that contain documentation. |
| HasTableDataProfiles | Boolean | Check items that have a table profile. |
| HasColumnsDataProfiles | Boolean | Check items that have a columns data profile. |
| HasDescription | Boolean | Check items that have a description. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| LastRegisteredTime | Date | Date and time when the metadata was registered. |
Get list of descriptions of databases, tables, and objects.
The Sync App will use the Azure Data Catalog API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
SELECT * FROM Descriptions WHERE CONTAINS(Description, 'sakila') AND ObjectType = table;
SELECT * FROM Descriptions WHERE CONTAINS(Name, 'customer') AND HasTags = true;
| Name | Type | Description |
| Id | String | Id of a description. |
| Type | String | Type of description. |
| EffectiveRights | String | Rights a particular annotation has. |
| PropertyDescription | String | Content in description. |
| PropertyFromSourceSystem | Boolean | Indicates whether data of an item is derived from a source system or authored by a user. |
| PropertyKey | String | Key of a description. |
| Roles | String | Roles of a description. |
| RoleMembers | String | Members whom roles was assigned. |
| Timestamp | Datetime | Created time of description. |
| Name | String | Name of a table, database, object. |
| ObjectType | String | Type of object. Eg. table, etc. |
| SourceType | String | Source type. Eg. Jdbc, Odbc, etc. |
| FriendlyName | String | Check items where the search term appears in the data source friendly name. |
| Experts | String | Check items where the data source expert matches the search term. |
| Description | String | Content of a description. |
| Tags | String | Tags available in descriptions. |
| HasTags | Boolean | Check items that have a tag. |
| HasPreviews | Boolean | Check items that contain preview. |
| HasDocumentation | Boolean | Check items that contain documentation. |
| HasTableDataProfiles | Boolean | Check items that have a table profile. |
| HasColumnsDataProfiles | Boolean | Check items that have a columns data profile. |
| HasDescription | Boolean | Check items that have a description. |
| View | String | Name of the view the client wants to see. |
| Facets | String | A comma separated field names to facet the results on. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| LastRegisteredTime | Date | Date and time when the metadata was registered. |
Get list of experts of databases, tables, and objects.
The Sync App will use the Azure Data Catalog API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
SELECT * FROM Experts WHERE ObjectType = 'table' AND CONTAINS(Experts, 'support')
SELECT * FROM Experts WHERE Tags = 'orders' OR Name = 'orders' AND ObjectType = 'table';
| Name | Type | Description |
| Id | String | Id of an expert. |
| Type | String | Type of expert. |
| EffectiveRights | String | Rights a particular annotation has. |
| FromSourceSystem | Boolean | Indicates whether data of an item is derived from a source system or authored by a user. |
| Key | String | Key of an expert. |
| ExpertObjectId | String | Object Id of an expert. |
| ExpertUPN | String | User Principal Name of an expert. |
| Roles | String | Roles of an expert. |
| RoleMembers | String | Members whom roles was assigned. |
| Timestamp | Datetime | Created time of experts. |
| Name | String | Name of a table, database, object. |
| ObjectType | String | Type of object. Eg. table, etc. |
| SourceType | String | Source type. Eg. Jdbc, Odbc, etc. |
| FriendlyName | String | Check items where the search term appears in the data source friendly name. |
| Experts | String | Check items where the data source expert matches the search term. |
| Description | String | Description of an expert. |
| Tags | String | Tags available for experts. |
| HasTags | Boolean | Check items that have a tag. |
| HasPreviews | Boolean | Check items that contain a preview. |
| HasDocumentation | Boolean | Check items that contain documentation. |
| HasTableDataProfiles | Boolean | Check items that have a table profile. |
| HasColumnsDataProfiles | Boolean | Check items that have a columns data profile. |
| HasDescription | Boolean | Check items that have a description. |
| View | String | Name of the view the client wants to see. |
| Facets | String | A comma separated field names to facet the results on. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| LastRegisteredTime | Date | Date and time when the metadata was registered. |
Get list datasource properties.
The Sync App will use the Azure Data Catalog API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
SELECT * FROM Objects WHERE Tags <> 'sales';
SELECT * FROM Objects WHERE Name = 'sales' AND HasTags = true;
SELECT * FROM Objects WHERE CONTAINS(Tags, 'sales') AND CONTAINS(Tags, 'customer');
| Name | Type | Description |
| Id | String | Id of an Object. |
| Type | String | Type of an Object. |
| EffectiveRights | String | Rights a particular annotation has. |
| Name | String | Name of an Object. |
| ObjectType | String | Type of object. Eg. table, etc. |
| SourceType | String | Source type. Eg. Jdbc, Odbc, etc. |
| DslAuthentication | String | Type of authentication used. |
| DslProtocol | String | Describes a protocol used to communicate with the data source. |
| FromSourceSystem | Boolean | Indicates whether data of an item is derived from a source system or authored by a user. |
| LastRegisteredByObjectId | String | Object Id of a user. |
| LastRegisteredByUpn | String | User Principal Name of a user. |
| Roles | String | Roles of Database. |
| RoleMembers | String | Members whom roles was assigned. |
| Timestamp | Datetime | Created time of an Object. |
| AccessInstructionsId | String | Id of access instructions. |
| AccessInstructionsType | String | Type of access instructions. |
| AccessInstructionsEffectiveRights | String | Rights a particular annotation has. |
| AccessInstructionsMimeType | String | Mime type of a documentation. |
| AccessInstructionsContent | String | Content of a documentation. |
| AccessInstructionsFromSourceSystem | Boolean | Indicates whether data of an item is derived from a source system or authored by a user. |
| AccessInstructionsRoles | String | Roles of an object. |
| AccessInstructionsRoleMembers | String | Members whom roles was assigned. |
| AccessInstructionsTimestamp | Datetime | Created time of an object. |
| FriendlyName | String | Check items where the search term appears in the data source friendly name. |
| Experts | String | Check items where the data source expert matches the search term. |
| Description | String | Description of objects. |
| Tags | String | Tags available for objects. |
| HasTags | Boolean | Check items that have a tag. |
| HasPreviews | Boolean | Check items that contain a preview. |
| HasDocumentation | Boolean | Check items that contain documentation. |
| HasTableDataProfiles | Boolean | Check items that have a table profile. |
| HasColumnsDataProfiles | Boolean | Check items that have a columns data profile. |
| HasDescription | Boolean | Check items that have a description. |
| View | String | Name of the view the client wants to see. |
| Facets | String | A comma separated field names to facet the results on. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| LastRegisteredTime | String | Date and time when the metadata was registered. |
Get details of table schema.
The Sync App will use the Azure Data Catalog API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
SELECT * FROM TableColumns WHERE ItemId = '8a2b7305-b474-45d6-9fba-57e954565070'
| Name | Type | Description |
| Database | String | Name of the database. |
| TableName | String | Name of the table. |
| ColumnName | String | Name of the column or attribute. |
| Type | String | Data type of the column or attribute. The Allowable types depend on data sourceType of the asset. |
| MaxLength | Integer | The maximum length allowed for the column or attribute. Derived from data source. |
| Precision | Integer | The precision for the column or attribute. Derived from data source. |
| IsNullable | Boolean | Whether the column is allowed to have a null value or not. Derived from data source. |
| Expression | String | If the value is a calculated column, this field contains the expression that expresses the value. Derived from data source. |
| ItemId | String | Item Id of a view or table. |
Get list of table data profiles.
The Sync App will use the Azure Data Catalog API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
SELECT * FROM TableDataProfiles WHERE NOT Tags = 'FactProductInventory'
SELECT * FROM TableDataProfiles WHERE Timestamp > '2019-09-20T04:39:54.0083651Z';
| Name | Type | Description |
| Id | String | Id of a table data profile. |
| Type | String | Type of table data profile. |
| EffectiveRights | String | Rights a particular table data profile has. |
| Tag | String | Name of the tag. |
| FromSourceSystem | Boolean | Indicates whether data of an item is derived from a source system or authored by a user. |
| Key | String | Key of a table data profiles. |
| Roles | String | Roles of table data profiles. |
| RoleMembers | String | Members whom roles was assigned. |
| Timestamp | Datetime | Created time of table data profiles. |
| SourceType | String | Source type. Eg. Jdbc, Odbc, etc. |
| FriendlyName | String | Check items where the search term appears in the data source friendly name. |
| Experts | String | Check items where the data source expert matches the search term. |
| Description | String | Description of table data profiles. |
| Tags | String | Tags available in table data profiles. |
| HasTags | Boolean | Check items that have a tag. |
| HasPreviews | Boolean | Check items that contain preview. |
| HasDocumentation | Boolean | Check items that contain documentation. |
| HasTableDataProfiles | Boolean | Check items that have a table profile. |
| HasColumnsDataProfiles | Boolean | Check items that have a columns data profile. |
| HasDescription | Boolean | Check items that have a description. |
| View | String | Name of the view the client wants to see. |
| Facets | String | A comma separated field names to facet the results on. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| LastRegisteredTime | Date | Date and time when the metadata was registered. |
Get list of tables in the data asset.
The Sync App will use the Azure Data Catalog API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
SELECT * FROM Tables WHERE Tags = 'sales' OR Name = 'FactProductInventory';
SELECT * FROM Tables WHERE Tags != 'FactProductInventory' AND NOT Tags = 'sales';
SELECT * FROM Tables WHERE NOT Tags = 'FactProductInventory';
| Name | Type | Description |
| Id | String | Id of a table. |
| Type | String | Type of table. |
| EffectiveRights | String | Rights a particular annotation has. |
| Roles | String | Roles of a table. |
| RoleMembers | String | Members to whom the role was assigned. |
| Timestamp | Datetime | Created time of table. |
| ItemId | String | Item Id of the table or view. |
| Name | String | Name of a table. |
| ContainerId | String | Id of a container. |
| ObjectType | String | Type of object. Eg. table, etc. |
| SourceType | String | Source type. Eg. Jdbc, Odbc, etc. |
| DslAddressDatabase | String | Name of the database. |
| DslAddressObject | String | Object of a table. |
| DslAddressOptionsDriver | String | Name of the driver. |
| DslAddressOptionsPort | String | Port number. |
| DslAddressOptionsServer | String | IP address of the server. |
| DslAuthentication | String | Type of authentication used. |
| DslProtocol | String | Describes a protocol used to communicate with the data source. |
| FromSourceSystem | Boolean | Indicates whether data of an item is derived from a source system or authored by a user. |
| LastRegisteredByFirstName | String | First name of the registered user. |
| LastRegisteredByLastName | String | Last name of the registered user. |
| LastRegisteredByObjectId | String | Object Id of a user. |
| LastRegisteredByUpn | String | User Principal Name of a user. |
| AccessInstructionsId | String | Id of access instructions. |
| AccessInstructionsType | String | Type of access instructions. |
| AccessInstructionsEffectiveRights | String | Rights a particular annotation has. |
| AccessInstructionsMimeType | String | Mime type of access instructions. |
| AccessInstructionsContent | String | Content described in access instructions. |
| AccessInstructionsFromSourceSystem | Boolean | Indicates whether data of an item is derived from a source system or authored by a user. |
| AccessInstructionsRoles | String | Roles of table. |
| AccessInstructionsRoleMembers | String | Members to whom the role was assigned. |
| AccessInstructionsTimestamp | Datetime | Created time of table. |
| SchemaId | String | Id of a schema. |
| SchemaType | String | Type of schema. |
| SchemaEffectiveRights | String | Rights a particular annotation has. |
| SchemaFromSourceSystem | Boolean | Indicates whether data of an item is derived from a source system or authored by a user. |
| SchemaRoles | String | Roles of an schema for table. |
| SchemaRoleMembers | String | Members whom roles was assigned. |
| SchemaTimestamp | Datetime | Created time of an schema for table. |
| DocumentationId | String | Id of a documentation. |
| DocumentationType | String | Type of documentation. |
| DocumentationEffectiveRights | String | Rights a particular documentation has. |
| DocumentationMimeType | String | Mime type of a documentation. |
| DocumentationContent | String | Content of a documentation. |
| DocumentationFromSourceSystem | Boolean | Indicates whether data of an item is derived from a source system or authored by a user. |
| DocumentationRoles | String | Roles of an documentation for table. |
| DocumentationRoleMembers | String | Members whom roles was assigned. |
| DocumentationTimestamp | Datetime | Created time of an documentation for table. |
| FriendlyName | String | Name of a friendly name. |
| FriendlyNameId | String | Id of a friendly name. |
| FriendlyNameType | String | Type of friendly name. |
| FriendlyNameEffectiveRights | String | Rights a particular annotation has. |
| FriendlyNameFromSourceSystem | Boolean | Indicates whether data of an item is derived from a source system or authored by a user. |
| FriendlyNameRoles | String | Roles of an friendly name for table. |
| FriendlyNameRoleMembers | String | Members whom roles was assigned. |
| FriendlyNameTimestamp | Datetime | Created time of an friendly name for table. |
| Experts | String | Check items where the data source expert matches the search term. |
| Description | String | Description of table. |
| Tags | String | Tags available in tables. |
| HasTags | Boolean | Check items that have a tag. |
| HasPreviews | Boolean | Check items that contain preview. |
| HasDocumentation | Boolean | Check items that contain documentation. |
| HasTableDataProfiles | Boolean | Check items that have a table profile. |
| HasColumnsDataProfiles | Boolean | Check items that have a columns data profile. |
| HasDescription | Boolean | Check items that have a description. |
| View | String | Name of the view the client wants to see. |
| Facets | String | A comma separated field names to facet the results on. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| LastRegisteredTime | Date | Date and time when the metadata was registered. |
Get list of tags of databases, tables, and objects.
The Sync App will use the Azure Data Catalog API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
SELECT * FROM Tags WHERE HasTags = 'true' AND CONTAINS(Name, 'sales')
SELECT * FROM Tags WHERE FriendlyName <> 'sales';
| Name | Type | Description |
| Id | String | Id of the tag. |
| Type | String | Type of tag. |
| EffectiveRights | String | Rights a particular tag has. |
| Tag | String | Name of the tag. |
| FromSourceSystem | Boolean | Indicates whether item data is derived from a source system or authored by a user. |
| Key | String | Key of a tag. |
| Roles | String | Roles of tag. |
| RoleMembers | String | Members to whom the role was assigned. |
| Timestamp | Datetime | Created time of tag. |
| Name | String | Name of a table, database, object. |
| ObjectType | String | Type of object. Eg. table, etc. |
| SourceType | String | Source type. Eg. Jdbc, Odbc, etc. |
| FriendlyName | String | Check items where the search term appears in the data source friendly name. |
| Experts | String | Check items where the data source expert matches the search term. |
| Description | String | Description of the tag. |
| HasTags | Boolean | Check items that have a tag. |
| HasPreviews | Boolean | Check items that contain preview. |
| HasDocumentation | Boolean | Check items that contain documentation. |
| HasTableDataProfiles | Boolean | Check items that have a table profile. |
| HasColumnsDataProfiles | Boolean | Check items that have a columns data profile. |
| HasDescription | Boolean | Check items that have a description. |
| View | String | Name of the view the client wants to see. |
| Facets | String | A comma separated field names to facet the results on. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| LastRegisteredTime | Date | Date and time when the tag was registered. |
| プロパティ | 説明 |
| AuthScheme | Azure Data Catalog に接続する際に使用する認証の種類を指定します。このプロパティが空白の場合は、デフォルトの認証が使用されます。 |
| CatalogName | The name of the catalog to connect to. |
| プロパティ | 説明 |
| AzureTenant | データにアクセスするために使用されるAzure Data Catalog テナントを、名前(例えば、contoso.omnicrosoft.com)またはID で識別します。(条件付き) |
| AzureEnvironment | 接続するAzure ネットワーク環境を指定します。Azure アカウントが追加されたネットワークと同じである必要があります。 |
| プロパティ | 説明 |
| OAuthClientId | カスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。(コンシューマーキーとも呼ばれます。)このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。 |
| OAuthClientSecret | カスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。( コンシューマーシークレット とも呼ばれます。)このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。 |
| プロパティ | 説明 |
| OAuthJWTCert | JWT 証明書のストア。 |
| OAuthJWTCertType | JWT 証明書を格納するキーストアの種類。 |
| OAuthJWTCertPassword | OAuth JWT 証明書のパスワード。パスワードを必要とする証明書ストアにアクセスするために使用されます。証明書ストアがパスワードを必要としない場合は、このプロパティを空白のままにします。 |
| OAuthJWTCertSubject | OAuth JWT 証明書のサブジェクトで、ストアで一致する証明書を検索するために使用されます。部分一致と、先頭の証明書を選択するためのワイルドカード '*' をサポートします。 |
| プロパティ | 説明 |
| SSLServerCert | TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。 |
| プロパティ | 説明 |
| FirewallType | provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。 |
| FirewallServer | ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。 |
| FirewallPort | プロキシベースのファイアウォールで使用するTCP ポートを指定します。 |
| FirewallUser | プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。 |
| FirewallPassword | プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。 |
| プロパティ | 説明 |
| ProxyAutoDetect | provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。 |
| ProxyServer | HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。 |
| ProxyPort | クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバー(ProxyServer 接続プロパティで設定)のTCP ポート。 |
| ProxyAuthScheme | ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。 |
| ProxyUser | ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名。 |
| ProxyPassword | ProxyUser 接続プロパティで指定されたユーザーに紐付けられたパスワード。 |
| ProxySSLType | ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプ。 |
| ProxyExceptions | ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。 |
| プロパティ | 説明 |
| LogModules | ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。 |
| プロパティ | 説明 |
| Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。 |
| BrowsableSchemas | レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
| Tables | レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。 |
| Views | レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。 |
| プロパティ | 説明 |
| MaxRows | 集計やGROUP BY を使用しないクエリで返される最大行数を指定します。 |
| Other | 特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。 |
| Pagesize | Azure Data Catalog から返される、1ページあたりの結果の最大数を指定します。この設定は、ほとんどのユースケースに最適化されている、データソースによって設定されたデフォルトのページサイズをオーバーライドします。 |
| PseudoColumns | テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。 |
| Timeout | provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。 |
| UserDefinedViews | カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。 |
このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。
| プロパティ | 説明 |
| AuthScheme | Azure Data Catalog に接続する際に使用する認証の種類を指定します。このプロパティが空白の場合は、デフォルトの認証が使用されます。 |
| CatalogName | The name of the catalog to connect to. |
Azure Data Catalog に接続する際に使用する認証の種類を指定します。このプロパティが空白の場合は、デフォルトの認証が使用されます。
Azure AD で認証するためのカスタムアプリケーションの作成方法については、Azure AD アプリケーションの作成 を参照してください。
Azure AD サービスプリンシパルで認証するためのカスタムアプリケーションの作成方法については、サービスプリンシパルによるAzure AD アプリの作成 を参照してください。
The name of the catalog to connect to.
If left blank, the default catalog will be used. To obtain a given CatalogName, navigate to the Azure Portal home page -> Data Catalog -> Catalog Name.
このセクションでは、本プロバイダーの接続文字列で設定可能なAzure Authentication プロパティの全リストを提供します。
| プロパティ | 説明 |
| AzureTenant | データにアクセスするために使用されるAzure Data Catalog テナントを、名前(例えば、contoso.omnicrosoft.com)またはID で識別します。(条件付き) |
| AzureEnvironment | 接続するAzure ネットワーク環境を指定します。Azure アカウントが追加されたネットワークと同じである必要があります。 |
データにアクセスするために使用されるAzure Data Catalog テナントを、名前(例えば、contoso.omnicrosoft.com)またはID で識別します。(条件付き)
テナントは、主にドメイン(例えば、microsoft.com)に関連付けられた、組織のデジタル表現です。 テナントは、Tenant ID(ディレクトリID とも呼ばれる)によって管理されます。これは、Azure リソースへのアクセスや管理権限をユーザーに割り当てる際に指定します。
Azure ポータルでディレクトリID を見つけるには、Azure Active Directory -> プロパティに移動します。
AuthScheme = AzureServicePrincipal またはAzureServicePrincipalCert のいずれかである場合、またはAzureTenant = AzureAD であり、ユーザーが複数のテナントに属している場合は、AzureTenant を指定する必要があります。
接続するAzure ネットワーク環境を指定します。Azure アカウントが追加されたネットワークと同じである必要があります。
Azure アカウントがGlobal ネットワークとは異なるネットワーク(China、USGOVT、USGOVTDOD など)の一部である場合は、必要です。
このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。
| プロパティ | 説明 |
| OAuthClientId | カスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。(コンシューマーキーとも呼ばれます。)このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。 |
| OAuthClientSecret | カスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。( コンシューマーシークレット とも呼ばれます。)このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。 |
カスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。(コンシューマーキーとも呼ばれます。)このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。
OAuthClientId は、ユーザーがOAuth 経由で認証を行う前に設定する必要があるいくつかの接続パラメータの1つです。詳細は接続の確立を参照してください。
カスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。( コンシューマーシークレット とも呼ばれます。)このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。
OAuthClientSecret は、ユーザーがOAuth 経由で認証を行う前に設定する必要があるいくつかの接続パラメータの1つです。詳細は接続の確立を参照してください。
このセクションでは、本プロバイダーの接続文字列で設定可能なJWT OAuth プロパティの全リストを提供します。
| プロパティ | 説明 |
| OAuthJWTCert | JWT 証明書のストア。 |
| OAuthJWTCertType | JWT 証明書を格納するキーストアの種類。 |
| OAuthJWTCertPassword | OAuth JWT 証明書のパスワード。パスワードを必要とする証明書ストアにアクセスするために使用されます。証明書ストアがパスワードを必要としない場合は、このプロパティを空白のままにします。 |
| OAuthJWTCertSubject | OAuth JWT 証明書のサブジェクトで、ストアで一致する証明書を検索するために使用されます。部分一致と、先頭の証明書を選択するためのワイルドカード '*' をサポートします。 |
JWT 証明書のストア。
クライアント証明書のための証明書ストア名。
OAuthJWTCertType フィールドは、OAuthJWTCert により指定された証明書ストアの種類を指定します。 ストアがパスワードで保護されている場合は、OAuthJWTCertPassword でパスワードを指定します。
OAuthJWTCert は、OAuthJWTCertSubject フィールドとともにクライアント証明書を指定するために使われます。 OAuthJWTCert に値がある場合で、OAuthJWTCertSubject が設定されている場合は、証明書の検索が始まります。 詳しくは、OAuthJWTCertSubject フィールドを参照してください。
証明書ストアの指定はプラットフォームに依存します。
Windows の共通のユーザとシステム証明書ストアの指定は以下のとおりです。
| MY | 個人証明書と関連付けられた秘密キーを格納している証明書ストア。 |
| CA | 証明機関の証明書。 |
| ROOT | ルート証明書。 |
| SPC | ソフトウェア発行元証明書。 |
Javaでは、証明書ストアは通常、証明書および任意の秘密キーを含むファイルです。
証明書ストアの種類がPFXFile の場合は、このプロパティにファイル名を設定します。 PFXBlob の場合は、このプロパティをPFX ファイルのバイナリコンテンツ(例えば、PKCS12証明書ストア)に設定する必要があります。
JWT 証明書を格納するキーストアの種類。
このプロパティには次の値の一つを設定できます。
| USER | Windows の場合、現在のユーザーにより所有された証明書ストアであることを指定します。 Note:この種類はJava では利用できません。 |
| MACHINE | Windows の場合、この証明書ストアがシステムストアであることを指定します。 Note:この種類はJava では利用できません。 |
| PFXFILE | この証明書ストアは、証明書を含むPFX(PKCS12)ファイルの名前です。 |
| PFXBLOB | この証明書ストアは、PFX(PKCS12)形式の証明書ストアを表すBase-64でエンコードされた文字列です。 |
| JKSFILE | この証明書ストアは、証明書を含むJava key store(JKS)ファイルの名前です。 Note:この種類はJava のみで利用できます。 |
| JKSBLOB | この証明書ストアは、Java key store(JKS)形式の証明書ストアを表すBase-64でエンコードされた文字列です。 Note:この種類はJava のみで利用できます。 |
| PEMKEY_FILE | この証明書ストアは、秘密キーと任意の証明書を含むPEM でエンコードされたファイルの名前です。 |
| PEMKEY_BLOB | この証明書ストアは、秘密キーと任意の証明書を含むBase-64でエンコードされた文字列です。 |
| PUBLIC_KEY_FILE | この証明書ストアは、PEM またはDER でエンコードされた公開キーの証明書を含むファイルの名前です。 |
| PUBLIC_KEY_BLOB | この証明書ストアは、PEM またはDER でエンコードされた公開キーの証明書を含むBase-64でエンコードされた文字列です。 |
| SSHPUBLIC_KEY_FILE | この証明書ストアは、SSH 公開キーを含むファイルの名前です。 |
| SSHPUBLIC_KEY_BLOB | この証明書ストアは、SSH 公開キーを含むBase-64でエンコードされた文字列です。 |
| P7BFILE | この証明書ストアは、証明書を含むPKCS7 ファイルの名前です。 |
| PPKFILE | この証明書ストアは、PuTTY 秘密キー(PPK)を含むファイルの名前です。 |
| XMLFILE | この証明書ストアは、XML 形式の証明書を含むファイルの名前です。 |
| XMLBLOB | この証明書ストアは、XML 形式の証明書を含む文字列の名前です。 |
| BCFKSFILE | この証明書ストアは、Bouncy Castle キーストアを含むファイルの名前です。 |
| BCFKSBLOB | この証明書ストアは、Bouncy Castle キーストアを含む文字列(Base-64エンコード)です。 |
OAuth JWT 証明書のパスワード。パスワードを必要とする証明書ストアにアクセスするために使用されます。証明書ストアがパスワードを必要としない場合は、このプロパティを空白のままにします。
このプロパティは、証明書ストアを開くために必要なパスワードを指定します。ただし、ストアの種類がパスワードを必要とする場合に限ります。 パスワードが必要かどうかを判断するには、ご利用の証明書ストアのドキュメントまたは設定を参照してください。
OAuth JWT 証明書のサブジェクトで、ストアで一致する証明書を検索するために使用されます。部分一致と、先頭の証明書を選択するためのワイルドカード '*' をサポートします。
このプロパティの値は、ストアで一致する証明書を検索するために使用されます。検索プロセスは以下のように動作します。
値を '*' に設定すると、ストアの先頭の証明書が自動的に選択されます。 証明書のサブジェクトは識別名フィールドおよび値のカンマ区切りのリストです。 例:CN=www.server.com, OU=test, C=US, [email protected]。一般的なフィールドには以下のものが含まれます。
| フィールド | 説明 |
| CN | 共通名。一般的には、www.server.com のようなホスト名です。 |
| O | 法人名 |
| OU | 法人の部署名 |
| L | 法人の住所(市町村名) |
| S | 法人の住所(都道府県) |
| C | 国名 |
| E | E メールアドレス |
フィールド値にカンマが含まれる場合は、引用符で囲んでください。例:"O=ACME, Inc."。
このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。
| プロパティ | 説明 |
| SSLServerCert | TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。 |
TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。
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 |
これを指定しない場合は、マシンが信用するすべての証明書が受け入れられます。
すべての証明書の受け入れを示すには、'*'を使用します。セキュリティ上の理由から、これはお勧めできません。
このセクションでは、本プロバイダーの接続文字列で設定可能なFirewall プロパティの全リストを提供します。
| プロパティ | 説明 |
| FirewallType | provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。 |
| FirewallServer | ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。 |
| FirewallPort | プロキシベースのファイアウォールで使用するTCP ポートを指定します。 |
| FirewallUser | プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。 |
| FirewallPassword | プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。 |
provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。
プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
Note:デフォルトでは、Sync App はシステムプロキシに接続します。この動作を無効化し、次のプロキシタイプのいずれかに接続するには、ProxyAutoDetect をfalse に設定します。
次の表は、サポートされている各プロトコルのポート番号情報です。
| プロトコル | デフォルトポート | 説明 |
| TUNNEL | 80 | Sync App がAzure Data Catalog への接続を開くポート。トラフィックはこの場所のプロキシを経由して行き来します。 |
| SOCKS4 | 1080 | Sync App がAzure Data Catalog への接続を開くポート。SOCKS 4 は次にFirewallUser 値をプロキシに渡し、接続リクエストが許容されるかどうかを決定します。 |
| SOCKS5 | 1080 | Sync App がAzure Data Catalog にデータを送信するポート。SOCKS 5 プロキシに認証が必要な場合には、FirewallUser およびFirewallPassword をプロキシが認識する認証情報に設定します。 |
HTTP プロキシへの接続には、ProxyServer およびProxyPort ポートを使ってください。HTTP プロキシへの認証には、ProxyAuthScheme、ProxyUser、およびProxyPassword を使ってください。
ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。
プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
プロキシベースのファイアウォールで使用するTCP ポートを指定します。
プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。
プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。
プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
このセクションでは、本プロバイダーの接続文字列で設定可能なProxy プロパティの全リストを提供します。
| プロパティ | 説明 |
| ProxyAutoDetect | provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。 |
| ProxyServer | HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。 |
| ProxyPort | クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバー(ProxyServer 接続プロパティで設定)のTCP ポート。 |
| ProxyAuthScheme | ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。 |
| ProxyUser | ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名。 |
| ProxyPassword | ProxyUser 接続プロパティで指定されたユーザーに紐付けられたパスワード。 |
| ProxySSLType | ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプ。 |
| ProxyExceptions | ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。 |
provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。
この接続プロパティをTrue に設定すると、Sync App は既存のプロキシサーバー構成についてシステムプロキシ設定をチェックします(プロキシサーバーの詳細を手動で入力する必要はありません)。
この接続プロパティは他のプロキシ設定より優先されます。特定のプロキシサーバーに接続するためにSync App を手動で構成する場合は、False に設定します。
HTTP プロキシへの接続には、ProxyServer を参照してください。SOCKS やトンネリングなどの他のプロキシには、FirewallType を参照してください。
HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。
ProxyAutoDetect がFalse に設定されている場合、Sync App はこの接続プロパティで指定されたプロキシサーバーを通じてのみHTTP トラフィックをルーティングします。ProxyAutoDetect がTrue に設定されている場合(デフォルト)、Sync App は代わりにシステムプロキシ設定で指定されたプロキシサーバーを介してHTTP トラフィックをルーティングします。
クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバー(ProxyServer 接続プロパティで設定)のTCP ポート。
ProxyAutoDetect がFalse に設定されている場合、Sync App はこの接続プロパティで指定されたプロキシサーバーポートを通じてのみHTTP トラフィックをルーティングします。ProxyAutoDetect がTrue に設定されている場合(デフォルト)、Sync App は代わりにシステムプロキシ設定で指定されたプロキシサーバーポートを介してHTTP トラフィックをルーティングします。
その他のプロキシタイプについては、FirewallType を参照してください。
ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。
認証タイプは次のいずれかです。
"NONE" 以外のすべての値については、ProxyUser およびProxyPassword 接続プロパティも設定する必要があります。
SOCKS 5 認証のような他の認証タイプを使用するには、FirewallType を参照してください。
ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名。
ProxyUser および ProxyPassword 接続プロパティは、ProxyServer で指定されたHTTP プロキシに対して接続よび認証するために使用されます。
ProxyAuthScheme で利用可能な認証タイプを1つ選択した後、このプロパティを以下のように設定します。
| ProxyAuthScheme の値 | ProxyUser に設定する値 |
| BASIC | プロキシサーバーに登録されているユーザーのユーザー名。 |
| DIGEST | プロキシサーバーに登録されているユーザーのユーザー名。 |
| NEGOTIATE | プロキシサーバーが属するドメインまたは信頼されたドメイン内の有効なユーザーであるWindows ユーザーのユーザー名。user@domain またはdomain\user の形式で指定。 |
| NTLM | プロキシサーバーが属するドメインまたは信頼されたドメイン内の有効なユーザーであるWindows ユーザーのユーザー名。user@domain またはdomain\user の形式で指定。 |
| NONE | ProxyPassword 接続プロパティは設定しないでください。 |
Sync App は、ProxyAutoDetect がFalse に設定されている場合にのみ、このユーザー名を使用します。ProxyAutoDetect がTrue に設定されている場合(デフォルト)、Sync App は代わりにシステムのプロキシ設定で指定されているユーザー名を使用します。
ProxyUser 接続プロパティで指定されたユーザーに紐付けられたパスワード。
ProxyUser および ProxyPassword 接続プロパティは、ProxyServer で指定されたHTTP プロキシに対して接続よび認証するために使用されます。
ProxyAuthScheme で利用可能な認証タイプを1つ選択した後、このプロパティを以下のように設定します。
| ProxyAuthScheme の値 | ProxyPassword に設定する値 |
| BASIC | ProxyUser で指定したプロキシサーバーユーザーに紐付けられたパスワード。 |
| DIGEST | ProxyUser で指定したプロキシサーバーユーザーに紐付けられたパスワード。 |
| NEGOTIATE | ProxyUser で指定したWindows ユーザーアカウントに紐付けられたパスワード。 |
| NTLM | ProxyUser で指定したWindows ユーザーアカウントに紐付けられたパスワード。 |
| NONE | ProxyPassword 接続プロパティは設定しないでください。 |
SOCKS 5 認証もしくは、トンネリングは、FirewallType を参照してください。
Sync App は、ProxyAutoDetect がFalse に設定されている場合にのみ、このパスワードを使用します。ProxyAutoDetect がTrue に設定されている場合(デフォルト)、Sync App は代わりにシステムのプロキシ設定で指定されているパスワードを使用します。
ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプ。
このプロパティは、ProxyServer で指定されたHTTP プロキシへの接続にSSL を使用するかどうかを決定します。この接続プロパティには、以下の値を設定できます。
| AUTO | デフォルト設定。ProxyServer がHTTPS URL に設定されている場合、Sync App は、TUNNEL オプションを使用します。ProxyServer がHTTP URL に設定されている場合、コンポーネントはNEVER オプションを使用します。 |
| ALWAYS | 接続は、常にSSL 有効となります。 |
| NEVER | 接続は、SSL 有効になりません。 |
| TUNNEL | 接続はトンネリングプロキシ経由で行われます。プロキシサーバーがリモートホストへの接続を開き、プロキシを経由して通信が行われます。 |
ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。
ProxyServer は、このプロパティで定義されたアドレスを除くすべてのアドレスに使用されます。セミコロンを使用してエントリを区切ります。
Sync App はデフォルトでシステムプロキシ設定を使用するため、それ以上の設定は必要ありません。この接続にプロキシ例外を明示的に設定する場合は、ProxyAutoDetect をFalse に設定します。
このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。
| プロパティ | 説明 |
| LogModules | ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。 |
ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。
このプロパティは、含めるログモジュールを指定することでログファイルの内容をカスタマイズすることができます。 ログモジュールは、クエリ実行、メタデータ、SSL 通信などの異なる領域にログ情報を分類します。 各モジュールは4文字のコードで表され、文字の名前の場合は末尾にスペースが必要なものもあります。
例えば、EXEC はクエリ実行をログに記録し、INFO は一般的なプロバイダーメッセージをログに記録します。 複数のモジュールを含めるには、次のように名前をセミコロンで区切ります:INFO;EXEC;SSL。
Verbosity 接続プロパティは、このプロパティで指定されたモジュールベースのフィルタリングよりも優先されます。 Verbosity レベルを満たし、指定されたモジュールに属するログエントリのみが記録されます。 利用可能なすべてのモジュールをログファイルに含めるには、このプロパティを空白のままにします。
利用可能なモジュールの完全なリストとログの設定に関する詳細な手引きについては、ログ の「高度なログの記録」セクションを参照してください。
このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。
| プロパティ | 説明 |
| Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。 |
| BrowsableSchemas | レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
| Tables | レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。 |
| Views | レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。 |
テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。
Location プロパティは、定義をカスタマイズしたり(例えば、カラム名を変更する、カラムを無視するなど)、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。
指定しない場合、デフォルトの場所は%APPDATA%\\CData\\AzureDataCatalog Data Provider\\Schema となり、%APPDATA%はユーザーのコンフィギュレーションディレクトリに設定されます:
| プラットフォーム | %APPDATA% |
| Windows | APPDATA 環境変数の値 |
| Linux | ~/.config |
レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
利用可能なデータベーススキーマをすべてリストすると余分な時間がかかり、パフォーマンスが低下します。 接続文字列にスキーマのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。
レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。
データベースによっては、利用可能なすべてのテーブルをリストするのに時間がかかり、パフォーマンスが低下する場合があります。 接続文字列にテーブルのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。
利用可能なテーブルがたくさんあり、すでに作業したいテーブルが決まっている場合、このプロパティを使用して対象のテーブルのみに表示を制限することができます。これを行うには、カンマ区切りのリストで使用したいテーブルを指定します。各テーブルは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space` です。
Note:複数のスキーマまたはカタログを持つデータソースに接続する場合は、表示する各テーブルを完全修飾名で指定する必要があります。これにより、複数のカタログやスキーマに存在するテーブルが混同されることを防ぎます。
レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。
データベースによっては、利用可能なすべてのビューをリストするのに時間がかかり、パフォーマンスが低下する場合があります。 接続文字列にビューのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。
利用可能なビューがたくさんあり、すでに作業したいビューが決まっている場合、このプロパティを使用して対象のビューのみに表示を制限することができます。これを行うには、カンマ区切りのリストで使用したいビューを指定します。各ビューは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space` です。
Note:複数のスキーマまたはカタログを持つデータソースに接続する場合は、確認する各ビューを完全修飾名で指定する必要があります。これにより、複数のカタログやスキーマに存在するビューが混同されることを防ぎます。
このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。
| プロパティ | 説明 |
| MaxRows | 集計やGROUP BY を使用しないクエリで返される最大行数を指定します。 |
| Other | 特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。 |
| Pagesize | Azure Data Catalog から返される、1ページあたりの結果の最大数を指定します。この設定は、ほとんどのユースケースに最適化されている、データソースによって設定されたデフォルトのページサイズをオーバーライドします。 |
| PseudoColumns | テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。 |
| Timeout | provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。 |
| UserDefinedViews | カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。 |
集計やGROUP BY を使用しないクエリで返される最大行数を指定します。
このプロパティは、集計やGROUP BY 句を含まないクエリに対してSync App が返す行数の上限を設定します。 この制限により、クエリがデフォルトで過度に大きな結果セットを返さないようにします。
クエリにLIMIT 句が含まれている場合、クエリで指定された値がMaxRows 設定よりも優先されます。 MaxRows が"-1" に設定されている場合、LIMIT 句が明示的にクエリに含まれていない限り、行の制限は行われません。
このプロパティは、非常に大きなデータセットを返す可能性のあるクエリを実行する際に、パフォーマンスを最適化し過剰なリソース消費を防ぐのに役立ちます。
特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。
このプロパティは、シニアユーザーが特定のシナリオに対して隠しプロパティを設定できるようにします。 これらの設定は通常のユースケースには必要ありませんが、特定の要件に対応したり、追加の機能を提供したりすることができます。 複数のプロパティをセミコロン区切りのリストで定義できます。
Note: 特定のシナリオや問題に対処するためにサポートチームから助言があった場合にのみ、これらのプロパティを設定することを強く推奨します。
複数のプロパティをセミコロン区切りリストで指定します。
| DefaultColumnSize | データソースがメタデータにカラムの長さを提供しない場合に、文字列フィールドのデフォルトの長さを設定します。デフォルト値は2000です。 |
| ConvertDateTimeToGMT | 日時の値を、マシンのローカルタイムではなくGMT グリニッジ標準時に変換するかどうかを決定します。 |
| RecordToFile=filename | 基底のソケットデータ転送を指定のファイルに記録します。 |
Azure Data Catalog から返される、1ページあたりの結果の最大数を指定します。この設定は、ほとんどのユースケースに最適化されている、データソースによって設定されたデフォルトのページサイズをオーバーライドします。
クエリする特定のオブジェクトやサービスエンドポイントの結果を最適化するために、デフォルトのページサイズを調整したい場合があります。 ページサイズを大きくするとパフォーマンスが向上するかもしれませんが、ページあたりのメモリ消費量が増える可能性もあることに注意してください。
テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。
このプロパティを使用すると、Sync App がテーブルカラムとして公開する擬似カラムを定義できます。
個々の擬似カラムを指定するには、以下の形式を使用します。"Table1=Column1;Table1=Column2;Table2=Column3"
すべてのテーブルのすべての擬似カラムを含めるには、次のようにします:"*=*"
provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。
このプロパティは、Sync App が操作をキャンセルする前に操作の完了を待機する最大時間を秒単位で制御します。 操作の完了前にタイムアウト時間が経過すると、Sync App は操作をキャンセルして例外をスローします。
タイムアウトは、クエリや操作全体ではなくサーバーとの個々の通信に適用されます。 例えば、各ページング呼び出しがタイムアウト制限内に完了する場合、クエリは60秒を超えて実行を続けることができます。
このプロパティを0に設定するとタイムアウトが無効になり、操作が成功するか、サーバー側のタイムアウト、ネットワークの中断、またはサーバーのリソース制限などの他の条件で失敗するまで無期限に実行されます。 このプロパティは慎重に使用してください。長時間実行される操作がパフォーマンスを低下させたり、応答しなくなる可能性があるためです。
カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。
このプロパティを使用すると、UserDefinedViews.json というJSON 形式の構成ファイルを通じてカスタムビューを定義および管理できます。 これらのビューはSync App によって自動的に認識され、標準のデータベースビューのようにカスタムSQL クエリを実行できるようになります。 JSON ファイルは、各ビューをルート要素として定義し、その子要素として"query" を持ちます。この"query" にはビューのSQL クエリが含まれています。次に例を示します。
{
"MyView": {
"query": "SELECT * FROM Tables WHERE MyColumn = 'value'"
},
"MyView2": {
"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
}
}
このプロパティを使用して、1つのファイルに複数のビューを定義し、ファイルパスを指定できます。 例:UserDefinedViews=C:\Path\To\UserDefinedViews.json。 このプロパティを使用すると、指定されたビューのみがSync App によって検知されます。
詳しくは、ユーザー定義ビュー を参照してください。