edocs Home > Oracle WebLogic Server Documentation > Administration Console Online Help > Persistence: Plugins: HSQL Dictionary
Persistence: Plugins: HSQL Dictionary
Configuration Options Related Tasks Related Topics
This page shows the attributes of a HSQL Dictionary.
Configuration Options
Name Description Char Type Name The default name for the column type indicated by java.sql.Types.CHAR. The mapping tool uses the name when it generates a schema.
MBean Attribute:
BuiltInDBDictionaryBean.CharTypeName
Changes take effect after you redeploy the module or restart the server.
Outer Join Clause The SQL clause to express a left outer join.
MBean Attribute:
BuiltInDBDictionaryBean.OuterJoinClause
Changes take effect after you redeploy the module or restart the server.
Binary Type Name The default name for the column type indicated by java.sql.Types.BINARY. The mapping tool uses the name when it generates a schema.
MBean Attribute:
BuiltInDBDictionaryBean.BinaryTypeName
Changes take effect after you redeploy the module or restart the server.
Clob Type Name The default name for the column type indicated by java.sql.Types.CLOB. The mapping tool uses the name when it generates a schema.
MBean Attribute:
BuiltInDBDictionaryBean.ClobTypeName
Changes take effect after you redeploy the module or restart the server.
Supports Locking With Distinct Clause When true, the database supports FOR UPDATE clauses in SQL select statements with DISTINCT clauses.
MBean Attribute:
BuiltInDBDictionaryBean.SupportsLockingWithDistinctClause
Changes take effect after you redeploy the module or restart the server.
Simulate Locking Setting this property to true bypasses Kodo's attempt, when executing a transaction with the pessimistic lock manager, to lock records in the database upon load.
Because some databases do not support pessimistic locking, attempting a pessimistic transaction within Kodo will result in an exception with these databases unless this property is set to true. At the same time, setting this property to true means that the semantics of a pessimistic transaction with the database are not obtained.
MBean Attribute:
BuiltInDBDictionaryBean.SimulateLocking
Changes take effect after you redeploy the module or restart the server.
System Tables A comma-separated list of table names that the dictionary should ignored.
MBean Attribute:
BuiltInDBDictionaryBean.SystemTables
Changes take effect after you redeploy the module or restart the server.
Concatenate Function The SQL function call or operation to concatenate two strings. Use the tokens {0} and {1} to represent the two arguments. The result of the function or operation is to concatenate the {1} string to the end of the {0} string.
MBean Attribute:
BuiltInDBDictionaryBean.ConcatenateFunction
Changes take effect after you redeploy the module or restart the server.
Sub Function Name MBean Attribute:
BuiltInDBDictionaryBean.SubFunctionName
Changes take effect after you redeploy the module or restart the server.
Supports Query Timeout When true, the JDBC driver supports calls to java.sql.Statement.setQueryTimeout.
MBean Attribute:
BuiltInDBDictionaryBean.SupportsQueryTimeout
Changes take effect after you redeploy the module or restart the server.
Use Set Bytes For Blobs When true, the dictionary will use PreparedStatement.setBytes to set blob data, rather than PreparedStatement.setBinaryStream.
MBean Attribute:
BuiltInDBDictionaryBean.UseSetBytesForBlobs
Changes take effect after you redeploy the module or restart the server.
Max Constraint Name Length The maximum number of characters in a constraint name.
MBean Attribute:
BuiltInDBDictionaryBean.MaxConstraintNameLength
Changes take effect after you redeploy the module or restart the server.
Search Escape MBean Attribute:
BuiltInDBDictionaryBean.SearchEscape
Changes take effect after you redeploy the module or restart the server.
Supports Cascade Update Action When true, the database supports the CASCADE update action on foreign keys.
MBean Attribute:
BuiltInDBDictionaryBean.SupportsCascadeUpdateAction
Changes take effect after you redeploy the module or restart the server.
String Length Function The SQL function call to get the length of a string. Use the token {0} to represent the argument.
MBean Attribute:
BuiltInDBDictionaryBean.StringLengthFunction
Changes take effect after you redeploy the module or restart the server.
get Long Varbinary Type Name MBean Attribute:
BuiltInDBDictionaryBean.getLongVarbinaryTypeName
Changes take effect after you redeploy the module or restart the server.
Supports Unique Constraints When true, the database supports unique constraints.
MBean Attribute:
BuiltInDBDictionaryBean.SupportsUniqueConstraints
Changes take effect after you redeploy the module or restart the server.
Supports Restrict Delete Action When true, the database supports the RESTRICT delete action on foreign keys.
MBean Attribute:
BuiltInDBDictionaryBean.SupportsRestrictDeleteAction
Changes take effect after you redeploy the module or restart the server.
Trim Leading Function The SQL function call to trim any number of a particular character from the start of a string.
Note: some databases do not support specifying the character in which case only spaces or whitespace can be trimmed.
Use the token {1} when possible to represent the character, and the token {0} to represent the string.
MBean Attribute:
BuiltInDBDictionaryBean.TrimLeadingFunction
Changes take effect after you redeploy the module or restart the server.
Supports Default Delete Action When true, the database supports the SET DEFAULT delete action on foreign keys.
MBean Attribute:
BuiltInDBDictionaryBean.SupportsDefaultDeleteAction
Changes take effect after you redeploy the module or restart the server.
Next Sequence Query A SQL string for obtaining a native sequence value. May use a placeholder of {0} for the sequence name. For example, "SELECT {0}.NEXTVAL FROM DUAL" for Oracle.
MBean Attribute:
BuiltInDBDictionaryBean.NextSequenceQuery
Changes take effect after you redeploy the module or restart the server.
Long Varchar Type Name The default name for the column type indicated by java.sql.Types.LONGVARCHAR. The mapping tool uses the name when it generates a schema.
MBean Attribute:
BuiltInDBDictionaryBean.LongVarcharTypeName
Changes take effect after you redeploy the module or restart the server.
Cross Join Clause The SQL clause to express a cross join (cartesian product).
MBean Attribute:
BuiltInDBDictionaryBean.CrossJoinClause
Changes take effect after you redeploy the module or restart the server.
Max Embedded Clob Size When greater than -1, the maximum size of a CLOB value that can be sent directly to the database within an insert or update statement. Values whose size is greater than MaxEmbeddedClobSize force OpenJPA to work around this limitation. A value of -1 means that there is no limitation.
MBean Attribute:
BuiltInDBDictionaryBean.MaxEmbeddedClobSize
Changes take effect after you redeploy the module or restart the server.
Date Type Name The default name for the column type indicated by java.sql.Types.DATE. The mapping tool uses the name when it generates a schema.
MBean Attribute:
BuiltInDBDictionaryBean.DateTypeName
Changes take effect after you redeploy the module or restart the server.
Supports Schema For Get Tables When true, the database driver supports using the schema name for schema reflection on table names.
MBean Attribute:
BuiltInDBDictionaryBean.SupportsSchemaForGetTables
Changes take effect after you redeploy the module or restart the server.
Supports Alter Table With Drop Column When true, the database supports dropping a column in an ALTER TABLE statement.
MBean Attribute:
BuiltInDBDictionaryBean.SupportsAlterTableWithDropColumn
Changes take effect after you redeploy the module or restart the server.
Current Time Function The SQL function call to obtain the current time from the database.
MBean Attribute:
BuiltInDBDictionaryBean.CurrentTimeFunction
Changes take effect after you redeploy the module or restart the server.
Requires Condition For Cross Join When true, the database requires that there always be a conditional clause in any SQL statement expressing a cross join.
MBean Attribute:
BuiltInDBDictionaryBean.RequiresConditionForCrossJoin
Changes take effect after you redeploy the module or restart the server.
Ref Type Name The default name for the column type indicated by java.sql.Types.REF. The mapping tool uses the name when it generates a schema.
MBean Attribute:
BuiltInDBDictionaryBean.RefTypeName
Changes take effect after you redeploy the module or restart the server.
Concatenate Delimiter This property is not used.
MBean Attribute:
BuiltInDBDictionaryBean.ConcatenateDelimiter
Changes take effect after you redeploy the module or restart the server.
Catalog Separator The string the database uses to delimit between the schema name and the table name.
MBean Attribute:
BuiltInDBDictionaryBean.CatalogSeparator
Changes take effect after you redeploy the module or restart the server.
Supports Mod Operator When true, the database supports the modulus operator (%) instead of the MOD function.
MBean Attribute:
BuiltInDBDictionaryBean.SupportsModOperator
Changes take effect after you redeploy the module or restart the server.
Schema Case The case to use when querying the database metadata about schema components. Available values are: upper, lower, and preserve.
MBean Attribute:
BuiltInDBDictionaryBean.SchemaCase
Changes take effect after you redeploy the module or restart the server.
Java Object Type Name The default name for the column type indicated by java.sql.Types.JAVAOBJECT. The mapping tool uses the name when it generates a schema.
MBean Attribute:
BuiltInDBDictionaryBean.JavaObjectTypeName
Changes take effect after you redeploy the module or restart the server.
Driver Vendor Some dictionaries must alter their behavior depending on the driver's vendor. When used, the dictionary often sets this property using its own logic. To override this logic, see the VENDOR_XXX constants, if any, defined in the dictionary's Javadoc.
MBean Attribute:
BuiltInDBDictionaryBean.DriverVendor
Changes take effect after you redeploy the module or restart the server.
Supports Locking With Multiple Tables When true, the database supports FOR UPDATE clauses in SQL select statements that select from multiple tables.
MBean Attribute:
BuiltInDBDictionaryBean.SupportsLockingWithMultipleTables
Changes take effect after you redeploy the module or restart the server.
Max Column Name Length The maximum number of characters in a column name.
MBean Attribute:
BuiltInDBDictionaryBean.MaxColumnNameLength
Changes take effect after you redeploy the module or restart the server.
Double Type Name The default name for the column type indicated by java.sql.Types.DOUBLE. The mapping tool uses the name when it generates a schema.
MBean Attribute:
BuiltInDBDictionaryBean.DoubleTypeName
Changes take effect after you redeploy the module or restart the server.
Use Get String For Clobs Decimal Type Name The default name for the column type indicated by java.sql.Types.DECIMAL. The mapping tool uses the name when it generates a schema.
MBean Attribute:
BuiltInDBDictionaryBean.DecimalTypeName
Changes take effect after you redeploy the module or restart the server.
Smallint Type Name The default name for the column type indicated by java.sql.Types.SMALLINT. The mapping tool uses the name when it generates a schema.
MBean Attribute:
BuiltInDBDictionaryBean.SmallintTypeName
Changes take effect after you redeploy the module or restart the server.
Date Precision The database is able to store time values to this degree of precision, which is expressed in nanoseconds.
This value is usually one million, meaning that the database is able to store time values with a precision of one millisecond. Particular databases may have more or less precision.
Kodo and OpenJPA will round all time values to this degree of precision before storing them in the database.
MBean Attribute:
BuiltInDBDictionaryBean.DatePrecision
Changes take effect after you redeploy the module or restart the server.
Supports Alter Table With Add Column When true, the database supports adding a new column in an ALTER TABLE statement.
MBean Attribute:
BuiltInDBDictionaryBean.SupportsAlterTableWithAddColumn
Changes take effect after you redeploy the module or restart the server.
Bit Type Name The default name for the column type indicated by java.sql.Types.BIT. The mapping tool uses the name when it generates a schema.
MBean Attribute:
BuiltInDBDictionaryBean.BitTypeName
Changes take effect after you redeploy the module or restart the server.
Supports Null Table For Get Columns When true, the database supports passing a null parameter to DatabaseMetaData.getColumns as an optimization to get information on all tables.
MBean Attribute:
BuiltInDBDictionaryBean.SupportsNullTableForGetColumns
Changes take effect after you redeploy the module or restart the server.
To Upper Case Function The SQL function call to convert a string to upper case. Use the token {0} to represent the argument.
MBean Attribute:
BuiltInDBDictionaryBean.ToUpperCaseFunction
Changes take effect after you redeploy the module or restart the server.
Supports Select End Index When true, the database supports SQL select statements that do not return more than the first N results.
MBean Attribute:
BuiltInDBDictionaryBean.SupportsSelectEndIndex
Changes take effect after you redeploy the module or restart the server.
Supports Auto Assign When true, the database supports auto-assign columns where the value of column is assigned upon insertion of the row into the database.
MBean Attribute:
BuiltInDBDictionaryBean.SupportsAutoAssign
Changes take effect after you redeploy the module or restart the server.
Store Large Numbers As Strings When true, the dictionary prefers to store large numbers (Java fields of type BigInteger and BigDecimal) as string values in the database. Likewise, the dictionary will instruct the mapping tool to map the BigInteger or BigDecimal fields to character columns.
Because many databases have limitations on the number of digits that can be stored in a numeric column (for example, Oracle can only store 38 digits), this option may be necessary for some applications.
Note that this option may prevent Kodo from executing meaningful numeric queries against the columns.
MBean Attribute:
BuiltInDBDictionaryBean.StoreLargeNumbersAsStrings
Changes take effect after you redeploy the module or restart the server.
Constraint Name Mode MBean Attribute:
BuiltInDBDictionaryBean.ConstraintNameMode
Changes take effect after you redeploy the module or restart the server.
Allows Alias In Bulk Clause When true, SQL delete and update statements may use table aliases.
MBean Attribute:
BuiltInDBDictionaryBean.AllowsAliasInBulkClause
Changes take effect after you redeploy the module or restart the server.
Supports Select For Update When true, the database supports SQL select statements with a pessimistic locking (FOR UPDATE) clause.
MBean Attribute:
BuiltInDBDictionaryBean.SupportsSelectForUpdate
Changes take effect after you redeploy the module or restart the server.
Distinct Count Column Separator The string the database uses to delimit between column expressions in a SELECT COUNT(DISTINCT column-list) clause. Defaults to null for most databases, meaning that they do not support multiple columns in a distinct COUNT clause.
MBean Attribute:
BuiltInDBDictionaryBean.DistinctCountColumnSeparator
Changes take effect after you redeploy the module or restart the server.
Supports Subselect When true, the database supports SQL select statements with subselect clauses.
MBean Attribute:
BuiltInDBDictionaryBean.SupportsSubselect
Changes take effect after you redeploy the module or restart the server.
Time Type Name The default name for the column type indicated by java.sql.Types.TIME. The mapping tool uses the name when it generates a schema.
MBean Attribute:
BuiltInDBDictionaryBean.TimeTypeName
Changes take effect after you redeploy the module or restart the server.
Auto Assign Type Name The default name for the column type used for auto-increment columns. For example, "BIGSERIAL" for PostgreSQL. The mapping tool uses the name when it generates a schema.
MBean Attribute:
BuiltInDBDictionaryBean.AutoAssignTypeName
Changes take effect after you redeploy the module or restart the server.
Use Get Object For Blobs When true, the dictionary will use ResultSet.getObject to obtain blob data rather than ResultSet.getBinaryStream.
MBean Attribute:
BuiltInDBDictionaryBean.UseGetObjectForBlobs
Changes take effect after you redeploy the module or restart the server.
Max Auto Assign Name Length The maximum number of characters in the name of a sequence used for auto-increment columns. Any name provided that is longer than this value is truncated.
MBean Attribute:
BuiltInDBDictionaryBean.MaxAutoAssignNameLength
Changes take effect after you redeploy the module or restart the server.
Validation SQL The SQL used to validate that a connection to the database is still in working order. The SQL statement should impose minimum load on the database.
MBean Attribute:
BuiltInDBDictionaryBean.ValidationSQL
Changes take effect after you redeploy the module or restart the server.
Struct Type Name The default name for the column type indicated by java.sql.Types.STRUCT. The mapping tool uses the name when it generates a schema.
MBean Attribute:
BuiltInDBDictionaryBean.StructTypeName
Changes take effect after you redeploy the module or restart the server.
Varchar Type Name The default name for the column type indicated by java.sql.Types.VARCHAR. The mapping tool uses the name when it generates a schema.
MBean Attribute:
BuiltInDBDictionaryBean.VarcharTypeName
Changes take effect after you redeploy the module or restart the server.
Range Position Indicates where to specify in the SQL select statement the range, if any, of the result rows to be returned.
When limiting the number of returned result rows to a subset of all those that satisfy the query's conditions, the position of the range clause varies by database.
Examine the source code of the org.apache.openjpa.jdbc.sql.DBDictionary class to view the possible values and their effects.
MBean Attribute:
BuiltInDBDictionaryBean.RangePosition
Changes take effect after you redeploy the module or restart the server.
Supports Restrict Update Action When true, the database supports the RESTRICT update action on foreign keys.
MBean Attribute: