API d'une base de données - AWS Glue
  —  types de données  —Database (Base de données)DatabaseInputPrincipalPermissionsDataLakePrincipalDatabaseIdentifierFederatedDatabase  —  operations  —CreateDatabase (create_database)UpdateDatabase (update_database)DeleteDatabase (delete_database)GetDatabase (get_database)GetDatabases (get_databases)

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

API d'une base de données

L'API de base de données décrit les types de données d'une base de données et comprend l'API permettant de créer, supprimer, localiser, mettre à jour et répertorier des bases de données.

Types de données

Structure Database

L'objet Database représente un groupement logique de tables pouvant résider dans un metastore Hive ou un SGBDR.

Champs

  • Name – Obligatoire : Chaîne UTF-8, d'une longueur comprise entre 1 et 255 octets, correspondant au Single-line string pattern.

    Nom de la base de données. Pour des raisons de compatibilité avec Hive, ce nom est converti en minuscules lors de son stockage.

  • Description – Chaîne de description, d'une longueur maximale de 2 048 octets, correspondant au URI address multi-line string pattern.

    Description de la base de données.

  • LocationUri – Identificateur de ressource uniforme (URI), d'une longueur comprise entre 1 et 1024 octets, correspondant au URI address multi-line string pattern.

    Emplacement de la base de données (par exemple, un chemin HDFS).

  • Parameters – Tableau de mappage de paires valeur-clé.

    Chaque clé est une chaîne de clé, d'une longueur comprise entre 1 et 255 octets, correspondant au Single-line string pattern.

    Chaque valeur est une chaîne UTF-8, d'une longueur maximale de 512 000 octets.

    Ces paires clé-valeur définissent les paramètres et les propriétés de la base de données.

  • CreateTime – Horodatage.

    Heure à laquelle la base de données de métadonnées a été créée dans le catalogue.

  • CreateTableDefaultPermissions – Un tableau d'objets PrincipalPermissions.

    Crée un ensemble d'autorisations par défaut sur le tableau pour les principaux. Utilisé par AWS Lake Formation. Non utilisé dans le cours normal des opérations AWS Glue.

  • TargetDatabase – Un objet DatabaseIdentifier.

    Structure DatabaseIdentifier qui décrit une base de données cible pour la liaison de ressources.

  • CatalogId – Chaîne d'ID de catalogue, d'une longueur comprise entre 1 et 255 octets, correspondant au Single-line string pattern.

    ID du catalogue de données dans lequel réside la base de données.

  • FederatedDatabase – Un objet FederatedDatabase.

    Une structure FederatedDatabase qui fait référence à une entité extérieure à AWS Glue Data Catalog.

Structure DatabaseInput

Structure utilisée pour créer ou mettre à jour une base de données.

Champs

  • Name – Obligatoire : Chaîne UTF-8, d'une longueur comprise entre 1 et 255 octets, correspondant au Single-line string pattern.

    Nom de la base de données. Pour des raisons de compatibilité avec Hive, ce nom est converti en minuscules lors de son stockage.

  • Description – Chaîne de description, d'une longueur maximale de 2 048 octets, correspondant au URI address multi-line string pattern.

    Description de la base de données.

  • LocationUri – Identificateur de ressource uniforme (URI), d'une longueur comprise entre 1 et 1024 octets, correspondant au URI address multi-line string pattern.

    Emplacement de la base de données (par exemple, un chemin HDFS).

  • Parameters – Tableau de mappage de paires valeur-clé.

    Chaque clé est une chaîne de clé, d'une longueur comprise entre 1 et 255 octets, correspondant au Single-line string pattern.

    Chaque valeur est une chaîne UTF-8, d'une longueur maximale de 512 000 octets.

    Ces paires clé-valeur définissent les paramètres et les propriétés de la base de données.

    Ces paires clé-valeur définissent les paramètres et les propriétés de la base de données.

  • CreateTableDefaultPermissions – Un tableau d'objets PrincipalPermissions.

    Crée un ensemble d'autorisations par défaut sur le tableau pour les principaux. Utilisé par AWS Lake Formation. Non utilisé dans le cours normal des opérations AWS Glue.

  • TargetDatabase – Un objet DatabaseIdentifier.

    Structure DatabaseIdentifier qui décrit une base de données cible pour la liaison de ressources.

  • FederatedDatabase – Un objet FederatedDatabase.

    Une structure FederatedDatabase qui fait référence à une entité extérieure à AWS Glue Data Catalog.

