API database - AWS Glue
  —  tipi di dati  —DatabaseDatabaseInputPrincipalPermissionsDataLakePrincipalDatabaseIdentifierFederatedDatabase —  operazioni  —CreateDatabase (create_database)UpdateDatabase (update_database)DeleteDatabase (delete_database)GetDatabase (get_database)GetDatabases (get_databases)

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à.

API database

L'API Database descrive i tipi di dati del database e include l'API per creare, eliminare, localizzare, aggiornare ed elencare i database.

Tipi di dati

Struttura dei database

L'oggetto Database rappresenta un raggruppamento logico di tabelle che potrebbero trovarsi in un metastore Hive o in un RDBMS.

Campi

  • Name: obbligatorio: stringa UTF-8, non inferiore a 1 o superiore a 255 byte di lunghezza, 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 (per esempio, un percorso HDFS).

  • 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 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. Utilizzato da AWS Lake Formation. Non utilizzato nel corso delle normali operazioni di AWS Glue.

  • 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.

Struttura DatabaseInput

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

Campi

  • Name: obbligatorio: stringa UTF-8, non inferiore a 1 o superiore a 255 byte di lunghezza, 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 (per esempio, un percorso HDFS).

  • 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 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. Utilizzato da AWS Lake Formation. Non utilizzato nel corso delle normali operazioni di AWS Glue.

  • 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.

Struttura PrincipalPermissions

Autorizzazioni concesse a un principal.

Campi

  • Principal: un oggetto DataLakePrincipal.

    Il principal a cui vengono concesse le autorizzazioni.

  • Permissions: una matrice di stringhe UTF-8.

    Le autorizzazioni concesse al principal.

Struttura DataLakePrincipal

Il principale AWS Lake Formation.

Campi

  • DataLakePrincipalIdentifier: stringa UTF-8, non inferiore a 1 o superiore a 255 byte di lunghezza.

    Un identificatore del principal AWS Lake Formation.

Struttura DatabaseIdentifier

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: stringa UTF-8, non inferiore a 1 o superiore a 255 byte di lunghezza, corrispondente a Single-line string pattern.

    Il nome del database del catalogo.

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

    La regione della tabella di destinazione.

Struttura FederatedDatabase

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

Campi

  • Identifier: stringa UTF-8, non inferiore a 1 o superiore a 512 byte di lunghezza, corrispondente a Single-line string pattern.

    Un identificatore univoco per la tabella federata.

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

    Il nome della connessione al metastore esterno.

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

    Il tipo di connessione utilizzato per accedere al database federato, ad esempio JDBC, ODBC o altri protocolli di connessione supportati.

Operazioni

Operazione CreateDatabase (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 viene fornito, per impostazione predefinita viene utilizzato l'ID dell'account AWS.

  • 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 UTF-8, non inferiore a 1 o superiore a 128 byte di lunghezza.

    Ogni valore è una stringa 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

Operazione UpdateDatabase (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 viene fornito, per impostazione predefinita viene utilizzato l'ID dell'account AWS.

  • Name: obbligatorio: stringa UTF-8, non inferiore a 1 o superiore a 255 byte di lunghezza, 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

Operazione DeleteDatabase (Python: delete_database)

Rimuove un database specificato da un catalogo dati.

Nota

Una volta completata questa operazione, non potrai più accedere alle tabelle (e a tutte le versioni e le partizioni delle tabelle che potrebbero appartenere alle tabelle stesse) e alle funzioni definite dall'utente del database eliminato. AWS Glue elimina tempestivamente queste risorse "orfane" in modo asincrono, 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 viene fornito, per impostazione predefinita viene utilizzato l'ID dell'account AWS.

  • Name: obbligatorio: stringa UTF-8, non inferiore a 1 o superiore a 255 byte di lunghezza, 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

Operazione GetDatabase (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 viene fornito, per impostazione predefinita viene utilizzato l'ID dell'account AWS.

  • Name: obbligatorio: stringa UTF-8, non inferiore a 1 o superiore a 255 byte di lunghezza, 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

Operazione GetDatabase (Python: get_database)

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 viene fornito, per impostazione predefinita viene utilizzato l'ID dell'account AWS.

  • NextToken: stringa UTF-8.

    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: stringa UTF-8 (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: una matrice di stringhe UTF-8.

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

Risposta

  • DatabaseList: obbligatorio: una matrice di oggetti Database.

    Un elenco di oggetti Database dal catalogo specificato.

  • NextToken: stringa UTF-8.

    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