Package dev.morphia

Interface Datastore

    • Method Detail

      • aggregate

        Aggregation<Document> aggregate​(String source)
        Returns a new query bound to the kind (a specific MongoCollection)
        Parameters:
        source - The collection aggregation against
        Returns:
        the aggregation pipeline
        Since:
        2.0

      • aggregate

        <T> Aggregation<T> aggregate​(Class<T> source)
        Returns a new query bound to the kind (a specific MongoCollection)
        Type Parameters:
        T - the source type
        Parameters:
        source - The class to create aggregation against
        Returns:
        the aggregation pipeline
        Since:
        2.0

      • createQuery

        @Deprecated(since="2.0",
            forRemoval=true)
default <T> Query<T> createQuery​(Class<T> type)
        Deprecated, for removal: This API element is subject to removal in a future version.
        use find(Class)
        Returns a new query bound to the collection (a specific MongoCollection)
        Type Parameters:
        T - the type of the query
        Parameters:
        type - The collection to query
        Returns:
        the query

      • delete

        @Deprecated(since="2.0",
            forRemoval=true)
default <T> DeleteResult delete​(Query<T> query)
        Deprecated, for removal: This API element is subject to removal in a future version.
        use Query.delete() instead
        Deletes entities based on the query
        Type Parameters:
        T - the type to delete
        Parameters:
        query - the query to use when finding documents to delete
        Returns:
        results of the delete

      • delete

        @Deprecated(since="2.0",
            forRemoval=true)
default <T> DeleteResult delete​(Query<T> query,
                                DeleteOptions options)
        Deprecated, for removal: This API element is subject to removal in a future version.
        use Query.delete(DeleteOptions) instead
        Deletes entities based on the query
        Type Parameters:
        T - the type to delete
        Parameters:
        query - the query to use when finding documents to delete
        options - the options to apply to the delete
        Returns:
        results of the delete
        Since:
        1.3

      • delete

        <T> DeleteResult delete​(T entity)
        Deletes the given entity (by @Id)
        Type Parameters:
        T - the type to delete
        Parameters:
        entity - the entity to delete
        Returns:
        results of the delete

      • delete

        <T> DeleteResult delete​(T entity,
                        DeleteOptions options)
        Deletes the given entity (by @Id), with the WriteConcern
        Type Parameters:
        T - the type to delete
        Parameters:
        entity - the entity to delete
        options - the options to use when deleting
        Returns:
        results of the delete
        Since:
        1.3

      • enableDocumentValidation

        @Deprecated(since="2.4.0",
            forRemoval=true)
void enableDocumentValidation()
        Deprecated, for removal: This API element is subject to removal in a future version.
        this is handled by the config file and should not be called directly
        Process any Validation annotations for document validation.
        Since:
        1.3
        MongoDB documentation
        core/document-validation/

      • ensureCaps

        @Deprecated(since="2.4.0",
            forRemoval=true)
void ensureCaps()
        Deprecated, for removal: This API element is subject to removal in a future version.
        this is handled by the config file and should not be called directly
        ensure capped collections for Entity(s)

      • ensureIndexes

        @Deprecated(since="2.4.0",
            forRemoval=true)
void ensureIndexes()
        Deprecated, for removal: This API element is subject to removal in a future version.
        this is configured by the config file and doesn't need to be called directly
        Ensures (creating if necessary) the indexes found during class mapping
        See Also:
        Indexes, Indexed, Text

      • find

        <T> Query<T> find​(Class<T> type)
        Find instances of a type
        Type Parameters:
        T - the type to query
        Parameters:
        type - the class to use for mapping the results
        Returns:
        the query

      • find

        @MorphiaExperimental
<T> Query<T> find​(Class<T> type,
                  Document nativeQuery)
        Find instances of a type using a native query. This method is intended as an aid when copying queries from external sources such as the shell or Compass whose structure is already in json form.
        Type Parameters:
        T - the type to query
        Parameters:
        type - the class to use for mapping the results
        nativeQuery - the full query structure to use for this Query
        Returns:
        the query
        Since:
        2.3
        Developer note.
        This is an experimental item. Its function and presence are subject to change. Feedback on features and usability extremely welcome.

      • find

        @Deprecated(forRemoval=true,
            since="2.3")
