CREATE XML INDEX (Transact-SQL)

構文

Create XML Index 
CREATE [ PRIMARY ] XML INDEX index_name 
    ON <object> ( xml_column_name )
    [ USING XML INDEX xml_index_name 
        [ FOR { VALUE | PATH | PROPERTY } ] ]
    [ WITH ( <xml_index_option> [ ,...n ] ) ]
[ ; ]

<object> ::=
{
    [ database_name. [ schema_name ] . | schema_name. ] 
        table_name
}

<xml_index_option> ::=
{ 
    PAD_INDEX  = { ON | OFF }
  | FILLFACTOR = fillfactor
   | SORT_IN_TEMPDB = { ON | OFF }
    | IGNORE_DUP_KEY = OFF
  | DROP_EXISTING = { ON | OFF }
  | ONLINE = OFF
  | ALLOW_ROW_LOCKS = { ON | OFF }
  | ALLOW_PAGE_LOCKS = { ON | OFF }
  | MAXDOP = max_degree_of_parallelism
}

引数

• [PRIMARY] XML
  指定した xml 列に、XML インデックスを作成します。PRIMARY を指定した場合、クラスター化インデックスは、ユーザー テーブルのクラスター化キーと XML ノード識別子から構成されるクラスター化キーで作成されます。各テーブルには 249 個までの XML インデックスを作成できます。XML インデックスを作成するときには、次のことに注意してください。

  • クラスター化インデックスは、ユーザー テーブルの主キー上に存在する必要がある。

  • ユーザー テーブルのクラスター化キーは 15 列に制限されている。

  • テーブル内の各 xml 列には、1 つのプライマリ XML インデックスと、複数のセカンダリ XML インデックスを作成できる。

  • xml 列にセカンダリ XML インデックスを作成するには、プライマリ XML インデックスが存在している必要がある。

  • XML インデックスは、単一の xml 列にのみ作成できる。XML インデックスは xml 以外の列には作成できません。またリレーショナル インデックスは xml 列には作成できません。

  • ビュー内の xml 列、xml 列を使用したテーブル値変数、および xml 型の変数には、プライマリまたはセカンダリのいずれの XML インデックスも作成できない。

  • xml 計算列にプライマリ XML インデックスを作成することはできない。

  • SET オプション設定は、インデックス付きビューおよび計算列インデックスに必要な設定と同じにする必要がある。特に、XML インデックスを作成し、xml 列に値を挿入、削除、更新する場合は、オプション ARITHABORT が ON に設定されている必要があります。詳細については、「結果に影響を与える SET オプション」を参照してください。

  詳細については、「XML データ型の列のインデックス」を参照してください。

• index_name
  インデックスの名前を指定します。インデックス名は、テーブル内では一意である必要がありますが、データベース内で一意である必要はありません。インデックス名は、識別子の規則に従っている必要があります。

  プライマリ XML インデックス名は、#、##、@、または @@ で始めることはできません。

• xml_column_name
  インデックスの基準となる xml 列を指定します。単一の XML インデックス定義には、1 つの xml 列しか指定できませんが、1 つの xml 列には複数のセカンダリ XML インデックスを作成できます。

• USING XML INDEX xml_index_name
  セカンダリ XML インデックスの作成でプライマリ XML インデックスを使用します。

• FOR { VALUE | PATH | PROPERTY }
  セカンダリ XML インデックスの種類を指定します。

  • VALUE
    キー列がプライマリ XML インデックス (ノード値とパス) となっている列に、セカンダリ XML インデックスを作成します。

  • PATH
    プライマリ XML インデックスのパス値とノード値に基づく列に、セカンダリ XML インデックスを作成します。PATH セカンダリ インデックスではパス値とノード値がキー列になり、パスの検索時に効率的にシークできるようになります。

  • PROPERTY
    PK がベース テーブルの主キーとなっているプライマリ XML インデックスの列 (PK、パスおよびノード値) に、セカンダリ XML インデックスを作成します。

<object>::=

インデックスを作成するオブジェクトを、完全修飾または完全修飾ではない形式で指定します。

