Morphia

https://morphia.dev/morphia/2.5/
Admin
Morphia is a Java Object-Document Mapper (ODM) for MongoDB that provides a lightweight, type-safe...
Tokens:485,075
Snippets:6,032
Trust Score:6.5
Update:4 months ago
Show doc for...
Tokens:
Raw
### Configure ChangeStream Start After

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/aggregation/stages/ChangeStream.html

Specifies a resume token as the logical starting point for the change stream. This is similar to resumeAfter but starts after the specified token.

```java
public ChangeStream startAfter(org.bson.Document startAfter)
```

--------------------------------

### Query by Example

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/Datastore.html

Creates a new query based on an example object. This is useful for constructing queries with multiple criteria.

```java
Query<T> queryByExample(T example)
```

--------------------------------

### queryByExample

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/Datastore.html

Creates a new query based on an example object. This allows for querying documents that match the properties of the provided example.

```APIDOC
## queryByExample

### Description
Returns a new query based on the example object. This is useful for creating queries where the criteria are defined by the fields and values of an existing object.

### Method
`queryByExample(T example)`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **example** (T) - Required - An object used as a template for the query criteria.
```

--------------------------------

### queryByExample(T example)

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/Datastore.html

Returns a new query based on the provided example entity. This is useful for creating queries with criteria derived from an object's state.

```APIDOC
## queryByExample(T example)

### Description
Returns a new query based on the provided example entity. This is useful for creating queries with criteria derived from an object's state.

### Method
queryByExample

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **example** (T) - Required - the example entity to use when creating the query

### Request Example
None

### Response
#### Success Response (200)
- **Query<T>** - the query

#### Response Example
None
```

--------------------------------

### Query by Example

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/Datastore.html

Creates a new query based on an example entity. This is useful for constructing queries with criteria derived from an existing object.

```java
<T> Query<T> queryByExample(T example)
```

--------------------------------

### startSession()

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/Datastore.html

Starts a new, unconfigured session on the server.

```APIDOC
## startSession()

### Description
Starts a new session on the server.

### Method
`startSession`

### Parameters
* None

### Request Example
```json
{}
```

### Response
#### Success Response (200)
* `MorphiaSession` - the new session reference

### Response Example
```json
{
  "sessionId": "..."
}
```
```

--------------------------------

### Query by Example (Deprecated)

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/AdvancedDatastore.html

This deprecated method returns a new query based on an example object. Use newer query methods.

```java
@Deprecated(since="2.0",
            forRemoval=true)
<T> Query<T> queryByExample(String collection,
                            T example)
```

--------------------------------

### queryByExample

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/AdvancedDatastore.html

Deprecated method to query by example for a given collection and example entity. Users should use Datastore.find(Class, Object) or similar methods.

```APIDOC
## queryByExample

### Description
Deprecated method to query by example for a given collection and example entity. Users should use `Datastore.find(Class, Object)` or similar methods.

### Method
`<T> Query<T> queryByExample(String collection, T example)`

### Parameters
#### Path Parameters
- None

#### Query Parameters
- None

#### Request Body
- None

### Request Example
```
// No example provided in source
```

### Response
#### Success Response (200)
- `Query<T>` - A query object based on the example.

#### Response Example
```
// No example provided in source
```
```

--------------------------------

### Start New Morphia Session with Options

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/Datastore.html

Starts a new Morphia session on the server with specified client session options. This provides more control over session behavior.

```java
MorphiaSession startSession(com.mongodb.ClientSessionOptions options)
```

--------------------------------

### Lookup.from()

Source: https://morphia.dev/morphia/2.5/javadoc/index-all.html

Specifies the starting collection for a $lookup stage.

```APIDOC
## Lookup.from(Class<?>, String)

### Description
Specifies the starting collection for a $lookup stage.

### Method
`from(Class<?>, String)`

### Parameters
* **collectionClass** (Class<?>) - The class representing the starting collection.
* **fieldName** (String) - The field to join.
```

```APIDOC
## Lookup.from(String)

### Description
Specifies the starting collection for a $lookup stage.

### Method
`from(String)`

### Parameters
* **collectionName** (String) - The name of the starting collection.
```

--------------------------------

### Configure ChangeStream Start At Operation Time

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/aggregation/stages/ChangeStream.html

Specifies a time as the logical starting point for the change stream. The stream will begin with operations that occurred at or after this time.

```java
public ChangeStream startAtOperationTime(LocalDateTime startAtOperationTime)
```

--------------------------------

### startSession(ClientSessionOptions options)

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/Datastore.html

Starts a new session on the server with specified client session options.

```APIDOC
## startSession(ClientSessionOptions options)

### Description
Starts a new session on the server.

### Method
`startSession`

### Parameters
#### Path Parameters
* None

#### Query Parameters
* None

#### Request Body
* `options` (com.mongodb.ClientSessionOptions) - Required - the options to apply

### Request Example
```json
{
  "options": {
    "causation": "example",
    "readConcern": {"level": "majority"}
  }
}
```

### Response
#### Success Response (200)
* `MorphiaSession` - the new session reference

#### Response Example
```json
{
  "sessionId": "..."
}
```
```

--------------------------------

### applyCaps()

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/config/MorphiaConfig.html

If true, collection caps will be applied to the database at start up.

```APIDOC
## applyCaps()

### Description
If true, collection caps will be applied to the database at start up.

### Method
Boolean

### Returns
true if the caps should be applied
```

--------------------------------

### applyIndexes()

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/config/MorphiaConfig.html

If true, mapped indexes will be applied to the database at start up.

```APIDOC
## applyIndexes()

### Description
If true, mapped indexes will be applied to the database at start up.

### Method
Boolean

### Returns
true if the indexes should be applied
```

--------------------------------

### GraphLookup.from()

Source: https://morphia.dev/morphia/2.5/javadoc/index-all.html

Specifies the starting collection for a $graphLookup stage.

