finspace / Client / update_kx_cluster_databases

update_kx_cluster_databases#

finspace.Client.update_kx_cluster_databases(**kwargs)#

Updates the databases mounted on a kdb cluster, which includes the changesetId and all the dbPaths to be cached. This API does not allow you to change a database name or add a database if you created a cluster without one.

Using this API you can point a cluster to a different changeset and modify a list of partitions being cached.

See also: AWS API Documentation

Request Syntax

response = client.update_kx_cluster_databases(
    environmentId='string',
    clusterName='string',
    clientToken='string',
    databases=[
        {
            'databaseName': 'string',
            'cacheConfigurations': [
                {
                    'cacheType': 'string',
                    'dbPaths': [
                        'string',
                    ]
                },
            ],
            'changesetId': 'string'
        },
    ]
)
Parameters:

  • environmentId (string) –

    [REQUIRED]

    The unique identifier of a kdb environment.

  • clusterName (string) –

    [REQUIRED]

    A unique name for the cluster that you want to modify.

  • clientToken (string) – A token that ensures idempotency. This token expires in 10 minutes.

  • databases (list) –

    [REQUIRED]

    The structure of databases mounted on the cluster.

    • (dict) –

      The configuration of data that is available for querying from this database.

      • databaseName (string) – [REQUIRED]

        The name of the kdb database. When this parameter is specified in the structure, S3 with the whole database is included by default.

      • cacheConfigurations (list) –

        Configuration details for the disk cache used to increase performance reading from a kdb database mounted to the cluster.

        • (dict) –

          The structure of database cache configuration that is used for mapping database paths to cache types in clusters.

          • cacheType (string) – [REQUIRED]

            The type of disk cache. This parameter is used to map the database path to cache storage. The valid values are:

            • CACHE_1000 – This type provides at least 1000 MB/s disk access throughput.

          • dbPaths (list) – [REQUIRED]

            Specifies the portions of database that will be loaded into the cache for access.

            • (string) –

      • changesetId (string) –

        A unique identifier of the changeset that is associated with the cluster.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • finspace.Client.exceptions.InternalServerException

  • finspace.Client.exceptions.ThrottlingException

  • finspace.Client.exceptions.AccessDeniedException

  • finspace.Client.exceptions.LimitExceededException

  • finspace.Client.exceptions.ValidationException

  • finspace.Client.exceptions.ResourceNotFoundException