finspace / Client / list_kx_dataviews

list_kx_dataviews#

finspace.Client.list_kx_dataviews(**kwargs)#

Returns a list of all the dataviews in the database.

Request Syntax

response = client.list_kx_dataviews(
    environmentId='string',
    databaseName='string',
    nextToken='string',
    maxResults=123
)

Parameters:

environmentId (string) –
[REQUIRED]

A unique identifier for the kdb environment, for which you want to retrieve a list of dataviews.
databaseName (string) –
[REQUIRED]

The name of the database where the dataviews were created.
nextToken (string) – A token that indicates where a results page should begin.
maxResults (integer) – The maximum number of results to return in this request.

Return type:

dict

Returns:

Response Syntax

{
    'kxDataviews': [
        {
            'environmentId': 'string',
            'databaseName': 'string',
            'dataviewName': 'string',
            'azMode': 'SINGLE'|'MULTI',
            'availabilityZoneId': 'string',
            'changesetId': 'string',
            'segmentConfigurations': [
                {
                    'dbPaths': [
                        'string',
                    ],
                    'volumeName': 'string',
                    'onDemand': True|False
                },
            ],
            'activeVersions': [
                {
                    'changesetId': 'string',
                    'segmentConfigurations': [
                        {
                            'dbPaths': [
                                'string',
                            ],
                            'volumeName': 'string',
                            'onDemand': True|False
                        },
                    ],
                    'attachedClusters': [
                        'string',
                    ],
                    'createdTimestamp': datetime(2015, 1, 1),
                    'versionId': 'string'
                },
            ],
            'status': 'CREATING'|'ACTIVE'|'UPDATING'|'FAILED'|'DELETING',
            'description': 'string',
            'autoUpdate': True|False,
            'readWrite': True|False,
            'createdTimestamp': datetime(2015, 1, 1),
            'lastModifiedTimestamp': datetime(2015, 1, 1),
            'statusReason': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- kxDataviews (list) –
  
  The list of kdb dataviews that are currently active for the given database.
  - (dict) –
    
    A collection of kdb dataview entries.
    - environmentId (string) –
      
      A unique identifier for the kdb environment.
    - databaseName (string) –
      
      A unique identifier of the database.
    - dataviewName (string) –
      
      A unique identifier of the dataview.
    - azMode (string) –
      
      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.
    - availabilityZoneId (string) –
      
      The identifier of the availability zones.
    - changesetId (string) –
      
      A unique identifier for the changeset.
    - segmentConfigurations (list) –
      
      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.
      - (dict) –
        
        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.
        
        dbPaths (list) –
        
        The database path of the data that you want to place on each selected volume for the segment. Each segment must have a unique database path for each volume.
        
        (string) –
        
        volumeName (string) –
        
        The name of the volume where you want to add data.
        
        onDemand (boolean) –
        
        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.
    - activeVersions (list) –
      
      The active changeset versions for the given dataview entry.
      - (dict) –
        
        The active version of the dataview that is currently in use by this cluster.
        
        changesetId (string) –
        
        A unique identifier for the changeset.
        
        segmentConfigurations (list) –
        
        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.
        
        (dict) –
        
        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.
        
        dbPaths (list) –
        
        The database path of the data that you want to place on each selected volume for the segment. Each segment must have a unique database path for each volume.
        
        (string) –
        
        volumeName (string) –
        
        The name of the volume where you want to add data.
        
        onDemand (boolean) –
        
        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.
        
        attachedClusters (list) –
        
        The list of clusters that are currently using this dataview.
        
        (string) –
        
        createdTimestamp (datetime) –
        
        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.
        
        versionId (string) –
        
        A unique identifier of the active version.
    - status (string) –
      
      The status of a given dataview entry.
    - description (string) –
      
      A description for the dataview list entry.
    - autoUpdate (boolean) –
      
      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.
    - readWrite (boolean) –
      
      Returns True if the dataview is created as writeable and False otherwise.
    - createdTimestamp (datetime) –
      
      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.
    - lastModifiedTimestamp (datetime) –
      
      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.
    - statusReason (string) –
      
      The error message when a failed state occurs.
- nextToken (string) –
  
  A token that indicates where a results page should begin.

list_kx_dataviews#

Request Syntax

Response Syntax

Response Structure

Exceptions