com.pega.pegarules.pub.database

Class DatabaseInformation

java.lang.Object

com.pega.pegarules.pub.database.DatabaseInformation

public class DatabaseInformation
extends java.lang.Object

An immutable representation of a particular database's meta data.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT
static int	DB_TYPE_APACHE
static int	DB_TYPE_CASSANDRA
static int	DB_TYPE_COUCHBASE
static int	DB_TYPE_DB2UDB
static int	DB_TYPE_DB2ZOS
static int	DB_TYPE_GENERIC Constants that define the DB family
static int	DB_TYPE_MSSQL
static int	DB_TYPE_ORACLE
static int	DB_TYPE_POSTGRES
static int	DB_TYPE_TERADATA
static java.lang.String	VERSION

Constructor Summary

Constructors

Constructor and Description
DatabaseInformation(java.lang.String aProductName, java.lang.String aProductVersion, int aProductMajorVersion, int aProductMinorVersion, java.lang.String aDriverName, java.lang.String aDriverVersion, int aProductFamily, java.lang.String aDelimiter, int aDriverMajorVersion, int aDriverMinorVersion)
DatabaseInformation(java.lang.String aProductName, java.lang.String aProductVersion, int aProductMajorVersion, int aProductMinorVersion, java.lang.String aDriverName, java.lang.String aDriverVersion, java.lang.String aConfigProductName, java.lang.String aDelimiter, int aDriverMajorVersion, int aDriverMinorVersion) Creates driver information.

Method Summary

Modifier and Type	Method and Description
int	getDatabaseType() Returns the product family Type.
java.lang.String	getDefaultSchemaForConnection() Deprecated.
java.lang.String	getDelimiter() Gets the string delimiter
int	getDriverMajorVersion() Gets the driverMajorVersion
int	getDriverMinorVersion() Gets the driverMinorVersion
java.lang.String	getDriverName() Gets the driverName
java.lang.String	getDriverVersion() Gets the driverVersion
int	getMaxEncodedCharSize() returns the max size of char in bytes, that it takes to write to database,If PRPC database is Unicode
int	getProductMajorVersion() Gets the productMajorVersion
int	getProductMinorVersion() Gets the productMinorVersion
java.lang.String	getProductName()
java.lang.String	getProductVersion() Gets the productVersion
boolean	isDB2UDB() Checks whether this database is db2 luw
boolean	isMSSQL() Checks whether this database is Microsoft SQL Server.
boolean	isOracle()
boolean	isPostgres() Checks whether this database is Postgres.
boolean	isUnicodeDatabase() Returns if PRPC database instance is UNICODE or Not
boolean	isVersionAtLeast(java.lang.String aMinimunVersion) Determines if the version number is at least the given version number.
boolean	isZOS() Checks whether this database is db2 z/os.
void	setDefaultSchemaForConnection(java.lang.String aDefaultSchemaForConnection) Sets the Default schema name for connection as defined in Data-Admin-DB-Name configuration this method is called from DatabaseInformationImpl explicitly to set the default schema name, The call from DatabaseInformationImpl is needed because mProductFamily is set only in this class.
void	setMaxEncodedCharSize(int maxEncodedCharSize) If PRPC database is Unicode, then max size of char in bytes, that it takes to write to database
void	setUnicodeDatabase(boolean isUnicodeDatabase) Sets if PRPC database instance is UNICODE or Not

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

See Also:

Constant Field Values

VERSION

public static final java.lang.String VERSION

DB_TYPE_GENERIC

public static final int DB_TYPE_GENERIC

Constants that define the DB family

See Also:

Constant Field Values

DB_TYPE_MSSQL

public static final int DB_TYPE_MSSQL

See Also:

Constant Field Values

DB_TYPE_DB2UDB

public static final int DB_TYPE_DB2UDB

See Also:

Constant Field Values

DB_TYPE_DB2ZOS

public static final int DB_TYPE_DB2ZOS

See Also:

Constant Field Values

DB_TYPE_ORACLE

public static final int DB_TYPE_ORACLE

See Also:

Constant Field Values

DB_TYPE_APACHE

public static final int DB_TYPE_APACHE

See Also:

Constant Field Values

DB_TYPE_POSTGRES

public static final int DB_TYPE_POSTGRES

See Also:

Constant Field Values

DB_TYPE_TERADATA

public static final int DB_TYPE_TERADATA

See Also:

Constant Field Values

DB_TYPE_COUCHBASE

public static final int DB_TYPE_COUCHBASE

See Also:

Constant Field Values

DB_TYPE_CASSANDRA

public static final int DB_TYPE_CASSANDRA

See Also:

Constant Field Values

Constructor Detail

DatabaseInformation

