Skip to content

Commit

Permalink
docs: make IP type defaults clear in README (#369)
Browse files Browse the repository at this point in the history
Fixes #368
  • Loading branch information
enocom authored Aug 30, 2024
1 parent f264bfd commit 1d8a9a6
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,9 @@ def getconn():
user="my-user",
password="my-password",
db="my-db-name"
# NOTE: this assumes private IP by default.
# Add the following keyword arg to use public IP:
# ip_type="PUBLIC"
)
return conn

Expand Down Expand Up @@ -263,6 +266,9 @@ async def init_connection_pool(connector: AsyncConnector) -> AsyncEngine:
user="my-user",
password="my-password",
db="my-db-name"
# NOTE: this assumes private IP by default.
# Add the following keyword arg to use public IP:
# ip_type="PUBLIC"
# ... additional database driver args
)
return conn
Expand Down

0 comments on commit 1d8a9a6

Please sign in to comment.