2023-08-29 11:16:32 +05:30 
										
									 
								 
							 
							
								
							 
							
								 
							
							
								---
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								title: Couchbase
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								slug: /connectors/database/couchbase
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								---
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								# Couchbase
  
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								{% multiTablesWrapper %}
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								| Feature            | Status                       |
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								| :----------------- | :--------------------------- |
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								| Stage              | PROD                         |
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								| Metadata           | {% icon iconName="check" /%} |
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								| Query Usage        | {% icon iconName="cross" /%} |
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								| Data Profiler      | {% icon iconName="cross" /%} |
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								| Data Quality       | {% icon iconName="cross" /%} |
							 
						 
					
						
							
								
									
										
										
										
											2023-10-31 10:06:25 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
								| Stored Procedures            | {% icon iconName="cross" /%} |
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								| DBT                | {% icon iconName="check" /%} |
							 
						 
					
						
							
								
									
										
										
										
											2023-08-29 11:16:32 +05:30 
										
									 
								 
							 
							
								
							 
							
								 
							
							
								| Supported Versions | --                           |
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								| Feature      | Status                       |
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								| :----------- | :--------------------------- |
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								| Lineage      | {% icon iconName="cross" /%}          |
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								| Table-level  | {% icon iconName="cross" /%} |
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								| Column-level | {% icon iconName="cross" /%} |
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								{% /multiTablesWrapper %}
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								In this section, we provide guides and references to use the Couchbase connector.
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								Configure and schedule Couchbase metadata workflows from the OpenMetadata UI:
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								-  [Requirements ](#requirements ) 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								-  [Metadata Ingestion ](#metadata-ingestion ) 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
									
										
										
										
											2023-09-12 12:22:40 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
								{% partial file="/v1.2/connectors/ingestion-modes-tiles.md" variables={yamlPath: "/connectors/database/couchbase/yaml"} /%}
							 
						 
					
						
							
								
									
										
										
										
											2023-08-29 11:16:32 +05:30 
										
									 
								 
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								## Requirements
  
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								{%inlineCallout icon="description" bold="OpenMetadata 0.12 or later" href="/deployment"%}
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								To deploy OpenMetadata, check the Deployment guides.
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								{%/inlineCallout%}
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								## Metadata Ingestion
  
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								{% partial 
							 
						 
					
						
							
								
									
										
										
										
											2023-09-12 12:22:40 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
								  file="/v1.2/connectors/metadata-ingestion-ui.md" 
							 
						 
					
						
							
								
									
										
										
										
											2023-08-29 11:16:32 +05:30 
										
									 
								 
							 
							
								
							 
							
								 
							
							
								  variables={
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								    connector: "Couchbase", 
							 
						 
					
						
							
								
									
										
										
										
											2023-09-12 12:22:40 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
								    selectServicePath: "/images/v1.2/connectors/couchbase/select-service.png",
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								    addNewServicePath: "/images/v1.2/connectors/couchbase/add-new-service.png",
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								    serviceConnectionPath: "/images/v1.2/connectors/couchbase/service-connection.png",
							 
						 
					
						
							
								
									
										
										
										
											2023-08-29 11:16:32 +05:30 
										
									 
								 
							 
							
								
							 
							
								 
							
							
								} 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								/%}
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								{% stepsContainer %}
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								{% extraContent parentTagName="stepsContainer" %}
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								#### Connection Details
  
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								-  **Username**: Username to connect to Couchbase. 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								-  **Password**: Password to connect to Couchbase. 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								-  **Hostport**: If couchbase is hosted on cloud then the hostport parameter specifies the connection string and if you are using couchbase server then the hostport parameter specifies hostname of the Couchbase. This should be specified as a string in the format `hostname`  or `xyz.cloud.couchbase.com` . E.g., `localhost` . 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								-  **bucketName**: Optional name to give to the bucket in OpenMetadata. If left blank, If left blank, we will ingest all the bucket names. 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
									
										
										
										
											2023-09-12 12:22:40 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
								{% partial file="/v1.2/connectors/database/advanced-configuration.md" /%}
							 
						 
					
						
							
								
									
										
										
										
											2023-08-29 11:16:32 +05:30 
										
									 
								 
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								{% /extraContent %}
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
									
										
										
										
											2023-09-12 12:22:40 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
								{% partial file="/v1.2/connectors/test-connection.md" /%}
							 
						 
					
						
							
								
									
										
										
										
											2023-08-29 11:16:32 +05:30 
										
									 
								 
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
									
										
										
										
											2023-09-12 12:22:40 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
								{% partial file="/v1.2/connectors/database/configure-ingestion.md" /%}
							 
						 
					
						
							
								
									
										
										
										
											2023-08-29 11:16:32 +05:30 
										
									 
								 
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
									
										
										
										
											2023-09-12 12:22:40 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
								{% partial file="/v1.2/connectors/ingestion-schedule-and-deploy.md" /%}
							 
						 
					
						
							
								
									
										
										
										
											2023-08-29 11:16:32 +05:30 
										
									 
								 
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								{% /stepsContainer %}
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
									
										
										
										
											2023-09-12 12:22:40 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
								{% partial file="/v1.2/connectors/troubleshooting.md" /%}
							 
						 
					
						
							
								
									
										
										
										
											2023-08-29 11:16:32 +05:30 
										
									 
								 
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
									
										
										
										
											2023-09-12 12:22:40 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
								{% partial file="/v1.2/connectors/database/related.md" /%}