![]() ![]() ![]() ![]() |
Persistence: Plugins: DB2 Dictionary Configuration
Configuration Options Related Tasks Related Topics
This page shows the attributes of a DB2 Dictionary configuration.
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 When true, the dictionary will use ResultSet.getString to obtain clob data rather than ResultSet.getCharacterStream.
MBean Attribute:
BuiltInDBDictionaryBean.UseGetStringForClobs
Changes take effect after you redeploy the module or restart the server.
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:
BuiltInDBDictionaryBean.SupportsRestrictUpdateAction
Changes take effect after you redeploy the module or restart the server.
Auto Assign Clause The magic word(s) to append to the column definition of a SQL statement that creates an auto-assignment column. For example, "AUTO_INCREMENT" for MySQL. Used only when the mapping tool generates a schema.
MBean Attribute:
BuiltInDBDictionaryBean.AutoAssignClause
Changes take effect after you redeploy the module or restart the server.
Supports Multiple Nontransactional Result Sets When true, a nontransactional JDBC connection to the database is capable of having multiple open ResultSet instances.
MBean Attribute:
BuiltInDBDictionaryBean.SupportsMultipleNontransactionalResultSets
Changes take effect after you redeploy the module or restart the server.
Bit Length Function This property is not used.
MBean Attribute:
BuiltInDBDictionaryBean.BitLengthFunction
Changes take effect after you redeploy the module or restart the server.
Create Primary Keys When true, create database primary keys for identifiers.
MBean Attribute:
BuiltInDBDictionaryBean.CreatePrimaryKeys
Changes take effect after you redeploy the module or restart the server.
Null Type Name The default name for the column type indicated by java.sql.Types.NULL. The mapping tool uses the name when it generates a schema.
MBean Attribute:
BuiltInDBDictionaryBean.NullTypeName
Changes take effect after you redeploy the module or restart the server.
Float Type Name The default name for the column type indicated by java.sql.Types.FLOAT. The mapping tool uses the name when it generates a schema.
MBean Attribute:
BuiltInDBDictionaryBean.FloatTypeName
Changes take effect after you redeploy the module or restart the server.
Use Get Bytes For Blobs When true, the dictionary will use ResultSet.getBytes to obtain blob data rather than ResultSet.getBinaryStream.
MBean Attribute:
BuiltInDBDictionaryBean.UseGetBytesForBlobs
Changes take effect after you redeploy the module or restart the server.
Table Types Comma-separated list of table types to use when looking for tables during schema reflection, as defined in the JDBC method java.sql.DatabaseMetaData.getTableInfo. Examples are "TABLE" and "TABLE,VIEW,ALIAS".
MBean Attribute:
BuiltInDBDictionaryBean.TableTypes
Changes take effect after you redeploy the module or restart the server.
Numeric Type Name The default name for the column type indicated by java.sql.Types.NUMERIC. The mapping tool uses the name when it generates a schema.
MBean Attribute:
BuiltInDBDictionaryBean.NumericTypeName
Changes take effect after you redeploy the module or restart the server.
Table For Update Clause The clause to append to the end of each table alias in queries that obtain pessimistic locks.
MBean Attribute:
BuiltInDBDictionaryBean.TableForUpdateClause
Changes take effect after you redeploy the module or restart the server.
Integer Type Name The default name for the column type indicated by java.sql.Types.INTEGER. The mapping tool uses the name when it generates a schema.
MBean Attribute:
BuiltInDBDictionaryBean.IntegerTypeName
Changes take effect after you redeploy the module or restart the server.
Blob Type Name The default name for the column type indicated by java.sql.Types.BLOB. The mapping tool uses the name when it generates a schema.
MBean Attribute:
BuiltInDBDictionaryBean.BlobTypeName
Changes take effect after you redeploy the module or restart the server.
For Update Clause The clause to append to SQL select statements to issue queries that obtain pessimistic locks. The clause is usually FOR UPDATE.
MBean Attribute:
BuiltInDBDictionaryBean.ForUpdateClause
Changes take effect after you redeploy the module or restart the server.
Boolean Type Name The default name for the column type indicated by java.sql.Types.BOOLEAN. The mapping tool uses the name when it generates a schema.
MBean Attribute:
BuiltInDBDictionaryBean.BooleanTypeName
Changes take effect after you redeploy the module or restart the server.
Use Get Best Row Identifier For Primary Keys When true, metadata queries will use DatabaseMetaData.getBestRowIdentifier to obtain information about primary keys, rather than DatabaseMetaData.getPrimaryKeys.
MBean Attribute:
BuiltInDBDictionaryBean.UseGetBestRowIdentifierForPrimaryKeys
Changes take effect after you redeploy the module or restart the server.
Supports Foreign Keys When true, the database supports foreign keys.
MBean Attribute:
BuiltInDBDictionaryBean.SupportsForeignKeys
Changes take effect after you redeploy the module or restart the server.
Drop Table SQL The SQL statement used to drop a table. Use the token {0} as the argument for the table name.
MBean Attribute:
BuiltInDBDictionaryBean.DropTableSQL
Changes take effect after you redeploy the module or restart the server.
Use Set String For Clobs When true, the dictionary will use PreparedStatement.setString to set clob data, rather than PreparedStatement.setCharacterStream.
MBean Attribute:
BuiltInDBDictionaryBean.UseSetStringForClobs
Changes take effect after you redeploy the module or restart the server.
Supports Locking With Order Clause When true, the database supports FOR UPDATE clauses in SQL select statements with ORDER BY clauses.
MBean Attribute:
BuiltInDBDictionaryBean.SupportsLockingWithOrderClause
Changes take effect after you redeploy the module or restart the server.
Platform The name of the database that this dictionary targets.
MBean Attribute:
BuiltInDBDictionaryBean.Platform
Changes take effect after you redeploy the module or restart the server.
Fixed Size Type Names A comma separated list of additional database types that have a size defined by the database. In other words, when a column of a fixed size type is declared, its size cannot be defined by the user. Common examples would be DATE, FLOAT, and INTEGER.
Each database dictionary has its own internal set of fixed size type names (fixedSizeTypeNameSet) that include the names mentioned above and many others.
Names added to this property are added to the dictionary's internal set.
MBean Attribute:
BuiltInDBDictionaryBean.FixedSizeTypeNames
Changes take effect after you redeploy the module or restart the server.
Store Chars As Numbers When true, the dictionary prefers to store Java char fields as numbers rather than as CHAR values.
MBean Attribute:
BuiltInDBDictionaryBean.StoreCharsAsNumbers
Changes take effect after you redeploy the module or restart the server.
Max Indexes Per Table The maximum number of indexes that can be placed on a single table.
MBean Attribute:
BuiltInDBDictionaryBean.MaxIndexesPerTable
Changes take effect after you redeploy the module or restart the server.
Requires Cast For Comparisons When true, comparisons of two values of different types or of two literals requires a cast in the generated SQL.
MBean Attribute:
BuiltInDBDictionaryBean.RequiresCastForComparisons
Changes take effect after you redeploy the module or restart the server.
Supports Having When true, the database supports HAVING clauses in SQL select statements.
MBean Attribute:
BuiltInDBDictionaryBean.SupportsHaving
Changes take effect after you redeploy the module or restart the server.
Supports Locking With Outer Join When true, the database supports FOR UPDATE clauses in SQL select statements with outer join clauses.
MBean Attribute:
BuiltInDBDictionaryBean.SupportsLockingWithOuterJoin
Changes take effect after you redeploy the module or restart the server.
Supports Correlated Subselect When true, the database supports correlated subselects. Correlated subselects are select statements nested within select statements that refers to a column in the outer select statement. For performance reasons, correlated subselects are generally a last resort.
MBean Attribute:
BuiltInDBDictionaryBean.SupportsCorrelatedSubselect
Changes take effect after you redeploy the module or restart the server.
Supports Null Table For Get Imported Keys When true, the database supports passing a null parameter to DatabaseMetaData.getImportedKeys as an optimization to get information on all tables.
MBean Attribute:
BuiltInDBDictionaryBean.SupportsNullTableForGetImportedKeys
Changes take effect after you redeploy the module or restart the server.
Bigint Type Name The default name for the column type indicated by java.sql.Types.BIGINT. The mapping tool uses the name when it generates a schema.
MBean Attribute:
BuiltInDBDictionaryBean.BigintTypeName
Changes take effect after you redeploy the module or restart the server.
Last Generated Key Query The query to issue to obtain the last automatically generated key for an auto-increment column. For example, "SELECT LAST_INSERT_ID()" for MySQL.
MBean Attribute:
BuiltInDBDictionaryBean.LastGeneratedKeyQuery
Changes take effect after you redeploy the module or restart the server.
Reserved Words A comma-separated list of reserved words for the database, beyond the standard SQL92 keywords.
MBean Attribute:
BuiltInDBDictionaryBean.ReservedWords
Changes take effect after you redeploy the module or restart the server.
Supports Null Update Action When true, the database supports the SET NULL update action on foreign keys.
MBean Attribute:
BuiltInDBDictionaryBean.SupportsNullUpdateAction
Changes take effect after you redeploy the module or restart the server.
Use Schema Name When true, the dictionary generates SQL that uses the schema name with the table name.
MBean Attribute:
BuiltInDBDictionaryBean.UseSchemaName
Changes take effect after you redeploy the module or restart the server.
Supports Deferred Constraints When true, the database supports deferred constraints. The database supports deferred constraints by checking for constraint violations when the transaction commits, rather than checking for violations immediately after receiving each SQL statement within the transaction.
MBean Attribute:
BuiltInDBDictionaryBean.SupportsDeferredConstraints
Changes take effect after you redeploy the module or restart the server.
Real Type Name The default name for the column type indicated by java.sql.Types.REAL. The mapping tool uses the name when it generates a schema.
MBean Attribute:
BuiltInDBDictionaryBean.RealTypeName
Changes take effect after you redeploy the module or restart the server.
Requires Alias For Subselect When true, the database requires that subselects in a FROM clause be assigned an alias.
MBean Attribute:
BuiltInDBDictionaryBean.RequiresAliasForSubselect
Changes take effect after you redeploy the module or restart the server.
Supports Null Table For Get Index Info When true, the database supports passing a null parameter to DatabaseMetaData.getIndexInfo as an optimization to get information on all tables.
MBean Attribute:
BuiltInDBDictionaryBean.SupportsNullTableForGetIndexInfo
Changes take effect after you redeploy the module or restart the server.
Trim Trailing Function The SQL function call to trim any number of a particular character from the end 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.TrimTrailingFunction
Changes take effect after you redeploy the module or restart the server.
Supports Locking With Select Range When true, the database supports FOR UPDATE clauses in SQL select statements select a range of data using LIMIT, TOP or equivalent database specific clause.
MBean Attribute:
BuiltInDBDictionaryBean.SupportsLockingWithSelectRange
Changes take effect after you redeploy the module or restart the server.
Storage Limitations Fatal When true, then any data truncation or rounding that is performed by the dictionary in order to store a value in the database will be treated as a fatal error. Otherwise, the dictionary issues a warning.
MBean Attribute:
BuiltInDBDictionaryBean.StorageLimitationsFatal
Changes take effect after you redeploy the module or restart the server.
Supports Locking With Inner Join When true, the database supports FOR UPDATE clauses in SQL select statements with inner join clauses.
MBean Attribute:
BuiltInDBDictionaryBean.SupportsLockingWithInnerJoin
Changes take effect after you redeploy the module or restart the server.
Current Timestamp Function The SQL function call to obtain the current timestamp from the database.
MBean Attribute:
BuiltInDBDictionaryBean.CurrentTimestampFunction
Changes take effect after you redeploy the module or restart the server.
Cast Function The SQL function call to cast a value to another SQL type. Use the tokens {0} and {1} to represent the two arguments. The result of the function is convert the {0} value to a {1} type.
MBean Attribute:
BuiltInDBDictionaryBean.CastFunction
Changes take effect after you redeploy the module or restart the server.
Other Type Name The default name for the column type indicated by java.sql.Types.OTHER. The mapping tool uses the name when it generates a schema.
MBean Attribute:
BuiltInDBDictionaryBean.OtherTypeName
Changes take effect after you redeploy the module or restart the server.
Max Index Name Length The maximum number of characters in an index name.
MBean Attribute:
BuiltInDBDictionaryBean.MaxIndexNameLength
Changes take effect after you redeploy the module or restart the server.
Distinct Type Name The default name for the column type indicated by java.sql.Types.DISTINCT. The mapping tool uses the name when it generates a schema.
MBean Attribute:
BuiltInDBDictionaryBean.DistinctTypeName
Changes take effect after you redeploy the module or restart the server.
Character Column Size The default size of VARCHAR and CHAR columns, typically 255.
MBean Attribute:
BuiltInDBDictionaryBean.CharacterColumnSize
Changes take effect after you redeploy the module or restart the server.
Varbinary Type Name The default name for the column type indicated by java.sql.Types.VARBINARY. The mapping tool uses the name when it generates a schema.
MBean Attribute:
BuiltInDBDictionaryBean.VarbinaryTypeName
Changes take effect after you redeploy the module or restart the server.
Max Table Name Length The maximum number of characters in a table name.
MBean Attribute:
BuiltInDBDictionaryBean.MaxTableNameLength
Changes take effect after you redeploy the module or restart the server.
Close Pool SQL A special command to issue to the database when shutting down the pool.
Usually the pool of connections to the database is closed when the application is ending. For embedded databases, whose lifecycle is coterminous with the application, there may be a special command, usually "SHUTDOWN", that will cause the database to close cleanly.
MBean Attribute:
BuiltInDBDictionaryBean.ClosePoolSQL
Changes take effect after you redeploy the module or restart the server.
Current Date Function The SQL function call to obtain the current date from the database.
MBean Attribute:
BuiltInDBDictionaryBean.CurrentDateFunction
Changes take effect after you redeploy the module or restart the server.
Join Syntax The style of SQL join syntax to use in select statements.
sql92 - ANSI SQL92 join syntax where joins are expressed in the SQL FROM clause. Outer joins are supported. Not all databases support this syntax.
traditional - Traditional SQL join syntax where joins are expressed in the SQL WHERE clause. Outer joins are not supported.
database - Join syntax is encoded to some extent within the dictionary class for the database. Outer joins may be supported.
MBean Attribute:
BuiltInDBDictionaryBean.JoinSyntax
Changes take effect after you redeploy the module or restart the server.
Max Embedded Blob Size When greater than -1, the maximum size of a BLOB value that can be sent directly to the database within an insert or update statement. Values whose size is greater than MaxEmbeddedBlobSize force OpenJPA to work around this limitation. A value of -1 means that there is no limitation.
MBean Attribute:
BuiltInDBDictionaryBean.MaxEmbeddedBlobSize
Changes take effect after you redeploy the module or restart the server.
Trim Both Function The SQL function call to trim any number of a particular character from both the start and end 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.TrimBothFunction
Changes take effect after you redeploy the module or restart the server.
Supports Select Start Index When true, the database supports SQL select statements that skip the first N results.
MBean Attribute:
BuiltInDBDictionaryBean.SupportsSelectStartIndex
Changes take effect after you redeploy the module or restart the server.
To Lower Case Function The SQL function call to convert a string to lower case. Use the token {0} to represent the argument.
MBean Attribute:
BuiltInDBDictionaryBean.ToLowerCaseFunction
Changes take effect after you redeploy the module or restart the server.
Array Type Name The default name for the column type indicated by java.sql.Types.ARRAY. The mapping tool uses the name when it generates a schema.
MBean Attribute:
BuiltInDBDictionaryBean.ArrayTypeName
Changes take effect after you redeploy the module or restart the server.
Inner Join Clause The SQL clause to express an inner join.
MBean Attribute:
BuiltInDBDictionaryBean.InnerJoinClause
Changes take effect after you redeploy the module or restart the server.
Supports Default Update Action When true, the database supports the SET DEFAULT update action on foreign keys.
MBean Attribute:
BuiltInDBDictionaryBean.SupportsDefaultUpdateAction
Changes take effect after you redeploy the module or restart the server.
Supports Schema For Get Columns When true, the database driver supports using the schema name for schema reflection on column names.
MBean Attribute:
BuiltInDBDictionaryBean.SupportsSchemaForGetColumns
Changes take effect after you redeploy the module or restart the server.
Tinyint Type Name The default name for the column type indicated by java.sql.Types.TINYINT. The mapping tool uses the name when it generates a schema.
MBean Attribute:
BuiltInDBDictionaryBean.TinyintTypeName
Changes take effect after you redeploy the module or restart the server.
Supports Null Table For Get Primary Keys When true, the database supports passing a null parameter to DatabaseMetaData.getPrimaryKeys as an optimization to get information on all tables.
MBean Attribute:
BuiltInDBDictionaryBean.SupportsNullTableForGetPrimaryKeys
Changes take effect after you redeploy the module or restart the server.
System Schemas A comma-separated list of schema names that should be ignored.
MBean Attribute:
BuiltInDBDictionaryBean.SystemSchemas
Changes take effect after you redeploy the module or restart the server.
Requires Cast For Math Functions When true, math operations on two values of different types or on two literals requires a cast in the generated SQL.
MBean Attribute:
BuiltInDBDictionaryBean.RequiresCastForMathFunctions
Changes take effect after you redeploy the module or restart the server.
Supports Null Delete Action When true, the database supports the SET NULL delete action on foreign keys.
MBean Attribute:
BuiltInDBDictionaryBean.SupportsNullDeleteAction
Changes take effect after you redeploy the module or restart the server.
Requires Auto Commit For Meta Data When true, the JDBC driver requires that autocommit be enabled before any schema interrogation operations can take place.
MBean Attribute:
BuiltInDBDictionaryBean.RequiresAutoCommitForMetaData
Changes take effect after you redeploy the module or restart the server.
Timestamp Type Name The default name for the column type indicated by java.sql.Types.TIMESTAMP. The mapping tool uses the name when it generates a schema.
MBean Attribute:
BuiltInDBDictionaryBean.TimestampTypeName
Changes take effect after you redeploy the module or restart the server.
Initialization SQL A SQL statement to initialize a connection after obtaining it from the DataSource. The dictionary normally uses this to work around any JDBC bugs.
MBean Attribute:
BuiltInDBDictionaryBean.InitializationSQL
Changes take effect after you redeploy the module or restart the server.
Supports Cascade Delete Action When true, the database supports the CASCADE delete action on foreign keys.
MBean Attribute:
BuiltInDBDictionaryBean.SupportsCascadeDeleteAction
Changes take effect after you redeploy the module or restart the server.
![]() |