Jump to Content

This API Documentation is now deprecated

We are excited to announce our new API Documentation.

Interface CreateKxChangesetCommandInputProtected

The input for CreateKxChangesetCommand.



changeRequests: undefined | ChangeRequest[]

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?: string

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

databaseName: undefined | string

The name of the kdb database.

environmentId: undefined | string

A unique identifier of the kdb environment.