connect

`app.contrib.sqlalchemy.connect`

Módulo de Python para gestionar la conexión a PostgreSQL(psycopg)

Para más información, te recomendamos leer la documentación del Proyecto.

Obtiene de variables de entorno, los valores para definir una conexión hacia una Base de Datos PostgreSQL.

Raises:

Type	Description
`DefaultException`	excepciones para el manejo de errores personalizados
`None`	en caso de un error

Returns:

Type	Description
`Optional[dict[str, Any]]`	un diccionario con información de la cadena de conexión, el nombre de la Base de Datos y el prefijo para las colecciones, ó `None` en caso de error

Examples:

from app.contrib.sqlalchemy.connect import pgmodel_get_connect
...

pg_conn = pgmodel_get_connect()

Establece la conexión a PostgreSQL.

Parameters:

Name	Type	Description	Default
`ping`	`bool`	permite hacer un ping a la Base de Datos, para comprobar el estado de la conexión, por defecto `False`	`False`
`pool_recycle_time`	`int`	este parámetro hace que el pool recicle las conexiones después de que haya pasado el número de segundos dado. Por defecto es de `1800`, ó 15 minutos	`1800`
`use_echo`	`bool`	PostgreSQL registrará todas las sentencias así como un `repr()`, la salida por defecto es `sys.stdout`	`False`

Raises:

Type	Description
`DefaultException`	excepciones para el manejo de errores personalizados
`Exception`	fallo al conectarse a la Base de Datos
`None`	en caso de un error

Returns:

Type	Description
`Optional[dict[str, Any]]`	un diccionario con información del cliente(session), la instancia de la Base de Datos, una instancia de `declarative_base` y el prefijo para las colecciones, ó `None` en caso de error

Examples:

from app.contrib.sqlalchemy.connect import pgmodel_connect
...

db = pgmodel_connect(True)
fastapi.pg_db = db

Cierra la conexión a una Base de Datos PostgreSQL.

Parameters:

Name	Type	Description	Default
`conn`	`Any`	la instancia de conexión	`None`

Examples:

from app.contrib.sqlalchemy.connect import pgmodel_close
...

conn = getattr(fastapp, "pg_db", None)
pgmodel_close(conn)