Class default

Implementation of ViewsApiClient that goes through the REST API

Hierarchy

default
- default

Index

Constructors

Properties

Methods

createView deleteView getAllViews

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/views/viewsRestApiClient.ts:17

Properties

sqlClient

sqlClient: default

SQL API client to send all SQL query requests.

Methods

createView

createView(name: string, project: string, select: string): Promise<default>
Creates a view using the given select statement

Returns
- Newly created view.
Throws
- Something went wrong while creating the view.
Parameters
- name: string
  
  Name of the view to create.
- project: string
  
  Project the view will be created in.
- select: string
  
  SELECT statement to use for initializing the view.
Returns Promise<default>
Overrides default.createView
- Defined in src/views/viewsRestApiClient.ts:46

deleteView

deleteView(name: string, project: string): Promise<void>
Deletes a view from the project it belongs to.

Throws
- Something went wrong while deleting the view.
Parameters
- name: string
  
  Name of the view to delete.
- project: string
  
  Project the view belongs to.
Returns Promise<void>
Overrides default.deleteView
- Defined in src/views/viewsRestApiClient.ts:67

getAllViews

getAllViews(project: string): Promise<default[]>
Gets all views for the given project.

Returns
- All views for the given project name.
Parameters
- project: string
  
  Project name to get all views from.
Returns Promise<default[]>
Overrides default.getAllViews
- Defined in src/views/viewsRestApiClient.ts:27

Generated using TypeDoc