Couchbase

Il connettore Couchbase ti consente di connetterti a un'istanza di database Couchbase ed eseguire le operazioni di database supportate.

Versioni supportate

• Couchbase Server versioni 4.0 e successive (Enterprise Edition o Community Edition).

• Couchbase Capella

Prima di iniziare

Prima di utilizzare il connettore Couchbase, 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.

• Se necessario, crea un server Couchbase. Per ulteriori informazioni, consulta la guida rapida di Couchbase Server.
Per informazioni sulle API Couchbase, consulta la documentazione dell'API REST di Couchbase.
• Se necessario, scarica il certificato SSL. Per ulteriori informazioni, vedi Connessione sicura con TLS.

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 Couchbase 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. Consenti parametri JSON: consente di utilizzare JSON non elaborato nei parametri quando QueryPassthrough è attivato.
   9. Porta Analytics: la porta per la connessione all'endpoint Couchbase Analytics.
   10. Separatore secondario: il carattere o i caratteri utilizzati per indicare le tabelle secondarie.
   11. Servizio Couchbase: determina il servizio Couchbase a cui connettersi. Il valore predefinito è N1QL. Le opzioni disponibili sono N1QL e Analytics.
   12. Quota RAM per la creazione di tabelle: la quota RAM predefinita, in megabyte, da utilizzare per l'inserimento di bucket tramite la sintassi CREATE TABLE.
   13. Separatore dei dataverse: il carattere o i caratteri utilizzati per indicare gli ambiti/le raccolte e i dataverse di Analytics.
   14. Separatore di aromi: il carattere o i caratteri utilizzati per indicare gli aromi.
   15. Porta N1QL: la porta per la connessione all'endpoint N1QL di Couchbase.
   16. Separatore di punti: il carattere o i caratteri utilizzati per indicare la gerarchia.
   17. Timeout esecuzione query: imposta il timeout lato server per la query, che regola il tempo per cui Couchbase eseguirà la query prima di restituire un errore di timeout.
   18. Confronto rigoroso: regola la precisione con cui tradurre i filtri nelle query di input SQL in query Couchbase. Può essere impostato su un elenco di valori separati da virgole, in cui ogni valore può essere una data, un numero, un valore booleano o una stringa.
   19. Durabilità della transazione: specifica la modalità di archiviazione di un documento per la riuscita di una transazione. Specifica se utilizzare le transazioni N1QL durante l'esecuzione delle query.
   20. Timeout transazioni: imposta il tempo di esecuzione di una transazione prima che venga eseguito il timeout da Couchbase.
   21. Utilizza collezioni per DDL: indica se assumere che le istruzioni CREATE TABLE utilizzino collezioni anziché gusti. Viene applicato solo quando si connette a Couchbase v7 e GenerateSchemaFiles è impostato su OnCreate.
   22. Utilizza transazioni: specifica se utilizzare le transazioni N1QL durante l'esecuzione delle query.
   23. Convalida parametri JSON: consente al provider di convalidare che i parametri di stringa siano JSON validi prima di inviare la query a Couchbase.
   24. Utilizza proxy: seleziona questa casella di controllo per configurare un server proxy per la connessione e configura i seguenti valori:
   • Schema di autenticazione proxy: seleziona il tipo di autenticazione per l'autenticazione con il server proxy. Sono supportati i seguenti tipi di autenticazione:
     • Di base: autenticazione HTTP di base.
     • Digest: autenticazione HTTP Digest.
   • Utente proxy: un nome utente da utilizzare per l'autenticazione con il server proxy.
   • Password proxy: il segreto di Secret Manager della password dell'utente.
   • Tipo SSL proxy: il tipo di SSL da utilizzare per la connessione al server proxy. Sono supportati i seguenti tipi di autenticazione:
     • Automatica: impostazione predefinita. Se l'URL è un URL HTTPS, viene utilizzata l'opzione Tunnel. Se l'URL è un URL HTTP, viene utilizzata l'opzione MAI.
     • Sempre: la connessione è sempre abilitata per SSL.
     • Mai: la connessione non è abilitata per SSL.
     • Tunnel: la connessione avviene tramite un proxy di tunneling. Il server proxy apre una connessione all'host remoto e il traffico fluisce avanti e indietro attraverso il proxy.
   • Nella sezione Server proxy, inserisci i dettagli del server proxy.
     1. Fai clic su + Aggiungi destinazione.
     2. Seleziona un Tipo di destinazione.
        • Indirizzo host: specifica il nome host o l'indirizzo IP della destinazione.

          Se vuoi stabilire una connessione privata al tuo sistema di backend:

          • Crea un collegamento del servizio PSC.
          • Crea un collegamento dell'endpoint e poi inserisci i dettagli del collegamento dell'endpoint nel campo Indirizzo host.
   25. Se vuoi, fai clic su + AGGIUNGI ETIQUETTA per aggiungere un'etichetta alla connessione sotto forma di coppia chiave/valore.
   26. 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 Couchbase 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.
  • UseSSL: questo campo imposta se SSL è abilitato.
  • SSLServerCert: SSLServerCert per Couchbase Connector
  • Schema di autenticazione: schema di autenticazione per Couchbase Connector
  • Modalità di connessione: determina come connettersi al server Couchbase. Deve essere Direct o Cloud. Per Cloud, SSL è obbligatorio. Per ulteriori informazioni, consulta Connessioni sicure con TLS.
  • Server DNS: determina il server DNS da utilizzare per recuperare le informazioni di Couchbase Cloud. Ad esempio, 8.8.8.8.

