Implemented as an object that can query a Couchbase View.
Inheritance Hierarchy
Namespace: Couchbase.ViewsAssembly: Couchbase.NetClient (in Couchbase.NetClient.dll) Version: 2.0.0.0 (2.0.0.0)
Syntax
The ViewQuery type exposes the following members.
Constructors
Name | Description | |
---|---|---|
ViewQuery | Initializes a new instance of the ViewQuery class | |
ViewQuery(String) | Initializes a new instance of the ViewQuery class | |
ViewQuery(String, String) | Initializes a new instance of the ViewQuery class | |
ViewQuery(String, String, String) | Initializes a new instance of the ViewQuery class | |
ViewQuery(String, String, String, String) | Initializes a new instance of the ViewQuery class |
Methods
Name | Description | |
---|---|---|
Asc |
Return the documents in ascending by key order
| |
BaseUri |
Sets the base uri for the query if it's not set in the constructor.
| |
Bucket |
Sets the name of the Couchbase Bucket.
| |
ConnectionTimeout |
The number of seconds before the request will be terminated if it has not completed.
| |
Desc |
Return the documents in descending by key order
| |
DesignDoc |
Sets the name of the design document.
| |
Development |
Toggles the query between development or production dataset and View.
| |
EndKey(Object) |
Stop returning records when the specified key is reached. Key must be specified as a JSON value.
| |
EndKey(Object, Boolean) |
Stop returning records when the specified key is reached. Key must be specified as a JSON value.
| |
EndKeyDocId |
Stop returning records when the specified document ID is reached
| |
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) | |
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) | |
From |
Specifies the bucket and design document to target for a query.
| |
FullSet |
Use the full cluster data set (development views only).
| |
GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
Group |
Group the results using the reduce function to a group or single row
| |
GroupLevel |
Specify the group level to be used
| |
InclusiveEnd |
Specifies whether the specified end key should be included in the result
| |
Key(Object) |
Return only documents that match the specified key. Key must be specified as a JSON value.
| |
Key(Object, Boolean) |
Return only documents that match the specified key. Key must be specified as a JSON value.
| |
Keys(IEnumerable) |
Return only documents that match each of keys specified within the given array. Key must be specified as a JSON value. Sorting is not applied when using this option.
| |
Keys(IEnumerable, Boolean) |
Return only documents that match each of keys specified within the given array. Key must be specified as a JSON value. Sorting is not applied when using this option.
| |
Limit |
Limit the number of the returned documents to the specified number
| |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
OnError |
Sets the response in the event of an error
| |
RawUri |
Returns the raw REST URI which can be executed in a browser or using curl.
| |
Reduce |
Use the reduction function
| |
Skip |
Skip this number of records before starting to return the results
| |
Stale |
Allow the results from a stale view to be used. The default is StaleState.Ok; for development work set to StaleState.False
| |
StartKey(Object) |
Return records with a value equal to or greater than the specified key. Key must be specified as a JSON value.
| |
StartKey(Object, Boolean) |
Return records with a value equal to or greater than the specified key. Key must be specified as a JSON value.
| |
StartKeyDocId |
Return records starting with the specified document ID.
| |
ToString | Returns a string that represents the current object. (Inherited from Object.) | |
View |
Sets the name of the view to query.
|
Fields
Properties
Name | Description | |
---|---|---|
BucketName |
Gets the name of the IBucket that the query is targeting.
|
See Also