```APIDOC
## GraphLookup.from(Class)

### Description
Specifies the starting collection for a $graphLookup stage.

### Method
`from(Class)`

### Parameters
* **collectionClass** (Class) - The class representing the starting collection.
```

```APIDOC
## GraphLookup.from(String)

### Description
Specifies the starting collection for a $graphLookup stage.

### Method
`from(String)`

### Parameters
* **collectionName** (String) - The name of the starting collection.
```

--------------------------------

### queryByExample

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/AdvancedDatastore.html

Returns a new query based on the example object. This method is deprecated and scheduled for removal.

```APIDOC
## queryByExample

### Description
Returns a new query based on the example object.

### Method
Deprecated

### Endpoint
N/A (SDK Method)

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
N/A

### Response
#### Success Response
- **Query<T>** (Query<T>) - the query

#### Response Example
N/A
```

--------------------------------

### Get Substring by Code Points with Expression

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/aggregation/expressions/StringExpressions.html

Use substrCP() to extract a substring from a string based on code point start and length.

```java
public static Expression substrCP(Expression input, int start, int length)
```

--------------------------------

### PushOptions Creation and Configuration

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/query/class-use/PushOptions.html

Demonstrates how to create and configure PushOptions instances for use in update operations.

```APIDOC
## PushOptions

### Description
Provides options for controlling how elements are added to array fields during update operations.

### Methods

#### `static PushOptions options()`
Helper method to create a new PushOptions instance.

#### `PushOptions position(int position)`
Sets the position for the update operation.

- **position** (int) - The index at which to insert elements.

#### `PushOptions slice(int slice)`
Sets the slice value for the update operation.

- **slice** (int) - The number of elements to include from the end of the array.

#### `PushOptions sort(int sort)`
Sets the sort value for the update operation (numeric).

- **sort** (int) - The numeric value to sort by.

#### `PushOptions sort(String field, int direction)`
Sets the sort value for the update operation (field-based).

- **field** (String) - The name of the field to sort by.
- **direction** (int) - The direction of the sort (e.g., 1 for ascending, -1 for descending).
```

--------------------------------

### Get Substring by Bytes with Expression

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/aggregation/expressions/StringExpressions.html

Use substrBytes() to extract a substring from a string based on byte start and length. This is the default behavior for $substr.

```java
public static Expression substrBytes(Expression input, int start, int length)
```

--------------------------------

### Get First Entity

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/query/LegacyQuery.html

Gets the first entity in the result set. This method is deprecated.

```java
T first()
```

--------------------------------

### Get Key Method (Deprecated)

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/mapping/Mapper.html

Deprecated method to get a Key for an entity. Subject to removal.

```java
<T>
Key<T>
getKey
(T
entity)
```

--------------------------------

### Bucket Stage Creation and Configuration

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/aggregation/stages/class-use/Bucket.html

Demonstrates how to create a new Bucket stage and configure its boundaries, grouping expression, output fields, and default value.

```APIDOC
## Bucket Stage

### Description

The `Bucket` stage in Morphia is used to categorize incoming documents into groups, called buckets, based on a specified expression and bucket boundaries. It allows for flexible data aggregation by defining how documents are grouped and what information is included in the output.

### Methods

#### `static Bucket bucket()`
Creates a new bucket stage.

#### `static Bucket of()`
Deprecated. Use `bucket()` instead.

#### `Bucket groupBy(Expression groupBy)`
Specifies the expression to group documents by. This expression determines the basis for categorization.

* **Parameters**:
  * **groupBy** (Expression) - Required - The expression to group documents by.

#### `Bucket boundaries(Expression... boundaries)`
Defines an array of values based on the `groupBy` expression that specify the boundaries for each bucket. Documents falling within these boundaries are assigned to the corresponding bucket.

* **Parameters**:
  * **boundaries** (Expression...) - Required - An array of expressions defining the bucket boundaries.

#### `Bucket outputField(String name, Expression value)`
Adds a field to the output document. This field specifies the data to include in the output documents, in addition to the `_id` field.

* **Parameters**:
  * **name** (String) - Required - The name of the output field.
  * **value** (Expression) - Required - The expression defining the value of the output field.

#### `Bucket defaultValue(Object defaultValue)`
An optional field that specifies a default value for documents that do not fall into any of the defined buckets.

* **Parameters**:
  * **defaultValue** (Object) - Optional - The default value to assign.

### Usage Example

```java
import static dev.morphia.aggregation.stages.Bucket.*;
import static dev.morphia.aggregation.expressions.Expressions.*;

// Example of creating and configuring a Bucket stage
Aggregation<YourDocument>
    .group(bucket()
        .groupBy($$ウンドo("age"))
        .boundaries($$ウンドo(18, 30, 40, 50))
        .outputField("count", $sum($$ROOT))
        .defaultValue(0)
    );
```

### Related Methods

#### `Aggregation<T> bucket(Bucket bucket)`
This method is used within the `Aggregation` class to apply the configured `Bucket` stage to an aggregation pipeline.
```

--------------------------------

### Create Morphia Datastore and Map Entities

Source: https://morphia.dev/morphia/2.5/quicktour.html

This snippet demonstrates the initial setup of Morphia by creating a Datastore instance connected to a local MongoDB instance and configuring Morphia to map entities from a specified package. Use this to begin your Morphia application.

```java
final Datastore datastore = Morphia.createDatastore(MongoClients.create());
// tell Morphia where to find your classes
// can be called multiple times with different packages or classes
datastore.getMapper().mapPackage("dev.morphia.example");

datastore.ensureIndexes();

```

--------------------------------

### ArrayIndexExpression start Method

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/aggregation/expressions/impls/ArrayIndexExpression.html

Sets the starting index for array slicing. Returns the ArrayIndexExpression instance for chaining.

```java
public
ArrayIndexExpression start(Integer start)
```

--------------------------------