Esempi di configurazione delle connessioni

Questa sezione elenca i valori di esempio per i vari campi che configuri durante la creazione del connettore Couchbase.

SSL - Tipo di connessione del certificato

Nome campo	Dettagli
Regione	us-central1
Connettore	Couchbase
Versione del connettore	1
Nome connettore	Couchbase-basic-auth-conn
Account di servizio	[e-mail]
Livello di verbosità	5
Impostazioni del nodo di connessione: Numero minimo/massimo di nodi	2/50
Configurazione SSL Abilita SSL	Vero
Archivio di attendibilità	Privato
Archivio di attendibilità personalizzato	Un certificato PEM completo (-----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----)
Versione secret	1
Indirizzo host	xx.1HOST_NAME.cloud.couchbase.com:18xxx
Autenticazione	Password utente
Nome utente	nome utente
Password	password
versioni	1
Modalità vConnection	Cloud
Server DNS	192.0.2.0
Schema OAuth	Di base

Tipo di connessione Couchbase di Analytics

Nome campo	Dettagli
Regione	us-central1
Connettore	Couchbase
Versione del connettore	1
Nome connettore	Couchbase-basic-auth-Analytics-conn
Account di servizio	[e-mail]
Porta di Analytics	18095
Servizio Couchbase	Analytics
Livello di verbosità	5
Impostazioni del nodo di connessione: Numero minimo/massimo di nodi	2/50
Indirizzo host	xx.1HOST_NAME.cloud.couchbase.com:18095
Autenticazione	Password utente
Nome utente	nome utente
Password	password
versioni	1
Modalità vConnection	Cloud
Server DNS	192.0.2.0
Schema OAuth	Di base

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.

Azioni

Questo connettore supporta l'esecuzione delle seguenti azioni:

• Funzioni e stored procedure definite dall'utente. Se nel tuo backend sono presenti procedure e funzioni memorizzate, queste sono elencate nella colonna Actions della finestra di dialogo Configure connector task.
• Query SQL personalizzate. Per eseguire query SQL personalizzate, il connettore fornisce l'azione Esegui 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.

Limitazioni del sistema

Il connettore Couchbase può elaborare 25 transazioni al secondo per nodo e limita le transazioni che superano 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.

Azioni

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

Nota: i risultati di tutte le azioni saranno disponibili come risposta JSON nel parametro di risposta connectorOutputPayload della task Connectors dopo l'esecuzione dell'integrazione.

Azione AddDocument

Questa azione aggiunge documenti in Couchbase.

