couchbase-sqlalchemy


Namecouchbase-sqlalchemy JSON
Version 1.0.2 PyPI version JSON
download
home_pageNone
SummaryA SQLAlchemy dialect for Couchbase Analytics/Columnar.
upload_time2025-02-10 05:28:46
maintainerNone
docs_urlNone
authorAyush Tripathi
requires_pythonNone
licenseApache-2.0
keywords couchbase db database cloud analytics columnar
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            Couchbase SQLAlchemy
=====================

Couchbase dialect for SQLAlchemy to `Couchbase Analytics/Columnar <https://docs.couchbase.com/server/current/learn/services-and-indexes/services/analytics-service.html/>`_.
A Python client library for Couchbase Analytics, `couchbase-sqlalchemy` provides a comprehensive DB-API and SQLAlchemy dialect implementation for Couchbase.

.. image:: https://img.shields.io/pypi/v/couchbase-sqlalchemy.svg
    :target: https://pypi.python.org/pypi/couchbase-sqlalchemy/

.. image:: https://img.shields.io/:license-Apache%202-brightgreen.svg
    :target: http://www.apache.org/licenses/LICENSE-2.0.txt


Installing Couchbase SQLAlchemy
===============================

The Couchbase SQLAlchemy package can be installed from the public PyPI repository using pip:

    .. code-block:: shell

        pip install --upgrade couchbase-sqlalchemy

Run a Simple query
==================

1.Creatge a file (e.g. test.py) that contains the following Python sample code, which connects to Couchbase Analytics and displays a simple locate function query:

    .. code-block:: python

        import urllib.parse
        from sqlalchemy import create_engine
        # Define the Couchbase connection string (replace with your details)
        URL = 'couchbase://<username>:<password>@<host>:<port>?ssl=false'
        # Create the engine for Couchbase using the Couchbase SQLAlchemy dialect
        engine = create_engine(COUCHBASE_URL)
        query_result = engine.execute("select locate('something','there is something good');")
        result = query_result.fetchall()
        print(result)

2. Replace <your_user_login_name>, <your_password>, and <host> and <port> with the appropriate values for your Couchbase account and user.

3. Execute the sample code. For example, if you created a file named test.py:

    .. code-block:: shell

        python test.py


License
=======

Couchbase SQLAlchemy is distributed under the `Apache 2.0
<https://www.apache.org/licenses/LICENSE-2.0>`_.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "couchbase-sqlalchemy",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "Couchbase db database cloud analytics Columnar",
    "author": "Ayush Tripathi",
    "author_email": "ayush.tripathi@couchbase.com",
    "download_url": "https://files.pythonhosted.org/packages/1c/3b/fff3ee12d17f51fd53976c879e8ee7c4088ec6ee4a2cc53d0f25f198d029/couchbase-sqlalchemy-1.0.2.tar.gz",
    "platform": null,
    "description": "Couchbase SQLAlchemy\n=====================\n\nCouchbase dialect for SQLAlchemy to `Couchbase Analytics/Columnar <https://docs.couchbase.com/server/current/learn/services-and-indexes/services/analytics-service.html/>`_.\nA Python client library for Couchbase Analytics, `couchbase-sqlalchemy` provides a comprehensive DB-API and SQLAlchemy dialect implementation for Couchbase.\n\n.. image:: https://img.shields.io/pypi/v/couchbase-sqlalchemy.svg\n    :target: https://pypi.python.org/pypi/couchbase-sqlalchemy/\n\n.. image:: https://img.shields.io/:license-Apache%202-brightgreen.svg\n    :target: http://www.apache.org/licenses/LICENSE-2.0.txt\n\n\nInstalling Couchbase SQLAlchemy\n===============================\n\nThe Couchbase SQLAlchemy package can be installed from the public PyPI repository using pip:\n\n    .. code-block:: shell\n\n        pip install --upgrade couchbase-sqlalchemy\n\nRun a Simple query\n==================\n\n1.Creatge a file (e.g. test.py) that contains the following Python sample code, which connects to Couchbase Analytics and displays a simple locate function query:\n\n    .. code-block:: python\n\n        import urllib.parse\n        from sqlalchemy import create_engine\n        # Define the Couchbase connection string (replace with your details)\n        URL = 'couchbase://<username>:<password>@<host>:<port>?ssl=false'\n        # Create the engine for Couchbase using the Couchbase SQLAlchemy dialect\n        engine = create_engine(COUCHBASE_URL)\n        query_result = engine.execute(\"select locate('something','there is something good');\")\n        result = query_result.fetchall()\n        print(result)\n\n2. Replace <your_user_login_name>, <your_password>, and <host> and <port> with the appropriate values for your Couchbase account and user.\n\n3. Execute the sample code. For example, if you created a file named test.py:\n\n    .. code-block:: shell\n\n        python test.py\n\n\nLicense\n=======\n\nCouchbase SQLAlchemy is distributed under the `Apache 2.0\n<https://www.apache.org/licenses/LICENSE-2.0>`_.\n",
    "bugtrack_url": null,
    "license": "Apache-2.0",
    "summary": "A SQLAlchemy dialect for Couchbase Analytics/Columnar.",
    "version": "1.0.2",
    "project_urls": null,
    "split_keywords": [
        "couchbase",
        "db",
        "database",
        "cloud",
        "analytics",
        "columnar"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "b877ee6b43d09e23919aecf544d18a4c02a2287e59b917bb368b77e9745fc996",
                "md5": "5ce11ebf689ce5f0726b50b0d284da9e",
                "sha256": "ec893a17087b978fd61a2ca65de6c5aa6d0185ad954fc23bd6e34e06bc9fa633"
            },
            "downloads": -1,
            "filename": "couchbase_sqlalchemy-1.0.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "5ce11ebf689ce5f0726b50b0d284da9e",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 12671,
            "upload_time": "2025-02-10T05:28:45",
            "upload_time_iso_8601": "2025-02-10T05:28:45.511210Z",
            "url": "https://files.pythonhosted.org/packages/b8/77/ee6b43d09e23919aecf544d18a4c02a2287e59b917bb368b77e9745fc996/couchbase_sqlalchemy-1.0.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "1c3bfff3ee12d17f51fd53976c879e8ee7c4088ec6ee4a2cc53d0f25f198d029",
                "md5": "86a6e5c75ce7a5463fcac5ebf1838669",
                "sha256": "111e420c5cd559ed3909ef02d72dd2fa5e7ab088efb0b328135d5f0fbac7c79b"
            },
            "downloads": -1,
            "filename": "couchbase-sqlalchemy-1.0.2.tar.gz",
            "has_sig": false,
            "md5_digest": "86a6e5c75ce7a5463fcac5ebf1838669",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 12089,
            "upload_time": "2025-02-10T05:28:46",
            "upload_time_iso_8601": "2025-02-10T05:28:46.947081Z",
            "url": "https://files.pythonhosted.org/packages/1c/3b/fff3ee12d17f51fd53976c879e8ee7c4088ec6ee4a2cc53d0f25f198d029/couchbase-sqlalchemy-1.0.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-02-10 05:28:46",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "couchbase-sqlalchemy"
}
        
Elapsed time: 0.42301s