org.eclipse.persistence.annotations.CascadeOnDelete Maven / Gradle / Ivy
Show all versions of eclipselink Show documentation
/*
* Copyright (c) 2011, 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.annotations;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;
import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.ElementType.TYPE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;
/**
* Define the foreign key defined by the relationship to cascade the delete on the database.
* This means when the source object is deleted the target object will be automatically deleted by the database.
* This will affect DDL generation as well as runtime behavior in omitting the delete statements.
*
* The constraint cascaded depends on the mapping, only relationship mappings are allowed.
* The relationship should also use cascade remove, or deleteOrphans.
*
For a OneToOne it can only be defined if the mapping uses a mappedBy, and will delete the target object.
*
It cannot be defined for a ManyToOne.
*
For a OneToMany it will delete the target objects, or ONLY the join table if using a join table.
*
For a ManyToMany it will delete the rows from the join table, not the target objects.
*
For an ElementCollection it will delete the target rows.
*
For an Entity it will delete the secondary or {@linkplain jakarta.persistence.InheritanceType#JOINED} inheritance tables.
*
* @author James Sutherland
* @since EclipseLink 2.2
*/
@Target({METHOD, FIELD, TYPE})
@Retention(RUNTIME)
public @interface CascadeOnDelete {
}