Utilizzo della funzione di introspezione (console)Utilizzo della funzione di introspezione (API)

Introspezione RDS

AWS AppSyncsemplifica la creazione di API da database relazionali esistenti. La sua utilità di introspezione può scoprire modelli dalle tabelle del database e proporre tipi GraphQL. La procedura guidata Create API della AWS AppSync console può generare istantaneamente un'API da un database Aurora MySQL o PostgreSQL. Crea automaticamente tipi e resolver per leggere e scrivere dati JavaScript .

AWS AppSyncfornisce l'integrazione diretta con i database Amazon Aurora tramite l'API Amazon RDS Data. Anziché richiedere una connessione persistente al database, l'API Amazon RDS Data offre un endpoint HTTP sicuro a cui AWS AppSync connettersi per l'esecuzione SQL di istruzioni. Puoi usarlo per creare un'API di database relazionale per i tuoi carichi di lavoro MySQL e PostgreSQL su Aurora.

La creazione di un'API per il database relazionale presenta diversi vantaggi: AWS AppSync

Il database non è esposto direttamente ai client, il che significa che il punto di accesso è separato dal database stesso.
È possibile creare API personalizzate in base alle esigenze di diverse applicazioni, eliminando la necessità di una logica aziendale personalizzata nei frontend. Questo è in linea con il modello Backend-For-Frontend (BFF).
L'autorizzazione e il controllo degli accessi possono essere implementati a AWS AppSync livello utilizzando varie modalità di autorizzazione per controllare l'accesso. Non sono necessarie risorse di elaborazione aggiuntive per connettersi al database, ad esempio l'hosting di un server Web o l'invio di connessioni tramite proxy.
È possibile aggiungere funzionalità in tempo reale tramite abbonamenti, con le mutazioni dei dati effettuate AppSync automaticamente tramite push ai client connessi.
I client possono connettersi all'API tramite HTTPS utilizzando porte comuni come 443.

AWS AppSyncsemplifica la creazione di API a partire da database relazionali esistenti. La sua utilità di introspezione può scoprire modelli dalle tabelle del database e proporre tipi GraphQL. La procedura guidata Create API della AWS AppSync console può generare istantaneamente un'API da un database Aurora MySQL o PostgreSQL. Crea automaticamente tipi e resolver per leggere e scrivere dati JavaScript.

AWS AppSyncfornisce JavaScript utilità integrate per semplificare la scrittura di istruzioni SQL nei resolver. È possibile utilizzare i modelli AWS AppSync di sql tag per istruzioni statiche con valori dinamici o le utilità del rds modulo per creare istruzioni a livello di codice. Per ulteriori informazioni, consulta il riferimento alla funzione resolver per le fonti di dati RDS e i moduli integrati.

Utilizzo della funzione di introspezione (console)

Per un tutorial dettagliato e una guida introduttiva, vedi Tutorial: Aurora PostgreSQL Serverless with Data API.

La AWS AppSync console consente di creare un'API AWS AppSync GraphQL dal database Aurora esistente configurato con l'API Data in pochi minuti. Questo genera rapidamente uno schema operativo basato sulla configurazione del database. Puoi utilizzare l'API così com'è o basarti su di essa per aggiungere funzionalità.

Accedere alla AWS Management Console e aprire la console AppSync.
1. Nel pannello di controllo, scegliere Create API (Crea API).
In Opzioni API, scegli API GraphQL, Inizia con un cluster Amazon Aurora, quindi Avanti.
1. Inserisci un nome API. Verrà utilizzato come identificatore per l'API nella console.
2. Per i dettagli di contatto, puoi inserire un punto di contatto per identificare un gestore dell'API. Questo campo è opzionale.
3. In Configurazione API privata, puoi abilitare le funzionalità dell'API privata. È possibile accedere a un'API privata solo da un endpoint VPC configurato (VPCE). Per ulteriori informazioni, consulta API private.
  
  Non è consigliabile abilitare questa funzionalità per questo esempio. Scegli Avanti dopo aver esaminato i dati inseriti.
Nella pagina Database, scegli Seleziona database.
1. È necessario scegliere il database dal cluster. Il primo passo è scegliere la regione in cui esiste il cluster.
2. Scegli il cluster Aurora dall'elenco a discesa. Tieni presente che devi aver creato e abilitato un'API di dati corrispondente prima di utilizzare la risorsa.
3. Successivamente, è necessario aggiungere le credenziali del database al servizio. Questo viene fatto principalmente utilizzandoAWS Secrets Manager. Scegli la regione in cui esiste il tuo segreto. Per ulteriori informazioni su come recuperare informazioni segrete, consulta Trova segreti o Recupera segreti.
4. Aggiungi il tuo segreto dall'elenco a discesa. Tieni presente che l'utente deve disporre delle autorizzazioni di lettura per il tuo database.

Seleziona Importa.

AWS AppSyncinizierà a esaminare il database, scoprendo tabelle, colonne, chiavi primarie e indici. Verifica che le tabelle rilevate possano essere supportate in un'API GraphQL. Nota che per supportare la creazione di nuove righe, le tabelle necessitano di una chiave primaria, che può utilizzare più colonne. AWS AppSyncmappa le colonne della tabella per digitare i campi come segue:

Tipo di dati	Tipo di campo
VARCHAR	String
CHAR	String
BINARY	String
VARBINARY	String
TINYBLOB	String
TINYTEXT	String
TEXT	String
BLOB	String
MEDIUMTEXT	String
MEDIUMBLOB	String
LONGTEXT	String
LONGBLOB	String
BOOL	Boolean
BOOLEAN	Boolean
BIT	Int
TINYINT	Int
SMALLINT	Int
MEDIUMINT	Int
INT	Int
INTEGER	Int
BIGINT	Int
YEAR	Int
FLOAT	Float
DOUBLE	Float
DECIMAL	Float
DEC	Float
NUMERIC	Float
DATE	AWSDate
TIMESTAMP	String
DATETIME	String
TIME	AWSTime
JSON	AWSJson
ENUM	ENUM

