Skip to content

CreateKxDataviewRequest

Source code in docs_src/capo_finspace/types/create_kx_dataview_request.py
class CreateKxDataviewRequest(TypedDict, closed=True):
    environment_id: "capo_finspace.types.environment_id.EnvironmentId"
    """<p>A unique identifier for the kdb environment, where you want to create the dataview. </p>"""
    database_name: "capo_finspace.types.database_name.DatabaseName"
    """<p> The name of the database where you want to create a dataview. </p>"""
    dataview_name: "capo_finspace.types.kx_dataview_name.KxDataviewName"
    """<p>A unique identifier for the dataview.</p>"""
    az_mode: "capo_finspace.types.kx_az_mode.KxAzMode"
    """<p>The number of availability zones you want to assign per volume. Currently, FinSpace only supports <code>SINGLE</code> for volumes. This places dataview in a single AZ.</p>"""
    availability_zone_id: NotRequired[
        "capo_finspace.types.availability_zone_id.AvailabilityZoneId"
    ]
    """<p> The identifier of the availability zones. </p>"""
    changeset_id: NotRequired["capo_finspace.types.changeset_id.ChangesetId"]
    """<p> A unique identifier of the changeset that you want to use to ingest data. </p>"""
    segment_configurations: NotRequired[
        "capo_finspace.types.kx_dataview_segment_configuration_list.KxDataviewSegmentConfigurationList"
    ]
    """<p> 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. </p>"""
    auto_update: "capo_finspace.types.boolean_value.booleanValue"
    """<p>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.</p>"""
    read_write: "capo_finspace.types.boolean_value.booleanValue"
    """<p> 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. </p> <ul> <li> <p>You cannot create partial writable dataviews. When you create writeable dataviews you must provide the entire database path.</p> </li> <li> <p>You cannot perform updates on a writeable dataview. Hence, <code>autoUpdate</code> must be set as <b>False</b> if <code>readWrite</code> is <b>True</b> for a dataview.</p> </li> <li> <p>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.</p> </li> <li> <p>Once you create a dataview as writeable, you cannot change it to read-only. So, you cannot update the <code>readWrite</code> parameter later.</p> </li> </ul>"""
    description: NotRequired["capo_finspace.types.description.Description"]
    """<p>A description of the dataview.</p>"""
    tags: NotRequired["capo_finspace.types.tag_map.TagMap"]
    """<p> A list of key-value pairs to label the dataview. You can add up to 50 tags to a dataview. </p>"""
    client_token: "capo_finspace.types.client_token_string.ClientTokenString"
    """<p>A token that ensures idempotency. This token expires in 10 minutes.</p>"""

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, autoUpdate must be set as False if readWrite is 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 readWrite parameter 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.

tags instance-attribute

tags: NotRequired[TagMap]

A list of key-value pairs to label the dataview. You can add up to 50 tags to a dataview.