googleapis / googleapis/langchain-google-alloydb-pg-python
Add documentation for AlloyDBEngine class methods
- Dominant language
- Python
- Stars
- 39
- Forks
- 25
- Avg merge
- 5d 5h
- Merged PRs (30d)
- 6
Description
All connection approaches for the AlloyDBEngine class should be documented in the README noting if they have the built in auth proxy or any other nuances.
For example:
* PostgresEngine.from_engine() - pass in your configured SQLAlchemy AsyncEngine
* PostgresEngine.from_engine_args() - pass in your URL and configuration
Both these options require you to handle the authentication proxy unless you are self hosting an Omni instance
* PostgresEngine.afrom_instance() - easiest to use and supports engine_args
```
PostgresEngine.afrom_instance(
project_id=db_project,
instance=db_instance,
region=db_region,
database=db_name,
engine_args={
"pool_size": 3,
"max_overflow": 2,
},
)
```
Contributor guide
Assessment
This issue has not been assessed yet.