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

Interface DatasourceRpc

public interface DatasourceRpc

Provides RPC methods for working with datasources. Includes methods for working with

• DatasourceMeta
• Transactions
• Stored Procedures

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final record	DatasourceRpc.ColumnMetaInfo
static final record	DatasourceRpc.DatasourceMetaInfo

Field Summary

Fields

Modifier and Type	Field	Description
static final ProtoRpcSerializer	SERIALIZER

Method Summary

Modifier and Type	Method	Description
String	beginTransaction(String datasource, int isolationLevel, long timeout)
SProcCall	call(SProcCall call)
void	closeTransaction(String txId)
void	commitTransaction(String txId)
String	getColumnQuoteChar(String dataSource)
List<RpcDatasourceMeta>	getConnections()
String	getDatasourceName(String txId)
List<DatasourceRpc.DatasourceMetaInfo>	getDatasources()
Table	getTableInfo(String dataSource, String tableName, TableType type)
List<String>	getTables(String dataSource, TableType type)
List<DatasourceRpc.ColumnMetaInfo>	listColumns(@Nullable String dsn, @NotNull String tableName)
List<String>	listTables(@Nullable String dsn)
void	rollbackTransaction(String txId)

Field Details

SERIALIZER

static final ProtoRpcSerializer SERIALIZER

Method Details

getConnections

List<RpcDatasourceMeta> getConnections()

getTables

List<String> getTables(String dataSource,
 TableType type)
                throws Exception

Throws:

Exception

getTableInfo

Table getTableInfo(String dataSource,
 String tableName,
 TableType type)
            throws Exception

Throws:

Exception

getColumnQuoteChar

String getColumnQuoteChar(String dataSource)

call

SProcCall call(SProcCall call)
        throws Exception

Throws:

Exception

beginTransaction

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

Throws:

Exception

commitTransaction

void commitTransaction(String txId)
                throws Exception

Throws:

Exception

rollbackTransaction

void rollbackTransaction(String txId)
                  throws Exception

Throws:

Exception

closeTransaction

void closeTransaction(String txId)
               throws Exception

Throws:

Exception

getDatasourceName

String getDatasourceName(String txId)

Returns:

the datasource that a transaction is running under. If the transaction no longer exists, then an empty String is returned.

getDatasources

List<DatasourceRpc.DatasourceMetaInfo> getDatasources()

listTables

List<String> listTables(@Nullable
 @Nullable String dsn)
                 throws Exception

Throws:

Exception

listColumns

List<DatasourceRpc.ColumnMetaInfo> listColumns(@Nullable
 @Nullable String dsn,
 @NotNull
 @NotNull String tableName)
                                        throws Exception

Throws:

Exception