Skip to content

List Databases

athena_list_databases R Documentation

Lists the databases in the specified data catalog

Description

Lists the databases in the specified data catalog.

Usage

athena_list_databases(CatalogName, NextToken, MaxResults, WorkGroup)

Arguments

CatalogName

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

NextToken

A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

MaxResults

Specifies the maximum number of results 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(
  DatabaseList = list(
    list(
      Name = "string",
      Description = "string",
      Parameters = list(
        "string"
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_databases(
  CatalogName = "string",
  NextToken = "string",
  MaxResults = 123,
  WorkGroup = "string"
)