Update Kx Cluster Databases
finspace_update_kx_cluster_databases | R Documentation |
Updates the databases mounted on a kdb cluster, which includes the changesetId and all the dbPaths to be cached¶
Description¶
Updates the databases mounted on a kdb cluster, which includes the
changesetId
and all the dbPaths to be cached. This API does not allow
you to change a database name or add a database if you created a cluster
without one.
Using this API you can point a cluster to a different changeset and modify a list of partitions being cached.
Usage¶
finspace_update_kx_cluster_databases(environmentId, clusterName,
clientToken, databases, deploymentConfiguration)
Arguments¶
environmentId
[required] The unique identifier of a kdb environment.
clusterName
[required] A unique name for the cluster that you want to modify.
clientToken
A token that ensures idempotency. This token expires in 10 minutes.
databases
[required] The structure of databases mounted on the cluster.
deploymentConfiguration
The configuration that allows you to choose how you want to update the databases on a cluster.
Value¶
An empty list.
Request syntax¶
svc$update_kx_cluster_databases(
environmentId = "string",
clusterName = "string",
clientToken = "string",
databases = list(
list(
databaseName = "string",
cacheConfigurations = list(
list(
cacheType = "string",
dbPaths = list(
"string"
),
dataviewName = "string"
)
),
changesetId = "string",
dataviewName = "string",
dataviewConfiguration = list(
dataviewName = "string",
dataviewVersionId = "string",
changesetId = "string",
segmentConfigurations = list(
list(
dbPaths = list(
"string"
),
volumeName = "string",
onDemand = TRUE|FALSE
)
)
)
)
),
deploymentConfiguration = list(
deploymentStrategy = "NO_RESTART"|"ROLLING"
)
)