C# OJAI Client API
MapRDB.Driver.Ojai.IQuery Interface Reference
Inheritance diagram for MapRDB.Driver.Ojai.IQuery:
MapRDB.Driver.Ojai.OjaiQuery

Public Member Functions

string ToJsonString ()
 Parse query into JSON string. More...
 
string ToJsonString (Formatting formatting)
 Parse query into JSON string. More...
 
IDictionary< string, Object > ToDictionary ()
 Parse query into dictionary. More...
 
IQuery Select (params string[] fieldPaths)
 Adds the list of field paths to the list of projected fields. If not specified, the entire Document will be returned. Multiple invocation will append new fields to the list. More...
 
IQuery Where (IQueryCondition conditionJson)
 Sets the filtering condition for the query. Multiple invocation will 'AND' the individual conditions. More...
 
IQuery OrderBy (params string[] fieldPaths)
 Sets the sort ordering of the returned Documents to the ascending order of specified field paths. Multiple invocation will append the field to the sort list. More...
 
IQuery OrderBy (string field, SortOrder order)
 Sets the sort ordering of the returned Documents to the specified field and order. Multiple invocation will append the field to the sort list. More...
 
IQuery Offset (ulong offset)
 (0) based index which specifies number of Documents to skip before returning any result. Negative values are not permitted. Multiple invocation will overwrite the previous value. More...
 
IQuery Limit (ulong limit)
 Restricts the maximum number of documents returned from this query to the specified value. Negative values are not permitted. Multiple invocation will overwrite the previous value. More...
 
IQuery SetMaxClientSortLimit (int value)
 Sets maximum size of client sort limit. More...
 
IQuery Build ()
 Builds this Query object and makes it immutable. More...
 

Member Function Documentation

◆ Build()

IQuery MapRDB.Driver.Ojai.IQuery.Build ( )

Builds this Query object and makes it immutable.

Implemented in MapRDB.Driver.Ojai.OjaiQuery.

◆ Limit()

IQuery MapRDB.Driver.Ojai.IQuery.Limit ( ulong  limit)

Restricts the maximum number of documents returned from this query to the specified value. Negative values are not permitted. Multiple invocation will overwrite the previous value.

Implemented in MapRDB.Driver.Ojai.OjaiQuery.

◆ Offset()

IQuery MapRDB.Driver.Ojai.IQuery.Offset ( ulong  offset)

(0) based index which specifies number of Documents to skip before returning any result. Negative values are not permitted. Multiple invocation will overwrite the previous value.

Implemented in MapRDB.Driver.Ojai.OjaiQuery.

◆ OrderBy() [1/2]

IQuery MapRDB.Driver.Ojai.IQuery.OrderBy ( params string []  fieldPaths)

Sets the sort ordering of the returned Documents to the ascending order of specified field paths. Multiple invocation will append the field to the sort list.

Implemented in MapRDB.Driver.Ojai.OjaiQuery.

◆ OrderBy() [2/2]

IQuery MapRDB.Driver.Ojai.IQuery.OrderBy ( string  field,
SortOrder  order 
)

Sets the sort ordering of the returned Documents to the specified field and order. Multiple invocation will append the field to the sort list.

Implemented in MapRDB.Driver.Ojai.OjaiQuery.

◆ Select()

IQuery MapRDB.Driver.Ojai.IQuery.Select ( params string []  fieldPaths)

Adds the list of field paths to the list of projected fields. If not specified, the entire Document will be returned. Multiple invocation will append new fields to the list.

Implemented in MapRDB.Driver.Ojai.OjaiQuery.

◆ SetMaxClientSortLimit()

IQuery MapRDB.Driver.Ojai.IQuery.SetMaxClientSortLimit ( int  value)

Sets maximum size of client sort limit.

Implemented in MapRDB.Driver.Ojai.OjaiQuery.

◆ ToDictionary()

IDictionary<string, Object> MapRDB.Driver.Ojai.IQuery.ToDictionary ( )

Parse query into dictionary.

Implemented in MapRDB.Driver.Ojai.OjaiQuery.

◆ ToJsonString() [1/2]

string MapRDB.Driver.Ojai.IQuery.ToJsonString ( )

Parse query into JSON string.

Implemented in MapRDB.Driver.Ojai.OjaiQuery.

◆ ToJsonString() [2/2]

string MapRDB.Driver.Ojai.IQuery.ToJsonString ( Formatting  formatting)

Parse query into JSON string.

Implemented in MapRDB.Driver.Ojai.OjaiQuery.

◆ Where()

IQuery MapRDB.Driver.Ojai.IQuery.Where ( IQueryCondition  conditionJson)

Sets the filtering condition for the query. Multiple invocation will 'AND' the individual conditions.

Implemented in MapRDB.Driver.Ojai.OjaiQuery.