GoodData JS SDK GoodDataJS
gooddata-js v13.5.0

execution Class

Defined in: src/execution.ts:8
Module: execution

Deprecated: The module is in maintenance mode only (just the the compilation issues are being fixed when referenced utilities and interfaces are being changed) and is not being extended when AFM executor have new functionality added.

Execution endpoints

Show:

Methods

Show:

executeAfm

(
  • projectId
  • execution
)
Promise

Provided by the DataLayer module.

Defined in src/execution/execute-afm.ts:43

Execute AFM and fetch all data results

Parameters

Returns

Promise:

Structure with executionResponse and executionResult - See https://github.com/gooddata/gooddata-typings/blob/v2.1.0/src/Execution.ts#L113

getData

(
  • projectId
  • columns
  • executionConfiguration
  • settings
)
Object

Defined in src/execution/experimental-executions.ts:516

For the given projectId it returns table structure with the given elements in column headers.

Parameters

  • projectId String
    • GD project identifier
  • columns Array
    • An array of attribute or metric identifiers.
  • executionConfiguration Object
    • Execution configuration - can contain for example property "where" containing query-like filters property "orderBy" contains array of sorted properties to order in form [{column: 'identifier', direction: 'asc|desc'}]
  • settings Object
    • Supports additional settings accepted by the underlying xhr.ajax() calls

Returns

Object:

Structure with headers and rawData keys filled with values from execution.

getExecutionResponse

(
  • projectId
  • execution
)
Promise

Provided by the DataLayer module.

Defined in src/execution/execute-afm.ts:68

Execute AFM and return execution's response; the response describes dimensionality of the results and includes link to poll for the results.

Parameters

Returns

Promise:

Promise with executionResponse See https://github.com/gooddata/gooddata-typings/blob/v2.1.0/src/Execution.ts#L69

getExecutionResult

(
  • executionResultUri
)
Promise

Provided by the DataLayer module.

Defined in src/execution/execute-afm.ts:175

Get whole ExecutionResult

Parameters

  • executionResultUri String

Returns

Promise:

Promise with executionResult or null (null means empty response - HTTP 204) See https://github.com/gooddata/gooddata-typings/blob/v2.1.0/src/Execution.ts#L88

getPartialExecutionResult

(
  • executionResultUri
  • limit
  • offset
)
Promise

Provided by the DataLayer module.

Defined in src/execution/execute-afm.ts:151

Get one page of Result from Execution (with requested limit and offset)

Parameters

  • executionResultUri String
  • limit Number
    • limit for each dimension
  • offset Number
    • offset for each dimension

Returns

Promise:

Promise with executionResult or null (null means empty response - HTTP 204) See https://github.com/gooddata/gooddata-typings/blob/v2.1.0/src/Execution.ts#L88

© GoodData 2019