Connection Manager

The connection manager is in charge of the loading of the connection configurations and the initialization with every engine specific implementation. It is also in charge to open and close the connection, pool size, throttling, node balancing,...

Accessing the Connection Manager in Code

You can get the connection Manager in your code using:

from app.rest import connection_manager

Getting Connection by Default

The default connection is the engine connection with the explicit default flag in true, or if none with the flag, the first in the list of connections. This connection is used as well for all internal transactions of GAIA API  such as logging, feedback, analytics,...

To get the default connection, just use the code line below: 

engine_conn = connection_manager.get_default()

Getting Connection by name

You can have multiple connections to the same or different types of NonSQL engines, all with a name you can refer to, in order to get said connection. 

To get a connection by name, just use the code line below:

engine = connection_manager.get_engine(name=engine_name)

Engine Connection Config

All engine connections have the generic connection focus on managing the specific aspects of the REST connection.

Engine Connection Authentication 

Engine authentication section, if none, there will be no authentication performed. If basic, Basic Authentication is used to authenticate against the engine.  There are two possibilities for Azure AI Search: API_KEY and Managed Identity. And finally aws uses AWS credentials with or without credential provider

Configuration Examples

In this section we show some engine configuration examples for better understanding.

Azure AI Search

{
            'name': 'Azure Ai Search',
            'type': EngineTypes.AZURE_AI_SEARCH,
            'default': True,
            'headers': {
                'Content-Type': 'application/json'
            },
            'engine_url': 'http://engineurl.com:8085',
            'index_prefix': 'gaia',
            'pool_connections': 10,
            'pool_maxsize': 100,
            'params': {
                'api_version': '2024-05-01-preview'
            },
            'pool_block': True,
            'verify': False,
            'max_redirects': 30,
            'max_retries': 10,
            'retry_wait_time': 10,
            'timeout': 60,
            'allow_redirects':True,
            'trust_env': True,
            'use_throttling': True,
            'throttling_rate': 5000,
            'throttling_connection_rate': 50,
            'auth': {
                'type': Authentications.API_KEY,
                # NOTE that the name of the property has an underscore
                'api_key': 123456789012345678901234567890

                # 'type': Authentications.AZURE_MID,
                # 'azure_scope': 'https://search.azure.com/.default'
            },
            'log_requests': False
}