クエリ最適化のインデックス

Overview

このページでは、 MongoDB PHPライブラリを使用してさまざまなタイプのインデックスを管理する方法を示すコピー可能なコード例を紹介します。

To use an example from this page, copy the code example into the sample application or your own application. Make sure to set the MONGODB_URI environment variable to the connection string for your MongoDB deployment, and replace the <database> and <collection> placeholders with values for your target namespace.

1
<?php
2
3
require __DIR__ . '/../vendor/autoload.php';
4
5
$uri = getenv('MONGODB_URI') ?: throw new RuntimeException('Set the MONGODB_URI variable to your Atlas URI that connects to the sample dataset');
6
$client = new MongoDB\Client($uri);
7
8
$collection = $client->selectCollection('<database>', '<collection>');
9
10
// Start example code here
11
12
// End example code here

function toJSON(object $document): string
{
    return MongoDB\BSON\Document::fromPHP($document)->toRelaxedExtendedJSON();
}

単一フィールド インデックス

次の例では、指定されたフィールドに昇順のインデックスを作成しています。

$indexName = $collection->createIndex(['<field name>' => 1]);

単一フィールドインデックスの詳細については、「単一フィールド インデックスガイド」を参照してください。

複合インデックス

次の例では、指定されたフィールドに対して 2 つの昇順インデックスからなる複合インデックスを作成します。

$indexName = $collection->createIndex(
    ['<field name 1>' => 1, '<field name 2>' => 1],
);

複合インデックスの詳細については、「複合インデックス」のガイドを参照してください。

Multikey Index

次の例では、指定された配列値フィールドに昇順のマルチキーインデックスを作成しています。

$indexName = $collection->createIndex(['<array field name>' => 1]);

マルチキー インデックスの詳細については、「 マルチキーインデックス」のガイドを参照してください。

地理空間インデックス

次の例では、GeoJSONオブジェクト値を持つ指定されたフィールドに2 dsphereインデックスを作成します。

$indexName = $collection->createIndex(
    ['<GeoJSON object field>' => '2dsphere'],
);

GeoJSONデータ型の詳細については、 MongoDB Serverマニュアルの 「 GeoJSON オブジェクト」 を参照してください。

ユニークインデックス

次の例では、指定されたフィールドに昇順のユニークインデックスを作成しています。

$indexName = $collection->createIndex(['<field name>' => 1], ['unique' => true]);

ワイルドカード インデックス

次の例では、コレクションに昇順のワイルドカードを作成しています。

$indexName = $collection->createIndex(['$**' => 1]);

クラスター化されたインデックス

指定されたデータベースに新しいコレクションを作成するときに、クラスター化インデックスを作成できます。 次の例では、 _idフィールドに昇順のクラスターインデックスを含む新しいコレクションを作成します。

$options = [
    'clusteredIndex' => [
        'key' => ['_id' => 1],
        'unique' => true,
    ],
];
$database->createCollection('<collection name>', $options);

Text Index

次の例では、指定された string フィールドにテキスト インデックスを作成します。

$indexName = $collection->createIndex(['<field name>' => 'text']);

インデックスをリストする

次の例では、指定されたコレクション内のインデックスのリストを出力します。

foreach ($collection->listIndexes() as $indexInfo) {
    echo $indexInfo;
}

インデックスの削除

次の例では、指定された名前のインデックスを 1 つ削除します。

$collection->dropIndex('<index name>');

インデックスの削除の詳細については、「 インデックスの考慮事項と管理ガイド」の「 インデックスの削除 」を参照してください。

MongoDB 検索インデックス マネジメント

次のセクションには、MongoDB Search および ベクトル検索 検索インデックスを管理する方法を説明するコード例が含まれています。

MongoDB 検索インデックスについて詳しく学ぶには、MongoDB 検索インデックス ガイドを参照してください。

$indexName = $collection->createSearchIndex(
    ['mappings' => ['dynamic' => true]],
    ['name' => '<Search index name>'],
);

foreach ($collection->listSearchIndexes() as $indexInfo) {
    echo toJSON($indexInfo), PHP_EOL;
}

$collection->updateSearchIndex(
    '<Search index name>',
    ['mappings' => [
        'dynamic' => false,
        'fields' => [
            '<string field name>' => [
                'type' => 'string',
                'analyzer' => 'lucene.standard',
            ],
        ],
    ]],
);

$collection->dropSearchIndex('<Search index name>');