Apache CouchDB

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

Prima di iniziare

Prima di utilizzare il connettore Apache CouchDB, esegui le seguenti 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 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 le informazioni, vedi Creazione di un account di servizio.

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

    Per informazioni su come abilitare i servizi, vedi Attivazione 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.

Configura il connettore

Per configurare il connettore è necessario creare una connessione al tuo 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 a Connettori di integrazione > Pagina Connessioni e poi selezionare o creare 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 aree geografiche supportate, consulta la sezione Località.

   2. Fai clic su AVANTI.
4. Nella sezione Dettagli connessione, completa quanto segue:
   1. Connettore: seleziona Apache CouchDB 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. Facoltativamente, 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, per elaborare meno transazioni. Per comprendere 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 migliore 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. Schema flessibile: imposta FlexibleSchema su true per cercare metadati aggiuntivi nel set di risultati della query. In caso contrario, i metadati rimarranno invariati.
   9. Utilizza proxy: seleziona questa casella di controllo per configurare un server proxy per la connessione e imposta 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 secret di Secret Manager della password dell'utente.
   • Tipo SSL proxy: il tipo SSL da utilizzare per la connessione al server proxy. Sono supportati i seguenti tipi di autenticazione:
     • Automatica: l'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 SSL abilitata.
     • Mai: la connessione non è abilitata per SSL.
     • Tunnel: la connessione avviene tramite un proxy di tunneling. Il server proxy apre una connessione con l'host remoto e il traffico passa 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, segui questi passaggi:

          • Crea un collegamento del servizio PSC.
          • Crea un collegamento dell'endpoint e poi inserisci i dettagli del collegamento dell'endpoint nel campo Indirizzo host.
   10. Facoltativamente, fai clic su + AGGIUNGI ETICHETTA per aggiungere un'etichetta alla connessione sotto forma di coppia chiave/valore.
   11. 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 dell'endpoint, vedi Collegamento servizio PSC e l'allegato all'endpoint. Dopo hanno creato il collegamento dell'endpoint, sarà visibile nell'elenco Allegato 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 Apache CouchDB supporta i seguenti tipi di autenticazione:

      • Nome utente e password

   Per informazioni su come configurare questi tipi di autenticazione, consulta l'articolo 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 del connettore
  • Password: il segreto 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 l'applicazione connessa. 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 nell'attività Connettori.

• Entità: un'entità può essere considerata un oggetto o un insieme di proprietà nel un'applicazione o un servizio connesso. 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

  Selezionando un'entità dall'elenco disponibile, viene generato un elenco di le 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. Normalmente, un'azione ha alcuni parametri di input e un output . Tuttavia, è possibile che un connettore non supporti alcuna azione, nel qual caso l'elenco Actions sarà vuoto.

Nota : a tutte le entità e alle azioni è associato uno schema. Ad esempio, uno schema delle azioni avrà i dettagli dei parametri, come ad esempio il parametro e il tipo di dati corrispondente. Lo schema (metadati) per entità e azioni viene recuperato dalla connessione in 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 Apache CouchDB può elaborare un massimo di 5 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. Se invece vuoi prenotare capacità per volumi elevati senza in attesa della 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, 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 hai un abbonamento basato su abbonamento Cliente, 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 tutti i record dei clienti

Questo esempio elenca tutti i record dei clienti nell'entità Customer.

1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
2. Seleziona Customer dall'elenco Entity.
3. Seleziona l'operazione LIST e fai clic su Fine.
4. Facoltativamente, puoi inserire valori in filterClause per filtrare il set di risultati.

Esempio: ottieni un record cliente

Questo esempio recupera un record cliente specifico dall'entità Customers.

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

   In questo caso, cust-2 è il valore della chiave primaria dell'entità Customers.

Esempio - Aggiungere un cliente

Questo esempio crea un record del cliente nell'entità Customers.

1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
2. Seleziona Customers 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, quindi inserisci un valore simile al seguente nella Campo Default Value:

   {
   "name": "John",
   "_id": "cust-3"
   }

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

   {
   "_id": cust-3
   }

Esempio: aggiornare un record cliente

Questo esempio aggiorna il record cliente specificato nell'entità Customers.

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

   {
         "name": "Jason",
       }
       

5. Fai clic su entityId e inserisci cust-5 nel campo Default Value (Valore predefinito).

   In alternativa, anziché specificare entityId, puoi anche impostare filterClause su cust-5.

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

   {
   "_id": cust-5
   }
       

Esempio: eliminare un record di un cliente

Questo esempio elimina il record del cliente specificato dall'entità Customers.

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

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 connessioni, vedi il modello di esempio.

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

Nome parametro	Tipo di dati	Obbligatorio	Descrizione
flexible_schema	BOOLEANO	Falso	Imposta FlexibleSchema su true per cercare metadati aggiuntivi nel set di risultati della query. In caso contrario, i metadati rimarranno invariati.
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 sul 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 sul proxy ProxyServer.
proxy_ssltype	ENUM	Falso	Il tipo SSL da utilizzare per la connessione al proxy ProxyServer. I valori supportati sono: AUTO, ALWAYS, NEVER, TUNNEL

Utilizzare la connessione Apache CouchDB in un'integrazione

Una volta creata, la connessione diventa disponibile sia nell'integrazione Apigee sia nell'integrazione delle applicazioni. Puoi usare 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 in Google Cloud nei 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.