### Start Morphia Session

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/Datastore.html

Starts a new session on the MongoDB server. Sessions can be used for transactions and other advanced operations.

```java
MorphiaSession startSession()
```

```java
MorphiaSession startSession(com.mongodb.ClientSessionOptions options)
```

--------------------------------

### Get First Entity with Options

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/query/LegacyQuery.html

Gets the first entity in the result set using specified options. This method is deprecated.

```java
T first(FindOptions options)
```

--------------------------------

### PushOptions.options()

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/query/PushOptions.html

A static helper method to create a new PushOptions instance.

```APIDOC
## options()

### Description
Helper method to create a PushOptions instance.

### Method
`static PushOptions options()`

### Returns
The new PushOptions instance.
```

--------------------------------

### load()

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/config/MorphiaConfig.html

Tries to load a configuration from the default location.

```APIDOC
## load()

### Description
Tries to load a configuration from the default location.

### Method
static MorphiaConfig

### Returns
the loaded config
```

--------------------------------

### Start New Morphia Session

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/Datastore.html

Starts a new Morphia session on the server. This is useful for managing operations within a session context.

```java
MorphiaSession startSession()
```

--------------------------------

### Get Key with Collection Method (Deprecated)

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/mapping/Mapper.html

Deprecated method to get a Key for an entity within a specific collection. Subject to removal.

```java
<T>
Key<T>
getKey
(T
entity,
       String
collection)
```

--------------------------------

### Create a Sample Stage

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/aggregation/stages/Sample.html

Creates a new Sample stage with the specified number of documents to sample. Use this method for creating new sample stages.

```java
public static Sample sample(long size)
```

--------------------------------

### Get First Entity with Options (Deprecated)

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/query/Query.html

Deprecated method to get the first entity with options. Use `Datastore.find(Class, FindOptions)` instead.

```java
@Nullable
@Deprecated(since="2.5",
            forRemoval=true)
T first(FindOptions options)
```

--------------------------------

### DatastoreImpl.DatastoreOperations Constructor

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/DatastoreImpl.DatastoreOperations.html

Initializes a new instance of the DatastoreImpl.DatastoreOperations class.

```java
public DatastoreOperations()
```

--------------------------------

### PreLoad with Document and Datastore Parameters

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/annotations/PreLoad.html

Example of using @PreLoad with both Document and Datastore parameters. This allows modifications to the Document and access to the Datastore for potential additional operations.

```java
@PreLoad
 private void performAdditionalQueriesBeforeLoading(Document doc, Datastore datastore) {
   // doc is the Document we will be loaded from. datastore is the datastore the Document originated from.
 }
```

--------------------------------

### Create Datastore with Database Name and Mapper Options

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/Morphia.html

Creates a Datastore using the provided database name and custom MapperOptions.

```java
public static Datastore createDatastore(String dbName,
                                        MapperOptions options)
```

--------------------------------

### Set Starting Point for Recursive Search

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/aggregation/stages/GraphLookup.html

Specifies an expression that defines the starting value for the `connectFromField` when initiating the recursive search. This allows control over where the graph traversal begins.

```java
public GraphLookup startWith(Expression startWith)
```

--------------------------------

### load()

Source: https://morphia.dev/morphia/2.5/javadoc/index-all.html

Tries to load a configuration from the default location. This is a static method in dev.morphia.config.MorphiaConfig.

```APIDOC
## load()

### Description
Tries to load a configuration from the default location.

### Method
Static method

### Interface
dev.morphia.config.MorphiaConfig
```

--------------------------------

### Create a New Projection Stage

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/aggregation/stages/Projection.html

Use this static method to create a new Projection stage instance. This is the recommended way to start building a projection.

```java
public static Projection project()
```

--------------------------------

### Manual Transaction Management with MorphiaSession

Source: https://morphia.dev/morphia/2.5/transactions.html

Manually manage transaction boundaries by starting a session, starting the transaction, performing operations, committing, and closing the session. This approach offers more control over the transaction lifecycle.

```java
MorphiaSession session = datastore.startSession();
session.startTransaction();
User user = new User("jimbo", "jimhalpert@dundermifflin.com");
user.setHomeAddress(new Address("123 Paper Lane", "Scranton", "PA", "18510"));
session.save(user);
session.commitTransaction();
session.close();
```

--------------------------------

### getProjection()

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/query/FindOptions.html

Gets the projection. This method is internal.

```APIDOC
## getProjection()

### Description
Returns the projection.

### Returns
the projection

Developer note.
This is an internal item. Its function and presence are subject to change without warning. Its use is highly discouraged.
```

--------------------------------

### Create PushOptions Instance

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/query/PushOptions.html

A helper method to create a new instance of PushOptions.

```java
public static PushOptions options()
```

--------------------------------

### getLimit()

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/query/FindOptions.html

Deprecated method to get the limit.

```APIDOC
## getLimit()

### Description
Deprecated, for removal: This API element is subject to removal in a future version.
Returns the limit.

### Returns
the limit
```

--------------------------------

### Create Datastore with MongoClient and MorphiaConfig

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/Morphia.html

Creates a Datastore configured via a config file using the provided MongoClient and MorphiaConfig.

```java
public static Datastore createDatastore(com.mongodb.client.MongoClient mongoClient,
                                        MorphiaConfig config)
```

--------------------------------

### Create FindOptions from Original

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/query/FindOptions.html

Creates a new FindOptions instance by copying the settings from another.

```java
@MorphiaInternal
public FindOptions copy(FindOptions original)
```

--------------------------------

### getComment()

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/query/FindOptions.html

Deprecated method to get the comment.

```APIDOC
## getComment()

### Description
Deprecated, for removal: This API element is subject to removal in a future version.
Returns the comment.

### Returns
the comment
```

--------------------------------

### getCollation()

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/query/FindOptions.html

Deprecated method to get the collation.

