software.amazon.jdbc.plugin.cache

Class RemoteQueryCachePlugin

java.lang.Object

software.amazon.jdbc.plugin.AbstractConnectionPlugin

software.amazon.jdbc.plugin.cache.RemoteQueryCachePlugin

All Implemented Interfaces:

ConnectionPlugin, StateSnapshotProvider

public class RemoteQueryCachePlugin
extends AbstractConnectionPlugin
implements StateSnapshotProvider

This plugin provides query result caching capability which stores cacheable query results from database in a remote Valkey cache server. Error responses from the database are not cached. Users can opt-in per query using a SQL query hint that specifies a time‑to‑live (TTL). Once a particular query result is cached, subsequent identical queries are served directly from the cache while the TTL is valid.

Constructor Summary

Constructors

Constructor and Description
RemoteQueryCachePlugin(FullServicesContainer servicesContainer, java.util.Properties properties)

Method Summary

Modifier and Type	Method and Description
<T,E extends java.lang.Exception> T	execute(java.lang.Class<T> resultClass, java.lang.Class<E> exceptionClass, java.lang.Object methodInvokeOn, java.lang.String methodName, JdbcCallable<T,E> jdbcMethodFunc, @Nullable java.lang.Object[] jdbcMethodArgs)
protected @Nullable java.lang.String	getQuery(java.lang.Object methodInvokeOn, @Nullable java.lang.Object[] jdbcMethodArgs)
java.util.List<Pair<java.lang.String,java.lang.Object>>	getSnapshotState()
java.util.Set<java.lang.String>	getSubscribedMethods()
protected @Nullable java.lang.Integer	getTtlForQuery(@Nullable java.lang.String queryHint) Determine the TTL based on an input query.
protected void	setCacheConnection(CacheConnection conn)

Methods inherited from class software.amazon.jdbc.plugin.AbstractConnectionPlugin

acceptsStrategy, connect, forceConnect, getHostSpecByStrategy, getHostSpecByStrategy, initHostProvider, notifyConnectionChanged, notifyNodeListChanged

Methods inherited from class java.lang.Object

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

Constructor Detail

RemoteQueryCachePlugin

public RemoteQueryCachePlugin(FullServicesContainer servicesContainer,
                              java.util.Properties properties)

Method Detail

setCacheConnection

protected void setCacheConnection(CacheConnection conn)

getSubscribedMethods

public java.util.Set<java.lang.String> getSubscribedMethods()

Specified by:

getSubscribedMethods in interface ConnectionPlugin

Specified by:

getSubscribedMethods in class AbstractConnectionPlugin

getTtlForQuery

protected @Nullable java.lang.Integer getTtlForQuery(@Nullable java.lang.String queryHint)

Determine the TTL based on an input query.

Parameters:

queryHint - string. e.g. "CACHE_PARAM(ttl=100s, key=custom)"

Returns:

TTL in seconds to cache the query. null if the query is not cacheable.

execute

public <T,E extends java.lang.Exception> T execute(java.lang.Class<T> resultClass,
                                                   java.lang.Class<E> exceptionClass,
                                                   java.lang.Object methodInvokeOn,
                                                   java.lang.String methodName,
                                                   JdbcCallable<T,E> jdbcMethodFunc,
                                                   @Nullable java.lang.Object[] jdbcMethodArgs)
                                            throws E extends java.lang.Exception

Specified by:

execute in interface ConnectionPlugin

Overrides:

execute in class AbstractConnectionPlugin

Throws:

E extends java.lang.Exception

getQuery

protected @Nullable java.lang.String getQuery(java.lang.Object methodInvokeOn,
                                              @Nullable java.lang.Object[] jdbcMethodArgs)

getSnapshotState

public java.util.List<Pair<java.lang.String,java.lang.Object>> getSnapshotState()

Specified by:

getSnapshotState in interface StateSnapshotProvider

Overrides:

getSnapshotState in class AbstractConnectionPlugin