API Docs for: 0.0.3
Show:

CDA Class

Defined in: lib/cda.js:278
Module: CDAjs

The CDA class provides a javascript API to communicate Pentaho Community Data Access plugin (CDA) over HTTP.

Constructor

CDA

(
  • options
)

Defined in lib/cda.js:278

Parameters:

  • options Object

    standard options

Methods

clearCache

(
  • callback
  • options
)

Defined in lib/cda.js:443

Invokes the /cda/clearCache endpoint of CDA.

Parameters:

  • callback Function()

    Function to be called for cda query done.

  • options Object

    Options to use on http request.

doQuery

(
  • callback
  • options
)

Defined in lib/cda.js:329

Invokes the /cda/doQuery endpoint of CDA.

Parameters:

  • callback Function()

    Function to be called for cda query done.

  • options Object

    Options to use on http request.

getCdaFile

(
  • callback
  • options
)

Defined in lib/cda.js:461

Invokes the /cda/getCdaFile endpoint of CDA.

Parameters:

  • callback Function()

    Function to be called for cda query done.

  • options Object

    Options to use on http request.

getCdaList

(
  • callback
  • options
)

Defined in lib/cda.js:377

Invokes the /cda/getCdaList endpoint of CDA.

Parameters:

  • callback Function()

    Function to be called for cda query done.

  • options Object

    Options to use on http request.

listDataAccessTypes

(
  • callback
  • options
)

Defined in lib/cda.js:395

Invokes the /cda/listDataAccessTypes endpoint of CDA.

Parameters:

  • callback Function()

    Function to be called for cda query done.

  • options Object

    Options to use on http request.

listParameters

(
  • callback
  • options
)

Defined in lib/cda.js:413

Invokes the /cda/listParameters endpoint of CDA.

Parameters:

  • callback Function()

    Function to be called for cda query done.

  • options Object

    Options to use on http request.

listQueries

(
  • callback
  • options
)

Defined in lib/cda.js:351

Invokes the /cda/listQueries endpoint of CDA.

Parameters:

  • callback Function()

    Function to be called for cda query done.

  • options Object

    Options to use on http request.

Properties

DEFAULT_OPTIONS

Object static

Defined in lib/cda.js:301

These are the default options used for new CDA instances in case no custom properties are set. It sets the following properties:

  • REQUEST_TIMEOUT int: 60000 - number of milliseconds before a request to the Pentaho server will timeout
  • ASYNC boolean: true - determines whether synchronous or asynchronous communication with the Pentaho server will be used.
  • ACCEPT string: text/xml, application/json - determines the accept header on http request with the Pentaho server will be used.
  • CONTENT_TYPE string: application/json - determines the content-type header on http request with the Pentaho server will be used.
  • METHOD string: GET - determines the method on http request with the Pentaho server will be used.