org.eclipse.persistence.config.CommitOrderType Maven / Gradle / Ivy

/*
 * Copyright (c) 2013, 2024 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:
//     Oracle - initial API and implementation

package org.eclipse.persistence.config;


/**
 * Commit order type persistence property values.
 *
 * JPA persistence property usage:
 * {@snippet :
 *  properties.add(PersistenceUnitProperties.PERSISTENCE_CONTEXT_COMMIT_ORDER, CommitOrderType.Changes);
 * }
 * 
Property values are case-insensitive.
 * 

 * Defines the ordering of updates and deletes of a set of the same entity type during a commit or flush operation.
 * The commit order of entities is defined by their foreign key constraints, and then sorted alphabetically.\
 * 

 * By default, the commit of a set of the same entity type is not ordered.
 * 
 * Entity type commit order can be modified using a {@linkplain org.eclipse.persistence.descriptors.DescriptorCustomizer} and
 * the {@linkplain org.eclipse.persistence.descriptors.ClassDescriptor#addConstraintDependency(Class)} API.
 * Commit order can also be controlled using the EntityManager.flush() API.
 */
public final class CommitOrderType {
    /** Updates and deletes are ordered by the object's id.  This can help avoid deadlocks on highly concurrent systems. */
    public static final String Id = "Id";
    /** Updates are ordered by the object's changes, then by id.  This can improve batch writing efficiency. */
    public static final String Changes = "Changes";
    /** No ordering is done. */
    public static final String None = "None";

    public static final String DEFAULT = Id;

    private CommitOrderType() {
        // no instance please
    }
}