Uses of Class
com.datastax.astra.client.model.Filter

Packages that use Filter

Package	Description
com.datastax.astra.client	Entrypoint and core classes for the client.
com.datastax.astra.client.model	Domain model classes with Requests, Results, Options and Iterables.

Uses of Filter in com.datastax.astra.client

Methods in com.datastax.astra.client with parameters of type Filter

Modifier and Type	Method	Description
int	Collection.countDocuments(Filter filter, int upperBound)	Implementation of the @see Collection.countDocuments(Filter, int, CountDocumentsOptions) method with default options.
int	Collection.countDocuments(Filter filter, int upperBound, CountDocumentsOptions options)	Counts the number of documents in the collection with a filter.
DeleteResult	Collection.deleteMany(Filter filter)	Removes all documents from the collection that match the given query filter.
DeleteResult	Collection.deleteMany(Filter filter, DeleteManyOptions options)	Removes all documents from the collection that match the given query filter.
DeleteResult	Collection.deleteOne(Filter filter)	Removes at most one document from the collection that matches the given filter.
DeleteResult	Collection.deleteOne(Filter filter, DeleteOneOptions deleteOneOptions)	Removes at most one document from the collection that matches the given filter.
<F> DistinctIterable<T,F>	Collection.distinct(String fieldName, Filter filter, Class<F> resultClass)	Gets the distinct values of the specified field name.
FindIterable<T>	Collection.find(Filter filter)	Retrieves documents in the collection that match the specified filter.
FindIterable<T>	Collection.find(Filter filter, float[] vector, int limit)	Finds documents in the collection that match the specified filter and sorts them based on their similarity to a provided vector, limiting the number of results returned.
FindIterable<T>	Collection.find(Filter filter, FindOptions options)	Finds all documents in the collection.
FindIterable<T>	Collection.find(Filter filter, String vectorize, int limit)	Finds documents in the collection that match the specified filter and sorts them based on their similarity to a provided vector, limiting the number of results returned.
Optional<T>	Collection.findOne(Filter filter)	Attempts to find a single document within the collection that matches the given filter criteria.
Optional<T>	Collection.findOne(Filter filter, FindOneOptions findOneOptions)	Attempts to find a single document within the collection that matches the given filter criteria.
Optional<T>	Collection.findOneAndDelete(Filter filter)	Atomically find a document and remove it.
Optional<T>	Collection.findOneAndDelete(Filter filter, FindOneAndDeleteOptions options)	Atomically find a document and remove it.
CompletableFuture<Optional<T>>	Collection.findOneAndDeleteAsync(Filter filter)	Delete and return a document asynchronous.
Optional<T>	Collection.findOneAndReplace(Filter filter, T replacement)	Atomically find a document and replace it.
Optional<T>	Collection.findOneAndReplace(Filter filter, T replacement, FindOneAndReplaceOptions options)	Atomically find a document and replace it.
Optional<T>	Collection.findOneAndUpdate(Filter filter, Update update)	Atomically find a document and update it.
Optional<T>	Collection.findOneAndUpdate(Filter filter, Update update, FindOneAndUpdateOptions options)	Atomically find a document and update it.
CompletableFuture<Optional<T>>	Collection.findOneASync(Filter filter)	Initiates an asynchronous search to find a single document that matches the given filter criteria.
CompletableFuture<Optional<T>>	Collection.findOneASync(Filter filter, FindOneOptions findOneOptions)	Asynchronously attempts to find a single document within the collection that matches the given filter criteria, utilizing the specified FindOneOptions for the query.
Page<T>	Collection.findPage(Filter filter, FindOptions options)	Executes a paginated 'find' query on the collection using the specified filter and find options.
CompletableFuture<Page<T>>	Collection.findPageASync(Filter filter, FindOptions options)	Executes a paginated 'find' query on the collection using the specified filter and find options asynchronously.
UpdateResult	Collection.replaceOne(Filter filter, T replacement)	Replace a single document on the collection with a new one, optionally inserting a new document if no match is found.
UpdateResult	Collection.replaceOne(Filter filter, T replacement, ReplaceOneOptions replaceOneOptions)	Replace a document in the collection according to the specified arguments.
UpdateResult	Collection.updateMany(Filter filter, Update update)	Update all documents in the collection according to the specified arguments.
UpdateResult	Collection.updateMany(Filter filter, Update update, UpdateManyOptions options)	Update all documents in the collection according to the specified arguments.
UpdateResult	Collection.updateOne(Filter filter, Update update)	Update a single document in the collection according to the specified arguments.
UpdateResult	Collection.updateOne(Filter filter, Update update, UpdateOneOptions updateOptions)	Update a single document in the collection according to the specified arguments.

Uses of Filter in com.datastax.astra.client.model

Fields in com.datastax.astra.client.model declared as Filter

Modifier and Type	Field	Description
protected Filter	PageableIterable.filter	Original command, we will edit it to iterate on pages.

Methods in com.datastax.astra.client.model that return Filter

