Couchbase
Connect Couchbase Database to your preprocessing pipeline, and use the Unstructured Ingest CLI or the Unstructured Ingest Python library to batch process all your documents and store structured outputs locally on your filesystem.
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. Create an account.
-
A Couchbase Capella cluster. Create a cluster.
-
A cluster connection string. Learn how.
-
A username and password. Learn how.
-
Incoming IP address allowance. Learn how.
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. Learn how.
- Connection details to the local Couchbase server. Learn how.
To learn more about how to set up a Couchbase cluster and play with data, refer to this tutorial.
The Couchbase DB connector dependencies:
You might also need to install additional dependencies, depending on your needs. Learn more.
These environment variables are required for the Couchbase Connector:
CB_CONN_STR
- The Connection String for the Couchbase server, represented by--connection-string
(CLI) orconnection_string
(Python).CB_USERNAME
- The username for the Couchbase server, represented by--username
(CLI) orusername
(Python).CB_PASSWORD
- The password for the Couchbase server, represented by--password
(CLI) orpassword
(Python).CB_BUCKET
- The name of the bucket in the Couchbase server, represented by--bucket
(CLI) orbucket
(Python).CB_SCOPE
- The name of the scope in the bucket, represented by--scope
(CLI) orscope
(Python).CB_COLLECTION
- The name of the collection in the scope, represented by--collection
(CLI) orcollection
(Python).
Additional available settings include:
--collection-id
(CLI) orcollection_id
inCouchbaseDownloaderConfig
(Python) - Optional for the source connector. The
unique key of the ID field in the collection. The default isid
if not otherwise specified. Learn more.
These environment variables:
UNSTRUCTURED_API_KEY
- Your Unstructured API key value.UNSTRUCTURED_API_URL
- Your Unstructured API URL.
Now call the Unstructured CLI or Python. The destination connector can be any of the ones supported. This example uses the local destination connector:
Was this page helpful?