PicodataBaseDataSource (JDBC driver for Picodata 3.0.0 API)

java.lang.Object
- io.picodata.jdbc.datasource.PicodataBaseDataSource

All Implemented Interfaces:

CommonDataSource

Direct Known Subclasses:

PicodataConnectionPoolDataSource, PicodataSimpleDataSource
```
public abstract class PicodataBaseDataSource
extends Object
implements CommonDataSource
```
Base class for data source implementations. This implementation is partially borrowed from the pgJDBC source.

Constructor Summary

Constructors
Constructor and Description

PicodataBaseDataSource()

Constructors
Constructor and Description
`PicodataBaseDataSource()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getApplicationName()`
`int`	`getCancelSignalTimeout()`
`Connection`	`getConnection()` Gets a connection to the Picodata server.
`Connection`	`getConnection(String user, String password)` Gets a connection to the Picodata server.
`int`	`getConnectTimeout()`
`int`	`getDatabaseMetadataCacheFields()`
`int`	`getDatabaseMetadataCacheFieldsMiB()`
`int`	`getDefaultRowFetchSize()`
`abstract String`	`getDescription()`
`boolean`	`getHideUnprivilegedObjects()`
`List<String>`	`getHosts()` Gets the hostnames of the Picodata servers to connect to.
`String`	`getLocalSocketAddress()`
`int`	`getLoginTimeout()`
`boolean`	`getLogServerErrorDetail()`
`PrintWriter`	`getLogWriter()` This implementation don't use a LogWriter.
`String`	`getMaxResultBuffer()`
`Logger`	`getParentLogger()`
`String`	`getPassword()`
`List<Integer>`	`getPorts()` Gets the ports of the Picodata servers to connect to.
`int`	`getPreparedStatementCacheQueries()`
`int`	`getPreparedStatementCacheSizeMiB()`
`int`	`getPrepareThreshold()`
`protected Properties`	`getProperties()` Return copy of the underlying properties object
`String`	`getProperty(PicodataProperty property)`
`String`	`getProperty(String name)`
`boolean`	`getReadOnly()`
`String`	`getReadOnlyMode()`
`int`	`getReceiveBufferSize()`
`boolean`	`getReWriteBatchedInserts()`
`int`	`getSendBufferSize()`
`String`	`getSocketFactory()`
`int`	`getSocketTimeout()`
`boolean`	`getTcpKeepAlive()`
`boolean`	`getTcpNoDelay()`
`int`	`getUnknownLength()`
`String`	`getURL()` Generates a `DriverManager` URL from the other properties supplied.
`String`	`getUser()`
`protected String`	`internalGetURL(String user, String password)`
`protected void`	`readBaseObject(ObjectInputStream in)`
`void`	`setApplicationName(String applicationName)`
`void`	`setCancelSignalTimeout(int seconds)`
`void`	`setConnectTimeout(int seconds)`
`void`	`setDatabaseMetadataCacheFields(int cacheSize)`
`void`	`setDatabaseMetadataCacheFieldsMiB(int cacheSize)`
`void`	`setDefaultRowFetchSize(int fetchSize)`
`void`	`setHideUnprivilegedObjects(boolean hideUnprivileged)`
`void`	`setHosts(List<String> hosts)` Sets the hostnames of the Picodata servers to connect to.
`void`	`setLocalSocketAddress(String localSocketAddress)`
`void`	`setLoginTimeout(int seconds)`
`void`	`setLogServerErrorDetail(boolean enabled)`
`void`	`setLogWriter(PrintWriter printWriter)` This implementation don't use a LogWriter.
`void`	`setMaxResultBuffer(String maxResultBuffer)` Set max result buffer value
`void`	`setPassword(String password)`
`void`	`setPorts(List<Integer> ports)` Sets the ports of the Picodata servers to connect to.
`void`	`setPreparedStatementCacheQueries(int cacheSize)`
`void`	`setPreparedStatementCacheSizeMiB(int cacheSize)`
`void`	`setPrepareThreshold(int count)`
`void`	`setProperty(PicodataProperty property, String value)`
`void`	`setProperty(String name, String value)`
`void`	`setReadOnly(boolean readOnly)`
`void`	`setReadOnlyMode(String mode)`
`void`	`setReceiveBufferSize(int nbytes)`
`void`	`setReWriteBatchedInserts(boolean reWrite)`
`void`	`setSendBufferSize(int nbytes)`
`void`	`setSocketFactory(String socketFactoryClassName)`
`void`	`setSocketTimeout(int seconds)`
`void`	`setTcpKeepAlive(boolean enabled)`
`void`	`setTcpNoDelay(boolean enabled)`
`void`	`setUnknownLength(int unknownLength)`
`void`	`setURL(String url)` Sets properties from a `DriverManager` URL.
`void`	`setUser(String username)`
`protected void`	`writeBaseObject(ObjectOutputStream out)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - PicodataBaseDataSource
```
public PicodataBaseDataSource()
```
- Method Detail
  - getProperties
```
protected Properties getProperties()
```
    Return copy of the underlying properties object
    
    Returns:
    
    properties
  - getLogWriter
```
public PrintWriter getLogWriter()
```
    This implementation don't use a LogWriter.
    
    Specified by:
    
    getLogWriter in interface CommonDataSource
  - setLogWriter
```
public void setLogWriter(PrintWriter printWriter)
```
    This implementation don't use a LogWriter.
    
    Specified by:
    
    setLogWriter in interface CommonDataSource
    
    Parameters:
    
    printWriter - Not used
  - getLoginTimeout
```
public int getLoginTimeout()
```
    Specified by:
    
    getLoginTimeout in interface CommonDataSource
    
    See Also:
    
    PicodataProperty.LOGIN_TIMEOUT
  - setLoginTimeout
```
public void setLoginTimeout(int seconds)
```
    Specified by:
    
    setLoginTimeout in interface CommonDataSource
    
    See Also:
    
    PicodataProperty.LOGIN_TIMEOUT
  - getParentLogger
```
public Logger getParentLogger()
```
    Specified by:
    
    getParentLogger in interface CommonDataSource
  - getDescription
```
public abstract String getDescription()
```
  - getConnection
```
public Connection getConnection()
                         throws SQLException
