Couchbase

If you’re new to Unstructured, read this note first.

Before you can create a source connector, you must first sign in to your Unstructured account:

• If you do not already have an Unstructured account, go to https://unstructured.io/contact and fill out the online form to indicate your interest.
• If you already have an Unstructured account, go to https://platform.unstructured.io and sign in by using the email address, Google account, or GitHub account that is associated with your Unstructured account.

After you sign in, the Unstructured user interface (UI) appears, which you use to get your Unstructured API key. To learn how, watch this 40-second how-to video.

After you create the source connector, add it along with a destination connector to a workflow. Then run the worklow as a job. To learn how, try out the hands-on Workflow Endpoint quickstart, go directly to the quickstart notebook, or watch the two 4-minute video tutorials for the Unstructured Python SDK.

You can also create source connectors with the Unstructured user interface (UI). Learn how.

If you need help, reach out to the community on Slack, or contact us directly.

You are now ready to start creating a source connector! Keep reading to learn how.

Ingest your files into Unstructured from Couchbase.

The requirements are as follows.

• For the Unstructured UI or the Unstructured API, 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 a Couchbase source connector, see the following examples.

Python SDK

import os

from unstructured_client import UnstructuredClient
from unstructured_client.models.operations import CreateSourceRequest
from unstructured_client.models.shared import (
    CreateSourceConnector,
    SourceConnectorType,
    CouchbaseSourceConnectorConfigInput
)

with UnstructuredClient(api_key_auth=os.getenv("UNSTRUCTURED_API_KEY")) as client:
    response = client.sources.create_source(
        request=CreateSourceRequest(
            create_source_connector=CreateSourceConnector(
                name="<name>",
                type=SourceConnectorType.COUCHBASE,
                config=CouchbaseSourceConnectorConfigInput(
                    username="<username>",
                    bucket="<bucket>",
                    connection_string="<connection-string>",
                    scope="<scope>",
                    collection="<collection>",
                    password="<password>",
                    batch_size=<batch-size>,
                    collection_id="<collection-id>" 
                )
            )
        )
    )

    print(response.source_connector_information)

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> (source connector only) - The name of the collection field that contains the document ID. The default is id if not otherwise specified.