zol | zol

Index

Modules

Enumerations

Order

Classes

Interfaces

Type aliases

Functions

Type aliases

AggrCols

AggrCols: object

Type declaration

LeftCols

LeftCols: object

Type declaration

MakeCols

MakeCols: object

Type declaration

MakeTable

MakeTable: object & object

TableDeclareCols

TableDeclareCols: object

Type declaration

Functions

aggregate

aggregate<s, a>(q: Q<s>, s: function): MakeCols<s, a>

- Defined in zol.d.ts:366
Type parameters
- s
- a: any
Parameters
- q: Q<s>
- s: function
  - - (q: Q<Inner<s>>): AggrCols<s, a>
    - Parameters
      - q: Q<Inner<s>>
      Returns AggrCols<s, a>
Returns MakeCols<s, a>

arbitrary

arbitrary<s>(): Col<s, Arbitrary>

- Defined in zol.d.ts:391
Type parameters
- s
Returns Col<s, Arbitrary>

avg

avg<s>(col: Col<s, number>): Aggr<s, number | null>

- Defined in zol.d.ts:64
Type parameters
- s
Parameters
- col: Col<s, number>
Returns Aggr<s, number | null>

booleanCol

booleanCol<s>(val: boolean): Col<s, boolean>

- Defined in zol.d.ts:114
Type parameters
- s
Parameters
- val: boolean
Returns Col<s, boolean>

count

count<s, a>(col: Col<s, a>): Aggr<s, number>

- Defined in zol.d.ts:62
Type parameters
- s
- a
Parameters
- col: Col<s, a>
Returns Aggr<s, number>

declareTable

declareTable<Req, Def>(tableName: string, columns: TableDeclareCols<Req & Def>): Table<Req, Def>

- Defined in zol.d.ts:90
Type parameters
- Req: any
- Def: any
Parameters
- tableName: string
- columns: TableDeclareCols<Req & Def>
Returns Table<Req, Def>

defaultValue

defaultValue(): DefaultValue

- Defined in zol.d.ts:53
Returns DefaultValue

delete_

delete_<Req, Def>(sqlTag: string | undefined, conn: Client, table: Table<Req, Def>, pred: function): Promise<number>

- Defined in zol.d.ts:297
Type parameters
- Req: any
- Def: any
Parameters
- sqlTag: string | undefined
- conn: Client
- table: Table<Req, Def>
- pred: function
  - - (c: MakeCols<Write, Req & Def>): Col<Write, boolean>
    - Parameters
      - c: MakeCols<Write, Req & Def>
      Returns Col<Write, boolean>
Returns Promise<number>

number of rows deleted

distinct

distinct<s, a>(q: Q<s>, query: function): MakeCols<s, a>

- Defined in zol.d.ts:429
Type parameters
- s
- a: any
Parameters
- q: Q<s>
- query: function
  - - (q: Q<s>): MakeCols<s, a>
    - Parameters
      - q: Q<s>
      Returns MakeCols<s, a>
Returns MakeCols<s, a>

e

e<s, a>(lhs: Col<s, a>, op: "=", rhs: Col<s, a>): Col<s, boolean>
e<s, a>(lhs: Col<s, a>, op: "!=", rhs: Col<s, a>): Col<s, boolean>
e<s, a>(lhs: Col<s, a>, op: ">", rhs: Col<s, a>): Col<s, boolean>
e<s, a>(lhs: Col<s, a>, op: "<", rhs: Col<s, a>): Col<s, boolean>
e<s, a>(lhs: Col<s, a>, op: ">=", rhs: Col<s, a>): Col<s, boolean>
e<s, a>(lhs: Col<s, a>, op: "<=", rhs: Col<s, a>): Col<s, boolean>
e<s>(lhs: Col<s, boolean>, op: "AND", rhs: Col<s, boolean>): Col<s, boolean>
e<s>(lhs: Col<s, boolean>, op: "OR", rhs: Col<s, boolean>): Col<s, boolean>
e<s>(lhs: Col<s, number>, op: "+", rhs: Col<s, number>): Col<s, number>
e<s>(lhs: Col<s, number>, op: "-", rhs: Col<s, number>): Col<s, number>
e<s>(lhs: Col<s, number>, op: "*", rhs: Col<s, number>): Col<s, number>
e<s>(lhs: Col<s, number>, op: "/", rhs: Col<s, number>): Col<s, number>
e<s>(lhs: Col<s, string>, op: "||", rhs: Col<s, string>): Col<s, string>