public DatabaseInformation(java.lang.String aProductName,
                           java.lang.String aProductVersion,
                           int aProductMajorVersion,
                           int aProductMinorVersion,
                           java.lang.String aDriverName,
                           java.lang.String aDriverVersion,
                           java.lang.String aConfigProductName,
                           java.lang.String aDelimiter,
                           int aDriverMajorVersion,
                           int aDriverMinorVersion)

Creates driver information.

Parameters:

aProductName - the product name

aProductVersion - the product version

aProductMajorVersion - the product version

aProductMinorVersion - the product version

aDriverName - the driver name

aDriverVersion - the driver version

aConfigProductName - the configured product name - For SQL generation

aDelimiter - the SQL delimiter for quoting column names

aDriverMajorVersion - the driver major version

aDriverMinorVersion - the driver minor version

DatabaseInformation

public DatabaseInformation(java.lang.String aProductName,
                           java.lang.String aProductVersion,
                           int aProductMajorVersion,
                           int aProductMinorVersion,
                           java.lang.String aDriverName,
                           java.lang.String aDriverVersion,
                           int aProductFamily,
                           java.lang.String aDelimiter,
                           int aDriverMajorVersion,
                           int aDriverMinorVersion)

Method Detail

getProductName

public java.lang.String getProductName()

Returns:

the product name

getProductVersion

public java.lang.String getProductVersion()

Gets the productVersion

Returns:

Returns a String

getProductMajorVersion

public int getProductMajorVersion()

Gets the productMajorVersion

Returns:

Returns a int

getProductMinorVersion

public int getProductMinorVersion()

Gets the productMinorVersion

Returns:

Returns a int

getDriverName

public java.lang.String getDriverName()

Gets the driverName

Returns:

Returns a String

getDriverVersion

public java.lang.String getDriverVersion()

Gets the driverVersion

Returns:

Returns a String

getDelimiter

public java.lang.String getDelimiter()

Gets the string delimiter

Returns:

Returns a String

getDriverMajorVersion

public int getDriverMajorVersion()

Gets the driverMajorVersion

Returns:

Returns a int

getDriverMinorVersion

public int getDriverMinorVersion()

Gets the driverMinorVersion

Returns:

Returns a int

getDefaultSchemaForConnection

@Deprecated
public java.lang.String getDefaultSchemaForConnection()

Deprecated.

WARNING: THIS METHOD IS DEPRECATED AND SHOULD NOT BE USED. Instead, a schema name should be obtained based on the class you are operating on, calling ClassDefinitionImpl.getClassName(). See mesh doc for more info here: https://mesh.pega.com/message/85592#85592 Gets the Default schema name for connection as defined in Data-Admin-DB-Name configuration

Returns:

Returns the schema name

setDefaultSchemaForConnection

public void setDefaultSchemaForConnection(java.lang.String aDefaultSchemaForConnection)

Sets the Default schema name for connection as defined in Data-Admin-DB-Name configuration this method is called from DatabaseInformationImpl explicitly to set the default schema name, The call from DatabaseInformationImpl is needed because mProductFamily is set only in this class.

Parameters:

aDefaultSchemaForConnection - the schema name to set

isOracle

public boolean isOracle()

isVersionAtLeast

public boolean isVersionAtLeast(java.lang.String aMinimunVersion)

Determines if the version number is at least the given version number. Any unspecified parts of the version string are assumed to be zero.

Parameters:

aMinimunVersion - - a string representation of the desired minimum version can be dot seperated - i.e. 10.2

Returns:

true if the db product is at least the given version number

getDatabaseType

public int getDatabaseType()

Returns the product family Type.

Returns:

an integer that represents the database product family used for this connection

isMSSQL

public boolean isMSSQL()

Checks whether this database is Microsoft SQL Server.

Returns:

True if SQL Server, false otherwise

isPostgres

public boolean isPostgres()

Checks whether this database is Postgres.

Returns:

True if Postgres, false otherwise

isZOS

public boolean isZOS()

Checks whether this database is db2 z/os.

Returns:

True if z/os, false otherwise

isDB2UDB

public boolean isDB2UDB()

Checks whether this database is db2 luw

Returns:

True if db2luw, false otherwise

setUnicodeDatabase

public void setUnicodeDatabase(boolean isUnicodeDatabase)

Sets if PRPC database instance is UNICODE or Not

Parameters:

isUnicodeDatabase -

isUnicodeDatabase

public boolean isUnicodeDatabase()

Returns if PRPC database instance is UNICODE or Not

Returns:

the mIsUniocodeDatabase

getMaxEncodedCharSize

public int getMaxEncodedCharSize()

returns the max size of char in bytes, that it takes to write to database,If PRPC database is Unicode

Returns:

the mMaxUnicodeCharSize

setMaxEncodedCharSize

public void setMaxEncodedCharSize(int maxEncodedCharSize)

If PRPC database is Unicode, then max size of char in bytes, that it takes to write to database

Parameters:

maxEncodedCharSize - the mMaxUnicodeCharSize to set