**********************************
SQLAlchemy Dialect for SQream DB
**********************************
Requirements
=====================
* Python > 3.9.
* SQLAlchemy == 1.3.18
* SQream Blue DB-API Connector >= 1.0.42
Installation
=====================
Install from the PyPi repository using `pip`:
.. code-block:: bash
pip3.9 install --upgrade pysqream_blue_sqlalchemy
Usage
===============================
Integrating with SQLAlchemy
----------------------------
.. code-block:: python
import sqlalchemy as sa
_access_token = "ACCESS TOKEN"
conn_str = f"sqream_blue://domain:443/database"
connect_args = {'access_token': _access_token}
engine = sa.create_engine(conn_string, connect_args=connect_args)
conn = engine.connect()
res = conn.execute("select 'Success' as Test").fetchall()
print(res)
Integrating with the IPython/Jupyter SQL Magic
-----------------------------------------------
.. code-block:: python
%load_ext sql
%config SqlMagic.autocommit=False
%config SqlMagic.displaycon=False
%config SqlMagic.autopandas=True
%sql sqream_blue://product.isqream.com/master?access_token=<ACCESS_TOKEN>
%sql select 'Success' as Test
Connection String
=====================
.. code-block:: shell
sqream_blue://<domain>:443/<db_name>
Parameters
------------
.. list-table::
:widths: auto
:header-rows: 1
* - Parameter
- Description
* - ``domain``
- Specifies the domain
* - ``port``
- Specifies the port number
* - ``database``
- Specifies the database name
Limitations
=============
Parameterized Queries
-----------------------
SQream SQLAlchemy supports only the ``BULK INSERT`` statement.
Raw data
{
"_id": null,
"home_page": "https://github.com/SQream/pysqream_blue_sqlalchemy",
"name": "pysqream-blue-sqlalchemy",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "database sqlalchemy sqream sqreamdb",
"author": "SQream",
"author_email": "info@sqream.com",
"download_url": "https://files.pythonhosted.org/packages/ea/79/6d90b82292d3281704d51825b35f459dbc558187605f21485b5c293e5d33/pysqream_blue_sqlalchemy-0.9.3.tar.gz",
"platform": null,
"description": "**********************************\nSQLAlchemy Dialect for SQream DB\n**********************************\n\nRequirements\n=====================\n\n* Python > 3.9.\n* SQLAlchemy == 1.3.18\n* SQream Blue DB-API Connector >= 1.0.42\n\nInstallation\n=====================\n\nInstall from the PyPi repository using `pip`:\n\n.. code-block:: bash\n\n pip3.9 install --upgrade pysqream_blue_sqlalchemy\n\nUsage\n===============================\n\nIntegrating with SQLAlchemy\n----------------------------\n\n.. code-block:: python\n\n import sqlalchemy as sa\n _access_token = \"ACCESS TOKEN\"\n conn_str = f\"sqream_blue://domain:443/database\"\n connect_args = {'access_token': _access_token}\n engine = sa.create_engine(conn_string, connect_args=connect_args)\n conn = engine.connect()\n res = conn.execute(\"select 'Success' as Test\").fetchall()\n print(res)\n\nIntegrating with the IPython/Jupyter SQL Magic\n-----------------------------------------------\n\n.. code-block:: python\n\n %load_ext sql\n %config SqlMagic.autocommit=False\n %config SqlMagic.displaycon=False\n %config SqlMagic.autopandas=True\n %sql sqream_blue://product.isqream.com/master?access_token=<ACCESS_TOKEN>\n %sql select 'Success' as Test\n\n\nConnection String \n=====================\n\n.. code-block:: shell\n\n sqream_blue://<domain>:443/<db_name>\n\nParameters\n------------\n\n.. list-table:: \n :widths: auto\n :header-rows: 1\n\n * - Parameter\n - Description\n * - ``domain``\n - Specifies the domain\n * - ``port``\n - Specifies the port number\n * - ``database``\n - Specifies the database name \n\n\nLimitations\n=============\n\nParameterized Queries\n-----------------------\n\nSQream SQLAlchemy supports only the ``BULK INSERT`` statement.\n\n\n",
"bugtrack_url": null,
"license": null,
"summary": "SQLAlchemy dialect for SQream Blue",
"version": "0.9.3",
"project_urls": {
"Homepage": "https://github.com/SQream/pysqream_blue_sqlalchemy"
},
"split_keywords": [
"database",
"sqlalchemy",
"sqream",
"sqreamdb"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b6f299b9daad296bb841e77215f33fd07bebd43183718e830b38064dc476d599",
"md5": "1edbb2297bf9bba4845b367283b11253",
"sha256": "07db04c06e57b7d490557a121ad53c2e3d3a3d10bd47d24a004dce9c06415f15"
},
"downloads": -1,
"filename": "pysqream_blue_sqlalchemy-0.9.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1edbb2297bf9bba4845b367283b11253",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 7130,
"upload_time": "2024-09-24T05:31:25",
"upload_time_iso_8601": "2024-09-24T05:31:25.682982Z",
"url": "https://files.pythonhosted.org/packages/b6/f2/99b9daad296bb841e77215f33fd07bebd43183718e830b38064dc476d599/pysqream_blue_sqlalchemy-0.9.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ea796d90b82292d3281704d51825b35f459dbc558187605f21485b5c293e5d33",
"md5": "4fd863f19ec0838bcae77e6fcb631c2c",
"sha256": "0674bc2235d733edc833511e78f339409a8f29ad72647e078ad8f2609c93dd79"
},
"downloads": -1,
"filename": "pysqream_blue_sqlalchemy-0.9.3.tar.gz",
"has_sig": false,
"md5_digest": "4fd863f19ec0838bcae77e6fcb631c2c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 5492,
"upload_time": "2024-09-24T05:31:26",
"upload_time_iso_8601": "2024-09-24T05:31:26.583969Z",
"url": "https://files.pythonhosted.org/packages/ea/79/6d90b82292d3281704d51825b35f459dbc558187605f21485b5c293e5d33/pysqream_blue_sqlalchemy-0.9.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-24 05:31:26",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "SQream",
"github_project": "pysqream_blue_sqlalchemy",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pysqream-blue-sqlalchemy"
}
JSON