```APIDOC
## getCollation()

### Description
Deprecated, for removal: This API element is subject to removal in a future version.
Returns the collation.

### Returns
the collation
```

--------------------------------

### load(String path)

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/config/MorphiaConfig.html

Parses and loads the configuration found at the given location.

```APIDOC
## load(String path)

### Description
Parses and loads the configuration found at the given location.

### Method
static MorphiaConfig

### Parameters
#### Path Parameters
- **path** (String) - the location of the configuration to load. This can be a file path, a classpath resource, a URL, etc.

### Returns
the loaded configuration

### Since
3.0
```

--------------------------------

### execute

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/aggregation/AggregationImpl.html

Execute the aggregation and get the results.

```APIDOC
## execute

### Description
Execute the aggregation and get the results.

### Method
public <R> dev.morphia.query.internal.MorphiaCursor<R> execute(Class<R> resultType)

### Parameters
#### Path Parameters
- **resultType** (Class<R>) - Required - the type of the result

### Returns
a MorphiaCursor
```

```APIDOC
## execute

### Description
Execute the aggregation and get the results.

### Method
public <R> dev.morphia.query.internal.MorphiaCursor<R> execute(Class<R> resultType, AggregationOptions options)

### Parameters
#### Path Parameters
- **resultType** (Class<R>) - Required - the type of the result
- **options** (AggregationOptions) - Required - the options to apply

### Returns
a MorphiaCursor
```

--------------------------------

### Sample Stage Creation

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/aggregation/stages/Sample.html

Demonstrates how to create a Sample stage to randomly select a specified number of documents. The `sample(long size)` method is the recommended way to create this stage.

```APIDOC
## sample(long size)

### Description
Creates a new stage with the given sample size.

### Method
`public static Sample sample(long size)`

### Parameters
#### Path Parameters
- **size** (long) - The sample size.

### Returns
- **Sample** - The new stage instance.
```

--------------------------------

### Create Datastore with MongoClient, Database Name, and Mapper Options

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/Morphia.html

Creates a Datastore using a MongoClient, database name, and custom MapperOptions. It is recommended to use a singleton MongoClient instance.

```java
public static Datastore createDatastore(com.mongodb.client.MongoClient mongoClient,
                                        String dbName,
                                        MapperOptions options)
```

--------------------------------

### String Comparison: startsWith

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/query/FieldEndImpl.html

Checks that a string field begins with a specified prefix. This comparison is case-sensitive.

```java
public
T startsWith
(String prefix)
```

--------------------------------

### readPreference

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/query/FindOptions.html

Gets the read preference for the find operation.

```APIDOC
## readPreference

### Description
Gets the read preference for the find operation.

### Method
public com.mongodb.ReadPreference readPreference()

### Returns
the read preference
```

--------------------------------

### readConcern

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/query/FindOptions.html

Gets the read concern for the find operation.

```APIDOC
## readConcern

### Description
Gets the read concern for the find operation.

### Method
public com.mongodb.ReadConcern readConcern()

### Returns
the read concern
```

--------------------------------

### getSkip()

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/query/FindOptions.html

Deprecated method to get the skip count.

```APIDOC
## getSkip()

### Description
Deprecated, for removal: This API element is subject to removal in a future version.
Returns the skip count.

### Returns
the skip count
```

--------------------------------

### Tailable Cursor Example

Source: https://morphia.dev/morphia/2.5/queries.html

Demonstrates how to create and iterate over a tailable cursor for capped collections. The `hasNext()` and `next()` methods will block until new documents matching the query are found.

```java
datastore.getMapper().map(CappedPic.class);
getDs().ensureCaps();                                                          
final Query<CappedPic> query = getDs().find(CappedPic.class,
    new FindOptions()
            .cursorType(CursorType.Tailable));
final List<CappedPic> found = new ArrayList<>();

final MorphiaCursor<CappedPic> tail =
    query.iterator();
while(found.size() < 10) {
	found.add(tail.next());                                                    
}
```

--------------------------------

### getMin()

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/query/FindOptions.html

Deprecated method to get the min value.

```APIDOC
## getMin()

### Description
Deprecated, for removal: This API element is subject to removal in a future version.
Returns the min value.

### Returns
the min value
```

--------------------------------

### startAfter

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/aggregation/stages/ChangeStream.html

Specifies a resume token as the logical starting point for the change stream. This method cannot be used with resumeAfter or startAtOperationTime fields.

```APIDOC
## startAfter

### Description
Specifies a resume token as the logical starting point for the change stream. Cannot be used with resumeAfter or startAtOperationTime fields.

### Method
public ChangeStream startAfter(org.bson.Document startAfter)

### Parameters
#### Path Parameters
- **startAfter** (org.bson.Document) - Required - the token to start after
```

--------------------------------

### getMax()

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/query/FindOptions.html

Deprecated method to get the max value.

```APIDOC
## getMax()

### Description
Deprecated, for removal: This API element is subject to removal in a future version.
Returns the max value.

### Returns
the max value
```

--------------------------------

### Exporting Services with Java Modules

Source: https://morphia.dev/morphia/2.5/configuration.html

Demonstrates how to export a custom service provider for Morphia using Java modules.

```java
provides dev.morphia.mapping.codec.MorphiaPropertyCodecProvider with com.foo.MyCodecProvider;
```

--------------------------------

### Create InsertOneOptions from Existing

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/InsertOneOptions.html

Creates a new options wrapper by copying settings from an existing InsertOneOptions object. Useful for modifying existing configurations.

```java
@MorphiaInternal
public
InsertOneOptions(InsertOneOptions that)
```

--------------------------------

### getHint()

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/query/FindOptions.html

Deprecated method to get the index hint.

```APIDOC
## getHint()

### Description
Deprecated, for removal: This API element is subject to removal in a future version.
Returns the index hint.

### Returns
the index hint
```

--------------------------------

### getCursorType()

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/query/FindOptions.html

Deprecated method to get the cursor type.

