MongoDB indexes support

data-model/src/main/java/io/micronaut/data/annotation/JsonView.java

@@ -32,8 +32,8 @@
  * {@code
  * @JsonView(value = "CONTACT_VIEW", alias = "cv", entity = Contact.class)
  * public class ContactView {
- *     @Id
- *     @GeneratedValue(GeneratedValue.Type.IDENTITY)
+ *     @Id
+ *     @GeneratedValue(GeneratedValue.Type.IDENTITY)
  *     private Long id;
  *     private String name;
  *     private int age;

data-mongodb/src/main/java/io/micronaut/data/mongodb/annotation/index/MongoClusteredIndex.java

@@ -0,0 +1,51 @@
+/*
+ * Copyright 2017-2026 original authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package io.micronaut.data.mongodb.annotation.index;
+
+import java.lang.annotation.Documented;
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Inherited;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * Declares MongoDB clustered collection options for an entity collection.
+ *
+ * @author radovanradic
+ * @since 5.0.0
+ */
+@Retention(RetentionPolicy.RUNTIME)
+@Target({ElementType.TYPE, ElementType.ANNOTATION_TYPE})
+@Documented
+@Inherited
+public @interface MongoClusteredIndex {
+
+    /**
+     * @return The clustered index name.
+     */
+    String name() default "";
+
+    /**
+     * @return Whether clustered index is unique. MongoDB requires {@code true}.
+     */
+    boolean unique() default true;
+
+    /**
+     * @return The collection expiration in seconds for clustered TTL collections.
+     */
+    int expireAfterSeconds() default -1;
+}

data-mongodb/src/main/java/io/micronaut/data/mongodb/annotation/index/MongoCompoundIndex.java

@@ -0,0 +1,93 @@
+/*
+ * Copyright 2017-2026 original authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package io.micronaut.data.mongodb.annotation.index;
+
+import java.lang.annotation.Documented;
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Inherited;
+import java.lang.annotation.Repeatable;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * Declares a compound MongoDB index for an entity.
+ *
+ * @author radovanradic
+ * @since 5.0.0
+ */
+@Retention(RetentionPolicy.RUNTIME)
+@Target({ElementType.TYPE, ElementType.ANNOTATION_TYPE})
+@Documented
+@Inherited
+@Repeatable(MongoCompoundIndexes.class)
+public @interface MongoCompoundIndex {
+
+    /**
+     * @return The index name.
+     */
+    String name() default "";
+
+    /**
+     * @return The fields.
+     */
+    MongoCompoundIndexField[] fields();
+
+    /**
+     * @return Whether the index is unique.
+     */
+    boolean unique() default false;
+
+    /**
+     * @return Whether the index is sparse.
+     */
+    boolean sparse() default false;
+
+    /**
+     * @return Whether the index is hidden.
+     */
+    boolean hidden() default false;
+
+    /**
+     * @return The index expiration in seconds.
+     */
+    int expireAfterSeconds() default -1;
+
+    /**
+     * @return The partial filter expression as JSON.
+     */
+    String partialFilterExpression() default "";
+
+    /**
+     * @return The collation definition as JSON.
+     */
+    String collation() default "";
+
+    /**
+     * @return The index creation command comment.
+     */
+    String comment() default "";
+
+    /**
+     * @return The createIndexes commit quorum.
+     */
+    String commitQuorum() default "";
+
+    /**
+     * @return The storage engine options as JSON.
+     */
+    String storageEngine() default "";
+}

data-mongodb/src/main/java/io/micronaut/data/mongodb/annotation/index/MongoCompoundIndexField.java

@@ -0,0 +1,66 @@
+/*
+ * Copyright 2017-2026 original authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package io.micronaut.data.mongodb.annotation.index;
+
+import java.lang.annotation.Documented;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+
+/**
+ * Declares a field within a compound MongoDB index.
+ *
+ * @author radovanradic
+ * @since 5.0.0
+ */
+@Retention(RetentionPolicy.RUNTIME)
+@Documented
+public @interface MongoCompoundIndexField {
+
+    /**
+     * @return The property path.
+     */
+    String value();
+
+    /**
+     * @return The field direction.
+     */
+    MongoIndexDirection direction() default MongoIndexDirection.ASC;
+
+    /**
+     * @return The geospatial key kind when this field should use a geospatial index key inside a compound index.
+     */
+    MongoGeoIndexType geoType() default MongoGeoIndexType.GEO_2DSPHERE;
+
+    /**
+     * @return Whether the field should use the geospatial key kind instead of the numeric direction.
+     */
+    boolean geo() default false;
+
+    /**
+     * @return The 2d index bits setting, or -1 if unset.
+     */
+    int bits() default -1;
+
+    /**
+     * @return The 2d index minimum value, or NaN if unset.
+     */
+    double min() default Double.NaN;
+
+    /**
+     * @return The 2d index maximum value, or NaN if unset.
+     */
+    double max() default Double.NaN;
+}

data-mongodb/src/main/java/io/micronaut/data/mongodb/annotation/index/MongoCompoundIndexes.java

@@ -0,0 +1,41 @@
+/*
+ * Copyright 2017-2026 original authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package io.micronaut.data.mongodb.annotation.index;
+
+import java.lang.annotation.Documented;
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Inherited;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * Repeatable annotation for {@link MongoCompoundIndex}.
+ *
+ * @author radovanradic
+ * @since 5.0.0
+ */
+@Retention(RetentionPolicy.RUNTIME)
+@Target(ElementType.TYPE)
+@Documented
+@Inherited
+public @interface MongoCompoundIndexes {
+
+    /**
+     * @return The indexes.
+     */
+    MongoCompoundIndex[] value() default {};
+}

data-mongodb/src/main/java/io/micronaut/data/mongodb/annotation/index/MongoGeoIndexType.java

@@ -0,0 +1,40 @@
+/*
+ * Copyright 2017-2026 original authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package io.micronaut.data.mongodb.annotation.index;
+
+/**
+ * Supported MongoDB geospatial index kinds.
+ *
+ * @author radovanradic
+ * @since 5.0.0
+ */
+public enum MongoGeoIndexType {
+    GEO_2D("2d"),
+    GEO_2DSPHERE("2dsphere");
+
+    private final String key;
+
+    MongoGeoIndexType(String key) {
+        this.key = key;
+    }
+
+    /**
+     * @return The MongoDB key value.
+     */
+    public String getKey() {
+        return key;
+    }
+}

data-mongodb/src/main/java/io/micronaut/data/mongodb/annotation/index/MongoGeoIndexed.java

@@ -0,0 +1,85 @@
+/*
+ * Copyright 2017-2026 original authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package io.micronaut.data.mongodb.annotation.index;
+
+import java.lang.annotation.Documented;
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Inherited;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * Declares a simple MongoDB geospatial index for a property.
+ *
+ * @author radovanradic
+ * @since 5.0.0
+ */
+@Retention(RetentionPolicy.RUNTIME)
+@Target({ElementType.FIELD, ElementType.METHOD, ElementType.ANNOTATION_TYPE})
+@Documented
+@Inherited
+public @interface MongoGeoIndexed {
+
+    /**
+     * @return The index name.
+     */
+    String name() default "";
+
+    /**
+     * @return The geospatial index kind. Defaults to {@link MongoGeoIndexType#GEO_2DSPHERE}.
+     */
+    MongoGeoIndexType type() default MongoGeoIndexType.GEO_2DSPHERE;
+
+    /**
+     * @return Whether the index is hidden.
+     */
+    boolean hidden() default false;
+
+    /**
+     * @return The index creation command comment.
+     */
+    String comment() default "";
+
+    /**
+     * @return The storage engine options as JSON.
+     */
+    String storageEngine() default "";
+
+    /**
+     * @return The 2dsphere index version, or {@code -1} if unset. Only valid for
+     * {@link MongoGeoIndexType#GEO_2DSPHERE}.
+     */
+    int sphereVersion() default -1;
+
+    /**
+     * @return The 2d index bits setting, or {@code -1} if unset. Only valid for
+     * {@link MongoGeoIndexType#GEO_2D}. Valid range is 1..32 inclusive. MongoDB default is 26.
+     */
+    int bits() default -1;
+
+    /**
+     * @return The 2d index minimum value, or {@link Double#NaN} if unset. Only valid for
+     * {@link MongoGeoIndexType#GEO_2D}. Represents the lower inclusive boundary. MongoDB default is -180.0.
+     */
+    double min() default Double.NaN;
+
+    /**
+     * @return The 2d index maximum value, or {@link Double#NaN} if unset. Only valid for
+     * {@link MongoGeoIndexType#GEO_2D}. Represents the upper inclusive boundary. MongoDB default is 180.0.
+     */
+    double max() default Double.NaN;
+}