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

  • Assicurati di disporre di un ruolo utente amministratore per autenticarti in Apache CouchDB.
  • Per informazioni su Apache CouchDB, consulta la guida rapida ad Apache CouchDB. Per ulteriori informazioni sulla piattaforma Apache CouchDB, consulta la panoramica della piattaforma Apache CouchDB. Per informazioni sulla configurazione SSL di Apache CouchDB, consulta Apache CouchDB 3.5.2. Opzioni HTTPS (SSL/TLS) e Come faccio a configurare SSL (HTTPS) in Apache CouchDB?.

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 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 superare i 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. Per elaborare più transazioni per una connessione sono necessari più nodi 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.

    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 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:

    10. Se vuoi, fai clic su + AGGIUNGI ETIQUETTA 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.

      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

      2. 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 quando crei la connessione Apcache CouchDB.

Tipo di connessione per l'autenticazione di base

Nome campo Dettagli
Località us-central1
Connettore Apache CouchDB
Versione del connettore 1
Nome collegamento couchdb-vm-connection
Abilita Cloud Logging Sì
Account di servizio SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
Visualizzazioni elenco Sì
Schema flessibile Sì
Numero minimo di nodi 2
Numero massimo di nodi 50
Tipo di destinazione(server) Indirizzo host
Indirizzo host http://198.51.100.0
Nome utente NOME UTENTE
Password PASSWORD
Versione secret 1

Tipo di connessione proxy

Nome campo Dettagli
Località us-central1
Connettore Apache CouchDB
Versione del connettore 1
Nome collegamento couchdb-proxy-conn
Abilita Cloud Logging Sì
Account di servizio SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
Visualizzazioni elenco No
Schema flessibile No
Proxy utilizza proxy
Schema di autenticazione proxy Sintesi
Utente proxy PROXY_USER
Password proxy PROXY_PASSWORD
Numero minimo di nodi 2
Numero massimo di nodi 50
Tipo di destinazione(server) Indirizzo host
Indirizzo host http://198.51.100.0
Nome utente NOME UTENTE
Password PASSWORD
Versione secret 1

Tipo di connessione SSL (non sicura)

Nome campo Dettagli
Località us-central1
Connettore Apache CouchDB
Versione del connettore 1
Nome collegamento couchdb-ssl-conn
Abilita Cloud Logging Sì
Account di servizio SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
Visualizzazioni elenco No
Schema flessibile No
Numero minimo di nodi 2
Numero massimo di nodi 50
Archivio di attendibilità (scegli il modello di attendibilità) Connessione non sicura
Tipo di destinazione(server) Indirizzo host
Indirizzo host http://198.51.100.0
Nome utente NOME UTENTE
Password PASSWORD
Versione secret 1

Tipo di connessione SSL (privata)

Nome campo Dettagli
Località us-central1
Connettore Apache CouchDB
Versione del connettore 1
Nome collegamento couchdb-proxy-conn
Abilita Cloud Logging Sì
Account di servizio SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
Visualizzazioni elenco No
Schema flessibile No
Numero minimo di nodi 2
Numero massimo di nodi 50
Archivio di attendibilità (scegli il modello di attendibilità) Privato
Archivio di attendibilità personalizzato Certificato autofirmato.
Versione secret 1
Tipo di destinazione(server) Indirizzo host
Indirizzo host https://198.51.100.0
Nome utente NOME UTENTE
Password PASSWORD
Versione secret 1

Entità, operazioni e azioni

Tutti i connettori di integrazione 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.

  • 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:

    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.

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.

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. Se vuoi, 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.

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

Esempio: aggiungere un cliente

Questo esempio crea un record 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 e poi inserisci un valore simile al seguente nel 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 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 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 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
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 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 SEGRETO 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

Utilizzare la connessione Apache CouchDB 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