Class: TableQuery

dg.TableQuery

Represents a table query

Hierarchy

• DataQuery

  ↳ TableQuery

Constructors

constructor

• new TableQuery(dart)

Constructs

TableQeury

Parameters

Name	Type
dart	any

Overrides

DataQuery.constructor

Defined in

src/entities.ts:422

Properties

aux

• aux: any

Inherited from

DataQuery.aux

Defined in

src/entities.ts:220

---

dart

• dart: any

Inherited from

DataQuery.dart

Defined in

src/entities.ts:67

---

options

• options: Object

Index signature

▪ [key: string]: any

Inherited from

DataQuery.options

Defined in

src/entities.ts:221

Accessors

adHoc

• get adHoc(): boolean

Deprecated

Use FuncCall.adHoc instead *

Returns

boolean

Inherited from

DataQuery.adHoc

Defined in

src/entities.ts:402

• set adHoc(a): void

Deprecated

Use FuncCall.adHoc instead *

Parameters

Name	Type
a	boolean

Returns

void

Inherited from

DataQuery.adHoc

Defined in

src/entities.ts:404

---

aggregations

• get aggregations(): GroupAggregation[]

Aggregation clauses {queryPartParams}

Returns

GroupAggregation[]

Defined in

src/entities.ts:449

• set aggregations(wl): void

Parameters

Name	Type
wl	GroupAggregation[]

Returns

void

Defined in

src/entities.ts:450

---

author

• get author(): User

Who created entity *

Returns

User

Inherited from

DataQuery.author

Defined in

src/entities.ts:104

---

connection

• get connection(): DataConnection

Returns

DataConnection

Inherited from

DataQuery.connection

Defined in

src/entities.ts:410

• set connection(c): void

Parameters

Name	Type
c	DataConnection

Returns

void

Inherited from

DataQuery.connection

Defined in

src/entities.ts:411

---

createdOn

• get createdOn(): Dayjs

Time when entity was created *

Returns

Dayjs

Inherited from

DataQuery.createdOn

Defined in

src/entities.ts:98

---

description

• get description(): string

Returns

string

Inherited from

DataQuery.description

Defined in

src/entities.ts:230

---

fields

• get fields(): string[]

Fields array

Returns

string[]

Defined in

src/entities.ts:438

• set fields(fields): void

Parameters

Name	Type
fields	string[]

Returns

void

Defined in

src/entities.ts:439

---

friendlyName

• get friendlyName(): string

Entity friendly name

Returns

string

Inherited from

DataQuery.friendlyName

Defined in

src/entities.ts:84

• set friendlyName(x): void

Parameters

Name	Type
x	string

Returns

void

Inherited from

DataQuery.friendlyName

Defined in

src/entities.ts:85

---

having

• get having(): FieldPredicate[]

Having clauses

Returns

FieldPredicate[]

Defined in

src/entities.ts:453

• set having(wl): void

Parameters

Name	Type
wl	FieldPredicate[]

Returns

void

Defined in

src/entities.ts:454

---

helpUrl

• get helpUrl(): string

Help URL.

Returns

string

Inherited from

DataQuery.helpUrl

Defined in

src/entities.ts:237

---

id

• get id(): string

Entity ID (GUID)

Returns

string

Inherited from

DataQuery.id

Defined in

src/entities.ts:76

• set id(x): void

Parameters

Name	Type
x	string

Returns

void

Inherited from

DataQuery.id

Defined in

src/entities.ts:77

---

inputs

• get inputs(): Property[]

Input parameters

Returns

Property[]

Inherited from

DataQuery.inputs

Defined in

src/entities.ts:248

---

name

• get name(): string

Entity short name

Returns

string

Inherited from

DataQuery.name

Defined in

src/entities.ts:88

• set name(x): void

Parameters

Name	Type
x	string

Returns

void

Inherited from

DataQuery.name

Defined in

src/entities.ts:89

---

nqName

• get nqName(): string

Entity full-qualified name

Returns

string

Inherited from

DataQuery.nqName

Defined in

src/entities.ts:92

---

orderBy

• get orderBy(): FieldOrder[]

Order By clauses

Returns

FieldOrder[]

Defined in

src/entities.ts:457

• set orderBy(wl): void

Parameters

Name	Type
wl	FieldOrder[]

Returns

void

Defined in

src/entities.ts:458

---

outputs

• get outputs(): Property[]

Output parameters

Returns

Property[]

Inherited from

DataQuery.outputs

Defined in

src/entities.ts:253

---

package

• get package(): Package

A package this function belongs to.

Returns

Package

Inherited from

DataQuery.package

Defined in

src/entities.ts:240

---

path

• get path(): string

Entity path

Returns

string

Inherited from

DataQuery.path

Defined in

src/entities.ts:234

---

query

• get query(): string

Query text

Returns

string

Inherited from

DataQuery.query

Defined in

src/entities.ts:407

• set query(q): void

Parameters

Name	Type
q	string

