kx_changesets

Creates, updates, deletes, gets or lists a kx_changesets resource.

Overview

Name	kx_changesets
Type	Resource
Id	aws.finspace.kx_changesets

Fields

The following fields are returned by SELECT queries:

get_kx_changeset

Name	Datatype	Description
active_from_timestamp	string (date-time)	Beginning time from which the changeset is active. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
change_requests	array	A list of change request objects that are run in order.
changeset_id	string	A unique identifier for the changeset. (pattern: <code>^[a-zA-Z0-9]+$</code>)
created_timestamp	string (date-time)	The timestamp at which the changeset was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
database_name	string	The name of the kdb database. (pattern: <code>^[a-zA-Z0-9][a-zA-Z0-9-_]*[a-zA-Z0-9]$</code>)
environment_id	string	A unique identifier for the kdb environment. (pattern: <code>.\S.</code>)
error_info	object	Provides details in the event of a failed flow, including the error type and the related error message.
last_modified_timestamp	string (date-time)	The timestamp at which the changeset was updated in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
status	string	Status of the changeset creation process. Pending – Changeset creation is pending. Processing – Changeset creation is running. Failed – Changeset creation has failed. Complete – Changeset creation has succeeded. (PENDING, PROCESSING, FAILED, COMPLETED)

list_kx_changesets

Name	Datatype	Description
kx_changesets	array	A list of changesets for a database.
next_token	string	A token that indicates where a results page should begin. (pattern: <code>.*</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_kx_changeset	select	environment_id, database_name, changeset_id, region		Returns information about a kdb changeset.
list_kx_changesets	select	environment_id, database_name, region	nextToken, maxResults	Returns a list of all the changesets for a database.
create_kx_changeset	insert	environment_id, database_name, region, changeRequests, clientToken		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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
changeset_id	string	A unique identifier of the changeset for which you want to retrieve data.
database_name	string	The name of the kdb database.
environment_id	string	A unique identifier of the kdb environment.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of results to return in this request.
nextToken	string	A token that indicates where a results page should begin.

SELECT examples

get_kx_changeset

Returns information about a kdb changeset.

SELECT
active_from_timestamp,
change_requests,
changeset_id,
created_timestamp,
database_name,
environment_id,
error_info,
last_modified_timestamp,
status
FROM aws.finspace.kx_changesets
WHERE environment_id = '{{ environment_id }}' -- required
AND database_name = '{{ database_name }}' -- required
AND changeset_id = '{{ changeset_id }}' -- required
AND region = '{{ region }}' -- required
;

list_kx_changesets

Returns a list of all the changesets for a database.

SELECT
kx_changesets,
next_token
FROM aws.finspace.kx_changesets
WHERE environment_id = '{{ environment_id }}' -- required
AND database_name = '{{ database_name }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

INSERT examples

create_kx_changeset

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.

INSERT INTO aws.finspace.kx_changesets (
changeRequests,
clientToken,
environment_id,
database_name,
region
)
SELECT 
'{{ changeRequests }}' /* required */,
'{{ clientToken }}' /* required */,
'{{ environment_id }}',
'{{ database_name }}',
'{{ region }}'
RETURNING
change_requests,
changeset_id,
created_timestamp,
database_name,
environment_id,
error_info,
last_modified_timestamp,
status
;

Manifest

# Description fields are for documentation purposes
- name: kx_changesets
props:
  - name: environment_id
    value: "{{ environment_id }}"
    description: Required parameter for the kx_changesets resource.
  - name: database_name
    value: "{{ database_name }}"
    description: Required parameter for the kx_changesets resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the kx_changesets resource.
  - name: changeRequests
    value:
      - changeType: "{{ changeType }}"
        s3Path: "{{ s3Path }}"
        dbPath: "{{ dbPath }}"
  - name: clientToken
    value: "{{ clientToken }}"