denodo-sqlalchemy


Namedenodo-sqlalchemy JSON
Version 2.0.0 PyPI version JSON
download
home_pageNone
SummaryDenodo Dialect for SQLAlchemy
upload_time2025-01-28 20:38:10
maintainerNone
docs_urlNone
authorNone
requires_python>=3.9
licenseThis is the MIT license: http://www.opensource.org/licenses/mit-license.php Copyright (c) 2022-2025 denodo (https://www.denodo.com) Copyright (c) 2005-2025 the SQLAlchemy authors and contributors <see AUTHORS file>. SQLAlchemy is a trademark of Michael Bayer. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords sqlalchemy denodo database data data analysis data science
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            `Denodo Dialect for SQLAlchemy`
********************************************************************************

This package includes the Denodo Dialect for SQLAlchemy, which offers an easy way to connect to Denodo databases from SQLAlchemy https://www.sqlalchemy.org/

Denodo documentation and software resources are available at https://community.denodo.com

This dialect supports SQLAlchemy v2.0 and Denodo 8.0 and higher.

Pre-requisites
================================================================================

Python 3.9 or newer is needed.

This dialect requires the following Python modules:
   * SQLAlchemy 2.0.x
   * psycopg2 version 2.9 or higher.

This Python modules are also optional dependencies in order to use Denodo Virtual DataPort's (optional) Flight SQL interface:
   * flightsql
     * adbc-driver-flightsql version 1.3.0 or higher
     * pyarrow version 18.1.0 or higher
 
Required dependencies will be installed automatically, in order to install dependencies for Flight SQL the `flightsql` extras package needs to be installed:

    .. code-block::
        
       pip install denodo-sqlalchemy[flightsql]


Alternatively, dependency packages can be installed manually:

    .. code-block::

        pip install sqlalchemy~=2.0.0
        pip install psycopg2-binary>=2.9
        pip install adbc-driver-flightsql~=1.4.0
        pip install pyarrow~=19.0.0


Important: note also that psycopg2 has its own requirements for installation which need to be satisfied: https://www.psycopg.org/docs/install.html#prerequisites

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

The Denodo SQLAlchemy package can be installed from the public PyPI repository using :code:`pip`:

    .. code-block::

        pip install --upgrade denodo-sqlalchemy
        or
        pip install --upgrade denodo-sqlalchemy[flightsql]

:code:`pip` automatically installs all required modules.

Usage
================================================================================

To connect to Denodo VDP Server with SQLAlchemy, the following URL pattern can be used:

    .. code-block::

        denodo://<username>:<password>@<host>:<port[9996]>/<database>

This will create a connection using the default driver `psycopg2`, so it is equivalent to:

    .. code-block::

        denodo+psycopg2://<username>:<password>@<host>:<port[9996]>/<database>

In order to create a connection using Flight SQL, you would need: 

    .. code-block::

        denodo+flightsql://<username>:<password>@<host>:<port[9994]>/<database>

