DOCSP-39685: Indexes landing page #75
+367
−169
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,117 @@ | ||
| import com.mongodb.ConnectionString; | ||
| import com.mongodb.MongoClientSettings; | ||
| import com.mongodb.ServerApi; | ||
| import com.mongodb.ServerApiVersion; | ||
|
|
||
| import com.mongodb.client.model.ClusteredIndexOptions; | ||
| import com.mongodb.client.model.CreateCollectionOptions; | ||
| import com.mongodb.client.model.IndexOptions; | ||
| import com.mongodb.client.model.Indexes; | ||
| import com.mongodb.reactivestreams.client.*; | ||
| import org.bson.Document; | ||
| import org.reactivestreams.Publisher; | ||
| import reactor.core.publisher.Flux; | ||
| import reactor.core.publisher.Mono; | ||
|
|
||
| public class IndexExamples { | ||
| public static void main(String[] args) { | ||
| // Replace the placeholder with your Atlas connection string | ||
| String uri = "<connection string URI>"; | ||
|
|
||
| // Construct a ServerApi instance using the ServerApi.builder() method | ||
| ServerApi serverApi = ServerApi.builder() | ||
| .version(ServerApiVersion.V1) | ||
| .build(); | ||
|
|
||
| MongoClientSettings settings = MongoClientSettings.builder() | ||
| .applyConnectionString(new ConnectionString(uri)) | ||
| .serverApi(serverApi) | ||
| .build(); | ||
|
|
||
| // Create a new client and connect to the server | ||
| try (MongoClient mongoClient = MongoClients.create(settings)) { | ||
| MongoDatabase database = mongoClient.getDatabase("sample_mflix"); | ||
| MongoCollection<Document> collection = database.getCollection("movies"); | ||
|
|
||
| // start-single-field | ||
| Publisher<String> publisher = collection.createIndex(Indexes.ascending("<field name>")); | ||
| Mono.from(publisher).block(); | ||
| // end-single-field | ||
|
|
||
| // start-compound | ||
| Publisher<String> publisher = collection.createIndex(Indexes.ascending("<field name 1>", "<field name 2>")); | ||
| Mono.from(publisher).block(); | ||
| // end-compound | ||
|
|
||
| // start-multikey | ||
| Publisher<String> publisher = collection.createIndex(Indexes.ascending("<array field name>")); | ||
| Mono.from(publisher).block(); | ||
| // end-multikey | ||
|
|
||
| // start-search-create | ||
| Document index = new Document("mappings", new Document("dynamic", true)); | ||
| Publisher<String> publisher = collection.createSearchIndex("<index name>", index); | ||
| Mono.from(publisher).block(); | ||
| // end-search-create | ||
|
|
||
| // start-search-list | ||
| ListSearchIndexesPublisher<Document> listIndexesPublisher = collection.listSearchIndexes(); | ||
|
|
||
| Flux.from(listIndexesPublisher) | ||
| .doOnNext(System.out::println) | ||
| .blockLast(); | ||
| // end-search-list | ||
|
|
||
| // start-search-update | ||
| Document newIndex = new Document("mappings", new Document("dynamic", true)); | ||
| Publisher<Void> publisher = collection.updateSearchIndex("<index name>", newIndex); | ||
| Mono.from(publisher).block(); | ||
| // end-search-update | ||
|
|
||
| // start-search-delete | ||
| Publisher<Void> publisher = collection.dropIndex("<index name>"); | ||
| Mono.from(publisher).block(); | ||
| // end-search-delete | ||
|
|
||
| // start-text | ||
| Publisher<String> publisher = collection.createIndex(Indexes.text("<field name>")); | ||
| Mono.from(publisher).block(); | ||
| // end-text | ||
|
|
||
| // start-geo | ||
| Publisher<String> publisher = collection.createIndex(Indexes.geo2dsphere("<GeoJSON object field>")); | ||
| Mono.from(publisher).block(); | ||
| // end-geo | ||
|
|
||
| // start-unique | ||
| IndexOptions indexOptions = new IndexOptions().unique(true); | ||
| Publisher<String> publisher = collection.createIndex(Indexes.ascending("<field name>"), indexOptions); | ||
| Mono.from(publisher).block(); | ||
| // end-unique | ||
|
|
||
| // start-wildcard | ||
| Publisher<String> publisher = collection.createIndex(Indexes.ascending("$**")); | ||
| Mono.from(publisher).block(); | ||
| // end-wildcard | ||
|
|
||
| // start-clustered | ||
| ClusteredIndexOptions clusteredIndexOptions = new ClusteredIndexOptions( | ||
| Indexes.ascending("_id"), | ||
| true | ||
| ); | ||
|
|
||
| CreateCollectionOptions createCollectionOptions= new CreateCollectionOptions() | ||
| .clusteredIndexOptions(clusteredIndexOptions); | ||
|
|
||
| Publisher<Void> clusteredCollection = database.createCollection("<collection name>", | ||
| createCollectionOptions); | ||
| Mono.from(clusteredCollection).block(); | ||
| // end-clustered | ||
|
|
||
| // start-remove | ||
| Publisher<Void> publisher = collection.dropIndex("<index name>"); | ||
| Mono.from(publisher).block(); | ||
| // end-remove | ||
| } | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| You can use the following sample application to test the code examples on this | ||
| page. To use the sample application, perform the following steps: | ||
|
|
||
| 1. Create a new Java project in your IDE. | ||
| #. Install the {+driver-short+} in your Java project. | ||
| #. Install the `Project Reactor library | ||
| <https://projectreactor.io/docs/core/release/reference/#getting>`__ in your | ||
| Java project. | ||
| #. Copy the following code and paste it into a new Java file named ``IndexApp.java``. | ||
| #. Copy a code example from this page and paste it on the specified lines in the | ||
| file. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| import com.mongodb.ConnectionString; | ||
| import com.mongodb.MongoClientSettings; | ||
| import com.mongodb.ServerApi; | ||
| import com.mongodb.ServerApiVersion; | ||
|
|
||
| import com.mongodb.client.model.ClusteredIndexOptions; | ||
| import com.mongodb.client.model.CreateCollectionOptions; | ||
| import com.mongodb.client.model.IndexOptions; | ||
| import com.mongodb.client.model.Indexes; | ||
| import com.mongodb.reactivestreams.client.*; | ||
| import org.bson.Document; | ||
| import org.reactivestreams.Publisher; | ||
| import reactor.core.publisher.Flux; | ||
|
There was a problem hiding this comment. The imports here must be the same as in |
||
| import reactor.core.publisher.Mono; | ||
|
|
||
| public class IndexApp { | ||
| public static void main(String[] args) { | ||
| // Replace the placeholder with your Atlas connection string | ||
| String uri = "<connection string URI>"; | ||
|
|
||
| // Construct a ServerApi instance using the ServerApi.builder() method | ||
| ServerApi serverApi = ServerApi.builder() | ||
| .version(ServerApiVersion.V1) | ||
| .build(); | ||
|
|
||
| MongoClientSettings settings = MongoClientSettings.builder() | ||
| .applyConnectionString(new ConnectionString(uri)) | ||
| .serverApi(serverApi) | ||
| .build(); | ||
|
|
||
| // Create a new client and connect to the server | ||
| try (MongoClient mongoClient = MongoClients.create(settings)) { | ||
| MongoDatabase database = mongoClient.getDatabase("<database name>"); | ||
| MongoCollection<Document> collection = database.getCollection("<collection name>"); | ||
|
|
||
| // Start example code here | ||
|
|
||
| // End example code here | ||
| } | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,249 +1,278 @@ | ||
| .. _java-rs-indexes: | ||
|
|
||
| ================================= | ||
| Optimize Queries by Using Indexes | ||
| ================================= | ||
|
|
||
| .. contents:: On this page | ||
| :local: | ||
| :backlinks: none | ||
| :depth: 2 | ||
| :class: singlecol | ||
|
|
||
| .. facet:: | ||
| :name: genre | ||
| :values: reference | ||
|
|
||
| .. meta:: | ||
| :description: Learn how to use indexes by using the MongoDB Java Reactive Streams driver. | ||
| :keywords: query, optimization, efficiency, usage example, code example | ||
|
|
||
| Overview | ||
| -------- | ||
|
|
||
| On this page, you can see copyable code examples that show how to manage different | ||
| types of indexes by using the {+driver-short+}. | ||
|
|
||
| .. .. tip:: | ||
|
|
||
| .. To learn more about working with indexes, see the :ref:`java-rs-work-with-indexes` | ||
| .. guide. To learn more about any of the indexes shown on this page, see the link | ||
| .. provided in each section. | ||
|
|
||
| To use an example from this page, copy the code example into the | ||
| :ref:`sample application <java-rs-index-sample>` or your own application. | ||
| Be sure to replace all placeholders in the code examples, such as ``<connection string URI>``, with | ||
| the relevant values for your MongoDB deployment. | ||
|
|
||
| Project Reactor Implementation | ||
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| This guide uses the {+pr+} library to consume ``Publisher`` instances returned | ||
| by the {+driver-short+} methods. To learn more about the {+pr+} library | ||
| and how to use it, see `Getting Started <https://projectreactor.io/docs/core/release/reference/#getting-started>`__ | ||
| in the Reactor documentation. | ||
|
|
||
| There are also other ways to consume ``Publisher`` instances. You can use one of many alternative libraries such as | ||
| `RxJava <https://github.com/ReactiveX/RxJava>`__ or call ``Publisher.subscribe()`` directly and pass your own | ||
| implementation of a ``Subscriber``. | ||
|
|
||
| This guide uses the ``Mono.block()`` method from Reactor to subscribe to a ``Publisher`` and block the current | ||
| thread until the ``Publisher`` reaches its terminal state. To learn more about the Reactive Streams initiative, see `Reactive Streams <https://www.reactive-streams.org/>`__. | ||
|
|
||
| .. important:: Publishers Returned are Cold | ||
|
|
||
| All ``Publisher`` instances returned by the {+driver-short+} methods are cold, | ||
| which means that the corresponding operation does not happen unless you | ||
| subscribe to the returned ``Publisher``. We recommend only subscribing to | ||
| the returned ``Publisher`` once, because subscribing more than once can lead | ||
| to errors. | ||
|
|
||
| Sample Application | ||
| ~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| .. _java-rs-index-sample: | ||
|
|
||
| .. include:: /includes/usage-examples/sample-index-app-intro.rst | ||
|
|
||
| .. literalinclude:: /includes/usage-examples/sample-index-application.java | ||
| :language: java | ||
| :copyable: | ||
| :linenos: | ||
| :emphasize-lines: 36-38 | ||
|
|
||
| Single Field Index | ||
| ------------------ | ||
|
|
||
| The following example creates an ascending index on the specified field: | ||
|
|
||
| .. literalinclude:: /includes/usage-examples/index-code-examples.java | ||
| :start-after: start-single-field | ||
| :end-before: end-single-field | ||
| :language: java | ||
| :copyable: | ||
| :dedent: | ||
|
|
||
| .. TODO: To learn more about single field indexes, see the :ref:`java-rs-single-field-index` guide. | ||
|
|
||
| Compound Index | ||
| -------------- | ||
|
|
||
| The following example creates a compound index on the specified fields: | ||
|
|
||
| .. literalinclude:: /includes/usage-examples/index-code-examples.java | ||
| :start-after: start-compound | ||
| :end-before: end-compound | ||
| :language: java | ||
| :copyable: | ||
| :dedent: | ||
|
|
||
| .. TODO: To learn more about compound indexes, see the :ref:`java-rs-compound-index` | ||
| .. guide. | ||
|
|
||
| Multikey Index | ||
| -------------- | ||
|
|
||
| The following example creates a multikey index on the specified array-valued field: | ||
|
|
||
| .. literalinclude:: /includes/usage-examples/index-code-examples.java | ||
| :start-after: start-multikey | ||
| :end-before: end-multikey | ||
| :language: java | ||
| :copyable: | ||
| :dedent: | ||
|
|
||
| .. TODO To learn more about multikey indexes, see the :ref:`java-rs-multikey-index` | ||
| .. guide. | ||
|
|
||
| Geospatial Index | ||
| ---------------- | ||
|
|
||
| The following example creates a ``2dsphere`` index on the specified field that contains | ||
| GeoJSON objects: | ||
|
|
||
| .. literalinclude:: /includes/usage-examples/index-code-examples.java | ||
| :start-after: start-geo | ||
| :end-before: end-geo | ||
| :language: java | ||
| :copyable: | ||
| :dedent: | ||
|
|
||
| .. TODO: To learn more about geospatial indexes, see the :ref:`java-rs-geospatial-index` | ||
| .. guide. | ||
|
|
||
| Unique Index | ||
| ------------ | ||
|
|
||
| The following example creates a unique index on the specified field: | ||
|
|
||
| .. literalinclude:: /includes/usage-examples/index-code-examples.java | ||
| :start-after: start-unique | ||
| :end-before: end-unique | ||
| :language: java | ||
| :copyable: | ||
| :dedent: | ||
|
|
||
| .. TODO: To learn more about unique indexes, see the :ref:`java-rs-unique-index` | ||
| .. guide. | ||
|
|
||
| Wildcard Index | ||
| -------------- | ||
|
|
||
| The following example creates a wildcard index in the specified collection: | ||
|
|
||
| .. literalinclude:: /includes/usage-examples/index-code-examples.java | ||
| :start-after: start-wildcard | ||
| :end-before: end-wildcard | ||
| :language: java | ||
| :copyable: | ||
| :dedent: | ||
|
|
||
| .. TODO: To learn more about wildcard indexes, see the :ref:`java-rs-wildcard-index` | ||
| .. guide. | ||
|
|
||
| Clustered Index | ||
| --------------- | ||
|
|
||
| The following example creates a new collection with a clustered index on the ``_id`` | ||
| field: | ||
|
|
||
| .. literalinclude:: /includes/usage-examples/index-code-examples.java | ||
| :start-after: start-clustered | ||
| :end-before: end-clustered | ||
| :language: java | ||
| :copyable: | ||
| :dedent: | ||
|
|
||
| .. TODO: To learn more about wildcard indexes, see the :ref:`java-rs-clustered-index` | ||
| .. guide. | ||
|
|
||
| Atlas Search Index Management | ||
| ----------------------------- | ||
|
|
||
| The following sections contain code examples that describe how to manage Atlas Search | ||
| indexes. | ||
|
|
||
| .. TODO: To learn more about Atlas Search indexes, see the :ref:`java-rs-atlas-search-index` | ||
| .. guide. | ||
|
|
||
| Create Search Index | ||
| ~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| The following example creates an Atlas Search index on the specified field: | ||
|
|
||
| .. literalinclude:: /includes/usage-examples/index-code-examples.java | ||
| :start-after: start-search-create | ||
| :end-before: end-search-create | ||
| :language: java | ||
| :copyable: | ||
| :dedent: | ||
|
|
||
| .. TODO: To learn more about creating search indexes, see the :ref:`java-rs-atlas-search-index-create` | ||
| .. guide. | ||
|
|
||
| List Search Indexes | ||
| ~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| The following example prints a list of Atlas Search indexes in the specified collection: | ||
|
|
||
| .. literalinclude:: /includes/usage-examples/index-code-examples.java | ||
| :start-after: start-search-list | ||
| :end-before: end-search-list | ||
| :language: java | ||
| :copyable: | ||
| :dedent: | ||
|
|
||
| .. TODO: To learn more about listing search indexes, see the :ref:`java-rs-atlas-search-index-list` | ||
| .. guide. | ||
|
|
||
| Update Search Indexes | ||
| ~~~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| The following example updates an existing Atlas Search index with the specified | ||
| new index definition: | ||
|
|
||
| .. literalinclude:: /includes/usage-examples/index-code-examples.java | ||
| :start-after: start-search-update | ||
| :end-before: end-search-update | ||
| :language: java | ||
| :copyable: | ||
| :dedent: | ||
|
|
||
| .. TODO: To learn more about updating search indexes, see the :ref:`java-rs-atlas-search-index-update` | ||
| .. guide. | ||
|
|
||
| Delete Search Indexes | ||
| ~~~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| The following example deletes an Atlas Search index with the specified name: | ||
|
|
||
| .. literalinclude:: /includes/usage-examples/index-code-examples.java | ||
| :start-after: start-search-delete | ||
| :end-before: end-search-delete | ||
| :language: java | ||
| :copyable: | ||
| :dedent: | ||
|
|
||
| .. TODO: To learn more about deleting search indexes, see the :ref:`java-rs-atlas-search-index-drop` | ||
| .. guide. | ||
|
|
||
| Text Index | ||
| ---------- | ||
|
|
||
| The following example creates a text index on the specified string field: | ||
|
|
||
| .. literalinclude:: /includes/usage-examples/index-code-examples.java | ||
| :start-after: start-text | ||
| :end-before: end-text | ||
| :language: java | ||
| :copyable: | ||
| :dedent: | ||
|
|
||
| .. TODO: To learn more about text indexes, see the :ref:`java-rs-text-index` | ||
| .. guide. | ||
|
|
||
| Delete an Index | ||
| --------------- | ||
|
|
||
| The following example deletes an index with the specified name: | ||
|
|
||
| .. literalinclude:: /includes/usage-examples/index-code-examples.java | ||
| :start-after: start-remove | ||
| :end-before: end-remove | ||
| :language: java | ||
| :copyable: | ||
| :dedent: | ||
|
|
||
| .. TODO: To learn more about removing indexes, see :ref:`java-rs-indexes-remove` | ||
| .. in the Work with Indexes guide. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This seems out of place, given other examples in the documentation don't provide such information. Generally, they seem to provide a block about the examples using Project reactor.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I can add the extra info about using Project reactor to be more in line with the Read/Write landing pages.