Index by: file name | procedure name | procedure call | annotation

## sqlrconCmd.tcl Annotations

Created from `../../../src/api/tcl/sqlrconCmd.tcl`

Procedure Summary
`autoCommitOff { }` Instructs the database to wait for the client to tell it when to
`autoCommitOn { }` Instructs the database to perform a commit after every successful
`bindFormat { }` Returns a string representing the format of the bind variables used in the
`clientVersion { }` Returns the version of the sqlrelay client
`commit { }` Issues a commit.
`dbVersion { }` Returns the version of the
`debugOff { }` Turns debugging
`debugOn { }` Causes verbose debugging information to be sent to standard output.
`endSession { }` Ends the
`errorMessage { }` If an operation failed and generated an error the error message is available here.
`getConnectionPort { }` Returns the inet port that the connection is communicating over.
`getConnectionSocket { }` Returns the unix socket that the connection is communicating over.
`getCurrentDatabase { }` Returns the database/schema that is currently in
`getDebug { }` Returns false if debugging is off and true if debugging is
`getLastInsertId { }` Returns the value of the autoincrement column for the last
`identify { }` Returns the type of database: oracle8 postgresql mysql
`ping { }` Returns true if the database is up and false if it's
`resumeSession { port socket }` Resumes a session previously left open using suspendSession {}.
`rollback { }` Issues a rollback.
`selectDatabase { database }` Sets the current database/schema to
`serverVersion { }` Returns the version of the sqlrelay server
`setTimeout { timeoutsec timeoutusec }` Sets the server connect timeout in seconds and milliseconds.
`sqlrconCmd { server port socket user password retrytime tries }` Initiates a connection to "server" on "port" or to the unix "socket" on the local machine and authenticates with "user" and "password".
`sqlrconDelete { }` Disconnects and ends the session if it hasn't been ended
`suspendSession { }` Disconnects this connection from the current session but leaves the session open so that another connection can connect to it using resumeSession

Procedure Detail

### autoCommitOff

    proc autoCommitOff {  }

  Instructs the database to wait for the client to tell it when to commit.
  Defined in:
    sqlrconCmd.tcl, line 105

### autoCommitOn

    proc autoCommitOn {  }

  Instructs the database to perform a commit after every successful query.
  Defined in:
    sqlrconCmd.tcl, line 101

### bindFormat

    proc bindFormat {  }

  Returns a string representing the format of the bind variables used in the db.
  Defined in:
    sqlrconCmd.tcl, line 81

### clientVersion

    proc clientVersion {  }

  Returns the version of the sqlrelay client software.
  Defined in:
    sqlrconCmd.tcl, line 77

### commit

    proc commit {  }

  Issues a commit. Returns 1 if the commit succeeded 0 if it failed.
  Defined in:
    sqlrconCmd.tcl, line 111

### dbVersion

    proc dbVersion {  }

  Returns the version of the database
  Defined in:
    sqlrconCmd.tcl, line 71

### debugOff

    proc debugOff {  }

  Turns debugging off.
  Defined in:
    sqlrconCmd.tcl, line 135

### debugOn

    proc debugOn {  }

  Causes verbose debugging information to be sent to standard output. Another way to do this is to start a query with "-- debug\n". Another way is to set the environment variable SQLRDEBUG to "ON"
  Defined in:
    sqlrconCmd.tcl, line 132

### endSession

    proc endSession {  }

  Ends the session.
  Defined in:
    sqlrconCmd.tcl, line 31

### errorMessage

    proc errorMessage {  }

  If an operation failed and generated an error the error message is available here. If there is no error then this method returns NULL.
  Defined in:
    sqlrconCmd.tcl, line 123

### getConnectionPort

    proc getConnectionPort {  }

  Returns the inet port that the connection is communicating over. This parameter may be passed to another connection for use in the resumeSession {} method. Note: The value this method returns is only valid after a call to suspendSession {}.
  Defined in:
    sqlrconCmd.tcl, line 45

### getConnectionSocket

    proc getConnectionSocket {  }

  Returns the unix socket that the connection is communicating over. This parameter may be passed to another connection for use in the resumeSession {} method. Note: The value this method returns is only valid after a call to suspendSession {}.
  Defined in:
    sqlrconCmd.tcl, line 53

### getCurrentDatabase

    proc getCurrentDatabase {  }

  Returns the database/schema that is currently in use.
  Defined in:
    sqlrconCmd.tcl, line 89

### getDebug

    proc getDebug {  }

  Returns false if debugging is off and true if debugging is on.
  Defined in:
    sqlrconCmd.tcl, line 139

### getLastInsertId

    proc getLastInsertId {  }

  Returns the value of the autoincrement column for the last insert
  Defined in:
    sqlrconCmd.tcl, line 95

### identify

    proc identify {  }

  Returns the type of database: oracle8 postgresql mysql etc.
  Defined in:
    sqlrconCmd.tcl, line 68

### ping

    proc ping {  }

  Returns true if the database is up and false if it's down.
  Defined in:
    sqlrconCmd.tcl, line 64

### resumeSession

    proc resumeSession { port socket }

  Resumes a session previously left open using suspendSession {}. Returns true on success and false on failure.
  Defined in:
    sqlrconCmd.tcl, line 58

### rollback

    proc rollback {  }

  Issues a rollback. Returns 1 if the rollback succeeded 0 if it failed.
  Defined in:
    sqlrconCmd.tcl, line 115

### selectDatabase

    proc selectDatabase { database }

  Sets the current database/schema to "database"
  Defined in:
    sqlrconCmd.tcl, line 86

### serverVersion

    proc serverVersion {  }

  Returns the version of the sqlrelay server software.
  Defined in:
    sqlrconCmd.tcl, line 74

### setTimeout

    proc setTimeout { timeoutsec timeoutusec }

  Sets the server connect timeout in seconds and milliseconds. Setting either parameter to -1 disables the timeout.
  Defined in:
    sqlrconCmd.tcl, line 28

### sqlrconCmd

    proc sqlrconCmd { server port socket user password retrytime tries }

  Initiates a connection to "server" on "port" or to the unix "socket" on the local machine and authenticates with "user" and "password". Failed connections will be retried for "tries" times on interval "retrytime". If "tries" is 0 then retries will continue forever. If "retrytime" is 0 then retries will be attempted on a default interval. If the "socket" parameter is neither NULL nor "" then an attempt will be made to connect through it before attempting to connect to "server" on "port". If it is NULL or "" then no attempt will be made to connect through the socket.
  Defined in:
    sqlrconCmd.tcl, line 16

### sqlrconDelete

    proc sqlrconDelete {  }

  Disconnects and ends the session if it hasn't been ended already.
  Defined in:
    sqlrconCmd.tcl, line 21

### suspendSession

    proc suspendSession {  }

  Disconnects this connection from the current session but leaves the session open so that another connection can connect to it using resumeSession {}.
  Defined in:
    sqlrconCmd.tcl, line 37

Index by: file name | procedure name | procedure call | annotation
File generated 2012-01-10 at 06:42.