DataQuery

Defined in: js-api/src/entities/data-connection.ts:23

Represents a data query

Extends

• Func

Extended by

• TableQuery

Constructors

Constructor

new DataQuery(dart): DataQuery

Defined in: js-api/src/entities/data-connection.ts:25

Parameters

Parameter	Type
dart	any

Returns

DataQuery

Constructs

DataQuery

Overrides

Func.constructor

Properties

Property	Modifier	Type	Inherited from	Defined in
aux	public	any	Func.aux	js-api/src/entities/func.ts:26
dart	public	any	Func.dart	js-api/src/entities/entity.ts:19
options	public	object	Func.options	js-api/src/entities/func.ts:27

Accessors

adHoc

Get Signature

get adHoc(): boolean

Defined in: js-api/src/entities/data-connection.ts:30

Deprecated

Use FuncCall.adHoc instead *

Returns

boolean

Set Signature

set adHoc(a): void

Defined in: js-api/src/entities/data-connection.ts:32

Deprecated

Use FuncCall.adHoc instead *

Parameters

Parameter	Type
a	boolean

Returns

void

---

author

Get Signature

get author(): any

Defined in: js-api/src/entities/entity.ts:59

Who created entity *

Returns

any

Inherited from

Func.author

---

connection

Get Signature

get connection(): DataConnection

Defined in: js-api/src/entities/data-connection.ts:38

Returns

DataConnection

Set Signature

set connection(c): void

Defined in: js-api/src/entities/data-connection.ts:39

Parameters

Parameter	Type
c	DataConnection

Returns

void

---

createdOn

Get Signature

get createdOn(): Dayjs

Defined in: js-api/src/entities/entity.ts:50

Time when entity was created *

Returns

Dayjs

Inherited from

Func.createdOn

---

description

Get Signature

get description(): string

Defined in: js-api/src/entities/func.ts:36

Returns

string

Set Signature

set description(s): void

Defined in: js-api/src/entities/func.ts:37

Parameters

Parameter	Type
s	string

Returns

void

Inherited from

Func.description

---

entityType

Get Signature

get entityType(): string

Defined in: js-api/src/entities/entity.ts:66

Entity type name *

Returns

string

Inherited from

Func.entityType

---

friendlyName

Get Signature

get friendlyName(): string

Defined in: js-api/src/entities/entity.ts:36

Entity friendly name

Returns

string

Set Signature

set friendlyName(x): void

Defined in: js-api/src/entities/entity.ts:37

Parameters

Parameter	Type
x	string

Returns

void

Inherited from

Func.friendlyName

---

helpUrl

Get Signature

get helpUrl(): string

Defined in: js-api/src/entities/func.ts:44

Help URL.

Returns

string

Set Signature

set helpUrl(url): void

Defined in: js-api/src/entities/func.ts:46

Parameters

Parameter	Type
url	string

Returns

void

Inherited from

Func.helpUrl

---

id

Get Signature

get id(): string

Defined in: js-api/src/entities/entity.ts:28

Entity ID (GUID)

Returns

string

Set Signature

set id(x): void

Defined in: js-api/src/entities/entity.ts:29

Parameters

Parameter	Type
x	string

Returns

void

Inherited from

Func.id

---

inputs

Get Signature

get inputs(): Property[]

Defined in: js-api/src/entities/func.ts:72

Input parameters

Returns

Property[]

Inherited from

Func.inputs

---

isVectorFunc

Get Signature

get isVectorFunc(): boolean

Defined in: js-api/src/entities/func.ts:54

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

Inherited from

Func.isVectorFunc

---

name

Get Signature

get name(): string

Defined in: js-api/src/entities/entity.ts:40

Entity short name

Returns

string

Set Signature

set name(x): void

Defined in: js-api/src/entities/entity.ts:41

Parameters

Parameter	Type
x	string

Returns

void

Inherited from

Func.name

---

nqName

Get Signature

get nqName(): string

Defined in: js-api/src/entities/entity.ts:44

Entity full-qualified name

Returns

string

Inherited from

Func.nqName

---

outputs

Get Signature

get outputs(): Property[]

Defined in: js-api/src/entities/func.ts:77

Output parameters

Returns

Property[]

Inherited from

Func.outputs

---

package

Get Signature

get package(): any

Defined in: js-api/src/entities/func.ts:49

A package this function belongs to, or null for core functions (e.g. Sin).

Returns

any

Inherited from

Func.package

---

path

Get Signature

get path(): string

Defined in: js-api/src/entities/func.ts:41

Entity path

Returns

string

Inherited from

Func.path

---

postProcessScript

Get Signature

get postProcessScript(): string

Defined in: js-api/src/entities/data-connection.ts:41

Returns

string

Set Signature

set postProcessScript(script): void

Defined in: js-api/src/entities/data-connection.ts:42

