QueryBuilderRecordShape
@melon-db/db-query — QueryBuilderRecordShape
@melon-db/db-query API Reference
Class: QueryBuilder<RecordShape>
Defined in: query-builder.ts:12
Fluent query builder that produces QueryAst.
Type Parameters
| Type Parameter | Default type |
|---|---|
RecordShape | Record<string, unknown> |
Constructors
Constructor
new QueryBuilder<
RecordShape>(collection):QueryBuilder<RecordShape>
Defined in: query-builder.ts:21
Parameters
| Parameter | Type |
|---|---|
collection | string |
Returns
QueryBuilder<RecordShape>
Methods
and()
and(
group):this
Defined in: query-builder.ts:40
Parameters
| Parameter | Type |
|---|---|
group | (q) => QueryBuilder<RecordShape> |
Returns
this
include()
include(
relation,config?):this
Defined in: query-builder.ts:99
Parameters
| Parameter | Type |
|---|---|
relation | keyof RecordShape & string |
config? | Omit<QueryRelationInclude, "relation"> |
Returns
this
limit()
limit(
value):this
Defined in: query-builder.ts:89
Parameters
| Parameter | Type |
|---|---|
value | number |
Returns
this
not()
not(
group):this
Defined in: query-builder.ts:66
Parameters
| Parameter | Type |
|---|---|
group | (q) => QueryBuilder<RecordShape> |
Returns
this
or()
or(
group):this
Defined in: query-builder.ts:54
Parameters
| Parameter | Type |
|---|---|
group | (q) => QueryBuilder<RecordShape> |
Returns
this
orderBy()
orderBy(
field,direction?):this
Defined in: query-builder.ts:81
Parameters
| Parameter | Type | Default value |
|---|---|---|
field | keyof RecordShape & string | undefined |
direction | "asc" | "desc" | "asc" |
Returns
this
skip()
skip(
value):this
Defined in: query-builder.ts:94
Parameters
| Parameter | Type |
|---|---|
value | number |
Returns
this
toAst()
toAst(
mode?):QueryAst
Defined in: query-builder.ts:107
Parameters
| Parameter | Type |
|---|---|
mode? | "many" | "one" | "count" |
Returns
QueryAst
where()
where(
field,op,value?):this
Defined in: query-builder.ts:25
Parameters
| Parameter | Type |
|---|---|
field | keyof RecordShape & string |
op | QueryOperator |
value? | unknown |
Returns
this