CockroachDB

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

Prima di iniziare

Prima di utilizzare il connettore CockroachDB, svolgi le seguenti attività:

• Nel tuo progetto Google Cloud:
  • Assicurati che la connettività di rete sia configurata. Per informazioni sui pattern di rete, consulta Connettività di rete.
  • 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 eseguire l'autenticazione ed essere autorizzato ad accedere ai dati nelle API Google. Se non hai un account di servizio, devi crearne uno. Per maggiori informazioni, consulta Creare un account di servizio.

  • Attiva i seguenti servizi:
    • secretmanager.googleapis.com (API Secret Manager)
    • connectors.googleapis.com (API Connectors)

    Per scoprire come attivare i servizi, consulta Abilitazione dei servizi.

  Se questi servizi o autorizzazioni non sono stati attivati in precedenza per il tuo progetto, ti verrà chiesto di attivarli durante la configurazione del connettore.

Per ulteriori informazioni su come creare un cluster serverless e utilizzare tutti i parametri dell'applicazione creata, consulta Creare un cluster CockroachDB serverless su Cockroachlabs

Per informazioni su come creare un certificato autofirmato , consulta Cockroach cert

Configura il connettore

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

1. Nella console Cloud, vai alla pagina Connettori di integrazione > Connessioni, quindi seleziona o crea un progetto Google Cloud.

   Vai alla pagina Connessioni

2. Fai clic su + CREA NUOVO per aprire la pagina Crea connessione.
3. Nella sezione Località, scegli la località della connessione.
   1. Regione: seleziona una località dall'elenco a discesa.

      Per l'elenco di tutte le regioni supportate, consulta Località.

   2. Fai clic su AVANTI.
4. Nella sezione Dettagli connessione, completa quanto segue:
   1. Connettore: seleziona CockroachDB dall'elenco a discesa dei connettori disponibili.
   2. Versione del 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 contenere più di 49 caratteri.
   4. (Facoltativo) Inserisci una Descrizione per l'istanza di connessione.
   5. Se vuoi, attiva Cloud Logging e poi seleziona un livello di log. Per impostazione predefinita, il livello di log è impostato su Error.
   6. Account di servizio: seleziona un account di servizio con i ruoli richiesti.
   7. (Facoltativo) 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 meno transazioni. Per capire in che modo i nodi influiscono sui prezzi dei connettori, consulta Prezzi per i nodi di connessione. Se non inserisci alcun valore, per impostazione predefinita il numero minimo di nodi è impostato su 2 (per una maggiore disponibilità) e il numero massimo di nodi è impostato su 50.

   Nota: puoi personalizzare i valori dei nodi di connessione solo se sei un cliente con pagamento a consumo.
   8. Database: il nome del database Cockroach.
   9. Consenti istruzioni preparate: consenti la preparazione di un'istruzione di query prima della sua esecuzione.
   10. Recupero metadati del set di risultati: questo campo indica se il provider riceve informazioni dettagliate sulle colonne del set di risultati dal server.
   11. UseSSL: questo campo imposta se SSL è abilitato.
   12. SSLServerCert: questo campo imposta l'attivazione o meno di SSL.
   13. Se vuoi, fai clic su + AGGIUNGI ETIQUETTA per aggiungere un'etichetta alla connessione sotto forma di coppia chiave/valore.
   14. Fai clic su AVANTI.
5. 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.
      • Seleziona Indirizzo host dall'elenco per specificare il nome host o l'indirizzo IP della destinazione.
      • Se vuoi stabilire una connessione privata ai tuoi sistemi di backend, seleziona Allegato endpoint dall'elenco, quindi seleziona l'allegato endpoint richiesto dall'elenco Allegato endpoint.
        Nota: per capire come creare un collegamento endpoint, consulta Collegamento del servizio PSC e Collegamento endpoint. Una volta creato, il collegamento dell'endpoint sarà visibile nell'elenco Collegamento dell'endpoint.

      Se vuoi stabilire una connessione pubblica ai tuoi sistemi di backend con una maggiore sicurezza, puoi prendere in considerazione la configurazione di indirizzi IP statici in uscita per le tue connessioni, quindi configurare le regole del firewall in modo da inserire nella lista consentita solo gli indirizzi IP statici specifici.

      Per inserire destinazioni aggiuntive, fai clic su + AGGIUNGI DESTINAZIONE.

   2. Fai clic su AVANTI.
6. 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

   Per capire come configurare questi tipi di autenticazione, consulta Configurare l'autenticazione.

   2. Fai clic su AVANTI.
7. Rivedi: controlla i dettagli di connessione e autenticazione.
8. Fai clic su Crea.

Configura autenticazione

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

• Nome utente e password
  • Nome utente: nome utente per il connettore
  • Password: il segreto Secret Manager contenente la password associata al connettore.

