Interface IDatabaseTableQuery

Interface for a key-value database table query.

interface IDatabaseTableQuery {
    limit?: number;
    offset?: number;
    orderBy?: {
        direction: "asc" | "desc";
        key: string;
    };
    where?: IDatabaseTableQueryWhereValue | IDatabaseTableQueryWhereValues | IDatabaseTableQueryWhereBetween;
}

Index

Properties

limit? offset? orderBy? where?

Properties

`Optional` limit

limit?: number

The limit for the query, allowing pagination.

`Optional` offset

offset?: number

The offset for the query, allowing pagination.

`Optional` orderBy

orderBy?: {
direction: "asc" | "desc";
key: string;
}

The order by clause for the query. The key must be a valid indexed key path for the table and match the where clause key, if provided.

Type declaration

direction: "asc" | "desc"
key: string

`Optional` where

where?: IDatabaseTableQueryWhereValue | IDatabaseTableQueryWhereValues | IDatabaseTableQueryWhereBetween

The where clause for the query.

Generated using TypeDoc