List Kx Dataviews

finspace_list_kx_dataviews

R Documentation

Returns a list of all the dataviews in the database¶

Description¶

Returns a list of all the dataviews in the database.

Usage¶

finspace_list_kx_dataviews(environmentId, databaseName, nextToken,
  maxResults)

Arguments¶

environmentId

[required] A unique identifier for the kdb environment, for which you want to retrieve a list of dataviews.

databaseName

[required] The name of the database where the dataviews were created.

nextToken

A token that indicates where a results page should begin.

maxResults

The maximum number of results to return in this request.

Value¶

A list with the following syntax:

list(
  kxDataviews = list(
    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",
      description = "string",
      autoUpdate = TRUE|FALSE,
      readWrite = TRUE|FALSE,
      createdTimestamp = as.POSIXct(
        "2015-01-01"
      ),
      lastModifiedTimestamp = as.POSIXct(
        "2015-01-01"
      ),
      statusReason = "string"
    )
  ),
  nextToken = "string"
)

Request syntax¶

svc$list_kx_dataviews(
  environmentId = "string",
  databaseName = "string",
  nextToken = "string",
  maxResults = 123
)