```APIDOC
## getCursorType()

### Description
Deprecated, for removal: This API element is subject to removal in a future version.
Returns the cursor type.

### Returns
the cursor type
```

--------------------------------

### Create Datastore with MongoClient

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/Morphia.html

Creates a Datastore configured via a config file using the provided MongoClient. If no config file exists, defaults from MorphiaConfig will be applied.

```java
public static Datastore createDatastore(com.mongodb.client.MongoClient mongoClient)
```

--------------------------------

### Create Datastore with MongoClient and ClassLoader

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/Morphia.html

Creates a Datastore configured via a config file using the provided MongoClient and ClassLoader for resource and class resolution.

```java
public static Datastore createDatastore(com.mongodb.client.MongoClient mongoClient,
                                        ClassLoader classLoader)
```

--------------------------------

### getBatchSize()

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/query/FindOptions.html

Deprecated method to get the batch size.

```APIDOC
## getBatchSize()

### Description
Deprecated, for removal: This API element is subject to removal in a future version.
Returns the batch size.

### Returns
the batch size
```

--------------------------------

### Get Nested Group

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/aggregation/Group.html

Retrieves the nested group, if any.

```java
@Nullable
public Group getNested()
```

--------------------------------

### Explain Query Plan with Options and Verbosity

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/query/LegacyQuery.html

Provides information on the query plan with specified options and verbosity. This method is deprecated.

```java
Map<String, Object> explain(FindOptions options,
        com.mongodb.ExplainVerbosity verbosity)
```

--------------------------------

### Get Group Name

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/aggregation/Group.html

Retrieves the name of the group.

```java
public String getName()
```

--------------------------------

### Using Meta with Projection and FindOptions

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/query/class-use/Meta.html

Demonstrates how Meta objects are used with Projection and FindOptions to add metadata fields to projections and define sorting criteria.

```APIDOC
## Using Meta with Projection and FindOptions

### Description
Illustrates the usage of Meta objects within Morphia's query building process, specifically for projections and sorting.

### Methods

#### `Projection.project(Meta meta)`
Adds a metadata field defined by a Meta object to a projection.

#### `FindOptions.sort(Meta meta)`
Sets the sorting criteria for a query using a Meta object.

#### `FindOptions.sort(Meta meta, Sort... sorts)`
Sets the sorting criteria for a query using a Meta object and additional sort orders.
```

--------------------------------

### writeConcern()

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/ModifyOptions.html

Sets or gets the write concern for the operation.

```APIDOC
## writeConcern(WriteConcern writeConcern)

### Description
Set the write concern to use.

### Method
`public ModifyOptions writeConcern(com.mongodb.WriteConcern writeConcern)`

### Returns
this

### See Also
`dev.morphia.internal.WriteConfigurable<ModifyOptions>`
```

```APIDOC
## writeConcern()

### Description
The write concern to use.

### Method
`public com.mongodb.WriteConcern writeConcern()`

### Returns
The write concern

### See Also
`dev.morphia.internal.WriteConfigurable<ModifyOptions>`
```

--------------------------------

### Legacy Configuration

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/config/MorphiaConfig.html

Creates a new configuration instance updated to reflect legacy settings.

```java
default MorphiaConfig
legacy()
Creates a new configuration based on the current one but updated to reflect the legacy configuration.
```

--------------------------------

### startSession

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/Datastore.html

Starts a new session on the server. Sessions can be used for managing transactions and maintaining context across operations. Options for session configuration are available.

```APIDOC
## startSession

### Description
Starts a new session on the server. This allows for managing client-side state and can be used for operations like transactions. Sessions can be started with default or custom client session options.

### Method
`startSession()`
`startSession(ClientSessionOptions options)`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **options** (ClientSessionOptions) - Optional - Options for configuring the new session.
```

--------------------------------

### Explain Query Plan with Options

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/query/Query.html

Provides information on the query plan with specified options. This method is deprecated and users should use Datastore.find(Class, FindOptions) instead.

```java
@Deprecated(since="2.5",
            forRemoval=true)
default Map<String, Object> explain(FindOptions options)
```

--------------------------------

### IndexExpression.start

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/aggregation/expressions/impls/class-use/IndexExpression.html

Sets the start boundary for searching within an IndexExpression.

```APIDOC
## IndexExpression.start

### Description
Sets the start boundary for searching.

### Method
instance

### Signature
IndexExpression.start(int start)

### Parameters
#### Path Parameters
- **start** (int) - Description: The start boundary for the search.
```

--------------------------------

### Get Projection

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/query/FindOptions.html

Retrieves the projection configuration for find operations.

```java
public Projection projection()
```

--------------------------------

### load(String path, ClassLoader classLoader)

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/config/MorphiaConfig.html

Parses and loads the configuration found at the given location.

```APIDOC
## load(String path, ClassLoader classLoader)

### Description
Parses and loads the configuration found at the given location.

### Method
static MorphiaConfig

### Parameters
#### Path Parameters
- **path** (String) - the location of the configuration to load. This can be a file path, a classpath resource, a URL, etc.
- **classLoader** (ClassLoader) - the classloader to use when loading resources from the classpath

### Returns
the loaded configuration

### Since
3.0
```

--------------------------------

### cursorType()

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/query/FindOptions.html

Gets the cursor type. This method is internal and deprecated.

```APIDOC
## cursorType()

### Description
Returns the cursor type.

### Returns
the cursor type

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.
```

--------------------------------

### Query.explain with FindOptions

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/query/class-use/FindOptions.html

Provides an explanation of the query execution plan with specified FindOptions. Deprecated.

```APIDOC
## Query.explain

### Description
Provides an explanation of the query execution plan with specified FindOptions. Deprecated, for removal: This API element is subject to removal in a future version. use `Datastore.find(Class, FindOptions)` instead.

### Method
`default Map<String, Object> explain(FindOptions options)`

### Parameters
* **options** (FindOptions) - The options for the query explanation.
```

