com.inductiveautomation.ignition.common.db.namedquery

Interface NamedQueryRpc

All Known Implementing Classes:

NamedQueryClientRpc, NamedQueryDesignerRpc

public interface NamedQueryRpc

This allows NamedQueries to use unsaved queries in the Designer (so other resources can use them without forcing a save), but not the Client.

Method Summary

Modifier and Type	Method and Description
void	clearAllCaches(java.lang.String project) This clears all named query caches for the project.
void	clearCache(java.lang.String project, java.lang.String namedQueries) This clears the named query cache for the path(s) that are passed in the namedQueries parameter.
java.lang.Object	execute(java.lang.Long projectId, NamedQuery query, java.util.Map<java.lang.String,java.lang.Object> parameters, boolean canCache, boolean canLimit)
java.lang.Object	execute(java.lang.Long projectId, java.lang.String queryPath, java.util.Map<java.lang.String,java.lang.Object> parameters, boolean canCache, boolean canLimit)
java.lang.Object	execute(java.lang.String project, NamedQuery query, java.util.Map<java.lang.String,java.lang.Object> parameters, boolean useLimit, int limit) Deprecated.
java.lang.Object	execute(java.lang.String project, java.lang.String queryPath, java.util.Map<java.lang.String,java.lang.Object> parameters) Deprecated.
java.lang.Object	execute(java.lang.String project, java.lang.String queryPath, java.util.Map<java.lang.String,java.lang.Object> parameters, boolean useLimit, int limit) Deprecated.

Method Detail

execute

java.lang.Object execute(java.lang.Long projectId,
                         java.lang.String queryPath,
                         java.util.Map<java.lang.String,java.lang.Object> parameters,
                         boolean canCache,
                         boolean canLimit)
                  throws java.lang.Exception

Throws:

java.lang.Exception

execute

java.lang.Object execute(java.lang.Long projectId,
                         NamedQuery query,
                         java.util.Map<java.lang.String,java.lang.Object> parameters,
                         boolean canCache,
                         boolean canLimit)
                  throws java.lang.Exception

Throws:

java.lang.Exception

execute

@Deprecated
java.lang.Object execute(java.lang.String project,
                                     java.lang.String queryPath,
                                     java.util.Map<java.lang.String,java.lang.Object> parameters)
                              throws java.lang.Exception

Deprecated.

Throws:

java.lang.Exception

execute

@Deprecated
java.lang.Object execute(java.lang.String project,
                                     java.lang.String queryPath,
                                     java.util.Map<java.lang.String,java.lang.Object> parameters,
                                     boolean useLimit,
                                     int limit)
                              throws java.lang.Exception

Deprecated.

Executes a named query. useLimit/limit overload for user testing of queries.

Parameters:

project - The project name.

queryPath - Full query path

parameters - Optional query parameters

useLimit - Testing may limit the number of results. Default true.

limit - If useLimit, the limit to use, else ignored.

Returns:

Result of the query. May be null or empty.

Throws:

java.lang.Exception - Throws exception if path not found or sql error.

execute

@Deprecated
java.lang.Object execute(java.lang.String project,
                                     NamedQuery query,
                                     java.util.Map<java.lang.String,java.lang.Object> parameters,
                                     boolean useLimit,
                                     int limit)
                              throws java.lang.Exception

Deprecated.

This overload is used by the Designer to run unsaved versions of queries. Returns null in the client context.

Parameters:

project - The project name.

query - A named query resource.

parameters - Map of parameter values

useLimit - Testing may limit the number of results. Default true.

limit - If useLimit, the limit to use, else ignored.

Returns:

Result of the query. May be null or empty.

Throws:

java.lang.Exception - Throws exception if path not found or sql error.

clearCache

void clearCache(java.lang.String project,
                java.lang.String namedQueries)
         throws java.lang.Exception

This clears the named query cache for the path(s) that are passed in the namedQueries parameter. This may be a list if implemented on the gateway but not on the client.

Parameters:

project - The project name. Must not be null or empty

namedQueries - a String (or String array on gateway) containing the paths to the named query resources to clear. Must not be null or empty

Throws:

java.lang.Exception - if the cache(s) cannot be cleared

clearAllCaches

void clearAllCaches(java.lang.String project)
             throws java.lang.Exception

This clears all named query caches for the project.

Parameters:

project - The project name. Must not be null or empty

Throws:

java.lang.Exception - if the caches cannot be cleared.