Skip to content
delta-base docs

QueryOptions

API reference for QueryOptions

@delta-base/toolkit

Interface: QueryOptions

Section titled “Interface: QueryOptions”

Query options with common parameters

Indexable

Section titled “Indexable”

[key: string]: unknown

Properties

Section titled “Properties”

cacheTtl?

Section titled “cacheTtl?”

optional cacheTtl: number

consistency?

Section titled “consistency?”

optional consistency: "strong" | "eventual"

cursor?

Section titled “cursor?”

optional cursor: string

limit?

Section titled “limit?”

optional limit: number

offset?

Section titled “offset?”

optional offset: number

prefix?

Section titled “prefix?”

optional prefix: string

sort?

Section titled “sort?”

optional sort: object[]

direction

Section titled “direction”

direction: "asc" | "desc"

field

Section titled “field”

field: string

tableName?

Section titled “tableName?”

optional tableName: string

type?

Section titled “type?”

optional type: "text" | "json" | "arrayBuffer" | "stream"