org.springframework.data.mongodb.repository

Annotation Type Meta

@Retention(value=RUNTIME)
 @Target(value={METHOD,ANNOTATION_TYPE})
 @Documented
public @interface Meta

Since:

1.6

Author:

Christoph Strobl, Mark Paluch

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	comment Add a comment to the query.
int	cursorBatchSize Sets the number of documents to return per batch.
Meta.CursorOption[]	flags Set Meta.CursorOption to be used when executing query.
long	maxExecutionTimeMs Set the maximum time limit in milliseconds for processing operations.
long	maxScanDocuments Deprecated. since 2.2. $maxScan has been removed without replacement in MongoDB 4.2.
boolean	snapshot Using snapshot prevents the cursor from returning a document more than once.

Element Detail

maxExecutionTimeMs

public abstract long maxExecutionTimeMs

Set the maximum time limit in milliseconds for processing operations.

Returns:

-1 by default.

Since:

1.10

Default:

-1L

maxScanDocuments

@Deprecated
public abstract long maxScanDocuments

Deprecated. since 2.2. $maxScan has been removed without replacement in MongoDB 4.2.

Only scan the specified number of documents.

Returns:

Default:

-1L

cursorBatchSize

public abstract int cursorBatchSize

Sets the number of documents to return per batch.
Use 0 (zero) for no limit. A negative limit closes the cursor after returning a single batch indicating to the server that the client will not ask for a subsequent one.

Returns:

0 (zero) by default.

Since:

2.1

Default:

0

comment

public abstract String comment

Add a comment to the query.

Returns:

empty String by default.

Default:

""

snapshot

public abstract boolean snapshot

Using snapshot prevents the cursor from returning a document more than once.

Returns:

Default:

false

flags

public abstract Meta.CursorOption[] flags

Set Meta.CursorOption to be used when executing query.

Returns:

never null.

Since:

1.10

Default:

{}