Class Cluster

Exposes the operations which are available to be performed against a cluster. Namely, the ability to access to Databases as well as performing management operations against the cluster.

Index

Methods

close database executeQuery

Methods

close

close(callback?): Promise<void>
Shuts down this cluster object. Cleaning up all resources associated with it.
Parameters
- Optional callback: NodeCallback<void>
  A node-style callback to be invoked after execution.
Returns Promise<void>
- Defined in lib/cluster.ts:352

database

database(databaseName): Database
Volatile: This API is subject to change at any time.

Creates a database object reference to a specific database.
Parameters
- databaseName: string
  The name of the database to reference.
Returns Database
- Defined in lib/cluster.ts:321

executeQuery

executeQuery(statement, options?): Promise<QueryResult>
Executes a query against the Columnar cluster.
Parameters
- statement: string
  The columnar SQL++ statement to execute.
- Optional options: QueryOptions
  Optional parameters for this operation.
Returns Promise<QueryResult>
- Defined in lib/cluster.ts:331