Skip to content

Get Kx Dataview

finspace_get_kx_dataview R Documentation

Retrieves details of the dataview

Description

Retrieves details of the dataview.

Usage

finspace_get_kx_dataview(environmentId, databaseName, dataviewName)

Arguments

environmentId

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

databaseName

[required] The name of the database where you created the dataview.

dataviewName

[required] A unique identifier for the dataview.

Value

A list with the following syntax:

list(
  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"
    )
  ),
  description = "string",
  autoUpdate = TRUE|FALSE,
  readWrite = TRUE|FALSE,
  environmentId = "string",
  createdTimestamp = as.POSIXct(
    "2015-01-01"
  ),
  lastModifiedTimestamp = as.POSIXct(
    "2015-01-01"
  ),
  status = "CREATING"|"ACTIVE"|"UPDATING"|"FAILED"|"DELETING",
  statusReason = "string"
)

Request syntax

svc$get_kx_dataview(
  environmentId = "string",
  databaseName = "string",
  dataviewName = "string"
)