Module spin_sdk.redis

Module for interacting with a Redis database

Functions

async def open(connection_string: str) ‑> Connection

Expand source code

async def open(connection_string: str) -> Connection:
    """
    Open a connection with a Redis database.
    
    The connection_string is the Redis URL to connect to.

    A `componentize_py_types.Err(spin_sdk.wit.imports.spin_redis_redis_3_0_0.Error_InvalidAddress)` will be raised if the connection string is invalid.

    A `componentize_py_types.Err(spin_sdk.wit.imports.spin_redis_redis_3_0_0.Error_TooManyConnections)` will be raised if there are too many open connections. Closing one or more previously opened connection using the `__exit__` method might help.
    
    A `componentize_py_types.Err(spin_sdk.wit.imports.spin_redis_redis_3_0_0.Error_Other(str))` when some other error occurs.
    """
    return await Connection.open(connection_string)

Open a connection with a Redis database.

The connection_string is the Redis URL to connect to.

A componentize_py_types.Err(Error_InvalidAddress) will be raised if the connection string is invalid.

A componentize_py_types.Err(Error_TooManyConnections) will be raised if there are too many open connections. Closing one or more previously opened connection using the __exit__ method might help.

A componentize_py_types.Err(Error_Other(str)) when some other error occurs.