Una volta completata l'individuazione delle tabelle, la sezione Database verrà popolata con le informazioni dell'utente. Nella nuova sezione Tabelle del database, i dati della tabella potrebbero già essere compilati e convertiti in un tipo adatto allo schema. Se non vedi alcuni dei dati richiesti, puoi verificarli scegliendo Aggiungi tabelle, facendo clic sulle caselle di controllo relative a tali tipi nella finestra modale visualizzata, quindi scegliendo Aggiungi.

Per rimuovere un tipo dalla sezione Tabelle del database, fai clic sulla casella di controllo accanto al tipo che desideri rimuovere, quindi scegli Rimuovi. I tipi rimossi verranno inseriti nella modalità Aggiungi tabelle se desideri aggiungerli nuovamente in un secondo momento.

Nota che AWS AppSync utilizza i nomi delle tabelle come nomi dei tipi, ma puoi rinominarli, ad esempio cambiando il nome di una tabella plurale come movies con il nome del tipo Movie. Per rinominare un tipo nella sezione Tabelle del database, fai clic sulla casella di controllo del tipo che desideri rinominare, quindi fai clic sull'icona a forma di matita nella colonna Nome tipo.

Per visualizzare in anteprima il contenuto dello schema in base alle tue selezioni, scegli Anteprima schema. Tieni presente che questo schema non può essere vuoto, quindi dovrai convertire almeno una tabella in un tipo. Inoltre, questo schema non può superare 1 MB di dimensione.
1. In Ruolo di servizio, scegli se creare un nuovo ruolo di servizio specifico per questa importazione o utilizzare un ruolo esistente.
Seleziona Avanti.
Quindi, scegli se creare un'API di sola lettura (solo query) o un'API per leggere e scrivere dati (con query e mutazioni). Quest'ultima supporta anche sottoscrizioni in tempo reale innescate da mutazioni.
Seleziona Avanti.
Controlla le tue scelte e poi scegli Crea API. AWS AppSynccreerà l'API e collegherà i resolver a query e mutazioni. L'API generata è completamente operativa e può essere estesa secondo necessità.

Utilizzo della funzione di introspezione (API)

Puoi utilizzare l'API di StartDataSourceIntrospection introspezione per scoprire i modelli nel tuo database a livello di codice. Per maggiori dettagli sul comando, consulta Utilizzo dell'API. StartDataSourceIntrospection

Per utilizzarloStartDataSourceIntrospection, fornisci il nome Amazon Resource Name (ARN) del cluster Aurora, il nome del database e l'ARN segreto. AWS Secrets Manager Il comando avvia il processo di introspezione. È possibile recuperare i risultati con il comando. GetDataSourceIntrospection È possibile specificare se il comando deve restituire la stringa Storage Definition Language (SDL) per i modelli rilevati. Ciò è utile per generare una definizione dello schema SDL direttamente dai modelli scoperti.

Ad esempio, se avete la seguente istruzione DDL (Data Definition Language) per una tabella semplice: Todos


create table if not exists public.todos  
(  
id serial constraint todos_pk primary key,  
description text,  
due timestamp,  
"createdAt" timestamp default now()  
);

Iniziate l'introspezione con quanto segue.


aws appsync start-data-source-introspection \ 
  --rds-data-api-config resourceArn=<cluster-arn>,secretArn=<secret-arn>,databaseName=database

Quindi, utilizzate il GetDataSourceIntrospection comando per recuperare il risultato.


aws appsync get-data-source-introspection \
  --introspection-id a1234567-8910-abcd-efgh-identifier \
  --include-models-sdl

Ciò restituisce il seguente risultato.


{
    "introspectionId": "a1234567-8910-abcd-efgh-identifier",
    "introspectionStatus": "SUCCESS",
    "introspectionStatusDetail": null,
    "introspectionResult": {
        "models": [
            {
                "name": "todos",
                "fields": [
                    {
                        "name": "description",
                        "type": {
                            "kind": "Scalar",
                            "name": "String",
                            "type": null,
                            "values": null
                        },
                        "length": 0
                    },
                    {
                        "name": "due",
                        "type": {
                            "kind": "Scalar",
                            "name": "AWSDateTime",
                            "type": null,
                            "values": null
                        },
                        "length": 0
                    },
                    {
                        "name": "id",
                        "type": {
                            "kind": "NonNull",
                            "name": null,
                            "type": {
                                "kind": "Scalar",
                                "name": "Int",
                                "type": null,
                                "values": null
                            },
                            "values": null
                        },
                        "length": 0
                    },
                    {
                        "name": "createdAt",
                        "type": {
                            "kind": "Scalar",
                            "name": "AWSDateTime",
                            "type": null,
                            "values": null
                        },
                        "length": 0
                    }
                ],
                "primaryKey": {
                    "name": "PRIMARY_KEY",
                    "fields": [
                        "id"
                    ]
                },
                "indexes": [],
                "sdl": "type todos\n{\ndescription: String\n\ndue: AWSDateTime\n\nid: Int!\n\ncreatedAt: AW
SDateTime\n}\n"
            }
        ],
        "nextToken": null
    }
}

Avvertimento JavaScript è disabilitato o non è disponibile nel tuo browser.

Per usare la documentazione AWS, JavaScript deve essere abilitato. Consulta le pagine della guida del browser per le istruzioni.

Convenzioni dei documenti

API unite

Creazione di un'applicazione client