MongoCollection::ensureIndex

パラメータ

keys

インデックスをソートするフィールドの配列。配列の各要素のキーがフィールド名、 値には、方向あるいは » index type. を指定します。方向を指定する場合は、昇順なら 1、降順なら -1 と指定します。

options

インデックス作成操作についてのオプションの配列。 現在利用可能なオプションは、以下のとおりです。

• "unique"

  TRUE を指定すると、一意なインデックスを作ります。デフォルト値は FALSE です。このオプションを使えるのは、昇順もしくは降順のインデックスだけです。

  注意:

  MongoDB がフィールドをインデックスするとき、もしそのフィールドに値を含まないドキュメントがあれば、NULL 値をインデックスします。このフィールドを含まないドキュメントが複数あった場合、一意なインデックスは、最初に出現したドキュメント以外を受け付けません。これを防ぐには "sparse" オプションを使います。このオプションを指定すれば、インデックス対象のフィールドが存在しないドキュメントはインデックスしなくなります。

• "sparse"

  TRUE を指定すると、疎なインデックスを作ります。これは、指定したフィールドを含むドキュメントだけをインデックスします。デフォルト値は FALSE です。

• "expireAfterSeconds"

  このオプションの値に指定するのは、ドキュメントを有効期限切れとみなしてコレクションから自動削除するまでの秒数です。このオプションが使えるのは、単一フィールドインデックスで、フィールドに MongoDate の値を含む場合のみです。

  注意:

  この機能が使えるのは、MongoDB 2.2 以降です。詳細は » Expire Data from Collections by Setting TTL を参照ください。

• "name"

  オプションの、インデックスを一意に特定するための名前。

  注意:

  ドライバーがデフォルトで生成するインデックス名は、インデックスのフィールドと、並び順あるいは型に基づくものです。たとえば、複合インデックス array("x" => 1, "y" => -1) の名前は "x_1_y_-1" であり、地理空間インデックス array("loc" => "2dsphere") の名前は "loc_2dsphere" となります。多数のフィールドからなるインデックスの場合、自動生成される名前が MongoDB の » インデックス名の制限 を超えてしまう可能性があります。"name" オプションは、そんな場合に短い名前を用意するときなどに使えます。

• "background"

  Builds the index in the background so that building an index does not block other database activities. Specify TRUE to build in the background. The default value is FALSE.

  警告

  Prior to MongoDB 2.6.0, index builds on secondaries were executed as foreground operations, irrespective of this option. See » Building Indexes with Replica Sets for more information.

• "socketTimeoutMS"

  このオプションは、ソケット通信の制限時間を、ミリ秒単位で指定します。この時間内にサーバーからの反応がなければ、MongoCursorTimeoutException をスローします。この場合、サーバー側で書き込み処理が行われたのかどうかを判断できなくなります。-1 を指定すると、永遠にブロックします。MongoClient のデフォルト値は 30000 (30 秒) です。

以下のオプションは、MongoDB 2.6 以降で使えます。

• "maxTimeMS"

  サーバー上で操作を行う累積時間の制限 (アイドル時間を含まない) を、ミリ秒単位で指定します。この時間内にサーバー側の操作が完了しなければ、MongoExecutionTimeoutException をスローします。

以下のオプションは、MongoDB 2.8 より前のバージョンで使えます。

• "dropDups"

  TRUE を指定すると、一意なインデックスを強制的に作成します。このとき、コレクション内でキーの値が重複してしまう可能性があります。MongoDB は最初に出現したキーをインデックスし、それ以降に出現する同じキーのすべてのドキュメントを削除します。デフォルト値は FALSE です。

  警告

  "dropDups" はデータベースのデータを削除することがあるので、使う際には十分な注意が必要です。

  注意:

  このオプションは、MongoDB 2.8 以降には対応していません。コレクションに値の重複がある場合は、インデックスの作成に失敗します。

以下のオプションは、MongoDB 2.6 より前のバージョンで使えます。

• "w"

  WriteConcerns を参照ください。MongoClient でのデフォルト値は 1 です。

• "wTimeoutMS"

  このオプションは、書き込み確認を待つ制限時間をミリ秒単位で指定します。これが書き込み操作に適用されるのは、"w" が 1 より大きい場合のみです。というのも、タイムアウトはレプリケーションに関する機能だからです。この時間内に書き込み確認ができなかった場合は MongoCursorException をスローします。0 を指定すると、永遠にブロックし続けます。MongoClient でのデフォルトは 10000 ミリ秒 (10 秒) です。

以下のオプションは廃止予定です。使ってはいけません。

• "safe"

  非推奨。write concern の w オプションを使いましょう。

• "timeout"

  非推奨。"socketTimeoutMS" のエイリアス。

• "wtimeout"

  廃止予定。"wTimeoutMS" のエイリアスです。