avoid-text-index-name-limit.txt

===============================
Specify Name for ``text`` Index
===============================

.. default-domain:: mongodb

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

.. admonition:: Changed in MongoDB 4.2
   :class: note

   .. include:: /includes/extracts/4.2-changes-index-names.rst

The default name for the index consists of each indexed field name
concatenated with ``_text``. For example, the following command creates
a ``text`` index on the fields ``content``, ``users.comments``, and
``users.profiles``:

.. code-block:: javascript

   db.collection.createIndex(
      {
        content: "text",
        "users.comments": "text",
        "users.profiles": "text"
      }
   )

The default name for the index is:

.. code-block:: javascript

   "content_text_users.comments_text_users.profiles_text"

Specify a Name for ``text`` Index
---------------------------------

You can pass the ``name`` option to the
:method:`db.collection.createIndex()` method:

.. code-block:: javascript

   db.collection.createIndex(
      {
        content: "text",
        "users.comments": "text",
        "users.profiles": "text"
      },
      {
        name: "MyTextIndex"
      }
   )

.. TODO this probably should move out somewhere, but for now ...

.. _drop-text-index:

Use the Index Name to Drop a ``text`` Index
-------------------------------------------

Whether the :doc:`text </core/index-text>` index has the default name
or you specified a name for the :doc:`text </core/index-text>` index,
to drop the :doc:`text </core/index-text>` index, pass the index name
to the :method:`db.collection.dropIndex()` method.

For example, consider the index created by the following operation:

.. code-block:: javascript

   db.collection.createIndex(
      {
        content: "text",
        "users.comments": "text",
        "users.profiles": "text"
      },
      {
        name: "MyTextIndex"
      }
   )   

Then, to remove this text index, pass the name ``"MyTextIndex"`` to the
:method:`db.collection.dropIndex()` method, as in the following:

.. code-block:: javascript

   db.collection.dropIndex("MyTextIndex")

To get the names of the indexes, use the
:method:`db.collection.getIndexes()` method.