• database_name
  データベースの名前を指定します。

• schema_name
  テーブルが所属するスキーマの名前を指定します。

• table_name
  インデックスを作成するテーブルの名前を指定します。

<xml_index_option> ::=

インデックスを作成するときに使用するオプションを指定します。

• PAD_INDEX = { ON | OFF }
  インデックスの埋め込みを指定します。既定値は OFF です。

  • ON
    fillfactor で指定される空き領域のパーセンテージが、インデックスの中間レベルのページに適用されます。

  • OFF または fillfactor の指定なし
    中間レベルのページはほぼ全容量が使用されます。ただし、中間ページにあるキーのセットを考慮して、インデックスに割り当てることのできる、少なくとも 1 行の最大サイズが収まる分の領域は残されます。

  PAD_INDEX では FILLFACTOR で指定されるパーセンテージが使用されるので、PAD_INDEX オプションは、FILLFACTOR が指定されている場合にのみ有効です。FILLFACTOR で指定されるパーセンテージで 1 行分のデータを格納できない場合、データベース エンジンでは内部的に、最小サイズを格納できるパーセンテージが使用されます。中間インデックス ページの行数は、fillfactor の値がどれだけ小さくなっても 2 未満にはなりません。

• FILLFACTOR **=**fillfactor
  インデックスの作成時や再構築時に、データベース エンジンが各インデックス ページのリーフ レベルをどのくらい使用するかを示すパーセンテージを指定します。fillfactor には 1 ～ 100 の整数値を指定する必要があります。既定値は 0 です。fillfactor が 100 または 0 の場合、データベース エンジンでは全容量を使用するリーフ ページでインデックスが作成されます。

  注
  FILLFACTOR 値 0 と 100 の機能は、まったく同じです。

  FILLFACTOR 設定は、インデックスが作成または再構築されるときのみ適用されます。データベース エンジンでは、ページ内で指定されたパーセント分の空領域は動的に保持されません。FILLFACTOR 設定を表示するには、sys.indexes カタログ ビューを使用します。

  重要
  データベース エンジンでは、クラスター化インデックスの作成時にデータが再分配されるため、100 未満の FILLFACTOR 値を使ってクラスター化インデックスを作成すると、データ用のストレージ領域のサイズに影響が生じます。

  詳細については、「FILL FACTOR」を参照してください。

• SORT_IN_TEMPDB = { ON | OFF }
  tempdb に一時的な並べ替え結果を格納するかどうかを指定します。既定値は OFF です。

  • ON
    インデックス構築に使用される中間の並べ替え結果が tempdb に格納されます。この場合、tempdb がユーザー データベースとは別のディスク セット上に存在すると、インデックスの作成にかかる時間を短縮できますが、インデックスの構築中に使用されるディスク領域のサイズは増加します。

  • OFF
    中間の並べ替え結果はインデックスと同じデータベースに格納されます。

  インデックスを作成するためにユーザー データベース内に必要となる領域の他に、tempdb には、並べ替えの中間結果を格納するためにほぼ同じ大きさの追加領域が必要になります。詳細については、「tempdb とインデックスの作成」を参照してください。

• IGNORE_DUP_KEY **=**OFF
  インデックスの種類が一意になることはないので、XML インデックスでは無効です。このオプションを ON に設定すると、エラーが発生します。

• DROP_EXISTING = { ON | OFF }
  名前付きの、既存の XML インデックスを削除および再構築することを指定します。既定値は OFF です。

  • ON
    既存のインデックスは削除され、再構築されます。指定するインデックス名は、現在存在するインデックスと同じにする必要がありますが、インデックス定義は変更できます。たとえば、異なる列、並べ替え順、パーティション構成、またはインデックス オプションを指定できます。

  • OFF
    指定するインデックス名が既に存在する場合、エラーが表示されます。

  DROP_EXISTING を使用してインデックスの種類を変更することはできません。また、プライマリ XML インデックスをセカンダリ XML インデックスに、またはその逆に再定義することもできません。