--------------------------------

### Get Sort

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/query/FindOptions.html

Retrieves the sort order for the query results.

```java
@Nullable
```

--------------------------------

### Get Longitude

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/geo/Point.html

Retrieves the longitude of the Point. This method is deprecated.

```java
public double getLongitude()
```

--------------------------------

### Executing Aggregations with AggregationOptions

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/aggregation/class-use/AggregationOptions.html

Demonstrates how to execute aggregation queries using AggregationOptions.

```APIDOC
## Aggregation Execution with Options

### Description
Methods for executing aggregation pipelines with custom options.

### Methods

- **execute(Class<S> resultType, AggregationOptions options)**: Execute the aggregation and get the results. (Applies to `dev.morphia.query.internal.MorphiaCursor<S>`)
- **execute(Class<R> resultType, AggregationOptions options)**: (Applies to `AggregationImpl`)
- **merge(Merge<M> merge, AggregationOptions options)**: Writes the results of the aggregation pipeline to a specified collection.
- **merge(Merge<M> merge, AggregationOptions options)**: (Applies to `AggregationImpl`)
- **out(Out<O> out, AggregationOptions options)**: Writes the results of the aggregation pipeline to a specified collection.
- **out(Out<O> out, AggregationOptions options)**: (Applies to `AggregationImpl`)
```

--------------------------------

### Get Latitude

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/geo/Point.html

Retrieves the latitude of the Point. This method is deprecated.

```java
public double getLatitude()
```

--------------------------------

### PrePersist Method With Datastore Parameter

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/annotations/PrePersist.html

An example of a method annotated with @PrePersist that can optionally accept a Datastore parameter to query or modify data before persistence.

```java
@PrePersist
 void retrieveOtherInfoBeforeSaving(Datastore datastore) {
   // query datastore as needed
 }
```

--------------------------------

### Create Query with Type and FindOptions

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/query/QueryFactory.html

Creates a new query for a given type and specifies find options. This is a common way to start building a query.

```java
default <T> Query<T> createQuery(
                                 Datastore datastore,
                                 Class<T> type,
                                 FindOptions options)
```

--------------------------------

### Get Accumulator for Group

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/aggregation/Group.html

Retrieves the accumulator associated with this Group.

```java
@Nullable
public Accumulator getAccumulator()
```

--------------------------------

### collection()

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/ModifyOptions.html

Sets or gets the alternate collection to use for the operation.

```APIDOC
## collection(String collection)

### Description
Sets the alternate collection to use for the operation.

### Method
`public ModifyOptions collection(String collection)`

### Parameters
* **collection** (String) - the name of the collection to use

### Returns
this

### See Also
`dev.morphia.internal.CollectionConfigurable<ModifyOptions>`
```

```APIDOC
## collection()

### Description
Returns the alternate collection to use for the operation. Might return null.

### Method
`public String collection()`

### Returns
the collection name or null

### See Also
`dev.morphia.internal.CollectionConfigurable<ModifyOptions>`
```

--------------------------------

### Create a Sample Stage (Deprecated)

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/aggregation/stages/Sample.html

Deprecated method for creating a Sample stage. Use `sample(long)` instead. This method is subject to removal in future versions.

```java
@Deprecated(forRemoval=true)
public static Sample of(long size)
```

--------------------------------

### Explain Query Plan (Default Verbosity)

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/query/LegacyQuery.html

Provides information about the query plan used by the server to find matches. This is useful for query optimization. This method is deprecated.

```java
public Map<String, Object> explain()
```

--------------------------------

### Get Accumulator Operation

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/aggregation/Accumulator.html

Retrieves the operation name for this accumulator.

```java
public	String	getOperation()

```

--------------------------------

### SliceExpression.position()

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/aggregation/expressions/impls/SliceExpression.html

Sets the starting position for the slice operation. This method is chainable.

```APIDOC
## SliceExpression.position()

### Description
Sets the starting position for the slice operation. This method is chainable.

### Signature
```java
public SliceExpression position(Integer position)
```

### Parameters
* **position** (Integer) - The starting position for the slice.
```

--------------------------------

### Enable Disk Use

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/query/FindOptions.html

Enables writing to temporary files on the server. Use this when dealing with large datasets that might exceed memory limits.

```java
FindOptions options = new FindOptions();
options.allowDiskUse(true);
```

--------------------------------

### getQueryLogId()

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/query/FindOptions.html

Deprecated internal method to get the query log ID.

```APIDOC
## getQueryLogId()

### Description
Deprecated, for removal: This API element is subject to removal in a future version.
Returns the query log id used for retrieving the logged query.

### Returns
the query log id used for retrieving the logged query

Developer note.
This is an internal item. Its function and presence are subject to change without warning. Its use is highly discouraged.
```

--------------------------------

### Query.explain with FindOptions and ExplainVerbosity

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/query/class-use/FindOptions.html

Provides an explanation of the query execution plan with specified FindOptions and verbosity level. Deprecated.

```APIDOC
## Query.explain

### Description
Provides an explanation of the query execution plan with specified FindOptions and verbosity level. Deprecated, for removal: This API element is subject to removal in a future version. use `Datastore.find(Class, FindOptions)` instead.

### Method
`Map<String, Object> explain(FindOptions options, com.mongodb.ExplainVerbosity verbosity)`

### Parameters
* **options** (FindOptions) - The options for the query explanation.
* **verbosity** (com.mongodb.ExplainVerbosity) - The verbosity level for the explanation.
```

--------------------------------

### resumeAfter

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/aggregation/stages/ChangeStream.html

Specifies a resume token as the logical starting point for the change stream. This method cannot be used with startAfter or startAtOperationTime fields.