Esempi di configurazione delle connessioni

Questa sezione elenca i valori di esempio per i vari campi che configuri durante la creazione della connessione CockroachDB.

CockroachDB - Tipo di connessione con autenticazione di base

Nome campo	Dettagli
Località	us-central1
Connettore	CockroachDB
Versione del connettore	1
Nome collegamento	cockroach-db-cloud-conn
Abilita Cloud Logging	Sì
Account di servizio	SERVICE_ACCOUNT_NAME@serviceaccount
SSL	Sì
SSLServerCert	cockroach-db-ssl-cert
SecretVersion	1
Database	TestGCP
Consenti istruzione preparata	Sì
Recupera i metadati del set di risultati	Sì
Livello di verbosità	5
Numero minimo di nodi	2
Numero massimo di nodi	50
Tipo di destinazione(server)	Indirizzo host
Indirizzo host	googlecloud-bcone-cluster-13792.5xj.cockroachlabs.cloud. Questo è il nome del cluster cloud CockroachDB.
Porta	26257
Nome utente	Nome utente
Password	password
Versione secret	1

CockroachDB - Tipo di connessione PSC

Nome campo	Dettagli
Località	us-central1
Connettore	CockroachDB
Versione del connettore	1
Nome collegamento	cockroach-db-cloud-conn-psc
Abilita Cloud Logging	Sì
Account di servizio	SERVICE_ACCOUNT_NAME@serviceaccount
SSL	Sì
SSLServerCert	gcp-bcone-crdb-hosted-node-crt
SecretVersion	1
Database	banca
Consenti istruzione preparata	No
Recupera i metadati del set di risultati	No
Livello di verbosità	5
Numero minimo di nodi	2
Numero massimo di nodi	50
Tipo di destinazione(server)	Indirizzo host
Indirizzo host	192.0.2.0/24 (dovrebbe essere l'attacco dell'endpoint creato in base all'IP del server che ospita l'istanza del database Cockroach)
Porta	26257
Nome utente	Nome utente
Password	password
Versione secret	1

Entità, operazioni e azioni

Tutti gli Integration Connectors forniscono un livello di astrazione per gli oggetti dell'applicazione collegata. Puoi accedere agli oggetti di un'applicazione solo tramite questa astrazione. L'astrazione viene mostrata come entità, operazioni e azioni.

Nota: puoi visualizzare le entità, le operazioni e le azioni di un connettore nell'attività Connettori.

• Entità : un'entità può essere considerata un oggetto o una raccolta di proprietà nell'applicazione o nel servizio collegato. La definizione di un'entità varia da un connettore all'altro. 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à. Puoi eseguire su un'entità una delle seguenti operazioni:
  • Elenca
  • Scarica
  • Crea
  • Aggiorna
  • Elimina

  La selezione di un'entità dall'elenco disponibile genera un elenco di operazioni disponibili per l'entità. Per una descrizione dettagliata delle operazioni, consulta le operazioni sulle entità dell'attività Connettori. Tuttavia, se un connettore non supporta nessuna delle operazioni sulle entità, queste operazioni non supportate non sono elencate nell'elenco Operations.

• Azione : un'azione è una funzione di prima classe resa disponibile all'integrazione tramite l'interfaccia del connettore. Un'azione ti consente di apportare modifiche a una o più entità e varia da un connettore all'altro. In genere, un'azione avrà alcuni parametri di input e un parametro di output. Tuttavia, è possibile che un connettore non supporti alcuna azione, nel qual caso l'elenco Actions sarà vuoto.

Nota: a tutte le entità e le azioni è associato uno schema. Ad esempio, uno schema di azioni avrà i dettagli dei parametri, ad esempio i nomi dei parametri e il relativo tipo di dati. Lo schema (metadati) per le entità e le azioni viene recuperato dalla connessione al runtime dal tuo backend. Se sono presenti aggiornamenti allo schema, questi non verranno applicati automaticamente alle connessioni esistenti. Dovrai aggiornare manualmente lo schema. Per aggiornare lo schema di una connessione, apri la pagina Dettagli connessione della connessione e poi fai clic su Aggiorna schema connessione.

Limitazioni del sistema

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

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

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

• Se sei un cliente con pagamento a consumo, configura il valore minimo e massimo del nodo nella pagina di modifica della connessione.
• Se sei un cliente con abbonamento, contatta l'assistenza.

Il numero massimo di transazioni che un nodo può gestire dipende da vari fattori. Pertanto, prima di modificare il numero minimo di nodi per migliorare il throughput, ti consigliamo di verificare se i sistemi di backend sono configurati in modo ottimale per gestire il traffico richiesto.

Esempi di operazioni sulle entità

Esempio: elenca i record di un'entità