```
    Gets a connection to the Picodata server. The following properties need to be specified for connection: target hostname or IP address, user name and password. These parameters and some others can be specified in a connection URL or connection properties.
    
    Returns:
    
    A valid database connection.
    
    Throws:
    
    SQLException - Occurs when the database connection cannot be established.
  - getConnection
```
public Connection getConnection(String user,
                                String password)
                         throws SQLException
```
    Gets a connection to the Picodata server. The following properties need to be specified for connection: target hostname or IP address, user name and password. These parameters and some others can be specified in a connection URL or connection properties. This method should be used if the user name and password need to be explicitly overriden.
    
    Parameters:
    
    user - user
    
    password - password
    
    Returns:
    
    A valid database connection.
    
    Throws:
    
    SQLException - Occurs when the database connection cannot be established.
  - setPorts
```
public void setPorts(List<Integer> ports)
```
    Sets the ports of the Picodata servers to connect to. If this is changed, it will only affect future calls to getConnection. The default value is localhost.
    
    Parameters:
    
    ports - Picodata server port(s)
  - getPorts
```
public List<Integer> getPorts()
```
    Gets the ports of the Picodata servers to connect to.
    
    Returns:
    
    List of Picodata server port(s)
  - setHosts
```
public void setHosts(List<String> hosts)
```
    Sets the hostnames of the Picodata servers to connect to. If this is changed, it will only affect future calls to getConnection. The default value is localhost.
    
    Parameters:
    
    hosts - Picodata server hostname(s)
  - getHosts
```
public List<String> getHosts()
```
    Gets the hostnames of the Picodata servers to connect to.
    
    Returns:
    
    List of Picodata server hostname(s)
  - getUser
```
public String getUser()
```
    Returns:
    
    user for connecting to Picodata server
    
    See Also:
    
    PicodataProperty.PICODATA_USER
  - setUser
```
public void setUser(String username)
```
    Parameters:
    
    username - user for connecting to Picodata server
    
    See Also:
    
    PicodataProperty.PICODATA_USER
  - getPassword
```
public String getPassword()
```
    Returns:
    
    password for connecting to Picodata server
    
    See Also:
    
    PicodataProperty.PICODATA_PASSWORD
  - setPassword
```
public void setPassword(String password)
```
    Parameters:
    
    password - password for connecting to Picodata server
    
    See Also:
    
    PicodataProperty.PICODATA_PASSWORD
  - getConnectTimeout
```
public int getConnectTimeout()
```
    Returns:
    
    connect timeout
    
    See Also:
    
    PicodataProperty.CONNECT_TIMEOUT
  - setConnectTimeout
```
public void setConnectTimeout(int seconds)
```
    Parameters:
    
    seconds - connect timeout
    
    See Also:
    
    PicodataProperty.CONNECT_TIMEOUT
  - getReceiveBufferSize
```
public int getReceiveBufferSize()
```
    Returns:
    
    receive buffer size
    
    See Also:
    
    PicodataProperty.RECEIVE_BUFFER_SIZE
  - setReceiveBufferSize
```
public void setReceiveBufferSize(int nbytes)
```
    Parameters:
    
    nbytes - receive buffer size
    
    See Also:
    
    PicodataProperty.RECEIVE_BUFFER_SIZE
  - getSendBufferSize
```
public int getSendBufferSize()
```
    Returns:
    
    send buffer size
    
    See Also:
    
    PicodataProperty.SEND_BUFFER_SIZE
  - setSendBufferSize
```
public void setSendBufferSize(int nbytes)
```
    Parameters:
    
    nbytes - send buffer size
    
    See Also:
    
    PicodataProperty.SEND_BUFFER_SIZE
  - setPrepareThreshold
```
public void setPrepareThreshold(int count)
```
    Parameters:
    
    count - prepare threshold
    
    See Also:
    
    PicodataProperty.PREPARE_THRESHOLD
  - getPrepareThreshold
```
public int getPrepareThreshold()
```
    Returns:
    
    prepare threshold
    
    See Also:
    
    PicodataProperty.PREPARE_THRESHOLD
  - getPreparedStatementCacheQueries
```
public int getPreparedStatementCacheQueries()
```
    Returns:
    
    prepared statement cache size (number of statements per connection)
    
    See Also:
    
    PicodataProperty.PREPARED_STATEMENT_CACHE_QUERIES
  - setPreparedStatementCacheQueries
```
public void setPreparedStatementCacheQueries(int cacheSize)
```
    Parameters:
    
    cacheSize - prepared statement cache size (number of statements per connection)
    
    See Also:
    
    PicodataProperty.PREPARED_STATEMENT_CACHE_QUERIES
  - getPreparedStatementCacheSizeMiB
```
public int getPreparedStatementCacheSizeMiB()
```
    Returns:
    
    prepared statement cache size (number of megabytes per connection)
    
    See Also:
    
    PicodataProperty.PREPARED_STATEMENT_CACHE_SIZE_MIB
  - setPreparedStatementCacheSizeMiB
```
public void setPreparedStatementCacheSizeMiB(int cacheSize)
```
    Parameters:
    
    cacheSize - statement cache size (number of megabytes per connection)
    
    See Also:
    
    PicodataProperty.PREPARED_STATEMENT_CACHE_SIZE_MIB
  - getDatabaseMetadataCacheFields
```
public int getDatabaseMetadataCacheFields()
```
    Returns:
    
    database metadata cache fields size (number of fields cached per connection)
    
    See Also:
    
    PicodataProperty.DATABASE_METADATA_CACHE_FIELDS
  - setDatabaseMetadataCacheFields
```
public void setDatabaseMetadataCacheFields(int cacheSize)
```
    Parameters:
    
    cacheSize - database metadata cache fields size (number of fields cached per connection)
    
    See Also:
    
    PicodataProperty.DATABASE_METADATA_CACHE_FIELDS
  - getDatabaseMetadataCacheFieldsMiB
```
public int getDatabaseMetadataCacheFieldsMiB()
```
    Returns:
    
    database metadata cache fields size (number of megabytes per connection)
    
    See Also:
    
    PicodataProperty.DATABASE_METADATA_CACHE_FIELDS_MIB
  - setDatabaseMetadataCacheFieldsMiB
```
public void setDatabaseMetadataCacheFieldsMiB(int cacheSize)
```
    Parameters:
    
    cacheSize - database metadata cache fields size (number of megabytes per connection)
    
    See Also:
    
    PicodataProperty.DATABASE_METADATA_CACHE_FIELDS_MIB
  - setDefaultRowFetchSize
```
public void setDefaultRowFetchSize(int fetchSize)
```
    Parameters:
    
    fetchSize - default fetch size
    
    See Also:
    
    PicodataProperty.DEFAULT_ROW_FETCH_SIZE
  - getDefaultRowFetchSize
```
public int getDefaultRowFetchSize()
```
    Returns:
    
    default fetch size
    
    See Also:
    
    PicodataProperty.DEFAULT_ROW_FETCH_SIZE
  - setUnknownLength
```
public void setUnknownLength(int unknownLength)
```
    Parameters:
    
    unknownLength - unknown length
    
    See Also:
    
    PicodataProperty.UNKNOWN_LENGTH
  - getUnknownLength
```
public int getUnknownLength()
```
    Returns:
    
    unknown length
    
    See Also:
    
    PicodataProperty.UNKNOWN_LENGTH
  - setSocketTimeout
```
public void setSocketTimeout(int seconds)
```
    Parameters:
    
    seconds - socket timeout
    
    See Also:
    
    PicodataProperty.SOCKET_TIMEOUT
  - getSocketTimeout
```
public int getSocketTimeout()
```
    Returns:
    
    socket timeout
    
    See Also:
    
    PicodataProperty.SOCKET_TIMEOUT
  - setCancelSignalTimeout
```
public void setCancelSignalTimeout(int seconds)
```
    Parameters:
    
    seconds - timeout that is used for sending cancel command
    
    See Also:
    
    PicodataProperty.CANCEL_SIGNAL_TIMEOUT
  - getCancelSignalTimeout
```
public int getCancelSignalTimeout()
```
    Returns:
    
    timeout that is used for sending cancel command in seconds
    
    See Also:
    
    PicodataProperty.CANCEL_SIGNAL_TIMEOUT
  - setApplicationName
```
public void setApplicationName(String applicationName)
```
    Parameters:
    
    applicationName - application name
    
    See Also:
    
    PicodataProperty.APPLICATION_NAME
  - getApplicationName
```
public String getApplicationName()
```
    Returns:
    
    application name
    
    See Also:
    
    PicodataProperty.APPLICATION_NAME
  - setTcpKeepAlive
```
public void setTcpKeepAlive(boolean enabled)
```
    Parameters:
    
    enabled - if TCP keep alive should be enabled
    
    See Also:
    
    PicodataProperty.TCP_KEEP_ALIVE
  - getTcpKeepAlive
```
public boolean getTcpKeepAlive()
```
    Returns:
    
    true if TCP keep alive is enabled
    
    See Also:
    
    PicodataProperty.TCP_KEEP_ALIVE
  - setTcpNoDelay
```
public void setTcpNoDelay(boolean enabled)
```
    Parameters:
    
    enabled - if TCP no delay should be enabled
    
    See Also:
    
    PicodataProperty.TCP_NO_DELAY
  - getTcpNoDelay
```
public boolean getTcpNoDelay()
```
    Returns:
    
    true if TCP no delay is enabled
    
    See Also:
    
    PicodataProperty.TCP_NO_DELAY
  - getReadOnly
```
public boolean getReadOnly()
```
    Returns:
    
    true if connection is readonly
    
    See Also:
    
    PicodataProperty.READ_ONLY
  - setReadOnly
```
public void setReadOnly(boolean readOnly)
```
    Parameters:
    
    readOnly - if connection should be readonly
    
    See Also:
    
    PicodataProperty.READ_ONLY
  - getReadOnlyMode
```
public String getReadOnlyMode()
```
    Returns:
    
    The behavior when set read only
    
    See Also:
    
    PicodataProperty.READ_ONLY_MODE
  - setReadOnlyMode
```
public void setReadOnlyMode(String mode)
```
    Parameters:
    
    mode - the behavior when set read only
    
    See Also:
    
    PicodataProperty.READ_ONLY_MODE
  - getLogServerErrorDetail
```
public boolean getLogServerErrorDetail()
```
    Returns:
    
    true if driver should log include detail in server error messages
    
    See Also:
    
    PicodataProperty.LOG_SERVER_ERROR_DETAIL
  - setLogServerErrorDetail
```
public void setLogServerErrorDetail(boolean enabled)
```
    Parameters:
    
    enabled - true if driver should include detail in server error messages
    
    See Also:
    
    PicodataProperty.LOG_SERVER_ERROR_DETAIL
  - getSocketFactory
```
public String getSocketFactory()
```
    Returns:
    
    socket factory class name
    
    See Also:
    
    PicodataProperty.SOCKET_FACTORY
  - setSocketFactory
```
public void setSocketFactory(String socketFactoryClassName)
```
    Parameters:
    
    socketFactoryClassName - socket factory class name
    
    See Also:
    
    PicodataProperty.SOCKET_FACTORY
  - getLocalSocketAddress
```
public String getLocalSocketAddress()
```
    Returns:
    
    the localSocketAddress
    
    See Also:
    
    PicodataProperty.LOCAL_SOCKET_ADDRESS
  - setLocalSocketAddress
```
public void setLocalSocketAddress(String localSocketAddress)
```
    Parameters:
    
    localSocketAddress - local address to bind client side to
    
    See Also:
    
    PicodataProperty.LOCAL_SOCKET_ADDRESS
  - getReWriteBatchedInserts
```
public boolean getReWriteBatchedInserts()
```
    Returns:
    
    boolean indicating property is enabled or not.
    
    See Also:
    
    PicodataProperty.REWRITE_BATCHED_INSERTS
  - setReWriteBatchedInserts
```
public void setReWriteBatchedInserts(boolean reWrite)
```
    Parameters:
    
    reWrite - boolean value to set the property in the properties collection
    
    See Also:
    
    PicodataProperty.REWRITE_BATCHED_INSERTS
  - getHideUnprivilegedObjects
```
public boolean getHideUnprivilegedObjects()
```
    Returns:
    
    boolean indicating property is enabled or not.
    
    See Also:
    
    PicodataProperty.HIDE_UNPRIVILEGED_OBJECTS
  - setHideUnprivilegedObjects
```
public void setHideUnprivilegedObjects(boolean hideUnprivileged)
```
    Parameters:
    
    hideUnprivileged - boolean value to set the property in the properties collection
    
    See Also:
    
    PicodataProperty.HIDE_UNPRIVILEGED_OBJECTS
  - getMaxResultBuffer
```
public String getMaxResultBuffer()
```
    Returns:
    
    current max result buffer value
    
    See Also:
    
    PicodataProperty.MAX_RESULT_BUFFER
  - setMaxResultBuffer
```
public void setMaxResultBuffer(String maxResultBuffer)
```
    Set max result buffer value
    
    Parameters:
    
    maxResultBuffer - new value
    
    See Also:
    
    PicodataProperty.MAX_RESULT_BUFFER
  - internalGetURL
```
protected String internalGetURL(String user,
                                String password)
                         throws SQLException
