finspace / Client / get_kx_database

get_kx_database#

finspace.Client.get_kx_database(**kwargs)#

Returns database information for the specified environment ID.

See also: AWS API Documentation

Request Syntax

response = client.get_kx_database(
    environmentId='string',
    databaseName='string'
)
Parameters:

  • environmentId (string) –

    [REQUIRED]

    A unique identifier for the kdb environment.

  • databaseName (string) –

    [REQUIRED]

    The name of the kdb database.

Return type:

dict

Returns:

Response Syntax

{
    'databaseName': 'string',
    'databaseArn': 'string',
    'environmentId': 'string',
    'description': 'string',
    'createdTimestamp': datetime(2015, 1, 1),
    'lastModifiedTimestamp': datetime(2015, 1, 1),
    'lastCompletedChangesetId': 'string',
    'numBytes': 123,
    'numChangesets': 123,
    'numFiles': 123
}

Response Structure

  • (dict) –

    • databaseName (string) –

      The name of the kdb database for which the information is retrieved.

    • databaseArn (string) –

      The ARN identifier of the database.

    • environmentId (string) –

      A unique identifier for the kdb environment.

    • description (string) –

      A description of the database.

    • createdTimestamp (datetime) –

      The timestamp at which the database is 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 database was modified. 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.

    • lastCompletedChangesetId (string) –

      A unique identifier for the changeset.

    • numBytes (integer) –

      The total number of bytes in the database.

    • numChangesets (integer) –

      The total number of changesets in the database.

    • numFiles (integer) –

      The total number of files in the database.

Exceptions