jakarta.persistence.FlushModeType Maven / Gradle / Ivy
Show all versions of jakarta.persistence-api Show documentation
/*
* Copyright (c) 2008, 2020 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0,
* or the Eclipse Distribution License v. 1.0 which is available at
* http://www.eclipse.org/org/documents/edl-v10.php.
*
* SPDX-License-Identifier: EPL-2.0 OR BSD-3-Clause
*/
// Contributors:
// Linda DeMichiel - 2.1
// Linda DeMichiel - 2.0
package jakarta.persistence;
/**
* Flush mode setting.
*
* When queries are executed within a transaction, if
* FlushModeType.AUTO is set on the {@link
* Query Query} or {@link TypedQuery
* TypedQuery} object, or if the flush mode setting for the
* persistence context is AUTO (the default) and a flush
* mode setting has not been specified for the Query or
* TypedQuery object, the persistence provider is
* responsible for ensuring that all updates to the state of all
* entities in the persistence context which could potentially affect
* the result of the query are visible to the processing of the
* query. The persistence provider implementation may achieve this by
* flushing those entities to the database or by some other means.
*
If FlushModeType.COMMIT is set, the effect of
* updates made to entities in the persistence context upon queries is
* unspecified.
*
*
If there is no transaction active or the persistence context is not
* joined to the current transaction, the persistence provider must not flush
* to the database.
*
* @since 1.0
*/
public enum FlushModeType {
/** Flushing to occur at transaction commit. The provider may flush
* at other times, but is not required to.
*/
COMMIT,
/** (Default) Flushing to occur at query execution. */
AUTO
}