KPropertyPath

Creates an update that adds the given value to the array value of the property, unless the value is already present, in which case it does nothing

Creates a filter that matches all documents where the value of a property is an array that contains all the specified values.

Creates a filter that matches all documents where all of the bit positions are clear in the property.

Creates a filter that matches all documents where all of the bit positions are set in the property.

Creates a filter that matches all documents where any of the bit positions are clear in the property.

Creates a filter that matches all documents where any of the bit positions are set in the property.

Creates an update that performs a bitwise and between the given integer value and the integral value of the property.

Creates an update that performs a bitwise and between the given long value and the integral value of the property.

Creates an update that performs a bitwise or between the given integer value and the integral value of the property.

Creates an update that performs a bitwise or between the given long value and the integral value of the property.

Creates an update that performs a bitwise xor between the given integer value and the integral value of the property.

Creates an update that performs a bitwise xor between the given long value and the integral value of the property.

Creates a projection of a property whose value is computed from the given expression. Projection with an expression can be used in the following contexts:

Creates a projection of a property whose value is equal to the {@code $$SEARCH_META} variable. for use with {@link Aggregates#search(SearchOperator, SearchOptions)} / {@link Aggregates#search(SearchCollector, SearchOptions)}. Calling this method is equivalent to calling {@link #computed(String, Object)} with {@code "$$SEARCH_META"} as the second argument.

Returns a composed property. For example Friend::address / Address::postalCode = "address.postalCode".

Returns a collection composed property. For example Friend::addresses / Address::postalCode = "addresses.postalCode".

Returns a map composed property. For example Friend::addresses / Address::postalCode = "addresses.postalCode".

Creates a filter that matches all documents containing a property that is an array where at least one member of the array matches the given filter.

Creates a projection that includes for the given property only the first element of the array value of that field that matches the given query filter.

Creates a filter that matches all documents where the value of the property equals the specified value. Note that this doesn't actually generate an $eq operator, as the query language doesn't require it.

Creates a filter that matches all documents that contain the given property.

Creates a filter that matches all documents that either contain or do not contain the given property, depending on the value of the exists parameter.

The filtered positional operator $\

Creates a filter that matches all documents containing a property with geospatial data that intersects with the specified shape.

Creates a filter that matches all documents containing a property with geospatial data that exists entirely within the specified shape.

Creates a filter that matches all documents containing a property with grid coordinates data that exist entirely within the specified box.

Creates a filter that matches all documents containing a property with grid coordinates data that exist entirely within the specified circle.

Creates a filter that matches all documents containing a property with geospatial data (GeoJSON or legacy coordinate pairs) that exist entirely within the specified circle, using spherical geometry. If using longitude and latitude, specify longitude first.

Creates a filter that matches all documents containing a property with grid coordinates data that exist entirely within the specified polygon.

Creates a filter that matches all documents where the value of the given property is greater than the specified value.

Creates a filter that matches all documents where the value of the given property is greater than or equal to the specified value.

Creates a filter that matches all documents where the value of a property equals any value in the list of specified values.

Creates an update that increments the value of the property by the given value.

Key projection of map. Sample: p.keyProjection(Locale.ENGLISH) / Gift::amount

Creates a filter that matches all documents where the value of the given property is less than the specified value.

Creates a filter that matches all documents where the value of the given property is less than or equal to the specified value.

Creates an update that sets the value of the property if the given value is greater than the current value of the property.

Creates a $meta projection for the given property

Creates a searchHighlights projection for the given property, for use with {@link Aggregates#search(SearchOperator, SearchOptions)} / {@link Aggregates#search(SearchCollector, SearchOptions)}. Calling this method is equivalent to calling {@link #meta(String, String)} with {@code "searchHighlights"} as the argument.

Creates a searchScore projection for the given property, for use with {@link Aggregates#search(SearchOperator, SearchOptions)} / {@link Aggregates#search(SearchCollector, SearchOptions)}. Calling this method is equivalent to calling {@link #meta(String, String)} with {@code "searchScore"} as the argument.

Creates a textScore projection for the given property, for use with text queries. Calling this method is equivalent to calling {@link #meta(String)} with {@code "textScore"} as the argument.

Creates a vectorSearchScore projection for the given property, for use with {@link Aggregates#vectorSearch(FieldSearchPath, Iterable, String, long, VectorSearchOptions)} . Calling this method is equivalent to calling {@link #meta(String, String)} with {@code "vectorSearchScore"} as the argument.

Creates an update that sets the value of the property if the given value is less than the current value of the property.

Creates a filter that matches all documents where the value of a property divided by a divisor has the specified remainder (i.e. perform a modulo operation to select documents).

Creates an update that multiplies the value of the property by the given number.

Creates a filter that matches all documents where the value of the property does not equal the specified value.

Creates a filter that matches all documents containing a property with geospatial data that is near the specified GeoJSON point.

Creates a filter that matches all documents containing a property with geospatial data that is near the specified point.

Creates a filter that matches all documents containing a property with geospatial data that is near the specified GeoJSON point using spherical geometry.

Creates a filter that matches all documents containing a property with geospatial data that is near the specified point using spherical geometry.

Creates a filter that matches all documents where the value of a property does not equal any of the specified values or does not exist.

Returns a mongo path of a property.

In order to write array indexed expressions (like accesses.0.timestamp).

In order to write $p.p2

Creates an update that removes all instances of the given value from the array value of the property.

Creates an update that removes all instances of the given values from the array value of the property.

Creates an update that removes all instances of the given value from the array value of the property.

Creates a filter that matches all documents where the value of the property matches the given regular expression pattern.

Creates a filter that matches all documents where the value of the option matches the given regular expression pattern with the given options applied.

Returns a composed property without type checks. For example Friend::address % Address::postalCode = "address.postalCode".

Creates an update that renames a field.

Creates an update that sets the value of the property to the given value.

Creates an update that sets the value of the property to the given value, but only if the update is an upsert that results in an insert of a document.

Creates a filter that matches all documents where the value of a property is an array of the specified size.

Creates a projection to the given property of a slice of the array value of that field.

Creates a filter that matches all documents where the value of the property is of the specified BSON type.

The all positional operator $[]

Returns a collection property.

Creates a projection that includes for the given property only the first element of an array that matches the query filter. This is referred to as the positional $ operator.

Returns a map property.

The positional array operator $ (projection or update)

The projection of the property. This is used in an aggregation pipeline to reference a property from a path.