Options
All
  • Public
  • Public/Protected
  • All
Menu

Class QueriesApi

QueriesApi - object-oriented interface

export

Hierarchy

Index

Constructors

constructor

Properties

Protected basePath

basePath: string

Protected configuration

configuration: Configuration

Protected fetch

fetch: FetchAPI

Methods

getQueryPlan

  • Fetch a query plan from Rockset's planner for a given SQL query.

    summary

    Plan Query

    throws

    {RequiredError}

    memberof

    QueriesApi

    Parameters

    Returns Promise<QueryResponse>

getQueryStats

  • Fetch execution statistics for a particular query.

    summary

    Fetch Query Stats

    throws

    {RequiredError}

    memberof

    QueriesApi

    Parameters

    • queryId: string
    • Optional options: any

    Returns Promise<QueryStatsResponse>

query

validate

  • Validate a SQL query with Rockset's parser and planner.

    summary

    Validate Query

    throws

    {RequiredError}

    memberof

    QueriesApi

    Parameters

    • body: QueryRequest

      JSON object

    • Optional parameters: undefined | false | true
    • Optional options: any

    Returns Promise<ValidateQueryResponse>

validateExpression

Generated using TypeDoc