Module engine (0.15.0)

0.15.0 (latest) 0.14.0 0.12.0 0.11.0 0.10.0 0.9.3 0.8.0 0.7.0 0.6.0 0.5.0 0.4.1 0.3.0 0.2.2

API documentation for engine module.

Classes

AlloyDBEngine

AlloyDBEngine(
    key: object,
    pool: sqlalchemy.ext.asyncio.engine.AsyncEngine,
    loop: typing.Optional[asyncio.events.AbstractEventLoop],
    thread: typing.Optional[threading.Thread],
)

A class for managing connections to a AlloyDB database.

Modules Functions

_get_iam_principal_email

_get_iam_principal_email(credentials: google.auth.credentials.Credentials) -> str

Get email address associated with current authenticated IAM principal.

Email will be used for automatic IAM database authentication to AlloyDB.

Parameter
Name	Description
credentials	google.auth.credentials.Credentials The credentials object to use in finding the associated IAM principal email address.

Returns
Type	Description
email (str)	The email address associated with the current authenticated IAM principal.