main-concepts

No menu items for this category
OpenMetadata Documentation

MysqlConnection

Mysql Database Connection Config

  • type: Service Type. Refer to #/definitions/mySQLType. Default: Mysql.
  • scheme: SQLAlchemy driver scheme options. Refer to #/definitions/mySQLScheme. Default: mysql+pymysql.
  • username (string): Username to connect to MySQL. This user should have privileges to read all the metadata in Mysql.
  • authType: Choose Auth Config Type.
  • hostPort (string): Host and port of the MySQL service.
  • databaseName (string): Optional name to give to the database in OpenMetadata. If left blank, we will use default as the database name.
  • databaseSchema (string): Database Schema of the data source. This is optional parameter, if you would like to restrict the metadata reading to a single schema. When left blank, OpenMetadata Ingestion attempts to scan all the schemas.
  • sslConfig: SSL Configuration details. Refer to ../../../../security/ssl/verifySSLConfig.json#/definitions/sslConfig.
  • connectionOptions: Refer to ../connectionBasicType.json#/definitions/connectionOptions.
  • connectionArguments: Refer to ../connectionBasicType.json#/definitions/connectionArguments.
  • schemaFilterPattern: Regex to only include/exclude schemas that matches the pattern. Refer to ../../../../type/filterPattern.json#/definitions/filterPattern. Default: {'includes': [], 'excludes': ['^information_schema$', '^performance_schema$']}.
  • 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.
  • supportsMetadataExtraction: Refer to ../connectionBasicType.json#/definitions/supportsMetadataExtraction.
  • supportsDBTExtraction: Refer to ../connectionBasicType.json#/definitions/supportsDBTExtraction.
  • supportsProfiler: Refer to ../connectionBasicType.json#/definitions/supportsProfiler.
  • supportsQueryComment: Refer to ../connectionBasicType.json#/definitions/supportsQueryComment.
  • sampleDataStorageConfig: Refer to ../connectionBasicType.json#/definitions/sampleDataStorageConfig.
  • supportsDataDiff: Refer to ../connectionBasicType.json#/definitions/supportsDataDiff.
  • supportsUsageExtraction: Refer to ../connectionBasicType.json#/definitions/supportsUsageExtraction.
  • supportsLineageExtraction: Refer to ../connectionBasicType.json#/definitions/supportsLineageExtraction.
  • useSlowLogs (boolean): Use slow logs to extract lineage. Default: False.
  • mySQLType (string): Service type. Must be one of: ['Mysql']. Default: Mysql.
  • mySQLScheme (string): SQLAlchemy driver scheme options. Must be one of: ['mysql+pymysql']. Default: mysql+pymysql.

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