Documentation

Documentation / @zerotal/admin / index / AdminQuery

Interface: AdminQuery

Defined in: admin/src/Resource.ts:45

Loosely-typed view of an ORM query builder — avoids a hard dependency on @zerotal/orm.

Methods

where()

Call Signature

where(column, operator, value?): AdminQuery

Defined in: admin/src/Resource.ts:46

Parameters

column

string

operator

unknown

value?

unknown

Returns

AdminQuery

Call Signature

where(group): AdminQuery

Defined in: admin/src/Resource.ts:48

Nest predicates into one parenthesised group, so an OR inside can't escape it.

Parameters

group

(query) => void

Returns

AdminQuery

orWhere()?

Call Signature

optional orWhere(column, operator, value?): AdminQuery

Defined in: admin/src/Resource.ts:49

Parameters

column

string

operator

unknown

value?

unknown

Returns

AdminQuery

Call Signature

optional orWhere(group): AdminQuery

Defined in: admin/src/Resource.ts:50

Parameters

group

(query) => void

Returns

AdminQuery

whereLike()?

optional whereLike(column, value): AdminQuery

Defined in: admin/src/Resource.ts:51

Parameters

column

string

value

string

Returns

AdminQuery

orWhereLike()?

optional orWhereLike(column, value): AdminQuery

Defined in: admin/src/Resource.ts:52

Parameters

column

string

value

string

Returns

AdminQuery

whereNotLike()?

optional whereNotLike(column, value): AdminQuery

Defined in: admin/src/Resource.ts:53

Parameters

column

string

value

string

Returns

AdminQuery

orWhereNotLike()?

optional orWhereNotLike(column, value): AdminQuery

Defined in: admin/src/Resource.ts:54

Parameters

column

string

value

string

Returns

AdminQuery

whereNull()?

optional whereNull(column): AdminQuery

Defined in: admin/src/Resource.ts:55

Parameters

column

string

Returns

AdminQuery

orWhereNull()?

optional orWhereNull(column): AdminQuery

Defined in: admin/src/Resource.ts:56

Parameters

column

string

Returns

AdminQuery

whereNotNull()?

optional whereNotNull(column): AdminQuery

Defined in: admin/src/Resource.ts:57

Parameters

column

string

Returns

AdminQuery

orWhereNotNull()?

optional orWhereNotNull(column): AdminQuery

Defined in: admin/src/Resource.ts:58

Parameters

column

string

Returns

AdminQuery

whereIn()?

optional whereIn(column, values): AdminQuery

Defined in: admin/src/Resource.ts:59

Parameters

column

string

values

unknown[]

Returns

AdminQuery

whereNotIn()?

optional whereNotIn(column, values): AdminQuery

Defined in: admin/src/Resource.ts:60

Parameters

column

string

values

unknown[]

Returns

AdminQuery

with()?

optional with(relation): AdminQuery

Defined in: admin/src/Resource.ts:61

Parameters

relation

string

Returns

AdminQuery

orderBy()

orderBy(column, direction?): AdminQuery

Defined in: admin/src/Resource.ts:62

Parameters

column

string

direction?

"asc" | "desc"

Returns

AdminQuery

limit()

limit(n): AdminQuery

Defined in: admin/src/Resource.ts:63

Parameters

n

number

Returns

AdminQuery

offset()

offset(n): AdminQuery

Defined in: admin/src/Resource.ts:64

Parameters

n

number

Returns

AdminQuery

count()

count(): Promise<number>

Defined in: admin/src/Resource.ts:65

Returns

Promise<number>

get()?

optional get(): Promise<Record<string, unknown>[]>

Defined in: admin/src/Resource.ts:66

Returns

Promise<Record<string, unknown>[]>

all()?

optional all(): Promise<Record<string, unknown>[]>

Defined in: admin/src/Resource.ts:67

Returns

Promise<Record<string, unknown>[]>