superduperdb.server package#

Submodules#

superduperdb.server.app module#

superduperdb.server.app.DatalayerDependency()[source]#

A helper method to be used for injecting datalayer instance into endpoint implementation

class superduperdb.server.app.ExceptionHandlerMiddleware(app: Callable[[MutableMapping[str, Any], Callable[[], Awaitable[MutableMapping[str, Any]]], Callable[[MutableMapping[str, Any]], Awaitable[None]]], Awaitable[None]], dispatch: Callable[[Request, Callable[[Request], Awaitable[Response]]], Awaitable[Response]] | None = None)[source]#

Bases: BaseHTTPMiddleware

async dispatch(request: Request, call_next)[source]#
class superduperdb.server.app.Server(config: Config)[source]#

Bases: Server

install_signal_handlers()[source]#
run_in_thread()[source]#
stop()[source]#
class superduperdb.server.app.SuperDuperApp(service='vector_search', port=8000)[source]#

Bases: object

This is a wrapper class that prepares helper functions used to create a fastapi application in the realm of superduperdb.

add(*args, method='post', **kwargs)[source]#

Register an endpoint with this method.

add_default_endpoints()[source]#

Add a list of default endpoints which comes out of the box with SuperDuperApp

property app#
property db#
pre_start(cfg=None)[source]#
print_routes()[source]#
shutdown(function=None)[source]#

This method is used to register a shutdown function

start()[source]#

This method is used to start the application server

startup(function=None, cfg=None)[source]#

This method is used to register a startup function

superduperdb.server.app.database(request: Request) Datalayer[source]#

superduperdb.server.cluster module#

superduperdb.server.cluster.local_cluster(db)[source]#

This method is used to create a local cluster consisting of Vector search service, cdc service and dask setup.

Once this cluster is up, user can offload vector search, cdc on these services.

Module contents#