Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 88 Commits
.github		.github
docs		docs
pydataapi		pydataapi
scripts		scripts
tests		tests
.coveragerc		.coveragerc
.gitignore		.gitignore
CODE_OF_CONDUCT.md		CODE_OF_CONDUCT.md
LICENSE		LICENSE
README.md		README.md
example.py		example.py
mkdocs.yml		mkdocs.yml
mypy.ini		mypy.ini
pyproject.toml		pyproject.toml
setup.cfg		setup.cfg
setup.py		setup.py

Repository files navigation

py-data-api - Data API Client for Python

py-data-api is a client for Data API ofAurora Serverless.Also, the package includes SQLAlchemy Dialects and DB API 2.0 Client.

Features

SQLAlchemy Dialects
DB API 2.0 compatible clientPEP 249

Support Database Engines

MySQL
PostgreSQL

What's AWS Aurora Serverless's Data API?

https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html

This project is an experimental phase.

Warning: Some interface will be changed.

How to install

pydataapi requires Python 3.6.1 or later

$ pip install pydataapi

Example

fromtypingimportListfromsqlalchemyimportColumn,Integer,Stringfromsqlalchemy.ext.declarativeimportdeclarative_basefrompydataapiimportDataAPI,ResultclassPets(declarative_base()):__tablename__='pets'id=Column(Integer,primary_key=True,autoincrement=True)name=Column(String(255,collation='utf8_unicode_ci'),default=None)database:str='test'resource_arn:str='arn:aws:rds:us-east-1:123456789012:cluster:serverless-test-1'secret_arn:str='arn:aws:secretsmanager:us-east-1:123456789012:secret:serverless-test1'defexample_driver_for_sqlalchemy():fromsqlalchemy.engineimportcreate_engineengine=create_engine('mysql+pydataapi://',connect_args={'resource_arn':'arn:aws:rds:us-east-1:123456789012:cluster:dummy','secret_arn':'arn:aws:secretsmanager:us-east-1:123456789012:secret:dummy','database':'test'}    )result=engine.execute("select * from pets")print(result.fetchall())defexample_simple_execute():data_api=DataAPI(resource_arn=resource_arn,secret_arn=secret_arn,database=database)result:Result=data_api.execute('show tables')print(result.scalar())# Pets