API de la base de datos - AWS Glue
 —  tipos de datos  —Base de datosDatabaseInputPrincipalPermissionsDataLakePrincipalDatabaseIdentifierFederatedDatabase —  operaciones  —CreateDatabase (create_database)UpdateDatabase (update_database)DeleteDatabase (delete_database)GetDatabase (get_database)GetDatabases (get_databases)

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

API de la base de datos

La API de la base de datos describe los tipos de datos de la base de datos e incluye la API de creación, eliminación, ubicación, actualización y enumeración de las bases de datos.

Tipos de datos

Estructura de base de datos

El objeto Database representa una agrupación lógica de tablas que puede residir en un metaalmacén de Hive o en un RDBMS.

Campos

  • Name: obligatorio: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.

    El nombre de la base de datos. Para su compatibilidad con Hive, este se incorpora en minúsculas al almacenarse.

  • Description: cadena de descripción de un máximo de 2048 bytes de largo, que coincide con el URI address multi-line string pattern.

    Una descripción de la base de datos.

  • LocationUri: identificador uniforme de recursos (uri), con 1 byte de largo como mínimo y 1024 bytes de largo como máximo, que coincide con el URI address multi-line string pattern.

    La ubicación de la base de datos (por ejemplo, una ruta de HDFS).

  • Parameters: matriz de mapas de pares clave-valor.

    Cada clave es una cadena de claves con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.

    Cada valor es una cadena UTF-8 que no tiene más de 512000 bytes de largo.

    Estos pares de clave-valor definen los parámetros y las propiedades de la base de datos.

  • CreateTime: marca temporal.

    Hora de creación de la base de datos de metadatos en el catálogo.

  • CreateTableDefaultPermissions: matriz de objetos PrincipalPermissions.

    Permite crear un conjunto de permisos predeterminados en la tabla para las entidades principales. Utilizado por AWS Lake Formation. No se utiliza en el transcurso normal de las operaciones de AWS Glue.

  • TargetDatabase: un objeto DatabaseIdentifier.

    Estructura DatabaseIdentifier que describe una base de datos de destino para la vinculación de recursos.

  • CatalogId: cadena de ID de catálogo, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.

    El ID del Catálogo de datos donde reside la base de datos.

  • FederatedDatabase: un objeto FederatedDatabase.

    Una estructura FederatedDatabase que hace referencia a una entidad externa aAWS Glue Data Catalog.

Estructura DatabaseInput

Estructura usada para crear o actualizar una base de datos.

Campos

  • Name: obligatorio: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.

    El nombre de la base de datos. Para su compatibilidad con Hive, este se incorpora en minúsculas al almacenarse.

  • Description: cadena de descripción de un máximo de 2048 bytes de largo, que coincide con el URI address multi-line string pattern.

    Una descripción de la base de datos.

  • LocationUri: identificador uniforme de recursos (uri), con 1 byte de largo como mínimo y 1024 bytes de largo como máximo, que coincide con el URI address multi-line string pattern.

    La ubicación de la base de datos (por ejemplo, una ruta de HDFS).

  • Parameters: matriz de mapas de pares clave-valor.

    Cada clave es una cadena de claves con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.

    Cada valor es una cadena UTF-8 que no tiene más de 512000 bytes de largo.

    Estos pares de clave-valor definen los parámetros y las propiedades de la base de datos.

    Estos pares de clave-valor definen los parámetros y las propiedades de la base de datos.

  • CreateTableDefaultPermissions: matriz de objetos PrincipalPermissions.

    Permite crear un conjunto de permisos predeterminados en la tabla para las entidades principales. Utilizado por AWS Lake Formation. No se utiliza en el transcurso normal de las operaciones de AWS Glue.

  • TargetDatabase: un objeto DatabaseIdentifier.

    Estructura DatabaseIdentifier que describe una base de datos de destino para la vinculación de recursos.

  • FederatedDatabase: un objeto FederatedDatabase.

    Una estructura FederatedDatabase que hace referencia a una entidad externa aAWS Glue Data Catalog.

Estructura PrincipalPermissions

Permisos concedidos a una entidad principal.

Campos

  • Principal: un objeto DataLakePrincipal.

    La entidad principal a la que se conceden los permisos.

  • Permissions: matriz de cadenas UTF-8.

    Los permisos que se conceden al principal.

Estructura DataLakePrincipal

La AWS Lake Formation principal.

Campos

  • DataLakePrincipalIdentifier: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo.

    Un identificador para la AWS Lake Formation principal.

Estructura DatabaseIdentifier

Estructura que describe una base de datos de destino para la vinculación de recursos.

Campos

  • CatalogId: cadena de ID de catálogo, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.

    El ID del Catálogo de datos donde reside la base de datos.

  • DatabaseName: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.

    Nombre de la base de datos del catálogo.

  • Region: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.

    Región de la base de datos objetivo.

Estructura de FederatedDatabase

Una base de datos que apunta a una entidad externa a AWS Glue Data Catalog.

Campos

  • Identifier: cadena UTF-8, con 1 byte de largo como mínimo y 512 bytes de largo como máximo, que coincide con el Single-line string pattern.

    Un identificador único para la base de datos federada.

  • ConnectionName: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.

    El nombre de la conexión al metalmacén externo.

Operaciones

Acción CreateDatabase (Python: create_database)

Crea una base de datos nueva en un Catálogo de datos.

