Package com.inductiveautomation.ignition.common.rpc.impl

Interface NamedQueryRpc

public interface NamedQueryRpc

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final record	NamedQueryRpc.JavaSerializedPayload

Field Summary

Fields

Modifier and Type	Field	Description
static final RpcSerializer	SERIALIZER

Method Summary

Modifier and Type	Method	Description
String	beginTransaction(@NonNull String projectName, String datasource, int isolationLevel, long timeout)
void	clearCache(@NonNull String project, List<String> namedQueries)	Clears the caches of the specified named queries in the project.
NamedQueryRpc.JavaSerializedPayload	execute(@NonNull String project, String queryPath, NamedQueryRpc.JavaSerializedPayload parameters, String tx, boolean getKey)
boolean	executeSFQuery(@NonNull String project, String path, NamedQueryRpc.JavaSerializedPayload parameters)
NamedQueryRpc.JavaSerializedPayload	executeUnsaved(@NonNull String project, NamedQuery query, NamedQueryRpc.JavaSerializedPayload parameters, boolean canCache, boolean canLimit, String tx, boolean getKey)
Set<String>	getParameters(@NonNull String project, String queryPath)
static <T> T	unwrap(NamedQueryRpc.JavaSerializedPayload javaSerializedPayload)
static NamedQueryRpc.JavaSerializedPayload	wrap(Object any)

Field Details

SERIALIZER

static final RpcSerializer SERIALIZER

Method Details

beginTransaction

String beginTransaction(@NonNull String projectName,
 String datasource,
 int isolationLevel,
 long timeout)
                 throws Exception

Throws:

Exception

execute

NamedQueryRpc.JavaSerializedPayload execute(@NonNull String project,
 String queryPath,
 NamedQueryRpc.JavaSerializedPayload parameters,
 String tx,
 boolean getKey)
                                     throws Exception

Throws:

Exception

executeUnsaved

NamedQueryRpc.JavaSerializedPayload executeUnsaved(@NonNull String project,
 NamedQuery query,
 NamedQueryRpc.JavaSerializedPayload parameters,
 boolean canCache,
 boolean canLimit,
 String tx,
 boolean getKey)
                                            throws Exception

Throws:

Exception

executeSFQuery

boolean executeSFQuery(@NonNull String project,
 String path,
 NamedQueryRpc.JavaSerializedPayload parameters)
                throws Exception

Throws:

Exception

getParameters

Set<String> getParameters(@NonNull String project,
 String queryPath)

clearCache

void clearCache(@NonNull String project,
 List<String> namedQueries)
         throws Exception

Clears the caches of the specified named queries in the project. If the list of named queries is null, all named query caches in the project will be cleared.

Parameters:

project - The project name. Must not be null.

namedQueries - A list of paths to the named queries whose caches should be cleared. If null, all caches will be cleared.

Throws:

Exception - if the project cannot be found or is invalid.

wrap

static NamedQueryRpc.JavaSerializedPayload wrap(Object any)

unwrap

static <T> T unwrap(NamedQueryRpc.JavaSerializedPayload javaSerializedPayload)