OpenJDK 27 · javax.sql.CommonDataSource · APIdia, the JavaDoc alternative

Method Summary

Modifier and Type	Method and Description
public default ShardingKeyBuilder	Returns: The ShardingKeyBuilder instance that was created createShardingKeyBuilder() Creates a new `ShardingKeyBuilder` instance
public int	Returns: the data source login time limit getLoginTimeout() Gets the maximum time in seconds that this data source can wait while attempting to connect to a database.
public PrintWriter	Returns: the log writer for this data source or null if logging is disabled getLogWriter() Retrieves the log writer for this `DataSource` object.
public Logger	Returns: the parent Logger for this data source getParentLogger() Return the parent Logger of all the Loggers used by this data source.
public void	setLoginTimeout(int the data source login time limit seconds) Sets the maximum time in seconds that this data source will wait while attempting to connect to a database.
public void	setLogWriter(PrintWriter the new log writer; to disable logging, set to null out) Sets the log writer for this `DataSource` object to the given `java.io.PrintWriter` object.

Method Detail

createShardingKeyBuilder back to summary

createShardingKeyBuilder	back to summary
public default ShardingKeyBuilder createShardingKeyBuilder() throws SQLException Creates a new `ShardingKeyBuilder` instance Implementation Specification The default implementation will throw a `SQLFeatureNotSupportedException`. Returns:ShardingKeyBuilder The ShardingKeyBuilder instance that was created Exceptions SQLException: if an error occurs creating the builder SQLFeatureNotSupportedException: if the driver does not support this method Since 9 See Also `ShardingKeyBuilder`

public default ShardingKeyBuilder createShardingKeyBuilder() throws SQLException

Creates a new ShardingKeyBuilder instance

Implementation Specification

The default implementation will throw a SQLFeatureNotSupportedException.

Returns:ShardingKeyBuilder

The ShardingKeyBuilder instance that was created

Exceptions

SQLException:: if an error occurs creating the builder
SQLFeatureNotSupportedException:: if the driver does not support this method

Since

See Also

ShardingKeyBuilder

getLoginTimeout back to summary

getLoginTimeout	back to summary
public int getLoginTimeout() throws SQLException Gets the maximum time in seconds that this data source can wait while attempting to connect to a database. A value of zero means that the timeout is the default system timeout if there is one; otherwise, it means that there is no timeout. When a `DataSource` object is created, the login timeout is initially zero. Returns:int the data source login time limit Exceptions SQLException: if a database access error occurs. See Also `setLoginTimeout`

public int getLoginTimeout() throws SQLException

Gets the maximum time in seconds that this data source can wait while attempting to connect to a database. A value of zero means that the timeout is the default system timeout if there is one; otherwise, it means that there is no timeout. When a DataSource object is created, the login timeout is initially zero.

Returns:int

the data source login time limit

Exceptions

SQLException:: if a database access error occurs.

See Also

setLoginTimeout

getLogWriter back to summary

getLogWriter	back to summary
public PrintWriter getLogWriter() throws SQLException Retrieves the log writer for this `DataSource` object. The log writer is a character output stream to which all logging and tracing messages for this data source will be printed. This includes messages printed by the methods of this object, messages printed by methods of other objects manufactured by this object, and so on. Messages printed to a data source specific log writer are not printed to the log writer associated with the `java.sql.DriverManager` class. When a `DataSource` object is created, the log writer is initially null; in other words, the default is for logging to be disabled. Returns:PrintWriter the log writer for this data source or null if logging is disabled Exceptions SQLException: if a database access error occurs See Also `setLogWriter`

public PrintWriter getLogWriter() throws SQLException

Retrieves the log writer for this DataSource object.

The log writer is a character output stream to which all logging and tracing messages for this data source will be printed. This includes messages printed by the methods of this object, messages printed by methods of other objects manufactured by this object, and so on. Messages printed to a data source specific log writer are not printed to the log writer associated with the java.sql.DriverManager class. When a DataSource object is created, the log writer is initially null; in other words, the default is for logging to be disabled.

Returns:PrintWriter

the log writer for this data source or null if logging is disabled

Exceptions

SQLException:: if a database access error occurs

See Also

setLogWriter

getParentLogger back to summary

getParentLogger	back to summary
public Logger getParentLogger() throws SQLFeatureNotSupportedException Return the parent Logger of all the Loggers used by this data source. This should be the Logger farthest from the root Logger that is still an ancestor of all of the Loggers used by this data source. Configuring this Logger will affect all of the log messages generated by the data source. In the worst case, this may be the root Logger. Returns:Logger the parent Logger for this data source Exceptions SQLFeatureNotSupportedException: if the data source does not use `java.util.logging` Since 1.7

public Logger getParentLogger() throws SQLFeatureNotSupportedException

Return the parent Logger of all the Loggers used by this data source. This should be the Logger farthest from the root Logger that is still an ancestor of all of the Loggers used by this data source. Configuring this Logger will affect all of the log messages generated by the data source. In the worst case, this may be the root Logger.

Returns:Logger

the parent Logger for this data source

Exceptions

SQLFeatureNotSupportedException:: if the data source does not use java.util.logging

Since

1.7

setLoginTimeout back to summary

setLoginTimeout	back to summary
public void setLoginTimeout(int seconds) throws SQLException Sets the maximum time in seconds that this data source will wait while attempting to connect to a database. A value of zero specifies that the timeout is the default system timeout if there is one; otherwise, it specifies that there is no timeout. When a `DataSource` object is created, the login timeout is initially zero. Parameters seconds:int the data source login time limit Exceptions SQLException: if a database access error occurs. See Also `getLoginTimeout`

public void setLoginTimeout(int seconds) throws SQLException

Sets the maximum time in seconds that this data source will wait while attempting to connect to a database. A value of zero specifies that the timeout is the default system timeout if there is one; otherwise, it specifies that there is no timeout. When a DataSource object is created, the login timeout is initially zero.

Parameters

seconds:int: the data source login time limit

Exceptions

SQLException:: if a database access error occurs.

See Also

getLoginTimeout

setLogWriter back to summary

setLogWriter	back to summary
public void setLogWriter(PrintWriter out) throws SQLException Sets the log writer for this `DataSource` object to the given `java.io.PrintWriter` object. The log writer is a character output stream to which all logging and tracing messages for this data source will be printed. This includes messages printed by the methods of this object, messages printed by methods of other objects manufactured by this object, and so on. Messages printed to a data source- specific log writer are not printed to the log writer associated with the `java.sql.DriverManager` class. When a `DataSource` object is created the log writer is initially null; in other words, the default is for logging to be disabled. Parameters out:PrintWriter the new log writer; to disable logging, set to null Exceptions SQLException: if a database access error occurs See Also `getLogWriter`

public void setLogWriter(PrintWriter out) throws SQLException

Sets the log writer for this DataSource object to the given java.io.PrintWriter object.

The log writer is a character output stream to which all logging and tracing messages for this data source will be printed. This includes messages printed by the methods of this object, messages printed by methods of other objects manufactured by this object, and so on. Messages printed to a data source- specific log writer are not printed to the log writer associated with the java.sql.DriverManager class. When a DataSource object is created the log writer is initially null; in other words, the default is for logging to be disabled.

Parameters

out:PrintWriter: the new log writer; to disable logging, set to null

Exceptions

SQLException:: if a database access error occurs

See Also

getLogWriter

public Interface CommonDataSource

Method Summary

Method Detail