Interface QueryOptions

interface QueryOptions {
    bigints: boolean;
    format: DataFormat | DataFormat[];
    name: string;
    portal: string;
    streams: Record<string, Writable>;
    transform: ((name) => string);
    types: DataType[];
}

Properties

bigints format name portal streams transform types

Properties

Readonly bigints

bigints: boolean

Use bigint for the INT8 (64-bit integer) data type.

Readonly format

format: DataFormat | DataFormat[]

Whether column data should be transferred using text or binary mode.

Readonly name

name: string

The query name.

Readonly portal

portal: string

Whether to use the default portal (i.e. unnamed) or provide a name.

Readonly streams

streams: Record<string, Writable>

A mapping from column name to a socket, e.g. an open file.

Readonly transform

transform: ((name) => string)

Allows the transformation of column names as returned by the database.

Type declaration

    • (name): string

    • Parameters

      • name: string

      Returns string

Readonly types

types: DataType[]

Allows making the database native type explicit for some or all columns.

Settings

Member Visibility

Theme

On This Page

bigintsformatnameportalstreamstransformtypes