Documentation Center

  • Trial Software
  • Product Updates

logintimeout

Set or get time allowed to establish database connection

Syntax

timeout = logintimeout('driver', time)
timeout = logintimeout(time)
timeout = logintimeout('driver')
timeout = logintimeout

Description

timeout = logintimeout('driver', time) sets the amount of time, in seconds, for a MATLAB® session to connect to a database via a given JDBC driver. Use logintimeout before running the database function. If the MATLAB session cannot connect to the database within the specified time, it stops trying.

timeout = logintimeout(time) sets the amount of time, in seconds, allowed for a MATLAB session to try to connect to a database via an ODBC connection. Use logintimeout before running the database function. If the MATLAB session cannot connect within the allowed time, it stops trying.

timeout = logintimeout('driver') returns the time, in seconds, that was previously specified for the JDBC driver. A returned value of 0 means that the timeout value was not previously set. The MATLAB session stops trying to connect to the database if it is not immediately successful.

timeout = logintimeout returns the time, in seconds, that you previously specified for an ODBC connection. A returned value of 0 means that the timeout value was not previously set; the MATLAB software session stops trying to make a connection if it is not immediately successful.

    Note:   If you do not specify a value for logintimeout and the MATLAB session cannot establish a database connection, your MATLAB session may freeze.

    Note:   Apple Mac OS platforms do not support logintimeout.

Examples

Example 1 — Get Timeout Value for ODBC Connection

View the current connection timeout value.

 logintimeout
 ans =
     0

This indicates that you have not specified a timeout value.

Example 2 — Set Timeout Value for ODBC Connection

Set the timeout value to 5 seconds.

logintimeout(5)
ans =
     5

Example 3 — Get and Set Timeout Value for JDBC Connection

  1. Check the timeout value for a database connection that is established using an Oracle® JDBC driver.

    logintimeout('oracle.jdbc.driver.OracleDriver')
    ans =
         0
    

    This indicates that the timeout value is currently 0.

  2. Set the timeout to 5 seconds.

    timeout = ...
    logintimeout('oracle.jdbc.driver.OracleDriver', 5)
    timeout =
         5
    
  3. Verify the timeout value.

    logintimeout('oracle.jdbc.driver.OracleDriver')
    ans =
         5
    

See Also

| |

Was this topic helpful?