Solicitud

  • CatalogId: cadena de ID de catálogo, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.

    El ID del Catálogo de datos donde se crea la base de datos. Si no se proporciona ninguno, se usará de forma predeterminada el ID de cuenta de AWS.

  • DatabaseInput: obligatorio: objeto DatabaseInput.

    Los metadatos de la base de datos.

  • Tags: matriz de mapas de pares de clave-valor, con 50 pares como máximo.

    Cada clave es una cadena UTF-8 con una longitud de entre 1 y 128 bytes.

    Cada valor es una cadena UTF-8 que no tiene más de 256 bytes de largo.

    Las etiquetas que asigna a la base de datos.

Respuesta

  • Sin parámetros de respuesta.

Errores

  • InvalidInputException

  • AlreadyExistsException

  • ResourceNumberLimitExceededException

  • InternalServiceException

  • OperationTimeoutException

  • GlueEncryptionException

  • ConcurrentModificationException

  • FederatedResourceAlreadyExistsException

Acción UpdateDatabase (Python: update_database)

Actualiza una definición de base de datos existente en un Catálogo de datos.

Solicitud

  • CatalogId: cadena de ID de catálogo, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.

    El ID del Catálogo de datos donde reside la base de datos de metadatos. Si no se proporciona ninguno, se usará de forma predeterminada el ID de cuenta de AWS.

  • Name: obligatorio: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.

    Nombre de la base de datos que debe actualizarse en el catálogo. Para su compatibilidad con Hive, se convierte en minúsculas.

  • DatabaseInput: obligatorio: objeto DatabaseInput.

    Objeto DatabaseInput que especifica la nueva definición de la base de datos de metadatos en el catálogo.

Respuesta

  • Sin parámetros de respuesta.

Errores

  • EntityNotFoundException

  • InvalidInputException

  • InternalServiceException

  • OperationTimeoutException

  • GlueEncryptionException

  • ConcurrentModificationException

Acción DeleteDatabase (Python: delete_database)

Elimina una base de datos especificada de un Catálogo de datos.

nota

Después de completar esta operación, ya no tendrá acceso a las tablas (y todas las versiones y particiones de tabla que podrían pertenecer a las tablas) ni a las funciones definidas por el usuario en la base de datos eliminada. AWS Glue elimina estos recursos “huérfanos” de manera asíncrona en forma oportuna, a discreción del servicio.

Para asegurarse de la eliminación inmediata de todos los recursos relacionados, antes de llamar a DeleteDatabase, use DeleteTableVersion o BatchDeleteTableVersion, DeletePartition o BatchDeletePartition, DeleteUserDefinedFunction y DeleteTable o BatchDeleteTable para eliminar todos los recursos que pertenezcan a la base de datos.

Solicitud

  • CatalogId: cadena de ID de catálogo, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.

    El ID del Catálogo de datos donde reside la base de datos. Si no se proporciona ninguno, se usará de forma predeterminada el ID de cuenta de AWS.

  • Name: obligatorio: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.

    El nombre de la base de datos que se va a eliminar. Para su compatibilidad con Hive, este debe estar completamente en minúsculas.

Respuesta

  • Sin parámetros de respuesta.

Errores

  • EntityNotFoundException

  • InvalidInputException

  • InternalServiceException

  • OperationTimeoutException

  • ConcurrentModificationException

Acción GetDatabase (Python: get_database)

Recupera la definición de una base de datos especificada.

Solicitud

  • CatalogId: cadena de ID de catálogo, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.

    El ID del Catálogo de datos donde reside la base de datos. Si no se proporciona ninguno, se usará de forma predeterminada el ID de cuenta de AWS.

  • Name: obligatorio: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.

    Nombre de la base de datos que debe recuperarse. Para su compatibilidad con Hive, el nombre debe estar completamente en minúsculas.

Respuesta

  • Database: un objeto Base de datos.

    La definición de la base de datos especificada en el catálogo.

Errores

  • InvalidInputException

  • EntityNotFoundException

  • InternalServiceException

  • OperationTimeoutException

  • GlueEncryptionException

  • FederationSourceException

Acción GetDatabases (Python: get_databases)

Recupera todas las bases de datos definidas en un Catálogo de datos determinado.

Solicitud

  • CatalogId: cadena de ID de catálogo, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.

    El ID del Catálogo de datos donde se recuperará Databases. Si no se proporciona ninguno, se usará de forma predeterminada el ID de cuenta de AWS.

  • NextToken: cadena UTF-8.

    Token de continuación si se trata de una llamada de continuidad.

  • MaxResults: número (entero) que no es inferior a 1 ni es superior a 100.

    Número máximo de bases de datos que se devuelven en una respuesta.

  • ResourceShareType: cadena UTF-8 (valores válidos: FOREIGN | ALL | FEDERATED).

    Le permite especificar que desea enumerar las bases de datos compartidas con su cuenta. Los valores permitidos son FEDERATED, FOREIGN o ALL.

    • Si se establece en FEDERATED, enumerará las bases de datos federadas (que hacen referencia a una entidad externa) compartidas con la cuenta.

    • Si se establece en FOREIGN, enumerará las bases de datos compartidas con su cuenta.

    • Si se establece en ALL, enumerará las bases de datos compartidas con su cuenta, así como las bases de datos de su cuenta local.

  • AttributesToGet: matriz de cadenas UTF-8.

    Especifica los campos de la base de datos devueltos por la llamada GetDatabases. Este parámetro no acepta una lista vacía. La solicitud debe incluir NAME.

Respuesta

  • DatabaseList (obligatorio): una matriz de objetos Base de datos.

    Lista de objetos Database del catálogo especificado.

  • NextToken: cadena UTF-8.

    Token de continuación para paginar la lista de tokens obtenida; se devuelve si el segmento actual de la lista no es el último.

Errores

  • InvalidInputException

  • InternalServiceException

  • OperationTimeoutException

  • GlueEncryptionException