Apache Atlas - Open Metadata Management and Governance capabilities across the Hadoop platform and beyond

Apache Atlas 2.5.0

# Apache Atlas Couchbase bridge

This bridge connects to a Couchbase cluster using DCP protocol and performs real-time analysis and metadata extraction from stored on the cluster documents. The extracted metadata is then sent to Atlas via its REST API

## Configuration

The bridge uses environment variables for configuration.

### Atlas REST API

| Environment variable | Description             | Default Value            |
|----------------------|-------------------------|--------------------------|
| ATLAS\_URL           | Atlas REST API url      | "http://localhost:21000" |
| ATLAS\_USERNAME      | Atlas REST API username | "admin"                  |
| ATLAS\_PASSWORD      | Atlas REST API password | "admin"                  |

### Couchbase DCP connection

| Environment variable  | Description                                                                                                                      | Default Value           |
|-----------------------|----------------------------------------------------------------------------------------------------------------------------------|-------------------------|
| CB\_CLUSTER           | Couchbase Cluster connection string                                                                                              | "couchbase://localhost" |
| CB\_USERNAME          | Couchbase Cluster username                                                                                                       | "Administrator"         |
| CB\_PASSWORD          | Couchbase Cluster password                                                                                                       | "password"              |
| CB\_ENABLE\_TLS       | Use TLS                                                                                                                          | false                   |
| CB\_BUCKET            | Couchbase bucket to monitor                                                                                                      | "default"               |
| CB\_COLLECTIONS       | Comma-separated list of collections to monitor with each collection listed as {scope}.{collection}                               |                         |
| DCP\_PORT             | DCP port to use                                                                                                                  | 11210                   |
| DCP\_FIELD\_THRESHOLD | A threshold that indicates in what percentage of analyzed messages per collection a field must appear before it is sent to Atlas | 0                       |
| DCP\_SAMPLE\_RATIO    | Percentage of DCP messages to be analyzed in form of a short between 0 and 1.                                                    | 1                       |

## Running the bridge

In the following commands, replace `<VARNAME>` and `<version>` with appropriate values.

- Set environment variables using `export <VARNAME>=...` or prefix them before the next command.
- Run `java -cp couchbase-bridge-<version>.jar com.couchbase.atlas.connector.CouchbaseHook`.
- Verify that appropriate `couchbase_cluster`, `couchbase_bucket` objects were created on your Atlas cluster.
- After having some documents updated on the Couchbase cluster, verify that appropriate `couchbase_scope`, `couchbase_collection`, and `couchbase_field` objects were created on your Atlas cluster.


Couchbase

KnowForge 新版本 2026.0.3 正式发布！！！

High Level Architecture

Type System

Glossary

Classification Propagation

Notifications

High Availability

Business Metadata

Features

Basic Search

Advanced Search

Relationship Search

Search

HBase

Hive

Sqoop

Storm

Kafka

Falcon

Hooks

Import API

Import API Options

Import Entity Transforms

Import Export API

Export API

Export HDFS API

Export Import Audits

Incremental Export

Import/Export

Security Details

Authentication

Authorization Model

Atlas Simple Authorizer

Atlas Ranger Authorizer

Security

Quick Start

Configuration

Build Instruction

Installation Instruction

Setup

REST API Documentation

Legacy API Documentation

REST API

Atlas Repair Index

Trino Extractor

Tools

Atlas Server

Replicated Attributes

Soft Reference

Misc

Environment variable	Description	Default Value
ATLAS_URL	Atlas REST API url	"http://localhost:21000"
ATLAS_USERNAME	Atlas REST API username	"admin"
ATLAS_PASSWORD	Atlas REST API password	"admin"

Environment variable	Description	Default Value
CB_CLUSTER	Couchbase Cluster connection string	"couchbase://localhost"
CB_USERNAME	Couchbase Cluster username	"Administrator"
CB_PASSWORD	Couchbase Cluster password	"password"
CB_ENABLE_TLS	Use TLS	false
CB_BUCKET	Couchbase bucket to monitor	"default"
CB_COLLECTIONS	Comma-separated list of collections to monitor with each collection listed as {scope}.{collection}
DCP_PORT	DCP port to use	11210
DCP_FIELD_THRESHOLD	A threshold that indicates in what percentage of analyzed messages per collection a field must appear before it is sent to Atlas	0
DCP_SAMPLE_RATIO	Percentage of DCP messages to be analyzed in form of a short between 0 and 1.	1

Couchbase

Apache Atlas Couchbase bridge

Configuration

Atlas REST API

Couchbase DCP connection

Running the bridge

评论