Package com.inductiveautomation.ignition.common.db.rpc

Interface QueryRpc

public interface QueryRpc

This interface is not used directly for rpc calls, because methods here relies on streaming. There's an implementation for calls on the client-side.

Method Summary

Modifier and Type	Method	Description
void	prepQuery(String query, String datasourceName, byte[] encodedParams, Integer limit, String transactionId)
List<Integer>	prepUpdate(String query, String datasourceName, byte[] encodedParams, String transactionId, boolean skipAudit, boolean getKey)	Execute a query and will one of the following: 1.
void	query(String query, String datasourceName, Integer limit, String transactionId)
List<Integer>	update(String query, String datasourceName, String transactionId, boolean skipAudit, boolean getKey)	Execute a query and will one of the following: 1.

Method Details

query

void query(String query,
 String datasourceName,
 Integer limit,
 String transactionId)
    throws Exception

Throws:

Exception

prepQuery

void prepQuery(String query,
 String datasourceName,
 byte[] encodedParams,
 Integer limit,
 String transactionId)
        throws Exception

Throws:

Exception

update

List<Integer> update(String query,
 String datasourceName,
 String transactionId,
 boolean skipAudit,
 boolean getKey)
              throws Exception

Execute a query and will one of the following: 1. Return the generated key if getKey is true 2. Return the number of rows affected if getKey is false

Parameters:

query - The query to execute

datasourceName - The name of the datasource to execute the query on

transactionId - The transaction id to use for this query

skipAudit - Whether to skip auditing this query

getKey - Whether to return the generated key

Returns:

The generated key or the number of rows affected

Throws:

Exception - If an error occurs.

prepUpdate

List<Integer> prepUpdate(String query,
 String datasourceName,
 byte[] encodedParams,
 String transactionId,
 boolean skipAudit,
 boolean getKey)
                  throws Exception

Execute a query and will one of the following: 1. Return the generated key if getKey is true 2. Return the number of rows affected if getKey is false

Parameters:

query - The query to execute

datasourceName - The name of the datasource to execute the query on

transactionId - The transaction id to use for this query

skipAudit - Whether to skip auditing this query

getKey - Whether to return the generated key

Returns:

The generated key or the number of rows affected

Throws:

Exception - If an error occurs.