Create search example

examples/atlas-search.php

@@ -0,0 +1,129 @@
+<?php
+
+/**
+ * This example demonstrates how to create a search index and perform a text search.
+ * It requires a MongoDB Atlas M10+ cluster with Sample Dataset loaded.
+ */
+
+declare(strict_types=1);
+
+namespace MongoDB\Examples;
+
+use Closure;
+use MongoDB\Client;
+use RuntimeException;
+
+use function define;
+use function getenv;
+use function hrtime;
+use function iterator_to_array;
+use function preg_match;
+use function printf;
+use function sleep;
+
+require __DIR__ . '/../vendor/autoload.php';
+
+$uri = getenv('MONGODB_URI');
+if (! $uri || ! preg_match('/\.(mongodb\.net|mongodb-dev\.net)/', $uri)) {
+ printf("This example requires a MongoDB Atlas cluster.\n");
+ printf("Make sure you set the MONGODB_URI environment variable.\n");
+ exit(1);
+}
+
+define('WAIT_TIMEOUT_SEC', getenv('MONGODB_WAIT_TIMEOUT_SEC') ?: 300);
+define('INDEX_NAME', 'default');
+
+$client = new Client($uri);
+$collection = $client->sample_airbnb->listingsAndReviews;
+
+$count = $collection->estimatedDocumentCount();
+if ($count === 0) {
+ printf("This example requires the sample_airbnb database with the listingsAndReviews collection.\n");
+ printf("Load the sample dataset in your MongoDB Atlas cluster before running this example:\n");
+ printf(" https://www.mongodb.com/docs/atlas/sample-data/\n");
+ exit(1);
+}
+
+// Delete the index if it already exists.
+$indexes = iterator_to_array($collection->listSearchIndexes());
+foreach ($indexes as $index) {
+ if ($index->name === 'default') {
+ printf("\nThe index already exists. Dropping it.\n");
+ $collection->dropSearchIndex($index->name);
+
+ // Wait for the index to be deleted.
+ wait(function () use ($collection) {
+ foreach ($collection->listSearchIndexes() as $index) {
+ if ($index->name === 'default') {
+ printf("Waiting for the index to be deleted...\n");
+
+ return false;
+ }
+ }
+
+ return true;
+ });
+ }
+}
+
+// Create the search index
+printf("\nCreating the index.\n");
+$collection->createSearchIndex(
+ // Index definition
+ // See: https://www.mongodb.com/docs/atlas/atlas-search/define-field-mappings/
+ ['mappings' => ['dynamic' => true]],
+ // "default" is the default index name, this config can be omitted.
+ ['name' => 'default'],
+);
+
+// Wait for the index to be ready.
+wait(function () use ($collection) {
+ foreach ($collection->listSearchIndexes() as $index) {
+ if ($index->name === 'default') {
+ printf("Waiting for the index to be ready...\n");
+
+ return $index->queryable;
+ }
+ }
+
+ return false;
+});
+
+// Perform a text search.
+printf("\nPerforming a text search...\n");
+$results = $collection->aggregate([
+ [
+ '$search' => [
+ 'index' => 'default',
+ 'text' => [
+ 'query' => 'view beach ocean',
+ 'path' => ['name'],
+ ],
+ ],
+ ],
+ ['$project' => ['name' => 1, 'description' => 1]],
+ ['$limit' => 10],
+])->toArray();
+
+foreach ($results as $document) {
+ printf(" - %s\n", $document['name']);
+}
+
+printf("\nEnjoy MongoDB Atlas Search!\n\n");
+
+/**
+ * Wait until the callback returns true or the timeout is reached.
+ */
+function wait(Closure $callback): void
+{
+ $timeout = hrtime()[0] + WAIT_TIMEOUT_SEC;
+ while (hrtime()[0] < $timeout) {
+ if ($callback()) {
+ return;
+ }
+
+ sleep(5);
+ }
+
+ throw new RuntimeException('Time out');
+}