<T> Query<T> find​(String collection,
                  Class<T> type)
        Deprecated, for removal: This API element is subject to removal in a future version.
        use FindOptions.collection(String) instead
        Find all instances by type from an alternate collection
        Type Parameters:
        T - the type to query
        Parameters:
        collection - the actual collection to query. This overrides any mapped on collection on type.
        type - the class to use for mapping the results
        Returns:
        the query

      • find

        @MorphiaInternal
<T> Query<T> find​(String collection)
        Find all instances by type in a different collection than what is mapped on the class given.
        Type Parameters:
        T - the type to query
        Parameters:
        collection - the collection to query against
        Returns:
        the query
        Developer note.
        This is an internal item. Its function and presence are subject to change without warning. Its use is highly discouraged.

      • findAndDelete

        @Nullable
@Deprecated(since="2.0",
            forRemoval=true)
default <T> T findAndDelete​(Query<T> query)
        Deprecated, for removal: This API element is subject to removal in a future version.
        use Query.findAndDelete() instead
        Deletes the given entities based on the query (first item only).
        Type Parameters:
        T - the type to query
        Parameters:
        query - the query to use when finding entities to delete
        Returns:
        the deleted Entity

      • findAndDelete

        @Nullable
@Deprecated(since="2.0",
            forRemoval=true)
default <T> T findAndDelete​(Query<T> query,
                            FindAndModifyOptions options)
        Deprecated, for removal: This API element is subject to removal in a future version.
        use Query.findAndDelete(FindAndDeleteOptions) instead
        Deletes the given entities based on the query (first item only).
        Type Parameters:
        T - the type to query
        Parameters:
        query - the query to use when finding entities to delete
        options - the options to apply to the delete
        Returns:
        the deleted Entity
        Since:
        1.3

      • findAndModify

        @Nullable
@Deprecated(since="2.0",
            forRemoval=true)
default <T> T findAndModify​(Query<T> query,
                            UpdateOperations<T> operations,
                            FindAndModifyOptions options)
        Deprecated, for removal: This API element is subject to removal in a future version.
        use Query.modify(UpdateOperations) instead
        Find the first Entity from the Query, and modify it.
        Type Parameters:
        T - the type to query
        Parameters:
        query - the query to use when finding entities to update
        operations - the updates to apply to the matched documents
        options - the options to apply
        Returns:
        The modified Entity (the result of the update)

      • findAndModify

        @Nullable
@Deprecated(since="2.0",
            forRemoval=true)
default <T> T findAndModify​(Query<T> query,
                            UpdateOperations<T> operations)
        Deprecated, for removal: This API element is subject to removal in a future version.
        use Query.modify(UpdateOperations) instead
        Find the first Entity from the Query, and modify it.
        Type Parameters:
        T - the type to query
        Parameters:
        query - the query to use when finding entities to update
        operations - the updates to apply to the matched documents
        Returns:
        The modified Entity (the result of the update)

      • getCodecRegistry

        @MorphiaInternal
CodecRegistry getCodecRegistry()
        Returns:
        the codec registry
        Since:
        2.3
        Developer note.
        This is an internal item. Its function and presence are subject to change without warning. Its use is highly discouraged.

      • getCollection

        @MorphiaInternal
<T> MongoCollection<T> getCollection​(Class<T> type)
        Type Parameters:
        T - the class type
        Parameters:
        type - the type look up
        Returns:
        the collection mapped for this class
        Since:
        2.3
        Developer note.
        This is an internal item. Its function and presence are subject to change without warning. Its use is highly discouraged.

      • getDatabase

        @MorphiaInternal
MongoDatabase getDatabase()
        Returns:
        the MongoDatabase used by this DataStore
        Since:
        1.5
        Developer note.
        This is an internal item. Its function and presence are subject to change without warning. Its use is highly discouraged.

      • getLoggedQuery

        @MorphiaInternal
@Deprecated(forRemoval=true)
String getLoggedQuery​(FindOptions options)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use Query.getLoggedQuery() instead
        Parameters:
        options - the options used when requesting logging
        Returns:
        the logged query
        Since:
        2.0
        Developer note.
        This is an internal item. Its function and presence are subject to change without warning. Its use is highly discouraged.

      • getMapper

        @MorphiaInternal
