diff --git a/classes/BasicAuth.html b/classes/BasicAuth.html index a579f017..82ba605e 100644 --- a/classes/BasicAuth.html +++ b/classes/BasicAuth.html @@ -1,5 +1,5 @@ -BasicAuth | trino-client

Class BasicAuth

Implements

Constructors

constructor +BasicAuth | trino-client

Class BasicAuth

Implements

Constructors

constructor

Properties

password? type username -

Constructors

constructor

Properties

Optional Readonly password

password?: string

Readonly type

type: string = 'basic'

Readonly username

username: string

Settings

Member Visibility

Theme

On This Page

constructorpasswordtypeusername
\ No newline at end of file +

Constructors

constructor

Properties

Optional Readonly password

password?: string

Readonly type

type: string = 'basic'

Readonly username

username: string

Settings

Member Visibility

Theme

On This Page

constructorpasswordtypeusername
\ No newline at end of file diff --git a/classes/Iterator.html b/classes/Iterator.html index 87242f9e..90633a6d 100644 --- a/classes/Iterator.html +++ b/classes/Iterator.html @@ -1,16 +1,16 @@ -Iterator | trino-client

Class Iterator<T>

Type Parameters

  • T

Implements

  • AsyncIterableIterator<T>

Constructors

constructor +Iterator | trino-client

Class Iterator<T>

Type Parameters

  • T

Implements

  • AsyncIterableIterator<T>

Constructors

constructor

Properties

iter

Methods

[asyncIterator] fold forEach map next -

Constructors

constructor

Properties

Private Readonly iter

iter: AsyncIterableIterator<T>

Methods

[asyncIterator]

  • [asyncIterator](): AsyncIterableIterator<T>

  • Returns AsyncIterableIterator<T>

fold

  • fold<B>(acc, fn): Promise<B>

  • Calls a defined callback function on each QueryResult. The return value of the callback function is the accumulated +

Constructors

constructor

Properties

Private Readonly iter

iter: AsyncIterableIterator<T>

Methods

[asyncIterator]

  • [asyncIterator](): AsyncIterableIterator<T>

  • Returns AsyncIterableIterator<T>

fold

  • fold<B>(acc, fn): Promise<B>

  • Calls a defined callback function on each QueryResult. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type Parameters

    • B

    Parameters

    • acc: B

      The initial value of the accumulator.

    • fn: ((value, acc) => B)

      A function that accepts a QueryResult and accumulator, and returns an accumulator.

      -
        • (value, acc): B

        • Parameters

          • value: T
          • acc: B

          Returns B

    Returns Promise<B>

forEach

  • forEach(fn): Promise<void>

  • Performs the specified action for each element.

    +
      • (value, acc): B

      • Parameters

        • value: T
        • acc: B

        Returns B

Returns Promise<B>

forEach

map

Returns Promise<void>

map

next

Settings

Member Visibility

Theme

On This Page

constructoriter[asyncIterator]foldforEachmapnext
\ No newline at end of file +

Returns Iterator<B>

next

Settings

Member Visibility

Theme

On This Page

constructoriter[asyncIterator]foldforEachmapnext
\ No newline at end of file diff --git a/classes/QueryIterator.html b/classes/QueryIterator.html index f8992a57..a177765b 100644 --- a/classes/QueryIterator.html +++ b/classes/QueryIterator.html @@ -1,13 +1,13 @@ QueryIterator | trino-client

Class QueryIterator

Iterator for the query result data.

-

Implements

Constructors

constructor +

Implements

Constructors

constructor

Properties

client queryResult

Methods

[asyncIterator] hasNext next -

Constructors

constructor

Properties

Private Readonly client

client: Client

Private queryResult

queryResult: QueryResult

Methods

[asyncIterator]

  • [asyncIterator](): AsyncIterableIterator<QueryResult>

  • Returns AsyncIterableIterator<QueryResult>

hasNext

  • hasNext(): boolean

  • It returns true if the queryResult object has a nextUri property, and false otherwise

    +

Constructors

constructor

Properties

Private Readonly client

client: Client

Private queryResult

queryResult: QueryResult

Methods

[asyncIterator]

  • [asyncIterator](): AsyncIterableIterator<QueryResult>

  • Returns AsyncIterableIterator<QueryResult>

hasNext

  • hasNext(): boolean

  • It returns true if the queryResult object has a nextUri property, and false otherwise

    Returns boolean

    A boolean value.

    -

next

  • next(): Promise<IteratorResult<QueryResult, any>>

  • Retrieves the next QueryResult available. If there's no nextUri then there are no more +

