Couchbase

Send processed data from Unstructured to Couchbase.

The requirements are as follows.

• For the Unstructured Platform, only Couchbase Capella clusters are supported.
• For Unstructured Ingest, Couchbase Capella clusters and local Couchbase server deployments are supported.

For Couchbase Capella, you will need:

• A Couchbase Capella account.

• A Couchbase Capella cluster.

• A bucket, scope, and collection on the cluster.

• The cluster’s public connection string.

• The cluster access name (username) and secret (password).

• Incoming IP address allowance for the cluster.

  To get Unstructured’s IP address ranges, go to https://assets.p6m.u10d.net/publicitems/ip-prefixes.json and allow all of the ip_prefix fields’ values that are listed.

  These IP address ranges are subject to change. You can always find the latest ones in the preceding file.

For a local Couchbase server, you will need:

• Installation of a local Couchbase server.
• Connection details to the local Couchbase server.

To learn more about how to set up a Couchbase cluster and play with data, refer to this tutorial.

To create or change a Couchbase destination connector, see the following examples.

# ...
from unstructured_client.models.shared import <Create|Update>DestinationConnector
# ...
destination_connector = <Create|Update>DestinationConnector(
    name="<name>", # Create only.
    type="couchbase", # Create only.
    config={
        "username": "<username>",
        "bucket": "<bucket>",
        "connection_string": "<connection-string>",
        "scope": "<scope>",
        "collection": "<collection>",
        "password": "<password>",
        "batch_size": <batch-size>,
        "collection_id": "<collection-id>"
    }
)
# ...

Replace the preceding placeholders as follows:

• <name> (required) - A unique name for this connector.
• <username> (required) - The username for the Couchbase server.
• <bucket> (required) - The name of the bucket in the Couchbase server.
• <connection-string> (required) - The connection string for the Couchbase server.
• <scope> - The name of the scope in the bucket. The default is _default if not otherwise specified.
• <collection> - The name of the collection in the scope. The default is _default if not otherwise specified.
• <password> (required) - The password for the Couchbase server.
• <batch-size> - The maximum number of records to transmit per batch. The default is 50 if not otherwise specified.
• <collection-id> - The name of the collection field that contains the document ID. The default is id if not otherwise specified.

To change a connector, replace <connector-id> with the destination connector’s unique ID. To get this ID, see List destination connectors.