Parameters

Parameter	Type
script	string

Returns

void

---

query

Get Signature

get query(): string

Defined in: js-api/src/entities/data-connection.ts:35

Query text

Returns

string

Set Signature

set query(q): void

Defined in: js-api/src/entities/data-connection.ts:36

Parameters

Parameter	Type
q	string

Returns

void

---

tags

Get Signature

get tags(): string[]

Defined in: js-api/src/entities/func.ts:58

Function tags. Every function kind carries them (scripts, queries, package functions). See also: https://datagrok.ai/help/datagrok/concepts/functions/func-params-annotation

Returns

string[]

Set Signature

set tags(tags): void

Defined in: js-api/src/entities/func.ts:59

Parameters

Parameter	Type
tags	string[]

Returns

void

Inherited from

Func.tags

---

type

Get Signature

get type(): string

Defined in: js-api/src/entities/func.ts:39

Returns

string

Inherited from

Func.type

---

updatedOn

Get Signature

get updatedOn(): Dayjs | null

Defined in: js-api/src/entities/entity.ts:53

Time when entity was updated *

Returns

Dayjs | null

Inherited from

Func.updatedOn

Methods

apply()

apply(parameters?): Promise<any>

Defined in: js-api/src/entities/func.ts:85

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[] | {[name: string]: any; }

Returns

Promise<any>

Inherited from

Func.apply

---

applySync()

applySync(parameters?): any

Defined in: js-api/src/entities/func.ts:101

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

Parameters

Parameter	Type
parameters	{[name: string]: any; }

Returns

any

Inherited from

Func.applySync

---

executeTable()

executeTable(): Promise<DataFrame>

Defined in: js-api/src/entities/data-connection.ts:45

Executes query

Returns

Promise<DataFrame>

---

getProperties()

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

Defined in: js-api/src/entities/entity.ts:69

Gets entity properties

Returns

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

Inherited from

Func.getProperties

---

hasTag()

hasTag(tag): boolean

Defined in: js-api/src/entities/entity.ts:81

Parameters

Parameter	Type
tag	string

Returns

boolean

Inherited from

Func.hasTag

---

newId()

newId(): void

Defined in: js-api/src/entities/entity.ts:32

Generates new id for this entity.

Returns

void

Inherited from

Func.newId

---

prepare()

prepare(parameters?): FuncCall

Defined in: js-api/src/entities/func.ts:62

Returns FuncCall object in a stand-by state

Parameters

Parameter	Type
parameters	{[name: string]: any; }

Returns

FuncCall

Inherited from

Func.prepare

---

prepareAsync()

prepareAsync(parameters?): Promise<FuncCall>

Defined in: js-api/src/entities/func.ts:66

Parameters

Parameter	Type
parameters	{[name: string]: any; }

Returns

Promise<FuncCall>

Inherited from

Func.prepareAsync

---

setProperties()

setProperties(props): Promise<any>

Defined in: js-api/src/entities/entity.ts:74

Sets entity properties

Parameters

Parameter	Type
props	{[index: string]: any; }

Returns

Promise<any>

Inherited from

Func.setProperties

---

tag()

tag(tag): boolean

Defined in: js-api/src/entities/entity.ts:84

Adds a specified tag

Parameters

Parameter	Type
tag	string

Returns

boolean

Inherited from

Func.tag

---

toString()

toString(): string

Defined in: js-api/src/entities/entity.ts:79

Returns a string representing the object

Returns

string

Inherited from

Func.toString

---

unTag()

unTag(tag): boolean

Defined in: js-api/src/entities/entity.ts:87

Removes a specified tag

Parameters

Parameter	Type
tag	string

Returns

boolean

Inherited from

Func.unTag

---

byName()

static byName(name): Func

Defined in: js-api/src/entities/func.ts:122

Returns a function with the specified name.

Parameters

Parameter	Type
name	string

Returns

Func

Inherited from

Func.byName

---

find()

static find(params?): Func[]

Defined in: js-api/src/entities/func.ts:106

Returns functions with the specified attributes.

Parameters

Parameter	Type
params?	{ meta?: any; name?: string; package?: string; returnSemType?: string; returnType?: string; tags?: string[]; }
params.meta?	any
params.name?	string
params.package?	string
params.returnSemType?	string
params.returnType?	string
params.tags?	string[]

Returns

Func[]

Inherited from

Func.find

---

findAll()

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

Defined in: js-api/src/entities/func.ts:113

Parameters

Parameter	Type
params?	{ meta?: any; name?: string; package?: string; returnSemType?: string; returnType?: string; tags?: string[]; }
params.meta?	any
params.name?	string
params.package?	string
params.returnSemType?	string
params.returnType?	string
params.tags?	string[]

Returns

Promise<Func[]>

Deprecated

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

Inherited from

Func.findAll