Database API - AWS Glue

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

Database API

Il database API descrive i tipi di dati del database e include gli strumenti API per creare, eliminare, localizzare, aggiornare ed elencare i database.

Tipi di dati

Struttura dei database

L'Databaseoggetto rappresenta un raggruppamento logico di tabelle che potrebbero risiedere in un metastore Hive o in un. RDBMS

Campi
  • NameObbligatorio: UTF -8 stringhe, di lunghezza non inferiore a 1 o superiore a 255 byte, corrispondente a. Single-line string pattern

    Nome del database. Per la compatibilità Hive, questo viene scritto in minuscolo durante la memorizzazione.

  • Description: stringa di descrizione, non superiore a 2048 byte di lunghezza, corrispondente a URI address multi-line string pattern.

    Descrizione del database.

  • LocationUri: uniform resource identifier (uri), non inferiore a 1 e non superiore a 1024 byte di lunghezza, corrispondente a URI address multi-line string pattern.

    La posizione del database (ad esempio, un HDFS percorso).

  • Parameters: una matrice della mappa di coppie chiave-valore.

    Ogni chiave è una stringa chiave, non inferiore a 1 o superiore a 255 byte di lunghezza, corrispondente a Single-line string pattern.

    Ogni valore è una stringa di UTF -8, lunga non più di 512000 byte.

    Queste coppie chiave-valore definiscono parametri e proprietà del database.

  • CreateTime: timestamp.

    L'ora in cui è stato creato il database di metadati nel catalogo.

  • CreateTableDefaultPermissions: una matrice di oggetti PrincipalPermissions.

    Crea un set di autorizzazioni predefinite per la tabella dei principal. Usato da. AWS Lake Formation Non utilizzato nel normale corso delle AWS Glue operazioni.

  • TargetDatabase: un oggetto DatabaseIdentifier.

    Una struttura DatabaseIdentifier che descrive un database di destinazione per il collegamento delle risorse.

  • CatalogId: stringa ID catalogo, non inferiore a 1 o superiore a 255 byte di lunghezza, corrispondente a Single-line string pattern.

    L'ID del catalogo dati in cui risiede il database.

  • FederatedDatabase: un oggetto FederatedDatabase.

    Una struttura FederatedDatabase che fa riferimento a un'entità esterna al AWS Glue Data Catalog.

DatabaseInput struttura

Struttura utilizzata per la creazione o per l'aggiornamento di un database.

Campi
  • NameObbligatorio: UTF -8 stringhe, di lunghezza non inferiore a 1 o superiore a 255 byte, corrispondente a. Single-line string pattern

    Nome del database. Per la compatibilità Hive, questo viene scritto in minuscolo durante la memorizzazione.

  • Description: stringa di descrizione, non superiore a 2048 byte di lunghezza, corrispondente a URI address multi-line string pattern.

    Descrizione del database.

  • LocationUri: uniform resource identifier (uri), non inferiore a 1 e non superiore a 1024 byte di lunghezza, corrispondente a URI address multi-line string pattern.

    La posizione del database (ad esempio, un HDFS percorso).

  • Parameters: una matrice della mappa di coppie chiave-valore.

    Ogni chiave è una stringa chiave, non inferiore a 1 o superiore a 255 byte di lunghezza, corrispondente a Single-line string pattern.

    Ogni valore è una stringa di UTF -8, lunga non più di 512000 byte.

    Queste coppie chiave-valore definiscono parametri e proprietà del database.

    Queste coppie chiave-valore definiscono parametri e proprietà del database.

  • CreateTableDefaultPermissions: una matrice di oggetti PrincipalPermissions.

    Crea un set di autorizzazioni predefinite per la tabella dei principal. Usato da. AWS Lake Formation Non utilizzato nel normale corso delle AWS Glue operazioni.

  • TargetDatabase: un oggetto DatabaseIdentifier.

    Una struttura DatabaseIdentifier che descrive un database di destinazione per il collegamento delle risorse.

  • FederatedDatabase: un oggetto FederatedDatabase.

    Una struttura FederatedDatabase che fa riferimento a un'entità esterna al AWS Glue Data Catalog.

PrincipalPermissions struttura

Autorizzazioni concesse a un principal.

Campi
  • Principal: un oggetto DataLakePrincipal.

    Il principal a cui vengono concesse le autorizzazioni.

  • Permissions— Un array di UTF -8 stringhe.

    Le autorizzazioni concesse al principal.

