Returns a database object for the specfied database and data catalog.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
get-database
--catalog-name <value>
--database-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]
--catalog-name
(string)
The name of the data catalog that contains the database to return.
--database-name
(string)
The name of the database to return.
--cli-input-json
| --cli-input-yaml
(string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml
.
--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
. Similarly, if provided yaml-input
it will print a sample input YAML that can be used with --cli-input-yaml
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
--cli-auto-prompt
(boolean)
Automatically prompt for CLI input parameters.
See ‘aws help’ for descriptions of global parameters.
To return information about a database in a data catalog
The following get-database
example returns information about the sampledb
database in the AwsDataCatalog
data catalog.
aws athena get-database \
--catalog-name AwsDataCatalog \
--database-name sampledb
Output:
{
"Database": {
"Name": "sampledb",
"Description": "Sample database",
"Parameters": {
"CreatedBy": "Athena",
"EXTERNAL": "TRUE"
}
}
}
For more information, see Showing Database Details: get-database in the Amazon Athena User Guide.
Database -> (structure)
The database returned.
Name -> (string)
The name of the database.
Description -> (string)
An optional description of the database.
Parameters -> (map)
A set of custom key/value pairs.
key -> (string)
value -> (string)