Interface IQuery
An interface representing a runnable query over a data source
Inherited Members
System.IDisposable.Dispose()
Namespace: Couchbase.Lite.Query
Assembly: Couchbase.Lite.dll
Syntax
public interface IQuery : IChangeObservable<QueryChangedEventArgs>, IChangeObservableRemovable, IDisposableProperties
| Improve this Doc View SourceParameters
Gets or sets the parameter collection for this query so that parameters may be added for substitution into the query API (via Parameter(String))
Declaration
Parameters Parameters { get; set; }Property Value
| Type | Description |
|---|---|
| Parameters |
Remarks
The returned collection is a copy, and must be reset onto the query instance. Doing so will trigger a re-run and update any listeners.
Methods
| Improve this Doc View SourceExecute()
Runs the query
Declaration
IResultSet Execute()Returns
| Type | Description |
|---|---|
| IResultSet | The results of running the query |
Exceptions
| Type | Condition |
|---|---|
| System.InvalidOperationException | Thrown if this query has no database to operate on, or if it is missing SELECT or FROM statements (unusual) |
Explain()
Gets an explanation of what the query will do
Declaration
string Explain()Returns
| Type | Description |
|---|---|
| System.String | The explanation of the query |
Exceptions
| Type | Condition |
|---|---|
| System.ObjectDisposedException | Thrown if this method is called after disposal |