DataLakePrincipal struttura

Il AWS Lake Formation preside.

Campi
  • DataLakePrincipalIdentifier— UTF -8 stringhe, di lunghezza non inferiore a 1 o superiore a 255 byte.

    Un identificatore per il principale. AWS Lake Formation

DatabaseIdentifier struttura

Una struttura che descrive un database di destinazione per il collegamento delle risorse.

Campi
  • CatalogId: stringa ID catalogo, non inferiore a 1 o superiore a 255 byte di lunghezza, corrispondente a Single-line string pattern.

    L'ID del catalogo dati in cui risiede il database.

  • DatabaseName— UTF -8 stringhe, di lunghezza non inferiore a 1 o più di 255 byte, corrispondente a. Single-line string pattern

    Il nome del database del catalogo.

  • Region— UTF -8 stringhe, di lunghezza non inferiore a 1 o più di 255 byte, corrispondente a. Single-line string pattern

    La regione della tabella di destinazione.

FederatedDatabase struttura

Un database che punta a un'entità esterna al AWS Glue Data Catalog.

Campi
  • Identifier— UTF -8 stringhe, di lunghezza non inferiore a 1 o più di 512 byte, corrispondente a. Single-line string pattern

    Un identificatore univoco per la tabella federata.

  • ConnectionName— UTF -8 stringhe, di lunghezza non inferiore a 1 o più di 255 byte, corrispondente a. Single-line string pattern

    Il nome della connessione al metastore esterno.

Operazioni

CreateDatabase azione (Python: create_database)

Crea un nuovo database in un catalogo di dati.

Richiesta
  • CatalogId: stringa ID catalogo, non inferiore a 1 o superiore a 255 byte di lunghezza, corrispondente a Single-line string pattern.

    L'ID del catalogo dati in cui creare il database. Se non ne viene fornito nessuno, per impostazione predefinita viene utilizzato l'ID AWS dell'account.

  • DatabaseInput: obbligatorio: un oggetto DatabaseInput.

    I metadati per il database.

  • Tags: una matrice di mappe con coppie chiave-valore, non superiore alle 50 coppie.

    Ogni chiave è una stringa di UTF -8, lunga non meno di 1 o più di 128 byte.

    Ogni valore è una stringa di UTF -8, lunga non più di 256 byte.

    I tag assegnati al database.

Risposta
  • Nessun parametro di risposta.

Errori
  • InvalidInputException

  • AlreadyExistsException

  • ResourceNumberLimitExceededException

  • InternalServiceException

  • OperationTimeoutException

  • GlueEncryptionException

  • ConcurrentModificationException

  • FederatedResourceAlreadyExistsException

  • FederationSourceException

  • FederationSourceRetryableException

UpdateDatabase azione (Python: update_database)

Aggiorna una definizione di database esistente in un catalogo dati.

Richiesta
  • CatalogId: stringa ID catalogo, non inferiore a 1 o superiore a 255 byte di lunghezza, corrispondente a Single-line string pattern.

    L'ID del catalogo dati in cui risiede il database dei metadati. Se non ne viene fornito nessuno, per impostazione predefinita viene utilizzato l'ID AWS dell'account.

  • NameObbligatorio: UTF -8 stringhe, di lunghezza non inferiore a 1 o superiore a 255 byte, corrispondente a. Single-line string pattern

    Il nome del database da caricare nel catalogo. Per la compatibilità Hive, questo è scritto in caratteri minuscoli.

  • DatabaseInput: obbligatorio: un oggetto DatabaseInput.

    Un oggetto DatabaseInput che specifica la nuova definizione del database di metadati nel catalogo.

Risposta
  • Nessun parametro di risposta.

Errori
  • EntityNotFoundException

  • InvalidInputException

  • InternalServiceException

  • OperationTimeoutException

  • GlueEncryptionException

  • ConcurrentModificationException

  • FederationSourceException

  • FederationSourceRetryableException

  • AlreadyExistsException

DeleteDatabase azione (Python: delete_database)

Rimuove un database specificato da un catalogo dati.

Nota

Dopo aver completato questa operazione, non è più possibile accedere alle tabelle (e a tutte le versioni e partizioni delle tabelle che potrebbero appartenere alle tabelle) e alle funzioni definite dall'utente nel database eliminato. AWS Glue elimina queste risorse «orfane» in modo asincrono in modo tempestivo, a discrezione del servizio.