- Defined in zol.d.ts:517
Type parameters
- s
- a
Parameters
- lhs: Col<s, a>
- op: "="
- rhs: Col<s, a>
Returns Col<s, boolean>
- Defined in zol.d.ts:519
Type parameters
- s
- a
Parameters
- lhs: Col<s, a>
- op: "!="
- rhs: Col<s, a>
Returns Col<s, boolean>
- Defined in zol.d.ts:521
Type parameters
- s
- a
Parameters
- lhs: Col<s, a>
- op: ">"
- rhs: Col<s, a>
Returns Col<s, boolean>
- Defined in zol.d.ts:523
Type parameters
- s
- a
Parameters
- lhs: Col<s, a>
- op: "<"
- rhs: Col<s, a>
Returns Col<s, boolean>
- Defined in zol.d.ts:525
Type parameters
- s
- a
Parameters
- lhs: Col<s, a>
- op: ">="
- rhs: Col<s, a>
Returns Col<s, boolean>
- Defined in zol.d.ts:527
Type parameters
- s
- a
Parameters
- lhs: Col<s, a>
- op: "<="
- rhs: Col<s, a>
Returns Col<s, boolean>
- Defined in zol.d.ts:529
Type parameters
- s
Parameters
- lhs: Col<s, boolean>
- op: "AND"
- rhs: Col<s, boolean>
Returns Col<s, boolean>
- Defined in zol.d.ts:531
Type parameters
- s
Parameters
- lhs: Col<s, boolean>
- op: "OR"
- rhs: Col<s, boolean>
Returns Col<s, boolean>
- Defined in zol.d.ts:533
Type parameters
- s
Parameters
- lhs: Col<s, number>
- op: "+"
- rhs: Col<s, number>
Returns Col<s, number>
- Defined in zol.d.ts:535
Type parameters
- s
Parameters
- lhs: Col<s, number>
- op: "-"
- rhs: Col<s, number>
Returns Col<s, number>
- Defined in zol.d.ts:537
Type parameters
- s
Parameters
- lhs: Col<s, number>
- op: "*"
- rhs: Col<s, number>
Returns Col<s, number>
- Defined in zol.d.ts:539
Type parameters
- s
Parameters
- lhs: Col<s, number>
- op: "/"
- rhs: Col<s, number>
Returns Col<s, number>
- Defined in zol.d.ts:541
Type parameters
- s
Parameters
- lhs: Col<s, string>
- op: "||"
- rhs: Col<s, string>
Returns Col<s, string>

exists

exists<s>(subquery: function): Col<s, boolean>

- Defined in zol.d.ts:378
Type parameters
- s
Parameters
- subquery: function
  - - (q: Q<s>): Col<s, Arbitrary>
    - Parameters
      - q: Q<s>
      Returns Col<s, Arbitrary>
Returns Col<s, boolean>

groupBy

groupBy<s, a>(q: Q<Inner<s>>, col: Col<Inner<s>, a>): Aggr<Inner<s>, a>

- Defined in zol.d.ts:364
Type parameters
- s
- a
Parameters
- q: Q<Inner<s>>
- col: Col<Inner<s>, a>
Returns Aggr<Inner<s>, a>

ifNull

ifNull<s, a>(replacement: Col<s, a>, nullable: Col<s, a | null>): Col<s, a>

- Defined in zol.d.ts:150
Type parameters
- s
- a
Parameters
- replacement: Col<s, a>
- nullable: Col<s, a | null>
Returns Col<s, a>

ifThenElse

