Skip to content
AWS for Query.Farm

aws.finspace.get_kx_dataview

Example SQL Queries

SELECT * FROM
aws.finspace.get_kx_dataview
WHERE
"environment_id" = 'VALUE'
AND "database_name" = 'VALUE'
AND "dataview_name" = 'VALUE';

Description

Retrieves details of the dataview.

Table Definition

Column NameColumn Data Type
database_name Required Input Column

The name of the database where you created the dataview.

VARCHAR
dataview_name Required Input Column

A unique identifier for the dataview.

VARCHAR
environment_id Required Input Column

A unique identifier for the kdb environment, from where you want to retrieve the dataview details.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
active_versions

The current active changeset versions of the database on the given dataview. 

STRUCT(
    "changeset_id" VARCHAR,
    "segment_configurations" STRUCT(
        "db_paths" VARCHAR[],
        "volume_name" VARCHAR,
        "on_demand" BOOLEAN
    )[],
    "attached_clusters" VARCHAR[],
    "created_timestamp" TIMESTAMP_S,
    "version_id" VARCHAR
)[]
Show child fields
active_versions[]
Show child fields
active_versions[].attached_clusters[]
active_versions[].changeset_id

A unique identifier for the changeset.

active_versions[].created_timestamp

The timestamp at which the dataview version was 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.

active_versions[].segment_configurations[]
Show child fields
active_versions[].segment_configurations[].db_paths[]
active_versions[].segment_configurations[].on_demand

Enables on-demand caching on the selected database path when a particular file or a column of the database is accessed. When on demand caching is True, dataviews perform minimal loading of files on the filesystem as needed. When it is set to False, everything is cached. The default value is False.

active_versions[].segment_configurations[].volume_name

The name of the volume where you want to add data.

active_versions[].version_id

A unique identifier of the active version.

auto_update

The option to specify whether you want to apply all the future additions and corrections automatically to the dataview when new changesets are ingested. The default value is false.

BOOLEAN
availability_zone_id

The identifier of the availability zones. 

VARCHAR
az_mode

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.

VARCHAR
changeset_id

A unique identifier of the changeset that you want to use to ingest data. 

VARCHAR
created_timestamp

The timestamp at which the dataview 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.

TIMESTAMP_S
description

A description of the dataview.

VARCHAR
last_modified_timestamp

The last time that the dataview 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. 

TIMESTAMP_S
read_write

Returns True if the dataview is created as writeable and False otherwise. 

BOOLEAN
segment_configurations

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. 

STRUCT(
    "db_paths" VARCHAR[],
    "volume_name" VARCHAR,
    "on_demand" BOOLEAN
)[]
Show child fields
segment_configurations[]
Show child fields
segment_configurations[].db_paths[]
segment_configurations[].on_demand

Enables on-demand caching on the selected database path when a particular file or a column of the database is accessed. When on demand caching is True, dataviews perform minimal loading of files on the filesystem as needed. When it is set to False, everything is cached. The default value is False.

segment_configurations[].volume_name

The name of the volume where you want to add data.

status

The status of dataview creation.

  • CREATING – The dataview creation is in progress.

  • UPDATING – The dataview is in the process of being updated.

  • ACTIVE – The dataview is active.

VARCHAR
status_reason

The error message when a failed state occurs. 

VARCHAR