Modifier and Type	Method	Description
static Filter	Filters.all(String fieldName, Object... values)	Build a filter with the `$all` operator.
static Filter	Filters.and(Filter... filters)	Creates a filter that performs a logical AND of the provided list of filters.
static Filter	Filters.and(Iterable<Filter> filters)	Creates a filter that performs a logical AND of the provided list of filters.
static Filter	Filters.eq(Object value)	Creates a filter that matches all documents where the value of _id field equals the specified value.
static Filter	Filters.eq(String fieldName, Object value)	Help Building the filters.
Filter	FilterBuilder.exists()	Add condition exists.
static Filter	Filters.exists(String fieldName)	Build a filter with the `$exists` operator.
static Filter	Filter.findById(String id)	Build a filter for find by id.
static Filter	Filters.gt(String fieldName, Number value)	Creates a filter that matches all documents where the value of the given field is greater than the specified value.
static Filter	Filters.gt(String fieldName, Instant value)	Creates a filter that matches all documents where the value of the given field is greater than the specified value.
static Filter	Filters.gt(String fieldName, Calendar value)	Creates a filter that matches all documents where the value of the given field is greater than the specified value.
static Filter	Filters.gt(String fieldName, Date value)	Creates a filter that matches all documents where the value of the given field is greater than the specified value.
static Filter	Filters.gte(String fieldName, Number value)	Creates a filter that matches all documents where the value of the given field is greater than or equal to the specified value.
static Filter	Filters.gte(String fieldName, Instant value)	Creates a filter that matches all documents where the value of the given field is greater than or equal to the specified value.
static Filter	Filters.gte(String fieldName, Calendar value)	Creates a filter that matches all documents where the value of the given field is greater than or equal to the specified value.
static Filter	Filters.gte(String fieldName, Date value)	Creates a filter that matches all documents where the value of the given field is greater than or equal to the specified value.
Filter	FilterBuilder.hasSize(int size)	Condition to evaluate size
static Filter	Filters.hasSize(String fieldName, int size)	Build a filter with the `$hasSize` operator.
Filter	FilterBuilder.hasSubFieldsEqualsTo(Map<String,Object> value)	$eq: [ ... ]
static <V> Filter	Filters.in(String fieldName, V... values)	Creates a filter that matches all documents where the value of a field equals any value in the list of specified values.
final <V> Filter	FilterBuilder.isAnArrayContaining(V... value)	$eq: [ ... ]
Filter	FilterBuilder.isAnArrayExactlyEqualsTo(Object[] value)	$all: [ ... ]
Filter	FilterBuilder.isEqualsTo(Object value)	"fieldName": "value" ($eq is omitted)
Filter	FilterBuilder.isGreaterOrEqualsThan(Object value)	Add condition is greater than.
Filter	FilterBuilder.isGreaterThan(Object value)	Add condition is less than.
<V> Filter	FilterBuilder.isInArray(V[] value)	$in: [ ... ]
Filter	FilterBuilder.isLessOrEqualsThan(Object value)	Add condition is less than.
Filter	FilterBuilder.isLessThan(Object value)	Add condition is less than.
Filter	FilterBuilder.isNotEqualsTo(Object value)	Add condition is not equals to.
<V> Filter	FilterBuilder.isNotInArray(V[] value)	$in: [ ... ]
static Filter	Filters.lt(String fieldName, Number value)	Creates a filter that matches all documents where the value of the given field is less than the specified value.
static Filter	Filters.lt(String fieldName, Instant value)	Creates a filter that matches all documents where the value of the given field is less than the specified value.
static Filter	Filters.lt(String fieldName, Calendar value)	Creates a filter that matches all documents where the value of the given field is less than the specified value.
static Filter	Filters.lt(String fieldName, Date value)	Creates a filter that matches all documents where the value of the given field is less than the specified value.
static Filter	Filters.lte(String fieldName, Number value)	Creates a filter that matches all documents where the value of the given field is less than or equal to the specified value.
static Filter	Filters.lte(String fieldName, Instant value)	Creates a filter that matches all documents where the value of the given field is less than or equal to the specified value.
static Filter	Filters.lte(String fieldName, Calendar value)	Creates a filter that matches all documents where the value of the given field is less than or equal to the specified value.
static Filter	Filters.lte(String fieldName, Date value)	Creates a filter that matches all documents where the value of the given field is less than or equal to the specified value.
static Filter	Filters.ne(String fieldName, Object value)	Creates a filter that matches all documents where the value of the field name does not equal the specified value.
static <V> Filter	Filters.nin(String fieldName, V... values)	Creates a filter that matches all documents where the value of a field equals any value in the list of specified values.
static Filter	Filters.not(Filter filter)	Creates a filter that performs a logical NOT of the provided filter
static Filter	Filters.or(Filter... filters)	Creates a filter that performs a logical OR of the provided list of filters.
static Filter	Filters.or(Iterable<Filter> filters)	Creates a filter that performs a logical OR of the provided list of filters.
Filter	Filter.where(String fieldName, FilterOperator cond, Object value)	Build where clause with operator

Methods in com.datastax.astra.client.model with parameters of type Filter

Modifier and Type	Method	Description
static Filter	Filters.and(Filter... filters)	Creates a filter that performs a logical AND of the provided list of filters.
static Filter	Filters.not(Filter filter)	Creates a filter that performs a logical NOT of the provided filter
static Filter	Filters.or(Filter... filters)	Creates a filter that performs a logical OR of the provided list of filters.
Command	Command.withFilter(Filter filter)	Builder pattern, update filter.

Method parameters in com.datastax.astra.client.model with type arguments of type Filter

Modifier and Type	Method	Description
static Filter	Filters.and(Iterable<Filter> filters)	Creates a filter that performs a logical AND of the provided list of filters.
static Filter	Filters.or(Iterable<Filter> filters)	Creates a filter that performs a logical OR of the provided list of filters.

Constructors in com.datastax.astra.client.model with parameters of type Filter

Modifier	Constructor	Description
	DistinctIterable(Collection<T> collection, String fieldName, Filter filter, Class<F> fieldClass)	Constructs an iterable that provides distinct elements from a specified collection, optionally filtered by a given criterion.
protected	FilterBuilder(Filter filter, String fieldName)	Only constructor allowed
	FindIterable(Collection<T> collection, Filter filter, FindOptions options)	Constructor for a cursor over the elements of the find.