public interface AvailableSettings extends AvailableSettings
Modifier and Type | Field and Description |
---|---|
static String |
ACQUIRE_CONNECTIONS
Deprecated.
(since 5.2) use
CONNECTION_HANDLING instead |
static String |
ALLOW_JTA_TRANSACTION_ACCESS
Setting that allows access to the underlying
Transaction , even
when using a JTA since normal JPA operations prohibit this behavior. |
static String |
ALLOW_REFRESH_DETACHED_ENTITY
Setting that allows to call
EntityManager.refresh(Object)
or Session.refresh(Object) on a detached entity instance when the Session is obtained from
a JPA EntityManager ). |
static String |
ALLOW_UPDATE_OUTSIDE_TRANSACTION
Setting that allows to perform update operations outside of a transaction boundary.
|
static String |
APP_CLASSLOADER
Deprecated.
Use
CLASSLOADERS instead |
static String |
ARTIFACT_PROCESSING_ORDER
Used to specify the order in which metadata sources should be processed.
|
static String |
AUTO_CLOSE_SESSION
Enable automatic session close at end of transaction
|
static String |
AUTO_EVICT_COLLECTION_CACHE
Enables the automatic eviction of a bi-directional association's collection cache when an element in the
ManyToOne collection is added/updated/removed without properly managing the change on the OneToMany side.
|
static String |
AUTO_SESSION_EVENTS_LISTENER
Defines a default
SessionEventListener to be applied to opened Sessions. |
static String |
AUTOCOMMIT
Controls the autocommit mode of JDBC Connections obtained
from a non-DataSource ConnectionProvider - assuming the ConnectionProvider
impl properly leverages this setting (the provided Hibernate impls all
do).
|
static String |
BATCH_FETCH_STYLE
Names the
BatchFetchStyle to use. |
static String |
BATCH_STRATEGY
Select a custom batcher.
|
static String |
BATCH_VERSIONED_DATA
Should versioned data be included in batching?
|
static String |
BEAN_CONTAINER
Identifies an explicit
BeanContainer
to be used. |
static String |
BYTECODE_PROVIDER
Pick which bytecode enhancing library to use.
|
static String |
C3P0_ACQUIRE_INCREMENT
Number of connections acquired when pool is exhausted
|
static String |
C3P0_CONFIG_PREFIX
A setting prefix used to indicate settings that target the hibernate-c3p0 integration
|
static String |
C3P0_IDLE_TEST_PERIOD
Idle time before a C3P0 pooled connection is validated
|
static String |
C3P0_MAX_SIZE
Maximum size of C3P0 connection pool
|
static String |
C3P0_MAX_STATEMENTS
Maximum size of C3P0 statement cache
|
static String |
C3P0_MIN_SIZE
Minimum size of C3P0 connection pool
|
static String |
C3P0_TIMEOUT
Maximum idle time for C3P0 connection pool
|
static String |
CACHE_KEYS_FACTORY
Allow control to specify the
CacheKeysFactory impl to use. |
static String |
CACHE_PROVIDER_CONFIG
The CacheProvider implementation class
|
static String |
CACHE_REGION_FACTORY
The
RegionFactory implementation. |
static String |
CACHE_REGION_PREFIX
The CacheProvider region name prefix
|
static String |
CDI_BEAN_MANAGER
Used to pass along the CDI BeanManager, if any, to be used.
|
static String |
CHECK_NULLABILITY
Enable nullability checking.
|
static String |
CLASSLOADERS
Used to define a
Collection of the ClassLoader instances Hibernate should use for
class-loading and resource-lookups. |
static String |
COLLECTION_JOIN_SUBQUERY
Setting which indicates whether or not the new JOINS over collection tables should be rewritten to subqueries.
|
static String |
CONNECTION_HANDLING
Specifies how Hibernate should manage JDBC connections in terms of acquiring and releasing.
|
static String |
CONNECTION_PREFIX
Names a prefix used to define arbitrary JDBC connection properties.
|
static String |
CONNECTION_PROVIDER
Names the
ConnectionProvider to use for obtaining
JDBC connections. |
static String |
CONNECTION_PROVIDER_DISABLES_AUTOCOMMIT
Allows a user to tell Hibernate that the Connections we obtain from the configured
ConnectionProvider will already have auto-commit disabled when we acquire them from
the provider.
|
static String |
CONVENTIONAL_JAVA_CONSTANTS
Setting which indicates whether or not Java constant follow the Java Naming conventions.
|
static String |
CREATE_EMPTY_COMPOSITES_ENABLED
[EXPERIMENTAL] Enable instantiation of composite/embedded objects when all of its attribute values are
null . |
static String |
CRITERIA_LITERAL_HANDLING_MODE
By default, Criteria queries uses bind parameters for any literal that is not a numeric value.
|
static String |
CURRENT_SESSION_CONTEXT_CLASS
Context scoping impl for
SessionFactory.getCurrentSession() processing. |
static String |
CUSTOM_ENTITY_DIRTINESS_STRATEGY
Setting to identify a
CustomEntityDirtinessStrategy to use. |
static String |
DATASOURCE
Names a
DataSource . |
static String |
DEFAULT_BATCH_FETCH_SIZE
The default batch size for batch fetching
|
static String |
DEFAULT_CACHE_CONCURRENCY_STRATEGY
Setting used to give the name of the default
CacheConcurrencyStrategy
to use when either @Cacheable or
@Cache is used. |
static String |
DEFAULT_CATALOG
A default database catalog name to use for unqualified tablenames
|
static String |
DEFAULT_ENTITY_MODE
The EntityMode in which set the Session opened from the SessionFactory.
|
static String |
DEFAULT_NULL_ORDERING
Default precedence of null values in
ORDER BY clause. |
static String |
DEFAULT_SCHEMA
A default database schema (owner) name to use for unqualified tablenames
|
static String |
DELAY_ENTITY_LOADER_CREATIONS
Controls how the individual Loaders for an entity are created.
|
static String |
DIALECT
Names the Hibernate SQL
Dialect class |
static String |
DIALECT_RESOLVERS
Names any additional
DialectResolver implementations to
register with the standard DialectFactory . |
static String |
DRIVER
Names the JDBC driver class
|
static String |
ENABLE_LAZY_LOAD_NO_TRANS |
static String |
ENABLE_SYNONYMS
If enabled, allows schema update and validation to support synonyms.
|
static String |
ENFORCE_LEGACY_PROXY_CLASSNAMES
Configure the global BytecodeProvider implementation to generate class names matching the
existing naming patterns.
|
static String |
ENVIRONMENT_CLASSLOADER
Deprecated.
Use
CLASSLOADERS instead |
static String |
EXTRA_PHYSICAL_TABLE_TYPES
Identifies a comma-separate list of values to specify extra table types,
other than the default "TABLE" value, to recognize as defining a physical table
by schema update, creation and validation.
|
static String |
FAIL_ON_PAGINATION_OVER_COLLECTION_FETCH
Raises an exception when in-memory pagination over collection fetch is about to be performed.
|
static String |
FLUSH_BEFORE_COMPLETION
Enable automatic flush during the JTA beforeCompletion() callback
|
static String |
FORCE_DISCRIMINATOR_IN_SELECTS_BY_DEFAULT |
static String |
FORMAT_SQL
Enable formatting of SQL logged to the console
|
static String |
GENERATE_STATISTICS
Enable statistics collection
|
static String |
GLOBALLY_QUOTED_IDENTIFIERS
Should all database identifiers be quoted.
|
static String |
GLOBALLY_QUOTED_IDENTIFIERS_SKIP_COLUMN_DEFINITIONS
Assuming
GLOBALLY_QUOTED_IDENTIFIERS , this allows such global quoting
to skip column-definitions as defined by Column ,
JoinColumn , etc. |
static String |
HBM2DDL_AUTO
Setting to perform SchemaManagementTool actions automatically as part of
the SessionFactory lifecycle.
|
static String |
HBM2DDL_CHARSET_NAME
The name of the charset used by the schema generation resource.
|
static String |
HBM2DDL_CONNECTION
Allows passing a specific
Connection instance to be used by SchemaManagementTool. |
static String |
HBM2DDL_CREATE_SCRIPT_SOURCE
|
static String |
HBM2DDL_CREATE_SOURCE
Specifies whether schema generation commands for schema creation are to be determine based on object/relational
mapping metadata, DDL scripts, or a combination of the two.
|
static String |
HBM2DDL_DATABASE_ACTION
Setting to perform SchemaManagementTool actions against the database directly via JDBC
automatically as part of the SessionFactory lifecycle.
|
static String |
HBM2DDL_DB_MAJOR_VERSION
Specifies the major version of the underlying database, as would be returned by
DatabaseMetaData.getDatabaseMajorVersion() for the target database. |
static String |
HBM2DDL_DB_MINOR_VERSION
Specifies the minor version of the underlying database, as would be returned by
DatabaseMetaData.getDatabaseMinorVersion() for the target database. |
static String |
HBM2DDL_DB_NAME
Specifies the name of the database provider in cases where a Connection to the underlying database is
not available (aka, mainly in generating scripts).
|
static String |
HBM2DDL_DELIMITER
Identifies the delimiter to use to separate schema management statements in script outputs
|
static String |
HBM2DDL_DROP_SCRIPT_SOURCE
|
static String |
HBM2DDL_DROP_SOURCE
Specifies whether schema generation commands for schema dropping are to be determine based on object/relational
mapping metadata, DDL scripts, or a combination of the two.
|
static String |
HBM2DDL_FILTER_PROVIDER
Used to specify the
SchemaFilterProvider to be used by
create, drop, migrate and validate operations on the database schema. |
static String |
HBM2DDL_HALT_ON_ERROR
Whether the schema migration tool should halt on error, therefore terminating the bootstrap process.
|
static String |
HBM2DDL_IMPORT_FILES
Comma-separated names of the optional files containing SQL DML statements executed
during the SessionFactory creation.
|
static String |
HBM2DDL_IMPORT_FILES_SQL_EXTRACTOR
Reference to the
ImportSqlCommandExtractor implementation class
to use for parsing source/import files as defined by HBM2DDL_CREATE_SCRIPT_SOURCE ,
HBM2DDL_DROP_SCRIPT_SOURCE or HBM2DDL_IMPORT_FILES . |
static String |
HBM2DDL_JDBC_METADATA_EXTRACTOR_STRATEGY
Setting to choose the strategy used to access the JDBC Metadata.
|
static String |
HBM2DDL_LOAD_SCRIPT_SOURCE
JPA variant of
HBM2DDL_IMPORT_FILES
Specifies a Reader configured for reading of the SQL load script or a string designating the
file URL for the SQL load script. |
static String |
HBM2DDL_SCRIPTS_ACTION
Setting to perform SchemaManagementTool actions writing the commands into a DDL script file.
|
static String |
HBM2DDL_SCRIPTS_CREATE_TARGET
For cases where the "javax.persistence.schema-generation.scripts.action" value indicates that schema creation commands should
be written to DDL script file, "javax.persistence.schema-generation.scripts.create-target" specifies either a
Writer configured for output of the DDL script or a string specifying the file URL for the DDL
script. |
static String |
HBM2DDL_SCRIPTS_DROP_TARGET
For cases where the "javax.persistence.schema-generation.scripts.action" value indicates that schema drop commands should
be written to DDL script file, "javax.persistence.schema-generation.scripts.drop-target" specifies either a
Writer configured for output of the DDL script or a string specifying the file URL for the DDL
script. |
static String |
HBM2DLL_CREATE_NAMESPACES
Specifies whether to automatically create also the database schema/catalog.
|
static String |
HBM2DLL_CREATE_SCHEMAS
The JPA variant of
HBM2DLL_CREATE_NAMESPACES
Specifies whether the persistence provider is to create the database schema(s) in addition to creating
database objects (tables, sequences, constraints, etc). |
static String |
HIBERNATE_CLASSLOADER
Deprecated.
Use
CLASSLOADERS instead |
static String |
HQL_BULK_ID_STRATEGY |
static String |
IGNORE_EXPLICIT_DISCRIMINATOR_COLUMNS_FOR_JOINED_SUBCLASS
The legacy behavior of Hibernate is to not use discriminators for joined inheritance (Hibernate does not need
the discriminator...).
|
static String |
IMMUTABLE_ENTITY_UPDATE_QUERY_HANDLING_MODE
|
static String |
IMPLICIT_DISCRIMINATOR_COLUMNS_FOR_JOINED_SUBCLASS
The legacy behavior of Hibernate is to not use discriminators for joined inheritance (Hibernate does not need
the discriminator...).
|
static String |
IMPLICIT_NAMING_STRATEGY
Used to specify the
ImplicitNamingStrategy class to use. |
static String |
IN_CLAUSE_PARAMETER_PADDING
By default, the IN clause expands to include all bind parameter values.
|
static String |
INTERCEPTOR
Names a
Interceptor implementation to be applied to the
SessionFactory and propagated to each Session created from the SessionFactory. |
static String |
ISOLATION
Names the JDBC transaction isolation level
|
static String |
JACC_CONTEXT_ID |
static String |
JACC_ENABLED |
static String |
JACC_PREFIX |
static String |
JDBC_TIME_ZONE
Default JDBC TimeZone.
|
static String |
JDBC_TYLE_PARAMS_ZERO_BASE
Deprecated.
This is a temporary backwards-compatibility setting to help applications
using versions prior to 5.3 in upgrading. Deprecation warnings are issued when this
is set to `true`.
|
static String |
JMX_AGENT_ID |
static String |
JMX_DEFAULT_OBJ_NAME_DOMAIN |
static String |
JMX_DOMAIN_NAME |
static String |
JMX_ENABLED |
static String |
JMX_PLATFORM_SERVER |
static String |
JMX_SF_NAME |
static String |
JNDI_CLASS
Names the JNDI
InitialContext class. |
static String |
JNDI_PREFIX
Names a prefix used to define arbitrary JNDI
InitialContext properties. |
static String |
JNDI_URL
Names the JNDI provider/connection url
|
static String |
JPA_CACHING_COMPLIANCE |
static String |
JPA_CLOSED_COMPLIANCE
JPA defines specific exceptions on specific methods when called on
EntityManager and EntityManagerFactory
when those objects have been closed. |
static String |
JPA_ID_GENERATOR_GLOBAL_SCOPE_COMPLIANCE
Determine if the scope of
TableGenerator.name() and SequenceGenerator.name() should be
considered globally or locally defined. |
static String |
JPA_JDBC_DRIVER
The name of a JDBC driver to use to connect to the database.
|
static String |
JPA_JDBC_PASSWORD
The JDBC connection password.
|
static String |
JPA_JDBC_URL
The JDBC connection url to use to connect to the database.
|
static String |
JPA_JDBC_USER
The JDBC connection user name.
|
static String |
JPA_JTA_DATASOURCE
The JNDI name of a JTA
DataSource . |
static String |
JPA_LIST_COMPLIANCE
Controls whether Hibernate should recognize what it considers a "bag"
(
PersistentBag ) as a List
(PersistentList ) or as a bag. |
static String |
JPA_LOCK_SCOPE
Used to request (hint) a pessimistic lock scope.
|
static String |
JPA_LOCK_TIMEOUT
Used to request (hint) a pessimistic lock timeout (in milliseconds).
|
static String |
JPA_METAMODEL_GENERATION
Deprecated.
use
JPA_METAMODEL_POPULATION instead. |
static String |
JPA_METAMODEL_POPULATION
Deprecated.
|
static String |
JPA_NON_JTA_DATASOURCE
The JNDI name of a non-JTA
DataSource . |
static String |
JPA_PERSIST_VALIDATION_GROUP
Used to coordinate with bean validators
See JPA 2 section 8.2.1.9
|
static String |
JPA_PERSISTENCE_PROVIDER
The name of the
PersistenceProvider implementor
See JPA 2 sections 9.4.3 and 8.2.1.4 |
static String |
JPA_PROXY_COMPLIANCE
The JPA spec says that a
EntityNotFoundException
should be thrown when accessing an entity Proxy which does not have an associated
table row in the database. |
static String |
JPA_QUERY_COMPLIANCE
Controls whether Hibernate's handling of
Query
(JPQL, Criteria and native-query) should strictly follow the JPA spec. |
static String |
JPA_REMOVE_VALIDATION_GROUP
Used to coordinate with bean validators
See JPA 2 section 8.2.1.9
|
static String |
JPA_SHARED_CACHE_MODE
Used to indicate whether second-level (what JPA terms shared cache) caching is
enabled as per the rules defined in JPA 2 section 3.1.7.
|
static String |
JPA_SHARED_CACHE_RETRIEVE_MODE
NOTE : Not a valid EMF property...
|
static String |
JPA_SHARED_CACHE_STORE_MODE
NOTE : Not a valid EMF property...
|
static String |
JPA_TRANSACTION_COMPLIANCE
Should Hibernate's
Transaction behave as
defined by the spec for JPA's EntityTransaction
since it extends the JPA one. |
static String |
JPA_TRANSACTION_TYPE
The type of transactions supported by the entity managers.
|
static String |
JPA_UPDATE_VALIDATION_GROUP
Used to coordinate with bean validators
See JPA 2 section 8.2.1.9
|
static String |
JPA_VALIDATION_FACTORY
Used to pass along any discovered validator factory.
|
static String |
JPA_VALIDATION_MODE
Used to indicate what form of automatic validation is in effect as per rules defined
in JPA 2 section 3.6.1.1
See JPA 2 sections 9.4.3 and 8.2.1.8
|
static String |
JPAQL_STRICT_COMPLIANCE |
static String |
JTA_CACHE_TM
A configuration value key used to indicate that it is safe to cache
TransactionManager references. |
static String |
JTA_CACHE_UT
A configuration value key used to indicate that it is safe to cache
UserTransaction references. |
static String |
JTA_PLATFORM
Names the
JtaPlatform implementation to use for integrating
with JTA systems. |
static String |
JTA_PLATFORM_RESOLVER
Names the
JtaPlatformResolver implementation to use. |
static String |
JTA_TRACK_BY_THREAD
A transaction can be rolled back by another thread ("tracking by thread")
-- not the original application.
|
static String |
KEYWORD_AUTO_QUOTING_ENABLED
Specifies whether to automatically quote any names that are deemed keywords.
|
static String |
LOG_JDBC_WARNINGS
Enable fetching JDBC statement warning for logging.
|
static String |
LOG_SESSION_METRICS
A setting to control whether to
StatisticalLoggingSessionEventListener is
enabled on all Sessions (unless explicitly disabled for a given Session). |
static String |
MAX_FETCH_DEPTH
Maximum depth of outer join fetching
|
static String |
MERGE_ENTITY_COPY_OBSERVER
Setting that specifies how Hibernate will respond when multiple representations of the same persistent entity ("entity copy") is detected while merging.
|
static String |
MULTI_TENANT
Strategy for multi-tenancy.
|
static String |
MULTI_TENANT_CONNECTION_PROVIDER
Names a
MultiTenantConnectionProvider implementation to
use. |
static String |
MULTI_TENANT_IDENTIFIER_RESOLVER
Names a
CurrentTenantIdentifierResolver implementation to use. |
static String |
NATIVE_EXCEPTION_HANDLING_51_COMPLIANCE
Indicates if exception handling for a SessionFactory built via Hibernate's native bootstrapping
should behave the same as native exception handling in Hibernate ORM 5.1, When set to
true ,
HibernateException will not be wrapped or converted according to the JPA specification. |
static String |
NON_CONTEXTUAL_LOB_CREATION
Should we not use contextual LOB creation (aka based on
Connection.createBlob() et al). |
static String |
ORDER_INSERTS
Enable ordering of insert statements for the purpose of more efficient JDBC batching.
|
static String |
ORDER_UPDATES
Enable ordering of update statements by primary key value
|
static String |
PASS
Names the connection password.
|
static String |
PHYSICAL_NAMING_STRATEGY
Used to specify the
PhysicalNamingStrategy class to use. |
static String |
POOL_SIZE
Maximum number of inactive connections for the built-in Hibernate connection pool.
|
static String |
PREFER_GENERATOR_NAME_AS_DEFAULT_SEQUENCE_NAME
True/false setting indicating whether the value specified for
GeneratedValue.generator()
should be used as the sequence/table name when no matching SequenceGenerator
or TableGenerator is found. |
static String |
PREFER_POOLED_VALUES_LO
Deprecated.
Use
PREFERRED_POOLED_OPTIMIZER instead |
static String |
PREFER_USER_TRANSACTION
Should we prefer using the
JtaPlatform.retrieveUserTransaction()
over using JtaPlatform.retrieveTransactionManager() ?
Default is false |
static String |
PREFERRED_POOLED_OPTIMIZER
When a generator specified an increment-size and an optimizer was not explicitly specified, which of
the "pooled" optimizers should be preferred? Can specify an optimizer short name or an Optimizer
impl FQN.
|
static String |
PROCEDURE_NULL_PARAM_PASSING
Deprecated.
(5.3) Hibernate determines it implicitly
|
static String |
PROXOOL_CONFIG_PREFIX
A setting prefix used to indicate settings that target the hibernate-proxool integration
|
static String |
PROXOOL_EXISTING_POOL
Proxool property to configure the Proxool Provider from an already existing pool (true / false)
|
static String |
PROXOOL_POOL_ALIAS
Proxool property with the Proxool pool alias to use
(Required for PROXOOL_EXISTING_POOL, PROXOOL_PROPERTIES, or
PROXOOL_XML)
|
static String |
PROXOOL_PREFIX
Deprecated.
Use
PROXOOL_CONFIG_PREFIX instead |
static String |
PROXOOL_PROPERTIES
Proxool property to configure the Proxool Provider using a properties file (/path/to/proxool.properties)
|
static String |
PROXOOL_XML
Proxool property to configure the Proxool Provider using an XML (/path/to/file.xml)
|
static String |
QUERY_CACHE_FACTORY
The
TimestampsCacheFactory implementation class. |
static String |
QUERY_PLAN_CACHE_MAX_SIZE
The maximum number of entries including:
HQLQueryPlan
FilterQueryPlan
NativeSQLQueryPlan
maintained by QueryPlanCache . |
static String |
QUERY_PLAN_CACHE_MAX_SOFT_REFERENCES
Deprecated.
in favor of
QUERY_PLAN_CACHE_MAX_SIZE |
static String |
QUERY_PLAN_CACHE_MAX_STRONG_REFERENCES
Deprecated.
in favor of
QUERY_PLAN_CACHE_PARAMETER_METADATA_MAX_SIZE |
static String |
QUERY_PLAN_CACHE_PARAMETER_METADATA_MAX_SIZE
The maximum number of
ParameterMetadataImpl maintained
by QueryPlanCache . |
static String |
QUERY_STARTUP_CHECKING
Should named queries be checked during startup (the default is enabled).
|
static String |
QUERY_SUBSTITUTIONS
A comma-separated list of token substitutions to use when translating a Hibernate
query to SQL
|
static String |
QUERY_TRANSLATOR
The classname of the HQL query parser factory
|
static String |
RELEASE_CONNECTIONS
Deprecated.
(since 5.2) use
CONNECTION_HANDLING instead |
static String |
RESOURCES_CLASSLOADER
Deprecated.
Use
CLASSLOADERS instead |
static String |
SCANNER
Pass an implementation of
Scanner . |
static String |
SCANNER_ARCHIVE_INTERPRETER
Pass
ArchiveDescriptorFactory to use
in the scanning process. |
static String |
SCANNER_DEPRECATED
The deprecated name.
|
static String |
SCANNER_DISCOVERY
Identifies a comma-separate list of values indicating the types of
things we should auto-detect during scanning.
|
static String |
SCHEMA_MANAGEMENT_TOOL
Used to specify the
SchemaManagementTool to use for performing
schema management. |
static String |
SESSION_FACTORY_NAME
Setting used to name the Hibernate
SessionFactory . |
static String |
SESSION_FACTORY_NAME_IS_JNDI
Does the value defined by
SESSION_FACTORY_NAME represent a JNDI namespace into which
the SessionFactory should be bound and made accessible?
Defaults to true for backwards compatibility. |
static String |
SESSION_SCOPED_INTERCEPTOR
Names a
Interceptor implementation to be applied to the
SessionFactory and propagated to each Session created from the SessionFactory. |
static String |
SHOW_SQL
Enable logging of generated SQL to the console
|
static String |
SQL_EXCEPTION_CONVERTER
The
SQLExceptionConverter to use for converting SQLExceptions
to Hibernate's JDBCException hierarchy. |
static String |
STATEMENT_BATCH_SIZE
Maximum JDBC batch size.
|
static String |
STATEMENT_FETCH_SIZE
Gives the JDBC driver a hint as to the number of rows that should be fetched from the database
when more rows are needed.
|
static String |
STATEMENT_INSPECTOR
Names a
StatementInspector implementation to be applied to
the SessionFactory . |
static String |
STATIC_METAMODEL_POPULATION
Setting that controls whether we seek out JPA "static metamodel" classes and populate them.
|
static String |
STORAGE_ENGINE
Defines the default storage engine for the relational databases that support multiple storage engines.
|
static String |
TABLE_GENERATOR_STORE_LAST_USED
True/False setting indicating if the value stored in the table used by the
TableGenerator
is the last value generated or the next value to be used. |
static String |
TC_CLASSLOADER
Used to define how the current thread context
ClassLoader must be used
for class lookup. |
static String |
TRANSACTION_COORDINATOR_STRATEGY
Names the implementation of
TransactionCoordinatorBuilder to use for
creating TransactionCoordinator instances. |
static String |
UNIQUE_CONSTRAINT_SCHEMA_UPDATE_STRATEGY
Unique columns and unique keys both use unique constraints in most dialects.
|
static String |
URL
Names the JDBC connection url.
|
static String |
USE_DIRECT_REFERENCE_CACHE_ENTRIES
Enable direct storage of entity references into the second level cache when applicable (immutable data, etc).
|
static String |
USE_ENTITY_WHERE_CLAUSE_FOR_COLLECTIONS
Controls whether an entity's "where" clause, mapped using
@Where(clause="....")
or <entity ... |
static String |
USE_GET_GENERATED_KEYS
Tells the JDBC driver to attempt to retrieve row Id with the JDBC 3.0 PreparedStatement.getGeneratedKeys()
method.
|
static String |
USE_IDENTIFIER_ROLLBACK |
static String |
USE_LEGACY_LIMIT_HANDLERS
Setting which indicates whether or not to use
LimitHandler
implementations that sacrifices performance optimizations to allow legacy 4.x limit behavior. |
static String |
USE_MINIMAL_PUTS
Optimize the cache for minimal puts instead of minimal gets
|
static String |
USE_NATIONALIZED_CHARACTER_DATA
Enable nationalized character support on all string / clob based attribute ( string, char, clob, text etc ).
|
static String |
USE_NEW_ID_GENERATOR_MAPPINGS
Setting which indicates whether or not the new
IdentifierGenerator are used
for AUTO, TABLE and SEQUENCE. |
static String |
USE_QUERY_CACHE
Enable the query cache (disabled by default)
|
static String |
USE_REFLECTION_OPTIMIZER
Use bytecode libraries optimized property access
|
static String |
USE_SCROLLABLE_RESULTSET
Use JDBC scrollable ResultSets.
|
static String |
USE_SECOND_LEVEL_CACHE
Enable the second-level cache (enabled by default)
|
static String |
USE_SQL_COMMENTS
Add comments to the generated SQL
|
static String |
USE_STREAMS_FOR_BINARY
Use java.io streams to read / write binary data from / to JDBC
|
static String |
USE_STRUCTURED_CACHE
Enable use of structured second-level cache entries
|
static String |
USER
Names the connection user.
|
static String |
VALIDATE_QUERY_PARAMETERS
Setting which indicates if
Query.setParameter(javax.persistence.Parameter<java.time.Instant>, java.time.Instant, javax.persistence.TemporalType) should not perform parameters validation
This setting is applied only when the Session is bootstrapped via JPA EntityManagerFactory |
static String |
WRAP_RESULT_SETS
Enable wrapping of JDBC result sets in order to speed up column name lookups for
broken JDBC drivers
|
ALIAS_SPECIFIC_LOCK_MODE, CFG_FILE, CLASS_CACHE_PREFIX, COLLECTION_CACHE_PREFIX, DELAY_CDI_ACCESS, DISCARD_PC_ON_CLOSE, ENHANCER_ENABLE_ASSOCIATION_MANAGEMENT, ENHANCER_ENABLE_DIRTY_TRACKING, ENHANCER_ENABLE_LAZY_INITIALIZATION, ENTITY_MANAGER_FACTORY_NAME, EVENT_LISTENER_PREFIX, FLUSH_MODE, HBXML_FILES, IDENTIFIER_GENERATOR_STRATEGY_PROVIDER, JDBC_DRIVER, JDBC_PASSWORD, JDBC_URL, JDBC_USER, JTA_DATASOURCE, LOADED_CLASSES, LOCK_SCOPE, LOCK_TIMEOUT, NON_JTA_DATASOURCE, PERSIST_VALIDATION_GROUP, PERSISTENCE_UNIT_NAME, PROVIDER, REMOVE_VALIDATION_GROUP, SCHEMA_GEN_CONNECTION, SCHEMA_GEN_CREATE_SCHEMAS, SCHEMA_GEN_CREATE_SCRIPT_SOURCE, SCHEMA_GEN_CREATE_SOURCE, SCHEMA_GEN_DATABASE_ACTION, SCHEMA_GEN_DB_MAJOR_VERSION, SCHEMA_GEN_DB_MINOR_VERSION, SCHEMA_GEN_DB_NAME, SCHEMA_GEN_DROP_SCRIPT_SOURCE, SCHEMA_GEN_DROP_SOURCE, SCHEMA_GEN_LOAD_SCRIPT_SOURCE, SCHEMA_GEN_SCRIPTS_ACTION, SCHEMA_GEN_SCRIPTS_CREATE_TARGET, SCHEMA_GEN_SCRIPTS_DROP_TARGET, SESSION_FACTORY_OBSERVER, SESSION_INTERCEPTOR, SHARED_CACHE_MODE, SHARED_CACHE_RETRIEVE_MODE, SHARED_CACHE_STORE_MODE, TRANSACTION_TYPE, UPDATE_VALIDATION_GROUP, VALIDATION_FACTORY, VALIDATION_MODE, XML_FILE_NAMES
static final String JPA_PERSISTENCE_PROVIDER
PersistenceProvider
implementor
See JPA 2 sections 9.4.3 and 8.2.1.4static final String JPA_TRANSACTION_TYPE
static final String JPA_JTA_DATASOURCE
DataSource
.
See JPA 2 sections 9.4.3 and 8.2.1.5static final String JPA_NON_JTA_DATASOURCE
DataSource
.
See JPA 2 sections 9.4.3 and 8.2.1.5static final String JPA_JDBC_DRIVER
JPA_JDBC_URL
, JPA_JDBC_USER
and JPA_JDBC_PASSWORD
to define how to make connections to the database in lieu of
a datasource (either JPA_JTA_DATASOURCE
or JPA_NON_JTA_DATASOURCE
).
See section 8.2.1.9static final String JPA_JDBC_URL
JPA_JDBC_DRIVER
, JPA_JDBC_USER
and JPA_JDBC_PASSWORD
to define how to make connections to the database in lieu of
a datasource (either JPA_JTA_DATASOURCE
or JPA_NON_JTA_DATASOURCE
).
See section 8.2.1.9static final String JPA_JDBC_USER
JPA_JDBC_DRIVER
, JPA_JDBC_URL
and JPA_JDBC_PASSWORD
to define how to make connections to the database in lieu of
a datasource (either JPA_JTA_DATASOURCE
or JPA_NON_JTA_DATASOURCE
).
See section 8.2.1.9static final String JPA_JDBC_PASSWORD
JPA_JDBC_DRIVER
, JPA_JDBC_URL
and JPA_JDBC_USER
to define how to make connections to the database in lieu of
a datasource (either JPA_JTA_DATASOURCE
or JPA_NON_JTA_DATASOURCE
).
See JPA 2 section 8.2.1.9static final String JPA_SHARED_CACHE_MODE
SharedCacheMode
,
Constant Field Valuesstatic final String JPA_SHARED_CACHE_RETRIEVE_MODE
CacheRetrieveMode
,
Constant Field Valuesstatic final String JPA_SHARED_CACHE_STORE_MODE
CacheStoreMode
,
Constant Field Valuesstatic final String JPA_VALIDATION_MODE
ValidationMode
,
Constant Field Valuesstatic final String JPA_VALIDATION_FACTORY
static final String JPA_PERSIST_VALIDATION_GROUP
static final String JPA_UPDATE_VALIDATION_GROUP
static final String JPA_REMOVE_VALIDATION_GROUP
static final String JPA_LOCK_SCOPE
static final String JPA_LOCK_TIMEOUT
static final String CDI_BEAN_MANAGER
ExtendedBeanManager
* delayed access to the BeanManager reference. Here, Hibernate
will not access the reference passed as the BeanManager during
bootstrap until it is first needed. Note however that this has
the effect of delaying any deployement problems until after
bootstrapping.
This setting is used to configure Hibernate ORM's access to
the BeanManager (either directly or via ExtendedBeanManager
).static final String CLASSLOADERS
Collection
of the ClassLoader
instances Hibernate should use for
class-loading and resource-lookups.static final String TC_CLASSLOADER
ClassLoader
must be used
for class lookup.TcclLookupPrecedence
,
Constant Field Values@Deprecated static final String APP_CLASSLOADER
CLASSLOADERS
insteadClassLoader
used to load user application classes.@Deprecated static final String RESOURCES_CLASSLOADER
CLASSLOADERS
insteadClassLoader
Hibernate should use to perform resource loading.@Deprecated static final String HIBERNATE_CLASSLOADER
CLASSLOADERS
insteadClassLoader
responsible for loading Hibernate classes. By default this is
the ClassLoader
that loaded this class.@Deprecated static final String ENVIRONMENT_CLASSLOADER
CLASSLOADERS
insteadClassLoader
used when Hibernate is unable to locates classes on the
APP_CLASSLOADER
or HIBERNATE_CLASSLOADER
.@Deprecated static final String JPA_METAMODEL_GENERATION
JPA_METAMODEL_POPULATION
instead.@Deprecated static final String JPA_METAMODEL_POPULATION
static final String STATIC_METAMODEL_POPULATION
static final String CONNECTION_PROVIDER
ConnectionProvider
to use for obtaining
JDBC connections. Can reference:Class<? extends ConnectionProvider>
referenceClass<? extends ConnectionProvider>
FQN"class"
appears in the setting name due to legacy reasons; however it can accept instances.static final String DRIVER
static final String URL
static final String USER
ConnectionProvider
: static final String PASS
USER
static final String ISOLATION
static final String AUTOCOMMIT
static final String POOL_SIZE
static final String DATASOURCE
DataSource
. Can reference:DataSource
instanceDataSource
JNDI_CLASS
, JNDI_URL
, JNDI_PREFIX
, etc.static final String CONNECTION_PROVIDER_DISABLES_AUTOCOMMIT
false
- do not skip, aka call setAutocommitstatic final String CONNECTION_PREFIX
static final String JNDI_CLASS
InitialContext
class.static final String JNDI_URL
Context.PROVIDER_URL
,
Constant Field Valuesstatic final String JNDI_PREFIX
InitialContext
properties. These
properties are passed along to InitialContext.InitialContext(java.util.Hashtable)
static final String DIALECT
Dialect
classstatic final String DIALECT_RESOLVERS
DialectResolver
implementations to
register with the standard DialectFactory
.static final String STORAGE_ENGINE
static final String SCHEMA_MANAGEMENT_TOOL
SchemaManagementTool
to use for performing
schema management. The default is to use HibernateSchemaManagementTool
static final String TRANSACTION_COORDINATOR_STRATEGY
TransactionCoordinatorBuilder
to use for
creating TransactionCoordinator
instances.
Can beClass
referencestatic final String JTA_PLATFORM
JtaPlatform
implementation to use for integrating
with JTA systems. Can reference either a JtaPlatform
instance or the name of the JtaPlatform
implementation classstatic final String PREFER_USER_TRANSACTION
JtaPlatform.retrieveUserTransaction()
over using JtaPlatform.retrieveTransactionManager()
?
Default is false
static final String JTA_PLATFORM_RESOLVER
JtaPlatformResolver
implementation to use.static final String JTA_CACHE_TM
TransactionManager
references.static final String JTA_CACHE_UT
UserTransaction
references.@Deprecated static final String JDBC_TYLE_PARAMS_ZERO_BASE
DeprecationLogger.logUseOfDeprecatedZeroBasedJdbcStyleParams()
,
Constant Field Valuesstatic final String DEFAULT_CATALOG
static final String DEFAULT_SCHEMA
static final String DEFAULT_CACHE_CONCURRENCY_STRATEGY
CacheConcurrencyStrategy
to use when either @Cacheable
or
@Cache
is used. @Cache(strategy="..")
is used to override.static final String USE_NEW_ID_GENERATOR_MAPPINGS
IdentifierGenerator
are used
for AUTO, TABLE and SEQUENCE.
Default is true
. Existing applications may want to disable this (set it false
) for
upgrade compatibility.static final String FORCE_DISCRIMINATOR_IN_SELECTS_BY_DEFAULT
static final String IMPLICIT_DISCRIMINATOR_COLUMNS_FOR_JOINED_SUBCLASS
static final String IGNORE_EXPLICIT_DISCRIMINATOR_COLUMNS_FOR_JOINED_SUBCLASS
static final String USE_NATIONALIZED_CHARACTER_DATA
false
.static final String SCANNER_DEPRECATED
SCANNER
or SCANNER_ARCHIVE_INTERPRETER
instead.static final String SCANNER
Scanner
.
Accepts either:static final String SCANNER_ARCHIVE_INTERPRETER
ArchiveDescriptorFactory
to use
in the scanning process. Accepts either:Scanner
about expected constructor forms.static final String SCANNER_DISCOVERY
static final String IMPLICIT_NAMING_STRATEGY
ImplicitNamingStrategy
class to use. The following
short-names are defined for this setting:ImplicitNamingStrategyJpaCompliantImpl
ImplicitNamingStrategyJpaCompliantImpl
ImplicitNamingStrategyLegacyJpaImpl
ImplicitNamingStrategyLegacyHbmImpl
ImplicitNamingStrategyComponentPathImpl
ImplicitNamingStrategyJpaCompliantImpl
.static final String PHYSICAL_NAMING_STRATEGY
PhysicalNamingStrategy
class to use.static final String ARTIFACT_PROCESSING_ORDER
MetadataSourceType
.
Default is "hbm,class"
which indicates to process hbm.xml
files followed by
annotations (combined with orm.xml
mappings).static final String KEYWORD_AUTO_QUOTING_ENABLED
static final String SESSION_FACTORY_NAME
SessionFactory
.
Naming the SessionFactory allows for it to be properly serialized across JVMs as
long as the same name is used on each JVM.
If SESSION_FACTORY_NAME_IS_JNDI
is set to true
, this is also the
name under which the SessionFactory is bound into JNDI on startup and from which
it can be obtained from JNDI.static final String SESSION_FACTORY_NAME_IS_JNDI
SESSION_FACTORY_NAME
represent a JNDI namespace into which
the SessionFactory
should be bound and made accessible?
Defaults to true
for backwards compatibility.
Set this to false
if naming a SessionFactory is needed for serialization purposes, but
no writable JNDI context exists in the runtime environment or if the user simply does not want
JNDI to be used.SESSION_FACTORY_NAME
,
Constant Field Valuesstatic final String SHOW_SQL
static final String FORMAT_SQL
static final String USE_SQL_COMMENTS
static final String MAX_FETCH_DEPTH
static final String DEFAULT_BATCH_FETCH_SIZE
static final String USE_STREAMS_FOR_BINARY
static final String USE_SCROLLABLE_RESULTSET
static final String USE_GET_GENERATED_KEYS
static final String STATEMENT_FETCH_SIZE
static final String STATEMENT_BATCH_SIZE
static final String BATCH_STRATEGY
static final String BATCH_VERSIONED_DATA
static final String JDBC_TIME_ZONE
static final String AUTO_CLOSE_SESSION
static final String FLUSH_BEFORE_COMPLETION
@Deprecated static final String ACQUIRE_CONNECTIONS
CONNECTION_HANDLING
insteadRELEASE_CONNECTIONS
, not bothConnectionAcquisitionMode
,
Constant Field Values@Deprecated static final String RELEASE_CONNECTIONS
CONNECTION_HANDLING
insteadACQUIRE_CONNECTIONS
, not bothConnectionReleaseMode
,
Constant Field Valuesstatic final String CONNECTION_HANDLING
ACQUIRE_CONNECTIONS
and RELEASE_CONNECTIONS
PhysicalConnectionHandlingMode
,
Constant Field Valuesstatic final String CURRENT_SESSION_CONTEXT_CLASS
SessionFactory.getCurrentSession()
processing.static final String USE_IDENTIFIER_ROLLBACK
static final String USE_REFLECTION_OPTIMIZER
static final String ENFORCE_LEGACY_PROXY_CLASSNAMES
static final String QUERY_TRANSLATOR
static final String QUERY_SUBSTITUTIONS
static final String QUERY_STARTUP_CHECKING
static final String CONVENTIONAL_JAVA_CONSTANTS
true
. Existing applications may want to disable this (set it false
) if non-conventional Java constants are used.
However, there is a significant performance overhead for using non-conventional Java constants since Hibernate cannot determine if aliases
should be treated as Java constants or not.static final String SQL_EXCEPTION_CONVERTER
SQLExceptionConverter
to use for converting SQLExceptions
to Hibernate's JDBCException hierarchy. The default is to use the configured
Dialect
's preferred SQLExceptionConverter.static final String WRAP_RESULT_SETS
static final String NATIVE_EXCEPTION_HANDLING_51_COMPLIANCE
true
,
HibernateException
will not be wrapped or converted according to the JPA specification.
This setting will be ignored for a SessionFactory built via JPA bootstrapping.
Values are true
or false
.
Default value is false
static final String ORDER_UPDATES
static final String ORDER_INSERTS
static final String DEFAULT_NULL_ORDERING
ORDER BY
clause. Supported options: none
(default),
first
, last
.static final String LOG_JDBC_WARNINGS
true
or false
.
Default value is Dialect.isJdbcLogWarningsEnabledByDefault()
static final String BEAN_CONTAINER
BeanContainer
to be used.
Note that for CDI-based containers setting this is not necessary - simply
pass the BeanManager to use via CDI_BEAN_MANAGER
and
optionally specify AvailableSettings.DELAY_CDI_ACCESS
. This setting is more meant to
integrate non-CDI bean containers such as Spring.static final String C3P0_CONFIG_PREFIX
static final String C3P0_MAX_SIZE
static final String C3P0_MIN_SIZE
static final String C3P0_TIMEOUT
static final String C3P0_MAX_STATEMENTS
static final String C3P0_ACQUIRE_INCREMENT
static final String C3P0_IDLE_TEST_PERIOD
static final String PROXOOL_CONFIG_PREFIX
@Deprecated static final String PROXOOL_PREFIX
PROXOOL_CONFIG_PREFIX
insteadstatic final String PROXOOL_XML
static final String PROXOOL_PROPERTIES
static final String PROXOOL_EXISTING_POOL
static final String PROXOOL_POOL_ALIAS
static final String CACHE_REGION_FACTORY
RegionFactory
implementation. Can refer to:RegionFactory
RegionFactory
RegionFactory
static final String CACHE_KEYS_FACTORY
CacheKeysFactory
impl to use.
Can refer to:CacheKeysFactory
CacheKeysFactory
CacheKeysFactory
DefaultCacheKeysFactory
SimpleCacheKeysFactory
static final String CACHE_PROVIDER_CONFIG
static final String USE_SECOND_LEVEL_CACHE
static final String USE_QUERY_CACHE
static final String QUERY_CACHE_FACTORY
TimestampsCacheFactory
implementation class.static final String CACHE_REGION_PREFIX
static final String USE_MINIMAL_PUTS
static final String USE_STRUCTURED_CACHE
static final String AUTO_EVICT_COLLECTION_CACHE
static final String USE_DIRECT_REFERENCE_CACHE_ENTRIES
static final String DEFAULT_ENTITY_MODE
static final String GLOBALLY_QUOTED_IDENTIFIERS
true
/false
option.static final String GLOBALLY_QUOTED_IDENTIFIERS_SKIP_COLUMN_DEFINITIONS
GLOBALLY_QUOTED_IDENTIFIERS
, this allows such global quoting
to skip column-definitions as defined by Column
,
JoinColumn
, etc.
JPA states that column-definitions are subject to global quoting, so by default this setting
is false
for JPA compliance. Set to true
to avoid column-definitions
being quoted due to global quoting (they will still be quoted if explicitly quoted in the
annotation/xml).static final String CHECK_NULLABILITY
static final String BYTECODE_PROVIDER
static final String JPAQL_STRICT_COMPLIANCE
@Deprecated static final String PREFER_POOLED_VALUES_LO
PREFERRED_POOLED_OPTIMIZER
insteadoptimizers
, prefer interpreting the
database value as the lower (lo) boundary. The default is to interpret it as the high boundary.static final String PREFERRED_POOLED_OPTIMIZER
@Deprecated static final String QUERY_PLAN_CACHE_MAX_STRONG_REFERENCES
QUERY_PLAN_CACHE_PARAMETER_METADATA_MAX_SIZE
QueryPlanCache
. Default is 128.@Deprecated static final String QUERY_PLAN_CACHE_MAX_SOFT_REFERENCES
QUERY_PLAN_CACHE_MAX_SIZE
QueryPlanCache
. Default is 2048.static final String QUERY_PLAN_CACHE_MAX_SIZE
QueryPlanCache
. Default is 2048.static final String QUERY_PLAN_CACHE_PARAMETER_METADATA_MAX_SIZE
ParameterMetadataImpl
maintained
by QueryPlanCache
. Default is 128.static final String NON_CONTEXTUAL_LOB_CREATION
Connection.createBlob()
et al).static final String HBM2DDL_AUTO
Action
enum.
Interpreted in combination with HBM2DDL_DATABASE_ACTION
and
HBM2DDL_SCRIPTS_ACTION
. If no value is specified, the default
is "none" (Action.NONE
).Action
,
Constant Field Valuesstatic final String HBM2DDL_DATABASE_ACTION
Action
enum.
Interpreted in combination with HBM2DDL_AUTO
. If no value is specified, the default
is "none" (Action.NONE
).Action
,
Constant Field Valuesstatic final String HBM2DDL_SCRIPTS_ACTION
Action
enum.
Interpreted in combination with HBM2DDL_AUTO
. If no value is specified, the default
is "none" (Action.NONE
).Action
,
Constant Field Valuesstatic final String HBM2DDL_CONNECTION
Connection
instance to be used by SchemaManagementTool.
May also be used to determine the values for "javax.persistence.database-product-name",
"javax.persistence.database-major-version" and "javax.persistence.database-minor-version".static final String HBM2DDL_DB_NAME
DatabaseMetaData.getDatabaseProductName()
for the target database.
Additionally specifying "javax.persistence.database-major-version" and/or "javax.persistence.database-minor-version"
may be required to understand exactly how to generate the required schema commands.static final String HBM2DDL_DB_MAJOR_VERSION
DatabaseMetaData.getDatabaseMajorVersion()
for the target database. This value is used to
help more precisely determine how to perform schema generation tasks for the underlying database in cases
where "javax.persistence.database-product-name" does not provide enough distinction.static final String HBM2DDL_DB_MINOR_VERSION
DatabaseMetaData.getDatabaseMinorVersion()
for the target database. This value is used to
help more precisely determine how to perform schema generation tasks for the underlying database in cases
where the combination of "javax.persistence.database-product-name" and "javax.persistence.database-major-version" does not provide
enough distinction.static final String HBM2DDL_CREATE_SOURCE
SourceType
for valid set of values.
If no value is specified, a default is assumed as follows:SourceType
,
Constant Field Valuesstatic final String HBM2DDL_DROP_SOURCE
SourceType
for valid set of values.
If no value is specified, a default is assumed as follows:SourceType
,
Constant Field Valuesstatic final String HBM2DDL_CREATE_SCRIPT_SOURCE
Reader
configured for reading of the DDL script
file or a string designating a file URL
for the DDL script.
Hibernate historically also accepted HBM2DDL_IMPORT_FILES
for a similar purpose. This setting
should be preferred over HBM2DDL_IMPORT_FILES
moving forwardstatic final String HBM2DDL_DROP_SCRIPT_SOURCE
Reader
configured for reading of the DDL script
file or a string designating a file URL
for the DDL script.HBM2DDL_DROP_SOURCE
,
Constant Field Valuesstatic final String HBM2DDL_SCRIPTS_CREATE_TARGET
Writer
configured for output of the DDL script or a string specifying the file URL for the DDL
script.HBM2DDL_SCRIPTS_ACTION
,
Constant Field Valuesstatic final String HBM2DDL_SCRIPTS_DROP_TARGET
Writer
configured for output of the DDL script or a string specifying the file URL for the DDL
script.HBM2DDL_SCRIPTS_ACTION
,
Constant Field Valuesstatic final String HBM2DDL_IMPORT_FILES
HBM2DDL_CREATE_SCRIPT_SOURCE
/ HBM2DDL_DROP_SCRIPT_SOURCE
should be preferred
moving forwardstatic final String HBM2DDL_LOAD_SCRIPT_SOURCE
HBM2DDL_IMPORT_FILES
Specifies a Reader
configured for reading of the SQL load script or a string designating the
file URL
for the SQL load script.
A "SQL load script" is a script that performs some database initialization (INSERT, etc).static final String HBM2DDL_IMPORT_FILES_SQL_EXTRACTOR
ImportSqlCommandExtractor
implementation class
to use for parsing source/import files as defined by HBM2DDL_CREATE_SCRIPT_SOURCE
,
HBM2DDL_DROP_SCRIPT_SOURCE
or HBM2DDL_IMPORT_FILES
.
Reference may refer to an instance, a Class implementing ImportSqlCommandExtractor of the FQN
of the ImportSqlCommandExtractor implementation. If the FQN is given, the implementation
must provide a no-arg constructor.
The default value is SingleLineSqlCommandExtractor
.static final String HBM2DLL_CREATE_NAMESPACES
static final String HBM2DLL_CREATE_SCHEMAS
HBM2DLL_CREATE_NAMESPACES
Specifies whether the persistence provider is to create the database schema(s) in addition to creating
database objects (tables, sequences, constraints, etc). The value of this boolean property should be set
to true
if the persistence provider is to create schemas in the database or to generate DDL that
contains "CREATE SCHEMA" commands. If this property is not supplied (or is explicitly false
), the
provider should not attempt to create database schemas.static final String HBM2DDL_FILTER_PROVIDER
SchemaFilterProvider
to be used by
create, drop, migrate and validate operations on the database schema. SchemaFilterProvider
provides filters that can be used to limit the scope of these operations to specific namespaces,
tables and sequences. All objects are included by default.static final String HBM2DDL_JDBC_METADATA_EXTRACTOR_STRATEGY
JdbcMetadaAccessStrategy
enum.
JdbcMetadaAccessStrategy.GROUPED
is the default value.JdbcMetadaAccessStrategy
,
Constant Field Valuesstatic final String HBM2DDL_DELIMITER
static final String HBM2DDL_CHARSET_NAME
static final String HBM2DDL_HALT_ON_ERROR
static final String JMX_ENABLED
static final String JMX_PLATFORM_SERVER
static final String JMX_AGENT_ID
static final String JMX_DOMAIN_NAME
static final String JMX_SF_NAME
static final String JMX_DEFAULT_OBJ_NAME_DOMAIN
static final String CUSTOM_ENTITY_DIRTINESS_STRATEGY
CustomEntityDirtinessStrategy
to use. May point to
either a class name or instance.static final String USE_ENTITY_WHERE_CLAUSE_FOR_COLLECTIONS
@Where(clause="....")
or <entity ... where="...">
, is taken into account when loading one-to-many
or many-to-many collections of that type of entity.
This setting has no affect on collections of embeddable values containing an association to
that type of entity.
When `true` (the default), the entity's "where" clause will be taken into account when loading
one-to-many or many-to-many collections of that type of entity.
`false` indicates that the entity's "where" clause will be ignored when loading one-to-many or
many-to-many collections of that type of entity.static final String MULTI_TENANT
MultiTenancyStrategy
,
Constant Field Valuesstatic final String MULTI_TENANT_CONNECTION_PROVIDER
MultiTenantConnectionProvider
implementation to
use. As MultiTenantConnectionProvider is also a service, can be configured directly through the
StandardServiceRegistryBuilder
static final String MULTI_TENANT_IDENTIFIER_RESOLVER
CurrentTenantIdentifierResolver
implementation to use.
Can beClass
referencestatic final String INTERCEPTOR
Interceptor
implementation to be applied to the
SessionFactory
and propagated to each Session created from the SessionFactory.
This setting identifies an Interceptor which is effectively a singleton across all the Sessions
opened from the SessionFactory to which it is applied; the same instance will be passed to each Session.
See SESSION_SCOPED_INTERCEPTOR
for an approach to create unique Interceptor instances for each Session
Can referenceClass
referencestatic final String SESSION_SCOPED_INTERCEPTOR
Interceptor
implementation to be applied to the
SessionFactory
and propagated to each Session created from the SessionFactory.
This setting identifies an Interceptor implementation that is to be applied to every Session opened
from the SessionFactory, but unlike INTERCEPTOR
a unique instance of the Interceptor is
used for each Session.
Can reference
Note specifically that this setting cannot name an Interceptor instance.static final String STATEMENT_INSPECTOR
StatementInspector
implementation to be applied to
the SessionFactory
. Can referenceClass
referencestatic final String ENABLE_LAZY_LOAD_NO_TRANS
static final String HQL_BULK_ID_STRATEGY
static final String BATCH_FETCH_STYLE
BatchFetchStyle
to use. Can specify either the
BatchFetchStyle
name (insensitively), or a
BatchFetchStyle
instance.
LEGACY
is the default value.static final String DELAY_ENTITY_LOADER_CREATIONS
LockMode.READ
and LockMode.NONE
as well as specialized Loaders for
merge and refresh handling.
`false` indicates that all loaders should be created up frontstatic final String JTA_TRACK_BY_THREAD
true
(enabled).static final String JACC_CONTEXT_ID
static final String JACC_PREFIX
static final String JACC_ENABLED
static final String ENABLE_SYNONYMS
static final String EXTRA_PHYSICAL_TABLE_TYPES
static final String UNIQUE_CONSTRAINT_SCHEMA_UPDATE_STRATEGY
UniqueConstraintSchemaUpdateStrategy.DROP_RECREATE_QUIETLY
(DEFAULT):
Attempt to drop, then (re-)create each unique constraint.
Ignore any exceptions thrown.
UniqueConstraintSchemaUpdateStrategy.RECREATE_QUIETLY
:
attempt to (re-)create unique constraints,
ignoring exceptions thrown if the constraint already existed
UniqueConstraintSchemaUpdateStrategy.SKIP
:
do not attempt to create unique constraints on a schema updatestatic final String GENERATE_STATISTICS
static final String LOG_SESSION_METRICS
StatisticalLoggingSessionEventListener
is
enabled on all Sessions (unless explicitly disabled for a given Session). The default value of this
setting is determined by the value for GENERATE_STATISTICS
, meaning that if collection of statistics
is enabled logging of Session metrics is enabled by default too.static final String AUTO_SESSION_EVENTS_LISTENER
SessionEventListener
to be applied to opened Sessions.@Deprecated static final String PROCEDURE_NULL_PARAM_PASSING
ProcedureCall
handling. Implicitly Hibernate will not pass the NULL, the intention being to allow
any default argument values to be applied.
This defines a global setting, which can them be controlled per parameter via
ParameterRegistration.enablePassingNulls(boolean)
Values are true
(pass the NULLs) or false
(do not pass the NULLs).static final String CREATE_EMPTY_COMPOSITES_ENABLED
null
.
The default (and historical) behavior is that a null
reference will be used to represent the
composite when all of its attributes are null
This is an experimental feature that has known issues. It should not be used in production
until it is stabilized. See Hibernate Jira issue HHH-11936 for details.static final String ALLOW_JTA_TRANSACTION_ACCESS
Transaction
, even
when using a JTA since normal JPA operations prohibit this behavior.
Values are true
grants access, false
does not.
The default behavior is to allow access unless the session is bootstrapped via JPA.static final String ALLOW_UPDATE_OUTSIDE_TRANSACTION
true
to allow flush operations out of a transaction, false
to disallow.
The default behavior is false
static final String COLLECTION_JOIN_SUBQUERY
true
. Existing applications may want to disable this (set it false
) for
upgrade compatibility.static final String ALLOW_REFRESH_DETACHED_ENTITY
EntityManager.refresh(Object)
or Session.refresh(Object)
on a detached entity instance when the Session
is obtained from
a JPA EntityManager
).
Values are
true
permits the refresh, false
does not permit the detached instance refresh and an IllegalArgumentException
is thrown.
The default value is false
when the Session is bootstrapped via JPA EntityManagerFactory
, otherwise is true
static final String MERGE_ENTITY_COPY_OBSERVER
IllegalStateException
if an entity copy is detectedEntityCopyAllowedLoggedObserver
.
EntityCopyObserver
and setting hibernate.event.merge.entity_copy_observer
to the class name.
When this property is set to allow
or log
, Hibernate will merge each entity copy detected while cascading the merge operation.
In the process of merging each entity copy, Hibernate will cascade the merge operation from each entity copy to its associations with CascadeType.MERGE
or CascadeType.ALL
.
The entity state resulting from merging an entity copy will be overwritten when another entity copy is merged.static final String USE_LEGACY_LIMIT_HANDLERS
LimitHandler
implementations that sacrifices performance optimizations to allow legacy 4.x limit behavior.
Legacy 4.x behavior favored performing pagination in-memory by avoiding the use of the offset
value, which is overall poor performance. In 5.x, the limit handler behavior favors performance
thus if the dialect doesn't support offsets, an exception is thrown instead.
Default is false
.static final String VALIDATE_QUERY_PARAMETERS
Query.setParameter(javax.persistence.Parameter<java.time.Instant>, java.time.Instant, javax.persistence.TemporalType)
should not perform parameters validation
This setting is applied only when the Session is bootstrapped via JPA EntityManagerFactory
Values are: true
indicates the validation should be performed, false
otherwise
The default value is true
when the Session is bootstrapped via JPA EntityManagerFactory
,
otherwise is false
static final String CRITERIA_LITERAL_HANDLING_MODE
LiteralHandlingMode.BIND
mode will use bind variables for any literal value.
The LiteralHandlingMode.INLINE
mode will inline literal values as-is.
To prevent SQL injection, never use LiteralHandlingMode.INLINE
with String variables.
Always use constants with the LiteralHandlingMode.INLINE
mode.
Valid options are defined by the LiteralHandlingMode
enum.
The default value is LiteralHandlingMode.AUTO
LiteralHandlingMode
,
Constant Field Valuesstatic final String PREFER_GENERATOR_NAME_AS_DEFAULT_SEQUENCE_NAME
GeneratedValue.generator()
should be used as the sequence/table name when no matching SequenceGenerator
or TableGenerator
is found.
The default value is `true` meaning that GeneratedValue.generator()
will be used as the
sequence/table name by default. Users migrating from earlier versions using the legacy
`hibernate_sequence` name should disable this setting.static final String JPA_TRANSACTION_COMPLIANCE
Transaction
behave as
defined by the spec for JPA's EntityTransaction
since it extends the JPA one.JpaCompliance.isJpaTransactionComplianceEnabled()
,
Constant Field Valuesstatic final String JPA_QUERY_COMPLIANCE
Query
(JPQL, Criteria and native-query) should strictly follow the JPA spec.
This includes both in terms of parsing or translating a query as well
as calls to the Query
methods throwing spec
defined exceptions where as Hibernate might not.
Deviations result in an exception if enabledJpaCompliance.isJpaQueryComplianceEnabled()
,
Constant Field Valuesstatic final String JPA_LIST_COMPLIANCE
PersistentBag
) as a List
(PersistentList
) or as a bag.
If enabled, we will recognize it as a List where OrderColumn
is just missing (and its defaults will apply).JpaCompliance.isJpaListComplianceEnabled()
,
Constant Field Valuesstatic final String JPA_CLOSED_COMPLIANCE
EntityManager
and EntityManagerFactory
when those objects have been closed. This setting controls
whether the spec defined behavior or Hibernate's behavior will be used.
If enabled Hibernate will operate in the JPA specified way throwing
exceptions when the spec says it should.JpaCompliance.isJpaClosedComplianceEnabled()
,
Constant Field Valuesstatic final String JPA_PROXY_COMPLIANCE
EntityNotFoundException
should be thrown when accessing an entity Proxy which does not have an associated
table row in the database.
Traditionally, Hibernate does not initialize an entity Proxy when accessing its
identifier since we already know the identifier value, hence we can save a database roundtrip.
If enabled Hibernate will initialize the entity Proxy even when accessing its identifier.JpaCompliance.isJpaProxyComplianceEnabled()
,
Constant Field Valuesstatic final String JPA_CACHING_COMPLIANCE
JpaCompliance.isJpaCacheComplianceEnabled()
,
Constant Field Valuesstatic final String JPA_ID_GENERATOR_GLOBAL_SCOPE_COMPLIANCE
TableGenerator.name()
and SequenceGenerator.name()
should be
considered globally or locally defined.
If enabled, the names will considered globally scoped so defining two different generators with the same name
will cause a name collision and an exception will be thrown during the bootstrap phase.JpaCompliance.isGlobalGeneratorScopeEnabled()
,
Constant Field Valuesstatic final String TABLE_GENERATOR_STORE_LAST_USED
TableGenerator
is the last value generated or the next value to be used.
The default value is true.static final String FAIL_ON_PAGINATION_OVER_COLLECTION_FETCH
static final String IMMUTABLE_ENTITY_UPDATE_QUERY_HANDLING_MODE
Immutable
entities are handled when executing a
bulk update Query
.
By default, the (ImmutableEntityUpdateQueryHandlingMode.WARNING
) mode is used, meaning that
a warning log message is issued when an Immutable
entity
is to be updated via a bulk update statement.
If the (ImmutableEntityUpdateQueryHandlingMode.EXCEPTION
) mode is used, then a
HibernateException
is thrown instead.
Valid options are defined by the ImmutableEntityUpdateQueryHandlingMode
enum.
The default value is ImmutableEntityUpdateQueryHandlingMode.WARNING
ImmutableEntityUpdateQueryHandlingMode
,
Constant Field Valuesstatic final String IN_CLAUSE_PARAMETER_PADDING
true
.
The default value is false
.Copyright © 2019 JBoss by Red Hat. All rights reserved.