Skip to content

Get Database

athena_get_database R Documentation

Returns a database object for the specified database and data catalog

Description

Returns a database object for the specified database and data catalog.

Usage

athena_get_database(CatalogName, DatabaseName, WorkGroup)

Arguments

CatalogName

[required] The name of the data catalog that contains the database to return.

DatabaseName

[required] The name of the database to return.

WorkGroup

The name of the workgroup for which the metadata is being fetched. Required if requesting an IAM Identity Center enabled Glue Data Catalog.

Value

A list with the following syntax:

list(
  Database = list(
    Name = "string",
    Description = "string",
    Parameters = list(
      "string"
    )
  )
)

Request syntax

svc$get_database(
  CatalogName = "string",
  DatabaseName = "string",
  WorkGroup = "string"
)