OBJECTPROPERTYEX (Transact-SQL)

適用対象:SQL ServerAzure SQL DatabaseAzure SQL Managed InstanceAzure Synapse AnalyticsAnalytics Platform System (PDW)Microsoft Fabric の SQL 分析エンドポイントMicrosoft Fabric のウェアハウスMicrosoft Fabric プレビューの SQL データベース

OBJECTPROPERTYEX関数は、現在のデータベース内のスキーマ スコープ オブジェクトに関する情報を返します。

これらのオブジェクトの一覧については、「sys.objects (Transact-SQL)」をご覧ください。 OBJECTPROPERTYEX は、データ定義言語 (DDL) トリガーやイベント通知など、スキーマ スコープではないオブジェクトには使用できません。

Transact-SQL 構文表記規則

構文

OBJECTPROPERTYEX ( id , property )

引数

身分証明書

現在のデータベース内のオブジェクトの ID を表す式。 ID は int であり、現在のデータベース コンテキストではスキーマ スコープ オブジェクトであると見なされます。

property

ID で指定されたオブジェクトに対して返される情報を含む式。 戻り値の型は sql_variant。 次の表に、各プロパティ値に対する基本のデータ型を示します。

戻り値の型

sql_variant

例外

エラーが発生した場合、または呼び出し元にオブジェクトを表示する権限がない場合に NULL を返します。

ユーザーが所有しているか、または権限を与えられている、セキュリティ保護可能なリソースのメタデータのみを表示できます。 つまり、ユーザーがオブジェクトに対する権限を持っていない場合、メタデータを出力する組み込み関数 (OBJECTPROPERTYEX など) は NULL を返す可能性があります。 詳細については、「 メタデータの可視性の構成」を参照してください。

解説

データベース エンジン を前提としています object_id が現在のデータベース コンテキストでします。 別のデータベース内の object_id を参照するクエリは、 NULL または正しくない結果を返します。 たとえば、次のクエリでは、現在のデータベース コンテキストは master データベースです。 データベース エンジンは、クエリで指定されたデータベースではなく、そのデータベース内の指定された object_id のプロパティ値を返そうとします。 ビュー vEmployee が master データベースにないため、クエリから正しくない結果が返されます。

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

OBJECTPROPERTYEX(view_id, 'IsIndexable') IsIndexable プロパティを評価するには、ビュー定義、正規化、部分最適化の解析が必要なため、コンピューター リソースが大幅に消費される可能性があります。 IsIndexable プロパティではインデックスを作成できるテーブルまたはビューを指定しますが、特定のインデックス キーの要件が満たされない場合、インデックスの実際の作成は失敗します。 詳細については、「 CREATE INDEX (Transact-SQL)」を参照してください。

OBJECTPROPERTYEX (table_id, 'TableHasActiveFulltextIndex') は、インデックス作成のためにテーブルの少なくとも 1 つの列が追加されると、1 (true) の値を返します。 インデックス作成で先頭の列が追加されるとすぐ、フルテキスト インデックス作成が自動的にアクティブになります。

メタデータの表示に関する制限は、結果セットに適用されます。 詳細については、「 メタデータの可視性の構成」を参照してください。

例

A. オブジェクトの基本型を検索する

次の例では、AdventureWorks2022 データベースにEmployee テーブルのSYNONYMMyEmployeeTableを作成し、SYNONYMの基本型を返します。

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

結果セットでは、基になるオブジェクトである Employee テーブルの基本の種類が、ユーザー テーブルであることが示されます。

Base Type
--------
U

B. プロパティ値を返す

次の例では、指定したテーブルの UPDATE トリガーの数を返します。

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

C. FOREIGN KEY 制約を持つテーブルを検索する

次の例では、 TableHasForeignKey プロパティを使用して、 FOREIGN KEY 制約を持つすべてのテーブルを返します。

USE AdventureWorks2022;
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 Analytics、Analytics Platform System (PDW)

D: オブジェクトの基本型を検索する

次の例では、dbo.DimReseller オブジェクトの基本型を返します。

-- Uses AdventureWorks

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

結果セットでは、基になるオブジェクトである dbo.DimReseller テーブルの基本の種類が、ユーザー テーブルであることが示されます。

BaseType
--------
U

関連コンテンツ

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