TableQuery

Represents a table query

Extends

• DataQuery

Constructors

new TableQuery()

new TableQuery(dart): TableQuery

Parameters

Parameter	Type
dart	any

Returns

TableQuery

Overrides

DataQuery . constructor

Constructs

TableQuery

Source

src/entities.ts:474

Properties

Property	Modifier	Type	Inherited from
aux	public	any	DataQuery.aux
dart	public	any	DataQuery.dart
options	public	object	DataQuery.options

Accessors

adHoc

get adHoc(): boolean

Deprecated

Use FuncCall.adHoc instead *

set adHoc(a): void

Deprecated

Use FuncCall.adHoc instead *

Parameters

Parameter	Type
a	boolean

Returns

boolean

Source

src/entities.ts:452

---

aggregations

get aggregations(): GroupAggregation[]

Aggregation clauses {queryPartParams}

set aggregations(wl): void

Parameters

Parameter	Type
wl	GroupAggregation[]

Returns

GroupAggregation[]

Source

src/entities.ts:501

---

author

get author(): User

Who created entity *

Returns

User

Source

src/entities.ts:125

---

connection

get connection(): DataConnection

set connection(c): void

Parameters

Parameter	Type
c	DataConnection

Returns

DataConnection

Source

src/entities.ts:460

---

createdOn

get createdOn(): Dayjs

Time when entity was created *

Returns

Dayjs

Source

src/entities.ts:116

---

description

get description(): string

Returns

string

Source

src/entities.ts:260

---

fields

get fields(): string[]

Fields array

set fields(fields): void

Parameters

Parameter	Type
fields	string[]

Returns

string[]

Source

src/entities.ts:490

---

friendlyName

get friendlyName(): string

Entity friendly name

set friendlyName(x): void

Parameters

Parameter	Type
x	string

Returns

string

Source

src/entities.ts:102

---

having

get having(): FieldPredicate[]

Having clauses

set having(wl): void

Parameters

Parameter	Type
wl	FieldPredicate[]

Returns

FieldPredicate[]

Source

src/entities.ts:508

---

helpUrl

get helpUrl(): string

Help URL.

set helpUrl(url): void

Parameters

Parameter	Type
url	string

Returns

string

Source

src/entities.ts:267

---

id

get id(): string

Entity ID (GUID)

set id(x): void

Parameters

Parameter	Type
x	string

Returns

string

Source

src/entities.ts:94

---

inputs

get inputs(): Property[]

Input parameters

Returns

Property[]

Source

src/entities.ts:290

---

isVectorFunc

get isVectorFunc(): boolean

Indicates that the function (or script) is already vector, meaning it accepts vector input (an entire column) and processes it in a single call, rather than being executed separately for each scalar element (row)

Returns

boolean

Source

src/entities.ts:277

---

joins

get joins(): TableJoin[]

set joins(j): void

Parameters

Parameter	Type
j	TableJoin[]

Returns

TableJoin[]

Source

src/entities.ts:504

---

limit

get limit(): undefined | number

set limit(rows): void

Parameters

Parameter	Type
rows	undefined | number

Returns

undefined | number

Source

src/entities.ts:516

---

name

get name(): string

Entity short name

set name(x): void

Parameters

Parameter	Type
x	string

Returns

string

Source

src/entities.ts:106

---

nqName

get nqName(): string

Entity full-qualified name

Returns

string

Source

src/entities.ts:110

---

orderBy

get orderBy(): FieldOrder[]

Order By clauses

set orderBy(wl): void

Parameters

Parameter	Type
wl	FieldOrder[]

Returns

FieldOrder[]

Source

src/entities.ts:512

---

outputs

get outputs(): Property[]

Output parameters

Returns

Property[]

Source

src/entities.ts:295

---

package

get package(): Package

A package this function belongs to.

Returns

Package

Source

src/entities.ts:272

---

path

get path(): string

Entity path

Returns

string

Source

src/entities.ts:264

---

postProcessScript

get postProcessScript(): string

set postProcessScript(script): void

Parameters

Parameter	Type
script	string

Returns

string

Source

src/entities.ts:463

---

query

get query(): string

Query text

set query(q): void

