DataQuery

Represents a data query

Extends

• Func

Extended by

• TableQuery

Constructors

new DataQuery()

new DataQuery(dart): DataQuery

Parameters

Parameter	Type
dart	any

Returns

DataQuery

Overrides

Func . constructor

Constructs

DataQuery

Source

src/entities.ts:446

Properties

Property	Modifier	Type	Inherited from
aux	public	any	Func.aux
dart	public	any	Func.dart
options	public	object	Func.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:451

---

author

get author(): User

Who created entity *

Returns

User

Source

src/entities.ts:124

---

connection

get connection(): DataConnection

set connection(c): void

Parameters

Parameter	Type
c	DataConnection

Returns

DataConnection

Source

src/entities.ts:459

---

createdOn

get createdOn(): Dayjs

Time when entity was created *

Returns

Dayjs

Source

src/entities.ts:115

---

description

get description(): string

Returns

string

Source

src/entities.ts:259

---

friendlyName

get friendlyName(): string

Entity friendly name

set friendlyName(x): void

Parameters

Parameter	Type
x	string

Returns

string

Source

src/entities.ts:101

---

helpUrl

get helpUrl(): string

Help URL.

set helpUrl(url): void

Parameters

Parameter	Type
url	string

Returns

string

Source

src/entities.ts:266

---

id

get id(): string

Entity ID (GUID)

set id(x): void

Parameters

Parameter	Type
x	string

Returns

string

Source

src/entities.ts:93

---

inputs

get inputs(): Property[]

Input parameters

Returns

Property[]

Source

src/entities.ts:289

---

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:276

---

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

---

outputs

get outputs(): Property[]

Output parameters

Returns

Property[]

Source

src/entities.ts:294

---

package

get package(): Package

A package this function belongs to.

Returns

Package

Source

src/entities.ts:271

---

path

get path(): string

Entity path

Returns

string

Source

src/entities.ts:263

---

postProcessScript

get postProcessScript(): string

set postProcessScript(script): void

Parameters

Parameter	Type
script	string

Returns

string

Source

src/entities.ts:462

---

query

get query(): string

Query text

set query(q): void

Parameters

Parameter	Type
q	string

Returns

string

Source

src/entities.ts:456

---

type

get type(): string

Returns

string

Source

src/entities.ts:261

---

updatedOn

get updatedOn(): null | Dayjs

Time when entity was updated *

Returns

null | Dayjs

Source

src/entities.ts:118

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

Func . apply

Source

src/entities.ts:302

---

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

Func . applySync

Source

src/entities.ts:318

---

executeTable()

executeTable(): Promise <DataFrame>

Executes query

Returns

Promise <DataFrame>

Source

src/entities.ts:466

---

getProperties()

getProperties(): Promise<object>

Gets entity properties

Returns

Promise<object>

Inherited from

Func . getProperties

Source

src/entities.ts:127

---

hasTag()

hasTag(tag): boolean

Parameters

Parameter	Type
tag	string

Returns

boolean

Inherited from

Func . hasTag

Source

src/entities.ts:139

---

newId()

newId(): void

Generates new id for this entity.

Returns

void

Inherited from

Func . newId

Source

src/entities.ts:97

---

prepare()

prepare(parameters): FuncCall

Returns FuncCall object in a stand-by state

Parameters

Parameter	Type
parameters	object

Returns

FuncCall

Inherited from

Func . prepare

Source

src/entities.ts:279

---

prepareAsync()

prepareAsync(parameters): Promise <FuncCall>

Parameters

Parameter	Type
parameters	object

Returns

Promise <FuncCall>

Inherited from

Func . prepareAsync

Source

src/entities.ts:283

---

setProperties()

setProperties(props): Promise<any>

Sets entity properties

Parameters

Parameter	Type
props	object

Returns

Promise<any>

Inherited from

Func . setProperties

Source

src/entities.ts:132

---

tag()

tag(tag): boolean

Adds a specified tag

Parameters

Parameter	Type
tag	string

Returns

boolean

Inherited from

Func . tag

Source

src/entities.ts:142

---

toString()

toString(): string

Returns a string representing the object

Returns

string

Inherited from

Func . toString

Source

src/entities.ts:137

---

unTag()

unTag(tag): boolean

Removes a specified tag

Parameters

Parameter	Type
tag	string

Returns

boolean

Inherited from

Func . unTag

Source

src/entities.ts:145

---

byName()

static byName(name): Func

Returns a function with the specified name.

Parameters

Parameter	Type
name	string

Returns

Func

Inherited from

Func . byName

Source

src/entities.ts:339

---

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

Func . find

Source

src/entities.ts:323

---

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

Func . findAll

Deprecated

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

Source

src/entities.ts:330