Package com.inductiveautomation.ignition.client.script

Class ClientDBUtilities

java.lang.Object

com.inductiveautomation.ignition.common.script.builtin.AbstractDBUtilities

com.inductiveautomation.ignition.client.script.ClientDBUtilities

public class ClientDBUtilities
extends AbstractDBUtilities

These are DB utilities that are common to the client system as a whole (designer, client)

Field Summary

Fields

Modifier and Type	Field	Description
protected final AbstractClientContext	context

Fields inherited from class com.inductiveautomation.ignition.common.script.builtin.AbstractDBUtilities

ARRAY, BIGINT, BINARY, BIT, BLOB, BOOLEAN, CHAR, CLOB, DATALINK, DATE, DECIMAL, DISTINCT, DOUBLE, FLOAT, INTEGER, JAVA_OBJECT, LONGNVARCHAR, LONGVARBINARY, LONGVARCHAR, NCHAR, NCLOB, NULL, NUMERIC, NVARCHAR, ORACLE_CURSOR, OTHER, READ_COMMITTED, READ_UNCOMMITTED, REAL, REF, REPEATABLE_READ, ROWID, SDF_THREAD_LOCAL, SERIALIZABLE, SMALLINT, SQLXML, STRUCT, TIME, TIMESTAMP, TINYINT, VARBINARY, VARCHAR

Constructor Summary

Constructors

Constructor	Description
ClientDBUtilities(AbstractClientContext context)

Method Summary

Modifier and Type	Method	Description
protected String	_beginTransaction(String datasource, int isolationLevel, long timeout)
protected void	_call(SProcCall call)	Calls a stored procedure, so safe for client use without permission check.
protected void	_clearAllQueryCaches(String projectName)
protected void	_clearQueryCache(String project, Set<String> path)
protected void	_closeTransaction(String txId)
protected void	_commitTransaction(String txId)
protected Object	_execNamedQuery(String projectName, String path, Map<String,Object> parameters, String tx, boolean getKey)
protected boolean	_execNamedQueryAsync(String projectName, String path, Map<String,Object> parameters)
protected String	_getDatasourceName(String txId)
protected void	_rollbackTransaction(String txId)
protected Dataset	_runPrepQuery(String query, String datasource, String txId, Object[] args)
protected Integer	_runPrepStmt(String query, String datasource, String txId, boolean getIds, boolean skipAudit, Object[] args)
protected Dataset	_runQuery(String query, String datasource, String txId)
protected Integer	_runUpdateQuery(String query, String datasource, String txId, boolean getIds, boolean skipAudit)
String	beginNamedQueryTransaction(org.python.core.PyObject[] pyArgs, String[] keywords)
void	clearAllNamedQueryCaches()	Deprecated. As of 8.3.0, use AbstractDBUtilities.clearQueryCache(org.python.core.PyObject[], java.lang.String[]) instead.
void	clearNamedQueryCache(org.python.core.PyObject[] values, String[] keywords)	Deprecated. As of 8.3.0, use AbstractDBUtilities.clearQueryCache(org.python.core.PyObject[], java.lang.String[]) instead.
protected List<RpcDatasourceMeta>	findDatasources()
Dataset	getConnectionInfo()
protected Optional<String>	getDefaultProject()
protected Set<String>	getQueryParameters(String project, String queryPath)
Object	runNamedQuery(org.python.core.PyObject[] values, String[] keywords)	Deprecated. As of 8.3.0, use AbstractDBUtilities.execQuery(org.python.core.PyObject[], java.lang.String[]) or AbstractDBUtilities.execUpdate(org.python.core.PyObject[], java.lang.String[]) instead.
boolean	runSFNamedQuery(org.python.core.PyObject[] pyArgs, String[] keywords)	Deprecated. As of 8.3.0, use AbstractDBUtilities.execUpdateAsync(org.python.core.PyObject[], java.lang.String[]) instead.

Methods inherited from class com.inductiveautomation.ignition.common.script.builtin.AbstractDBUtilities

beginTransaction, clearQueryCache, closeTransaction, commitTransaction, createSProcCall, dataSetToCSV, dateFormat, error, execQuery, execSProcCall, execUpdate, execUpdateAsync, extractParameters, extractPath, extractProject, getConnectionInfo, getConnections, getDatasource, getTransactionDatasource, rollbackTransaction, runPrepQuery, runPrepStmt, runPrepStmt, runPrepStmtGetKey, runPrepStmtGetKey, runPrepUpdate, runQuery, runScalarPrepQuery, runScalarQuery, runUpdateQuery, runUpdateQueryGetKey, runUpdateQueryGetKey, toDataset, toDataSet, toDataSet, toPyDataSet

Methods inherited from class java.lang.Object

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

Field Details

context

protected final AbstractClientContext context

Constructor Details

ClientDBUtilities

public ClientDBUtilities(AbstractClientContext context)

Method Details

beginNamedQueryTransaction

public String beginNamedQueryTransaction(org.python.core.PyObject[] pyArgs,
 String[] keywords)
                                  throws Exception

Throws:

Exception

getConnectionInfo

public Dataset getConnectionInfo()

runNamedQuery

@Deprecated(since="8.3.0")
public Object runNamedQuery(org.python.core.PyObject[] values,
 String[] keywords)
                     throws Exception

