indexes.txt

.. _pymongo-indexes:

=============================
Optimize Queries with Indexes
=============================

.. contents:: On this page
   :local:
   :backlinks: none
   :depth: 2
   :class: singlecol

.. facet::
   :name: genre
   :values: reference
 
.. meta::
   :description: Learn how to use indexes with the MongoDB {+driver-short+} driver.
   :keywords: query, optimization, efficiency, usage example, code example

.. toctree::
   :titlesonly:
   :maxdepth: 1

   Work with Indexes </work-with-indexes>

Overview
--------

On this page, you can see copyable code examples that show how to work with common
types of indexes that you can use with {+driver-short+}.

.. tip::

  To learn more about working with indexes, see the :ref:`pymongo-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 <pymongo-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.

.. _pymongo-index-sample:

.. include:: /includes/usage-examples/sample-app-intro.rst

.. literalinclude:: /includes/usage-examples/sample-app.py
   :language: python
   :copyable:
   :linenos:
   :emphasize-lines: 11-13

Single Field Index
------------------

.. literalinclude:: /includes/usage-examples/index-code-examples.py
   :start-after: start-single-field
   :end-before: end-single-field
   :language: python
   :copyable:

To learn more about single field indexes, see the
:ref:`pymongo-single-field-index` guide.

Compound Index
--------------

.. literalinclude:: /includes/usage-examples/index-code-examples.py
   :start-after: start-compound
   :end-before: end-compound
   :language: python
   :copyable:

To learn more about compound indexes, see the :ref:`pymongo-compound-index`
guide.

Multikey Index
--------------

.. literalinclude:: /includes/usage-examples/index-code-examples.py
   :start-after: start-multikey
   :end-before: end-multikey
   :language: python
   :copyable:

To learn more about multikey indexes, see the :ref:`pymongo-multikey-index`
guide.

Atlas Search Index
------------------

To learn more about Atlas search indexes, see the :ref:`pymongo-atlas-search-index`
guide.

Create Search Index
~~~~~~~~~~~~~~~~~~~

.. literalinclude:: /includes/usage-examples/index-code-examples.py
   :start-after: start-search-create
   :end-before: end-search-create
   :language: python
   :copyable:

To learn more about creating search indexes, see the :ref:`pymongo-atlas-search-index-create`
guide.

List Search Indexes
~~~~~~~~~~~~~~~~~~~

.. literalinclude:: /includes/usage-examples/index-code-examples.py
   :start-after: start-search-list
   :end-before: end-search-list
   :language: python
   :copyable:

To learn more about listing search indexes, see the :ref:`pymongo-atlas-search-index-list`
guide.

Update Search Indexes
~~~~~~~~~~~~~~~~~~~~~

.. literalinclude:: /includes/usage-examples/index-code-examples.py
   :start-after: start-search-update
   :end-before: end-search-update
   :language: python
   :copyable:

To learn more about updating search indexes, see the :ref:`pymongo-atlas-search-index-update`
guide.

Delete Search Indexes
~~~~~~~~~~~~~~~~~~~~~

.. literalinclude:: /includes/usage-examples/index-code-examples.py
   :start-after: start-search-drop
   :end-before: end-search-drop
   :language: python
   :copyable:

To learn more about deleting search indexes, see the :ref:`pymongo-atlas-search-index-drop`
guide.


Text Index
----------

.. literalinclude:: /includes/usage-examples/index-code-examples.py
   :start-after: start-text
   :end-before: end-text
   :language: python
   :copyable:

To learn more about text indexes, see the :ref:`pymongo-text-index`
guide.

.. _geospatial-indexes:

Geospatial Index
----------------

.. literalinclude:: /includes/usage-examples/index-code-examples.py
   :start-after: start-geo
   :end-before: end-geo
   :language: python
   :copyable:

To learn more about geospatial indexes, see the :ref:`pymongo-geospatial-index`
guide.

Unique Index
------------

.. literalinclude:: /includes/usage-examples/index-code-examples.py
   :start-after: start-unique
   :end-before: end-unique
   :language: python
   :copyable:

To learn more about unique indexes, see the :ref:`pymongo-unique-index`
guide.

Wildcard Index
--------------

.. literalinclude:: /includes/usage-examples/index-code-examples.py
   :start-after: start-wildcard
   :end-before: end-wildcard
   :language: python
   :copyable:

To learn more about wildcard indexes, see the :ref:`pymongo-wildcard-index`
guide.

Clustered Index
---------------

.. literalinclude:: /includes/usage-examples/index-code-examples.py
   :start-after: start-clustered
   :end-before: end-clustered
   :language: python
   :copyable:

To learn more about wildcard indexes, see the :ref:`pymongo-clustered-index`
guide.

Remove an Index
---------------

.. literalinclude:: /includes/usage-examples/index-code-examples.py
   :start-after: start-remove
   :end-before: end-remove
   :language: python
   :copyable:

To learn more about removing indexes, see :ref:`pymongo-indexes-remove`
in the Work with Indexes guide.