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 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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected java.lang.String
_beginTransaction(java.lang.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
_closeTransaction(java.lang.String txId)
protected void
_commitTransaction(java.lang.String txId)
protected java.util.List<? extends DatasourceMeta>
_findDatasources()
protected void
_rollbackTransaction(java.lang.String txId)
protected Dataset
_runPrepQuery(java.lang.String query, java.lang.String datasource, java.lang.String txId, java.lang.Object[] args)
protected java.lang.Integer
_runPrepStmt(java.lang.String query, java.lang.String datasource, java.lang.String txId, boolean getIds, boolean skipAudit, java.lang.Object[] args)
protected Dataset
_runQuery(java.lang.String query, java.lang.String datasource, java.lang.String txId)
protected java.lang.Integer
_runUpdateQuery(java.lang.String q, java.lang.String datasource, java.lang.String txId, boolean getIds, boolean skipAudit)
java.lang.String
beginNamedQueryTransaction(org.python.core.PyObject[] pyArgs, java.lang.String[] keywords)
void
clearAllNamedQueryCaches()
Clears all named query caches for the current project.void
clearNamedQueryCache(org.python.core.PyObject[] values, java.lang.String[] keywords)
Clears the cache of the named query specified by the path parameter.Dataset
getConnectionInfo()
java.lang.Object
runNamedQuery(org.python.core.PyObject[] values, java.lang.String[] keywords)
This invokes the gateway rpc, which only uses the saved query version.boolean
runSFNamedQuery(org.python.core.PyObject[] pyArgs, java.lang.String[] keywords)
-
Methods inherited from class com.inductiveautomation.ignition.common.script.builtin.AbstractDBUtilities
beginTransaction, closeTransaction, commitTransaction, createSProcCall, dataSetToCSV, dateFormat, error, execSProcCall, getConnectionInfo, getConnections, getDatasource, rollbackTransaction, runPrepQuery, runPrepStmt, runPrepStmt, runPrepStmtGetKey, runPrepStmtGetKey, runPrepUpdate, runQuery, runScalarPrepQuery, runScalarQuery, runUpdateQuery, runUpdateQueryGetKey, runUpdateQueryGetKey, toDataset, toDataSet, toDataSet, toPyDataSet
-
-
-
-
Field Detail
-
context
protected final AbstractClientContext context
-
-
Constructor Detail
-
ClientDBUtilities
public ClientDBUtilities(AbstractClientContext context)
-
-
Method Detail
-
beginNamedQueryTransaction
public java.lang.String beginNamedQueryTransaction(org.python.core.PyObject[] pyArgs, java.lang.String[] keywords) throws java.lang.Exception
- Throws:
java.lang.Exception
-
getConnectionInfo
public Dataset getConnectionInfo()
-
runNamedQuery
public java.lang.Object runNamedQuery(org.python.core.PyObject[] values, java.lang.String[] keywords) throws java.lang.Exception
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.java.lang.Exception
-
runSFNamedQuery
public boolean runSFNamedQuery(org.python.core.PyObject[] pyArgs, java.lang.String[] keywords) throws java.lang.Exception
- Throws:
java.lang.Exception
-
clearNamedQueryCache
public void clearNamedQueryCache(org.python.core.PyObject[] values, java.lang.String[] keywords) throws GatewayException
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.
-
clearAllNamedQueryCaches
public void clearAllNamedQueryCaches() throws GatewayException
Clears all named query caches for the current project.- Throws:
GatewayException
- if there is an error clearing all the named query caches.
-
_beginTransaction
protected java.lang.String _beginTransaction(java.lang.String datasource, int isolationLevel, long timeout) throws java.lang.Exception
- Specified by:
_beginTransaction
in classAbstractDBUtilities
- Throws:
java.lang.Exception
-
_commitTransaction
protected void _commitTransaction(java.lang.String txId) throws java.lang.Exception
- Specified by:
_commitTransaction
in classAbstractDBUtilities
- Throws:
java.lang.Exception
-
_rollbackTransaction
protected void _rollbackTransaction(java.lang.String txId) throws java.lang.Exception
- Specified by:
_rollbackTransaction
in classAbstractDBUtilities
- Throws:
java.lang.Exception
-
_closeTransaction
protected void _closeTransaction(java.lang.String txId) throws java.lang.Exception
- Specified by:
_closeTransaction
in classAbstractDBUtilities
- Throws:
java.lang.Exception
-
_runUpdateQuery
protected java.lang.Integer _runUpdateQuery(java.lang.String q, java.lang.String datasource, java.lang.String txId, boolean getIds, boolean skipAudit) throws java.lang.Exception
- Specified by:
_runUpdateQuery
in classAbstractDBUtilities
- Throws:
java.lang.Exception
-
_runPrepStmt
protected java.lang.Integer _runPrepStmt(java.lang.String query, java.lang.String datasource, java.lang.String txId, boolean getIds, boolean skipAudit, java.lang.Object[] args) throws java.lang.Exception
- Specified by:
_runPrepStmt
in classAbstractDBUtilities
- Throws:
java.lang.Exception
-
_runPrepQuery
protected Dataset _runPrepQuery(java.lang.String query, java.lang.String datasource, java.lang.String txId, java.lang.Object[] args) throws java.lang.Exception
- Specified by:
_runPrepQuery
in classAbstractDBUtilities
- Throws:
java.lang.Exception
-
_runQuery
protected Dataset _runQuery(java.lang.String query, java.lang.String datasource, java.lang.String txId) throws java.lang.Exception
- Specified by:
_runQuery
in classAbstractDBUtilities
- Throws:
java.lang.Exception
-
_findDatasources
protected java.util.List<? extends DatasourceMeta> _findDatasources()
- Specified by:
_findDatasources
in classAbstractDBUtilities
-
_call
protected void _call(SProcCall call) throws java.lang.Exception
Calls a stored procedure, so safe for client use without permission check.- Specified by:
_call
in classAbstractDBUtilities
- Throws:
java.lang.Exception
-
-