Parameters

Parameter	Type
q	string

Returns

string

Source

src/entities.ts:457

---

table

get table(): string

Table name

set table(tableName): void

Parameters

Parameter	Type
tableName	string

Returns

string

Source

src/entities.ts:485

---

type

get type(): string

Returns

string

Source

src/entities.ts:262

---

updatedOn

get updatedOn(): null | Dayjs

Time when entity was updated *

Returns

null | Dayjs

Source

src/entities.ts:119

---

where

get where(): FieldPredicate[]

Where clauses

set where(wl): void

Parameters

Parameter	Type
wl	FieldPredicate[]

Returns

FieldPredicate[]

Source

src/entities.ts:497

Methods

apply()

apply(parameters): Promise<any>

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

Parameters

Parameter	Type
parameters	any[] | object

Returns

Promise<any>

Inherited from

DataQuery . apply

Source

src/entities.ts:303

---

applySync()

applySync(parameters): any

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

Parameters

Parameter	Type
parameters	object

Returns

any

Inherited from

DataQuery . applySync

Source

src/entities.ts:319

---

executeTable()

executeTable(): Promise <DataFrame>

Executes query

Returns

Promise <DataFrame>

Overrides

DataQuery . executeTable

Source

src/entities.ts:494

---

getProperties()

getProperties(): Promise<object>

Gets entity properties

Returns

Promise<object>

Inherited from

DataQuery . getProperties

Source

src/entities.ts:128

---

hasTag()

hasTag(tag): boolean

Parameters

Parameter	Type
tag	string

Returns

boolean

Inherited from

DataQuery . hasTag

Source

src/entities.ts:140

---

newId()

newId(): void

Generates new id for this entity.

Returns

void

Inherited from

DataQuery . newId

Source

src/entities.ts:98

---

prepare()

prepare(parameters): FuncCall

Returns FuncCall object in a stand-by state

Parameters

Parameter	Type
parameters	object

Returns

FuncCall

Inherited from

DataQuery . prepare

Source

src/entities.ts:280

---

prepareAsync()

prepareAsync(parameters): Promise <FuncCall>

Parameters

Parameter	Type
parameters	object

Returns

Promise <FuncCall>

Inherited from

DataQuery . prepareAsync

Source

src/entities.ts:284

---

setProperties()

setProperties(props): Promise<any>

Sets entity properties

Parameters

Parameter	Type
props	object

Returns

Promise<any>

Inherited from

DataQuery . setProperties

Source

src/entities.ts:133

---

tag()

tag(tag): boolean

Adds a specified tag

Parameters

Parameter	Type
tag	string

Returns

boolean

Inherited from

DataQuery . tag

Source

src/entities.ts:143

---

toString()

toString(): string

Returns a string representing the object

Returns

string

Inherited from

DataQuery . toString

Source

src/entities.ts:138

---

unTag()

unTag(tag): boolean

Removes a specified tag

Parameters

Parameter	Type
tag	string

Returns

boolean

Inherited from

DataQuery . unTag

Source

src/entities.ts:146

---

byName()

static byName(name): Func

Returns a function with the specified name.

Parameters

Parameter	Type
name	string

Returns

Func

Inherited from

DataQuery . byName

Source

src/entities.ts:340

---

create()

static create(connection): TableQuery

Creates a TableQuery

Parameters

Parameter	Type	Description
connection	DataConnection	DataConnection to query table from

Returns

TableQuery

Source

src/entities.ts:479

---

find()

static find(params?): Func[]

Returns functions with the specified attributes.

Parameters

Parameter	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

Source

src/entities.ts:324

---

findAll()

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

Parameters

Parameter	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

Deprecated

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

Source

src/entities.ts:331

---

from()

static from(table): TableQueryBuilder

Creates TableQueryBuilder from table name

Parameters

Parameter	Type	Description
table	string	Table name

Returns

TableQueryBuilder

Source

src/entities.ts:521

---

fromTable()

static fromTable(table): TableQueryBuilder

Creates TableQueryBuilder from TableInfo

Parameters

Parameter	Type	Description
table	TableInfo	TableInfo object

Returns

TableQueryBuilder

Source

src/entities.ts:526