finspace_create_kx_changeset: Creates a changeset for a kdb database

View source: R/finspace_operations.R

finspace_create_kx_changesetR Documentation

Creates a changeset for a kdb database

Description

Creates a changeset for a kdb database. A changeset allows you to add and delete existing files by using an ordered list of change requests.

See https://www.paws-r-sdk.com/docs/finspace_create_kx_changeset/ for full documentation.

Usage

finspace_create_kx_changeset(
  environmentId,
  databaseName,
  changeRequests,
  clientToken
)

Arguments

environmentId

[required] A unique identifier of the kdb environment.

databaseName

[required] The name of the kdb database.

changeRequests

[required] A list of change request objects that are run in order. A change request object consists of changeType , s3Path, and a dbPath. A changeType can has the following values:

  • PUT – Adds or updates files in a database.

  • DELETE – Deletes files in a database.

All the change requests require a mandatory dbPath attribute that defines the path within the database directory. The s3Path attribute defines the s3 source file path and is required for a PUT change type.

Here is an example of how you can use the change request object:

⁠[ { "changeType": "PUT", "s3Path":"s3://bucket/db/2020.01.02/", "dbPath":"/2020.01.02/"}, { "changeType": "PUT", "s3Path":"s3://bucket/db/sym", "dbPath":"/"}, { "changeType": "DELETE", "dbPath": "/2020.01.01/"} ]⁠

In this example, the first request with PUT change type allows you to add files in the given s3Path under the 2020.01.02 partition of the database. The second request with PUT change type allows you to add a single sym file at database root location. The last request with DELETE change type allows you to delete the files under the 2020.01.01 partition of the database.

clientToken

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


paws.management documentation built on Sept. 12, 2023, 1:06 a.m.