singlestoredb.server.docker.start

singlestoredb.server.docker.start(name: str | None = None, password: str | None = None, license: str | None = None, enable_kai: bool = False, server_port: int | None = None, studio_port: int | None = None, data_api_port: int | None = None, kai_port: int | None = None, hostname: str | None = None, data_dir: str | None = None, logs_dir: str | None = None, server_dir: str | None = None, global_vars: Dict[str, Any] | None = None, init_sql: str | None = None, image: str = 'ghcr.io/singlestore-labs/singlestoredb-dev:latest', database: str | None = None) → SingleStoreDB

Manager for SingleStoreDB server running in Docker.

Parameters:

  • name (str, optional) – Name of the container.

  • password (str, optional) – Password for the SingleStoreDB server.

  • license (str, optional) – License key for SingleStoreDB.

  • enable_kai (bool, optional) – Enable Kai (MongoDB) server.

  • server_port (int, optional) – Port for the SingleStoreDB server.

  • studio_port (int, optional) – Port for the SingleStoreDB Studio.

  • data_api_port (int, optional) – Port for the SingleStoreDB Data API.

  • kai_port (int, optional) – Port for the Kai server.

  • hostname (str, optional) – Hostname for the container.

  • data_dir (str, optional) – Path to the data directory.

  • logs_dir (str, optional) – Path to the logs directory.

  • server_dir (str, optional) – Path to the server directory.

  • global_vars (dict, optional) – Global variables to set in the SingleStoreDB server.

  • init_sql (str, optional) – Path to an SQL file to run on startup.

  • image (str, optional) – Docker image to use.

  • database (str, optional) – Default database to connect to.