Deprecated.

As of 8.3.0, use AbstractDBUtilities.execQuery(org.python.core.PyObject[], java.lang.String[]) or AbstractDBUtilities.execUpdate(org.python.core.PyObject[], java.lang.String[]) instead.

This invokes the gateway rpc, which only uses the saved query version. Named queries are "safe", so does not need the ClientProtection annotation.

Returns:

Results of the query. May be null or empty if the query failed or returned no results.

Throws:

GatewayException - If path is invalid or query can't be run.

Exception

getDefaultProject

protected Optional<String> getDefaultProject()

Specified by:

getDefaultProject in class AbstractDBUtilities

_execNamedQuery

protected Object _execNamedQuery(String projectName,
 String path,
 Map<String,Object> parameters,
 String tx,
 boolean getKey)
                          throws Exception

Specified by:

_execNamedQuery in class AbstractDBUtilities

Throws:

Exception

getQueryParameters

@Nonnull
protected Set<String> getQueryParameters(String project,
 String queryPath)

Specified by:

getQueryParameters in class AbstractDBUtilities

runSFNamedQuery

@Deprecated(since="8.3.0")
public boolean runSFNamedQuery(org.python.core.PyObject[] pyArgs,
 String[] keywords)
                        throws Exception

Deprecated.

As of 8.3.0, use AbstractDBUtilities.execUpdateAsync(org.python.core.PyObject[], java.lang.String[]) instead.

Throws:

Exception

_execNamedQueryAsync

protected boolean _execNamedQueryAsync(String projectName,
 String path,
 Map<String,Object> parameters)
                                throws Exception

Specified by:

_execNamedQueryAsync in class AbstractDBUtilities

Throws:

Exception

clearNamedQueryCache

@Deprecated(since="8.3.0")
public void clearNamedQueryCache(org.python.core.PyObject[] values,
 String[] keywords)
                          throws GatewayException

Deprecated.

As of 8.3.0, use AbstractDBUtilities.clearQueryCache(org.python.core.PyObject[], java.lang.String[]) instead.

Clears the cache of the named query specified by the path parameter. Will use published version. May not be null.

Throws:

GatewayException - if the path is malformed.

_clearQueryCache

protected void _clearQueryCache(String project,
 Set<String> path)
                         throws GatewayException

Specified by:

_clearQueryCache in class AbstractDBUtilities

Throws:

GatewayException

clearAllNamedQueryCaches

@Deprecated(since="8.3.0")
public void clearAllNamedQueryCaches()
                              throws GatewayException

Deprecated.

As of 8.3.0, use AbstractDBUtilities.clearQueryCache(org.python.core.PyObject[], java.lang.String[]) instead.

Clears all named query caches for the current project.

Throws:

GatewayException - if there is an error clearing all the named query caches.

_clearAllQueryCaches

protected void _clearAllQueryCaches(String projectName)
                             throws GatewayException

Specified by:

_clearAllQueryCaches in class AbstractDBUtilities

Throws:

GatewayException

_beginTransaction

protected String _beginTransaction(String datasource,
 int isolationLevel,
 long timeout)
                            throws Exception

Specified by:

_beginTransaction in class AbstractDBUtilities

Throws:

Exception

_commitTransaction

protected void _commitTransaction(String txId)
                           throws Exception

Specified by:

_commitTransaction in class AbstractDBUtilities

Throws:

Exception

_rollbackTransaction

protected void _rollbackTransaction(String txId)
                             throws Exception

Specified by:

_rollbackTransaction in class AbstractDBUtilities

Throws:

Exception

_closeTransaction

protected void _closeTransaction(String txId)
                          throws Exception

Specified by:

_closeTransaction in class AbstractDBUtilities

Throws:

Exception

_getDatasourceName

protected String _getDatasourceName(String txId)
                             throws Exception

Specified by:

_getDatasourceName in class AbstractDBUtilities

Throws:

Exception

_runUpdateQuery

protected Integer _runUpdateQuery(String query,
 String datasource,
 String txId,
 boolean getIds,
 boolean skipAudit)
                           throws Exception

Specified by:

_runUpdateQuery in class AbstractDBUtilities

Throws:

Exception

_runPrepStmt

protected Integer _runPrepStmt(String query,
 String datasource,
 String txId,
 boolean getIds,
 boolean skipAudit,
 Object[] args)
                        throws Exception

Specified by:

_runPrepStmt in class AbstractDBUtilities

Throws:

Exception

_runPrepQuery

protected Dataset _runPrepQuery(String query,
 String datasource,
 String txId,
 Object[] args)
                         throws Exception

Specified by:

_runPrepQuery in class AbstractDBUtilities

Throws:

Exception

_runQuery

protected Dataset _runQuery(String query,
 String datasource,
 String txId)
                     throws Exception

Specified by:

_runQuery in class AbstractDBUtilities

Throws:

Exception

findDatasources

protected List<RpcDatasourceMeta> findDatasources()

Specified by:

findDatasources in class AbstractDBUtilities

_call

protected void _call(SProcCall call)
              throws Exception

Calls a stored procedure, so safe for client use without permission check.

Specified by:

_call in class AbstractDBUtilities

Throws:

Exception