API Docs for:
Show:

Saiku Class

Uses
Defined in: saiku.js:33
Module: Saiku

The base constructor for the Saiku API service

Constructor

Saiku

(
  • options
)

Defined in saiku.js:33

Parameters:

  • options Object

    An options hash to configure the instance

    • [host] String optional

      A host name for send API requests

    • [username] String optional

      A username for authenticating API requests

    • [password] String optional

      A password for authenticating API requests

Methods

execute

(
  • callback
)
public

Inherited from MDXRequest: lib/mdx.js:53

<p>Execute query MDX</p>

Parameters:

  • callback Function

export

(
  • [options]
)
ExportRequest

Defined in saiku.js:96

Start a request against the /api/query/admin/export endpoint

Parameters:

  • [options] Object optional

    An options hash for a new ExportRequest

Returns:

ExportRequest:

A ExportRequest instance

file

(
  • callback
)
public

Inherited from ExportRequest: lib/export.js:64

<p>Export file (JSON/HTML/CSV/XLS/)</p>

Parameters:

  • callback Function

get

(
  • callback
)
public

Inherited from SchemasRequest but overwritten in lib/repository.js:44

<p>Return matada repository</p>

Parameters:

  • callback Function

mdx

(
  • [options]
)
MDXRequest

Defined in saiku.js:109

Start a request against the /api/query/execute endpoint

Parameters:

  • [options] Object optional

    An options hash for a new MDXRequest

Returns:

MDXRequest:

A MDXRequest instance

metadata

(
  • callback
)
public

Inherited from SchemasRequest: lib/schemas.js:55

<p>Return metadata Schemas</p>

Parameters:

  • callback Function

query

(
  • callback
)
public

Inherited from ExportRequest: lib/export.js:92

<p>Export query (HTML/CSV/XLS/PDF)</p>

Parameters:

  • callback Function

repository

(
  • [options]
)
RepositoryRequest

Defined in saiku.js:83

Start a request against the /api/repository endpoint

Parameters:

  • [options] Object optional

    An options hash for a new RepositoryRequest

Returns:

RepositoryRequest:

A RepositoryRequest instance

schemas

(
  • [options]
)
SchemasRequest

Defined in saiku.js:70

Start a request against the /discover endpoint

Parameters:

  • [options] Object optional

    An options hash for a new SchemasRequest

Returns:

SchemasRequest:

A SchemasRequest instance

session

(
  • [options]
)
SessionRequest

Defined in saiku.js:57

Start a request against the /session endpoint

Parameters:

  • [options] Object optional

    An options hash for a new SessionRequest

Returns:

SessionRequest:

A SessionRequest instance

Properties

_options

Object private

Inherited from SchemasRequest but overwritten in lib/export.js:33

<p>Configuration options for the request</p>

Default: {}