Creates a snapshot of kdb database with tiered storage capabilities and a pre-warmed cache, ready for mounting on kdb clusters¶

Description¶

Creates a snapshot of kdb database with tiered storage capabilities and a pre-warmed cache, ready for mounting on kdb clusters. Dataviews are only available for clusters running on a scaling group. They are not supported on dedicated clusters.

Usage¶

finspace_create_kx_dataview(environmentId, databaseName, dataviewName,
  azMode, availabilityZoneId, changesetId, segmentConfigurations,
  autoUpdate, readWrite, description, tags, clientToken)

Arguments¶

• environmentId

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

• databaseName

  [required] The name of the database where you want to create a dataview.

• dataviewName

  [required] A unique identifier for the dataview.

• azMode

  [required] The number of availability zones you want to assign per volume. Currently, FinSpace only supports SINGLE for volumes. This places dataview in a single AZ.

• availabilityZoneId

  The identifier of the availability zones.

• changesetId

  A unique identifier of the changeset that you want to use to ingest data.

• 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.

• autoUpdate

  The option to specify whether you want to apply all the future additions and corrections automatically to the dataview, when you ingest new changesets. The default value is false.

• readWrite

  The option to specify whether you want to make the dataview writable to perform database maintenance. The following are some considerations related to writable dataviews.

  • You cannot create partial writable dataviews. When you create writeable dataviews you must provide the entire database path.
  • You cannot perform updates on a writeable dataview. Hence, autoUpdate must be set as False if readWrite is True for a dataview.
  • You must also use a unique volume for creating a writeable dataview. So, if you choose a volume that is already in use by another dataview, the dataview creation fails.
  • Once you create a dataview as writeable, you cannot change it to read-only. So, you cannot update the readWrite parameter later.

• description

  A description of the dataview.

• tags

  A list of key-value pairs to label the dataview. You can add up to 50 tags to a dataview.

• clientToken

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

Value¶

A list with the following syntax:

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

Request syntax¶

svc$create_kx_dataview(
  environmentId = "string",
  databaseName = "string",
  dataviewName = "string",
  azMode = "SINGLE"|"MULTI",
  availabilityZoneId = "string",
  changesetId = "string",
  segmentConfigurations = list(
    list(
      dbPaths = list(
        "string"
      ),
      volumeName = "string",
      onDemand = TRUE|FALSE
    )
  ),
  autoUpdate = TRUE|FALSE,
  readWrite = TRUE|FALSE,
  description = "string",
  tags = list(
    "string"
  ),
  clientToken = "string"
)