Questo esempio elenca i record dell'entità Users.

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

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

Esempio: ottieni un singolo record da un'entità

Questo esempio recupera un record dall'entità Users.

1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
2. Seleziona User dall'elenco Entity.
3. Seleziona l'operazione Get e poi fai clic su Fine.
4. Nella sezione Input dell'attività dell'attività Connettori, fai clic su entityId e poi inserisci 103032 nel campo Valore predefinito.

   Qui, 103032 è il valore della chiave primaria dell'entità Users.

Esempio: elimina un record da un'entità

Questo esempio elimina un record dall'entità Users.

1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
2. Seleziona Users dall'elenco Entity.
3. Seleziona l'operazione Delete e poi fai clic su Fine.
4. Nella sezione Input dell'attività dell'attività Connettori, fai clic su entityId e poi inserisci 113132 nel campo Valore predefinito.

   In alternativa, se l'entità ha chiavi primarie composite, anziché specificare entityId, puoi impostare filterClause. Ad esempio: employeeCode='5100' and startDate='2010-01-01 00:00:00'.

Esempio: crea un record in un'entità

Questo esempio crea un record nell'entità Users.

1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
2. Seleziona Users dall'elenco Entity.
3. Seleziona l'operazione Create e fai clic su Fine.
4. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e poi 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 è riuscita, il campo connectorOutputPayload dell'attività del connettore conterrà la risposta dell'operazione di creazione.

Esempio: aggiorna un record in un'entità

Questo esempio aggiorna un record nell'entità Users.

1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
2. Seleziona Users dall'elenco Entity.
3. Seleziona l'operazione Update e fai clic su Fine.
4. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e poi inserisci un valore simile al seguente nel campo Default Value:

   {
   "country": "IN"
   }

5. Nella sezione Input dell'attività dell'attività Connettori, fai clic su entityId e poi inserisci 113132 nel campo Valore predefinito.

   In alternativa, se l'entità ha chiavi primarie composite, anziché specificare entityId, puoi impostare filterClause. Ad esempio: employeeCode='5100' and startDate='2010-01-01 00:00:00'.

Se l'integrazione è riuscita, il campo connectorOutputPayload dell'attività del connettore conterrà la risposta dell'operazione di aggiornamento.

Azioni

Questa sezione elenca le azioni supportate dal connettore. Per capire come configurare le azioni, consulta Esempi di azioni.

Azione ExecuteCustomQuery

Questa azione ti consente di eseguire una query personalizzata.

Per creare una query personalizzata:

1. Segui le istruzioni dettagliate per aggiungere un'attività di connettori.
2. Quando configuri l'attività del connettore, seleziona Azioni nel tipo di azione che vuoi eseguire.
3. Nell'elenco Azione, seleziona Esegui query personalizzata e poi fai clic su Fine.

   

4. Espandi la sezione Input attività ed esegui i seguenti 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 script personalizzato. 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 ogni punto interrogativo. Durante l'esecuzione dell'integrazione, questi parametri sostituiscono in modo sequenziale i punti interrogativi (?) nella query SQL. Ad esempio, se hai aggiunto tre punti di domanda (?), 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 query.

In caso di esecuzione riuscita, questa azione restituisce lo stato 200 (OK) con un corpo di risposta contenente i risultati della query.

Nota: le funzioni definite in CockroachDB sono elencate come azioni nell'attività del connettore. Pertanto, puoi eseguire una funzione eseguendo l'azione corrispondente. Ad esempio, per informazioni su come eseguire una funzione, consulta .

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

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

   {
   "$1": 1.0,
   "$2": 5.0
   }

Se l'esecuzione dell'azione è riuscita, il campo connectorOutputPayload della task 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 di una connessione, consulta 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	Falso	Questo campo imposta se SSL è abilitato.
ssl_server_cert	SECRET	Falso	Questo campo imposta se SSL è abilitato.
database	STRING	Vero	Il nome del database Cockroach.
allow_prepared_statement	BOOLEANO	Falso	Consente la preparazione di un'istruzione di query prima della sua esecuzione.
fetch_result_set_metadata	BOOLEANO	Falso	Questo campo imposta se il provider riceve informazioni dettagliate sulle colonne del set di risultati dal server.

Utilizzare la connessione CockroachDB in un'integrazione

Una volta creata, la connessione diventa disponibile sia nell'Apigee Integration sia nell'Application Integration. Puoi utilizzare la connessione in un'integrazione tramite l'attività Connettori.

• Per informazioni su come creare e utilizzare l'attività Connectors in Apigee Integration, consulta Attività Connectors.
• Per informazioni su come creare e utilizzare l'attività Connettori in Application Integration, consulta Attività Connettori.

Ricevere assistenza dalla community Google Cloud

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

Passaggi successivi

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