Update Dataset

finspacedata_update_dataset

R Documentation

Updates a FinSpace Dataset

Description

Updates a FinSpace Dataset.

Usage

finspacedata_update_dataset(clientToken, datasetId, datasetTitle, kind,
  datasetDescription, alias, schemaDefinition)

Arguments

clientToken

A token that ensures idempotency. This token expires in 10 minutes.

datasetId

[required] The unique identifier for the Dataset to update.

datasetTitle

[required] A display title for the Dataset.

kind

[required] The format in which the Dataset data is structured.

• TABULAR – Data is structured in a tabular format.

• NON_TABULAR – Data is structured in a non-tabular format.

datasetDescription

A description for the Dataset.

alias

The unique resource identifier for a Dataset.

schemaDefinition

Definition for a schema on a tabular Dataset.

Value

A list with the following syntax:

list(
  datasetId = "string"
)

Request syntax

svc$update_dataset(
  clientToken = "string",
  datasetId = "string",
  datasetTitle = "string",
  kind = "TABULAR"|"NON_TABULAR",
  datasetDescription = "string",
  alias = "string",
  schemaDefinition = list(
    tabularSchemaConfig = list(
      columns = list(
        list(
          dataType = "STRING"|"CHAR"|"INTEGER"|"TINYINT"|"SMALLINT"|"BIGINT"|"FLOAT"|"DOUBLE"|"DATE"|"DATETIME"|"BOOLEAN"|"BINARY",
          columnName = "string",
          columnDescription = "string"
        )
      ),
      primaryKeyColumns = list(
        "string"
      )
    )
  )
)