```APIDOC
## resumeAfter

### Description
Specifies a resume token as the logical starting point for the change stream. Cannot be used with startAfter or startAtOperationTime fields.

### Method
public ChangeStream resumeAfter(org.bson.Document resumeAfter)

### Parameters
#### Path Parameters
- **resumeAfter** (org.bson.Document) - Required - the token to resume after
```

--------------------------------

### Get Projection

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/query/FindOptions.html

Retrieves the projection settings for the query. This method is internal.

```java
@Nullable
@MorphiaInternal
public Projection getProjection()
```

--------------------------------

### Create a new Bucket stage

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/aggregation/stages/Bucket.html

Use this static factory method to create a new instance of the Bucket stage. This is the recommended way to start building a bucket aggregation.

```java
public static Bucket bucket()
```

--------------------------------

### Get Limit

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/query/FindOptions.html

Retrieves the limit for the number of results. This method is deprecated.

```java
@Deprecated(forRemoval=true,
            since="2.3")
public int getLimit()
```

--------------------------------

### Get Hint

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/query/FindOptions.html

Retrieves the index hint for the query. This method is deprecated.

```java
@Nullable
@Deprecated(forRemoval=true,
            since="2.3")
public org.bson.Document getHint()
```

--------------------------------

### CurrentOp Stage Creation

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/aggregation/stages/CurrentOp.html

Demonstrates how to create a new CurrentOp stage using the static factory method.

```APIDOC
## currentOp()

### Description
Creates a new CurrentOp stage.

### Method
`static CurrentOp`

### Endpoint
N/A (SDK method)

### Parameters
None

### Response
- `CurrentOp`: The newly created CurrentOp stage instance.
```

--------------------------------

### Get Comment

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/query/FindOptions.html

Retrieves the comment associated with the query. This method is deprecated.

```java
@Nullable
@Deprecated(forRemoval=true,
            since="2.3")
public String getComment()
```

--------------------------------

### Paginate Query Results (Skip and Limit)

Source: https://morphia.dev/morphia/2.5/queries.html

Implement pagination by skipping a specified number of results and limiting the number of items returned. This example skips the first result and limits to the next 10.

```java
datastore.find(Person.class, new FindOptions()
	    .skip(1)
	    .limit(10))
```

--------------------------------

### Get Collation

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/query/FindOptions.html

Retrieves the collation settings for the query. This method is deprecated.

```java
@Nullable
@Deprecated(forRemoval=true,
            since="2.3")
public com.mongodb.client.model.Collation getCollation()
```

--------------------------------

### Configure ChangeStream Resume After

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/aggregation/stages/ChangeStream.html

Specifies a resume token as the logical starting point for the change stream. This allows the stream to be resumed from a specific point.

```java
public ChangeStream resumeAfter(org.bson.Document resumeAfter)
```

--------------------------------

### Get Datastore

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/query/LegacyQuery.html

Returns the Datastore associated with this query. This method is deprecated.

```java
protected Datastore getDatastore()
```

--------------------------------

### Create a Match Stage with Filters

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/aggregation/stages/Match.html

Use the static `match` method to create a new Match stage, specifying the filters to apply. This is the recommended way to create a Match stage.

```java
public static Match match(Filter... filters)
```

--------------------------------

### Get All Mapped Entities

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/mapping/Mapper.html

Returns a collection of all mapped entity models.

```java
public List<dev.morphia.mapping.codec.pojo.EntityModel> getMappedEntities()
```

--------------------------------

### Get Discriminator Lookup

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/mapping/Mapper.html

Retrieves the DiscriminatorLookup instance used by the mapper.

```java
public DiscriminatorLookup getDiscriminatorLookup()
```

--------------------------------

### Create a SetWindowFields Stage

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/aggregation/stages/SetWindowFields.html

Use this static factory method to create a new instance of the SetWindowFields stage. This is the entry point for configuring window operations.

```java
public static SetWindowFields setWindowFields()
```

--------------------------------

### Create Datastore with MongoClient and Database Name

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/Morphia.html

Creates a Datastore using a MongoClient and database name. It is recommended to use a singleton MongoClient instance.

```java
public static Datastore createDatastore(com.mongodb.client.MongoClient mongoClient,
                                        String dbName)
```

--------------------------------

### Date Storage Configuration

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/mapping/MapperOptions.html

Gets the configuration value for how dates are stored.

```java
public DateStorage getDateStorage()

```

--------------------------------

### PushOptions Constructor

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/query/PushOptions.html

Creates an empty options class for $push updates.

```APIDOC
## PushOptions()

### Description
Creates an empty options class.

### Constructor
`PushOptions()`
```

--------------------------------

### collection Method (Get)

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/UpdateOptions.html

Returns the alternate collection to use for the operation.

```APIDOC
## collection()

### Description
Returns the alternate collection to use for the operation. Might return null.

### Method
`collection`

### Returns
- String: the collection name or null
```

--------------------------------

### Datastore

Source: https://morphia.dev/morphia/2.5/javadoc/allclasses-index.html

Interface for datastore operations like get, delete, and save.

```APIDOC
## Datastore

### Description
Datastore interface to get/delete/save objects
```

--------------------------------

### Meta Instance Methods

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/query/Meta.html

Instance methods available on Meta objects.

```APIDOC
## Method String getField()

### Description
Returns the field name associated with the meta object.

### Returns
metadata object field name
```

--------------------------------

### RangeExpression Constructor

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/aggregation/expressions/impls/RangeExpression.html

Constructs a new RangeExpression with a specified start and end value.

```APIDOC
## RangeExpression(start, end)

### Description
Constructs a new RangeExpression with the given start and end integers.

### Parameters
#### Path Parameters
* **start** (int) - The starting value of the range.
* **end** (int) - The ending value of the range.
```

--------------------------------

### Facet Stage Creation and Configuration

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/aggregation/stages/Facet.html

Demonstrates how to create a new Facet stage and add fields with their respective aggregation pipelines.

