Serialized Form

Package com.metamatrix.jdbc

Class com.metamatrix.jdbc.BaseDataSource extends WrapperImpl implements Serializable

Serialized Fields

databaseName

java.lang.String databaseName

The name of the virtual database on a particular MetaMatrix Server. This property name is one of the standard property names defined by the JDBC 2.0 specification, and is required.

dataSourceName

java.lang.String dataSourceName

The logical name for the underlying XADataSource or ConnectionPoolDataSource; used only when pooling connections or distributed transactions are implemented. This property name is one of the standard property names defined by the JDBC 2.0 specification, and is optional.

description

java.lang.String description

The description of this data source. This property name is one of the standard property names defined by the JDBC 2.0 specification, and is optional.

clientToken

java.io.Serializable clientToken

The Serializable client token that will be passed directly through to the connectors, which may use it and/or pass it down to their underlying data source. This property is optional.

The form and type of the client token is up to the client but it must implement the Serializabe interface. MetaMatrix does nothing with this token except to make it available for authentication/augmentation/replacement upon authentication to the system and to connectors that may require it at the data source level.

user

java.lang.String user

The user's name. This property name is one of the standard property names defined by the JDBC 2.0 specification, and is required.

password

java.lang.String password

The user's password. This property name is one of the standard property names defined by the JDBC 2.0 specification, and is required.

databaseVersion

java.lang.String databaseVersion

The version number of the virtual database to which a connection is to be established. This property is optional; if not specified, the assumption is that the latest version on the MetaMatrix Server is to be used.

applicationName

java.lang.String applicationName

The name of the application. Supplying this property may allow an administrator of a MetaMatrix Server to better identify individual connections and usage patterns. This property is optional.

partialResultsMode

java.lang.String partialResultsMode

Support partial results mode or not.

fetchSize

int fetchSize

Default fetch size, <= 0 indicates not set.

resultSetCacheMode

java.lang.String resultSetCacheMode

Whether to use result set cache if it available

loginTimeout

int loginTimeout

The number of milliseconds before timing out. This property is optional and defaults to "0" (meaning no time out).

sqlOptions

java.lang.String sqlOptions

disableLocalTxn

java.lang.String disableLocalTxn

transactionAutoWrap

java.lang.String transactionAutoWrap

A setting that controls how connections created by this DataSource manage transactions for client requests when client applications do not use transactions. Because a MetaMatrix virtual database will likely deal with multiple underlying information sources, the MetaMatrix XA Server will execute all client requests within the contexts of transactions. This method determines the semantics of creating such transactions when the client does not explicitly do so.

The allowable values for this property are:

• "OFF" - Nothing is ever wrapped in a transaction and the server will execute multi-source updates happily but outside a transaction. This is least safe but highest performance. The BaseDataSource.TXN_AUTO_WRAP_OFF constant value is provided for convenience.
• "ON" - Always wrap every command in a transaction. This is most safe but lowest performance. The BaseDataSource.TXN_AUTO_WRAP_ON constant value is provided for convenience.
• "PESSIMISTIC" - Assume that any command might require a transaction. Make a server call to check whether the command being executed needs a transaction and wrap the command in a transaction if necessary. This will auto wrap in exactly the cases where it is needed but requires an extra server call on every command execution (including queries). This is as safe as ON, but lower performance than OFF for cases where no transaction is actually needed (like queries). This is the default value. The BaseDataSource.TXN_AUTO_WRAP_PESSIMISTIC constant value is provided for convenience.
• "OPTIMISTIC" - same as OFF but assume that no command not in a transaction actually needs one. In other words, we're letting the user decide when to use and not use a transaction and assuming they are doing it correctly. Only difference from OFF is that if the user executes a command that requires a transaction but they don't use one, we will detect this and throw an exception. This provides the safety of ON or PESSIMISTIC mode but better performance in the common case of queries that are not multi-source. The BaseDataSource.TXN_AUTO_WRAP_OPTIMISTIC constant value is provided for convenience.

This property is important only if connecting to a MetaMatrix XA Server.

additionalProperties

java.lang.String additionalProperties

String to hold additional properties that are not represented with an explicit getter/setter

Class com.metamatrix.jdbc.EmbeddedDataSource extends BaseDataSource implements Serializable

Serialized Fields

bootstrapFile

java.lang.String bootstrapFile

configFile - The path and file name to which embedded DQP configuration info will be read. This property is optional; if none is specified, then embedded DQP access cannot be used.

maxStatements

int maxStatements

maxstatements - The total number of statements that the pool should keep open. 0 (zero) indicates that caching of statements is disabled.

initialPoolSize

int initialPoolSize

initialPoolSize - The number of physical connections the pool should contain when it is created

minPoolSize

int minPoolSize

minPoolSize - The number of physical connections the pool should keep available at all times. 0 (zero) indicates that connections should be created as needed.

maxPoolSize

int maxPoolSize

maxPoolSize - The maximum number of physical connections that the pool should contain. 0 (zero) indicates no maximum size.

maxIdleTime

int maxIdleTime

maxIdleTime - The number of seconds that a physical connection should remain unused in the pool before the connection is closed. 0 (zero) indicates no limit.

propertyCycle

int propertyCycle

propertyCycle - The interval, in seconds, that the pool should wait before enforcing the current policy defined by the values of the above connection pool properties

Class com.metamatrix.jdbc.EmbeddedSQLException extends java.sql.SQLException implements Serializable

Serialized Fields

parentException

java.lang.Throwable parentException

message

java.lang.String message

Class com.metamatrix.jdbc.MMDataSource extends BaseDataSource implements Serializable

Serialized Fields

portNumber

int portNumber

The port number where a MetaMatrix Server is listening for requests. This property name is one of the standard property names defined by the JDBC 2.0 specification, and is optional.

serverName

java.lang.String serverName

The name of the host where the MetaMatrix Server is running. This property name is one of the standard property names defined by the JDBC 2.0 specification, and is required.

credentials

java.lang.String credentials

Specify a set of data source credentials to pass to the connectors as defined in MMURL.JDBC.CREDENTIALS.

secure

boolean secure

Specify whether to make a secure (SSL, mms:) connection or a normal non-SSL mm: connection. the default is to use a non-secure connection.

Since:

5.0.2

alternateServers

java.lang.String alternateServers

Holds a comma delimited list of alternate MetaMatrix Server(s):Port(s) that can be used for connection fail-over.

Since:

5.5

autoFailover

java.lang.String autoFailover

The auto failover mode for calls made to the query engine. If true query engine calls that fail will allow the connection to choose another process.

discoveryStrategy

java.lang.String discoveryStrategy

Class com.metamatrix.jdbc.MMSQLException extends java.sql.SQLException implements Serializable

Package com.metamatrix.jdbc.api

Class com.metamatrix.jdbc.api.PartialResultsWarning extends java.sql.SQLWarning implements Serializable

Serialized Fields

failures

java.util.Map<K,V> failures