Package io.jmix.data

Class PersistenceHints

java.lang.Object

io.jmix.data.PersistenceHints

public class PersistenceHints
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PersistenceHints.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CACHEABLE
static final String	FETCH_PLAN
static final String	MSSQL_RECOMPILE_HINT	Defines a Jmix query hint which enable customization of generated SQL statements.
static final String	SKIP_ENTITY_CHANGED_EVENT	Hint that disables sending of io.jmix.core.event.EntityChangedEvent when saving entities through DataManager.
static final String	SKIP_ENTITY_SAVING_EVENT	Hint that disables sending of io.jmix.core.event.EntitySavingEvent when saving entities through DataManager.
static final String	SOFT_DELETION
static final String	SQL_HINT	Defines a Jmix query hint which enable customization of generated SQL statements.

Constructor Summary

Constructors

Constructor	Description
PersistenceHints()

Method Summary

Modifier and Type	Method	Description
static PersistenceHints.Builder	builder()
static Collection<FetchPlan>	getFetchPlans(@Nullable Map<String,Object> properties)
static boolean	isSoftDeletion(jakarta.persistence.EntityManager entityManager)

Methods inherited from class java.lang.Object

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

Field Details

SOFT_DELETION

public static final String SOFT_DELETION

See Also:

• Constant Field Values

SKIP_ENTITY_SAVING_EVENT

public static final String SKIP_ENTITY_SAVING_EVENT

Hint that disables sending of io.jmix.core.event.EntitySavingEvent when saving entities through DataManager. Set the value to true in SaveContext hints to suppress the event.

Note: this also disables listeners that rely on the event, such as multitenancy tenant-id assignment.

See Also:

• Constant Field Values

SKIP_ENTITY_CHANGED_EVENT

public static final String SKIP_ENTITY_CHANGED_EVENT

Hint that disables sending of io.jmix.core.event.EntityChangedEvent when saving entities through DataManager. Set the value to true in SaveContext hints to suppress the event.

Note: this also disables listeners that rely on the event, such as full-text search re-indexing.

See Also:

• Constant Field Values

FETCH_PLAN

public static final String FETCH_PLAN

See Also:

• Constant Field Values

CACHEABLE

public static final String CACHEABLE

See Also:

• Constant Field Values

SQL_HINT

public static final String SQL_HINT

Defines a Jmix query hint which enable customization of generated SQL statements. Adds an SQL hint string after the SQL statement.

The SQL hint can be used on certain database platforms to define how the query uses indexes and other such low level usages. It should be the full hint string including the comment delimiters.

Corresponds to org.eclipse.persistence.config.QueryHints#HINT

Usage examples:

    query.setHint(PersistenceHints.SQL_HINT, "OPTION(RECOMPILE)");
 

See Also:

• Constant Field Values

MSSQL_RECOMPILE_HINT

public static final String MSSQL_RECOMPILE_HINT

Defines a Jmix query hint which enable customization of generated SQL statements. Adds OPTION(RECOMPILE) SQL hint for MSSQL database. Hint value is ignored.

Usage examples:

    query.setHint(PersistenceHints.MSSQL_RECOMPILE_HINT, true);
 

See Also:

• Constant Field Values

Constructor Details

PersistenceHints

public PersistenceHints()

Method Details

isSoftDeletion

public static boolean isSoftDeletion(jakarta.persistence.EntityManager entityManager)

getFetchPlans

public static Collection<FetchPlan> getFetchPlans(@Nullable Map<String,Object> properties)

builder

public static PersistenceHints.Builder builder()