Skip to content

Get Kx Database

finspace_get_kx_database R Documentation

Returns database information for the specified environment ID

Description

Returns database information for the specified environment ID.

Usage

finspace_get_kx_database(environmentId, databaseName)

Arguments

environmentId

[required] A unique identifier for the kdb environment.

databaseName

[required] The name of the kdb database.

Value

A list with the following syntax:

list(
  databaseName = "string",
  databaseArn = "string",
  environmentId = "string",
  description = "string",
  createdTimestamp = as.POSIXct(
    "2015-01-01"
  ),
  lastModifiedTimestamp = as.POSIXct(
    "2015-01-01"
  ),
  lastCompletedChangesetId = "string",
  numBytes = 123,
  numChangesets = 123,
  numFiles = 123
)

Request syntax

svc$get_kx_database(
  environmentId = "string",
  databaseName = "string"
)