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
`begin { }` Begins a transaction.
`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.
`dbHostName { }` Returns the host name of the
`dbIpAddress { }` Returns the ip address of the
`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.
`errorNumber { }` If an operation failed and generated an error, the error number is available here.
`getClientInfo { }` Returns the string that was set by
`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
`setAuthenticationTimeout { timeoutsec timeoutusec }` Sets the authentication timeout in seconds and milliseconds.
`setClientInfo { clientinfo }` Allows you to set a string that will be passed to the server and ultimately included in server-side logging along with queries that were run by this instance of the
`setConnectTimeout { timeoutsec timeoutusec }` Sets the server connect timeout in seconds and milliseconds.
`setDebugFile { debugfilename }` Allows you to specify a file to write debug to.
`setResponseTimeout { timeoutsec timeoutusec }` Sets the response timeout (for queries, commits, rollbacks, pings,
`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 125

### autoCommitOn

    proc autoCommitOn {  }

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

### begin

    proc begin {  }

  Begins a transaction. Returns true if the begin succeeded, false if it failed. If the database automatically begins a new transaction when a commit or rollback is issued then this doesn't do anything unless SQL Relay is faking transaction blocks.
  Defined in:
    sqlrconCmd.tcl, line 135

### bindFormat

    proc bindFormat {  }

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

### clientVersion

    proc clientVersion {  }

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

### commit

    proc commit {  }

  Issues a commit. Returns true if the commit succeeded false if it failed.
  Defined in:
    sqlrconCmd.tcl, line 139

### dbHostName

    proc dbHostName {  }

  Returns the host name of the database
  Defined in:
    sqlrconCmd.tcl, line 88

### dbIpAddress

    proc dbIpAddress {  }

  Returns the ip address of the database
  Defined in:
    sqlrconCmd.tcl, line 91

### dbVersion

    proc dbVersion {  }

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

### debugOff

    proc debugOff {  }

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

### 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 SQLR_CLIENT_DEBUG to "ON"
  Defined in:
    sqlrconCmd.tcl, line 168

### endSession

    proc endSession {  }

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

### 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 151

### errorNumber

    proc errorNumber {  }

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

### getClientInfo

    proc getClientInfo {  }

  Returns the string that was set by setClientInfo().
  Defined in:
    sqlrconCmd.tcl, line 189

### 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 59

### 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 67

### getCurrentDatabase

    proc getCurrentDatabase {  }

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

### getDebug

    proc getDebug {  }

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

### getLastInsertId

    proc getLastInsertId {  }

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

### identify

    proc identify {  }

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

### ping

    proc ping {  }

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

### 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 72

### rollback

    proc rollback {  }

  Issues a rollback. Returns true if the rollback succeeded false if it failed.
  Defined in:
    sqlrconCmd.tcl, line 143

### selectDatabase

    proc selectDatabase { database }

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

### serverVersion

    proc serverVersion {  }

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

### setAuthenticationTimeout

    proc setAuthenticationTimeout { timeoutsec timeoutusec }

  Sets the authentication timeout in seconds and milliseconds. Setting either parameter to -1 disables the timeout. You can also set this timeout using the SQLR_CLIENT_AUTHENTICATION_TIMEOUT environment variable.
  Defined in:
    sqlrconCmd.tcl, line 35

### setClientInfo

    proc setClientInfo { clientinfo }

  Allows you to set a string that will be passed to the server and ultimately included in server-side logging along with queries that were run by this instance of the client.
  Defined in:
    sqlrconCmd.tcl, line 186

### setConnectTimeout

    proc setConnectTimeout { timeoutsec timeoutusec }

  Sets the server connect timeout in seconds and milliseconds. Setting either parameter to -1 disables the timeout. You can also set this timeout using the SQLR_CLIENT_CONNECT_TIMEOUT environment variable.
  Defined in:
    sqlrconCmd.tcl, line 29

### setDebugFile

    proc setDebugFile { debugfilename }

  Allows you to specify a file to write debug to. Setting "debugfilename" to NULL or an empty string causes debug to be written to standard output (the default).
  Defined in:
    sqlrconCmd.tcl, line 180

### setResponseTimeout

    proc setResponseTimeout { timeoutsec timeoutusec }

  Sets the response timeout (for queries, commits, rollbacks, pings, etc.) in seconds and milliseconds. Setting either parameter to -1 disables the timeout. You can also set this timeout using the SQLR_CLIENT_RESPONSE_TIMEOUT environment variable.
  Defined in:
    sqlrconCmd.tcl, line 42

### 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, waiting "retrytime" seconds between each try. 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 51

Index by: file name | procedure name | procedure call | annotation
File generated 2014-09-29 at 19:24.