Class default

Implementation of TablesApiClient that goes through the REST API

Hierarchy

default
- default

Index

Constructors

Properties

Methods

createOrReplaceTable createTable deleteTable

Constructors

constructor

new default(sqlClient: default): default
Parameters
- sqlClient: default
  
  SQL API client to send all SQL query requests.
Returns default
Overrides default.constructor
- Defined in src/tables/tablesRestApiClient.ts:16

Properties

sqlClient

sqlClient: default

SQL API client to send all SQL query requests.

Methods

createOrReplaceTable

createOrReplaceTable(name: string, integration: string, select: string): Promise<default>
Creates a table in an integration from a given SELECT statement. If the table already exists, it is deleted first and then recreated.

Returns
- Newly created/replaced table.
Throws
- Something went wrong creating or replacing the table.
Parameters
- name: string
  
  Name of table to be created/replaced.
- integration: string
  
  Name of integration the table will be a part of.
- select: string
  
  SELECT statement to use for populating the new/replaced table with data.
Returns Promise<default>
Overrides default.createOrReplaceTable
- Defined in src/tables/tablesRestApiClient.ts:56

createTable

createTable(name: string, integration: string, select: string): Promise<default>
Creates a table in an integration from a given SELECT statement.

Returns
- Newly created table.
Throws
- Something went wrong creating the table.
Parameters
- name: string
  
  Name of table to be created.
- integration: string
  
  Name of integration the table will be a part of.
- select: string
  
  SELECT statement to use for populating the new table with data.
Returns Promise<default>
Overrides default.createTable
- Defined in src/tables/tablesRestApiClient.ts:29

deleteTable

deleteTable(name: string, integration: string): Promise<void>
Deletes a table from its integration.

Throws
- Something went wrong deleting the table.
Parameters
- name: string
  
  Name of the table to be deleted.
- integration: string
  
  Name of the integration the table to be deleted is a part of.
Returns Promise<void>
Overrides default.deleteTable
- Defined in src/tables/tablesRestApiClient.ts:80

Generated using TypeDoc