Parametri di input dell'azione AddDocument

Nome parametro	Tipo di dati	Obbligatorio	Descrizione
Nome bucket	Stringa	Sì	Il bucket in cui inserire il documento.
SourceTable	Oggetto	No	Il nome della tabella temporanea contenente le colonne ID e Documento. Obbligatorio se non viene specificato alcun ID.
ID	Stringa	No	La chiave primaria in cui inserire il documento. Obbligatorio se non è specificata alcuna tabella di origine.
Documento	Stringa	No	Il testo JSON del documento da inserire. Obbligatorio se non è specificata la tabella SourceTable.

Parametri di output dell'azione AddDocument

Questa azione restituisce lo stato 200 (OK) se l'azione è riuscita.

Ad esempio, per scoprire come configurare l'azione AddDocument, consulta Esempi di azioni.

Azione CreateCollection

Questa azione crea una raccolta in un ambito esistente.

Parametri di input dell'azione CreateCollection

Nome parametro	Tipo di dati	Obbligatorio	Descrizione
Bucket	Stringa	Sì	Il nome del bucket contenente la raccolta.
Ambito	Stringa	Sì	Il nome dell'ambito contenente la raccolta.
Nome	Stringa	Sì	Il nome della raccolta da creare.

Parametri di output dell'azione CreateCollection

Questa azione restituisce lo stato 200 (OK) se l'azione è riuscita.

Ad esempio, per scoprire come configurare l'azione CreateCollection, consulta Esempi di azioni.

Azione DeleteCollection

Questa azione elimina una raccolta in un ambito esistente.

Parametri di input dell'azione DeleteCollection

Nome parametro	Tipo di dati	Obbligatorio	Descrizione
Bucket	string	Vero	Il nome del bucket contenente la raccolta.
Ambito	Stringa	Vero	Il nome dell'ambito contenente la raccolta.
Nome	string	Vero	Il nome della raccolta da eliminare.

Parametri di output dell'azione DeleteCollection

Questa azione restituisce lo stato 200 (OK) se l'azione è riuscita.

Ad esempio, per scoprire come configurare l'azione DeleteCollection, consulta Esempi di azioni.

Azione CreateScope

Questa azione crea un ambito in un bucket esistente.

Parametri di input dell'azione CreateScope

Nome parametro	Tipo di dati	Obbligatorio	Descrizione
Bucket	Stringa	Sì	Il nome del bucket contenente l'ambito
Nome	Stringa	Sì	Il nome dell'ambito da creare.

Parametri di output dell'azione CreateScope

Questa azione restituisce lo stato 200 (OK) se l'azione è riuscita.

Ad esempio, per scoprire come configurare l'azione CreateScope, consulta Esempi di azioni.

Azione DeleteScope

Questa azione elimina un ambito e tutte le relative raccolte.

Parametri di input dell'azione DeleteScope

Nome parametro	Tipo di dati	Obbligatorio	Descrizione
Bucket	Stringa	Sì	Il nome del bucket contenente l'ambito.
Nome	Stringa	Sì	Il nome dell'ambito da eliminare.

Parametri di output dell'azione DeleteScope

Questa azione restituisce lo stato 200 (OK) se l'azione è riuscita.

Ad esempio, per scoprire come configurare l'azione DeleteScope, consulta Esempi di azioni.

Azione ListIndices

Questa azione elenca tutti gli indici disponibili in Couchbase.

Parametri di input dell'azione ListIndices

N/D

Parametri di output dell'azione ListIndices

Questa azione restituisce lo stato 200 (OK) se l'azione è riuscita.

Ad esempio, per scoprire come configurare l'azione ListIndices, consulta Esempi di azioni.

Azione ManageIndices

Questa azione crea o elimina un indice in un bucket.

Parametri di input dell'azione ManageIndices