Please note that Flight SQL connections assume SSL is enabled at the server. If not, you would need to add the `use_encryption` parameter set to `False`, like:

    .. code-block::

        engine = sqlalchemy.create_engine("denodo+flightsql://someuser:somepwd@someserver:9994/somedb", connect_args={"use_encryption":"false"})

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "denodo-sqlalchemy",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": "sqlalchemy, denodo, database, data, data analysis, data science",
    "author": null,
    "author_email": "Denodo Research Labs <research.labs@denodo.com>",
    "download_url": "https://files.pythonhosted.org/packages/48/2d/e37eec34fdff4e2d73120a31a59d922ec60814486d816df1a7a632d54d1c/denodo_sqlalchemy-2.0.0.tar.gz",
    "platform": null,
    "description": "`Denodo Dialect for SQLAlchemy`\r\n********************************************************************************\r\n\r\nThis package includes the Denodo Dialect for SQLAlchemy, which offers an easy way to connect to Denodo databases from SQLAlchemy https://www.sqlalchemy.org/\r\n\r\nDenodo documentation and software resources are available at https://community.denodo.com\r\n\r\nThis dialect supports SQLAlchemy v2.0 and Denodo 8.0 and higher.\r\n\r\nPre-requisites\r\n================================================================================\r\n\r\nPython 3.9 or newer is needed.\r\n\r\nThis dialect requires the following Python modules:\r\n   * SQLAlchemy 2.0.x\r\n   * psycopg2 version 2.9 or higher.\r\n\r\nThis Python modules are also optional dependencies in order to use Denodo Virtual DataPort's (optional) Flight SQL interface:\r\n   * flightsql\r\n     * adbc-driver-flightsql version 1.3.0 or higher\r\n     * pyarrow version 18.1.0 or higher\r\n \r\nRequired dependencies will be installed automatically, in order to install dependencies for Flight SQL the `flightsql` extras package needs to be installed:\r\n\r\n    .. code-block::\r\n        \r\n       pip install denodo-sqlalchemy[flightsql]\r\n\r\n\r\nAlternatively, dependency packages can be installed manually:\r\n\r\n    .. code-block::\r\n\r\n        pip install sqlalchemy~=2.0.0\r\n        pip install psycopg2-binary>=2.9\r\n        pip install adbc-driver-flightsql~=1.4.0\r\n        pip install pyarrow~=19.0.0\r\n\r\n\r\nImportant: note also that psycopg2 has its own requirements for installation which need to be satisfied: https://www.psycopg.org/docs/install.html#prerequisites\r\n\r\nInstallation\r\n================================================================================\r\n\r\nThe Denodo SQLAlchemy package can be installed from the public PyPI repository using :code:`pip`:\r\n\r\n    .. code-block::\r\n\r\n        pip install --upgrade denodo-sqlalchemy\r\n        or\r\n        pip install --upgrade denodo-sqlalchemy[flightsql]\r\n\r\n:code:`pip` automatically installs all required modules.\r\n\r\nUsage\r\n================================================================================\r\n\r\nTo connect to Denodo VDP Server with SQLAlchemy, the following URL pattern can be used:\r\n\r\n    .. code-block::\r\n\r\n        denodo://<username>:<password>@<host>:<port[9996]>/<database>\r\n\r\nThis will create a connection using the default driver `psycopg2`, so it is equivalent to:\r\n\r\n    .. code-block::\r\n\r\n        denodo+psycopg2://<username>:<password>@<host>:<port[9996]>/<database>\r\n\r\nIn order to create a connection using Flight SQL, you would need: \r\n\r\n    .. code-block::\r\n\r\n        denodo+flightsql://<username>:<password>@<host>:<port[9994]>/<database>\r\n\r\nPlease note that Flight SQL connections assume SSL is enabled at the server. If not, you would need to add the `use_encryption` parameter set to `False`, like:\r\n\r\n    .. code-block::\r\n\r\n        engine = sqlalchemy.create_engine(\"denodo+flightsql://someuser:somepwd@someserver:9994/somedb\", connect_args={\"use_encryption\":\"false\"})\r\n",
    "bugtrack_url": null,
    "license": "This is the MIT license: http://www.opensource.org/licenses/mit-license.php\r\n        \r\n        Copyright (c) 2022-2025 denodo (https://www.denodo.com)\r\n        \r\n        Copyright (c) 2005-2025 the SQLAlchemy authors and contributors <see AUTHORS file>.\r\n        SQLAlchemy is a trademark of Michael Bayer.\r\n        \r\n        Permission is hereby granted, free of charge, to any person obtaining a copy of this\r\n        software and associated documentation files (the \"Software\"), to deal in the Software\r\n        without restriction, including without limitation the rights to use, copy, modify, merge,\r\n        publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons\r\n        to whom the Software is furnished to do so, subject to the following conditions:\r\n        \r\n        The above copyright notice and this permission notice shall be included in all copies or\r\n        substantial portions of the Software.\r\n        \r\n        THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,\r\n        INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR\r\n        PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE\r\n        FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR\r\n        OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER\r\n        DEALINGS IN THE SOFTWARE.\r\n        ",
    "summary": "Denodo Dialect for SQLAlchemy",
    "version": "2.0.0",
    "project_urls": null,
    "split_keywords": [
        "sqlalchemy",
        " denodo",
        " database",
        " data",
        " data analysis",
        " data science"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "bd6309886a7bcb158d4f31d449cac1969ec586a5ae4eece14e074b286c19d4d0",
                "md5": "763ca3dcd6adcbe57828c254f6fa289a",
                "sha256": "269a9d40374e31ee077a677f0c443c8ee914a8f5e3614d5443f32a4afc4b72e9"
            },
            "downloads": -1,
            "filename": "denodo_sqlalchemy-2.0.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "763ca3dcd6adcbe57828c254f6fa289a",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 41177,
            "upload_time": "2025-01-28T20:38:09",
            "upload_time_iso_8601": "2025-01-28T20:38:09.060637Z",
            "url": "https://files.pythonhosted.org/packages/bd/63/09886a7bcb158d4f31d449cac1969ec586a5ae4eece14e074b286c19d4d0/denodo_sqlalchemy-2.0.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "482de37eec34fdff4e2d73120a31a59d922ec60814486d816df1a7a632d54d1c",
                "md5": "9f368a382694d64ec7e3e149e223915f",
                "sha256": "8a2d547d06519ba3f7921080f6779d1a588355b4e7c7495734c6c591ebff044f"
            },
            "downloads": -1,
            "filename": "denodo_sqlalchemy-2.0.0.tar.gz",
            "has_sig": false,
            "md5_digest": "9f368a382694d64ec7e3e149e223915f",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 28254,
            "upload_time": "2025-01-28T20:38:10",
            "upload_time_iso_8601": "2025-01-28T20:38:10.213311Z",
            "url": "https://files.pythonhosted.org/packages/48/2d/e37eec34fdff4e2d73120a31a59d922ec60814486d816df1a7a632d54d1c/denodo_sqlalchemy-2.0.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-01-28 20:38:10",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "denodo-sqlalchemy"
}
        
Elapsed time: 3.01823s