ifThenElse<s, a>(if_: Col<s, boolean>, then: Col<s, a>, else_: Col<s, a>): Col<s, a>

- Defined in zol.d.ts:134
Type parameters
- s
- a
Parameters
- if_: Col<s, boolean>
- then: Col<s, a>
- else_: Col<s, a>
Returns Col<s, a>

ilike

ilike<s>(str: Col<s, string>, pattern: string): Col<s, boolean>
ilike<s>(str: Col<s, string>, pattern: Col<s, string>): Col<s, boolean>

- Defined in zol.d.ts:505
Type parameters
- s
Parameters
- str: Col<s, string>
- pattern: string
Returns Col<s, boolean>
- Defined in zol.d.ts:515
Type parameters
- s
Parameters
- str: Col<s, string>
- pattern: Col<s, string>
Returns Col<s, boolean>

inList

inList<s, a>(lhs: Col<s, a>, rhs: Col<s, a>[]): Col<s, boolean>

- Defined in zol.d.ts:72
Type parameters
- s
- a
Parameters
- lhs: Col<s, a>
- rhs: Col<s, a>[]
Returns Col<s, boolean>

inQuery

inQuery<s, a>(lhs: Col<s, a>, rhs: function): Col<s, boolean>

- Defined in zol.d.ts:368
Type parameters
- s
- a
Parameters
- lhs: Col<s, a>
- rhs: function
  - - (q: Q<s>): Col<s, a>
    - Parameters
      - q: Q<s>
      Returns Col<s, a>
Returns Col<s, boolean>

inner

inner<s, a>(q: Q<s>, query: function): MakeCols<s, a>

- Defined in zol.d.ts:405
Type parameters
- s
- a: any
Parameters
- q: Q<s>
- query: function
  - - (q: Q<Inner<s>>): MakeCols<Inner<s>, a>
    - Parameters
      - q: Q<Inner<s>>
      Returns MakeCols<Inner<s>, a>
Returns MakeCols<s, a>

innerJoin

innerJoin<s, a>(q: Q<s>, s: function, pred: function): MakeCols<s, a>

- Defined in zol.d.ts:395
Type parameters
- s
- a: any
Parameters
- q: Q<s>
- s: function
  - - (q: Q<Inner<s>>): MakeCols<Inner<s>, a>
    - Parameters
      - q: Q<Inner<s>>
      Returns MakeCols<Inner<s>, a>
- pred: function
  - - (p: MakeCols<s, a>): Col<s, boolean>
    - Parameters
      - p: MakeCols<s, a>
      Returns Col<s, boolean>
Returns MakeCols<s, a>

insert

insert<Req, Def>(sqlTag: string | undefined, conn: Client, table: Table<Req, Def>, rowValues: MakeTable<Req, Def>): Promise<void>

- Defined in zol.d.ts:193
Type parameters
- Req: any
- Def: any
Parameters
- sqlTag: string | undefined
- conn: Client
- table: Table<Req, Def>
- rowValues: MakeTable<Req, Def>
Returns Promise<void>

insertMany

insertMany<Req, Def>(sqlTag: string | undefined, conn: Client, table: Table<Req, Def>, rowValues: MakeTable<Req, Def>[]): Promise<void>

- Defined in zol.d.ts:250
Type parameters
- Req: any
- Def: any
Parameters
- sqlTag: string | undefined
- conn: Client
- table: Table<Req, Def>
- rowValues: MakeTable<Req, Def>[]
Returns Promise<void>

insertManyOnConflictDoNothing

insertManyOnConflictDoNothing<Req, Def>(sqlTag: string | undefined, conn: Client, table: Table<Req, Def>, rowValues: MakeTable<Req, Def>[], conflictTarget: ConflictTarget<Req & Def>): Promise<number>

- Defined in zol.d.ts:264
Type parameters
- Req: any
- Def: any
Parameters
- sqlTag: string | undefined
- conn: Client
- table: Table<Req, Def>
- rowValues: MakeTable<Req, Def>[]
- conflictTarget: ConflictTarget<Req & Def>
Returns Promise<number>

