Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[16.0] MIG base_external_dbsource_firebird #290

Open
wants to merge 10 commits into
base: 16.0
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
78 changes: 78 additions & 0 deletions base_external_dbsource_firebird/README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
.. image:: https://img.shields.io/badge/licence-LGPL--3-blue.svg
:target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html
:alt: License: LGPL-3

===================================
External Database Source - Firebird
===================================

This module extends ``base_external_dbsource``, allowing you to connect to
foreign Firebird databases.

Installation
============

* Install ``fdb`` python library

Configuration
=============

Database sources can be configured in Settings > Configuration -> Data sources.


Usage
=====

To use this module:

* Go to Settings > 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

.. image:: https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas
:alt: Try me on Runbot
:target: https://runbot.odoo-community.org/runbot/149/10.0 for server-tools

Known issues / Roadmap
======================

* Setting ``metadata`` to ``True`` in ``execute_fdb`` will do nothing.
* ``execute`` is susceptible to SQL injection.

Bug Tracker
===========

Bugs are tracked on `GitHub Issues <https://github.com/OCA/server-tools/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.

Credits
=======

Contributors
------------

* Daniel Reis <[email protected]>
* Maxime Chambreuil <[email protected]>
* Gervais Naoussi <[email protected]>
* Michell Stuttgart <[email protected]>
* Dave Lasley <[email protected]>

Maintainer
----------

.. image:: https://odoo-community.org/logo.png
:alt: Odoo Community Association
:target: https://odoo-community.org

This module is maintained by the OCA.

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.

To contribute to this module, please visit http://odoo-community.org.
2 changes: 2 additions & 0 deletions base_external_dbsource_firebird/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# -*- coding: utf-8 -*-
from . import models
24 changes: 24 additions & 0 deletions base_external_dbsource_firebird/__manifest__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# -*- coding: utf-8 -*-
# Copyright <2011> <Daniel Reis, Maxime Chambreuil, Savoir-faire Linux>
# Copyright 2016 LasLabs Inc.
# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl).
{
'name': 'External Database Source - Firebird',
'version': "16.0.1.0.1",
'category': 'Tools',
'author': "Daniel Reis, "
"LasLabs, "
"Odoo Community Association (OCA)",
'website': 'https://github.com/OCA/server-tools',
'license': 'LGPL-3',
"external_dependencies": {"python": ["fdb", "polars"]},
'depends': [
'base_external_dbsource',
],

'demo': [
'demo/base_external_dbsource.xml',
],
'installable': True,
'auto_install': True, # Remove this key for v11
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<?xml version="1.0"?>
<odoo>
<record model="base.external.dbsource" id="demo_firebird">
<field name="name">Firebird Demo</field>
<field name="conn_string">User=firebird;Database=SampleDatabase.fdb;DataSource=localhost;Port=3050;Dialect=3;Charset=NONE;Role=;Connection lifetime=15;Pooling=true;MinPoolSize=0;MaxPoolSize=50;Packet Size=8192;ServerType=0;</field>
<field name="password">password</field>
<field name="connector">fdb</field>
</record>
</odoo>
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Translation of Odoo Server.
# This file contains the translation of the following modules:
# * base_external_dbsource_firebird
#
msgid ""
msgstr ""
"Project-Id-Version: Odoo Server 10.0\n"
"Report-Msgid-Bugs-To: \n"
"Last-Translator: <>\n"
"Language-Team: \n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: \n"
"Plural-Forms: \n"

#. module: base_external_dbsource_firebird
#: model:ir.model,name:base_external_dbsource_firebird.model_base_external_dbsource
msgid "External Database Sources"
msgstr ""

24 changes: 24 additions & 0 deletions base_external_dbsource_firebird/i18n/de.po
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Translation of Odoo Server.
# This file contains the translation of the following modules:
# * base_external_dbsource_firebird
#
# Translators:
# Rudolf Schnapka <[email protected]>, 2017
msgid ""
msgstr ""
"Project-Id-Version: Odoo Server 10.0\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2017-05-10 00:47+0000\n"
"PO-Revision-Date: 2017-05-10 00:47+0000\n"
"Last-Translator: Rudolf Schnapka <[email protected]>, 2017\n"
"Language-Team: German (https://www.transifex.com/oca/teams/23907/de/)\n"
"Language: de\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: \n"
"Plural-Forms: nplurals=2; plural=(n != 1);\n"

#. module: base_external_dbsource_firebird
#: model:ir.model,name:base_external_dbsource_firebird.model_base_external_dbsource
msgid "External Database Sources"
msgstr "Externe Datenbankquellen"
24 changes: 24 additions & 0 deletions base_external_dbsource_firebird/i18n/es.po
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Translation of Odoo Server.
# This file contains the translation of the following modules:
# * base_external_dbsource_firebird
#
# Translators:
# Fernando Lara <[email protected]>, 2017
msgid ""
msgstr ""
"Project-Id-Version: Odoo Server 10.0\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2017-02-22 00:54+0000\n"
"PO-Revision-Date: 2017-02-22 00:54+0000\n"
"Last-Translator: Fernando Lara <[email protected]>, 2017\n"
"Language-Team: Spanish (https://www.transifex.com/oca/teams/23907/es/)\n"
"Language: es\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: \n"
"Plural-Forms: nplurals=2; plural=(n != 1);\n"

#. module: base_external_dbsource_firebird
#: model:ir.model,name:base_external_dbsource_firebird.model_base_external_dbsource
msgid "External Database Sources"
msgstr "Fuentes externas de la base de datos"
25 changes: 25 additions & 0 deletions base_external_dbsource_firebird/i18n/hr.po
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Translation of Odoo Server.
# This file contains the translation of the following modules:
# * base_external_dbsource_firebird
#
# Translators:
# Bole <[email protected]>, 2017
msgid ""
msgstr ""
"Project-Id-Version: Odoo Server 10.0\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2017-05-10 00:47+0000\n"
"PO-Revision-Date: 2017-05-10 00:47+0000\n"
"Last-Translator: Bole <[email protected]>, 2017\n"
"Language-Team: Croatian (https://www.transifex.com/oca/teams/23907/hr/)\n"
"Language: hr\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: \n"
"Plural-Forms: nplurals=3; plural=n%10==1 && n%100!=11 ? 0 : n%10>=2 && n"
"%10<=4 && (n%100<10 || n%100>=20) ? 1 : 2;\n"

#. module: base_external_dbsource_firebird
#: model:ir.model,name:base_external_dbsource_firebird.model_base_external_dbsource
msgid "External Database Sources"
msgstr "Vanjske baze"
25 changes: 25 additions & 0 deletions base_external_dbsource_firebird/i18n/nl_NL.po
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Translation of Odoo Server.
# This file contains the translation of the following modules:
# * base_external_dbsource_firebird
#
# Translators:
# Peter Hageman <[email protected]>, 2017
msgid ""
msgstr ""
"Project-Id-Version: Odoo Server 10.0\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2017-06-22 01:11+0000\n"
"PO-Revision-Date: 2017-06-22 01:11+0000\n"
"Last-Translator: Peter Hageman <[email protected]>, 2017\n"
"Language-Team: Dutch (Netherlands) (https://www.transifex.com/oca/"
"teams/23907/nl_NL/)\n"
"Language: nl_NL\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: \n"
"Plural-Forms: nplurals=2; plural=(n != 1);\n"

#. module: base_external_dbsource_firebird
#: model:ir.model,name:base_external_dbsource_firebird.model_base_external_dbsource
msgid "External Database Sources"
msgstr "Externe databasebronnen"
25 changes: 25 additions & 0 deletions base_external_dbsource_firebird/i18n/pt_BR.po
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Translation of Odoo Server.
# This file contains the translation of the following modules:
# * base_external_dbsource_firebird
#
# Translators:
# OCA Transbot <[email protected]>, 2017
msgid ""
msgstr ""
"Project-Id-Version: Odoo Server 10.0\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2017-01-21 04:22+0000\n"
"PO-Revision-Date: 2017-01-21 04:22+0000\n"
"Last-Translator: OCA Transbot <[email protected]>, 2017\n"
"Language-Team: Portuguese (Brazil) (https://www.transifex.com/oca/"
"teams/23907/pt_BR/)\n"
"Language: pt_BR\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: \n"
"Plural-Forms: nplurals=2; plural=(n > 1);\n"

#. module: base_external_dbsource_firebird
#: model:ir.model,name:base_external_dbsource_firebird.model_base_external_dbsource
msgid "External Database Sources"
msgstr "Fontes Banco de Dados Externo"
25 changes: 25 additions & 0 deletions base_external_dbsource_firebird/i18n/sl.po
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Translation of Odoo Server.
# This file contains the translation of the following modules:
# * base_external_dbsource_firebird
#
# Translators:
# OCA Transbot <[email protected]>, 2017
msgid ""
msgstr ""
"Project-Id-Version: Odoo Server 10.0\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2017-01-21 04:22+0000\n"
"PO-Revision-Date: 2017-01-21 04:22+0000\n"
"Last-Translator: OCA Transbot <[email protected]>, 2017\n"
"Language-Team: Slovenian (https://www.transifex.com/oca/teams/23907/sl/)\n"
"Language: sl\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: \n"
"Plural-Forms: nplurals=4; plural=(n%100==1 ? 0 : n%100==2 ? 1 : n%100==3 || n"
"%100==4 ? 2 : 3);\n"

#. module: base_external_dbsource_firebird
#: model:ir.model,name:base_external_dbsource_firebird.model_base_external_dbsource
msgid "External Database Sources"
msgstr "Viri zunanjih podatkovnih baz"
24 changes: 24 additions & 0 deletions base_external_dbsource_firebird/i18n/tr.po
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Translation of Odoo Server.
# This file contains the translation of the following modules:
# * base_external_dbsource_firebird
#
# Translators:
# OCA Transbot <[email protected]>, 2017
msgid ""
msgstr ""
"Project-Id-Version: Odoo Server 10.0\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2017-01-21 04:22+0000\n"
"PO-Revision-Date: 2017-01-21 04:22+0000\n"
"Last-Translator: OCA Transbot <[email protected]>, 2017\n"
"Language-Team: Turkish (https://www.transifex.com/oca/teams/23907/tr/)\n"
"Language: tr\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: \n"
"Plural-Forms: nplurals=2; plural=(n > 1);\n"

#. module: base_external_dbsource_firebird
#: model:ir.model,name:base_external_dbsource_firebird.model_base_external_dbsource
msgid "External Database Sources"
msgstr "Dış veritabanı kaynakları"
3 changes: 3 additions & 0 deletions base_external_dbsource_firebird/models/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# -*- coding: utf-8 -*-

from . import base_external_dbsource
68 changes: 68 additions & 0 deletions base_external_dbsource_firebird/models/base_external_dbsource.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
# -*- coding: utf-8 -*-
# Copyright 2011 Daniel Reis
# Copyright 2016 LasLabs Inc.
# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl.html).

import logging

from odoo import api
from odoo import models


_logger = logging.getLogger(__name__)

try:
from odoo.addons.base_external_dbsource.models import (
base_external_dbsource,
)
CONNECTORS = base_external_dbsource.BaseExternalDbsource.CONNECTORS
try:
import fdb
CONNECTORS.append(('fdb', 'Firebird'))
import polars as pl
except ImportError:
_logger.info('Firebird library not available. Please install "fdb and/or polars" '
'python package.')
except ImportError:
_logger.info('base_external_dbsource Odoo module not found.')


class BaseExternalDbsource(models.Model):
""" It provides logic for connection to a Firebird data source. """

_inherit = "base.external.dbsource"

PWD_STRING_FDB = 'Password=%s;'

def connection_close_fdb(self, connection):
self.ensure_one()
return connection.close()

def connection_open_fdb(self):
self.ensure_one()

kwargs = {}
for option in self.conn_string_full.split(';'):
try:
key, value = option.split('=')
except ValueError:
continue
if key.lower() == "port":
kwargs[key.lower()] = int(value)
else:
kwargs[key.lower()] = value
return fdb.connect(**kwargs)

def execute_fdb(self, sqlquery, sqlparams):
self.ensure_one()

with self.connection_open_fdb() as conn:
cur = conn.cursor()
cur.execute(sqlquery % sqlparams)
rows = cur.fetchall()
columns = [desc[0] for desc in cur.description]

# Create a DataFrame from the rows and columns using Polars
df = pl.DataFrame(rows, schema=columns)

return df
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions base_external_dbsource_firebird/tests/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# -*- encoding: utf-8 -*-

from . import test_base_external_dbsource
Loading
Loading