Docs Menu
Docs Home
/
MongoDB Atlas
/ / / /

How to Index ObjectId Values in Fields

On this page

  • Define the Index for the objectId Type
  • Configure objectId Field Properties
  • Try an Example for the objectId Type

You can use the Atlas Search objectId type to index ObjectId values. You can query fields of type objectId using the equals and in operators.

You can also use the objectId type to index:

If you enable dynamic mappings, Atlas Search automatically indexes fields of type objectId. You can use the Visual Editor or the JSON Editor in the Atlas UI to index fields as the objectId type.

To define the index for the objectId type, choose your preferred configuration method in the Atlas UI and then select the database and collection.

The Atlas Search objectId type takes the following option:

UI Field Name
JSON Option
Type
Necessity
Description
Data Type
type
string
required
Human-readable label that identifies this field type. Value must be objectId.

The following index definition example uses the sample_mflix.comments collection. If you have the sample data already loaded on your cluster, you can use the Visual Editor or JSON Editor in the Atlas UI to configure the index. After you select your preferred configuration method, select the database and collection, and refine your index to add field mappings.

The following example index definition indexes the movie_id field as the objectId data type to support queries against that field using the Atlas Search equals operator.

Tip

See also: Additional Index Definition Examples

← numberFacet
string →