The number of rows inserted

insertManyOnConflictDoNothingReturning

insertManyOnConflictDoNothingReturning<Req, Def, Ret>(sqlTag: string | undefined, conn: Client, table: Table<Req, Def>, rowValues: MakeTable<Req, Def>[], conflictTarget: ConflictTarget<Req & Def>, returning: function): Promise<Ret[]>

- Defined in zol.d.ts:257
Type parameters
- Req: any
- Def: any
- Ret: any
Parameters
- sqlTag: string | undefined
- conn: Client
- table: Table<Req, Def>
- rowValues: MakeTable<Req, Def>[]
- conflictTarget: ConflictTarget<Req & Def>
- returning: function
  - - (c: MakeCols<Write, Req & Def>): MakeCols<Write, Ret>
    - Parameters
      - c: MakeCols<Write, Req & Def>
      Returns MakeCols<Write, Ret>
Returns Promise<Ret[]>

insertManyOnConflictDoUpdate

insertManyOnConflictDoUpdate<Req, Def>(sqlTag: string | undefined, conn: Client, table: Table<Req, Def>, rowValues: MakeTable<Req, Def>[], conflictTarget: ConflictTarget<Req & Def>, onConflictPred: function, onConflictUpdate: function): Promise<number>

- Defined in zol.d.ts:288
Type parameters
- Req: any
- Def: any
Parameters
- sqlTag: string | undefined
- conn: Client
- table: Table<Req, Def>
- rowValues: MakeTable<Req, Def>[]
- conflictTarget: ConflictTarget<Req & Def>
- onConflictPred: function
  - - (c: MakeCols<Write, Req & Def>): Col<Write, boolean>
    - Parameters
      - c: MakeCols<Write, Req & Def>
      Returns Col<Write, boolean>
- onConflictUpdate: function
  - - (c: MakeCols<Write, Req & Def>): MakeTable<Req, Def>
    - Parameters
      - c: MakeCols<Write, Req & Def>
      Returns MakeTable<Req, Def>
Returns Promise<number>

The number of newly inserted rows + the number of updated rows

insertManyOnConflictDoUpdateReturning

insertManyOnConflictDoUpdateReturning<Req, Def, Ret>(sqlTag: string | undefined, conn: Client, table: Table<Req, Def>, rowValues: MakeTable<Req, Def>[], conflictTarget: ConflictTarget<Req & Def>, onConflictPred: function, onConflictUpdate: function, returning: function): Promise<Ret[]>

- Defined in zol.d.ts:271
Type parameters
- Req: any
- Def: any
- Ret: any
Parameters
- sqlTag: string | undefined
- conn: Client
- table: Table<Req, Def>
- rowValues: MakeTable<Req, Def>[]
- conflictTarget: ConflictTarget<Req & Def>
- onConflictPred: function
  - - (c: MakeCols<Write, Req & Def>): Col<Write, boolean>
    - Parameters
      - c: MakeCols<Write, Req & Def>
      Returns Col<Write, boolean>
- onConflictUpdate: function
  - - (c: MakeCols<Write, Req & Def>): MakeTable<Req, Def>
    - Parameters
      - c: MakeCols<Write, Req & Def>
      Returns MakeTable<Req, Def>
- returning: function
  - - (c: MakeCols<Write, Req & Def>): MakeCols<Write, Ret>
    - Parameters
      - c: MakeCols<Write, Req & Def>
      Returns MakeCols<Write, Ret>
Returns Promise<Ret[]>

insertManyReturning

insertManyReturning<Req, Def, Ret>(sqlTag: string | undefined, conn: Client, table: Table<Req, Def>, rowValues: MakeTable<Req, Def>[], returning: function): Promise<Ret[]>

- Defined in zol.d.ts:243
Type parameters
- Req: any
- Def: any
- Ret: any
Parameters
- sqlTag: string | undefined
- conn: Client
- table: Table<Req, Def>
- rowValues: MakeTable<Req, Def>[]
- returning: function
  - - (c: MakeCols<Write, Req & Def>): MakeCols<Write, Ret>
    - Parameters
      - c: MakeCols<Write, Req & Def>
      Returns MakeCols<Write, Ret>
