Namespace Couchbase.Lite.Query
Classes
ArrayExpression
A class containing methods for generating queries that operate on array types
ArrayFunction
A class for generating query functions that operate on array types
ArrayIndexConfiguration
Configuration for indexing property values within nested arrays in documents, intended for use with the UNNEST query keyword.
Collation
A factory class for creating ICollation instances
DataSource
A factory class for creating data sources for queries
Expression
A factory for unary IExpression operators
FullTextExpression
[DEPRECATED] A class that generates expressions that operate on the results of full-text searching
FullTextFunction
A class that generates functions for use on the results of a full-text search
FullTextIndexConfiguration
An class for an index based on full text searching
FullTextIndexItem
A factory class for creating IFullTextIndexItem instances
Function
A class for creating IExpression instances that represent functions
IndexBuilder
A factory class for creating IIndex instances
Join
A class for creating IJoin instances
Meta
A class that generates expressions for retrieving metadata during a query
Ordering
A factory class for generating ISortOrder objects
Parameters
A class which contains parameters for an IQuery
QueryBuilder
A factory class for generating the initial portion of a query
QueryChangedEventArgs
Arguments for the AddChangeListener(EventHandler<TEventType>) event
Result
A class representing information about a "row" in the result of an
IQuery
Warning
The data inside this class is tied to the lifetime of its parent IResultSet and will become invalid if the parent is disposed or garbage collected, unless the data is first converted to .NET objects via ToList, ToDictionary, etc.
SelectResult
A class for generating instances of ISelectResult. This will be expanded on in the near future.
ValueIndexConfiguration
An class for an index based on a simple property value
ValueIndexItem
A factory class for creating IValueIndexItem instances
Interfaces
IArrayExpressionIn
An interface that represents a portion of a query that chooses a collection to be used in a query of each of its elements
IArrayExpressionSatisfies
An interface representing an object that can accept a predicate to use on each item in a collection
IASCIICollation
An interface that can use 7-bit ASCII rules to do string collation
ICollation
A base interface for different collations
IDataSource
An interface representing the source of data for a query
IDataSourceAs
An interface representing a source of data that comes from an Database
IExpression
An interface representing an abstract expression that can act on a given piece of data
IFrom
An interface representing the FROM portion of an IQuery
IFromRouter
An interface representing a portion of a query that can be routed to a FROM portion
IFullTextExpression
[DEPRECATED] An interface that represents an expression that is eligible to receive full-text related query clauses
IFullTextIndex
An interface for an index based on full text searching
IFullTextIndexExpression
Specifies an unambiguous full text index to use when building a query via QueryBuilder.
IFullTextIndexItem
An interface for an index item for use when creating FTS based indexes
IGroupBy
An interface representing the GROUP BY portion of a query
IGroupByRouter
An interface representing a portion of a query which can take GROUP BY as its next step
IHaving
An interface representing the HAVING portion of a query (i.e. WHERE clause intended for a GROUP BY clause)
IHavingRouter
An interface representing a portion of a query that can take HAVING as its next step
IIndex
The base interface for an index in a Database
IIndexable
An interface describing an object That can create, delete, or retrieve a list of existing IIndex objects by name
IIndexExpression
The base interface used when an index is required to be specified in a QueryBuilder query.
IIndexUpdater
An interface used for updating the index in lazy mode.
Currently, vector index is the only index type that
can be updated lazily.
Warning
Any collections retrieved from this interface via GetValue(Int32)
or any of the overrides will be invalidated once this object is disposed and any
attempt to use them will result in an System.ObjectDisposedException
IJoin
An interface representing an IQuery with a JOIN clause
IJoinOn
An interface representing an IQuery with a partially constructed JOIN clause that has not yet received its ON clause
IJoinRouter
An interface representing a portion of an IQuery that can accept JOIN as its next clause
IJoins
An interface representing a query that has just received a JOIN clause
ILimit
An interface representing a query that has had a limit and optionally an offset applied
ILimitRouter
An interface representing a query that can accept LIMIT as its next clause
IMetaExpression
Represents an expression that is meant to retrieve metadata information inside of an IQuery
IOrderBy
An interface representing the ORDER BY portion of an IQuery
IOrderByRouter
An interface representing a portion of a query that can be routed to an ORDER BY portion
IOrdering
An interface representing an arbitrary sorting for an IOrderBy
IPredictionFunction
An element of an IQuery that holds the representation of a predictive query prediction
IPropertyExpression
An interface for an expression that will retrieve a property from a keypath
IQuery
An interface representing a runnable query over a data source
IQueryFactory
An interface describing an object that is capable of creating an IQuery object
IQueryIndex
An interface representing an existing index in a collection
IResultSet
An interface representing an enumerable collection of results from a given IQuery.
ISelect
An interface representing the SELECT portion of an IQuery
ISelectResult
An interface that holds information about what to select out of an IQuery
ISelectResultAs
An interface reprsenting a select result that can be aliased to an arbitrary name
ISelectResultFrom
An interface representing a select result "FROM" a certain data source
ISortOrder
An interface representing the way that an IOrderBy should be sorted
IUnicodeCollation
An interface that can use Unicode rules (http://unicode.org/reports/tr10/) to do string collation
IValueIndex
An interface for an index based on a simple property value
IValueIndexItem
An interface for an index item for use when creating value based indexes
IVariableExpression
A type of expression that represents the variable portion of an array based expression such as Any(IVariableExpression)
IWhere
An interface representing the WHERE portion of an IQuery
IWhereRouter
An interface representing a portion of a query that can be routed to a WHERE portion of the query.