| Name | harlequin-odbc JSON |
| Version |
0.2.0
JSON |
| download |
| home_page | None |
| Summary | A Harlequin adapter for ODBC drivers. |
| upload_time | 2025-01-08 18:12:45 |
| maintainer | None |
| docs_url | None |
| author | Ted Conbeer |
| requires_python | <3.14,>=3.9 |
| license | MIT |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# harlequin-odbc
This repo provides the ODBC adapter for Harlequin.
## Installation
`harlequin-odbc` depends on `harlequin`, so installing this package will also install Harlequin.
### Pre-requisites
You will need an ODBC driver manager installed on your OS. Windows has one built-in, but for Unix-based OSes, you will need to download and install one before installing `harlequin-odbc`. You can install unixODBC with `brew install unixodbc` or `sudo apt install unixodbc`. See the [pyodbc docs](https://github.com/mkleehammer/pyodbc/wiki/Install) for more info.
Additionally, you will need to install the ODBC driver for your specific database (e.g., `ODBC Driver 18 for SQL Server` for MS SQL Server). For more information, see the docs for your specific database.
### Using pip
To install this adapter into an activated virtual environment:
```bash
pip install harlequin-odbc
```
### Using poetry
```bash
poetry add harlequin-odbc
```
### Using pipx
If you do not already have Harlequin installed:
```bash
pip install harlequin-odbc
```
If you would like to add the ODBC adapter to an existing Harlequin installation:
```bash
pipx inject harlequin harlequin-odbc
```
### As an Extra
Alternatively, you can install Harlequin with the `odbc` extra:
```bash
pip install harlequin[odbc]
```
```bash
poetry add harlequin[odbc]
```
```bash
pipx install harlequin[odbc]
```
## Usage and Configuration
You can open Harlequin with the ODBC adapter by selecting it with the `-a` option and passing an ODBC connection string:
```bash
harlequin -a odbc 'Driver={ODBC Driver 18 for SQL Server};Server=tcp:harlequin-example.database.windows.net,1433;Database=dev;Uid=harlequin;Pwd=my_secret;Encrypt=yes;TrustServerCertificate=no;Connection Timeout=30;'
```
The ODBC adapter does not accept other options.
For more information, see the [Harlequin Docs](https://harlequin.sh/docs/odbc/index).
Raw data
{
"_id": null,
"home_page": null,
"name": "harlequin-odbc",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.14,>=3.9",
"maintainer_email": null,
"keywords": null,
"author": "Ted Conbeer",
"author_email": "tconbeer@users.noreply.github.com",
"download_url": "https://files.pythonhosted.org/packages/29/15/a382080b74b1f08a5b9d985a435afe413623f206ed8fc8a7b03be948da69/harlequin_odbc-0.2.0.tar.gz",
"platform": null,
"description": "# harlequin-odbc\n\nThis repo provides the ODBC adapter for Harlequin.\n\n## Installation\n\n`harlequin-odbc` depends on `harlequin`, so installing this package will also install Harlequin.\n\n### Pre-requisites\n\nYou will need an ODBC driver manager installed on your OS. Windows has one built-in, but for Unix-based OSes, you will need to download and install one before installing `harlequin-odbc`. You can install unixODBC with `brew install unixodbc` or `sudo apt install unixodbc`. See the [pyodbc docs](https://github.com/mkleehammer/pyodbc/wiki/Install) for more info.\n\nAdditionally, you will need to install the ODBC driver for your specific database (e.g., `ODBC Driver 18 for SQL Server` for MS SQL Server). For more information, see the docs for your specific database.\n\n### Using pip\n\nTo install this adapter into an activated virtual environment:\n```bash\npip install harlequin-odbc\n```\n\n### Using poetry\n\n```bash\npoetry add harlequin-odbc\n```\n\n### Using pipx\n\nIf you do not already have Harlequin installed:\n\n```bash\npip install harlequin-odbc\n```\n\nIf you would like to add the ODBC adapter to an existing Harlequin installation:\n\n```bash\npipx inject harlequin harlequin-odbc\n```\n\n### As an Extra\nAlternatively, you can install Harlequin with the `odbc` extra:\n\n```bash\npip install harlequin[odbc]\n```\n\n```bash\npoetry add harlequin[odbc]\n```\n\n```bash\npipx install harlequin[odbc]\n```\n\n## Usage and Configuration\n\nYou can open Harlequin with the ODBC adapter by selecting it with the `-a` option and passing an ODBC connection string:\n\n```bash\nharlequin -a odbc 'Driver={ODBC Driver 18 for SQL Server};Server=tcp:harlequin-example.database.windows.net,1433;Database=dev;Uid=harlequin;Pwd=my_secret;Encrypt=yes;TrustServerCertificate=no;Connection Timeout=30;'\n```\n\nThe ODBC adapter does not accept other options.\n\nFor more information, see the [Harlequin Docs](https://harlequin.sh/docs/odbc/index).\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A Harlequin adapter for ODBC drivers.",
"version": "0.2.0",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "11138099124095e92e8c8d28601dfafc54c733948a42acdab3a1e1888d1b1f60",
"md5": "2007563d5d7731af93857bd7b9260844",
"sha256": "b36d1ba05bfc7a6ab98b09f74dbb0259c04569c7aef4ad5f67185bced1a7e167"
},
"downloads": -1,
"filename": "harlequin_odbc-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2007563d5d7731af93857bd7b9260844",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.14,>=3.9",
"size": 5482,
"upload_time": "2025-01-08T18:12:42",
"upload_time_iso_8601": "2025-01-08T18:12:42.911146Z",
"url": "https://files.pythonhosted.org/packages/11/13/8099124095e92e8c8d28601dfafc54c733948a42acdab3a1e1888d1b1f60/harlequin_odbc-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2915a382080b74b1f08a5b9d985a435afe413623f206ed8fc8a7b03be948da69",
"md5": "3b52c5dbdb050101772f1cdacade2ca2",
"sha256": "9a61e182959642af1399df38b16c5027aa177af5b0e555f221f74daaafc91397"
},
"downloads": -1,
"filename": "harlequin_odbc-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "3b52c5dbdb050101772f1cdacade2ca2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.14,>=3.9",
"size": 4525,
"upload_time": "2025-01-08T18:12:45",
"upload_time_iso_8601": "2025-01-08T18:12:45.173418Z",
"url": "https://files.pythonhosted.org/packages/29/15/a382080b74b1f08a5b9d985a435afe413623f206ed8fc8a7b03be948da69/harlequin_odbc-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-08 18:12:45",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "harlequin-odbc"
}
