Class: Aws::Finspace::Types::CreateKxChangesetRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-finspace/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#change_requests ⇒ Array<Types::ChangeRequest>

A list of change request objects that are run in order. A change request object consists of ‘changeType` , `s3Path`, and `dbPath`. A changeType can have 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. All database paths must start with a leading / and end with a trailing /. The `s3Path` attribute defines the s3 source file path and is required for a PUT change type. The `s3path` must end with a trailing / if it is a directory and must end without a trailing / if it is a file.

Here are few examples of how you can use the change request object:

  1. This request adds a single sym file at database root location.

    ‘{ “changeType”: “PUT”, “s3Path”:“s3://bucket/db/sym”, “dbPath”:“/”}`

  2. This request adds files in the given ‘s3Path` under the 2020.01.02 partition of the database.

    ‘{ “changeType”: “PUT”, “s3Path”:“s3://bucket/db/2020.01.02/”, “dbPath”:“/2020.01.02/”}`

  3. This request adds files in the given ‘s3Path` under the taq table partition of the database.

    ‘[ { “changeType”: “PUT”, “s3Path”:“s3://bucket/db/2020.01.02/taq/”, “dbPath”:“/2020.01.02/taq/”}]`

  4. This request deletes the 2020.01.02 partition of the database.

    ‘[{ “changeType”: “DELETE”, “dbPath”: “/2020.01.02/”} ]`

  5. The DELETE request allows you to delete the existing files under the 2020.01.02 partition of the database, and the PUT request adds a new taq table under it.

    ‘[ “DELETE”, “dbPath”:“/2020.01.02/”, “PUT”, “s3Path”:“s3://bucket/db/2020.01.02/taq/”, “dbPath”:“/2020.01.02/taq/”]`

Returns:



352
353
354
355
356
357
358
359
 
# File 'lib/aws-sdk-finspace/types.rb', line 352

class CreateKxChangesetRequest < Struct.new(
  :environment_id,
  :database_name,
  :change_requests,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#client_token ⇒ String

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

**A suitable default value is auto-generated.** You should normally not need to pass this option.

Returns:

  • (String) 


352
353
354
355
356
357
358
359
 
# File 'lib/aws-sdk-finspace/types.rb', line 352

class CreateKxChangesetRequest < Struct.new(
  :environment_id,
  :database_name,
  :change_requests,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#database_name ⇒ String

The name of the kdb database.

Returns:

  • (String) 


352
353
354
355
356
357
358
359
 
# File 'lib/aws-sdk-finspace/types.rb', line 352

class CreateKxChangesetRequest < Struct.new(
  :environment_id,
  :database_name,
  :change_requests,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#environment_id ⇒ String

A unique identifier of the kdb environment.

Returns:

  • (String) 


352
353
354
355
356
357
358
359
 
# File 'lib/aws-sdk-finspace/types.rb', line 352

class CreateKxChangesetRequest < Struct.new(
  :environment_id,
  :database_name,
  :change_requests,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end