```APIDOC
## Facet Stage

### Description
Processes multiple aggregation pipelines within a single stage on the same set of input documents. Each sub-pipeline has its own field in the output document where its results are stored as an array of documents. The $facet stage allows you to create multi-faceted aggregations which characterize data across multiple dimensions, or facets, within a single aggregation stage.

### Methods

#### `static Facet facet()`
Creates a new facet stage.

- **Returns**: The new stage.
- **Since**: 2.2

#### `Facet field(String name, Stage... stages)`
Adds a field to the facet.

- **Parameters**:
  - `name` (String) - The field name.
  - `stages` (Stage...) - The pipeline defining the field.
- **Returns**: This Facet instance for chaining.

#### `static Facet of()`
Deprecated, for removal: This API element is subject to removal in a future version. use `facet()`
Creates a new facet stage.

- **Returns**: The new stage.
```

--------------------------------

### ReplaceRoot Stage Creation

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/aggregation/stages/class-use/ReplaceRoot.html

Demonstrates how to create a new ReplaceRoot stage using static factory methods.

```APIDOC
## ReplaceRoot

### Description
Creates a new ReplaceRoot stage.

### Method
`static ReplaceRoot`

### Usage
```java
// Creates a new stage to replace the root with the given expression.
ReplaceRoot.replaceRoot(expression);

// Creates a new stage to replace the root.
ReplaceRoot.replaceRoot();
```

### Parameters
* `expression` (Expression) - The expression to replace the root with.
```

--------------------------------

### DateDiffExpression.startOfWeek

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/aggregation/expressions/impls/DateDiffExpression.html

Sets the start of the week for calculations when the unit is 'week'. Defaults to Sunday.

```APIDOC
## startOfWeek(startOfWeek)

### Description
Sets the start of the week for calculations when the unit is 'week'. Defaults to Sunday.

### Parameters
#### Path Parameters
- **startOfWeek** (DayOfWeek) - The day of the week to be considered the start of the week.

### Returns
- DateDiffExpression - Returns the current DateDiffExpression instance for chaining.
```

--------------------------------

### Sample Stage Constructor

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/aggregation/stages/Sample.html

Protected constructor for creating a Sample stage instance. Typically used internally by Morphia.

```java
protected Sample(long size)
```

--------------------------------

### startOfWeek Method

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/aggregation/expressions/impls/DateTruncExpression.html

Sets the starting day of the week for truncation when the unit is 'week'.

```APIDOC
## startOfWeek(startOfWeek)

### Description
Specifies the starting day of the week. This is used when the truncation unit is 'week'. Defaults to Sunday.

### Parameters
* **startOfWeek** (DayOfWeek) - The day of the week to consider as the start.

### Returns
this (DateTruncExpression)
```

--------------------------------

### createDatastore(String dbName, MapperOptions options)

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/Morphia.html

Creates a Datastore with the specified database name and mapping options.

```APIDOC
## createDatastore(String dbName, MapperOptions options)

### Description
Creates a Datastore.

### Method
static Datastore

### Parameters
#### Path Parameters
- **dbName** (String) - the name of the database
- **options** (MapperOptions) - the mapping options to use.

### Returns
a Datastore that you can use to interact with MongoDB
```

--------------------------------

### unset

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/aggregation/AggregationImpl.html

Removes or excludes fields from documents. Field names must not start with '$'.

```APIDOC
## unset

### Description
Removes/excludes fields from documents. Names must not start with '$'.

### Method Signature
```java
public Aggregation<T> unset(Unset unset)
```

### Parameters
* `unset` (Unset) - The unset definition.

### Returns
* `this` (Aggregation<T>) - The current Aggregation instance for chaining.
```

--------------------------------

### createDatastore(MongoClient mongoClient, String dbName, MapperOptions options)

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/Morphia.html

Creates a Datastore using the provided MongoClient, database name, and mapping options. It is recommended to use a singleton MongoClient instance.

```APIDOC
## createDatastore(MongoClient mongoClient, String dbName, MapperOptions options)

### Description
It is best to use a Mongo singleton instance here.

### Method
static Datastore

### Parameters
#### Path Parameters
- **mongoClient** (MongoClient) - the client to use
- **dbName** (String) - the name of the database
- **options** (MapperOptions) - the mapping options to use.

### Returns
a Datastore that you can use to interact with MongoDB
```

--------------------------------

### sort (deprecated)

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/query/FindOptions.html

Gets the sort criteria. This method is deprecated and subject to removal.

```APIDOC
## sort (deprecated)

### Description
Gets the sort criteria. This method is deprecated and subject to removal.

### Method
public org.bson.Document sort()

### Returns
the sort criteria
```

--------------------------------

### getMaxTime(TimeUnit timeUnit)

Source: https://morphia.dev/morphia/2.5/javadoc/dev/morphia/query/FindOptions.html

Deprecated method to get the max time for the operation.

```APIDOC
## getMaxTime(TimeUnit timeUnit)

### Description
Deprecated, for removal: This API element is subject to removal in a future version.
Returns the max time for the operation.

### Parameters
#### Path Parameters
* `timeUnit` (TimeUnit) - the time unit to apply

### Returns
the max time for the operation
```

--------------------------------

### Datastore Methods

Source: https://morphia.dev/morphia/2.5/javadoc/index-all.html

Core methods for interacting with the Datastore.

```APIDOC
## createQuery(Class<T>)

### Description
Deprecated, for removal: This API element is subject to removal in a future version. use `Datastore.find(Class)`

### Method
Method

### Endpoint
N/A

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
N/A

### Response
#### Success Response (200)
N/A

#### Response Example
N/A
```

```APIDOC
## createUpdateOperations(Class<T>)

### Description
Deprecated, for removal: This API element is subject to removal in a future version. use `Query.update(UpdateOperator, UpdateOperator...)` instead

### Method
Method

### Endpoint
N/A

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
N/A

### Response
#### Success Response (200)
N/A

#### Response Example
N/A
```
Tokens:
Raw