org.objectweb.cjdbc.driver.protocol
Class Commands

java.lang.Object
  extended byorg.objectweb.cjdbc.driver.protocol.Commands

public class Commands
extends java.lang.Object

Commands used by the protocol between the C-JDBC driver and controller.

Version:
1.0
Author:
Emmanuel Cecchet , Nicolas Modrzyk *

Field Summary
static int AlterRequest
          Alter Request.
static int Begin
          Begins a new transaction and returns the corresponding transaction identifier.
static int Close
          Close the connection
static int CloseRemoteResultSet
          Closes a remote ResultSet that was opened for streaming.
static int Commit
          Commits a transaction given its id.
static int ConnectionSetCatalog
          Change the current connection catalog
static int CreateRequest
          Create Request.
static int DatabaseMetaDataGetCatalog
          Retrieve the current catalog
static int DatabaseMetaDataGetCatalogs
          Retrieve the list of catalogs
static int DatabaseMetaDataGetColumns
          Used to get the schema columns by calling DatabaseMetaData.getColumns()
static int DatabaseMetaDataGetPrimaryKeys
          Used to get the schema primary keys by calling DatabaseMetaData.getColumns()
static int DatabaseMetaDataGetProcedureColumns
          Used to get the schema procedure columns by calling DatabaseMetaData.getProcedureColumns()
static int DatabaseMetaDataGetProcedures
          Used to get the schema procedures by calling DatabaseMetaData.getProcedures()
static int DatabaseMetaDataGetSchemas
          Retrieve the schemas
static int DatabaseMetaDataGetTablePrivileges
          Retrieve the table privileges
static int DatabaseMetaDataGetTables
          Used to get the schema tables by calling DatabaseMetaData.getTables()
static int DatabaseMetaDataGetTableTypes
          Retrieve the database table types
static int DeleteRequest
          Delete Request.
static int DropRequest
          Drop Request.
static int ExecReadRequest
          Performs a read request and returns the reply.
static int ExecReadStoredProcedure
          Calls a stored procedure and returns the reply (ResultSet).
static int ExecWriteRequest
          Performs a write request and returns the number of rows affected.
static int ExecWriteRequestWithKeys
          Performs a write request and returns the auto generated keys.
static int ExecWriteStoredProcedure
          Calls a stored procedure and returns the number of rows affected (write query).
static int FetchNextResultSetRows
          Fetch next rows of data for ResultSet streaming
static int GetControllerVersionNumber
          Gets the controller version number.
static int GetDatabaseProductName
          Retrieve the list of database product names
static int GetVirtualDatabaseName
          Gets the virtual database name to be used by the client (C-JDBC driver).
static int InsertRequest
          Insert Request.
static int ProtocolVersion
          Protocol version to check that driver is compatible with controller.
static int Reset
          Reset the connection
static int RestoreConnectionState
          Restore a connection state after an automatic reconnection.
static int Rollback
          Rollbacks a transaction given its id.
static int SetAutoCommit
          Command to change the autocommit value from false to true.
static int UpdateRequest
          Update Request.
 
Constructor Summary
Commands()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ProtocolVersion

public static final int ProtocolVersion
Protocol version to check that driver is compatible with controller. Increase this number each time the exchange protocol changes between driver and controller.

See Also:
Constant Field Values

ExecReadRequest

public static final int ExecReadRequest
Performs a read request and returns the reply.

See Also:
VirtualDatabase.execReadRequest(org.objectweb.cjdbc.common.sql.SelectRequest), Constant Field Values

ExecWriteRequest

public static final int ExecWriteRequest
Performs a write request and returns the number of rows affected.

See Also:
VirtualDatabase.execWriteRequest(org.objectweb.cjdbc.common.sql.AbstractWriteRequest), Constant Field Values

ExecWriteRequestWithKeys

public static final int ExecWriteRequestWithKeys
Performs a write request and returns the auto generated keys.

See Also:
VirtualDatabase.execWriteRequestWithKeys(org.objectweb.cjdbc.common.sql.AbstractWriteRequest), Constant Field Values

ExecReadStoredProcedure

public static final int ExecReadStoredProcedure
Calls a stored procedure and returns the reply (ResultSet).

See Also:
VirtualDatabase.execReadStoredProcedure(org.objectweb.cjdbc.common.sql.StoredProcedure), Constant Field Values

ExecWriteStoredProcedure

public static final int ExecWriteStoredProcedure
Calls a stored procedure and returns the number of rows affected (write query).

See Also:
VirtualDatabase.execReadStoredProcedure(org.objectweb.cjdbc.common.sql.StoredProcedure), Constant Field Values

Begin

public static final int Begin
Begins a new transaction and returns the corresponding transaction identifier. This method is called from the driver when Connection.setAutoCommit(boolean)is called with false argument.

See Also:
VirtualDatabase.begin(String), Constant Field Values

Commit

public static final int Commit
Commits a transaction given its id.

