INDEXPROPERTY (Transact-SQL)INDEXPROPERTY (Transact-SQL)

• 06/26/2019
• • c
  • 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

指定されたテーブル ID 番号、インデックス名または統計名、およびプロパティ名の指定されたインデックスまたは統計プロパティ値を返します。Returns the named index or statistics property value of a specified table identification number, index or statistics name, and property name. XML インデックスに対して NULL を返します。Returns NULL for XML indexes.

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

構文Syntax

INDEXPROPERTY ( object_ID , index_or_statistics_name , property )   

引数Arguments

object_IDobject_ID
インデックス プロパティ情報の提供元となるテーブルまたはインデックス付きビューのオブジェクト ID 番号を含む式です。Is an expression that contains the object identification number of the table or indexed view for which to provide index property information. object_ID は int です。object_ID is int.

index_or_statistics_nameindex_or_statistics_name
返されるプロパティ情報の基となるインデックスまたは統計の名前を含む式です。Is an expression that contains the name of the index or statistics for which to return property information. index_or_statistics_name is nvarchar(128).index_or_statistics_name is nvarchar(128).

propertyproperty
返されるデータベース プロパティの名前を含む式です。Is an expression that contains the name of the database property to return. property のデータ型は varchar(128) で、次のいずれかの値を指定できます。property is varchar(128), and can be one of these values.

戻り値の型Return Types

intint

例外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. つまり、オブジェクトに対する権限がユーザーに与えられていない場合、メタデータを生成する組み込み関数 (INDEXPROPERTY など) が NULL を返す可能性があります。This means that metadata-emitting, built-in functions such as INDEXPROPERTY may return NULL if the user does not have any permission on the object. 詳細については、「 Metadata Visibility Configuration」を参照してください。For more information, see Metadata Visibility Configuration.

例Examples

次の例では、AdventureWorks2012AdventureWorks2012 データベースにある Employee テーブルの PK_Employee_BusinessEntityID インデックスについて IsClustered、IndexDepth、および IndexFillFactor プロパティの値を返します。The following example returns the values for the IsClustered, IndexDepth, and IndexFillFactor properties for the PK_Employee_BusinessEntityID index of the Employee table in the AdventureWorks2012AdventureWorks2012 database.

SELECT   
    INDEXPROPERTY(OBJECT_ID('HumanResources.Employee'),  
        'PK_Employee_BusinessEntityID','IsClustered')AS [Is Clustered],  
    INDEXPROPERTY(OBJECT_ID('HumanResources.Employee'),  
        'PK_Employee_BusinessEntityID','IndexDepth') AS [Index Depth],  
    INDEXPROPERTY(OBJECT_ID('HumanResources.Employee'),  
        'PK_Employee_BusinessEntityID','IndexFillFactor') AS [Fill Factor];  
  

結果セットは次のようになります。Here is the result set:

Is Clustered Index Depth Fill Factor   
------------ ----------- -----------   
1            2           0  
  
(1 row(s) affected)  

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

次の例では、FactResellerSales テーブルのインデックスの 1 つのプロパティを調べます。The following example examines the properties of one of the indexes on the FactResellerSales table.

-- Uses AdventureWorks  
  
SELECT   
INDEXPROPERTY(OBJECT_ID('dbo.FactResellerSales'),  
    'ClusteredIndex_6d10fa223e5e4c1fbba087e29e16a7a2','IsClustered') AS [Is Clustered],  
INDEXPROPERTY(OBJECT_ID('dbo.FactResellerSales'),  
    'ClusteredIndex_6d10fa223e5e4c1fbba087e29e16a7a2','IsColumnstore') AS [Is Columnstore Index],  
INDEXPROPERTY(OBJECT_ID('dbo.FactResellerSales'),  
    'ClusteredIndex_6d10fa223e5e4c1fbba087e29e16a7a2','IndexFillFactor') AS [Fill Factor];  
GO  

参照See Also

CREATE INDEX (Transact-SQL) CREATE INDEX (Transact-SQL)
統計 Statistics
sys.indexes (Transact-SQL) sys.indexes (Transact-SQL)
sys.index_columns (Transact-SQL) sys.index_columns (Transact-SQL)
sys.stats (Transact-SQL) sys.stats (Transact-SQL)
sys.stats_columns (Transact-SQL)sys.stats_columns (Transact-SQL)