CockroachDB

Il connettore CockroachDB consente di eseguire operazioni di inserimento, eliminazione, aggiornamento e lettura su un database CockroachDB.

Prima di iniziare

Prima di utilizzare il connettore CockroachDB, esegui queste attività:

Nel tuo progetto Google Cloud:
- Concedi il ruolo IAM roles/connectors.admin all'utente che configura il connettore.
- Concedi i seguenti ruoli IAM all'account di servizio che vuoi utilizzare per il connettore:
  - roles/secretmanager.viewer
  - roles/secretmanager.secretAccessor
  Un account di servizio è un tipo speciale di Account Google destinato a rappresentare un utente "non umano" che deve autenticarsi ed essere autorizzato ad accedere ai dati nelle API di Google. Se non hai un account di servizio, devi crearne uno. Per saperne di più, consulta la pagina sulla creazione di un account di servizio.
- Abilita i seguenti servizi:
  - secretmanager.googleapis.com (API Secret Manager)
  - connectors.googleapis.com (API Connectors)
  Per informazioni su come abilitare i servizi, vedi Abilitazione dei servizi.
Se questi servizi o queste autorizzazioni non sono stati abilitati per il tuo progetto in precedenza, ti verrà chiesto di abilitarli durante la configurazione del connettore.

Configura il connettore

Per configurare il connettore è necessario creare una connessione all'origine dati (sistema di backend). Una connessione è specifica per un'origine dati. Ciò significa che se disponi di molte origini dati, devi creare una connessione separata per ciascuna. Per creare una connessione, segui questi passaggi:

Nella console Cloud, vai alla pagina Connettori di integrazione > Connessioni, quindi seleziona o crea un progetto Google Cloud.
Vai alla pagina Connessioni
Fai clic su + CREA NUOVO per aprire la pagina Crea connessione.
Nella sezione Posizione, scegli la località per la connessione.
1. Regione: seleziona una località dall'elenco a discesa.
  Per l'elenco di tutte le regioni supportate, vedi Località.
2. Fai clic su AVANTI.
Nella sezione Dettagli connessione, completa quanto segue:
1. Connettore: seleziona CockroachDB dall'elenco a discesa dei connettori disponibili.
2. Versione connettore: seleziona la versione del connettore dall'elenco a discesa delle versioni disponibili.
3. Nel campo Nome connessione, inserisci un nome per l'istanza di connessione.
  I nomi delle connessioni devono soddisfare i seguenti criteri:
  - I nomi delle connessioni possono contenere lettere, numeri o trattini.
  - Le lettere devono essere minuscole.
  - I nomi delle connessioni devono iniziare con una lettera e terminare con una lettera o un numero.
  - I nomi delle connessioni non possono superare i 63 caratteri.
4. (Facoltativo) Inserisci una descrizione per l'istanza di connessione.
5. Account di servizio: seleziona un account di servizio con i ruoli richiesti.
6. Facoltativamente, configura le impostazioni del nodo di connessione:
  - Numero minimo di nodi: inserisci il numero minimo di nodi di connessione.
  - Numero massimo di nodi: inserisci il numero massimo di nodi di connessione.
  Un nodo è un'unità (o una replica) di una connessione che elabora le transazioni. Sono necessari più nodi per elaborare più transazioni per una connessione e, al contrario, sono necessari meno nodi per elaborare un numero minore di transazioni. Per capire in che modo i nodi influiscono sui prezzi del connettore, consulta Prezzi dei nodi di connessione. Se non inserisci alcun valore, per impostazione predefinita il numero minimo di nodi è impostato su 2 (per una migliore disponibilità) e il numero massimo di nodi è impostato su 50.
