sqlalchemy-iris


Namesqlalchemy-iris JSON
Version 0.13.3 PyPI version JSON
download
home_pagehttps://github.com/caretdev/sqlalchemy-iris
SummaryInterSystems IRIS for SQLAlchemy
upload_time2024-03-31 14:17:23
maintainerCaretDev
docs_urlNone
authorNone
requires_python>=3.8
licenseMIT
keywords "sqlalchemy intersystems iris"
VCS
bugtrack_url
requirements SQLAlchemy
Travis-CI No Travis.
coveralls test coverage No coveralls.
            sqlalchemy-iris
===

An InterSystems IRIS dialect for SQLAlchemy.

Pre-requisites
---

This dialect requires SQLAlchemy, InterSystems DB-API driver. They are specified as requirements so ``pip``
will install them if they are not already in place. To install, just:

```shell
pip install sqlalchemy-iris
```

Usage
---

In your Python app, you can connect to the database via:

```python
from sqlalchemy import create_engine
engine = create_engine("iris://_SYSTEM:SYS@localhost:1972/USER")
```

IRIS Cloud SQL requires SSLContext

```python
url = engine.URL.create(
    drivername="iris",
    host=host,
    port=443,
    username='SQLAdmin',
    password=password,
    database='USER',
)

sslcontext = ssl.create_default_context(cafile="certificateSQLaaS.pem")

engine = create_engine(url, connect_args={"sslcontext": sslcontext})
```

InterSystems IRIS
---

You can run your instance of InterSystems IRIS Community Edition with Docker

```shell
docker run -d --name iris \
 -p 1972:1972 \
 -p 52773:52773 \
 -e IRIS_USERNAME=_SYSTEM \
 -e IRIS_PASSWORD=SYS \
 intersystemsdc/iris-community:preview
```

_Port 1972 is used for binary communication (this driver, xDBC and so on), and 52773 is for web (Management Portal, IRIS based web-applications and API's)._

The System Management Portal is available by URL: `http://localhost:52773/csp/sys/UtilHome.csp`

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/caretdev/sqlalchemy-iris",
    "name": "sqlalchemy-iris",
    "maintainer": "CaretDev",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "dmitry@caretdev.com",
    "keywords": "\"SQLAlchemy InterSystems IRIS\"",
    "author": null,
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/0d/1b/dce5f6b18a61b796750ddccf4c4a55485351aecae35964913977b5d9b4d2/sqlalchemy-iris-0.13.3.tar.gz",
    "platform": null,
    "description": "sqlalchemy-iris\n===\n\nAn InterSystems IRIS dialect for SQLAlchemy.\n\nPre-requisites\n---\n\nThis dialect requires SQLAlchemy, InterSystems DB-API driver. They are specified as requirements so ``pip``\nwill install them if they are not already in place. To install, just:\n\n```shell\npip install sqlalchemy-iris\n```\n\nUsage\n---\n\nIn your Python app, you can connect to the database via:\n\n```python\nfrom sqlalchemy import create_engine\nengine = create_engine(\"iris://_SYSTEM:SYS@localhost:1972/USER\")\n```\n\nIRIS Cloud SQL requires SSLContext\n\n```python\nurl = engine.URL.create(\n    drivername=\"iris\",\n    host=host,\n    port=443,\n    username='SQLAdmin',\n    password=password,\n    database='USER',\n)\n\nsslcontext = ssl.create_default_context(cafile=\"certificateSQLaaS.pem\")\n\nengine = create_engine(url, connect_args={\"sslcontext\": sslcontext})\n```\n\nInterSystems IRIS\n---\n\nYou can run your instance of InterSystems IRIS Community Edition with Docker\n\n```shell\ndocker run -d --name iris \\\n -p 1972:1972 \\\n -p 52773:52773 \\\n -e IRIS_USERNAME=_SYSTEM \\\n -e IRIS_PASSWORD=SYS \\\n intersystemsdc/iris-community:preview\n```\n\n_Port 1972 is used for binary communication (this driver, xDBC and so on), and 52773 is for web (Management Portal, IRIS based web-applications and API's)._\n\nThe System Management Portal is available by URL: `http://localhost:52773/csp/sys/UtilHome.csp`\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "InterSystems IRIS for SQLAlchemy",
    "version": "0.13.3",
    "project_urls": {
        "Homepage": "https://github.com/caretdev/sqlalchemy-iris",
        "Source": "https://github.com/caretdev/sqlalchemy-iris",
        "Tracker": "https://github.com/caretdev/sqlalchemy-iris/issues"
    },
    "split_keywords": [
        "\"sqlalchemy",
        "intersystems",
        "iris\""
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "0a1a5bc8ee38f55a1ba9e99b61452e3508e97274701f10f31cb463df455846cd",
                "md5": "41d15ad25899ebedcd542fa93443d913",
                "sha256": "bfe403a0e024d389bc59601d3ae062352f5ecd575b6f6c14effa1bab54b48a11"
            },
            "downloads": -1,
            "filename": "sqlalchemy_iris-0.13.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "41d15ad25899ebedcd542fa93443d913",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 141431,
            "upload_time": "2024-03-31T14:17:20",
            "upload_time_iso_8601": "2024-03-31T14:17:20.930808Z",
            "url": "https://files.pythonhosted.org/packages/0a/1a/5bc8ee38f55a1ba9e99b61452e3508e97274701f10f31cb463df455846cd/sqlalchemy_iris-0.13.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "0d1bdce5f6b18a61b796750ddccf4c4a55485351aecae35964913977b5d9b4d2",
                "md5": "a5c73bd3030b9535f745551ca0d9d1c9",
                "sha256": "323e5ec9f6315001dd862465752faa5b3b29e2b0e7788745ea512a3e5d4e2433"
            },
            "downloads": -1,
            "filename": "sqlalchemy-iris-0.13.3.tar.gz",
            "has_sig": false,
            "md5_digest": "a5c73bd3030b9535f745551ca0d9d1c9",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 119113,
            "upload_time": "2024-03-31T14:17:23",
            "upload_time_iso_8601": "2024-03-31T14:17:23.071201Z",
            "url": "https://files.pythonhosted.org/packages/0d/1b/dce5f6b18a61b796750ddccf4c4a55485351aecae35964913977b5d9b4d2/sqlalchemy-iris-0.13.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-03-31 14:17:23",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "caretdev",
    "github_project": "sqlalchemy-iris",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "SQLAlchemy",
            "specs": [
                [
                    ">=",
                    "1.3"
                ]
            ]
        }
    ],
    "lcname": "sqlalchemy-iris"
}
        
Elapsed time: 0.30029s