Docs Menu
Docs Home
/
MongoDB Atlas
/ / / /

How to Index Boolean Values

On this page

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

You can use the Atlas Search boolean type to index true and false values. You can query fields of type boolean using the equals and in operators.

You can also use the boolean type to index:

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

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

The Atlas Search boolean type takes the following parameter:

Option
Type
Necessity
Description
type
string
required
Human-readable label that identifies this field type. Value must be boolean.

The following index definition example uses the sample_guides.planets 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 index definition indexes the hasRings field in the collection as the Atlas Search boolean type to support queries against that field using the Atlas Search equals operator.

Tip

See also: Additional Index Definition Examples

← autocomplete
date →