Benchling session

BenchlingService: class

The BenchlingService class takes in a BenchlingConnection object and is used to directly interact with Benchling's SDK, internal API, and Postgres warehouse. This class is surfaced for users so that there is one standard interface for interacting with Benchling around your codebase. Liminal's BenchlingService handles all session management and is a subclass of Benchling's SDK, so all functionality of Benchling's SDK is available.

BenchlingService can be used to build on top of Liminal's ORM. Below is an example of how to use the BenchlingService class.

from liminal.connection import BenchlingConnection
from liminal.connection import BenchlingService

connection = BenchlingConnection(
    ...
)
benchling_service = BenchlingService(connection, use_internal_api=True, use_warehouse=True) # enable all connections

# Use Benchling SDK
entity = benchling_service.custom_entities.get_by_id("my-entity-id")

# Use to query Postgres warehouse using SQLAlchemy
with benchling_service() as session:
    entity = session.query(Pizza).all()

Parameters

connection: BenchlingConnection

The connection object that contains the credentials for the Benchling tenant.

use_api: bool

Whether to connect to the Benchling SDK. Defaults to True. (See Benchling SDK documentation here)

use_internal_api: bool

Whether to connect to the Benchling internal API. Defaults to False.

use_warehouse: bool

Whether to connect to the Benchling Postgres warehouse. Defaults to False. See SQLAlchemy documentation here for more information.