OBJECTPROPERTYEX (Transact-SQL)OBJECTPROPERTYEX (Transact-SQL)

• 03/15/2017
• • V
  • o
  • O

適用対象:Applies to: SQL ServerSQL Server (サポートされているすべてのバージョン) SQL ServerSQL Server (all supported versions) Azure SQL データベースAzure SQL DatabaseAzure SQL データベースAzure SQL Database Azure SQL Managed InstanceAzure SQL Managed InstanceAzure SQL Managed InstanceAzure SQL Managed Instance Azure Synapse AnalyticsAzure Synapse AnalyticsAzure Synapse AnalyticsAzure Synapse Analytics Parallel Data WarehouseParallel Data WarehouseParallel Data WarehouseParallel Data Warehouse適用対象:Applies to: SQL ServerSQL Server (サポートされているすべてのバージョン) SQL ServerSQL Server (all supported versions) Azure SQL データベースAzure SQL DatabaseAzure SQL データベースAzure SQL Database Azure SQL Managed InstanceAzure SQL Managed InstanceAzure SQL Managed InstanceAzure SQL Managed Instance Azure Synapse AnalyticsAzure Synapse AnalyticsAzure Synapse AnalyticsAzure Synapse Analytics Parallel Data WarehouseParallel Data WarehouseParallel Data WarehouseParallel Data Warehouse

現在のデータベース内のスキーマ スコープ オブジェクトに関する情報を返します。Returns information about schema-scoped objects in the current database. これらのオブジェクトの一覧については、「sys.objects (Transact-SQL)」をご覧ください。For a list of these objects, see sys.objects (Transact-SQL). OBJECTPROPERTYEX は、データ定義言語 (DDL) トリガーやイベント通知などの非スキーマ スコープ オブジェクトには使用できません。OBJECTPROPERTYEX cannot be used for objects that are not schema-scoped, such as data definition language (DDL) triggers and event notifications.

Transact-SQL 構文表記規則 Transact-SQL Syntax Conventions

構文Syntax

OBJECTPROPERTYEX ( id , property )  

引数Arguments

idid
現在のデータベース内のオブジェクトの ID を表す式を指定します。Is an expression that represents the ID of the object in the current database. id のデータ型は int で、現在のデータベース コンテキストでのスキーマ スコープ オブジェクトであることが前提となっています。id is int and is assumed to be a schema-scoped object in the current database context.

propertyproperty
ID で指定したオブジェクトについて、返される情報を含む式を指定します。戻り値の型は sql_variant です。Is an expression that contains the information to be returned for the object specified by id. The return type is sql_variant. 次の表に、各プロパティ値に対する基本のデータ型を示します。The following table shows the base data type for each property value.

戻り値の型Return Types

sql_variantsql_variant

例外Exceptions

エラーが発生した場合、または呼び出し元にオブジェクトの表示権限がない場合は、NULL が返されます。Returns NULL on error or if a caller does not have permission to view the object.

ユーザーが所有しているか、または権限を与えられている、セキュリティ保護可能なリソースのメタデータのみを表示できます。A user can only view the metadata of securables that the user owns or on which the user has been granted permission. つまり、オブジェクトに対する権限がユーザーに与えられていない場合、メタデータを生成する組み込み関数 (OBJECTPROPERTYEX など) が NULL を返す可能性があります。This means that metadata-emitting, built-in functions such as OBJECTPROPERTYEX may return NULL if the user does not have any permission on the object. 詳細については、「 Metadata Visibility Configuration」を参照してください。For more information, see Metadata Visibility Configuration.

注釈Remarks

データベース エンジンDatabase Engine を前提としています object_id が現在のデータベース コンテキストでします。The データベース エンジンDatabase Engine assumes that object_id is in the current database context. 別のデータベースの object_id を参照するクエリは、NULL または正しくない値を返します。A query that references an object_id in another database will return NULL or incorrect results. たとえば、次のクエリでは、現在のデータベース コンテキストは master データベースです。For example, in the following query the current database context is the master database. データベース エンジンDatabase Engineは、クエリ内で指定されたデータベースではなく、このデータベースの指定された object_id のプロパティ値を返します。The データベース エンジンDatabase Engine will try to return the property value for the specified object_id in that database instead of the database that is specified in the query. ビュー vEmployee は master データベース内にないため、このクエリでは正しくない結果が返されます。The query returns incorrect results because the view vEmployee is not in the master database.

USE master;  
GO  
SELECT OBJECTPROPERTYEX(OBJECT_ID(N'AdventureWorks2012.HumanResources.vEmployee'), 'IsView');  
GO  