Nome parametro	Tipo di dati	Obbligatorio	Descrizione
Nome bucket	Stringa	Sì	Il bucket di destinazione da cui creare o eliminare l'indice.
ScopeName	oggetto	No	L'ambito di destinazione da cui creare o eliminare l'indice (Couchbase versione 7 e successive)
CollectionName	Stringa	No	La raccolta di destinazione da cui creare o eliminare l'indice (Couchbase versione 7 e successive)
Azione	Stringa	Sì	Specifica l'azione da eseguire sull'indice, che può essere Crea o Elimina.
Espressioni	Stringa	No	Un elenco di espressioni o funzioni, codificate come JSON, su cui si baserà l'indice. È necessario almeno uno se IsPrimary è impostato su false e l'azione è Crea.
Nome	Stringa	No	Il nome dell'indice da creare o eliminare, obbligatorio se IsPrimary è impostato su false.
IsPrimary	Stringa	No	Specifica se l'indice deve essere un indice principale.Il valore predefinito è true.
Filtri	Stringa	No	Un elenco di filtri, codificati come JSON, da applicare all'indice.
IndexType	Stringa	No	Il tipo di indice da creare, può essere GSI o Visualizzazione, utilizzato solo se l'azione è Crea. Il valore predefinito è GSI.
ViewName	Stringa	No	Elemento deprecato, incluso solo per la compatibilità. Non fa nulla.
Nodi	Stringa	No	Un elenco, codificato come JSON, di nodi contenenti l'indice deve contenere la porta. Viene utilizzato solo se l'azione è Crea.
NumReplica	Stringa	No	Il numero di repliche da creare tra i nodi dell'indice nel cluster.

Parametri di output dell'azione ManageIndices

Questa azione restituisce lo stato 200 (OK) se l'azione è riuscita.

Ad esempio, per scoprire come configurare l'azione ManageIndices, 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.

Esempi di azioni

Questa sezione descrive come eseguire alcune delle azioni in questo connettore.

Esempio: aggiungere un documento

Questo esempio aggiunge un documento in un bucket Couchbase.

1. Nella finestra di dialogo Configure connector task, fai clic su Actions.
2. Seleziona l'azione AddDocument 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:

   {
   "Document": "{\"ID\":10,\"Name\":\"TestDoc\"}",
   "BucketName": "CouchbaseTestBucket",
   "ID": "Test"
   }

Se l'azione ha esito positivo, il parametro risposta connectorOutputPayload della task AddDocument avrà un valore simile al seguente:

[{
"RowsAffected": "1"
}]

Esempio: creare una raccolta

Questo esempio crea una raccolta.

1. Nella finestra di dialogo Configure connector task, fai clic su Actions.
2. Seleziona l'azione CreateCollection 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:

   {
   "bucket": "CouchbaseTestBucket",
   "scope": "TestScope",
   "name": "CollectionFromGoogleCloud"
   }

Questo esempio crea una raccolta in TestScope. Se l'azione ha esito positivo, il parametro risposta connectorOutputPayload della task CreateCollection avrà un valore simile al seguente:

[{
"Success": true,
"scope": null,
"uid": null,
"collection": null,
"collections.uid": null,
"maxTTL": null,
"history": null
}]

Esempio: eliminare una raccolta

Questo esempio elimina una raccolta.

1. Nella finestra di dialogo Configure connector task, fai clic su Actions.
2. Seleziona l'azione DeleteCollection 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:

   {
   "bucket": "CouchbaseTestBucket",
   "scope": "TestScope",
   "name": "CollectionFromGoogleCloud"
   }

Questo esempio elimina una raccolta in TestScope. Se l'azione ha esito positivo, il parametro di risposta connectorOutputPayload della task CreateCollection avrà un valore simile al seguente:

[{
"Success": true,
"uid": "12"
}]

Esempio: crea un ambito

Questo esempio crea un ambito.

1. Nella finestra di dialogo Configure connector task, fai clic su Actions.
2. Seleziona l'azione CreateScope 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:

   {
   "bucket": "CouchbaseTestBucket",
   "name": "ScopeFromGoogleCloud"
   }

Questo esempio crea un ambito in CouchbaseTestBucket. Se l'azione ha esito positivo, il parametro di risposta connectorOutputPayload della task CreateScope avrà un valore simile al seguente:

[{
"Success": true,
"name": null,
"uid": null,
"collections": null,
"collections.name": null,
"collections.uid": null,
"collections.maxTTL": null,
"collections.history": null
}]

Esempio: elimina un ambito

Questo esempio elimina un ambito.

1. Nella finestra di dialogo Configure connector task, fai clic su Actions.
2. Seleziona l'azione DeleteScope 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:

   {
   "bucket": "CouchbaseTestBucket",
   "name": "ScopeFromGoogleCloud"
   }

Questo esempio elimina l'ambito ScopeFromGoogleCloud. Se l'azione ha esito positivo, il parametro di risposta connectorOutputPayload della task DeleteScope avrà un valore simile al seguente:

[{
"Success": true,
"uid": "10"
}]

Esempio: indici di elenco

Questo esempio elenca tutti gli indici disponibili in Couchbase.

1. Nella finestra di dialogo Configure connector task, fai clic su Actions.
2. Seleziona l'azione ListIndices 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:

   {
   }

Se l'azione ha esito positivo, il parametro di risposta connectorOutputPayload della task ListIndices avrà un valore simile al seguente:

[{
"id": "3d8a78cd2e302ac2",
"datastore_id": "http://127.0.0.1:8091",
"namespace_id": "default",
"bucket_id": null,
"scope_id": null,
"keyspace_id": "CouchbaseTestBucket",
"index_key": "",
"condition": null,
"is_primary": "false",
"name": "test",
"state": "online",
"using": "gsi"
}, {
"id": "d6ce8c103b97a00d",
"datastore_id": "http://127.0.0.1:8091",
"namespace_id": "default",
"bucket_id": "CouchbaseTestBucket",
"scope_id": "TestScope",
"keyspace_id": "CouchBaseDatatypes",
"index_key": "",
"condition": null,
"is_primary": "true",
"name": "#primary",
"state": "online",
"using": "gsi"
},
{
"id": "58c25aef49dd32b3",
"datastore_id": "http://127.0.0.1:8091",
"namespace_id": "default",
"bucket_id": "CouchbaseTestBucket",
"scope_id": "TestScope",
"keyspace_id": "TestCollection",
"index_key": "",
"condition": null,
"is_primary": "false",
"name": "SearchIndexTest_1",
"state": "online",
"using": "fts"
}]

Esempio: gestisci gli indici

Questo esempio elimina un indice nel bucket specificato.

1. Nella finestra di dialogo Configure connector task, fai clic su Actions.
2. Seleziona l'azione ManageIndices 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:

   {
   "BucketName": "CouchbaseTestBucket",
   "Action": "DROP",
   "Name": "CouchBaseTestIndex"
   }

Se l'azione ha esito positivo, il parametro di risposta connectorOutputPayload della task ManageIndices avrà un valore simile al seguente:

[{
"Success": "true"
}]

Esempi di operazioni sulle entità

Questa sezione mostra come eseguire alcune delle operazioni sulle entità in questo connettore.

Esempio: elenca tutti i record

Questo esempio elenca tutti i record nell'entità TestCollection.

