From 7ca62f57cd481feb2a3424e621174c1f4c249f17 Mon Sep 17 00:00:00 2001 From: OCA Git Bot Date: Fri, 29 Jun 2018 05:28:29 +0200 Subject: [PATCH] [UPD] README.rst --- base_external_dbsource/README.rst | 116 ++++- .../static/description/index.html | 465 ++++++++++++++++++ 2 files changed, 580 insertions(+), 1 deletion(-) create mode 100644 base_external_dbsource/static/description/index.html diff --git a/base_external_dbsource/README.rst b/base_external_dbsource/README.rst index 3f626252..f2b01e67 100644 --- a/base_external_dbsource/README.rst +++ b/base_external_dbsource/README.rst @@ -1 +1,115 @@ -**This file is going to be generated by oca-gen-addon-readme.** +========================= +External Database Sources +========================= + +.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! This file is generated by oca-gen-addon-readme !! + !! changes will be overwritten. !! + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png + :target: https://odoo-community.org/page/development-status + :alt: Beta +.. |badge2| image:: https://img.shields.io/badge/licence-LGPL--3-blue.png + :target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html + :alt: License: LGPL-3 +.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--backend-lightgray.png?logo=github + :target: https://github.com/OCA/server-backend/tree/11.0/base_external_dbsource + :alt: OCA/server-backend +.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png + :target: https://translation.odoo-community.org/projects/server-backend-11-0/server-backend-11-0-base_external_dbsource + :alt: Translate me on Weblate +.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png + :target: https://runbot.odoo-community.org/runbot/253/11.0 + :alt: Try me on Runbot + +|badge1| |badge2| |badge3| |badge4| |badge5| + +This module allows you to define connections to foreign databases using ODBC, +Firebird, Oracle Client or SQLAlchemy. + +**Table of contents** + +.. contents:: + :local: + +Installation +============ + +No installation required. + +Configuration +============= + +To configure this module, you need to: + +#. Database sources can be configured in Settings > Technical > + Database Structure > Data sources. + +Usage +===== + +* Go to Settings > Technical > Database Structure > Database Sources +* Click on Create to enter the following information: + +* Data source name  +* Password +* Connector: Choose the database to which you want to connect +* Connection string: Specify how to connect to database + +Known issues / Roadmap +====================== + +* Find a way to remove or default the CA certs dir +* Add concept of multiple connection strings for one source (multiple nodes) +* Add a ConnectionEnvironment that allows for the reuse of connections +* Message box should be displayed instead of error in ``connection_test`` +* Remove old api compatibility layers (v11) +* Instead of returning list of results, we should return iterators. This will + support larger datasets in a more efficient manner. +* Implement better CRUD handling + +Bug Tracker +=========== + +Bugs are tracked on `GitHub Issues `_. +In case of trouble, please check there if your issue has already been reported. +If you spotted it first, help us smashing it by providing a detailed and welcomed +`feedback `_. + +Do not contact contributors directly about support or help with technical issues. + +Credits +======= + +Authors +~~~~~~~ + +* Daniel Reis +* LasLabs + +Contributors +~~~~~~~~~~~~ + +* Daniel Reis +* Maxime Chambreuil +* Gervais Naoussi +* Dave Lasley +* Sergio Teruel (https://wwww.tecnativa.com) + +Maintainers +~~~~~~~~~~~ + +This module is maintained by the OCA. + +.. image:: https://odoo-community.org/logo.png + :alt: Odoo Community Association + :target: https://odoo-community.org + +OCA, or the Odoo Community Association, is a nonprofit organization whose +mission is to support the collaborative development of Odoo features and +promote its widespread use. + +This module is part of the `OCA/server-backend `_ project on GitHub. + +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/base_external_dbsource/static/description/index.html b/base_external_dbsource/static/description/index.html new file mode 100644 index 00000000..119b31a4 --- /dev/null +++ b/base_external_dbsource/static/description/index.html @@ -0,0 +1,465 @@ + + + + + + +External Database Sources + + + +
+

External Database Sources

+ + +

Beta License: LGPL-3 OCA/server-backend Translate me on Weblate Try me on Runbot

+

This module allows you to define connections to foreign databases using ODBC, +Firebird, Oracle Client or SQLAlchemy.

+

Table of contents

+ +
+

Installation

+

No installation required.

+
+
+

Configuration

+

To configure this module, you need to:

+
    +
  1. Database sources can be configured in Settings > Technical > +Database Structure > Data sources.
    2. +
+
+
+

Usage

+
    +
  • Go to Settings > Technical > Database Structure > Database Sources
    • +
  • Click on Create to enter the following information:
    • +
  • Data source name
    • +
  • Password
    • +
  • Connector: Choose the database to which you want to connect
    • +
  • Connection string: Specify how to connect to database
    • +
+
+
+

Known issues / Roadmap

+
    +
  • Find a way to remove or default the CA certs dir
    • +
  • Add concept of multiple connection strings for one source (multiple nodes)
    • +
  • Add a ConnectionEnvironment that allows for the reuse of connections
    • +
  • Message box should be displayed instead of error in connection_test
    • +
  • Remove old api compatibility layers (v11)
    • +
  • Instead of returning list of results, we should return iterators. This will +support larger datasets in a more efficient manner.
    • +
  • Implement better CRUD handling
    • +
+
+
+

Bug Tracker

+

Bugs are tracked on GitHub Issues. +In case of trouble, please check there if your issue has already been reported. +If you spotted it first, help us smashing it by providing a detailed and welcomed +feedback.

+

Do not contact contributors directly about support or help with technical issues.

+
+
+

Credits

+
+

Authors

+
    +
  • Daniel Reis
    • +
  • LasLabs
    • +
+
+ +
+

Maintainers

+

This module is maintained by the OCA.

+Odoo Community Association +

OCA, or the Odoo Community Association, is a nonprofit organization whose +mission is to support the collaborative development of Odoo features and +promote its widespread use.

+

This module is part of the OCA/server-backend project on GitHub.

+

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

+
+
+
+ +