Per garantire l'eliminazione immediata di tutte le risorse correlate, prima di chiamare DeleteDatabase, utilizza DeleteTableVersion o BatchDeleteTableVersion, DeletePartition o BatchDeletePartition, DeleteUserDefinedFunction e DeleteTable o BatchDeleteTable per eliminare eventuali risorse che appartengono al database.

Richiesta
  • CatalogId: stringa ID catalogo, non inferiore a 1 o superiore a 255 byte di lunghezza, corrispondente a Single-line string pattern.

    L'ID del catalogo dati in cui risiede il database. Se non ne viene fornito nessuno, per impostazione predefinita viene utilizzato l'ID AWS dell'account.

  • NameObbligatorio: UTF -8 stringhe, di lunghezza non inferiore a 1 o superiore a 255 byte, corrispondente a. Single-line string pattern

    Il nome del database da eliminare. Per la compatibilità Hive, deve essere interamente in caratteri minuscoli.

Risposta
  • Nessun parametro di risposta.

Errori
  • EntityNotFoundException

  • InvalidInputException

  • InternalServiceException

  • OperationTimeoutException

  • ConcurrentModificationException

  • FederationSourceException

  • FederationSourceRetryableException

GetDatabase azione (Python: get_database)

Recupera la definizione di un database specificato.

Richiesta
  • CatalogId: stringa ID catalogo, non inferiore a 1 o superiore a 255 byte di lunghezza, corrispondente a Single-line string pattern.

    L'ID del catalogo dati in cui risiede il database. Se non ne viene fornito nessuno, per impostazione predefinita viene utilizzato l'ID AWS dell'account.

  • NameObbligatorio: UTF -8 stringhe, di lunghezza non inferiore a 1 o superiore a 255 byte, corrispondente a. Single-line string pattern

    Nome del database da ripristinare. Per la compatibilità Hive, deve essere interamente in caratteri minuscoli.

Risposta
  • Database: un oggetto Database.

    La definizione del database specificato nel catalogo dati.

Errori
  • InvalidInputException

  • EntityNotFoundException

  • InternalServiceException

  • OperationTimeoutException

  • GlueEncryptionException

  • FederationSourceException

  • FederationSourceRetryableException

GetDatabases azione (Python: get_databases)

Recupera tutti i database definiti in un determinato catalogo dati.

Richiesta
  • CatalogId: stringa ID catalogo, non inferiore a 1 o superiore a 255 byte di lunghezza, corrispondente a Single-line string pattern.

    L'ID del catalogo dati da cui recuperare Databases. Se non ne viene fornito nessuno, per impostazione predefinita viene utilizzato l'ID AWS dell'account.

  • NextToken— UTF -8 stringhe.

    Un token di continuazione, se si tratta di una chiamata di continuazione.

  • MaxResults: numero (intero), non inferiore a 1 o superiore a 100.

    Il numero massimo di database da restituire in una risposta.

  • ResourceShareType— UTF -8 stringhe (valori validi: FOREIGN | ALL |FEDERATED).

    Consente di specificare che si desidera elencare i database condivisi con l'account. I valori consentiti sono FEDERATED, FOREIGN o ALL.

    • Se impostato su FEDERATED, elencherà i database federati (con riferimento a un'entità esterna) condivisi con l'account.

    • Se impostato su FOREIGN, elencherà i database condivisi con l'account.

    • Se impostato su ALL, elencherà i database condivisi con l'account, così come i database nell'account locale.

  • AttributesToGet— Un array di UTF -8 stringhe.

    Specifica i campi del database restituiti dalla GetDatabases chiamata. Questo parametro non accetta un elenco vuoto. La richiesta deve includere ilNAME.

Risposta
  • DatabaseList: obbligatorio: una matrice di oggetti Database.

    Un elenco di oggetti Database dal catalogo specificato.

  • NextToken— UTF -8 corde.

    Un token di continuazione per impaginare l'elenco restituito di token, restituiti se il segmento corrente dell'elenco non è l'ultimo.

Errori
  • InvalidInputException

  • InternalServiceException

  • OperationTimeoutException

  • GlueEncryptionException

  • EntityNotFoundException

  • FederationSourceException

  • FederationSourceRetryableException