OdooWiki OCA HUB

External Database Source - MySQL

base_external_dbsource_mysql folder_open OCA/server-backend open_in_new
Tools License: LGPL-3

This module extends base_external_dbsource, allowing you to connect to foreign MySQL databases using SQLAlchemy.

auto_awesome What this module does

AI-generated from the code · Odoo 18.0

Adds MySQL as a connector option for external database sources in Odoo, so users can connect to and query a MySQL database from the External Database Sources screen.

This module extends the External Database Sources feature so that a MySQL database can be used as a connection type. On the external database source form, the Connector field gains a new "MySQL" choice alongside the existing options.

Once a source is set to MySQL, Odoo can open a connection to that database, run SQL queries against it, and close the connection again. Query results are returned as rows, and when metadata is requested the column names are returned as well.

  • Adds the "MySQL" value to the connector selection on base.external.dbsource.
  • Provides the connection open, execute and close logic used when the connector is MySQL.
  • Requires the Python libraries sqlalchemy and mysqlclient to be installed on the server.
  • Ships a demo external database source record named "MySQL Demo" preconfigured with the MySQL connector.

It does not add its own menus or screens; everything appears inside the existing External Database Sources area provided by the base module. The connection details (server, database, user and password) are entered on the source record itself. This module only supplies the MySQL-specific plumbing, so any querying or use of the returned data is handled by the base external database source functionality.

Depends on

base_external_dbsource
Models and fields (1)
  • base.external.dbsource · extends an existing modelconnector

Text generated by AI (DeepSeek) from reading the Odoo 18.0 code on GitHub; it may contain mistakes, so check the code before deciding. View the code on GitHub

Availability by version

Reviewed: 2026-11-03
Confirmed (verified in repository and branch) Estimated (unverified) No information

Confirmation status: 6 confirmed, 3 with no information of 9 versions.

Sources · Odoo 17.0

Confirmed on 2026-11-03 in branch 17.0 of OCA/server-backend.

terminal Installation and usage

OCA documentation · Odoo 18.0

Installation

Source · Odoo 18.0

To install this module, you need to:

  • Install libmysqlclient-dev package (default-libmysqlclient-dev on Debian)
  • Install sqlalchemy and mysqlclient python libraries

Configuration

Source · Odoo 18.0

To configure this module, you need to:

  • Database sources can be configured in Settings \> Technical \> Database Structure \> Database sources.

Usage

Source · Odoo 18.0

To use this module:

  • Go to Settings \> Technical \> Database Structure \> Database Sources
  • Click on Create to enter the following information:
  • Datasource name??
  • Pasword
  • Connector: Choose the database to which you want to connect
  • Connection string: Specify how to connect to database
info

Data imported from GitHub: this sheet reflects the latest catalog review, not a live lookup. Always check the module documentation and staging before installing in production.