Skip to content

update_kx_dataview

update_kx_dataview(
    environment_id: EnvironmentId,
    database_name: DatabaseName,
    dataview_name: KxDataviewName,
    client_token: ClientTokenString,
    *,
    config_overrides: Optional[finspaceClientConfig] = None,
    description: Optional[Description] = None,
    changeset_id: Optional[ChangesetId] = None,
    segment_configurations: Optional[KxDataviewSegmentConfigurationList] = None,
) -> UpdateKxDataviewResponse

Updates the specified dataview. The dataviews get automatically updated when any new changesets are ingested. Each update of the dataview creates a new version, including changeset details and cache configurations

Parameters:

  • environment_id (EnvironmentId) –

    A unique identifier for the kdb environment, where you want to update the dataview.

  • database_name (DatabaseName) –

    The name of the database.

  • dataview_name (KxDataviewName) –

    The name of the dataview that you want to update.

  • description (Optional[Description], default: None ) –

    The description for a dataview.

  • changeset_id (Optional[ChangesetId], default: None ) –

    A unique identifier for the changeset.

  • segment_configurations (Optional[KxDataviewSegmentConfigurationList], default: None ) –

    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.

  • client_token (ClientTokenString) –

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

Raises:

Source code in docs_src/capo_finspace/_services/finspace.py
def update_kx_dataview(
    self,
    environment_id: "capo_finspace.types.environment_id.EnvironmentId",
    database_name: "capo_finspace.types.database_name.DatabaseName",
    dataview_name: "capo_finspace.types.kx_dataview_name.KxDataviewName",
    client_token: "capo_finspace.types.client_token_string.ClientTokenString",
    *,
    config_overrides: Optional[finspaceClientConfig] = None,
    description: Optional["capo_finspace.types.description.Description"] = None,
    changeset_id: Optional["capo_finspace.types.changeset_id.ChangesetId"] = None,
    segment_configurations: Optional[
        "capo_finspace.types.kx_dataview_segment_configuration_list.KxDataviewSegmentConfigurationList"
    ] = None,
) -> "capo_finspace.types.update_kx_dataview_response.UpdateKxDataviewResponse":
    """<p> Updates the specified dataview. The dataviews get automatically updated when any new changesets are ingested. Each update of the dataview creates a new version, including changeset details and cache configurations</p>

    Args:
        environment_id: <p>A unique identifier for the kdb environment, where you want to update the dataview.</p>
        database_name: <p> The name of the database.</p>
        dataview_name: <p>The name of the dataview that you want to update.</p>
        description: <p> The description for a dataview. </p>
        changeset_id: <p>A unique identifier for the changeset.</p>
        segment_configurations: <p> 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. </p>
        client_token: <p>A token that ensures idempotency. This token expires in 10 minutes.</p>

    Raises:
        capo_finspace.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_finspace.errors.conflict_exception.ConflictException: <p>There was a conflict with this action, and it could not be completed.</p>
        capo_finspace.errors.internal_server_exception.InternalServerException: <p>The request processing has failed because of an unknown error, exception or failure.</p>
        capo_finspace.errors.resource_already_exists_exception.ResourceAlreadyExistsException: <p>The specified resource group already exists.</p>
        capo_finspace.errors.resource_not_found_exception.ResourceNotFoundException: <p>One or more resources can't be found.</p>
        capo_finspace.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_finspace.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by an AWS service.</p>
        capo_finspace.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_finspace.types.update_kx_dataview_request.UpdateKxDataviewRequest]",
    ) -> OperationResponse[
        "capo_finspace.types.update_kx_dataview_response.UpdateKxDataviewResponse"
    ]:
        import capo_finspace._operations.aws_habanero_management_service.update_kx_dataview

        output, http_response = (
            capo_finspace._operations.aws_habanero_management_service.update_kx_dataview.update_kx_dataview(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateKxDataview")
    )
    input_: capo_finspace.types.update_kx_dataview_request.UpdateKxDataviewRequest = {
        "environment_id": environment_id,
        "database_name": database_name,
        "dataview_name": dataview_name,
        "client_token": client_token,
    }
    if description is not None:
        input_["description"] = description
    if changeset_id is not None:
        input_["changeset_id"] = changeset_id
    if segment_configurations is not None:
        input_["segment_configurations"] = segment_configurations

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output