QueryBuilder
where()
def where(filter) -> 'QueryBuilder':
Parameters
PropType
filterFilter
Type
FilterReturns
'QueryBuilder'
last()
def last(window) -> 'QueryBuilder':
Parameters
PropType
windowstr
Type
strReturns
'QueryBuilder'
since()
def since(since) -> 'QueryBuilder':
Parameters
PropType
sincestr
Type
strReturns
'QueryBuilder'
between()
def between(start, end) -> 'QueryBuilder':
Parameters
PropType
startstr
Type
strendstr
Type
strReturns
'QueryBuilder'
pipe()
def pipe() -> 'PipelineBuilder':
Returns
'PipelineBuilder'
rows()
def rows(*, fields=None, limit=None) -> 'QueryBuilder':
Parameters
PropType
fields?Optional[Sequence[str]]
Type
Optional[Sequence[str]]Default
Nonelimit?Optional[int]
Type
Optional[int]Default
NoneReturns
'QueryBuilder'
ids()
def ids() -> 'QueryBuilder':
Returns
'QueryBuilder'
count()
def count(by=None) -> 'QueryBuilder':
Parameters
PropType
by?Optional[str]
Type
Optional[str]Default
NoneReturns
'QueryBuilder'
recent()
def recent(n) -> 'QueryBuilder':
Parameters
PropType
nint
Type
intReturns
'QueryBuilder'
top()
def top(n, by) -> 'QueryBuilder':
Parameters
PropType
nint
Type
intbystr
Type
strReturns
'QueryBuilder'
ranked()
def ranked(*, by=None, pick=None, within=None) -> 'QueryBuilder':
Parameters
PropType
by?Optional[str]
Type
Optional[str]Default
Nonepick?Optional[Union[int, Sequence[int]]]
Type
Optional[Union[int, Sequence[int]]]Default
Nonewithin?Optional[str]
Type
Optional[str]Default
NoneReturns
'QueryBuilder'
agg()
def agg(func, field, q=None) -> 'QueryBuilder':
Parameters
PropType
funcstr
Type
strfieldstr
Type
strq?Optional[float]
Type
Optional[float]Default
NoneReturns
'QueryBuilder'
trend()
def trend(*, metric=None, bucket=None) -> 'QueryBuilder':
Parameters
PropType
metric?Optional[str]
Type
Optional[str]Default
Nonebucket?Optional[str]
Type
Optional[str]Default
NoneReturns
'QueryBuilder'
chart()
def chart(*, chart_type, title, x_axis, y_axis, series_by=None, description=None) -> JsonObject:
Parameters
PropType
chart_typeChartType
Type
ChartTypetitlestr
Type
strx_axisPresentationField
Type
PresentationFieldy_axisPresentationField
Type
PresentationFieldseries_by?Optional[PresentationField]
Type
Optional[PresentationField]Default
Nonedescription?Optional[str]
Type
Optional[str]Default
NoneReturns
JsonObject
table()
def table(*, title, columns, description=None) -> JsonObject:
Parameters
PropType
titlestr
Type
strcolumnsSequence[PresentationField]
Type
Sequence[PresentationField]description?Optional[str]
Type
Optional[str]Default
NoneReturns
JsonObject
to_json()
def to_json() -> JsonObject:
Returns
JsonObject
__init__()
def __init__(_spec) -> None:
Parameters
PropType
_specJsonObject
Type
JsonObjectReturns
None