Returns Promise<Ret[]>

insertOnConflictDoNothing

insertOnConflictDoNothing<Req, Def>(sqlTag: string | undefined, conn: Client, table: Table<Req, Def>, rowValues: MakeTable<Req, Def>, conflictTarget: ConflictTarget<Req & Def>): Promise<boolean>

- Defined in zol.d.ts:208
Type parameters
- Req: any
- Def: any
Parameters
- sqlTag: string | undefined
- conn: Client
- table: Table<Req, Def>
- rowValues: MakeTable<Req, Def>
- conflictTarget: ConflictTarget<Req & Def>
Returns Promise<boolean>

true if the row was inserted

insertOnConflictDoNothingReturning

insertOnConflictDoNothingReturning<Req, Def, Ret>(sqlTag: string | undefined, conn: Client, table: Table<Req, Def>, rowValues: MakeTable<Req, Def>, conflictTarget: ConflictTarget<Req & Def>, returning: function): Promise<Ret>

- Defined in zol.d.ts:200
Type parameters
- Req: any
- Def: any
- Ret: any
Parameters
- sqlTag: string | undefined
- conn: Client
- table: Table<Req, Def>
- rowValues: MakeTable<Req, Def>
- conflictTarget: ConflictTarget<Req & Def>
- returning: function
  - - (c: MakeCols<Write, Req & Def>): MakeCols<Write, Ret>
    - Parameters
      - c: MakeCols<Write, Req & Def>
      Returns MakeCols<Write, Ret>
Returns Promise<Ret>

insertOnConflictDoUpdate

insertOnConflictDoUpdate<Req, Def>(sqlTag: string | undefined, conn: Client, table: Table<Req, Def>, rowValues: MakeTable<Req, Def>, conflictTarget: ConflictTarget<Req & Def>, onConflictPred: function, onConflictUpdate: function): Promise<boolean>

- Defined in zol.d.ts:236
Type parameters
- Req: any
- Def: any
Parameters
- sqlTag: string | undefined
- conn: Client
- table: Table<Req, Def>
- rowValues: MakeTable<Req, Def>
- conflictTarget: ConflictTarget<Req & Def>
- onConflictPred: function
  - - (c: MakeCols<Write, Req & Def>): Col<Write, boolean>
    - Parameters
      - c: MakeCols<Write, Req & Def>
      Returns Col<Write, boolean>
- onConflictUpdate: function
  - - (c: MakeCols<Write, Req & Def>): MakeTable<Req, Def>
    - Parameters
      - c: MakeCols<Write, Req & Def>
      Returns MakeTable<Req, Def>
Returns Promise<boolean>

If a new row was inserted returns true.
```
    If a conflicting row already existed but was updated returns true.

    If a conflicting row already existed and was not updated returns false.
```

insertOnConflictDoUpdateReturning

insertOnConflictDoUpdateReturning<Req, Def, Ret>(sqlTag: string | undefined, conn: Client, table: Table<Req, Def>, rowValues: MakeTable<Req, Def>, conflictTarget: ConflictTarget<Req & Def>, onConflictPred: function, onConflictUpdate: function, returning: function): Promise<Ret>

- Defined in zol.d.ts:215
Type parameters
- Req: any
- Def: any
- Ret: any
Parameters
- sqlTag: string | undefined
- conn: Client
- table: Table<Req, Def>
- rowValues: MakeTable<Req, Def>
- conflictTarget: ConflictTarget<Req & Def>
- onConflictPred: function
  - - (c: MakeCols<Write, Req & Def>): Col<Write, boolean>
    - Parameters
      - c: MakeCols<Write, Req & Def>
      Returns Col<Write, boolean>
- onConflictUpdate: function
  - - (c: MakeCols<Write, Req & Def>): MakeTable<Req, Def>
    - Parameters
      - c: MakeCols<Write, Req & Def>
      Returns MakeTable<Req, Def>