next

  • next(): Promise<IteratorResult<QueryResult, any>>

  • Retrieves the next QueryResult available. If there's no nextUri then there are no more results and the query reached a completion state, successful or failure.

    Returns Promise<IteratorResult<QueryResult, any>>

    The next set of results.

    -

Settings

Member Visibility

Theme

On This Page

constructorclientqueryResult[asyncIterator]hasNextnext
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorclientqueryResult[asyncIterator]hasNextnext
\ No newline at end of file diff --git a/classes/Trino.html b/classes/Trino.html index 04eee314..dff7a6ed 100644 --- a/classes/Trino.html +++ b/classes/Trino.html @@ -1,17 +1,17 @@ Trino | trino-client

Class Trino

Trino is a client for the Trino REST API.

-

Constructors

constructor +

Constructors

constructor

Properties

client

Methods

cancel query queryInfo create -

Constructors

Private constructor

Properties

Private Readonly client

client: Client

Methods

cancel

  • cancel(queryId): Promise<QueryResult>

  • It cancels a query.

    +

Constructors

Private constructor

Properties

Private Readonly client

client: Client

Methods

cancel

  • cancel(queryId): Promise<QueryResult>

  • It cancels a query.

    Parameters

    • queryId: string

      The queryId of the query to cancel.

    Returns Promise<QueryResult>

    The result of the query.

    -

query

  • query(query): Promise<Iterator<QueryResult>>

  • Submittes a query for execution and returns a QueryIterator object that can be used to iterate over the query results.

    +

query

  • query(query): Promise<Iterator<QueryResult>>

  • Submittes a query for execution and returns a QueryIterator object that can be used to iterate over the query results.

    Parameters

    • query: string | Query

      The query to execute.

    Returns Promise<Iterator<QueryResult>>

    A QueryIterator object.

    -

queryInfo

  • queryInfo(queryId): Promise<QueryInfo>

  • Retrieves the query info for a given queryId.

    +

queryInfo

  • queryInfo(queryId): Promise<QueryInfo>

  • Retrieves the query info for a given queryId.

    Parameters

    • queryId: string

      The query to execute.

    Returns Promise<QueryInfo>

    The query info

    -

Static create

Settings

Member Visibility

Theme

On This Page

constructorclientcancelqueryqueryInfocreate
\ No newline at end of file +

Static create

Settings

Member Visibility

Theme

On This Page

constructorclientcancelqueryqueryInfocreate
\ No newline at end of file diff --git a/interfaces/Auth.html b/interfaces/Auth.html index 594d4424..fd922a06 100644 --- a/interfaces/Auth.html +++ b/interfaces/Auth.html @@ -1,2 +1,2 @@ -Auth | trino-client

Interface Auth

interface Auth {
    type: string;
}

Implemented by

Properties

type -

Properties

Readonly type

type: string

Settings

Member Visibility

Theme

On This Page

type
\ No newline at end of file +Auth | trino-client

Interface Auth

interface Auth {
    type: string;
}

Implemented by

Properties

type +

Properties

Readonly type

type: string

Settings

Member Visibility

Theme

On This Page

type
\ No newline at end of file diff --git a/types/AuthType.html b/types/AuthType.html index 03daf5b2..c95022be 100644 --- a/types/AuthType.html +++ b/types/AuthType.html @@ -1 +1 @@ -AuthType | trino-client

Type alias AuthType

AuthType: string

Settings

Member Visibility

Theme

\ No newline at end of file +AuthType | trino-client

Type alias AuthType

AuthType: string

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/Columns.html b/types/Columns.html index e21c2abd..b44aff8f 100644 --- a/types/Columns.html +++ b/types/Columns.html @@ -1 +1 @@ -Columns | trino-client

Type alias Columns

Columns: {
    name: string;
    type: string;
}[]

Type declaration

  • name: string
  • type: string

Settings

Member Visibility

Theme

\ No newline at end of file +Columns | trino-client

Type alias Columns

Columns: {
    name: string;
    type: string;
}[]

Type declaration

  • name: string
  • type: string

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/ConnectionOptions.html b/types/ConnectionOptions.html index ffc89f25..a6d7afac 100644 --- a/types/ConnectionOptions.html +++ b/types/ConnectionOptions.html @@ -1 +1 @@ -ConnectionOptions | trino-client

Type alias ConnectionOptions

ConnectionOptions: {
    auth?: Auth;
    catalog?: string;
    extraCredential?: ExtraCredential;
    schema?: string;
    server?: string;
    session?: Session;
    source?: string;
    ssl?: SecureContextOptions;
}

