Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . glue ]

get-database

Description

Retrieves the definition of a specified database.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  get-database
[--catalog-id <value>]
--name <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--catalog-id (string)

The ID of the Data Catalog in which the database resides. If none is supplied, the AWS account ID is used by default.

--name (string)

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

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

Database -> (structure)

The definition of the specified database in the catalog.

Name -> (string)

Name of the database. For Hive compatibility, this is folded to lowercase when it is stored.

Description -> (string)

Description of the database.

LocationUri -> (string)

The location of the database (for example, an HDFS path).

Parameters -> (map)

These key-value pairs define parameters and properties of the database.

key -> (string)

value -> (string)

CreateTime -> (timestamp)

The time at which the metadata database was created in the catalog.