connect

`app.contrib.mongoDB.connect`

Módulo de Python para gestionar la conexión a MongoDB(pymongo)

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 de MongoDB.

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.mongoDB.connect import mongodb_get_connect
...

mongo_conn = mongodb_get_connect()

Establece la conexión a mongoDB.

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`

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, la instancia de la Base de Datos y el prefijo para las colecciones, ó `None` en caso de error

Examples:

from app.contrib.mongoDB.connect import mongodb_connect
...

db = mongodb_connect(True)
fastapi.mongo_db = db

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

Parameters:

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

Examples:

from app.contrib.mongoDB.connect import mongodb_close
...

conn = getattr(fastapp, "mongo_db", None)
mongodb_close(conn)