We use cookies to improve site navigation, analyze site usage, and enhance your user experience. Click "Accept" to enable cookies or "Reject" to reject cookies.

main-concepts

No menu items for this category
Home/Main Concepts/Metadata Standard/Schemas/Entity/Services/Connections/Metadata/Openmetadataconnection
OpenMetadata Documentation

OpenMetadataConnection

OpenMetadata Connection Config

Properties

  • clusterName (string): Cluster name to differentiate OpenMetadata Server instance. Default: openmetadata.
  • type: Service Type. Refer to #/definitions/openmetadataType. Default: OpenMetadata.
  • hostPort (string): OpenMetadata Server Config. Must include API end point ex: http://localhost:8585/api. Default: http://localhost:8585/api.
  • authProvider: OpenMetadata Server Authentication Provider. Refer to #/definitions/authProvider.
  • verifySSL: Flag to verify SSL Certificate for OpenMetadata Server. Refer to ../../../../security/ssl/verifySSLConfig.json#/definitions/verifySSL. Default: no-ssl.
  • sslConfig: SSL Configuration for OpenMetadata Server. Refer to ../../../../security/ssl/verifySSLConfig.json#/definitions/sslConfig.
  • securityConfig: OpenMetadata Client security configuration. Refer to ../../../../security/client/openMetadataJWTClientConfig.json.
  • secretsManagerProvider: Secrets Manager Provider for OpenMetadata Server. Refer to ./../../../../security/secrets/secretsManagerProvider.json. Default: db.
  • secretsManagerLoader: Secrets Manager Loader for the Pipeline Service Client. Refer to ./../../../../security/secrets/secretsManagerClientLoader.json. Default: noop.
  • apiVersion (string): OpenMetadata server API version to use. Default: v1.
  • includeTopics (boolean): Include Topics for Indexing. Default: True.
  • includeTables (boolean): Include Tables for Indexing. Default: True.
  • includeDashboards (boolean): Include Dashboards for Indexing. Default: True.
  • includePipelines (boolean): Include Pipelines for Indexing. Default: True.
  • includeMlModels (boolean): Include MlModels for Indexing. Default: True.
  • includeUsers (boolean): Include Users for Indexing. Default: True.
  • includeTeams (boolean): Include Teams for Indexing. Default: True.
  • includeGlossaryTerms (boolean): Include Glossary Terms for Indexing. Default: True.
  • includeTags (boolean): Include Tags for Indexing. Default: True.
  • includePolicy (boolean): Include Tags for Policy. Default: True.
  • includeMessagingServices (boolean): Include Messaging Services for Indexing. Default: True.
  • enableVersionValidation (boolean): Validate Openmetadata Server & Client Version. Default: True.
  • includeDatabaseServices (boolean): Include Database Services for Indexing. Default: True.
  • includePipelineServices (boolean): Include Pipeline Services for Indexing. Default: True.
  • limitRecords (integer): Limit the number of records for Indexing. Default: 1000.
  • forceEntityOverwriting (boolean): Force the overwriting of any entity during the ingestion. Default: False.
  • storeServiceConnection (boolean): If set to true, when creating a service during the ingestion we will store its Service Connection. Otherwise, the ingestion will create a bare service without connection details. Default: True.
  • elasticsSearch (object): Configuration for Sink Component in the OpenMetadata Ingestion Framework. Cannot contain additional properties.
    • type (string): Type of sink component ex: metadata.
    • config: Refer to ../../../../type/basic.json#/definitions/componentConfig.
  • schemaFilterPattern: Regex to only include/exclude schemas that matches the pattern. Refer to ../../../../type/filterPattern.json#/definitions/filterPattern.
  • tableFilterPattern: Regex to only include/exclude tables that matches the pattern. Refer to ../../../../type/filterPattern.json#/definitions/filterPattern.
  • databaseFilterPattern: Regex to only include/exclude databases that matches the pattern. Refer to ../../../../type/filterPattern.json#/definitions/filterPattern.
  • supportsDataInsightExtraction: Flag to enable Data Insight Extraction. Refer to ../connectionBasicType.json#/definitions/supportsDataInsightExtraction.
  • supportsElasticSearchReindexingExtraction: Flag to enable ElasticSearch Reindexing Extraction. Refer to ../connectionBasicType.json#/definitions/supportsElasticSearchReindexingExtraction.
  • extraHeaders: Refer to #/definitions/extraHeaders.

Definitions

  • openmetadataType (string): OpenMetadata service type. Must be one of: ['OpenMetadata']. Default: OpenMetadata.
  • extraHeaders (object): Additional headers to be sent to the API endpoint. Can contain additional properties.
    • Additional Properties (string)
  • authProvider (string): OpenMetadata Server Authentication Provider. Make sure configure same auth providers as the one configured on OpenMetadata server. Must be one of: ['basic', 'azure', 'google', 'okta', 'auth0', 'aws-cognito', 'custom-oidc', 'ldap', 'saml', 'openmetadata']. Default: basic.

Documentation file automatically generated at 2025-08-12 05:39:47.683420+00:00.