# SQLAlchemy Dremio
A SQLAlchemy dialect for Dremio via ODBC and Flight interfaces.
<!--ts-->
* [Installation](#installation)
* [Pre-Requisites](#pre-requisites)
* [Usage](#usage)
* [ODBC](#odbc)
* [Arrow Flight](#arrow-flight)
* [Testing](#testing)
* [Superset Integration](#superset-integration)
<!--te-->
Installation
------------
`pip install sqlalchemy_dremio`
Pre-Requisites
--------------
Mac OS X:
* Unix ODBC: (brew install unixodbc)
* Dremio ODBC Driver (https://download.dremio.com/odbc-driver/DremioODBC-LATEST.dmg)
CentOS/RHEL:
* Unix ODBC (sudo yum apt-get install -y unixODBC unixODBC-devel)
* PyODBC (pip install pyodbc)
* Dremio ODBC Driver (https://download.dremio.com/odbc-driver/dremio-odbc-LATEST.x86_64.rpm)
Debian:
* Unix ODBC (sudo apt install -y unixodbc unixodbc-dev)
* PyODBC (pip install pyodbc)
* Dremio ODBC Driver (https://download.dremio.com/odbc-driver/dremio-odbc-LATEST.x86_64.rpm)
* Use alien to convert it into deb and then install it.
Usage
------------
ODBC
-------
Connection String example:
`dremio://user:password@host:port/dremio;SSL=0`
You can specify other ODBC parameters seperated by semi colon.
Arrow Flight
------
```diff
- This is experiemental. Not recommended for production usage.
```
Connection String example:
`dremio+flight://user:password@host:port/dremio`
Refer https://github.com/dremio-hub/dremio-flight-connector for configuring flight endpoint in Dremio.
Testing
------------
Set the environment variable DREMIO_CONNECTION_STRING:
Windows:
`setx DREMIO_CONNECTION_URL "dremio://dremio:dremio123@localhost:31010/dremio"`
Linux:
`export DREMIO_CONNECTION_URL="dremio://dremio:dremio123@localhost:31010/dremio"`
And then run:
`py.test test`
Superset Integration
-------------
This SQLAlchemy can be used for connecting Dremio with Superset. Please check superset website for more instructions on the setup.
Raw data
{
"_id": null,
"home_page": "https://github.com/narendrans/sqlalchemy_dremio",
"name": "preset-sqlalchemy-dremio",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "sqlalchemy_dremio",
"author": "Naren",
"author_email": "me@narendran.info",
"download_url": "https://files.pythonhosted.org/packages/d8/4f/5bd0704e39fc070b023a72590f088a6cb43294e5d82ee68ecf8620d93bef/preset_sqlalchemy_dremio-1.2.1.tar.gz",
"platform": null,
"description": "# SQLAlchemy Dremio\n\n\n\n\n\nA SQLAlchemy dialect for Dremio via ODBC and Flight interfaces.\n\n<!--ts-->\n * [Installation](#installation)\n * [Pre-Requisites](#pre-requisites)\n * [Usage](#usage)\n * [ODBC](#odbc)\n * [Arrow Flight](#arrow-flight)\n * [Testing](#testing)\n * [Superset Integration](#superset-integration)\n<!--te-->\n\nInstallation\n------------\n\n`pip install sqlalchemy_dremio`\n\nPre-Requisites\n--------------\n\nMac OS X:\n\n* Unix ODBC: (brew install unixodbc)\n* Dremio ODBC Driver (https://download.dremio.com/odbc-driver/DremioODBC-LATEST.dmg)\n\nCentOS/RHEL:\n\n* Unix ODBC (sudo yum apt-get install -y unixODBC unixODBC-devel)\n* PyODBC (pip install pyodbc)\n* Dremio ODBC Driver (https://download.dremio.com/odbc-driver/dremio-odbc-LATEST.x86_64.rpm)\n\nDebian:\n\n* Unix ODBC (sudo apt install -y unixodbc unixodbc-dev)\n* PyODBC (pip install pyodbc)\n* Dremio ODBC Driver (https://download.dremio.com/odbc-driver/dremio-odbc-LATEST.x86_64.rpm)\n\n * Use alien to convert it into deb and then install it.\n\nUsage\n------------\n\nODBC\n-------\nConnection String example:\n`dremio://user:password@host:port/dremio;SSL=0`\n\nYou can specify other ODBC parameters seperated by semi colon.\n\nArrow Flight\n------\n```diff\n- This is experiemental. Not recommended for production usage.\n```\n\nConnection String example:\n`dremio+flight://user:password@host:port/dremio`\n\nRefer https://github.com/dremio-hub/dremio-flight-connector for configuring flight endpoint in Dremio.\n\nTesting\n------------\n\nSet the environment variable DREMIO_CONNECTION_STRING:\n\nWindows:\n`setx DREMIO_CONNECTION_URL \"dremio://dremio:dremio123@localhost:31010/dremio\"`\n\nLinux:\n`export DREMIO_CONNECTION_URL=\"dremio://dremio:dremio123@localhost:31010/dremio\"`\n\nAnd then run:\n\n`py.test test`\n\nSuperset Integration\n-------------\n\nThis SQLAlchemy can be used for connecting Dremio with Superset. Please check superset website for more instructions on the setup.\n",
"bugtrack_url": null,
"license": "Apache Software License",
"summary": "Fork of sqlalchemy-dremio 1.2.1 for parallel deployment with newer versions",
"version": "1.2.1",
"project_urls": {
"Homepage": "https://github.com/narendrans/sqlalchemy_dremio"
},
"split_keywords": [
"sqlalchemy_dremio"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d84f5bd0704e39fc070b023a72590f088a6cb43294e5d82ee68ecf8620d93bef",
"md5": "02460aeb247d86a40bdbbe683a698643",
"sha256": "4465eca9554bcfdecbe35261a2fcbbd54d29787e42ebb15c5c56de3cd47f8a2b"
},
"downloads": -1,
"filename": "preset_sqlalchemy_dremio-1.2.1.tar.gz",
"has_sig": false,
"md5_digest": "02460aeb247d86a40bdbbe683a698643",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 15205,
"upload_time": "2024-04-29T19:42:09",
"upload_time_iso_8601": "2024-04-29T19:42:09.555467Z",
"url": "https://files.pythonhosted.org/packages/d8/4f/5bd0704e39fc070b023a72590f088a6cb43294e5d82ee68ecf8620d93bef/preset_sqlalchemy_dremio-1.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-29 19:42:09",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "narendrans",
"github_project": "sqlalchemy_dremio",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "preset-sqlalchemy-dremio"
}
JSON
