Skip to main content
atoti.SessionConfig(
    *,
    ai: AiConfig | None = None,
    app_extensions: Mapping[str, Path] = frozendict({}),
    base_path: str = '/',
    branding: BrandingConfig | None = None,
    extra_jars: Sequence[Path] = (),
    i18n: I18nConfig | None = None,
    java_options: Sequence[str] = (),
    limits: LimitsConfig | None = None,
    logging: LoggingConfig | None = None,
    observability: ObservabilityConfig | None = None,
    port: int = 0,
    ready: bool = True,
    security: SecurityConfig | None = None,
    user_content_storage: Path | UserContentStorageConfig | None = None,
)
The config passed to atoti.Session.start().

​
Attributes

​
ai

AiConfig | None

​
app_extensions

Mapping from the name of an Atoti UI extension (i.e. name property in their package.json) to the path of its dist directory.
This feature is not part of the community edition: it needs to be unlocked.
Atoti UI extensions can enhance the app in many ways such as:
  • Adding new widget plugins.
  • Attaching custom menu items or titlebar buttons to a set of widgets.
  • Providing other React contexts to the components rendered by the app.
See also: Prebuilt extensions in atoti.app_extension.

​
base_path

Path from which the session is served. atoti.Session.url includes it. : For example, with base_path="/foo/bar", url will be http://localhost:{port}/foo/bar.

​
branding

BrandingConfig | None

​
extra_jars

Paths of JARs to add to the classpath of the Java subprocess.

​
i18n

I18nConfig | None

​
java_options

Additional options to pass when starting the Java subprocess (e.g. for optimization or debugging purposes). In particular, the -Xmx option can be set to increase the amount of RAM that the session can use. If this option is not specified, the JVM default memory setting is used which is 25% of the machine memory.
These options are passed as is to the Java subprocess with no guarantee that the Session will behave as expected. Options that work with one version of Atoti Python SDK may break with another, even across a bugfix release.

​
limits

LimitsConfig | None

​
logging

LoggingConfig | None

​
observability

ObservabilityConfig | None

​
port

Port on which the session will listen to. If 0, the OS will pick an available port.

​
ready

Initial value of atoti.Session.ready.

​
security

SecurityConfig | None

​
user_content_storage

Config controlling how user content is stored. If a Path is given, the content will be stored in the corresponding directory. If None, the content will be stored in memory and will be lost when the session is closed. When not None and the observability plugin is enabled, the history of executed queries is also recorded and accessible in Admin UI (f"{session.url}/admin") under the Query history tab.