llm4s-docs
API
Generated with
llm4s-docs/org.llm4s/org.llm4s.agent/org.llm4s.agent.graph/org.llm4s.agent.graph.postgres/PostgresCheckpointerBackend

PostgresCheckpointerBackend

org.llm4s.agent.graph.postgres.PostgresCheckpointerBackend
See thePostgresCheckpointerBackend companion object
@Experimental
final class PostgresCheckpointerBackend extends CheckpointerBackend

Registers PostgresCheckpointer for llm4s.agent.checkpointer.kind = postgres (design 4.54).

Declared in this module's META-INF/services/org.llm4s.agent.graph.spi.CheckpointerBackend, so depending on llm4s-agent-checkpoint-postgres is all it takes. It opens the store over a HikariCP pool of its own (PostgresCheckpointer.open) from llm4s.agent.checkpointer.postgres, whose defaults and bindings are in this module's reference.conf:

  • url (LLM4S_CHECKPOINTER_POSTGRES_URL), jdbc:postgresql://host:port/database, and user (LLM4S_CHECKPOINTER_POSTGRES_USER): required;
  • password (LLM4S_CHECKPOINTER_POSTGRES_PASSWORD): unset for none; never logged or put in an error;
  • schema, callTimeout, connectionTimeout, maxPoolSize: PostgresCheckpointerConfig's, with its defaults.

A class rather than an object because java.util.ServiceLoader instantiates it through a public no-arg constructor.

Attributes

Companion
object
Graph
Supertypes
class Object
trait Matchable
class Any

Members list

Value members

Concrete methods

def open(settings: CheckpointerSettings): Result[CheckpointStore]

Opens the store settings describes.

Opens the store settings describes.

Return a Left rather than throwing - a missing setting, a value the store refuses, a database that cannot be reached - naming the key at fault (CheckpointerSettings.key). Never put a setting's value in an error or a log line: the block may hold a password. A thrown exception is caught and reported, but loses what went wrong.

Attributes

Concrete fields

val kind: String

The llm4s.agent.checkpointer.kind this backend serves; matched case-insensitively.

The llm4s.agent.checkpointer.kind this backend serves; matched case-insensitively.

Attributes

Generated with