Structure PrincipalPermissions

Autorisations accordées à un principal.

Champs

  • Principal – Un objet DataLakePrincipal.

    Principal à qui les autorisations sont accordées.

  • Permissions – Tableau de chaînes UTF-8.

    Autorisations accordées au principal.

Structure DataLakePrincipal

Le principal AWS Lake Formation.

Champs

  • DataLakePrincipalIdentifier – Chaîne UTF-8, d'une longueur comprise entre 1 et 255 octets.

    Un identifiant pour le principal AWS Lake Formation.

Structure DatabaseIdentifier

Structure qui décrit une base de données cible pour la liaison de ressources.

Champs

  • CatalogId – Chaîne d'ID de catalogue, d'une longueur comprise entre 1 et 255 octets, correspondant au Single-line string pattern.

    ID du catalogue de données dans lequel réside la base de données.

  • DatabaseName – Chaîne UTF-8, d'une longueur comprise entre 1 et 255 octets, correspondant au Single-line string pattern.

    Nom de la base de données du catalogue.

  • Region – Chaîne UTF-8, d'une longueur comprise entre 1 et 255 octets, correspondant au Single-line string pattern.

    Région de la base de données cible.

Structure de FederatedDatabase

Une base de données qui pointe vers une entité extérieure à AWS Glue Data Catalog.

Champs

  • Identifier – Chaîne UTF-8, d'une longueur comprise entre 1 et 512 octets, correspondant au Single-line string pattern.

    Un identifiant unique pour la base de données fédérée.

  • ConnectionName – Chaîne UTF-8, d'une longueur comprise entre 1 et 255 octets, correspondant au Single-line string pattern.

    Le nom de la connexion au métastore externe.

Opérations

Action CreateDatabase (Python : create_database)

Crée une nouvelle base de données dans un catalogue de données.

Requête

  • CatalogId – Chaîne d'ID de catalogue, d'une longueur comprise entre 1 et 255 octets, correspondant au Single-line string pattern.

    ID du catalogue de données dans lequel créer la base de données. Si aucun n'est fourni, l'ID de compte AWS est utilisé par défaut.

  • DatabaseInput – Obligatoire : un objet DatabaseInput.

    Métadonnées pour la base de données.

  • Tags – Tableau de mappage de paires clé-valeur, avec 50 paires au maximum.

    Chaque clé est une chaîne UTF-8, d'une longueur comprise entre 1 et 128 octets.

    Chaque valeur est une chaîne UTF-8, d'une longueur maximale de 256 octets.

    Les balises que vous attribuez à la base de données.

Réponse

  • Paramètres d'absence de réponse.

Erreurs

  • InvalidInputException

  • AlreadyExistsException

  • ResourceNumberLimitExceededException

  • InternalServiceException

  • OperationTimeoutException

  • GlueEncryptionException

  • ConcurrentModificationException

  • FederatedResourceAlreadyExistsException

Action UpdateDatabase (Python : update_database)

Met à jour une définition de base de données existante dans un catalogue de données.

Requête

  • CatalogId – Chaîne d'ID de catalogue, d'une longueur comprise entre 1 et 255 octets, correspondant au Single-line string pattern.

    ID du catalogue de données dans lequel réside la base de données de métadonnées. Si aucun n'est fourni, l'ID de compte AWS est utilisé par défaut.

  • Name – Obligatoire : Chaîne UTF-8, d'une longueur comprise entre 1 et 255 octets, correspondant au Single-line string pattern.

    Nom de la base de données à mettre à jour dans le catalogue. Pour la compatibilité Hive, ce nom est converti en minuscules.

  • DatabaseInput – Obligatoire : un objet DatabaseInput.

    Objet DatabaseInput spécifiant la nouvelle définition de la base de données de métadonnées dans le catalogue.

Réponse

  • Paramètres d'absence de réponse.

Erreurs

  • EntityNotFoundException

  • InvalidInputException

  • InternalServiceException

  • OperationTimeoutException

  • GlueEncryptionException

  • ConcurrentModificationException

