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 createInstance

Methods

close

close(): void
Shuts down this cluster object. Cleaning up all resources associated with it.

Returns void
- Defined in lib/cluster.ts:310

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:275

executeQuery

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

`Static` createInstance

createInstance(httpEndpoint, credential, options?): Cluster
Entry point for creating a new cluster object.
Parameters
- httpEndpoint: string
  The HTTP endpoint of the cluster.
- credential: Credential
  The credential to use for authenticating with the cluster.
- Optional options: ClusterOptions
  Options to configure the cluster connection and global settings.
Returns Cluster
- Defined in lib/cluster.ts:260