- returning: function
  - - (c: MakeCols<Write, Req & Def>): MakeCols<Write, Ret>
    - Parameters
      - c: MakeCols<Write, Req & Def>
      Returns MakeCols<Write, Ret>
Returns Promise<Ret>

insertReturning

insertReturning<Req, Def, Ret>(sqlTag: string | undefined, conn: Client, table: Table<Req, Def>, rowValues: MakeTable<Req, Def>, returning: function): Promise<Ret>

- Defined in zol.d.ts:186
Type parameters
- Req: any
- Def: any
- Ret: any
Parameters
- sqlTag: string | undefined
- conn: Client
- table: Table<Req, Def>
- rowValues: MakeTable<Req, Def>
- returning: function
  - - (c: MakeCols<Write, Req & Def>): MakeCols<Write, Ret>
    - Parameters
      - c: MakeCols<Write, Req & Def>
      Returns MakeCols<Write, Ret>
Returns Promise<Ret>

isNotNull

isNotNull<s, a>(col: Col<s, a | null>): Col<s, boolean>

- Defined in zol.d.ts:461
Type parameters
- s
- a
Parameters
- col: Col<s, a | null>
Returns Col<s, boolean>

isNull

isNull<s, a>(col: Col<s, a | null>): Col<s, boolean>

- Defined in zol.d.ts:452
Type parameters
- s
- a
Parameters
- col: Col<s, a | null>
Returns Col<s, boolean>

leftJoin

leftJoin<s, a>(q: Q<s>, s: function, pred: function): LeftCols<s, a>

- Defined in zol.d.ts:393
Type parameters
- s
- a: any
Parameters
- q: Q<s>
- s: function
  - - (q: Q<Inner<s>>): MakeCols<Inner<s>, a>
    - Parameters
      - q: Q<Inner<s>>
      Returns MakeCols<Inner<s>, a>
- pred: function
  - - (p: MakeCols<s, a>): Col<s, boolean>
    - Parameters
      - p: MakeCols<s, a>
      Returns Col<s, boolean>
Returns LeftCols<s, a>

like

like<s>(str: Col<s, string>, pattern: string): Col<s, boolean>
like<s>(str: Col<s, string>, pattern: Col<s, string>): Col<s, boolean>

- Defined in zol.d.ts:485
Type parameters
- s
Parameters
- str: Col<s, string>
- pattern: string
Returns Col<s, boolean>
- Defined in zol.d.ts:495
Type parameters
- s
Parameters
- str: Col<s, string>
- pattern: Col<s, string>
Returns Col<s, boolean>

limit

limit<s, a>(q: Q<s>, from: number, to: number, query: function): MakeCols<s, a>

- Defined in zol.d.ts:425
Type parameters
- s
- a: any
Parameters
- q: Q<s>
- from: number
- to: number
- query: function
  - - (q: Q<Inner<s>>): MakeCols<Inner<s>, a>
    - Parameters
      - q: Q<Inner<s>>
      Returns MakeCols<Inner<s>, a>
Returns MakeCols<s, a>

matchNull

matchNull<s, s2, a, b>(nullable: Col<s, a | null>, replacement: Col<s, b>, f: function): Col<s, b>

- Defined in zol.d.ts:144
Type parameters
- s
- s2
- a
- b
Parameters
- nullable: Col<s, a | null>
- replacement: Col<s, b>
- f: function
  - - (col: Col<s2, a>): Col<s2, b>
    - Parameters
      - col: Col<s2, a>
      Returns Col<s2, b>
Returns Col<s, b>

max

max<s, a>(col: Col<s, a>): Aggr<s, a | null>

- Defined in zol.d.ts:68
Type parameters
- s
- a
Parameters
- col: Col<s, a>
Returns Aggr<s, a | null>

min

min<s, a>(col: Col<s, a>): Aggr<s, a | null>

- Defined in zol.d.ts:70
Type parameters
- s
- a
Parameters
- col: Col<s, a>
Returns Aggr<s, a | null>

not

