quarkus.mongodb.database will be used.
+ */
+ String database() default "";
+}
diff --git a/extensions/panache/mongodb-panache/runtime/src/main/java/io/quarkus/mongodb/panache/PanacheMongoEntity.java b/extensions/panache/mongodb-panache/runtime/src/main/java/io/quarkus/mongodb/panache/PanacheMongoEntity.java
new file mode 100755
index 0000000000000..c3ffb4437c151
--- /dev/null
+++ b/extensions/panache/mongodb-panache/runtime/src/main/java/io/quarkus/mongodb/panache/PanacheMongoEntity.java
@@ -0,0 +1,30 @@
+package io.quarkus.mongodb.panache;
+
+import org.bson.types.ObjectId;
+
+/**
+ * Represents an entity with a generated ID field {@link #id} of type {@link ObjectId}. If your
+ * Mongo entities extend this class they gain the ID field and auto-generated accessors
+ * to all their public fields, as well as all the useful methods from {@link PanacheMongoEntityBase}.
+ *
+ * If you want a custom ID type or strategy, you can directly extend {@link PanacheMongoEntityBase}
+ * instead, and write your own ID field. You will still get auto-generated accessors and
+ * all the useful methods.
+ *
+ * @see PanacheMongoEntityBase
+ */
+public abstract class PanacheMongoEntity extends PanacheMongoEntityBase {
+
+ /**
+ * The auto-generated ID field.
+ * This field is set by Mongo when this entity is persisted.
+ *
+ * @see #persist()
+ */
+ public ObjectId id;
+
+ @Override
+ public String toString() {
+ return this.getClass().getSimpleName() + "<" + id + ">";
+ }
+}
diff --git a/extensions/panache/mongodb-panache/runtime/src/main/java/io/quarkus/mongodb/panache/PanacheMongoEntityBase.java b/extensions/panache/mongodb-panache/runtime/src/main/java/io/quarkus/mongodb/panache/PanacheMongoEntityBase.java
new file mode 100755
index 0000000000000..c4ed06d9573cf
--- /dev/null
+++ b/extensions/panache/mongodb-panache/runtime/src/main/java/io/quarkus/mongodb/panache/PanacheMongoEntityBase.java
@@ -0,0 +1,870 @@
+package io.quarkus.mongodb.panache;
+
+import java.util.List;
+import java.util.Map;
+import java.util.stream.Stream;
+
+import org.bson.Document;
+
+import com.mongodb.client.MongoCollection;
+import com.mongodb.client.MongoDatabase;
+
+import io.quarkus.mongodb.panache.runtime.MongoOperations;
+import io.quarkus.panache.common.Parameters;
+import io.quarkus.panache.common.Sort;
+import io.quarkus.panache.common.impl.GenerateBridge;
+
+/**
+ * Represents an entity. If your Mongo entities extend this class they gain auto-generated accessors
+ * to all their public fields, as well as a lot of useful
+ * methods. Unless you have a custom ID strategy, you should not extend this class directly but extend
+ * {@link PanacheMongoEntity} instead.
+ *
+ * @see PanacheMongoEntity
+ */
+public abstract class PanacheMongoEntityBase {
+
+ // Operations
+
+ /**
+ * Persist this entity in the database.
+ * This will set it's ID field if not already set.
+ *
+ * @see #persist(Iterable)
+ * @see #persist(Stream)
+ * @see #persist(Object, Object...)
+ */
+ public void persist() {
+ MongoOperations.persist(this);
+ }
+
+ /**
+ * Update this entity in the database.
+ *
+ * @see #update(Iterable)
+ * @see #update(Stream)
+ * @see #update(Object, Object...)
+ */
+ public void update() {
+ MongoOperations.update(this);
+ }
+
+ /**
+ * Persist this entity in the database or update it if it already exist.
+ *
+ * @see #persistOrUpdate(Iterable)
+ * @see #persistOrUpdate(Stream)
+ * @see #persistOrUpdate(Object, Object...)
+ */
+ public void persistOrUpdate() {
+ MongoOperations.persistOrUpdate(this);
+ }
+
+ /**
+ * Delete this entity from the database, if it is already persisted.
+ *
+ * @see #delete(String, Object...)
+ * @see #delete(String, Map)
+ * @see #delete(String, Parameters)
+ * @see #deleteAll()
+ */
+ public void delete() {
+ MongoOperations.delete(this);
+ }
+
+ // Queries
+
+ /**
+ * Find an entity of this type by ID.
+ *
+ * @param id the ID of the entity to find.
+ * @return the entity found, or null if not found.
+ */
+ @GenerateBridge(targetReturnTypeErased = true)
+ public static find(query, params).list().
+ *
+ * @param query a {@link io.quarkus.mongodb.panache query string}
+ * @param params optional sequence of indexed parameters
+ * @return a {@link List} containing all results, without paging
+ * @see #list(String, Sort, Object...)
+ * @see #list(String, Map)
+ * @see #list(String, Parameters)
+ * @see #find(String, Object...)
+ * @see #stream(String, Object...)
+ */
+ @GenerateBridge
+ public static find(query, sort, params).list().
+ *
+ * @param query a {@link io.quarkus.mongodb.panache query string}
+ * @param sort the sort strategy to use
+ * @param params optional sequence of indexed parameters
+ * @return a {@link List} containing all results, without paging
+ * @see #list(String, Object...)
+ * @see #list(String, Sort, Map)
+ * @see #list(String, Sort, Parameters)
+ * @see #find(String, Sort, Object...)
+ * @see #stream(String, Sort, Object...)
+ */
+ @GenerateBridge
+ public static find(query, params).list().
+ *
+ * @param query a {@link io.quarkus.mongodb.panache query string}
+ * @param params {@link Map} of named parameters
+ * @return a {@link List} containing all results, without paging
+ * @see #list(String, Sort, Map)
+ * @see #list(String, Object...)
+ * @see #list(String, Parameters)
+ * @see #find(String, Map)
+ * @see #stream(String, Map)
+ */
+ @GenerateBridge
+ public static find(query, sort, params).list().
+ *
+ * @param query a {@link io.quarkus.mongodb.panache query string}
+ * @param sort the sort strategy to use
+ * @param params {@link Map} of indexed parameters
+ * @return a {@link List} containing all results, without paging
+ * @see #list(String, Map)
+ * @see #list(String, Sort, Object...)
+ * @see #list(String, Sort, Parameters)
+ * @see #find(String, Sort, Map)
+ * @see #stream(String, Sort, Map)
+ */
+ @GenerateBridge
+ public static find(query, params).list().
+ *
+ * @param query a {@link io.quarkus.mongodb.panache query string}
+ * @param params {@link Parameters} of named parameters
+ * @return a {@link List} containing all results, without paging
+ * @see #list(String, Sort, Parameters)
+ * @see #list(String, Object...)
+ * @see #list(String, Map)
+ * @see #find(String, Parameters)
+ * @see #stream(String, Parameters)
+ */
+ @GenerateBridge
+ public static find(query, sort, params).list().
+ *
+ * @param query a {@link io.quarkus.mongodb.panache query string}
+ * @param sort the sort strategy to use
+ * @param params {@link Parameters} of indexed parameters
+ * @return a {@link List} containing all results, without paging
+ * @see #list(String, Parameters)
+ * @see #list(String, Sort, Object...)
+ * @see #list(String, Sort, Map)
+ * @see #find(String, Sort, Parameters)
+ * @see #stream(String, Sort, Parameters)
+ */
+ @GenerateBridge
+ public static find(query).list().
+ *
+ * @param query a {@link org.bson.Document} query
+ * @return a new {@link PanacheQuery} instance for the given query
+ * @see #find(String, Parameters)
+ * @see #find(String, Sort, Map)
+ * @see #find(String, Sort, Parameters)
+ * @see #list(String, Sort, Parameters)
+ * @see #stream(String, Sort, Parameters)
+ */
+ @GenerateBridge
+ public static find(query, sort).list().
+ *
+ * @param query a {@link org.bson.Document} query
+ * @param sort the {@link org.bson.Document} sort
+ * @return a new {@link PanacheQuery} instance for the given query
+ * @see #find(String, Parameters)
+ * @see #find(String, Sort, Map)
+ * @see #find(String, Sort, Parameters)
+ * @see #list(String, Sort, Parameters)
+ * @see #stream(String, Sort, Parameters)
+ */
+ @GenerateBridge
+ public static findAll().list().
+ *
+ * @return a {@link List} containing all results, without paging
+ * @see #listAll(Sort)
+ * @see #findAll()
+ * @see #streamAll()
+ */
+ @GenerateBridge
+ public static findAll(sort).list().
+ *
+ * @param sort the sort order to use
+ * @return a {@link List} containing all results, without paging
+ * @see #listAll()
+ * @see #findAll(Sort)
+ * @see #streamAll(Sort)
+ */
+ @GenerateBridge
+ public static find(query, params).stream().
+ *
+ * @param query a {@link io.quarkus.mongodb.panache query string}
+ * @param params optional sequence of indexed parameters
+ * @return a {@link Stream} containing all results, without paging
+ * @see #stream(String, Sort, Object...)
+ * @see #stream(String, Map)
+ * @see #stream(String, Parameters)
+ * @see #find(String, Object...)
+ * @see #list(String, Object...)
+ */
+ @GenerateBridge
+ public static find(query, sort, params).stream().
+ *
+ * @param query a {@link io.quarkus.mongodb.panache query string}
+ * @param sort the sort strategy to use
+ * @param params optional sequence of indexed parameters
+ * @return a {@link Stream} containing all results, without paging
+ * @see #stream(String, Object...)
+ * @see #stream(String, Sort, Map)
+ * @see #stream(String, Sort, Parameters)
+ * @see #find(String, Sort, Object...)
+ * @see #list(String, Sort, Object...)
+ */
+ @GenerateBridge
+ public static find(query, params).stream().
+ *
+ * @param query a {@link io.quarkus.mongodb.panache query string}
+ * @param params {@link Map} of named parameters
+ * @return a {@link Stream} containing all results, without paging
+ * @see #stream(String, Sort, Map)
+ * @see #stream(String, Object...)
+ * @see #stream(String, Parameters)
+ * @see #find(String, Map)
+ * @see #list(String, Map)
+ */
+ @GenerateBridge
+ public static find(query, sort, params).stream().
+ *
+ * @param query a {@link io.quarkus.mongodb.panache query string}
+ * @param sort the sort strategy to use
+ * @param params {@link Map} of indexed parameters
+ * @return a {@link Stream} containing all results, without paging
+ * @see #stream(String, Map)
+ * @see #stream(String, Sort, Object...)
+ * @see #stream(String, Sort, Parameters)
+ * @see #find(String, Sort, Map)
+ * @see #list(String, Sort, Map)
+ */
+ @GenerateBridge
+ public static find(query, params).stream().
+ *
+ * @param query a {@link io.quarkus.mongodb.panache query string}
+ * @param params {@link Parameters} of named parameters
+ * @return a {@link Stream} containing all results, without paging
+ * @see #stream(String, Sort, Parameters)
+ * @see #stream(String, Object...)
+ * @see #stream(String, Map)
+ * @see #find(String, Parameters)
+ * @see #list(String, Parameters)
+ */
+ @GenerateBridge
+ public static find(query, sort, params).stream().
+ *
+ * @param query a {@link io.quarkus.mongodb.panache query string}
+ * @param sort the sort strategy to use
+ * @param params {@link Parameters} of indexed parameters
+ * @return a {@link Stream} containing all results, without paging
+ * @see #stream(String, Parameters)
+ * @see #stream(String, Sort, Object...)
+ * @see #stream(String, Sort, Map)
+ * @see #find(String, Sort, Parameters)
+ * @see #list(String, Sort, Parameters)
+ */
+ @GenerateBridge
+ public static find(query).stream().
+ *
+ * @param query a {@link org.bson.Document} query
+ * @return a new {@link PanacheQuery} instance for the given query
+ * @see #find(String, Parameters)
+ * @see #find(String, Sort, Map)
+ * @see #find(String, Sort, Parameters)
+ * @see #list(String, Sort, Parameters)
+ * @see #stream(String, Sort, Parameters)
+ */
+ @GenerateBridge
+ public static find(query, sort).stream().
+ *
+ * @param query a {@link org.bson.Document} query
+ * @param sort the {@link org.bson.Document} sort
+ * @return a new {@link PanacheQuery} instance for the given query
+ * @see #find(String, Parameters)
+ * @see #find(String, Sort, Map)
+ * @see #find(String, Sort, Parameters)
+ * @see #list(String, Sort, Parameters)
+ * @see #stream(String, Sort, Parameters)
+ */
+ @GenerateBridge
+ public static findAll().stream().
+ *
+ * @return a {@link Stream} containing all results, without paging
+ * @see #streamAll(Sort)
+ * @see #findAll()
+ * @see #listAll()
+ */
+ @GenerateBridge
+ public static findAll(sort).stream().
+ *
+ * @param sort the sort order to use
+ * @return a {@link Stream} containing all results, without paging
+ * @see #streamAll()
+ * @see #findAll(Sort)
+ * @see #listAll(Sort)
+ */
+ @GenerateBridge
+ public static null if not found.
+ */
+ @GenerateBridge(targetReturnTypeErased = true)
+ public default Entity findById(Id id) {
+ throw MongoOperations.implementationInjectionMissing();
+ }
+
+ /**
+ * Find entities using a query, with optional indexed parameters.
+ *
+ * @param query a {@link io.quarkus.mongodb.panache query string}
+ * @param params optional sequence of indexed parameters
+ * @return a new {@link PanacheQuery} instance for the given query
+ * @see #find(String, Sort, Object...)
+ * @see #find(String, Map)
+ * @see #find(String, Parameters)
+ * @see #list(String, Object...)
+ * @see #stream(String, Object...)
+ */
+ @GenerateBridge
+ public default PanacheQueryfind(query, params).list().
+ *
+ * @param query a {@link io.quarkus.mongodb.panache query string}
+ * @param params optional sequence of indexed parameters
+ * @return a {@link List} containing all results, without paging
+ * @see #list(String, Sort, Object...)
+ * @see #list(String, Map)
+ * @see #list(String, Parameters)
+ * @see #find(String, Object...)
+ * @see #stream(String, Object...)
+ */
+ @GenerateBridge
+ public default Listfind(query, sort, params).list().
+ *
+ * @param query a {@link io.quarkus.mongodb.panache query string}
+ * @param sort the sort strategy to use
+ * @param params optional sequence of indexed parameters
+ * @return a {@link List} containing all results, without paging
+ * @see #list(String, Object...)
+ * @see #list(String, Sort, Map)
+ * @see #list(String, Sort, Parameters)
+ * @see #find(String, Sort, Object...)
+ * @see #stream(String, Sort, Object...)
+ */
+ @GenerateBridge
+ public default Listfind(query, params).list().
+ *
+ * @param query a {@link io.quarkus.mongodb.panache query string}
+ * @param params {@link Map} of named parameters
+ * @return a {@link List} containing all results, without paging
+ * @see #list(String, Sort, Map)
+ * @see #list(String, Object...)
+ * @see #list(String, Parameters)
+ * @see #find(String, Map)
+ * @see #stream(String, Map)
+ */
+ @GenerateBridge
+ public default Listfind(query, sort, params).list().
+ *
+ * @param query a {@link io.quarkus.mongodb.panache query string}
+ * @param sort the sort strategy to use
+ * @param params {@link Map} of indexed parameters
+ * @return a {@link List} containing all results, without paging
+ * @see #list(String, Map)
+ * @see #list(String, Sort, Object...)
+ * @see #list(String, Sort, Parameters)
+ * @see #find(String, Sort, Map)
+ * @see #stream(String, Sort, Map)
+ */
+ @GenerateBridge
+ public default Listfind(query, params).list().
+ *
+ * @param query a {@link io.quarkus.mongodb.panache query string}
+ * @param params {@link Parameters} of named parameters
+ * @return a {@link List} containing all results, without paging
+ * @see #list(String, Sort, Parameters)
+ * @see #list(String, Object...)
+ * @see #list(String, Map)
+ * @see #find(String, Parameters)
+ * @see #stream(String, Parameters)
+ */
+ @GenerateBridge
+ public default Listfind(query, sort, params).list().
+ *
+ * @param query a {@link io.quarkus.mongodb.panache query string}
+ * @param sort the sort strategy to use
+ * @param params {@link Parameters} of indexed parameters
+ * @return a {@link List} containing all results, without paging
+ * @see #list(String, Parameters)
+ * @see #list(String, Sort, Object...)
+ * @see #list(String, Sort, Map)
+ * @see #find(String, Sort, Parameters)
+ * @see #stream(String, Sort, Parameters)
+ */
+ @GenerateBridge
+ public default Listfind(query).list().
+ *
+ * @param query a {@link org.bson.Document} query
+ * @return a new {@link PanacheQuery} instance for the given query
+ * @see #find(String, Parameters)
+ * @see #find(String, Sort, Map)
+ * @see #find(String, Sort, Parameters)
+ * @see #list(String, Sort, Parameters)
+ * @see #stream(String, Sort, Parameters)
+ */
+ @GenerateBridge
+ public default PanacheQueryfind(query, sort).list().
+ *
+ * @param query a {@link org.bson.Document} query
+ * @param sort the {@link org.bson.Document} sort
+ * @return a new {@link PanacheQuery} instance for the given query
+ * @see #find(String, Parameters)
+ * @see #find(String, Sort, Map)
+ * @see #find(String, Sort, Parameters)
+ * @see #list(String, Sort, Parameters)
+ * @see #stream(String, Sort, Parameters)
+ */
+ @GenerateBridge
+ public default PanacheQueryfindAll().list().
+ *
+ * @return a {@link List} containing all results, without paging
+ * @see #listAll(Sort)
+ * @see #findAll()
+ * @see #streamAll()
+ */
+ @GenerateBridge
+ public default ListfindAll(sort).list().
+ *
+ * @param sort the sort order to use
+ * @return a {@link List} containing all results, without paging
+ * @see #listAll()
+ * @see #findAll(Sort)
+ * @see #streamAll(Sort)
+ */
+ @GenerateBridge
+ public default Listfind(query, params).stream().
+ *
+ * @param query a {@link io.quarkus.mongodb.panache query string}
+ * @param params optional sequence of indexed parameters
+ * @return a {@link Stream} containing all results, without paging
+ * @see #stream(String, Sort, Object...)
+ * @see #stream(String, Map)
+ * @see #stream(String, Parameters)
+ * @see #find(String, Object...)
+ * @see #list(String, Object...)
+ */
+ @GenerateBridge
+ public default Streamfind(query, sort, params).stream().
+ *
+ * @param query a {@link io.quarkus.mongodb.panache query string}
+ * @param sort the sort strategy to use
+ * @param params optional sequence of indexed parameters
+ * @return a {@link Stream} containing all results, without paging
+ * @see #stream(String, Object...)
+ * @see #stream(String, Sort, Map)
+ * @see #stream(String, Sort, Parameters)
+ * @see #find(String, Sort, Object...)
+ * @see #list(String, Sort, Object...)
+ */
+ @GenerateBridge
+ public default Streamfind(query, params).stream().
+ *
+ * @param query a {@link io.quarkus.mongodb.panache query string}
+ * @param params {@link Map} of named parameters
+ * @return a {@link Stream} containing all results, without paging
+ * @see #stream(String, Sort, Map)
+ * @see #stream(String, Object...)
+ * @see #stream(String, Parameters)
+ * @see #find(String, Map)
+ * @see #list(String, Map)
+ */
+ @GenerateBridge
+ public default Streamfind(query, sort, params).stream().
+ *
+ * @param query a {@link io.quarkus.mongodb.panache query string}
+ * @param sort the sort strategy to use
+ * @param params {@link Map} of indexed parameters
+ * @return a {@link Stream} containing all results, without paging
+ * @see #stream(String, Map)
+ * @see #stream(String, Sort, Object...)
+ * @see #stream(String, Sort, Parameters)
+ * @see #find(String, Sort, Map)
+ * @see #list(String, Sort, Map)
+ */
+ @GenerateBridge
+ public default Streamfind(query, params).stream().
+ *
+ * @param query a {@link io.quarkus.mongodb.panache query string}
+ * @param params {@link Parameters} of named parameters
+ * @return a {@link Stream} containing all results, without paging
+ * @see #stream(String, Sort, Parameters)
+ * @see #stream(String, Object...)
+ * @see #stream(String, Map)
+ * @see #find(String, Parameters)
+ * @see #list(String, Parameters)
+ */
+ @GenerateBridge
+ public default Streamfind(query, sort, params).stream().
+ *
+ * @param query a {@link io.quarkus.mongodb.panache query string}
+ * @param sort the sort strategy to use
+ * @param params {@link Parameters} of indexed parameters
+ * @return a {@link Stream} containing all results, without paging
+ * @see #stream(String, Parameters)
+ * @see #stream(String, Sort, Object...)
+ * @see #stream(String, Sort, Map)
+ * @see #find(String, Sort, Parameters)
+ * @see #list(String, Sort, Parameters)
+ */
+ @GenerateBridge
+ public default Streamfind(query).stream().
+ *
+ * @param query a {@link org.bson.Document} query
+ * @return a new {@link PanacheQuery} instance for the given query
+ * @see #find(String, Parameters)
+ * @see #find(String, Sort, Map)
+ * @see #find(String, Sort, Parameters)
+ * @see #list(String, Sort, Parameters)
+ * @see #stream(String, Sort, Parameters)
+ */
+ @GenerateBridge
+ public default PanacheQueryfind(query, sort).stream().
+ *
+ * @param query a {@link org.bson.Document} query
+ * @param sort the {@link org.bson.Document} sort
+ * @return a new {@link PanacheQuery} instance for the given query
+ * @see #find(String, Parameters)
+ * @see #find(String, Sort, Map)
+ * @see #find(String, Sort, Parameters)
+ * @see #list(String, Sort, Parameters)
+ * @see #stream(String, Sort, Parameters)
+ */
+ @GenerateBridge
+ public default PanacheQueryfindAll().stream().
+ *
+ * @return a {@link Stream} containing all results, without paging
+ * @see #streamAll(Sort)
+ * @see #findAll()
+ * @see #listAll()
+ */
+ @GenerateBridge
+ public default StreamfindAll(sort).stream().
+ *
+ * @return a {@link Stream} containing all results, without paging
+ * @see #streamAll()
+ * @see #findAll(Sort)
+ * @see #listAll(Sort)
+ */
+ @GenerateBridge
+ public default StreamSELECT COUNT(*) and a query equivalent to the current query, minus
+ * ordering.
+ *
+ * @return the total number of entities this query operates on, cached.
+ */
+ public long count();
+
+ /**
+ * Returns the current page of results as a {@link List}.
+ *
+ * @return the current page of results as a {@link List}.
+ * @see #stream()
+ * @see #page(Page)
+ * @see #page()
+ */
+ public
+ * public class Person extends PanacheMongoEntity {
+ * public String name;
+ * public LocalDate birth;
+ * public PersonStatus status;
+ *
+ * public static Person findByName(String name){
+ * return find("name", name).firstResult();
+ * }
+ *
+ * public static List<Person> findAlive(){
+ * return list("status", Status.Alive);
+ * }
+ *
+ * public static void deleteStefs(){
+ * delete("name", "Stef");
+ * }
+ * }
+ *
+ * You can use the @MongoEntity annotation to define the name of the MongoDB collection,
+ * otherwise it will be the name of your entity.
+ *
+ * The Mongo PojoCodec is used to serialize your entity to Bson Document, you can find more information on it's
+ * documentation page: https://mongodb.github.io/mongo-java-driver/3.10/bson/pojos/
+ * You can use the MongoDB annotations to control the mapping to the database : @BsonId,
+ * @BsonProperty("fieldName"), @BsonIgnore.
+ *
+ * Normally, MongoDB queries are of this form: {"field1": "value1", "field2": "value2"}
+ *
+ * We support multiple convenience query implementations, this is what we called PanacheQL queries: + *
@BsonProperty annotations
+ * You can also write native MongoDB queries, in this case the field names are not replaced even if you use
+ * @BsonProperty, but you can still use parameterized queries by index or name.
+ * find("{'field':?1}", value) or find("{'field'::key}", value)
+ *