Mapper getMapper()
        Returns:
        the Mapper used by this Datastore
        Since:
        1.5
        Developer note.
        This is an internal item. Its function and presence are subject to change without warning. Its use is highly discouraged.

      • insert

        default <T> void insert​(T entity)
        Inserts an entity in to the mapped collection.
        Type Parameters:
        T - the type of the entity
        Parameters:
        entity - the entity to insert

      • insert

        <T> void insert​(T entity,
                InsertOneOptions options)
        Inserts an entity in to the mapped collection.
        Type Parameters:
        T - the type of the entity
        Parameters:
        entity - the entity to insert
        options - the options to apply to the insert operation
        Since:
        2.0

      • insert

        default <T> void insert​(List<T> entities)
        Inserts a List of entities in to the mapped collection.
        Type Parameters:
        T - the type of the entity
        Parameters:
        entities - the entities to insert
        Since:
        2.0

      • insert

        <T> void insert​(List<T> entities,
                InsertManyOptions options)
        Inserts entities in to the mapped collection.
        Type Parameters:
        T - the type of the entity
        Parameters:
        entities - the entities to insert
        options - the options to apply to the insert operation
        Since:
        2.0

      • merge

        <T> T merge​(T entity)
        Work as if you did an update with each field in the entity doing a $set; Only at the top level of the entity.
        Type Parameters:
        T - the type of the entity
        Parameters:
        entity - the entity to merge back in to the database
        Returns:
        the new merged entity. NOTE: this is a database fetch.

      • merge

        <T> T merge​(T entity,
            InsertOneOptions options)
        Work as if you did an update with each field in the entity doing a $set; Only at the top level of the entity.
        Type Parameters:
        T - the type of the entity
        Parameters:
        entity - the entity to merge back in to the database
        options - the options to apply
        Returns:
        the new merged entity. NOTE: this is a database fetch.
        Since:
        2.0

      • merge

        @Deprecated(since="2.0",
            forRemoval=true)
default <T> void merge​(T entity,
                       WriteConcern wc)
        Deprecated, for removal: This API element is subject to removal in a future version.
        use merge(Object, InsertOneOptions) instead
        Work as if you did an update with each field in the entity doing a $set; Only at the top level of the entity.
        Type Parameters:
        T - the type of the entity
        Parameters:
        entity - the entity to merge back in to the database
        wc - the WriteConcern to use

      • queryByExample

        <T> Query<T> queryByExample​(T example)
        Returns a new query based on the example object
        Type Parameters:
        T - the type of the entity
        Parameters:
        example - the example entity to use when creating the query
        Returns:
        the query

      • refresh

        <T> void refresh​(T entity)
        Refreshes an existing entity to its current state in the database. Essentially, any existing mapped state is replaced by the latest persisted state while preserving the entity's reference and object identity.
        Type Parameters:
        T - the entity type
        Parameters:
        entity - the entity to refresh
        Since:
        2.0

      • replace

        default <T> T replace​(T entity)
        Replaces a document in the database
        Type Parameters:
        T - the type of the entity
        Parameters:
        entity - the entity to replace
        Returns:
        the replaced entity
        Since:
        2.3

      • replace

        <T> T replace​(T entity,
              ReplaceOptions options)
        Replaces a document in the database
        Type Parameters:
        T - the type of the entity
        Parameters:
        entity - the entity to replace
        options - the options to apply to the replace operation
        Returns:
        the replaced entity
        Since:
        2.3

      • replace

        default <T> List<T> replace​(List<T> entities)
        Replaces a list of documents in the database
        Type Parameters:
        T - the type of the entity
        Parameters:
        entities - the entities to replace
        Returns:
        the saved entities
        Since:
        2.3

      • replace

        <T> List<T> replace​(List<T> entities,
                    ReplaceOptions options)
        Replaces a list of documents in the database
        Type Parameters:
        T - the type of the entity
        Parameters:
        entities - the entities to replace
        options - the options to apply to the replace operation
        Returns:
        the saved entities
        Since:
        2.3

      • save

        @Deprecated(since="2.0",
            forRemoval=true)