7. Database: il nome del database Cockroach.
8. Allow Prepared Statement (Consenti l'istruzione preparata): consente la preparazione di un'istruzione di query prima della sua esecuzione.
9. Metadati del set di risultati di recupero: questo campo indica se il provider riceve dal server informazioni dettagliate sulle colonne del set di risultati.
10. UseSSL: questo campo consente di stabilire se attivare o meno SSL.
11. SSLServerCert: questo campo consente di specificare se SSL è attivato.
12. Facoltativamente, fai clic su + AGGIUNGI ETICHETTA per aggiungere un'etichetta alla connessione sotto forma di coppia chiave-valore.
13. Fai clic su AVANTI.
Nella sezione Destinazioni, inserisci i dettagli dell'host remoto (sistema di backend) a cui vuoi connetterti.
1. Tipo di destinazione: seleziona un Tipo di destinazione.
  1. Nel campo Indirizzo host, specifica il nome host o l'indirizzo IP della destinazione.
    1. Se vuoi stabilire una connessione privata ai sistemi di backend, segui questi passaggi:
      1. Crea un collegamento al servizio PSC.
      2. Crea un collegamento endpoint e inserisci i relativi dettagli nel campo Indirizzo host.
    2. Se vuoi stabilire una connessione pubblica ai tuoi sistemi di backend con maggiore sicurezza, puoi configurare indirizzi IP statici in uscita per le tue connessioni, quindi configurare le regole firewall in modo da inserire nella lista consentita solo indirizzi IP statici specifici.
  Per inserire altre destinazioni, fai clic su +AGGIUNGI DESTINAZIONE.
2. Fai clic su AVANTI.
Nella sezione Autenticazione, inserisci i dettagli di autenticazione.
1. Seleziona un Tipo di autenticazione e inserisci i dettagli pertinenti.
  La connessione CockroachDB supporta i seguenti tipi di autenticazione:
  - Nome utente e password
2. Fai clic su AVANTI.
Verifica: controlla i dettagli di connessione e autenticazione.
Fai clic su Crea.

Configura l'autenticazione

Inserisci i dettagli in base all'autenticazione che vuoi utilizzare.

Nome utente e password
- Nome utente: nome utente del connettore
- Password: il secret di Secret Manager contenente la password associata al connettore.

Entità, operazioni e azioni

Tutti i connettori di integrazione forniscono un livello di astrazione per gli oggetti dell'applicazione connessa. Puoi accedere agli oggetti di un'applicazione solo tramite questa astrazione. L'astrazione è esposta come entità, operazioni e azioni.

Entità: un'entità può essere considerata come un oggetto o una raccolta di proprietà nell'applicazione o nel servizio collegato. La definizione di un'entità è diversa da un connettore a un connettore. Ad esempio, in un connettore di database, le tabelle sono le entità, in un connettore di file server, le cartelle sono le entità e in un connettore di sistema di messaggistica le code sono le entità.
Tuttavia, è possibile che un connettore non supporti o non abbia entità, nel qual caso l'elenco Entities sarà vuoto.
Operazione : un'operazione è l'attività che puoi eseguire su un'entità. Su un'entità puoi eseguire una qualsiasi delle seguenti operazioni:
- Elenca
- Scarica
- Crea
- Aggiorna
- Elimina
Se selezioni un'entità dall'elenco disponibile, viene generato un elenco di operazioni disponibili per l'entità. Per una descrizione dettagliata delle operazioni, consulta le operazioni delle entità dell'attività Connettori. Tuttavia, se un connettore non supporta nessuna delle operazioni delle entità, queste operazioni non supportate non sono elencate nell'elenco Operations.
Azione: un'azione è una funzione di prima classe resa disponibile per l'integrazione attraverso l'interfaccia del connettore. Un'azione consente di apportare modifiche a una o più entità e di variare da connettore a connettore. Tuttavia, è possibile che un connettore non supporti alcuna azione, nel qual caso l'elenco Actions sarà vuoto.

Limitazioni di sistema

Il connettore CockroachDB può elaborare 1 transazione al secondo per nodo e limitare qualsiasi transazione oltre questo limite. Per impostazione predefinita, Integration Connectors alloca 2 nodi (per una migliore disponibilità) per una connessione.

Per informazioni sui limiti applicabili a Integration Connectors, consulta Limiti.

Nota: il numero di nodi di Integration Connectors verrà scalato automaticamente in modo dinamico in base all'utilizzo. Tuttavia, se vuoi prenotare capacità per grandi volumi senza attendere la scalabilità automatica, puoi regolare il valore minimo del nodo per una connessione. Per elaborare più transazioni per una connessione, sono necessari più nodi. Al contrario, se una connessione elabora meno transazioni, sono necessari meno nodi. Per configurare i valori dei nodi:

Se sei un cliente con pagamento a consumo, configura il valore minimo e massimo del nodo nella pagina di modifica delle connessioni.
Se sei un cliente che ha sottoscritto un abbonamento, contatta l'assistenza.

Il numero massimo di transazioni che un nodo è in grado di gestire dipende da vari fattori. Quindi, prima di regolare il numero minimo di nodi per migliorare la velocità effettiva, ti consigliamo di verificare se i sistemi di backend sono configurati in modo ottimale per gestire il traffico richiesto.

Esempi di operazioni sull'entità

Esempio: elenco di record di un'entità

In questo esempio sono elencati i record dell'entità Users.

Nella finestra di dialogo Configure connector task, fai clic su Entities.
Seleziona Users dall'elenco Entity.
Seleziona l'operazione List, quindi fai clic su Fine.
Nella sezione Input attività dell'attività Connettori, puoi impostare filterClause in base alle tue esigenze.

Ad esempio, se imposti la clausola di filtro su employeeCode='5100' and startDate='2010-01-01 00:00:00', vengono elencati solo i record con codice dipendente 5100 e data di inizio 2010-01-01 00:00:00.

Esempio: ricevere un singolo record da un'entità

Questo esempio recupera un record dall'entità Users.

Nella finestra di dialogo Configure connector task, fai clic su Entities.
Seleziona User dall'elenco Entity.
Seleziona l'operazione Get, quindi fai clic su Fine.
Nella sezione Input attività dell'attività Connettori, fai clic su entityId, quindi inserisci 103032 nel campo Valore predefinito.
Qui, 103032 è il valore della chiave primaria dell'entità Users.

Esempio: eliminare un record da un'entità

Questo esempio elimina un record dall'entità Users.

Nella finestra di dialogo Configure connector task, fai clic su Entities.
Seleziona Users dall'elenco Entity.
Seleziona l'operazione Delete, quindi fai clic su Fine.
Nella sezione Input attività dell'attività Connettori, fai clic su entityId, quindi inserisci 113132 nel campo Valore predefinito.
In alternativa, se l'entità ha chiavi primarie composte anziché specificare entityId, puoi impostare filterClause. Ad esempio: employeeCode='5100' and startDate='2010-01-01 00:00:00'.

Esempio: creare un record in un'entità

In questo esempio viene creato un record nell'entità Users.

Nella finestra di dialogo Configure connector task, fai clic su Entities.
Seleziona Users dall'elenco Entity.
Seleziona l'operazione Create, quindi fai clic su Fine.
Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e inserisci un valore simile al seguente nel campo Default Value:
```
{
"employeeCode": "5100",
"startDate": "2010-01-01 00:00:00.0",
"country": "US"
}
```

Se l'integrazione ha esito positivo, il campo connectorOutputPayload dell'attività del connettore avrà la risposta dell'operazione di creazione.

Esempio: aggiornamento di un record in un'entità

Questo esempio aggiorna un record nell'entità Users.

Nella finestra di dialogo Configure connector task, fai clic su Entities.
Seleziona Users dall'elenco Entity.
Seleziona l'operazione Update, quindi fai clic su Fine.
Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e inserisci un valore simile al seguente nel campo Default Value:
```
{
"country": "IN"
}
```
Nella sezione Input attività dell'attività Connettori, fai clic su entityId, quindi inserisci 113132 nel campo Valore predefinito.
In alternativa, se l'entità ha chiavi primarie composte anziché specificare entityId, puoi impostare filterClause. Ad esempio: employeeCode='5100' and startDate='2010-01-01 00:00:00'.

Se l'integrazione ha esito positivo, il campo connectorOutputPayload dell'attività del connettore riceverà la risposta all'operazione di aggiornamento.

Azioni

In questa sezione sono elencate le azioni supportate dal connettore. Per capire come configurare le azioni, consulta gli esempi di azioni.

Azione ExecuteCustomQuery

Questa azione ti consente di eseguire una query personalizzata.

Per creare una query personalizzata:

Segui le istruzioni dettagliate per aggiungere un'attività dei connettori.
Quando configuri l'attività del connettore, seleziona Azioni nel tipo di azione da eseguire.
Nell'elenco Azione, seleziona Esegui query personalizzata e fai clic su Fine.
Espandi la sezione Input attività, quindi segui questi passaggi:
1. Nel campo Timeout dopo, inserisci il numero di secondi di attesa prima dell'esecuzione della query.
  Valore predefinito: 180 secondi.
2. Nel campo Numero massimo di righe, inserisci il numero massimo di righe da restituire dal database.
  Valore predefinito: 25.
3. Per aggiornare la query personalizzata, fai clic su Modifica query personalizzata. Si apre la finestra di dialogo Editor di script.
4. Nella finestra di dialogo Editor di script, inserisci la query SQL e fai clic su Salva.
  Puoi utilizzare un punto interrogativo (?) in un'istruzione SQL per rappresentare un singolo parametro che deve essere specificato nell'elenco parametri di ricerca. Ad esempio, la seguente query SQL seleziona tutte le righe della tabella Employees che corrispondono ai valori specificati per la colonna LastName:
```
SELECT * FROM Employees where LastName=?
```
  Nota: sono supportate le istruzioni DML (Data Manipulation Language) e DDL (Data Definition Language).
5. Se hai utilizzato punti interrogativi nella query SQL, devi aggiungere il parametro facendo clic su + Aggiungi nome parametro per ciascun punto interrogativo. Durante l'esecuzione dell'integrazione, questi parametri sostituiscono i punti interrogativi (?) nella query SQL in modo sequenziale. Ad esempio, se hai aggiunto tre punti interrogativi (?), devi aggiungere tre parametri in ordine di sequenza. Per aggiungere parametri di ricerca:
  1. Nell'elenco Tipo, seleziona il tipo di dati del parametro.
  2. Nel campo Valore, inserisci il valore del parametro.
  3. Per aggiungere più parametri, fai clic su + Aggiungi parametro di ricerca.

Se l'esecuzione viene eseguita correttamente, questa azione restituisce lo stato 200 (OK) con un corpo della risposta che contiene i risultati della query.

Esempi di azioni

Esempio: trova il valore maggiore

Questo esempio mostra come eseguire una funzione definita dall'utente;utente. La funzione find_greater in questo esempio confronta due numeri interi e restituisce il numero intero che è maggiore.

Nella finestra di dialogo Configure connector task, fai clic su Actions.
Seleziona l'azione find_greater, quindi fai clic su Fine.
Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e inserisci un valore simile al seguente nel campo Default Value:
```
{
"$1": 1.0,
"$2": 5.0
}
```

Se l'esecuzione dell'azione ha esito positivo, il campo connectorOutputPayload dell'attività del connettore avrà un valore simile al seguente:

[{
"bignum": 5.0
}]

Utilizzare Terraform per creare connessioni

Puoi utilizzare la risorsa Terraform per creare una nuova connessione.

Per scoprire come applicare o rimuovere una configurazione Terraform, consulta Comandi Terraform di base.

Per visualizzare un modello Terraform di esempio per la creazione delle connessioni, guarda il modello di esempio.

Quando crei questa connessione utilizzando Terraform, devi impostare le seguenti variabili nel file di configurazione Terraform:

Nome parametro	Tipo di dati	Obbligatorio	Descrizione
use_ssl	BOOLEANO	False	Questo campo consente di specificare se SSL è abilitato o meno.
ssl_server_cert	SECRET	False	Questo campo consente di specificare se SSL è abilitato o meno.
database	STRING	True	Il nome del database Cockroach.
allow_prepared_statement	BOOLEANO	False	Consenti la preparazione di un'istruzione di query prima della sua esecuzione.
fetch_result_set_metadata	BOOLEANO	False	Questo campo consente di stabilire se il provider sta ricevendo informazioni dettagliate sulle colonne del set di risultati dal server.

Utilizza la connessione CockroachDB in un'integrazione

Dopo aver creato la connessione, diventa disponibile sia in Apigee Integration che in Application Integration. Puoi usare la connessione in un'integrazione tramite l'attività Connettori.

Per capire come creare e utilizzare l'attività Connettori in Apigee Integration, consulta Attività Connettori.
Per capire come creare e utilizzare l'attività Connettori in Application Integration, consulta Attività Connettori.

Ricevi assistenza dalla community Google Cloud

Puoi pubblicare le tue domande e discutere di questo connettore nella community Google Cloud sui forum Cloud.

Passaggi successivi

Scopri come sospendere e ripristinare una connessione.
Scopri come monitorare l'utilizzo dei connettori.
Scopri come visualizzare i log del connettore.