Skip to content

Database

Source code in docs_src/capo_glue/types/database.py
class Database(TypedDict, closed=True):
    name: "capo_glue.types.name_string.NameString"
    """<p>The name of the database. For Hive compatibility, this is folded to lowercase when it is stored.</p>"""
    description: NotRequired["capo_glue.types.description_string.DescriptionString"]
    """<p>A description of the database.</p>"""
    location_uri: NotRequired["capo_glue.types.uri.URI"]
    """<p>The location of the database (for example, an HDFS path).</p>"""
    parameters: NotRequired["capo_glue.types.parameters_map.ParametersMap"]
    """<p>These key-value pairs define parameters and properties of the database.</p>"""
    create_time: NotRequired["capo_glue.types.timestamp.Timestamp"]
    """<p>The time at which the metadata database was created in the catalog.</p>"""
    create_table_default_permissions: NotRequired[
        "capo_glue.types.principal_permissions_list.PrincipalPermissionsList"
    ]
    """<p>Creates a set of default permissions on the table for principals. Used by Lake Formation. Not used in the normal course of Glue operations.</p>"""
    target_database: NotRequired[
        "capo_glue.types.database_identifier.DatabaseIdentifier"
    ]
    """<p>A <code>DatabaseIdentifier</code> structure that describes a target database for resource linking.</p>"""
    catalog_id: NotRequired["capo_glue.types.catalog_id_string.CatalogIdString"]
    """<p>The ID of the Data Catalog in which the database resides.</p>"""
    federated_database: NotRequired[
        "capo_glue.types.federated_database.FederatedDatabase"
    ]
    """<p>A <code>FederatedDatabase</code> structure that references an entity outside the Glue Data Catalog.</p>"""

catalog_id instance-attribute

catalog_id: NotRequired[CatalogIdString]

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

create_table_default_permissions instance-attribute

create_table_default_permissions: NotRequired[PrincipalPermissionsList]

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

create_time instance-attribute

create_time: NotRequired[Timestamp]

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

description instance-attribute

description: NotRequired[DescriptionString]

A description of the database.

federated_database instance-attribute

federated_database: NotRequired[FederatedDatabase]

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

location_uri instance-attribute

location_uri: NotRequired[URI]

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

name instance-attribute

name: NameString

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

parameters instance-attribute

parameters: NotRequired[ParametersMap]

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

target_database instance-attribute

target_database: NotRequired[DatabaseIdentifier]

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