Package org.bsc.langgraph4j.checkpoint

Class AbstractMysqlServer

java.lang.Object

org.bsc.langgraph4j.checkpoint.AbstractCheckpointSaver

org.bsc.langgraph4j.checkpoint.AbstractMysqlServer

All Implemented Interfaces:

BaseCheckpointSaver, LG4JLoggable

Direct Known Subclasses:

MysqlSaver

public abstract class AbstractMysqlServer
extends AbstractCheckpointSaver
implements LG4JLoggable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	AbstractMysqlServer.AbstractBuilder<B extends AbstractMysqlServer.AbstractBuilder<B>>	A builder for MysqlSaver.

Nested classes/interfaces inherited from interface org.bsc.langgraph4j.checkpoint.BaseCheckpointSaver

BaseCheckpointSaver.SubGraphSaver, BaseCheckpointSaver.Tag

Field Summary

Fields

Modifier and Type	Field	Description
protected final CreateOption	createOption
protected final DataSource	dataSource
protected final com.fasterxml.jackson.databind.ObjectMapper	objectMapper
protected final SqlResource.Commands	sqlCommands
protected final StateSerializer<? extends AgentState>	stateSerializer

Fields inherited from interface org.bsc.langgraph4j.checkpoint.BaseCheckpointSaver

THREAD_ID_DEFAULT

Fields inherited from interface org.bsc.langgraph4j.LG4JLoggable

log

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractMysqlServer(AbstractMysqlServer.AbstractBuilder<?> builder)	protected constructor used by the builder to create a new instance of MysqlSaver.

Method Summary

Modifier and Type	Method	Description
Collection<Checkpoint>	clearCheckpointsCache(String threadId)	Deprecated, for removal: This API element is subject to removal in a future version. this method do nothing because currently this saver don't use cache anymore
protected void	initTables()	Initializes the database according the create options.
protected void	insertedCheckpoint(RunnableConfig config, LinkedList<Checkpoint> checkpoints, Checkpoint checkpoint)	Inserts a checkpoint to the database
protected LinkedList<Checkpoint>	loadCheckpoints(RunnableConfig config)	If the list of checkpoints is empty, loads the checkpoints from the database.
<State extends AgentState> CompletableFuture<InterruptionMetadata<State>>	registerInterruption(RunnableConfig config, InterruptionMetadata<State> interruptionMetadata)	Register Interrupt of the execution for the given config and provide interruption metadata.
protected BaseCheckpointSaver.Tag	releaseCheckpoints(RunnableConfig config, LinkedList<Checkpoint> checkpoints, String message)	Marks the checkpoints as released
protected BaseCheckpointSaver.Tag	releaseCheckpointsOnError(RunnableConfig config, LinkedList<Checkpoint> checkpoints, Exception exception)
Optional<BaseCheckpointSaver.Tag>	tag(RunnableConfig config, Integer version)
protected void	updatedCheckpoint(RunnableConfig config, LinkedList<Checkpoint> checkpoints, Checkpoint checkpoint)	If the checkpoint exists, updates the checkpoint, otherwise it inserts it.

Methods inherited from class org.bsc.langgraph4j.checkpoint.AbstractCheckpointSaver

get, list, listSubGraphSaver, put, putSubGraphSaver, release, release, releaseOnError

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.bsc.langgraph4j.checkpoint.BaseCheckpointSaver

lastTag, threadId

Field Details

dataSource

protected final DataSource dataSource

createOption

protected final CreateOption createOption

objectMapper

protected final com.fasterxml.jackson.databind.ObjectMapper objectMapper

stateSerializer

protected final StateSerializer<? extends AgentState> stateSerializer

sqlCommands

protected final SqlResource.Commands sqlCommands

Constructor Details

AbstractMysqlServer

protected AbstractMysqlServer(AbstractMysqlServer.AbstractBuilder<?> builder)
                       throws Exception

protected constructor used by the builder to create a new instance of MysqlSaver.

Parameters:

builder - Builder instance

Throws:

Exception

Method Details

initTables

protected void initTables()
                   throws Exception

Initializes the database according the create options.

Throws:

Exception

loadCheckpoints

protected LinkedList<Checkpoint> loadCheckpoints(RunnableConfig config)
                                          throws Exception

If the list of checkpoints is empty, loads the checkpoints from the database.

Specified by:

loadCheckpoints in class AbstractCheckpointSaver

Parameters:

config - the configuration

Returns:

a list of checkpoints

Throws:

Exception - if an error occurs while the checkpoints are being loaded from the database.

insertedCheckpoint

protected void insertedCheckpoint(RunnableConfig config,
 LinkedList<Checkpoint> checkpoints,
 Checkpoint checkpoint)
                           throws Exception

Inserts a checkpoint to the database

Specified by:

insertedCheckpoint in class AbstractCheckpointSaver

Parameters:

config - the configuration

checkpoints - the list of checkpoints

checkpoint - the checkpoint to insert

Throws:

Exception - if an error occurs while inserting the checkpoint in the database.

releaseCheckpoints

protected BaseCheckpointSaver.Tag releaseCheckpoints(RunnableConfig config,
 LinkedList<Checkpoint> checkpoints,
 String message)
                                              throws Exception

Marks the checkpoints as released

Specified by:

releaseCheckpoints in class AbstractCheckpointSaver

Parameters:

config - the configuration

checkpoints - the checkpoints

Throws:

Exception - if an error occurs while marking the checkpoints as released

releaseCheckpointsOnError

protected BaseCheckpointSaver.Tag releaseCheckpointsOnError(RunnableConfig config,
 LinkedList<Checkpoint> checkpoints,
 Exception exception)
                                                     throws Exception

Specified by:

releaseCheckpointsOnError in class AbstractCheckpointSaver

Throws:

Exception

registerInterruption

public <State extends AgentState>
CompletableFuture<InterruptionMetadata<State>> registerInterruption(RunnableConfig config,
 InterruptionMetadata<State> interruptionMetadata)

Description copied from interface: BaseCheckpointSaver

Register Interrupt of the execution for the given config and provide interruption metadata. this is used internally and should not be called directly by the user.

Specified by:

registerInterruption in interface BaseCheckpointSaver

Parameters:

config - the RunnableConfig for which to register the interruption

interruptionMetadata - the metadata associated with the interruption

tag

public Optional<BaseCheckpointSaver.Tag> tag(RunnableConfig config,
 Integer version)
                                      throws Exception

Specified by:

tag in interface BaseCheckpointSaver

Throws:

Exception

updatedCheckpoint

protected void updatedCheckpoint(RunnableConfig config,
 LinkedList<Checkpoint> checkpoints,
 Checkpoint checkpoint)
                          throws Exception

If the checkpoint exists, updates the checkpoint, otherwise it inserts it.

Specified by:

updatedCheckpoint in class AbstractCheckpointSaver

Parameters:

config - the configuration

checkpoints - the list of checkpoints

checkpoint - the checkpoint

Throws:

Exception - if an error occurs while inserting or updating the checkpoint.

clearCheckpointsCache

@Deprecated(forRemoval=true)
public Collection<Checkpoint> clearCheckpointsCache(String threadId)

Deprecated, for removal: This API element is subject to removal in a future version.

this method do nothing because currently this saver don't use cache anymore

Removes the cached checkpoints associated with the given thread identifier from the in-memory cache.

Parameters:

threadId - the thread identifier whose cached checkpoints must be cleared

Returns:

the checkpoints removed from the cache, or an empty collection if no cached checkpoints exist