not<s, a>(col: Col<s, a | null>): Col<s, boolean>

- Defined in zol.d.ts:468
Type parameters
- s
- a
Parameters
- col: Col<s, a | null>
Returns Col<s, boolean>

nullCol

nullCol<s>(): Col<s, null>

- Defined in zol.d.ts:108
Type parameters
- s
Returns Col<s, null>

numberCol

numberCol<s>(val: number): Col<s, number>

- Defined in zol.d.ts:110
Type parameters
- s
Parameters
- val: number
Returns Col<s, number>

order

order<s, a>(q: Q<s>, col: Col<s, a>, order: Order): void

- Defined in zol.d.ts:427
Type parameters
- s
- a
Parameters
- q: Q<s>
- col: Col<s, a>
- order: Order
Returns void

query

query<t>(sqlTag: string | undefined, conn: Client, q: function): Promise<t[]>

- Defined in zol.d.ts:327
Type parameters
- t: any
Parameters
- sqlTag: string | undefined
- conn: Client
- q: function
  - - (q: Q<__type>): MakeCols<__type, t>
    - Parameters
      - q: Q<__type>
      Returns MakeCols<__type, t>
Returns Promise<t[]>

queryOne

queryOne<t>(sqlTag: string | undefined, conn: Client, q: function): Promise<t>

- Defined in zol.d.ts:337
Type parameters
- t: any
Parameters
- sqlTag: string | undefined
- conn: Client
- q: function
  - - (q: Q<__type>): MakeCols<__type, t>
    - Parameters
      - q: Q<__type>
      Returns MakeCols<__type, t>
Returns Promise<t>

queryOneOrNone

queryOneOrNone<t>(sqlTag: string | undefined, conn: Client, q: function): Promise<t | null>

- Defined in zol.d.ts:347
Type parameters
- t: any
Parameters
- sqlTag: string | undefined
- conn: Client
- q: function
  - - (q: Q<__type>): MakeCols<__type, t>
    - Parameters
      - q: Q<__type>
      Returns MakeCols<__type, t>
Returns Promise<t | null>

queryStreaming

queryStreaming<t>(sqlTag: string | undefined, conn: Client, q: function, rowChunkSize?: number): Promise<StreamingRows<t>>

- Defined in zol.d.ts:360
Type parameters
- t: any
Parameters
- sqlTag: string | undefined
- conn: Client
- q: function
  - - (q: Q<__type>): MakeCols<__type, t>
    - Parameters
      - q: Q<__type>
      Returns MakeCols<__type, t>
- Optional rowChunkSize: number
Returns Promise<StreamingRows<t>>

restrict

restrict<s>(q: Q<s>, expr: Col<s, boolean>): void

- Defined in zol.d.ts:362
Type parameters
- s
Parameters
- q: Q<s>
- expr: Col<s, boolean>
Returns void

restrictEq

restrictEq<s, a>(q: Q<s>, lhs: Col<s, a>, rhs: Col<s, a>): void

- Defined in zol.d.ts:475
Type parameters
- s
- a
Parameters
- q: Q<s>
- lhs: Col<s, a>
- rhs: Col<s, a>
Returns void

select

select<s, a, b>(q: Q<s>, table: Table<a, b>): MakeCols<s, a & b>

- Defined in zol.d.ts:417
Type parameters
- s
- a: any
- b: any
Parameters
- q: Q<s>
- table: Table<a, b>
Returns MakeCols<s, a & b>

selectValues

selectValues<s, a>(q: Q<s>, vals: MakeCols<s, a>[]): MakeCols<s, a>

- Defined in zol.d.ts:423
Type parameters
- s
- a: any
Parameters
- q: Q<s>
- vals: MakeCols<s, a>[]
Returns MakeCols<s, a>

suchThat

suchThat<s, a>(q: Q<s>, query: function, pred: function): MakeCols<s, a>

- Defined in zol.d.ts:415
Type parameters
- s
- a: any
Parameters
- q: Q<s>
- query: function
  - - (q: Q<Inner<s>>): MakeCols<Inner<s>, a>
    - Parameters
      - q: Q<Inner<s>>
      Returns MakeCols<Inner<s>, a>
