Skip to content

aws.finspace.list_kx_dataviews

Example SQL Queries

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

Description

Returns a list of all the dataviews in the database.

Table Definition

Column NameColumn Data Type
database_name Required Input Column

The name of the database where the dataviews were created.

VARCHAR
environment_id Required Input Column

A unique identifier for the kdb environment, for which you want to retrieve a list of dataviews.

VARCHAR
max_results Input Column

The maximum number of results to return in this request.

BIGINT
next_token Input Column

A token that indicates where a results page should begin.

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
kx_dataviews

The list of kdb dataviews that are currently active for the given database.

STRUCT(
"environment_id" VARCHAR,
"database_name" VARCHAR,
"dataview_name" VARCHAR,
"az_mode" VARCHAR,
"availability_zone_id" VARCHAR,
"changeset_id" VARCHAR,
"segment_configurations" STRUCT(
"db_paths" VARCHAR[],
"volume_name" VARCHAR,
"on_demand" BOOLEAN
)[],
"active_versions" 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
)[],
"status" VARCHAR,
"description" VARCHAR,
"auto_update" BOOLEAN,
"read_write" BOOLEAN,
"created_timestamp" TIMESTAMP_S,
"last_modified_timestamp" TIMESTAMP_S,
"status_reason" VARCHAR
)[]
Show child fields
kx_dataviews[]
Show child fields
kx_dataviews[].active_versions[]
Show child fields
kx_dataviews[].active_versions[].attached_clusters[]
kx_dataviews[].active_versions[].changeset_id

A unique identifier for the changeset.

kx_dataviews[].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.

kx_dataviews[].active_versions[].segment_configurations[]
Show child fields
kx_dataviews[].active_versions[].segment_configurations[].db_paths[]
kx_dataviews[].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.

kx_dataviews[].active_versions[].segment_configurations[].volume_name

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

kx_dataviews[].active_versions[].version_id

A unique identifier of the active version.

kx_dataviews[].auto_update

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.

kx_dataviews[].availability_zone_id

The identifier of the availability zones.

kx_dataviews[].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.

kx_dataviews[].changeset_id

A unique identifier for the changeset.

kx_dataviews[].created_timestamp

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

kx_dataviews[].database_name

A unique identifier of the database.

kx_dataviews[].dataview_name

A unique identifier of the dataview.

kx_dataviews[].description

A description for the dataview list entry.

kx_dataviews[].environment_id

A unique identifier for the kdb environment.

kx_dataviews[].last_modified_timestamp

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

kx_dataviews[].read_write

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

kx_dataviews[].segment_configurations[]
Show child fields
kx_dataviews[].segment_configurations[].db_paths[]
kx_dataviews[].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.

kx_dataviews[].segment_configurations[].volume_name

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

kx_dataviews[].status

The status of a given dataview entry.

kx_dataviews[].status_reason

The error message when a failed state occurs.