Skip to main content

Datasource

Datalayer Core

Datalayer Core / Datasource

Class: Datasource

Defined in: src/models/Datasource.ts:186

Datasource domain model for the Datalayer SDK. Provides state management and operations for datasources.

Example​

const datasource = await sdk.createDatasource({
  type: 'Amazon Athena',
  name: 'my-athena-datasource',
  description: 'Production Athena datasource',
  database: 'my_database',
  output_bucket: 's3://my-bucket/output/'
});

await datasource.update({ description: 'Updated description' });
await datasource.delete();

Constructors​

Constructor​

new Datasource(data, sdk): DatasourceDTO

Defined in: src/models/Datasource.ts:197

Create a Datasource instance.

Parameters​

data​

DatasourceData

Datasource data from API

sdk​

DatalayerClient

SDK instance

Returns​

DatasourceDTO

Properties​

_data​

_data: DatasourceData

Defined in: src/models/Datasource.ts:188

Internal

Accessors​

createdAt​

Get Signature​

get createdAt(): Date | undefined

Defined in: src/models/Datasource.ts:253

Returns​

Date | undefined

database​

Get Signature​

get database(): string | undefined

Defined in: src/models/Datasource.ts:243

Returns​

string | undefined

description​

Get Signature​

get description(): string

Defined in: src/models/Datasource.ts:238

Returns​

string

name​

Get Signature​

get name(): string

Defined in: src/models/Datasource.ts:233

Returns​

string

outputBucket​

Get Signature​

get outputBucket(): string | undefined

Defined in: src/models/Datasource.ts:248

Returns​

string | undefined

type​

Get Signature​

get type(): DatasourceType

Defined in: src/models/Datasource.ts:223

Returns​

DatasourceType

uid​

Get Signature​

get uid(): string

Defined in: src/models/Datasource.ts:218

Returns​

string

updatedAt​

Get Signature​

get updatedAt(): Date | undefined

Defined in: src/models/Datasource.ts:258

Returns​

Date | undefined

variant​

Get Signature​

get variant(): string | undefined

Defined in: src/models/Datasource.ts:228

Returns​

string | undefined

Methods​

delete()​

delete(): Promise<void>

Defined in: src/models/Datasource.ts:281

Delete this datasource permanently.

Returns​

Promise<void>

rawData()​

rawData(): DatasourceData

Defined in: src/models/Datasource.ts:313

Get raw datasource data exactly as received from API.

Returns​

DatasourceData

toJSON()​

toJSON(): DatasourceJSON

Defined in: src/models/Datasource.ts:294

Get datasource data in camelCase format.

Returns​

DatasourceJSON

toString()​

toString(): string

Defined in: src/models/Datasource.ts:318

Returns​

string

update()​

update(updates): Promise<DatasourceDTO>

Defined in: src/models/Datasource.ts:272

Update this datasource.

Parameters​

updates​

UpdateDatasourceRequest

Fields to update

Returns​

Promise<DatasourceDTO>

Updated Datasource instance