DataSourceApi | @inetsoft/api-client

DataSourceApi provides operations used to list and manage data sources.

Hierarchy

DataSourceApi

Index

Methods

Methods

deleteDataSource

deleteDataSource(name: string, force?: undefined | false | true): Promise<void>

- Defined in client/datasource/data-source-api.ts:199
Deletes a data source.

Parameters
- name: string
  
  the name of the data source.
- Optional force: undefined | false | true
  
  a flag indicating if the data source should be deleted even if it is used by a query.
Returns Promise<void>

getDataSource

getDataSource(name: string): Promise<DataSourceProperties | null>

- Defined in client/datasource/data-source-api.ts:182
Gets the properties of a data source.

Parameters
- name: string
  
  the name of the data source.
Returns Promise<DataSourceProperties | null>

the data source properties.

getDataSources

getDataSources(): Promise<DataSourceDescription[]>

- Defined in client/datasource/data-source-api.ts:173
Gets the list of data sources.

Returns Promise<DataSourceDescription[]>

the data sources.

updateDataSource

updateDataSource(name: string, properties: DataSourceProperties): Promise<void>

- Defined in client/datasource/data-source-api.ts:190
Updates the properties of an existing data source.

Parameters
- name: string
  
  the name of the data source.
- properties: DataSourceProperties
  
  the modified data source properties.
Returns Promise<void>

Generated using TypeDoc