Module engine (0.7.0)

API documentation for engine module.

Classes

Column

Column(name: "str", data_type: "str", nullable: "bool" = True)

Column(name: 'str', data_type: 'str', nullable: 'bool' = True)

PostgresEngine

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

A class for managing connections to a Cloud SQL for Postgres 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 Cloud SQL.

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.