Skip to content
AWS for Query.Farm

aws.glue.get_database

Example SQL Queries

SELECT * FROM
aws.glue.get_database
WHERE
"name" = 'VALUE';

Description

Retrieves the definition of a specified database.

Table Definition

Column NameColumn Data Type
name Required Input Column

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

VARCHAR
catalog_id Input Column

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.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
database

The definition of the specified database in the Data Catalog.

STRUCT(
    "name" VARCHAR,
    "description" VARCHAR,
    "location_uri" VARCHAR,
    "parameters" MAP(VARCHAR, VARCHAR),
    "create_time" TIMESTAMP_S,
    "create_table_default_permissions" STRUCT(
        "principal" STRUCT(
            "data_lake_principal_identifier" VARCHAR
        ),
        "permissions" VARCHAR[]
    )[],
    "target_database" STRUCT(
        "catalog_id" VARCHAR,
        "database_name" VARCHAR,
        "region" VARCHAR
    ),
    "catalog_id" VARCHAR,
    "federated_database" STRUCT(
        "identifier" VARCHAR,
        "connection_name" VARCHAR
    )
)
Show child fields
database.catalog_id

The ID of the Data Catalog in which the database resides.

database.create_table_default_permissions[]
Show child fields
database.create_table_default_permissions[].permissions[]
database.create_table_default_permissions[].principal

The principal who is granted permissions.

Show child fields
database.create_table_default_permissions[].principal.data_lake_principal_identifier

An identifier for the Lake Formation principal.

database.create_time

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

database.description

A description of the database.

database.federated_database

A FederatedDatabase structure that references an entity outside the Glue Data Catalog.

Show child fields
database.federated_database.connection_name

The name of the connection to the external metastore.

database.federated_database.identifier

A unique identifier for the federated database.

database.location_uri

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

database.name

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

database.parameters

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

database.target_database

A DatabaseIdentifier structure that describes a target database for resource linking.

Show child fields
database.target_database.catalog_id

The ID of the Data Catalog in which the database resides.

database.target_database.database_name

The name of the catalog database.

database.target_database.region

Region of the target database.