default <T> List<T> save​(Iterable<T> entities)
        Deprecated, for removal: This API element is subject to removal in a future version.
        use save(List) instead
        Saves the entities (Objects) and updates the @Id field
        Type Parameters:
        T - the type of the entity
        Parameters:
        entities - the entities to save
        Returns:
        the list of updated entities

      • save

        default <T> List<T> save​(List<T> entities)
        Saves the entities (Objects) and updates the @Id field
        Type Parameters:
        T - the type of the entity
        Parameters:
        entities - the entities to save
        Returns:
        the saved entities

      • save

        <T> List<T> save​(List<T> entities,
                 InsertManyOptions options)
        Saves the entities (Objects) and updates the @Id field
        Type Parameters:
        T - the type of the entity
        Parameters:
        entities - the entities to save
        options - the options to apply to the save operation
        Returns:
        the saved entities
        Since:
        2.0

      • save

        @Deprecated(since="2.0",
            forRemoval=true)
default <T> List<T> save​(Iterable<T> entities,
                         InsertOptions options)
        Deprecated, for removal: This API element is subject to removal in a future version.
        use save(List, InsertManyOptions) instead
        Saves the entities (Objects) and updates the @Id field
        Type Parameters:
        T - the type of the entity
        Parameters:
        entities - the entities to save
        options - the options to apply to the save operation
        Returns:
        the saved entities

      • save

        default <T> T save​(T entity)
        Saves an entity (Object) and updates the @Id field
        Type Parameters:
        T - the type of the entity
        Parameters:
        entity - the entity to save
        Returns:
        the saved entity

      • save

        @Deprecated(since="2.0",
            forRemoval=true)
default <T> T save​(T entity,
                   InsertOptions options)
        Deprecated, for removal: This API element is subject to removal in a future version.
        use save(Object, InsertOneOptions) instead
        Saves an entity (Object) and updates the @Id field
        Type Parameters:
        T - the type of the entity
        Parameters:
        entity - the entity to save
        options - the options to apply to the save operation
        Returns:
        the saved entity

      • save

        <T> T save​(T entity,
           InsertOneOptions options)
        Saves an entity (Object) and updates the @Id field
        Type Parameters:
        T - the type of the entity
        Parameters:
        entity - the entity to save
        options - the options to apply to the save operation
        Returns:
        the saved entity

      • shardCollections

        @MorphiaExperimental
void shardCollections()
        Shards any collections with sharding definitions.
        Since:
        2.3
        Developer note.
        This is an experimental item. Its function and presence are subject to change. Feedback on features and usability extremely welcome.

      • startSession

        MorphiaSession startSession()
        Starts a new session on the server.
        Returns:
        the new session reference
        Since:
        2.0

      • startSession

        MorphiaSession startSession​(ClientSessionOptions options)
        Starts a new session on the server.
        Parameters:
        options - the options to apply
        Returns:
        the new session reference
        Since:
        2.0

      • update

        @Deprecated(since="2.0",
            forRemoval=true)
default <T> UpdateResult update​(Query<T> query,
                                UpdateOperations<T> operations,
                                UpdateOptions options)
        Deprecated, for removal: This API element is subject to removal in a future version.
        use Query.update(UpdateOperator, UpdateOperator...) instead
        Updates all entities found with the operations; this is an atomic operation per entity
        Type Parameters:
        T - the type of the entity
        Parameters:
        query - the query used to match the documents to update
        operations - the update operations to perform
        options - the options to apply to the update
        Returns:
        the results of the updates
        Since:
        1.3

      • update

        @Deprecated(since="2.0",
            forRemoval=true)
default <T> UpdateResult update​(Query<T> query,
                                UpdateOperations<T> operations)
        Deprecated, for removal: This API element is subject to removal in a future version.
        use Query.update(UpdateOperator, UpdateOperator...) instead. Please note the default has changed from multi- to single-document updates.
        Updates all entities found with the operations; this is an atomic operation per entity
        Type Parameters:
        T - the type of the entity
        Parameters:
        query - the query used to match the documents to update
        operations - the update operations to perform
        Returns:
        the results of the updates

      • withTransaction

        @Nullable
<T> T withTransaction​(MorphiaTransaction<T> transaction)
        Type Parameters:
        T - the return type
        Parameters:
        transaction - the transaction wrapper
        Returns:
        the return value
        Since:
        2.0

      • withTransaction

        @Nullable
<T> T withTransaction​(ClientSessionOptions options,
                      MorphiaTransaction<T> transaction)
        Type Parameters:
        T - the return type
        Parameters:
        options - the session options to apply
        transaction - the transaction wrapper
        Returns:
        the return value
        Since:
        2.0