Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.activeviam.com/llms.txt

Use this file to discover all available pages before exploring further.

final class atoti_jdbc.UserContentStorageConfig

The config for storing user content in a separate database.

Example

>>> from atoti_jdbc import UserContentStorageConfig
>>> config = UserContentStorageConfig(
...     "h2:/home/user/database/file/path;USER=username;PASSWORD=passwd"
... )

driver : Annotated[str | None, AfterValidator(_validate_driver)] = None

The Java class name of the driver to use. This defines Hibernate’s DRIVER option. Inferred from url if None.

hibernate_options : FrozenMapping[str, str] = frozendict({})

Extra options to pass to Hibernate. See AvailableSettings.

prefix : str | None = None

The prefix to add to all paths when reading and writing files and directories. This allows sharing the same database in multiple Atoti applications without conflicts.

url : Annotated[str, AfterValidator(normalize_jdbc_url)]

The JDBC connection string of the database. The "jdbc" scheme is optional but the database specific scheme (such as "h2") is mandatory. For instance:
  • "h2:/home/user/database/file/path;USER=username;PASSWORD=passwd"
  • "postgresql://postgresql.db.server:5430/example?user=username&password=passwd"
More examples can be found here. This defines Hibernate’s URL option.