Class: DataConnection

dg.DataConnection

Represents a data connection

Hierarchy

• Entity

  ↳ DataConnection

Constructors

constructor

• new DataConnection(dart)

Constructs

DataConnection

Parameters

Name	Type
dart	any

Overrides

Entity.constructor

Defined in

src/entities.ts:559

Properties

dart

• dart: any

Inherited from

Entity.dart

Defined in

src/entities.ts:67

---

parameters

• parameters: any

Defined in

src/entities.ts:556

Accessors

author

• get author(): User

Who created entity *

Returns

User

Inherited from

Entity.author

Defined in

src/entities.ts:104

---

createdOn

• get createdOn(): Dayjs

Time when entity was created *

Returns

Dayjs

Inherited from

Entity.createdOn

Defined in

src/entities.ts:98

---

credentials

• get credentials(): Credentials

Returns

Credentials

Defined in

src/entities.ts:564

---

friendlyName

• get friendlyName(): string

Entity friendly name

Returns

string

Inherited from

Entity.friendlyName

Defined in

src/entities.ts:84

• set friendlyName(x): void

Parameters

Name	Type
x	string

Returns

void

Inherited from

Entity.friendlyName

Defined in

src/entities.ts:85

---

id

• get id(): string

Entity ID (GUID)

Returns

string

Inherited from

Entity.id

Defined in

src/entities.ts:76

• set id(x): void

Parameters

Name	Type
x	string

Returns

void

Inherited from

Entity.id

Defined in

src/entities.ts:77

---

name

• get name(): string

Entity short name

Returns

string

Inherited from

Entity.name

Defined in

src/entities.ts:88

• set name(x): void

Parameters

Name	Type
x	string

Returns

void

Inherited from

Entity.name

Defined in

src/entities.ts:89

---

nqName

• get nqName(): string

Entity full-qualified name

Returns

string

Inherited from

Entity.nqName

Defined in

src/entities.ts:92

---

path

• get path(): string

Entity path

Returns

string

Inherited from

Entity.path

Defined in

src/entities.ts:95

---

updatedOn

• get updatedOn(): Dayjs

Time when entity was updated *

Returns

Dayjs

Inherited from

Entity.updatedOn

Defined in

src/entities.ts:101

Methods

getProperties

▸ getProperties(): Promise<{ [index: string]: any; }>

Gets entity properties

Returns

Promise<{ [index: string]: any; }>

Inherited from

Entity.getProperties

Defined in

src/entities.ts:107

---

hasTag

▸ hasTag(tag): boolean

Parameters

Name	Type
tag	string

Returns

boolean

Inherited from

Entity.hasTag

Defined in

src/entities.ts:119

---

newId

▸ newId(): void

Generates new id for this entity.

Returns

void

Inherited from

Entity.newId

Defined in

src/entities.ts:80

---

query

▸ query(name, sql): DataQuery

Creates DataQuery using this connection. Can be used only with database connections.

Parameters

Name	Type	Description
name	string	name of the query
sql	string	text of the query

Returns

DataQuery

Defined in

src/entities.ts:582

---

setProperties

▸ setProperties(props): Promise<any>

Sets entity properties

Parameters

Name	Type
props	Object

Returns

Promise<any>

Inherited from

Entity.setProperties

Defined in

src/entities.ts:112

---

tag

▸ tag(tag): boolean

Adds a specified tag

Parameters

Name	Type
tag	string

Returns

boolean

Inherited from

Entity.tag

Defined in

src/entities.ts:122

---

test

▸ test(): Promise<string>

Tests the connection, returns "ok" on success or an error message on error

Returns

Promise<string>

Defined in

src/entities.ts:573

---

toString

▸ toString(): string

Returns a string representing the object

Returns

string

Inherited from

Entity.toString

Defined in

src/entities.ts:117

---

unTag

▸ unTag(tag): boolean

Removes a specified tag

Parameters

Name	Type
tag	string

Returns

boolean

Inherited from

Entity.unTag

Defined in

src/entities.ts:125

---

create

▸ Static create(name, parameters): DataConnection

Creates a data connection. Note that in order to be used, it has to be saved first using DataConnectionsDataSource

Parameters

Name	Type	Description
name	string	Connection name
parameters	DataConnectionProperties	Connection properties

Returns

DataConnection

Defined in

src/entities.ts:591