- pred: function
  - - (row: MakeCols<Inner<s>, a>): Col<Inner<s>, boolean>
    - Parameters
      - row: MakeCols<Inner<s>, a>
      Returns Col<Inner<s>, boolean>
Returns MakeCols<s, a>

sum

sum<s>(col: Col<s, number>): Aggr<s, number>

- Defined in zol.d.ts:66
Type parameters
- s
Parameters
- col: Col<s, number>
Returns Aggr<s, number>

textCol

textCol<s>(str: string): Col<s, string>

- Defined in zol.d.ts:112
Type parameters
- s
Parameters
- str: string
Returns Col<s, string>

update

update<Req, Def>(sqlTag: string | undefined, conn: Client, table: Table<Req, Def>, pred: function, upd: function): Promise<number>

- Defined in zol.d.ts:165
Type parameters
- Req: any
- Def: any
Parameters
- sqlTag: string | undefined
- conn: Client
- table: Table<Req, Def>
- pred: function
  - - (c: MakeCols<Write, Req & Def>): Col<Write, boolean>
    - Parameters
      - c: MakeCols<Write, Req & Def>
      Returns Col<Write, boolean>
- upd: function
  - - (c: MakeCols<Write, Req & Def>): MakeTable<Req, Def>
    - Parameters
      - c: MakeCols<Write, Req & Def>
      Returns MakeTable<Req, Def>
Returns Promise<number>

number of rows updated

updateReturning

updateReturning<Req, Def, Ret>(sqlTag: string | undefined, conn: Client, table: Table<Req, Def>, pred: function, upd: function, returning: function): Promise<Ret[]>

- Defined in zol.d.ts:179
Type parameters
- Req: any
- Def: any
- Ret: any
Parameters
- sqlTag: string | undefined
- conn: Client
- table: Table<Req, Def>
- pred: function
  - - (c: MakeCols<Write, Req & Def>): Col<Write, boolean>
    - Parameters
      - c: MakeCols<Write, Req & Def>
      Returns Col<Write, boolean>
- upd: function
  - - (c: MakeCols<Write, Req & Def>): MakeTable<Req, Def>
    - Parameters
      - c: MakeCols<Write, Req & Def>
      Returns MakeTable<Req, Def>
- returning: function
  - - (c: MakeCols<Write, Req & Def>): MakeCols<Write, Ret>
    - Parameters
      - c: MakeCols<Write, Req & Def>
      Returns MakeCols<Write, Ret>
Returns Promise<Ret[]>

Generated using TypeDoc

Index

Modules

Enumerations

Classes

Interfaces

Type aliases

Functions

Type aliases

AggrCols

Type declaration

LeftCols

Type declaration

MakeCols

Type declaration

MakeTable

TableDeclareCols

Type declaration

Functions

aggregate

Type parameters

s

a: any

Parameters

q: Q<s>

s: function

Parameters

q: Q<Inner<s>>

Returns AggrCols<s, a>

Returns MakeCols<s, a>

arbitrary

Type parameters

s

Returns Col<s, Arbitrary>

avg

Type parameters

s

Parameters

col: Col<s, number>

Returns Aggr<s, number | null>

booleanCol

Type parameters

s

Parameters

val: boolean

Returns Col<s, boolean>

count

Type parameters

s

a

Parameters

col: Col<s, a>

Returns Aggr<s, number>

declareTable

Type parameters

Req: any

Def: any

Parameters

tableName: string

columns: TableDeclareCols<Req & Def>

Returns Table<Req, Def>

defaultValue

Returns DefaultValue

delete_

Type parameters

Req: any

Def: any

Parameters

sqlTag: string | undefined

conn: Client

table: Table<Req, Def>

pred: function

Parameters

c: MakeCols<Write, Req & Def>

Returns Col<Write, boolean>

Returns Promise<number>

distinct

Type parameters

s

a: any

Parameters