Skip to content
AWS for Query.Farm

aws.glue.get_databases

Example SQL Queries

SELECT * FROM
aws.glue.get_databases;

Description

Retrieves all databases defined in a given Data Catalog.

Table Definition

Column NameColumn Data Type
attributes_to_get Input Column

Specifies the database fields returned by the GetDatabases call. This parameter doesn’t accept an empty list. The request must include the NAME.

VARCHAR[]
Show child fields
attributes_to_get[]
catalog_id Input Column

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

VARCHAR
resource_share_type Input Column

Allows you to specify that you want to list the databases shared with your account. The allowable values are FEDERATED, FOREIGN or ALL.

  • If set to FEDERATED, will list the federated databases (referencing an external entity) shared with your account.

  • If set to FOREIGN, will list the databases shared with your account.

  • If set to ALL, will list the databases shared with your account, as well as the databases in yor local account. 

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
create_table_default_permissions

Creates a set of default permissions on the table for principals. Used by Lake Formation. Not used in the normal course of Glue operations.

STRUCT(
    "principal" STRUCT(
        "data_lake_principal_identifier" VARCHAR
    ),
    "permissions" VARCHAR[]
)[]
Show child fields
create_table_default_permissions[]
Show child fields
create_table_default_permissions[].permissions[]
create_table_default_permissions[].principal

The principal who is granted permissions.

Show child fields
create_table_default_permissions[].principal.data_lake_principal_identifier

An identifier for the Lake Formation principal.

create_time

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

TIMESTAMP_S
description

A description of the database.

VARCHAR
federated_database

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

STRUCT(
    "identifier" VARCHAR,
    "connection_name" VARCHAR
)
Show child fields
federated_database.connection_name

The name of the connection to the external metastore.

federated_database.identifier

A unique identifier for the federated database.

location_uri

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

VARCHAR
name

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

VARCHAR
parameters

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

MAP(VARCHAR, VARCHAR)
target_database

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

STRUCT(
    "catalog_id" VARCHAR,
    "database_name" VARCHAR,
    "region" VARCHAR
)
Show child fields
target_database.catalog_id

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

target_database.database_name

The name of the catalog database.

target_database.region

Region of the target database.