Update Kx Dataview

finspace_update_kx_dataview

R Documentation

Updates the specified dataview

Description

Updates the specified dataview. The dataviews get automatically updated when any new changesets are ingested. Each update of the dataview creates a new version, including changeset details and cache configurations

Usage

finspace_update_kx_dataview(environmentId, databaseName, dataviewName,
  description, changesetId, segmentConfigurations, clientToken)

Arguments

environmentId

[required] A unique identifier for the kdb environment, where you want to update the dataview.

databaseName

[required] The name of the database.

dataviewName

[required] The name of the dataview that you want to update.

description

The description for a dataview.

changesetId

A unique identifier for the changeset.

segmentConfigurations

The configuration that contains the database path of the data that you want to place on each selected volume. Each segment must have a unique database path for each volume. If you do not explicitly specify any database path for a volume, they are accessible from the cluster through the default S3/object store segment.

clientToken

[required] A token that ensures idempotency. This token expires in 10 minutes.

Value

A list with the following syntax:

list(
  environmentId = "string",
  databaseName = "string",
  dataviewName = "string",
  azMode = "SINGLE"|"MULTI",
  availabilityZoneId = "string",
  changesetId = "string",
  segmentConfigurations = list(
    list(
      dbPaths = list(
        "string"
      ),
      volumeName = "string",
      onDemand = TRUE|FALSE
    )
  ),
  activeVersions = list(
    list(
      changesetId = "string",
      segmentConfigurations = list(
        list(
          dbPaths = list(
            "string"
          ),
          volumeName = "string",
          onDemand = TRUE|FALSE
        )
      ),
      attachedClusters = list(
        "string"
      ),
      createdTimestamp = as.POSIXct(
        "2015-01-01"
      ),
      versionId = "string"
    )
  ),
  status = "CREATING"|"ACTIVE"|"UPDATING"|"FAILED"|"DELETING",
  autoUpdate = TRUE|FALSE,
  readWrite = TRUE|FALSE,
  description = "string",
  createdTimestamp = as.POSIXct(
    "2015-01-01"
  ),
  lastModifiedTimestamp = as.POSIXct(
    "2015-01-01"
  )
)

Request syntax

svc$update_kx_dataview(
  environmentId = "string",
  databaseName = "string",
  dataviewName = "string",
  description = "string",
  changesetId = "string",
  segmentConfigurations = list(
    list(
      dbPaths = list(
        "string"
      ),
      volumeName = "string",
      onDemand = TRUE|FALSE
    )
  ),
  clientToken = "string"
)