Type declaration

  • Optional Readonly auth?: Auth
  • Optional Readonly catalog?: string
  • Optional Readonly extraCredential?: ExtraCredential
  • Optional Readonly schema?: string
  • Optional Readonly server?: string
  • Optional Readonly session?: Session
  • Optional Readonly source?: string
  • Optional Readonly ssl?: SecureContextOptions

Settings

Member Visibility

Theme

\ No newline at end of file +ConnectionOptions | trino-client

Type alias ConnectionOptions

ConnectionOptions: {
    auth?: Auth;
    catalog?: string;
    extraCredential?: ExtraCredential;
    schema?: string;
    server?: string;
    session?: Session;
    source?: string;
    ssl?: SecureContextOptions;
}

Type declaration

  • Optional Readonly auth?: Auth
  • Optional Readonly catalog?: string
  • Optional Readonly extraCredential?: ExtraCredential
  • Optional Readonly schema?: string
  • Optional Readonly server?: string
  • Optional Readonly session?: Session
  • Optional Readonly source?: string
  • Optional Readonly ssl?: SecureContextOptions

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/ExtraCredential.html b/types/ExtraCredential.html index 8ec82828..310b2bfe 100644 --- a/types/ExtraCredential.html +++ b/types/ExtraCredential.html @@ -1 +1 @@ -ExtraCredential | trino-client

Type alias ExtraCredential

ExtraCredential: {
    [key: string]: string;
}

Type declaration

  • [key: string]: string

Settings

Member Visibility

Theme

\ No newline at end of file +ExtraCredential | trino-client

Type alias ExtraCredential

ExtraCredential: {
    [key: string]: string;
}

Type declaration

  • [key: string]: string

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/Query.html b/types/Query.html index ebc06257..29a3cce7 100644 --- a/types/Query.html +++ b/types/Query.html @@ -1 +1 @@ -Query | trino-client

Type alias Query

Query: {
    catalog?: string;
    extraCredential?: ExtraCredential;
    extraHeaders?: RequestHeaders;
    query: string;
    schema?: string;
    session?: Session;
    user?: string;
}

Type declaration

  • Optional catalog?: string
  • Optional extraCredential?: ExtraCredential
  • Optional extraHeaders?: RequestHeaders
  • query: string
  • Optional schema?: string
  • Optional session?: Session
  • Optional user?: string

Settings

Member Visibility

Theme

\ No newline at end of file +Query | trino-client

Type alias Query

Query: {
    catalog?: string;
    extraCredential?: ExtraCredential;
    extraHeaders?: RequestHeaders;
    query: string;
    schema?: string;
    session?: Session;
    user?: string;
}

Type declaration

  • Optional catalog?: string
  • Optional extraCredential?: ExtraCredential
  • Optional extraHeaders?: RequestHeaders
  • query: string
  • Optional schema?: string
  • Optional session?: Session
  • Optional user?: string

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/QueryData.html b/types/QueryData.html index 35c4d5ca..108c387f 100644 --- a/types/QueryData.html +++ b/types/QueryData.html @@ -1 +1 @@ -QueryData | trino-client

Type alias QueryData

QueryData: any[]

Settings

Member Visibility

Theme

\ No newline at end of file +QueryData | trino-client

Type alias QueryData

QueryData: any[]

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/QueryError.html b/types/QueryError.html index 9e886db2..38fb7452 100644 --- a/types/QueryError.html +++ b/types/QueryError.html @@ -1 +1 @@ -QueryError | trino-client

Type alias QueryError

QueryError: {
    errorCode: number;
    errorName: string;
    errorType: string;
    failureInfo: QueryFailureInfo;
    message: string;
}

Type declaration

  • errorCode: number
  • errorName: string
  • errorType: string
  • failureInfo: QueryFailureInfo
  • message: string

Settings

Member Visibility

Theme

\ No newline at end of file +QueryError | trino-client

Type alias QueryError

QueryError: {
    errorCode: number;
    errorName: string;
    errorType: string;
    failureInfo: QueryFailureInfo;
    message: string;
}

Type declaration

  • errorCode: number
  • errorName: string
  • errorType: string
  • failureInfo: QueryFailureInfo
  • message: string

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/QueryFailureInfo.html b/types/QueryFailureInfo.html index 8ec24791..6d9c7194 100644 --- a/types/QueryFailureInfo.html +++ b/types/QueryFailureInfo.html @@ -1 +1 @@ -QueryFailureInfo | trino-client

Type alias QueryFailureInfo

QueryFailureInfo: {
    message: string;
    stack: string[];
    suppressed: string[];
    type: string;
}

Type declaration

  • message: string
  • stack: string[]
  • suppressed: string[]
  • type: string

