Package com.datastax.astra.client.model

Class FindOptions

java.lang.Object

com.datastax.astra.client.model.FindOptions

public class FindOptions
extends Object

List Options for a FindOne command.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FindOptions.Builder	Builder for creating FindOneAndUpdateOptions instances with a fluent API.

Constructor Summary

Constructors

Constructor	Description
FindOptions()	Default constructor.

Method Summary

Modifier and Type	Method	Description
FindOptions	includeSimilarity()	Fluent api.
FindOptions	limit(int limit)	Add a limit clause in the find block
FindOptions	pageState(String pageState)	Update page state
FindOptions	projection(Projection... projection)	Syntax sugar as delete option is only a sort
FindOptions	skip(int skip)	Add a skip clause in the find block
FindOptions	sort(float[] vector, Sort... sorts)	Add a criteria with $vector in the sort clause
FindOptions	sort(Sort... sort)	Syntax sugar as delete option is only a sort
FindOptions	sort(String vectorize, Sort... sorts)	Add a criteria with $vectorize in the sort clause.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

FindOptions

public FindOptions()

Default constructor.

Method Details

sort

public FindOptions sort(Sort... sort)

Syntax sugar as delete option is only a sort

Parameters:

sort - add a filter

Returns:

current command.

sort

public FindOptions sort(String vectorize,
 Sort... sorts)

Add a criteria with $vectorize in the sort clause.

Note : This feature is under current development.

Parameters:

vectorize - an expression to look for vectorization

sorts - The sort criteria to be applied to the findOne operation.

Returns:

current command

sort

public FindOptions sort(float[] vector,
 Sort... sorts)

Add a criteria with $vector in the sort clause

Parameters:

vector - vector float

sorts - The sort criteria to be applied to the findOne operation.

Returns:

current command

projection

public FindOptions projection(Projection... projection)

Syntax sugar as delete option is only a sort

Parameters:

projection - add a filter

Returns:

current command.

includeSimilarity

public FindOptions includeSimilarity()

Fluent api.

Returns:

add a filter

pageState

public FindOptions pageState(String pageState)

Update page state

Parameters:

pageState - new value for page state

Returns:

self reference

skip

public FindOptions skip(int skip)

Add a skip clause in the find block

Parameters:

skip - value for skip options

Returns:

current command

limit

public FindOptions limit(int limit)

Add a limit clause in the find block

Parameters:

limit - value for limit options

Returns:

current command