|
| 1 | +================================ |
| 2 | +External Database Source - MySQL |
| 3 | +================================ |
| 4 | + |
| 5 | +.. |
| 6 | + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
| 7 | + !! This file is generated by oca-gen-addon-readme !! |
| 8 | + !! changes will be overwritten. !! |
| 9 | + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
| 10 | + !! source digest: sha256:dbfb3a74255192dbba49a5fee95d2e3f8f3e0c4e592e9307a1f653f266c3b7e7 |
| 11 | + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
| 12 | +
|
| 13 | +.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png |
| 14 | + :target: https://odoo-community.org/page/development-status |
| 15 | + :alt: Beta |
| 16 | +.. |badge2| image:: https://img.shields.io/badge/licence-LGPL--3-blue.png |
| 17 | + :target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html |
| 18 | + :alt: License: LGPL-3 |
| 19 | +.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--backend-lightgray.png?logo=github |
| 20 | + :target: https://github.com/OCA/server-backend/tree/17.0/base_external_dbsource_mysql |
| 21 | + :alt: OCA/server-backend |
| 22 | +.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png |
| 23 | + :target: https://translation.odoo-community.org/projects/server-backend-17-0/server-backend-17-0-base_external_dbsource_mysql |
| 24 | + :alt: Translate me on Weblate |
| 25 | +.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png |
| 26 | + :target: https://runboat.odoo-community.org/builds?repo=OCA/server-backend&target_branch=17.0 |
| 27 | + :alt: Try me on Runboat |
| 28 | + |
| 29 | +|badge1| |badge2| |badge3| |badge4| |badge5| |
| 30 | + |
| 31 | +This module extends ``base_external_dbsource``, allowing you to connect |
| 32 | +to foreign MySQL databases using SQLAlchemy. |
| 33 | + |
| 34 | +**Table of contents** |
| 35 | + |
| 36 | +.. contents:: |
| 37 | + :local: |
| 38 | + |
| 39 | +Installation |
| 40 | +============ |
| 41 | + |
| 42 | +To install this module, you need to: |
| 43 | + |
| 44 | +- Install ``libmysqlclient-dev`` package |
| 45 | + (``default-libmysqlclient-dev`` on Debian) |
| 46 | +- Install ``sqlalchemy`` and ``mysqlclient`` python libraries |
| 47 | + |
| 48 | +Configuration |
| 49 | +============= |
| 50 | + |
| 51 | +To configure this module, you need to: |
| 52 | + |
| 53 | +1. Database sources can be configured in Settings > Technical > Database |
| 54 | + Structure > Database sources. |
| 55 | + |
| 56 | +Usage |
| 57 | +===== |
| 58 | + |
| 59 | +To use this module: |
| 60 | + |
| 61 | +- Go to Settings > Technical > Database Structure > Database Sources |
| 62 | +- Click on Create to enter the following information: |
| 63 | +- Datasource name?? |
| 64 | +- Pasword |
| 65 | +- Connector: Choose the database to which you want to connect |
| 66 | +- Connection string: Specify how to connect to database |
| 67 | + |
| 68 | +Known issues / Roadmap |
| 69 | +====================== |
| 70 | + |
| 71 | +- Add X.509 authentication |
| 72 | + |
| 73 | +Bug Tracker |
| 74 | +=========== |
| 75 | + |
| 76 | +Bugs are tracked on `GitHub Issues <https://github.com/OCA/server-backend/issues>`_. |
| 77 | +In case of trouble, please check there if your issue has already been reported. |
| 78 | +If you spotted it first, help us to smash it by providing a detailed and welcomed |
| 79 | +`feedback <https://github.com/OCA/server-backend/issues/new?body=module:%20base_external_dbsource_mysql%0Aversion:%2017.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_. |
| 80 | + |
| 81 | +Do not contact contributors directly about support or help with technical issues. |
| 82 | + |
| 83 | +Credits |
| 84 | +======= |
| 85 | + |
| 86 | +Authors |
| 87 | +------- |
| 88 | + |
| 89 | +* Daniel Reis |
| 90 | +* LasLabs |
| 91 | + |
| 92 | +Contributors |
| 93 | +------------ |
| 94 | + |
| 95 | + |
| 96 | + |
| 97 | +- Maxime Chambreuil < [email protected]> |
| 98 | + |
| 99 | +- Gervais Naoussi < [email protected]> |
| 100 | + |
| 101 | + |
| 102 | + |
| 103 | +- `Tecnativa <https://www.tecnativa.com>`__: |
| 104 | + |
| 105 | + - Sergio Teruel |
| 106 | + |
| 107 | +- David Alonso < [email protected]> |
| 108 | + |
| 109 | +Maintainers |
| 110 | +----------- |
| 111 | + |
| 112 | +This module is maintained by the OCA. |
| 113 | + |
| 114 | +.. image:: https://odoo-community.org/logo.png |
| 115 | + :alt: Odoo Community Association |
| 116 | + :target: https://odoo-community.org |
| 117 | + |
| 118 | +OCA, or the Odoo Community Association, is a nonprofit organization whose |
| 119 | +mission is to support the collaborative development of Odoo features and |
| 120 | +promote its widespread use. |
| 121 | + |
| 122 | +This module is part of the `OCA/server-backend <https://github.com/OCA/server-backend/tree/17.0/base_external_dbsource_mysql>`_ project on GitHub. |
| 123 | + |
| 124 | +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. |
0 commit comments