DataConnection

Represents a data connection

Extends

• Entity

Constructors

new DataConnection()

new DataConnection(dart): DataConnection

Parameters

Parameter	Type
dart	any

Returns

DataConnection

Overrides

Entity . constructor

Constructs

DataConnection

Source

src/entities.ts:758

Properties

Property	Modifier	Type	Inherited from
dart	public	any	Entity.dart
parameters	public	any	-

Accessors

author

get author(): User

Who created entity *

Returns

User

Source

src/entities.ts:124

---

createdOn

get createdOn(): Dayjs

Time when entity was created *

Returns

Dayjs

Source

src/entities.ts:115

---

credentials

get credentials(): Credentials

Returns

Credentials

Source

src/entities.ts:763

---

dataSource

get dataSource(): string

Returns

string

Source

src/entities.ts:767

---

friendlyName

get friendlyName(): string

Entity friendly name

set friendlyName(x): void

Parameters

Parameter	Type
x	string

Returns

string

Source

src/entities.ts:101

---

id

get id(): string

Entity ID (GUID)

set id(x): void

Parameters

Parameter	Type
x	string

Returns

string

Source

src/entities.ts:93

---

name

get name(): string

Entity short name

set name(x): void

Parameters

Parameter	Type
x	string

Returns

string

Source

src/entities.ts:105

---

nqName

get nqName(): string

Entity full-qualified name

Returns

string

Source

src/entities.ts:109

---

path

get path(): string

Entity path

Returns

string

Source

src/entities.ts:112

---

updatedOn

get updatedOn(): null | Dayjs

Time when entity was updated *

Returns

null | Dayjs

Source

src/entities.ts:118

Methods

buildQuery()

buildQuery(table): TableQueryBuilder

Parameters

Parameter	Type
table	string

Returns

TableQueryBuilder

Source

src/entities.ts:789

---

getProperties()

getProperties(): Promise<object>

Gets entity properties

Returns

Promise<object>

Inherited from

Entity . getProperties

Source

src/entities.ts:127

---

hasTag()

hasTag(tag): boolean

Parameters

Parameter	Type
tag	string

Returns

boolean

Inherited from

Entity . hasTag

Source

src/entities.ts:139

---

newId()

newId(): void

Generates new id for this entity.

Returns

void

Inherited from

Entity . newId

Source

src/entities.ts:97

---

query()

query(name, sql): DataQuery

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

Parameters

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

Returns

DataQuery

Source

src/entities.ts:785

---

setProperties()

setProperties(props): Promise<any>

Sets entity properties

Parameters

Parameter	Type
props	object

Returns

Promise<any>

Inherited from

Entity . setProperties

Source

src/entities.ts:132

---

tableQuery()

tableQuery(tableName): TableQuery

Parameters

Parameter	Type
tableName	string

Returns

TableQuery

Source

src/entities.ts:793

---

tag()

tag(tag): boolean

Adds a specified tag

Parameters

Parameter	Type
tag	string

Returns

boolean

Inherited from

Entity . tag

Source

src/entities.ts:142

---

test()

test(): Promise<string>

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

Returns

Promise<string>

Source

src/entities.ts:776

---

toString()

toString(): string

Returns a string representing the object

Returns

string

Inherited from

Entity . toString

Source

src/entities.ts:137

---

unTag()

unTag(tag): boolean

Removes a specified tag

Parameters

Parameter	Type
tag	string

Returns

boolean

Inherited from

Entity . unTag

Source

src/entities.ts:145

---

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

Parameter	Type	Description
name	string	Connection name
parameters	DataConnectionProperties	Connection properties

Returns

DataConnection

Source

src/entities.ts:802