1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
2. Seleziona TestCollection dall'elenco Entity.
3. Seleziona l'operazione List e poi fai clic su Fine.
4. Se vuoi, nella sezione Input dell'attività dell'attività Connettori, puoi filtrare il set di risultati specificando una clausola di filtro. Specifica sempre il valore della clausola di filtro tra virgolette singole (').

Esempio: ottieni un record da un'entità

Questo esempio recupera un record con l'ID specificato dall'entità TestCollection.

1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
2. Seleziona TestCollection 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 120 nel campo Valore predefinito.

   In questo caso, 120 è un ID record univoco nell'entità TestCollection.

Esempio: aggiorna un record in un'entità

Questo esempio aggiorna un record nell'entità TestCollection.

1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
2. Seleziona TestCollection 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:

   {
   "COL_TEXT": "CouchBase Update"
   }

5. Fai clic su entityId e inserisci 120 nel campo Valore predefinito.

   Se l'integrazione è andata a buon fine, il campo connectorOutputPayload dell'attività del connettore avrà un valore simile al seguente:

   [{
   "Document.Id": "120"
   }]

Esempio: elimina un record da un'entità

Questo esempio elimina il record con l'ID specificato nell'entità TestCollection.

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

Nota: se l'entità ha una chiave primaria composta, puoi specificare una clausola di filtro.

Problemi noti

L'operazione create sulle entità non è supportata.

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
allow_jsonparameters	BOOLEANO	Falso	Consente di utilizzare JSON non elaborato nei parametri quando QueryPassthrough è attivato.
analytics_port	STRING	Falso	La porta per la connessione all'endpoint Couchbase Analytics.
child_separator	STRING	Falso	Il carattere o i caratteri utilizzati per indicare le tabelle secondarie.
couchbase_service	ENUM	Falso	Determina il servizio Couchbase a cui connettersi. Il valore predefinito è N1QL. Le opzioni disponibili sono N1QL e Analytics. I valori supportati sono: N1QL, Analytics
create_table_ram_quota	STRING	Falso	La quota RAM predefinita, in megabyte, da utilizzare per l'inserimento di bucket tramite la sintassi CREATE TABLE.
dataverse_separator	STRING	Falso	Il carattere o i caratteri utilizzati per indicare i dataverse e gli ambiti/le raccolte di Analytics.
flavor_separator	STRING	Falso	Il carattere o i caratteri utilizzati per indicare i sapori.
n1_qlport	STRING	Falso	La porta per la connessione all'endpoint N1QL di Couchbase.
periods_separator	STRING	Falso	Il carattere o i caratteri utilizzati per indicare la gerarchia.
query_execution_timeout	STRING	Falso	Imposta il timeout lato server per la query, che regola il tempo per cui Couchbase eseguirà la query prima di restituire un errore di timeout.
strict_comparison	STRING	Falso	Modifica la precisione con cui tradurre i filtri nelle query di input SQL in query Couchbase. Può essere impostato su un elenco di valori separati da virgole, in cui ogni valore può essere una data, un numero, un valore booleano o una stringa.
transaction_durability	STRING	Falso	Specifica come deve essere archiviato un documento affinché una transazione vada a buon fine. Specifica se utilizzare le transazioni N1QL durante l'esecuzione delle query.
transaction_timeout	STRING	Falso	Imposta il tempo di esecuzione di una transazione prima che venga eseguito il timeout da Couchbase.
use_collections_for_ddl	BOOLEANO	Falso	Indica se assumere che le istruzioni CREATE TABLE utilizzino raccolte anziché gusti. Viene applicato solo quando si connette a Couchbase v7 e GenerateSchemaFiles è impostato su OnCreate.
use_transactions	STRING	Falso	Specifica se utilizzare le transazioni N1QL durante l'esecuzione delle query.
validate_jsonparameters	BOOLEANO	Falso	Consente al fornitore di convalidare che i parametri di stringa siano JSON validi prima di inviare la query a Couchbase.
proxy_enabled	BOOLEANO	Falso	Seleziona questa casella di controllo per configurare un server proxy per la connessione.
proxy_auth_scheme	ENUM	Falso	Il tipo di autenticazione da utilizzare per l'autenticazione al proxy ProxyServer. I valori supportati sono: BASIC, DIGEST, NONE
proxy_user	STRING	Falso	Un nome utente da utilizzare per l'autenticazione al proxy ProxyServer.
proxy_password	SECRET	Falso	Una password da utilizzare per l'autenticazione al proxy ProxyServer.
proxy_ssltype	ENUM	Falso	Il tipo di SSL da utilizzare per la connessione al proxy ProxyServer. I valori supportati sono: AUTO, ALWAYS, NEVER, TUNNEL
livello di dettaglio	STRING	Falso	Livello di dettaglio per la connessione, da 1 a 5. Un livello di dettagli più elevato registrerà tutti i dettagli della comunicazione (richiesta,risposta e certificati SSL).

Utilizzare la connessione Couchbase 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.