In this section, we provide guides and references to use the Couchbase connector.
Configure and schedule Couchbase metadata workflows from the OpenMetadata UI:
Ingestion Deployment
To run the Ingestion via the UI you'll need to use the OpenMetadata Ingestion Container, which comes shipped with custom Airflow plugins to handle the workflow deployment. If you want to install it manually in an already existing Airflow host, you can follow this guide.
If you don't want to use the OpenMetadata Ingestion container to configure the workflows via the UI, then you can check the following docs to run the Ingestion Framework in any orchestrator externally.
Run Connectors from the OpenMetadata UI
Learn how to manage your deployment to run connectors from the UIRun the Connector Externally
Get the YAML to run the ingestion externallyExternal Schedulers
Get more information about running the Ingestion Framework ExternallyHow to Run the Connector Externally
To run the Ingestion via the UI you'll need to use the OpenMetadata Ingestion Container, which comes shipped with custom Airflow plugins to handle the workflow deployment.
If, instead, you want to manage your workflows externally on your preferred orchestrator, you can check the following docs to run the Ingestion Framework anywhere.
Requirements
Python Requirements
We have support for Python versions 3.8-3.11
To run the Couchbase ingestion, you will need to install:
Metadata Ingestion
All connectors are defined as JSON Schemas. Here you can find the structure to create a connection to Couchbase.
In order to create and run a Metadata Ingestion workflow, we will follow the steps to create a YAML configuration able to connect to the source, process the Entities if needed, and reach the OpenMetadata server.
The workflow is modeled around the following JSON Schema
1. Define the YAML Config
This is a sample config for Couchbase:
Source Configuration - Service Connection
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 name in OpenMetadata. If left blank, we will ingest all the bucket names.
Source Configuration - Source Config
The sourceConfig is defined here:
markDeletedTables: To flag tables as soft-deleted if they are not present anymore in the source system.
markDeletedStoredProcedures: Optional configuration to soft delete stored procedures in OpenMetadata if the source stored procedures are deleted. Also, if the stored procedures is deleted, all the associated entities like lineage, etc., with that stored procedures will be deleted.
includeTables: true or false, to ingest table data. Default is true.
includeViews: true or false, to ingest views definitions.
includeTags: Optional configuration to toggle the tags ingestion.
includeOwners: Set the 'Include Owners' toggle to control whether to include owners to the ingested entity if the owner email matches with a user stored in the OM server as part of metadata ingestion. If the ingested entity already exists and has an owner, the owner will not be overwritten.
includeStoredProcedures: Optional configuration to toggle the Stored Procedures ingestion.
includeDDL: Optional configuration to toggle the DDL Statements ingestion.
queryLogDuration: Configuration to tune how far we want to look back in query logs to process Stored Procedures results.
queryParsingTimeoutLimit: Configuration to set the timeout for parsing the query in seconds.
useFqnForFiltering: Regex will be applied on fully qualified name (e.g service_name.db_name.schema_name.table_name) instead of raw name (e.g. table_name).
databaseFilterPattern, schemaFilterPattern, tableFilterPattern: Note that the filter supports regex as include or exclude. You can find examples here
threads (beta): The number of threads to use when extracting the metadata using multithreading. Please take a look here before configuring this.
incremental (beta): Incremental Extraction configuration. Currently implemented for:
Sink Configuration
To send the metadata to OpenMetadata, it needs to be specified as type: metadata-rest.
Workflow Configuration
The main property here is the openMetadataServerConfig, where you can define the host and security provider of your OpenMetadata installation.
Logger Level
You can specify the loggerLevel depending on your needs. If you are trying to troubleshoot an ingestion, running with DEBUG will give you far more traces for identifying issues.
JWT Token
JWT tokens will allow your clients to authenticate against the OpenMetadata server. To enable JWT Tokens, you will get more details here.
You can refer to the JWT Troubleshooting section link for any issues in your JWT configuration.
Store Service Connection
If set to true (default), we will store the sensitive information either encrypted via the Fernet Key in the database or externally, if you have configured any Secrets Manager.
If set to false, the service will be created, but the service connection information will only be used by the Ingestion Framework at runtime, and won't be sent to the OpenMetadata server.
Store Service Connection
If set to true (default), we will store the sensitive information either encrypted via the Fernet Key in the database or externally, if you have configured any Secrets Manager.
If set to false, the service will be created, but the service connection information will only be used by the Ingestion Framework at runtime, and won't be sent to the OpenMetadata server.
SSL Configuration
If you have added SSL to the OpenMetadata server, then you will need to handle the certificates when running the ingestion too. You can either set verifySSL to ignore, or have it as validate, which will require you to set the sslConfig.caCertificate with a local path where your ingestion runs that points to the server certificate file.
Find more information on how to troubleshoot SSL issues here.
Advanced Configuration
Connection Options (Optional): Enter the details for any additional connection options that can be sent to database during the connection. These details must be added as Key-Value pairs.
2. Run with the CLI
First, we will need to save the YAML file. Afterward, and with all requirements installed, we can run:
Note that from connector to connector, this recipe will always be the same. By updating the YAML configuration, you will be able to extract metadata from different sources.