databases

Creates, updates, deletes, gets or lists a databases resource.

Overview

Name	databases
Type	Resource
Id	aws.athena.databases

Fields

The following fields are returned by SELECT queries:

get_database

Name	Datatype	Description
description	string	An optional description of the database.
name	string	The name of the database.
parameters	object	A set of custom key/value pairs.

list_databases

Name	Datatype	Description
description	string	An optional description of the database.
name	string	The name of the database.
parameters	object	A set of custom key/value pairs.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_database	select	region		Returns a database object for the specified database and data catalog.
list_databases	select	region		Lists the databases in the specified data catalog.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_database

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

SELECT
description,
name,
parameters
FROM aws.athena.databases
WHERE region = '{{ region }}' -- required
;

list_databases

Lists the databases in the specified data catalog.

SELECT
description,
name,
parameters
FROM aws.athena.databases
WHERE region = '{{ region }}' -- required
;