Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/goodmanwen/cx_oracle_async
A very simple asynchronous wrapper that allows you to get access to the Oracle database in asyncio programs.
https://github.com/goodmanwen/cx_oracle_async
asyncio-programs cx-oracle oracle-client oracle-database
Last synced: 14 days ago
JSON representation
A very simple asynchronous wrapper that allows you to get access to the Oracle database in asyncio programs.
- Host: GitHub
- URL: https://github.com/goodmanwen/cx_oracle_async
- Owner: GoodManWEN
- License: mit
- Created: 2020-12-26T20:17:51.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2023-07-06T12:12:08.000Z (over 1 year ago)
- Last Synced: 2024-09-16T14:19:06.752Z (about 2 months ago)
- Topics: asyncio-programs, cx-oracle, oracle-client, oracle-database
- Language: Python
- Homepage:
- Size: 119 KB
- Stars: 39
- Watchers: 5
- Forks: 16
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# cx_Oracle_async
[](https://pypi.org/project/cx-Oracle-async/)
[](https://github.com/GoodManWEN/cx_Oracle_async/blob/master/LICENSE)
[](https://pypi.org/project/cx-Oracle-async/)
[](https://github.com/GoodManWEN/cx_Oracle_async/actions?query=workflow:Publish)
[](https://github.com/GoodManWEN/cx_Oracle_async/actions?query=workflow:Build)
[](https://readthedocs.org/projects/cx-oracle-async/)
[](https://github.com/GoodManWEN/cx_Oracle_async/)
A very simple asynchronous wrapper that allows you to get access to the Oracle database in asyncio programs.
Easy to use , buy may not the best practice for efficiency concern.
## About development release
In parallel with the main branch, we have worked on a development version based on [SQLAlchemy](https://github.com/sqlalchemy/sqlalchemy)'s thread pool management facilities, please refer to [Development notes](https://github.com/GoodManWEN/cx_Oracle_async/blob/dev/misc/Development_notes.md) for details.
## Requirements
- [cx_Oracle >= 8.1.0](https://github.com/oracle/python-cx_Oracle) (Take into consideration that author of cx_Oracle said he's trying to implement asyncio support , APIs maybe change in future version. Switch to 8.1.0 if there's something wrong makes it not gonna work.)
- [ThreadPoolExecutorPlus >= 0.2.0](https://github.com/GoodManWEN/ThreadPoolExecutorPlus)
## Install
pip install cx_Oracle_async
## Feature
- Nearly all the same as aiomysql in asynchronous operational approach , with limited cx_Oracle feature support.
- No automaticly date format transition built-in.
- AQ feature added , check [docs here](https://cx_oracle_async.readthedocs.io/en/latest/user_guide/advancedfeatures.html#oracle-advanced-queuing-aq) for further information.
- You can modify some of the connection properties simply like you're using cx_Oracle.
- You can do basic insert / select / delete etc.
- If you're connecting to database which is on a different machine from python process , you need to install oracle client module in order to use this library. Check [cx-Oracle's installation guide](https://cx-oracle.readthedocs.io/en/latest/user_guide/installation.html) for further information.
## Documentation
[https://cx_oracle_async.readthedocs.io](https://cx_oracle_async.readthedocs.io)
## Performance
query type | asynchronous multithreading | synchronous multithreading | synchronous single thread
-|-|-|-
fast single line query | 6259.80 q/s | 28906.93 q/s | 14805.61 q/s
single line insertion | 1341.88 q/s | 1898 q/s | 1685.17 q/s
*/\* Test platform: \*/*
*AMD Ryzen 3700x*
*Windows 10 LTSC*
*Oracle 19c*
*You can find performance test codes [here](https://github.com/GoodManWEN/cx_Oracle_async/blob/main/misc).*
## Examples
Before running examples , make sure you've already installed a [Oracle Client](https://cx-oracle-async.readthedocs.io/en/latest/user_guide/quickstart.html#install-oracle-client) on your machine.
```Python
# basic_usages.py
import asyncio
import cx_Oracle_async
async def main():
oracle_pool = await cx_Oracle_async.create_pool(
host='localhost',
port='1521',
user='user',
password='password',
service_name='orcl',
min = 2,
max = 4,
)
async with oracle_pool.acquire() as connection:
async with connection.cursor() as cursor:
await cursor.execute("SELECT * FROM V$SESSION")
print(await cursor.fetchall())
await oracle_pool.close()
if __name__ == '__main__':
asyncio.run(main())
```