See Also:
VirtualDatabase.commit(long), Constant Field Values

Rollback

public static final int Rollback
Rollbacks a transaction given its id.

See Also:
VirtualDatabase.rollback(long), Constant Field Values

Close

public static final int Close
Close the connection

See Also:
Constant Field Values

Reset

public static final int Reset
Reset the connection

See Also:
Constant Field Values

DatabaseMetaDataGetTables

public static final int DatabaseMetaDataGetTables
Used to get the schema tables by calling DatabaseMetaData.getTables()

See Also:
DatabaseMetaData.getTables(String, String, String, String[]), Constant Field Values

GetVirtualDatabaseName

public static final int GetVirtualDatabaseName
Gets the virtual database name to be used by the client (C-JDBC driver).

See Also:
VirtualDatabase.getVirtualDatabaseName(), Constant Field Values

GetControllerVersionNumber

public static final int GetControllerVersionNumber
Gets the controller version number.

See Also:
Controller.getVersionNumber(), Constant Field Values

DatabaseMetaDataGetColumns

public static final int DatabaseMetaDataGetColumns
Used to get the schema columns by calling DatabaseMetaData.getColumns()

See Also:
DatabaseMetaData.getColumns(String, String, String, String), Constant Field Values

DatabaseMetaDataGetPrimaryKeys

public static final int DatabaseMetaDataGetPrimaryKeys
Used to get the schema primary keys by calling DatabaseMetaData.getColumns()

See Also:
DatabaseMetaData.getPrimaryKeys(String, String, String), Constant Field Values

DatabaseMetaDataGetProcedures

public static final int DatabaseMetaDataGetProcedures
Used to get the schema procedures by calling DatabaseMetaData.getProcedures()

See Also:
DatabaseMetaData.getProcedures(String, String, String), Constant Field Values

DatabaseMetaDataGetProcedureColumns

public static final int DatabaseMetaDataGetProcedureColumns
Used to get the schema procedure columns by calling DatabaseMetaData.getProcedureColumns()

See Also:
DatabaseMetaData.getProcedureColumns(java.lang.String, java.lang.String, java.lang.String, java.lang.String), Constant Field Values

DatabaseMetaDataGetCatalogs

public static final int DatabaseMetaDataGetCatalogs
Retrieve the list of catalogs

See Also:
Connection.getCatalogs(), Constant Field Values

DatabaseMetaDataGetCatalog

public static final int DatabaseMetaDataGetCatalog
Retrieve the current catalog

See Also:
Connection.getCatalog(), Constant Field Values

ConnectionSetCatalog

public static final int ConnectionSetCatalog
Change the current connection catalog

See Also:
Connection.setCatalog(java.lang.String), Constant Field Values

DatabaseMetaDataGetTableTypes

public static final int DatabaseMetaDataGetTableTypes
Retrieve the database table types

See Also:
Constant Field Values

DatabaseMetaDataGetTablePrivileges

public static final int DatabaseMetaDataGetTablePrivileges
Retrieve the table privileges

See Also:
Constant Field Values

DatabaseMetaDataGetSchemas

public static final int DatabaseMetaDataGetSchemas
Retrieve the schemas

See Also:
Constant Field Values

GetDatabaseProductName

public static final int GetDatabaseProductName
Retrieve the list of database product names

See Also:
Constant Field Values

FetchNextResultSetRows

public static final int FetchNextResultSetRows
Fetch next rows of data for ResultSet streaming

See Also:
Constant Field Values

CloseRemoteResultSet

public static final int CloseRemoteResultSet
Closes a remote ResultSet that was opened for streaming.

See Also:
Constant Field Values

RestoreConnectionState

public static final int RestoreConnectionState
Restore a connection state after an automatic reconnection.

See Also:
Constant Field Values

SetAutoCommit

public static final int SetAutoCommit
Command to change the autocommit value from false to true. We want to commit the current transaction but we don't want to start a new one.

See Also:
Constant Field Values

CreateRequest

public static final int CreateRequest
Create Request. This is used when sending a write request from the driver to the database worker thread

See Also:
Constant Field Values

DeleteRequest

public static final int DeleteRequest
Delete Request. This is used when sending a write request from the driver to the database worker thread

See Also:
Constant Field Values

DropRequest

public static final int DropRequest
Drop Request. This is used when sending a write request from the driver to the database worker thread

See Also:
Constant Field Values

InsertRequest

public static final int InsertRequest
Insert Request. This is used when sending a write request from the driver to the database worker thread

See Also:
Constant Field Values

UpdateRequest

public static final int UpdateRequest
Update Request. This is used when sending a write request from the driver to the database worker thread

See Also:
Constant Field Values

AlterRequest

public static final int AlterRequest
Alter Request. This is used when sending a write request from the driver to the database worker thread

See Also:
Constant Field Values
Constructor Detail

Commands

public Commands()


Copyright © 2002, 2005 - ObjectWeb Consortium - All Rights Reserved.