Class default

Class to perform SQL operations through the REST API.

See

Hierarchy

default
- default

Index

Constructors

Properties

authenticator client

Methods

getQueryUrl makeQueryResult runQuery

Constructors

constructor

new default(client: Axios, authenticator: default): default
Parameters
- client: Axios
  
  Axios instance used for all requests.
- authenticator: default
Returns default
Overrides default.constructor
- Defined in src/sql/sqlRestApiClient.ts:26

Properties

authenticator

authenticator: default

Authenticator to use for reauthenticating if needed.

client

client: Axios

Axios instance to send all requests.

Methods

`Private` getQueryUrl

getQueryUrl(): string
Returns
SQL query endpoint to send API requests to.

Returns string
- Defined in src/sql/sqlRestApiClient.ts:35

`Private` makeQueryResult

makeQueryResult(response: default): default
Returns a structured query result from the raw SQL query API response.

Returns
- A structured query result in an easier to use format.
Parameters
- response: default
  
  The raw API response data from the /api/sql/query endpoint.
Returns default
- Defined in src/sql/sqlRestApiClient.ts:47

runQuery

runQuery(query: string): Promise<default>
Runs the given SQL query on the backend.

Returns
- A structured query result from running the raw SQL query.
Throws
- Something went wrong sending the API request.
Parameters
- query: string
  
  The raw SQL query to run.
Returns Promise<default>
Overrides default.runQuery
- Defined in src/sql/sqlRestApiClient.ts:82

Generated using TypeDoc