Skip to content

Get Database

glue_get_database R Documentation

Retrieves the definition of a specified database

Description

Retrieves the definition of a specified database.

Usage

glue_get_database(CatalogId, Name)

Arguments

CatalogId

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

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

Value

A list with the following syntax:

list(
  Database = list(
    Name = "string",
    Description = "string",
    LocationUri = "string",
    Parameters = list(
      "string"
    ),
    CreateTime = as.POSIXct(
      "2015-01-01"
    ),
    CreateTableDefaultPermissions = list(
      list(
        Principal = list(
          DataLakePrincipalIdentifier = "string"
        ),
        Permissions = list(
          "ALL"|"SELECT"|"ALTER"|"DROP"|"DELETE"|"INSERT"|"CREATE_DATABASE"|"CREATE_TABLE"|"DATA_LOCATION_ACCESS"
        )
      )
    ),
    TargetDatabase = list(
      CatalogId = "string",
      DatabaseName = "string",
      Region = "string"
    ),
    CatalogId = "string",
    FederatedDatabase = list(
      Identifier = "string",
      ConnectionName = "string"
    )
  )
)

Request syntax

svc$get_database(
  CatalogId = "string",
  Name = "string"
)