| Name | sqlalchemy-odbc4abap JSON |
| Version |
0.0.5
JSON |
| download |
| home_page | |
| Summary | Connect to S/4HANA CDS View Entities through ODBC. |
| upload_time | 2024-01-18 10:17:06 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.10 |
| license | MIT License Copyright (c) [2023] [Gunter Albrecht] Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
odbc
sap
sqlalchemy
abap
cds
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# ODBC for ABAP (odbc4abap)
ODBC for ABAP is a Python library that provides an Open Database Connectivity (ODBC) driver for ABAP systems. This library is designed to plug into SQLAlchemy 2.0 and allows for external SQL read access to CDS objects owned by the ABAP system.
## Why an ODBC Driver for ABAP?
Direct SQL read access to the underlying SAP HANA database of an ABAP system is not recommended due to several issues outlined in SAP Note 2511210. These include unstable names and internal structures, incorrect typecasts, and bypassed ABAP-level security concepts.
By treating the ABAP system itself as a database and accessing it directly using ODBC, these problems are mitigated. Authentication and authorization are handled using an ABAP user, and full ABAP SQL semantics apply. This approach also enables the use of application-server-level buffering, ABAP-level access control, and read access logging.
Compared to the ODATA interface, the ODBC interface provides unrestricted SQL access to all exposed ABAP CDS view entities, allowing for ad-hoc joins and data aggregation for analytical queries.
## Features
- Supports the use of a technical user in the ABAP system with privileged access (no DCLs).
- Allows only read access to the exposed ABAP CDS objects.
- Integrates with SQLAlchemy 2.0 for easy use within Python applications.
## Installation
To install `odbc4abap`, you can use `pip`:
```bash
pip install odbc4abap
```
## Configuration
Please refer to SAP Note '3076454 - ODBC driver for ABAP: Configuration' for detailed configuration instructions.
## Usage
After installing and configuring the library, you can use it within your Python application to query ABAP CDS view entities. Here is an example of how to use `odbc4abap` with SQLAlchemy:
```python
from sqlalchemy import create_engine
# Create an engine that connects to the ABAP system
engine = create_engine('odbc4abap+pyodbc://username:password@dsn')
# Query the ABAP system using SQLAlchemy ORM or Core
# ...
```
## Limitations
- Currently, only read access is supported.
- The library supports the use of a technical user with privileged access only.
## License
`odbc4abap` is released under the MIT License. See the LICENSE file for more details.
## Contributions
Contributions are welcome! Please submit pull requests or open issues on the project's GitHub repository.
## Support
For support and further assistance, please refer to the SAP community forums or open an issue on the GitHub repository.
## Disclaimer
This project is not affiliated with SAP SE or its group of companies.
Raw data
{
"_id": null,
"home_page": "",
"name": "sqlalchemy-odbc4abap",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "",
"keywords": "odbc,sap,sqlalchemy,abap,cds",
"author": "",
"author_email": "Skye0402 <albrechg@yahoo.com>",
"download_url": "https://files.pythonhosted.org/packages/30/dd/4b35f35d8e4de09747809bee72cc380f045d32297bb726c8838f5750701a/sqlalchemy-odbc4abap-0.0.5.tar.gz",
"platform": null,
"description": "# ODBC for ABAP (odbc4abap)\r\n\r\nODBC for ABAP is a Python library that provides an Open Database Connectivity (ODBC) driver for ABAP systems. This library is designed to plug into SQLAlchemy 2.0 and allows for external SQL read access to CDS objects owned by the ABAP system.\r\n\r\n## Why an ODBC Driver for ABAP?\r\n\r\nDirect SQL read access to the underlying SAP HANA database of an ABAP system is not recommended due to several issues outlined in SAP Note 2511210. These include unstable names and internal structures, incorrect typecasts, and bypassed ABAP-level security concepts.\r\n\r\nBy treating the ABAP system itself as a database and accessing it directly using ODBC, these problems are mitigated. Authentication and authorization are handled using an ABAP user, and full ABAP SQL semantics apply. This approach also enables the use of application-server-level buffering, ABAP-level access control, and read access logging.\r\n\r\nCompared to the ODATA interface, the ODBC interface provides unrestricted SQL access to all exposed ABAP CDS view entities, allowing for ad-hoc joins and data aggregation for analytical queries.\r\n\r\n## Features\r\n\r\n- Supports the use of a technical user in the ABAP system with privileged access (no DCLs).\r\n- Allows only read access to the exposed ABAP CDS objects.\r\n- Integrates with SQLAlchemy 2.0 for easy use within Python applications.\r\n\r\n## Installation\r\n\r\nTo install `odbc4abap`, you can use `pip`:\r\n\r\n```bash\r\npip install odbc4abap\r\n```\r\n\r\n## Configuration\r\n\r\nPlease refer to SAP Note '3076454 - ODBC driver for ABAP: Configuration' for detailed configuration instructions.\r\n\r\n## Usage\r\n\r\nAfter installing and configuring the library, you can use it within your Python application to query ABAP CDS view entities. Here is an example of how to use `odbc4abap` with SQLAlchemy:\r\n\r\n```python\r\nfrom sqlalchemy import create_engine\r\n\r\n# Create an engine that connects to the ABAP system\r\nengine = create_engine('odbc4abap+pyodbc://username:password@dsn')\r\n\r\n# Query the ABAP system using SQLAlchemy ORM or Core\r\n# ...\r\n```\r\n\r\n## Limitations\r\n\r\n- Currently, only read access is supported.\r\n- The library supports the use of a technical user with privileged access only.\r\n\r\n## License\r\n\r\n`odbc4abap` is released under the MIT License. See the LICENSE file for more details.\r\n\r\n## Contributions\r\n\r\nContributions are welcome! Please submit pull requests or open issues on the project's GitHub repository.\r\n\r\n## Support\r\n\r\nFor support and further assistance, please refer to the SAP community forums or open an issue on the GitHub repository.\r\n\r\n## Disclaimer\r\n\r\nThis project is not affiliated with SAP SE or its group of companies.\r\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) [2023] [Gunter Albrecht] Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "Connect to S/4HANA CDS View Entities through ODBC.",
"version": "0.0.5",
"project_urls": {
"Homepage": "https://github.com/skye0402/sqlalchemy-odbc4abap"
},
"split_keywords": [
"odbc",
"sap",
"sqlalchemy",
"abap",
"cds"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ad7cda825de98715fb01a408ccdbccbfef2d1f952146091ed1a8c8074c121eb4",
"md5": "c08b07a0906419e39a95562794e952e8",
"sha256": "a0c5df62f6be06eee59040e9d01bdd4e7812d5348d51e79fcf1e4367acde8136"
},
"downloads": -1,
"filename": "sqlalchemy_odbc4abap-0.0.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c08b07a0906419e39a95562794e952e8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 14723,
"upload_time": "2024-01-18T10:17:04",
"upload_time_iso_8601": "2024-01-18T10:17:04.730869Z",
"url": "https://files.pythonhosted.org/packages/ad/7c/da825de98715fb01a408ccdbccbfef2d1f952146091ed1a8c8074c121eb4/sqlalchemy_odbc4abap-0.0.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "30dd4b35f35d8e4de09747809bee72cc380f045d32297bb726c8838f5750701a",
"md5": "669af53b21094a7f424c935a9544b66f",
"sha256": "1873f6eb86eacac86537546a63c2557ab4ad21c8760d2865ec80aeb71c02e96b"
},
"downloads": -1,
"filename": "sqlalchemy-odbc4abap-0.0.5.tar.gz",
"has_sig": false,
"md5_digest": "669af53b21094a7f424c935a9544b66f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 14357,
"upload_time": "2024-01-18T10:17:06",
"upload_time_iso_8601": "2024-01-18T10:17:06.469388Z",
"url": "https://files.pythonhosted.org/packages/30/dd/4b35f35d8e4de09747809bee72cc380f045d32297bb726c8838f5750701a/sqlalchemy-odbc4abap-0.0.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-18 10:17:06",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "skye0402",
"github_project": "sqlalchemy-odbc4abap",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "sqlalchemy-odbc4abap"
}