Settings

Member Visibility

Theme

\ No newline at end of file +QueryFailureInfo | trino-client

Type alias QueryFailureInfo

QueryFailureInfo: {
    message: string;
    stack: string[];
    suppressed: string[];
    type: string;
}

Type declaration

  • message: string
  • stack: string[]
  • suppressed: string[]
  • type: string

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/QueryInfo.html b/types/QueryInfo.html index 40fe0e9c..e7e51d5d 100644 --- a/types/QueryInfo.html +++ b/types/QueryInfo.html @@ -1 +1 @@ -QueryInfo | trino-client

Type alias QueryInfo

QueryInfo: {
    failureInfo?: QueryFailureInfo;
    query: string;
    queryId: string;
    state: string;
}

Type declaration

  • Optional failureInfo?: QueryFailureInfo
  • query: string
  • queryId: string
  • state: string

Settings

Member Visibility

Theme

\ No newline at end of file +QueryInfo | trino-client

Type alias QueryInfo

QueryInfo: {
    failureInfo?: QueryFailureInfo;
    query: string;
    queryId: string;
    state: string;
}

Type declaration

  • Optional failureInfo?: QueryFailureInfo
  • query: string
  • queryId: string
  • state: string

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/QueryResult.html b/types/QueryResult.html index a0840d19..94e8b602 100644 --- a/types/QueryResult.html +++ b/types/QueryResult.html @@ -1 +1 @@ -QueryResult | trino-client

Type alias QueryResult

QueryResult: {
    columns?: Columns;
    data?: QueryData[];
    error?: QueryError;
    id: string;
    infoUri?: string;
    nextUri?: string;
    stats?: QueryStats;
    warnings?: string[];
}

Type declaration

  • Optional columns?: Columns
  • Optional data?: QueryData[]
  • Optional error?: QueryError
  • id: string
  • Optional infoUri?: string
  • Optional nextUri?: string
  • Optional stats?: QueryStats
  • Optional warnings?: string[]

Settings

Member Visibility

Theme

\ No newline at end of file +QueryResult | trino-client

Type alias QueryResult

QueryResult: {
    columns?: Columns;
    data?: QueryData[];
    error?: QueryError;
    id: string;
    infoUri?: string;
    nextUri?: string;
    stats?: QueryStats;
    warnings?: string[];
}

Type declaration

  • Optional columns?: Columns
  • Optional data?: QueryData[]
  • Optional error?: QueryError
  • id: string
  • Optional infoUri?: string
  • Optional nextUri?: string
  • Optional stats?: QueryStats
  • Optional warnings?: string[]

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/QueryStage.html b/types/QueryStage.html index 8cf84ffd..355dc8d0 100644 --- a/types/QueryStage.html +++ b/types/QueryStage.html @@ -1 +1 @@ -QueryStage | trino-client

Type alias QueryStage

QueryStage: {
    completedSplits: number;
    coordinatorOnly: boolean;
    cpuTimeMillis: number;
    done: boolean;
    failedTasks: number;
    nodes: number;
    physicalInputBytes: number;
    processedBytes: number;
    processedRows: number;
    queuedSplits: number;
    runningSplits: number;
    stageId: string;
    state: string;
    subStages: QueryStage[];
    totalSplits: number;
    wallTimeMillis: number;
}

Type declaration

  • completedSplits: number
  • coordinatorOnly: boolean
  • cpuTimeMillis: number
  • done: boolean
  • failedTasks: number
  • nodes: number
  • physicalInputBytes: number
  • processedBytes: number
  • processedRows: number
  • queuedSplits: number
  • runningSplits: number
  • stageId: string
  • state: string
  • subStages: QueryStage[]
  • totalSplits: number
  • wallTimeMillis: number

Settings

Member Visibility

Theme

\ No newline at end of file +QueryStage | trino-client

Type alias QueryStage

QueryStage: {
    completedSplits: number;
    coordinatorOnly: boolean;
    cpuTimeMillis: number;
    done: boolean;
    failedTasks: number;
    nodes: number;
    physicalInputBytes: number;
    processedBytes: number;
    processedRows: number;
    queuedSplits: number;
    runningSplits: number;
    stageId: string;
    state: string;
    subStages: QueryStage[];
    totalSplits: number;
    wallTimeMillis: number;
}