Action DeleteDatabase (Python : delete_database)

Supprime une base de données spécifiée d'un catalogue de données.

Note

Après avoir effectué cette opération, vous n'avez plus accès ni aux tables (ainsi qu'aux versions et partitions de table appartenant à celles-ci), ni aux fonctions définies par l'utilisateur dans la base de données supprimée. AWS Glue supprime ces ressources « orphelines » de manière asynchrone et en temps voulu, à la discrétion du service.

Pour garantir la suppression immédiate de toutes les ressources connexes, avant d'appeler DeleteDatabase, utilisez DeleteTableVersion ou BatchDeleteTableVersion, DeletePartition ou BatchDeletePartition, DeleteUserDefinedFunction, et DeleteTable ou BatchDeleteTable pour supprimer les ressources appartenant à la base de données.

Requête

  • CatalogId – Chaîne d'ID de catalogue, d'une longueur comprise entre 1 et 255 octets, correspondant au Single-line string pattern.

    ID du catalogue de données dans lequel réside la base de données. Si aucun n'est fourni, l'ID de compte AWS est utilisé par défaut.

  • Name – Obligatoire : Chaîne UTF-8, d'une longueur comprise entre 1 et 255 octets, correspondant au Single-line string pattern.

    Nom de la base de données à supprimer. Pour la compatibilité Hive, ce nom doit être entièrement en minuscules.

Réponse

  • Paramètres d'absence de réponse.

Erreurs

  • EntityNotFoundException

  • InvalidInputException

  • InternalServiceException

  • OperationTimeoutException

  • ConcurrentModificationException

Action GetDatabase (Python : get_database)

Extrait la définition d'une base de données spécifiée.

Requête

  • CatalogId – Chaîne d'ID de catalogue, d'une longueur comprise entre 1 et 255 octets, correspondant au Single-line string pattern.

    ID du catalogue de données dans lequel réside la base de données. Si aucun n'est fourni, l'ID de compte AWS est utilisé par défaut.

  • Name – Obligatoire : Chaîne UTF-8, d'une longueur comprise entre 1 et 255 octets, correspondant au Single-line string pattern.

    Nom la base de données à extraire. Pour la compatibilité Hive, ce nom doit être entièrement en minuscules.

Réponse
Erreurs

  • InvalidInputException

  • EntityNotFoundException

  • InternalServiceException

  • OperationTimeoutException

  • GlueEncryptionException

  • FederationSourceException

Action GetDatabases (Python : get_databases)

Extrait toutes les bases de données définies dans un catalogue de données donnée.

Requête

  • CatalogId – Chaîne d'ID de catalogue, d'une longueur comprise entre 1 et 255 octets, correspondant au Single-line string pattern.

    ID du catalogue de données à partir duquel extraire Databases. Si aucun n'est fourni, l'ID de compte AWS est utilisé par défaut.

  • NextToken – Chaîne UTF-8.

    Jeton de continuation, s'il s'agit d'un appel de continuation.

  • MaxResults – Nombre (entier), compris entre 1 et 100.

    Nombre maximum de bases de données renvoyées par réponse.

  • ResourceShareType – Chaîne UTF-8 (valeurs valides : FOREIGN | ALL | FEDERATED).

    Permet de spécifier que vous souhaitez répertorier les bases de données partagées avec votre compte. Les valeurs autorisées sont FEDERATED, FOREIGN ou ALL.

    • Si la valeur est définie sur FEDERATED, la liste des bases de données fédérées (référençant une entité externe) partagées avec votre compte sera affichée.

    • Si défini sur FOREIGN, répertorie les bases de données partagées avec votre compte.

    • Si défini sur ALL, répertorie les bases de données partagées avec votre compte, ainsi que les bases de données dans votre compte local.

Réponse

  • DatabaseList – Obligatoire : Un tableau d'objets Database (Base de données).

    Liste d'objets Database à partir du catalogue spécifié.

  • NextToken – Chaîne UTF-8.

    Jeton de continuation pour la pagination de la liste des jetons renvoyés, renvoyé si le segment actuel de la liste n'est pas le dernier.

Erreurs

  • InvalidInputException

  • InternalServiceException

  • OperationTimeoutException

  • GlueEncryptionException