```
    Throws:
    
    SQLException
  - getURL
```
public String getURL()
```
    Generates a DriverManager URL from the other properties supplied.
    
    Returns:
    
    DriverManager URL from the other properties supplied
  - setURL
```
public void setURL(String url)
```
    Sets properties from a DriverManager URL.
    
    Parameters:
    
    url - properties to set
    
    Throws:
    
    IllegalArgumentException - if the passed URL cannot be parsed
  - getProperty
```
public String getProperty(String name)
                   throws SQLException
```
    Throws:
    
    SQLException
  - setProperty
```
public void setProperty(String name,
                        String value)
                 throws SQLException
```
    Throws:
    
    SQLException
  - getProperty
```
public String getProperty(PicodataProperty property)
```
  - setProperty
```
public void setProperty(PicodataProperty property,
                        String value)
```
  - writeBaseObject
```
protected void writeBaseObject(ObjectOutputStream out)
                        throws IOException
```
    Throws:
    
    IOException
  - readBaseObject
```
protected void readBaseObject(ObjectInputStream in)
                       throws IOException,
                              ClassNotFoundException
```
    Throws:
    
    IOException
    
    ClassNotFoundException

Class PicodataBaseDataSource

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PicodataBaseDataSource

Method Detail

getProperties

getLogWriter

setLogWriter

getLoginTimeout

setLoginTimeout

getParentLogger

getDescription

getConnection

getConnection

setPorts

getPorts

setHosts

getHosts

getUser

setUser

getPassword

setPassword

getConnectTimeout

setConnectTimeout

getReceiveBufferSize

setReceiveBufferSize

getSendBufferSize

setSendBufferSize

setPrepareThreshold

getPrepareThreshold

getPreparedStatementCacheQueries

setPreparedStatementCacheQueries

getPreparedStatementCacheSizeMiB

setPreparedStatementCacheSizeMiB

getDatabaseMetadataCacheFields

setDatabaseMetadataCacheFields

getDatabaseMetadataCacheFieldsMiB

setDatabaseMetadataCacheFieldsMiB

setDefaultRowFetchSize

getDefaultRowFetchSize

setUnknownLength

getUnknownLength

setSocketTimeout

getSocketTimeout

setCancelSignalTimeout

getCancelSignalTimeout

setApplicationName

getApplicationName

setTcpKeepAlive

getTcpKeepAlive

setTcpNoDelay

getTcpNoDelay

getReadOnly

setReadOnly

getReadOnlyMode

setReadOnlyMode

getLogServerErrorDetail

setLogServerErrorDetail

getSocketFactory

setSocketFactory

getLocalSocketAddress

setLocalSocketAddress

getReWriteBatchedInserts

setReWriteBatchedInserts

getHideUnprivilegedObjects

setHideUnprivilegedObjects

getMaxResultBuffer

setMaxResultBuffer

internalGetURL

getURL

setURL

getProperty

setProperty

getProperty

setProperty

writeBaseObject

readBaseObject