• ONLINE **=**OFF
  インデックス操作中に、基となるテーブルとそれに関連する各インデックスに対してクエリやデータ変更を行えないことを指定します。このバージョンの SQL Server では、XML インデックスに対するオンラインのインデックス構築操作はサポートされていません。XML インデックスに対してこのオプションを ON に設定すると、エラーが発生します。ONLINE オプションを省略するか、ONLINE を OFF に設定してください。

  オフラインのインデックス操作で、XML インデックスの作成、再構築、または削除を行う場合は、テーブルで Sch-M (スキーマ修正) ロックが取得されます。このため、操作中は、すべてのユーザーは基になるテーブルにアクセスできません。

  注
  オンラインでのインデックス操作は、SQL Server Enterprise Edition、Developer Edition、および Evaluation Edition でのみ使用できます。

• ALLOW_ROW_LOCKS = { ON | OFF }
  行ロックを許可するかどうかを指定します。既定値は ON です。

  • ON
    インデックスにアクセスするとき、行ロックが許可されます。いつ行ロックを使用するかは、データベース エンジンによって決定されます。

  • OFF
    行ロックは使用されません。

• ALLOW_PAGE_LOCKS = { ON | OFF }
  ページ ロックを許可するかどうかを指定します。既定値は ON です。

  • ON
    ページにアクセスするとき、行ロックが許可されます。いつページ ロックを使用するかは、データベース エンジンによって決定されます。

  • OFF
    ページ ロックは使用されません。

• MAXDOP **=**max_degree_of_parallelism
  インデックス操作では、max degree of parallelism 構成オプションを無効にします。並列プランの実行で使用されるプロセッサ数を制限するには、MAXDOP を使用します。最大数は 64 プロセッサです。

  重要
  MAXDOP オブションはすべての XML インデックスで構文的にサポートされていますが、プライマリ XML インデックスの場合、CREATE XML INDEX では単一のプロセッサのみ使用されます。

  max_degree_of_parallelism には次のデータを指定できます。

  • 1
    並列プランを生成しないようにします。

  • >1
    現在のシステム ワークロードに基づいて、並列インデックス操作で使用される最大プロセッサ数を指定の数以下に制限します。

  • 0 (既定値)
    現在のシステム ワークロードに基づいて、実際の数以下のプロセッサを使用します。

  詳細については、「並列インデックス操作の構成」を参照してください。

  注
  並列インデックス操作は、SQL Server Enterprise Edition、Developer Edition、および Evaluation Edition でのみ使用できます。

説明

計算列のデータ型をインデックス キー列または非キー列として使用できる限り、xml データ型から派生した計算列は、キー列または非キー列としてインデックスを設定できます。xml 計算列にプライマリ XML インデックスを作成することはできません。

XML インデックスについての情報を表示するには、sys.xml_indexes カタログ ビューを使用します。

XML インデックスの詳細については、「XML データ型の列のインデックス」を参照してください。

インデックス作成に関する詳細説明

例

A. プライマリ XML インデックスを作成する

USE AdventureWorks2008R2;
GO
IF EXISTS (SELECT * FROM sys.indexes
            WHERE name = N'PXML_ProductModel_CatalogDescription')
    DROP INDEX PXML_ProductModel_CatalogDescription 
        ON Production.ProductModel;
GO
CREATE PRIMARY XML INDEX PXML_ProductModel_CatalogDescription
    ON Production.ProductModel (CatalogDescription);
GO

B. セカンダリ XML インデックスを作成する

USE AdventureWorks2008R2;
GO
IF EXISTS (SELECT name FROM sys.indexes
            WHERE name = N'IXML_ProductModel_CatalogDescription_Path')
    DROP INDEX IXML_ProductModel_CatalogDescription_Path
        ON Production.ProductModel;
GO
CREATE XML INDEX IXML_ProductModel_CatalogDescription_Path 
    ON Production.ProductModel (CatalogDescription)
    USING XML INDEX PXML_ProductModel_CatalogDescription FOR PATH ;
GO

関連項目

参照

概念

その他の技術情報