Class: DataQuery
dg.DataQuery
Represents a data query
Hierarchy
↳
DataQuery↳↳
TableQuery
Constructors
constructor
• new DataQuery(dart)
Constructs
DataQuery
Parameters
| Name | Type |
|---|---|
dart | any |
Overrides
Defined in
Properties
aux
• aux: any
Inherited from
Defined in
dart
• dart: any
Inherited from
Defined in
options
• options: Object
Index signature
▪ [key: string]: any
Inherited from
Defined in
Accessors
adHoc
• get adHoc(): boolean
Deprecated
Use FuncCall.adHoc instead *
Returns
boolean
Defined in
• set adHoc(a): void
Deprecated
Use FuncCall.adHoc instead *
Parameters
| Name | Type |
|---|---|
a | boolean |
Returns
void
Defined in
author
• get author(): User
Who created entity *
Returns
Inherited from
Func.author
Defined in
connection
• get connection(): DataConnection
Returns
Defined in
• set connection(c): void
Parameters
| Name | Type |
|---|---|
c | DataConnection |
Returns
void
Defined in
createdOn
• get createdOn(): Dayjs
Time when entity was created *
Returns
Dayjs
Inherited from
Func.createdOn
Defined in
description
• get description(): string
Returns
string
Inherited from
Func.description
Defined in
friendlyName
• get friendlyName(): string
Entity friendly name
Returns
string
Inherited from
Func.friendlyName
Defined in
• set friendlyName(x): void
Parameters
| Name | Type |
|---|---|
x | string |
Returns
void
Inherited from
Func.friendlyName
Defined in
helpUrl
• get helpUrl(): string
Help URL.
Returns
string
Inherited from
Func.helpUrl
Defined in
id
• get id(): string
Entity ID (GUID)
Returns
string
Inherited from
Func.id
Defined in
• set id(x): void
Parameters
| Name | Type |
|---|---|
x | string |
Returns
void
Inherited from
Func.id
Defined in
inputs
• get inputs(): Property[]
Input parameters
Returns
Property[]
Inherited from
Func.inputs
Defined in
name
• get name(): string
Entity short name
Returns
string
Inherited from
Func.name
Defined in
• set name(x): void
Parameters
| Name | Type |
|---|---|
x | string |
Returns
void
Inherited from
Func.name
Defined in
nqName
• get nqName(): string
Entity full-qualified name
Returns
string
Inherited from
Func.nqName
Defined in
outputs
• get outputs(): Property[]
Output parameters
Returns
Property[]
Inherited from
Func.outputs
Defined in
package
• get package(): Package
A package this function belongs to.
Returns
Inherited from
Func.package
Defined in
path
• get path(): string
Entity path
Returns
string
Inherited from
Func.path
Defined in
query
• get query(): string
Query text
Returns
string
Defined in
• set query(q): void
Parameters
| Name | Type |
|---|---|
q | string |
Returns
void
Defined in
type
• get type(): string
Returns
string
Inherited from
Func.type
Defined in
updatedOn
• get updatedOn(): Dayjs
Time when entity was updated *
Returns
Dayjs
Inherited from
Func.updatedOn
Defined in
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
Defined in
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
Defined in
executeTable
▸ executeTable(): Promise<DataFrame>
Executes query
Returns
Promise<DataFrame>
Defined in
getProperties
▸ getProperties(): Promise<{ [index: string]: any; }>
Gets entity properties
Returns
Promise<{ [index: string]: any; }>
Inherited from
Defined in
hasTag
▸ hasTag(tag): boolean
Parameters
| Name | Type |
|---|---|
tag | string |
Returns
boolean
Inherited from
Defined in
newId
▸ newId(): void
Generates new id for this entity.
Returns
void
Inherited from
Defined in
prepare
▸ prepare(parameters?): FuncCall
Returns FuncCall object in a stand-by state
Parameters
| Name | Type |
|---|---|
parameters | Object |
Returns
Inherited from
Defined in
setProperties
▸ setProperties(props): Promise<any>
Sets entity properties
Parameters
| Name | Type |
|---|---|
props | Object |
Returns
Promise<any>
Inherited from
Defined in
tag
▸ tag(tag): boolean
Adds a specified tag
Parameters
| Name | Type |
|---|---|
tag | string |
Returns
boolean
Inherited from
Defined in
toString
▸ toString(): string
Returns a string representing the object
Returns
string
Inherited from
Defined in
unTag
▸ unTag(tag): boolean
Removes a specified tag
Parameters
| Name | Type |
|---|---|
tag | string |
Returns
boolean
Inherited from
Defined in
byName
▸ Static byName(name): Func
Returns a function with the specified name.
Parameters
| Name | Type |
|---|---|
name | string |
Returns
Inherited from
Defined in
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
Defined in
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[]>