FinSpaceData / Client / create_data_view

create_data_view#

FinSpaceData.Client.create_data_view(**kwargs)#

Creates a Dataview for a Dataset.

Danger

This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.

See also: AWS API Documentation

Request Syntax

response = client.create_data_view(
    clientToken='string',
    datasetId='string',
    autoUpdate=True|False,
    sortColumns=[
        'string',
    ],
    partitionColumns=[
        'string',
    ],
    asOfTimestamp=123,
    destinationTypeParams={
        'destinationType': 'string',
        's3DestinationExportFileFormat': 'PARQUET'|'DELIMITED_TEXT',
        's3DestinationExportFileFormatOptions': {
            'string': 'string'
        }
    }
)
Parameters:

  • clientToken (string) –

    A token that ensures idempotency. This token expires in 10 minutes.

    This field is autopopulated if not provided.

  • datasetId (string) –

    [REQUIRED]

    The unique Dataset identifier that is used to create a Dataview.

  • autoUpdate (boolean) – Flag to indicate Dataview should be updated automatically.

  • sortColumns (list) –

    Columns to be used for sorting the data.

    • (string) – 1 - 255 character String

  • partitionColumns (list) –

    Ordered set of column names used to partition data.

    • (string) – 1 - 255 character String

  • asOfTimestamp (integer) – Beginning time to use for the Dataview. 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.

  • destinationTypeParams (dict) –

    [REQUIRED]

    Options that define the destination type for the Dataview.

    • destinationType (string) – [REQUIRED]

      Destination type for a Dataview.

      • GLUE_TABLE – Glue table destination type.

      • S3 – S3 destination type.

    • s3DestinationExportFileFormat (string) –

      Dataview export file format.

      • PARQUET – Parquet export file format.

      • DELIMITED_TEXT – Delimited text export file format.

    • s3DestinationExportFileFormatOptions (dict) –

      Format Options for S3 Destination type.

      Here is an example of how you could specify the s3DestinationExportFileFormatOptions

      { "header": "true", "delimiter": ",", "compression": "gzip" }

      • (string) –

        • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'datasetId': 'string',
    'dataViewId': 'string'
}

Response Structure

  • (dict) – Response for creating a data view.

    • datasetId (string) –

      The unique identifier of the Dataset used for the Dataview.

    • dataViewId (string) –

      The unique identifier for the created Dataview.

Exceptions

  • FinSpaceData.Client.exceptions.InternalServerException

  • FinSpaceData.Client.exceptions.ThrottlingException

  • FinSpaceData.Client.exceptions.ValidationException

  • FinSpaceData.Client.exceptions.LimitExceededException

  • FinSpaceData.Client.exceptions.ConflictException

  • FinSpaceData.Client.exceptions.ResourceNotFoundException