CreateKxDataviewRequest
¶
Source code in docs_src/capo_finspace/types/create_kx_dataview_request.py
auto_update
instance-attribute
¶
auto_update: booleanValue
The option to specify whether you want to apply all the future additions and corrections automatically to the dataview, when you ingest new changesets. The default value is false.
availability_zone_id
instance-attribute
¶
availability_zone_id: NotRequired[AvailabilityZoneId]
The identifier of the availability zones.
az_mode
instance-attribute
¶
az_mode: KxAzMode
The number of availability zones you want to assign per volume. Currently, FinSpace only supports SINGLE for volumes. This places dataview in a single AZ.
changeset_id
instance-attribute
¶
changeset_id: NotRequired[ChangesetId]
A unique identifier of the changeset that you want to use to ingest data.
client_token
instance-attribute
¶
client_token: ClientTokenString
A token that ensures idempotency. This token expires in 10 minutes.
database_name
instance-attribute
¶
database_name: DatabaseName
The name of the database where you want to create a dataview.
dataview_name
instance-attribute
¶
dataview_name: KxDataviewName
A unique identifier for the dataview.
description
instance-attribute
¶
description: NotRequired[Description]
A description of the dataview.
environment_id
instance-attribute
¶
environment_id: EnvironmentId
A unique identifier for the kdb environment, where you want to create the dataview.
read_write
instance-attribute
¶
read_write: booleanValue
The option to specify whether you want to make the dataview writable to perform database maintenance. The following are some considerations related to writable dataviews.
-
You cannot create partial writable dataviews. When you create writeable dataviews you must provide the entire database path.
-
You cannot perform updates on a writeable dataview. Hence,
autoUpdatemust be set as False ifreadWriteis True for a dataview. -
You must also use a unique volume for creating a writeable dataview. So, if you choose a volume that is already in use by another dataview, the dataview creation fails.
-
Once you create a dataview as writeable, you cannot change it to read-only. So, you cannot update the
readWriteparameter later.
segment_configurations
instance-attribute
¶
segment_configurations: NotRequired[KxDataviewSegmentConfigurationList]
The configuration that contains the database path of the data that you want to place on each selected volume. Each segment must have a unique database path for each volume. If you do not explicitly specify any database path for a volume, they are accessible from the cluster through the default S3/object store segment.