Returns

void

Inherited from

DataQuery.query

Defined in

src/entities.ts:408

---

table

• get table(): string

Table name

Returns

string

Defined in

src/entities.ts:433

• set table(tableName): void

Parameters

Name	Type
tableName	string

Returns

void

Defined in

src/entities.ts:434

---

type

• get type(): string

Returns

string

Inherited from

DataQuery.type

Defined in

src/entities.ts:232

---

updatedOn

• get updatedOn(): Dayjs

Time when entity was updated *

Returns

Dayjs

Inherited from

DataQuery.updatedOn

Defined in

src/entities.ts:101

---

where

• get where(): FieldPredicate[]

Where clauses

Returns

FieldPredicate[]

Defined in

src/entities.ts:445

• set where(wl): void

Parameters

Name	Type
wl	FieldPredicate[]

Returns

void

Defined in

src/entities.ts:446

Methods

apply

▸ apply(parameters?): Promise<any>

Executes the function with the specified {link parameters}, and returns result. If necessary, the corresponding package will be loaded as part of the call.

Parameters

Name	Type
parameters	any[] | { [name: string]: any; }

Returns

Promise<any>

Inherited from

DataQuery.apply

Defined in

src/entities.ts:261

---

applySync

▸ applySync(parameters?): any

Executes the function synchronously, and returns the result. If the function is asynchronous, throws an exception.

Parameters

Name	Type
parameters	Object

Returns

any

Inherited from

DataQuery.applySync

Defined in

src/entities.ts:277

---

executeTable

▸ executeTable(): Promise<DataFrame>

Executes query

Returns

Promise<DataFrame>

Overrides

DataQuery.executeTable

Defined in

src/entities.ts:442

---

getProperties

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

Gets entity properties

Returns

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

Inherited from

DataQuery.getProperties

Defined in

src/entities.ts:107

---

hasTag

▸ hasTag(tag): boolean

Parameters

Name	Type
tag	string

Returns

boolean

Inherited from

DataQuery.hasTag

Defined in

src/entities.ts:119

---

newId

▸ newId(): void

Generates new id for this entity.

Returns

void

Inherited from

DataQuery.newId

Defined in

src/entities.ts:80

---

prepare

▸ prepare(parameters?): FuncCall

Returns FuncCall object in a stand-by state

Parameters

Name	Type
parameters	Object

Returns

FuncCall

Inherited from

DataQuery.prepare

Defined in

src/entities.ts:243

---

setProperties

▸ setProperties(props): Promise<any>

Sets entity properties

Parameters

Name	Type
props	Object

Returns

Promise<any>

Inherited from

DataQuery.setProperties

Defined in

src/entities.ts:112

---

tag

▸ tag(tag): boolean

Adds a specified tag

Parameters

Name	Type
tag	string

Returns

boolean

Inherited from

DataQuery.tag

Defined in

src/entities.ts:122

---

toString

▸ toString(): string

Returns a string representing the object

Returns

string

Inherited from

DataQuery.toString

Defined in

src/entities.ts:117

---

unTag

▸ unTag(tag): boolean

Removes a specified tag

Parameters

Name	Type
tag	string

Returns

boolean

Inherited from

DataQuery.unTag

Defined in

src/entities.ts:125

---

byName

▸ Static byName(name): Func

Returns a function with the specified name.

Parameters

Name	Type
name	string

Returns

Func

Inherited from

DataQuery.byName

Defined in

src/entities.ts:298

---

create

▸ Static create(connection): TableQuery

Creates a TableQuery

Parameters

Name	Type	Description
connection	DataConnection	DataConnection to query table from

Returns

TableQuery

Defined in

src/entities.ts:427

---

find

▸ Static find(params?): Func[]

Returns functions with the specified attributes.

Parameters

Name	Type
params?	Object
params.meta?	any
params.name?	string
params.package?	string
params.returnSemType?	string
params.returnType?	string
params.tags?	string[]

Returns

Func[]

Inherited from

DataQuery.find

Defined in

src/entities.ts:282

---

findAll

▸ Static findAll(params?): Promise<Func[]>

Deprecated

Use find, it's the same now but does not make a server query and synchronous.

Parameters

Name	Type
params?	Object
params.meta?	any
params.name?	string
params.package?	string
params.returnSemType?	string
params.returnType?	string
params.tags?	string[]

Returns

Promise<Func[]>

Inherited from

DataQuery.findAll

Defined in

src/entities.ts:289

---

from

▸ Static from(table): TableQueryBuilder

Creates TableQueryBuilder from table name

Parameters

Name	Type	Description
table	string	Table name

Returns

TableQueryBuilder

Defined in

src/entities.ts:463

---

fromTable

▸ Static fromTable(table): TableQueryBuilder

Creates TableQueryBuilder from TableInfo

Parameters

Name	Type	Description
table	TableInfo	TableInfo object

Returns

TableQueryBuilder

Defined in

src/entities.ts:468