get_database `async` ¶

get_database(
    name: NameString,
    *,
    config_overrides: Optional[AsyncGlueClientConfig] = None,
    catalog_id: Optional[CatalogIdString] = None,
) -> GetDatabaseResponse

Retrieves the definition of a specified database.

Parameters:

catalog_id (Optional[CatalogIdString], default: None ) –

The ID of the Data Catalog in which the database resides. If none is provided, the Amazon Web Services account ID is used by default.
name (NameString) –

The name of the database to retrieve. For Hive compatibility, this should be all lowercase.

Raises:

EntityNotFoundException –

A specified entity does not exist
FederationSourceException –

A federation source failed.
FederationSourceRetryableException –

A federation source failed, but the operation may be retried.
GlueEncryptionException –

An encryption operation failed.
InternalServiceException –

An internal service error occurred.
InvalidInputException –

The input provided was not valid.
OperationTimeoutException –

The operation timed out.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_glue/_services/async_glue.py

async def get_database(
    self,
    name: "capo_glue.types.name_string.NameString",
    *,
    config_overrides: Optional[AsyncGlueClientConfig] = None,
    catalog_id: Optional[
        "capo_glue.types.catalog_id_string.CatalogIdString"
    ] = None,
) -> "capo_glue.types.get_database_response.GetDatabaseResponse":
    """<p>Retrieves the definition of a specified database.</p>

    Args:
        catalog_id: <p>The ID of the Data Catalog in which the database resides. If none is provided, the Amazon Web Services account ID is used by default.</p>
        name: <p>The name of the database to retrieve. For Hive compatibility, this should be all lowercase.</p>

    Raises:
        capo_glue.errors.entity_not_found_exception.EntityNotFoundException: <p>A specified entity does not exist</p>
        capo_glue.errors.federation_source_exception.FederationSourceException: <p>A federation source failed.</p>
        capo_glue.errors.federation_source_retryable_exception.FederationSourceRetryableException: <p>A federation source failed, but the operation may be retried.</p>
        capo_glue.errors.glue_encryption_exception.GlueEncryptionException: <p>An encryption operation failed.</p>
        capo_glue.errors.internal_service_exception.InternalServiceException: <p>An internal service error occurred.</p>
        capo_glue.errors.invalid_input_exception.InvalidInputException: <p>The input provided was not valid.</p>
        capo_glue.errors.operation_timeout_exception.OperationTimeoutException: <p>The operation timed out.</p>
        capo_glue.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_glue.types.get_database_request.GetDatabaseRequest]",
    ) -> AsyncOperationResponse[
        "capo_glue.types.get_database_response.GetDatabaseResponse"
    ]:
        import capo_glue._operations.aws_glue.get_database

        (
            output,
            http_response,
        ) = await capo_glue._operations.aws_glue.get_database.async_get_database(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetDatabase")
    )
    input_: capo_glue.types.get_database_request.GetDatabaseRequest = {"name": name}
    if catalog_id is not None:
        input_["catalog_id"] = catalog_id

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

get_database async ¶

get_database `async` ¶