finspace_list_kx_clusters: Returns a list of clusters

View source: R/finspace_operations.R

finspace_list_kx_clustersR Documentation

Returns a list of clusters

Description

Returns a list of clusters.

See https://www.paws-r-sdk.com/docs/finspace_list_kx_clusters/ for full documentation.

Usage

finspace_list_kx_clusters(
  environmentId,
  clusterType = NULL,
  maxResults = NULL,
  nextToken = NULL
)

Arguments

environmentId

[required] A unique identifier for the kdb environment.

clusterType

Specifies the type of KDB database that is being created. The following types are available:

  • HDB – A Historical Database. The data is only accessible with read-only permissions from one of the FinSpace managed kdb databases mounted to the cluster.

  • RDB – A Realtime Database. This type of database captures all the data from a ticker plant and stores it in memory until the end of day, after which it writes all of its data to a disk and reloads the HDB. This cluster type requires local storage for temporary storage of data during the savedown process. If you specify this field in your request, you must provide the savedownStorageConfiguration parameter.

  • GATEWAY – A gateway cluster allows you to access data across processes in kdb systems. It allows you to create your own routing logic using the initialization scripts and custom code. This type of cluster does not require a writable local storage.

maxResults

The maximum number of results to return in this request.

nextToken

A token that indicates where a results page should begin.


paws.management documentation built on Sept. 12, 2023, 1:06 a.m.