Skip to main content
First time creating a connector? Read this first.
Ingest your files into Unstructured from Couchbase.

​
Requirements

You will need:
For Couchbase Capella, you will need: For a local Couchbase server, you will need: To learn more about how to set up a Couchbase cluster and play with data, refer to this tutorial.

​
Examples

To create a Couchbase source connector, see the following examples. For more information on working with source connectors using the Unstructured API, see Source endpoints. 
import os

from unstructured_client import UnstructuredClient
from unstructured_client.models.operations import CreateSourceRequest
from unstructured_client.models.shared import CreateSourceConnector

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="couchbase",
                config={
                    "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)

​
Configuration settings

Replace the preceding placeholders as follows:
​
name
string
required
A unique name for this connector.
​
username
string
required
The username for the Couchbase server.
​
bucket
string
required
The name of the bucket in the Couchbase server.
​
connection_string
string
required
The connection string for the Couchbase server.
​
scope
string
default:"_default"
The name of the scope in the bucket.
​
collection
string
default:"_default"
The name of the collection in the scope.
​
password
string
required
The password for the Couchbase server.
​
batch_size
integer
default:"50"
The maximum number of records to transmit per batch.
​
collection_id
string
default:"id"
Source connector only. The name of the collection field that contains the document ID.

​
Learn more