Type declaration

  • completedSplits: number
  • coordinatorOnly: boolean
  • cpuTimeMillis: number
  • done: boolean
  • failedTasks: number
  • nodes: number
  • physicalInputBytes: number
  • processedBytes: number
  • processedRows: number
  • queuedSplits: number
  • runningSplits: number
  • stageId: string
  • state: string
  • subStages: QueryStage[]
  • totalSplits: number
  • wallTimeMillis: number

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/QueryStats.html b/types/QueryStats.html index 92f508ba..19ac9074 100644 --- a/types/QueryStats.html +++ b/types/QueryStats.html @@ -1 +1 @@ -QueryStats | trino-client

Type alias QueryStats

QueryStats: {
    completedSplits: number;
    cpuTimeMillis: number;
    elapsedTimeMillis: number;
    nodes: number;
    peakMemoryBytes: number;
    physicalInputBytes: number;
    processedBytes: number;
    processedRows: number;
    progressPercentage: number;
    queued: boolean;
    queuedSplits: number;
    queuedTimeMillis: number;
    rootStage: QueryStage;
    runningSplits: number;
    scheduled: boolean;
    spilledBytes: number;
    state: string;
    totalSplits: number;
    wallTimeMillis: number;
}

Type declaration

  • completedSplits: number
  • cpuTimeMillis: number
  • elapsedTimeMillis: number
  • nodes: number
  • peakMemoryBytes: number
  • physicalInputBytes: number
  • processedBytes: number
  • processedRows: number
  • progressPercentage: number
  • queued: boolean
  • queuedSplits: number
  • queuedTimeMillis: number
  • rootStage: QueryStage
  • runningSplits: number
  • scheduled: boolean
  • spilledBytes: number
  • state: string
  • totalSplits: number
  • wallTimeMillis: number

Settings

Member Visibility

Theme

\ No newline at end of file +QueryStats | trino-client

Type alias QueryStats

QueryStats: {
    completedSplits: number;
    cpuTimeMillis: number;
    elapsedTimeMillis: number;
    nodes: number;
    peakMemoryBytes: number;
    physicalInputBytes: number;
    processedBytes: number;
    processedRows: number;
    progressPercentage: number;
    queued: boolean;
    queuedSplits: number;
    queuedTimeMillis: number;
    rootStage: QueryStage;
    runningSplits: number;
    scheduled: boolean;
    spilledBytes: number;
    state: string;
    totalSplits: number;
    wallTimeMillis: number;
}

Type declaration

  • completedSplits: number
  • cpuTimeMillis: number
  • elapsedTimeMillis: number
  • nodes: number
  • peakMemoryBytes: number
  • physicalInputBytes: number
  • processedBytes: number
  • processedRows: number
  • progressPercentage: number
  • queued: boolean
  • queuedSplits: number
  • queuedTimeMillis: number
  • rootStage: QueryStage
  • runningSplits: number
  • scheduled: boolean
  • spilledBytes: number
  • state: string
  • totalSplits: number
  • wallTimeMillis: number

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/RequestHeaders.html b/types/RequestHeaders.html index 934b6c05..b5092a35 100644 --- a/types/RequestHeaders.html +++ b/types/RequestHeaders.html @@ -1 +1 @@ -RequestHeaders | trino-client

Type alias RequestHeaders

RequestHeaders: {
    [key: string]: string;
}

Type declaration

  • [key: string]: string

Settings

Member Visibility

Theme

\ No newline at end of file +RequestHeaders | trino-client

Type alias RequestHeaders

RequestHeaders: {
    [key: string]: string;
}

Type declaration

  • [key: string]: string

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/SecureContextOptions.html b/types/SecureContextOptions.html index 5d4fbd5a..b97e30ee 100644 --- a/types/SecureContextOptions.html +++ b/types/SecureContextOptions.html @@ -1 +1 @@ -SecureContextOptions | trino-client

Type alias SecureContextOptions

SecureContextOptions: tls.SecureContextOptions & {
    rejectUnauthorized?: boolean;
}

Type declaration

  • Optional Readonly rejectUnauthorized?: boolean

Settings

Member Visibility

Theme

\ No newline at end of file +SecureContextOptions | trino-client

Type alias SecureContextOptions

SecureContextOptions: tls.SecureContextOptions & {
    rejectUnauthorized?: boolean;
}

Type declaration

  • Optional Readonly rejectUnauthorized?: boolean

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/Session.html b/types/Session.html index 9555aaad..8b3da556 100644 --- a/types/Session.html +++ b/types/Session.html @@ -1 +1 @@ -Session | trino-client

Type alias Session

Session: {
    [key: string]: string;
}

Type declaration

  • [key: string]: string

Settings

Member Visibility

Theme

\ No newline at end of file +Session | trino-client

Type alias Session

Session: {
    [key: string]: string;
}

Type declaration

  • [key: string]: string

Settings

Member Visibility

Theme

\ No newline at end of file