public class SqlClient extends QueryClient
SqlClient
class provides the basic APIs for database queries.
SqlClient
works with ORACLE, SYBASE, MS SQL server, and DB2.
QueryClient
reference.QueryClient
BaseClient.FilteredMethodsHandler
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
JDBC_DRIVERS |
static java.lang.String |
JDBC_PRE_URLS |
static java.lang.String |
JDBC_RESOURCE_DIR |
static java.lang.String |
UAVAILABLE_DB_VERSION |
CREDENTIALS_ID, ENCODING
Constructor and Description |
---|
SqlClient(ClientsFrameworkImpl framework,
java.util.Properties props) |
Modifier and Type | Method and Description |
---|---|
ResultSet |
doCall(java.lang.String sqlStatement)
Executes a
Select or Update query. |
ResultSet |
doCall(java.lang.String sqlStatement,
int queryTimeout)
Executes a
Select or Update query with the specified timeout. |
ResultSet |
executeQuery(java.lang.String query)
Executes a
Select query. |
ResultSet |
executeQuery(java.lang.String query,
int queryTimeout)
Executes a
Select query with the specified timeout. |
java.lang.String |
getAppVersion()
Returns the version of the database to which the client is connected.
|
java.lang.String |
getDatabaseName()
Returns Oracle SID or the database name from the protocol definition.
|
java.lang.String |
getDbVersion()
Returns the database version number.
|
int |
getPort()
Returns the port on which the database server listens.
|
java.lang.String |
getProtocolDbType()
Returns the database type.
|
int |
getQueryTimeout() |
java.lang.String |
getSid()
Returns the Database System ID(database instance name)
|
ResultSet |
getTable(java.lang.String query)
Deprecated.
|
ResultSet |
getTable(java.lang.String query,
int queryTimeout)
Deprecated.
|
java.lang.String |
getWorkingDatabase()
Returns the name of the schema to which the client is connected.
|
void |
setQueryTimeout(int queryTimeout) |
void |
setWorkingDatabase(java.lang.String dbName)
Sets the database schema name to which the client connects.
|
addDeniedPackage, close, getClientType, getCredentialId, getIpAddress, getProperty, getShellCmdSeperator, getSudoCommands, getSudoPaths, getTimeout, getUserName, isConnected, setAttributeEncrypted, supportsSudo
public static final java.lang.String JDBC_RESOURCE_DIR
public static final java.lang.String UAVAILABLE_DB_VERSION
public static final java.lang.String JDBC_DRIVERS
public static final java.lang.String JDBC_PRE_URLS
public SqlClient(ClientsFrameworkImpl framework, java.util.Properties props) throws java.lang.Exception
java.lang.Exception
public int getQueryTimeout()
public void setQueryTimeout(int queryTimeout)
public java.lang.String getSid()
public java.lang.String getDatabaseName()
public void setWorkingDatabase(java.lang.String dbName) throws java.lang.Exception
dbName
- The schema namejava.lang.Exception
public java.lang.String getWorkingDatabase() throws java.lang.Exception
getWorkingDatabase
uses the database specified in the credentials.java.lang.Exception
public ResultSet executeQuery(java.lang.String query) throws java.lang.Exception
Select
query.
executeQuery
in class QueryClient
query
- An SQL query statementResultSet
java.lang.Exception
ResultSet
public ResultSet executeQuery(java.lang.String query, int queryTimeout) throws java.lang.Exception
Select
query with the specified timeout.
query
- An SQL query statementqueryTimeout
- The timeout in millisecondsResultSet
java.lang.Exception
ResultSet
public ResultSet getTable(java.lang.String query) throws java.lang.Exception
executeQuery(java.lang.String)
Select
query.
query
- sql query statementjava.lang.Exception
ResultSet
public ResultSet getTable(java.lang.String query, int queryTimeout) throws java.lang.Exception
executeQuery(java.lang.String)
Select
query.
query
- sql query statementqueryTimeout
- The timeout in millisecondsjava.lang.Exception
ResultSet
public ResultSet doCall(java.lang.String sqlStatement) throws java.lang.Exception
Select
or Update
query.
sqlStatement
- An SQL statementResultSet
java.lang.Exception
ResultSet
public ResultSet doCall(java.lang.String sqlStatement, int queryTimeout) throws java.lang.Exception
Select
or Update
query with the specified timeout.
sqlStatement
- An SQL statementqueryTimeout
- The timeout in millisecondsResultSet
java.lang.Exception
ResultSet
public java.lang.String getProtocolDbType()
public int getPort()
public java.lang.String getDbVersion()
public java.lang.String getAppVersion()
Documentation Feedback
Copyright 2012 Micro Focus or one of its affiliates.