OBJECTPROPERTYEX(view_id, 'IsIndexable') は、多くのコンピューター リソースを使用する可能性があります。これは、IsIndexable プロパティを評価するために、ビュー定義、正規化、および部分最適化の解析が必要なためです。OBJECTPROPERTYEX(view_i d, 'IsIndexable') may consume significant computer resources because evaluation of IsIndexable property requires the parsing of view definition, normalization, and partial optimization. IsIndexable プロパティではインデックスを作成できるテーブルまたはビューを指定しますが、特定のインデックス キーの要件が満たされない場合、インデックスの実際の作成は失敗します。Although the IsIndexable property identifies tables or views that can be indexed, the actual creation of the index still might fail if certain index key requirements are not met. 詳細については、「CREATE INDEX (Transact-SQL)」を参照してください。For more information, see CREATE INDEX (Transact-SQL).

OBJECTPROPERTYEX(table_id, 'TableHasActiveFulltextIndex') は、テーブルの少なくとも 1 つの列にインデックスが作成されている場合は、1 (TRUE) を返します。OBJECTPROPERTYEX (table_id, 'TableHasActiveFulltextIndex') will return a value of 1 (true) when at least one column of a table is added for indexing. インデックス作成で先頭の列が追加されるとすぐ、フルテキスト インデックス作成が自動的にアクティブになります。Full-text indexing becomes active for population as soon as the first column is added for indexing.

メタデータの表示に関する制限は、結果セットに適用されます。Restrictions on metadata visibility are applied to the result set. 詳細については、「 Metadata Visibility Configuration」を参照してください。For more information, see Metadata Visibility Configuration.

例Examples

A.A. オブジェクトの基本の種類を検索するFinding the base type of an object

次の例では、AdventureWorks2012AdventureWorks2012 データベース内の MyEmployeeTable テーブルに対して SYNONYM Employee を作成した後、SYNONYM の基本の種類を返します。The following example creates a SYNONYM MyEmployeeTable for the Employee table in the AdventureWorks2012AdventureWorks2012 database and then returns the base type of the SYNONYM.

USE AdventureWorks2012;  
GO  
CREATE SYNONYM MyEmployeeTable FOR HumanResources.Employee;  
GO  
SELECT OBJECTPROPERTYEX ( object_id(N'MyEmployeeTable'), N'BaseType')AS [Base Type];  
GO  

結果セットでは、基になるオブジェクトである Employee テーブルの基本の種類が、ユーザー テーブルであることが示されます。The result set shows that the base type of the underlying object, the Employee table, is a user table.

Base Type 
--------  
U

B.B. プロパティ値を返すReturning a property value

次の例では、指定されたテーブルの UPDATE トリガー数を返します。The following example returns the number of UPDATE triggers on the specified table.

USE AdventureWorks2012;  
GO  
SELECT OBJECTPROPERTYEX(OBJECT_ID(N'HumanResources.Employee'), N'TABLEUPDATETRIGGERCOUNT');  
GO  

C.C. FOREIGN KEY 制約を含むテーブルを探すFinding tables that have a FOREIGN KEY constraint

次の例では、TableHasForeignKey プロパティを使用し、FOREIGN KEY 制約を含むすべてのテーブルを返します。The following example uses the TableHasForeignKey property to return all the tables that have a FOREIGN KEY constraint.

USE AdventureWorks2012;  
GO  
SELECT name, object_id, schema_id, type_desc  
FROM sys.objects   
WHERE OBJECTPROPERTYEX(object_id, N'TableHasForeignKey') = 1  
ORDER BY name;  
GO  

例: Azure Synapse AnalyticsAzure Synapse Analytics、Parallel Data WarehouseParallel Data WarehouseExamples: Azure Synapse AnalyticsAzure Synapse Analytics and Parallel Data WarehouseParallel Data Warehouse

D: オブジェクトの基本型を検索するD: Finding the base type of an object

次の例では、dbo.DimReseller オブジェクトの基本型を返します。The following example returns the base type of dbo.DimReseller object.

-- Uses AdventureWorks  
  
SELECT OBJECTPROPERTYEX ( object_id(N'dbo.DimReseller'), N'BaseType')AS BaseType;  

結果セットでは、基になるオブジェクトである dbo.DimReseller テーブルの基本の種類が、ユーザー テーブルであることが示されます。The result set shows that the base type of the underlying object, the dbo.DimReseller table, is a user table.

BaseType   
--------   
U   

関連項目See Also

CREATE SYNONYM (Transact-SQL) CREATE SYNONYM (Transact-SQL)
メタデータ関数 (Transact-SQL) Metadata Functions (Transact-SQL)
OBJECT_DEFINITION (Transact-SQL) OBJECT_DEFINITION (Transact-SQL)
OBJECT_ID (Transact-SQL) OBJECT_ID (Transact-SQL)
OBJECT_NAME (Transact-SQL) OBJECT_NAME (Transact-SQL)
sys.objects (Transact-SQL) sys.objects (Transact-SQL)
ALTER AUTHORIZATION (Transact-SQL) ALTER AUTHORIZATION (Transact-SQL)
TYPEPROPERTY (Transact-SQL)TYPEPROPERTY (Transact-SQL)