Revision as of 08:40, 17 August 2012

This page is now obsolete. Please see the EclipseLink JPA Extensions Guide for current information.

EclipseLink
Website
Download
Community
Mailing List • Forums • IRC • mattermost
Issues
Open • Help Wanted • Bug Day
Contribute
Browse Source

Key API

• @CascadeOnDelete

Examples

• DeleteCascade Example

@CascadeOnDelete

ON DELETE CASCADE is a database foreign key constraint option that automatically removes the dependent rows.

Use the @CascadeOnDelete annotation to specify that a delete operation performed on a database object is cascaded on secondary or related tables.

CascadeOnDelete Behavior

@CascadeOnDelete has the following behavior:

• DDL generation : If DDL generation is used, the generated constraint will include the cascade deletion option.
• Entity : Remove will not execute SQL for deletion from secondary or joined inheritance tables (as constraint will handle deletion).
• OneToOne : If the mapping uses cascading or orphanRemoval, SQL will not be executed to delete target object.
• OneToMany : If the mapping uses cascading or orphanRemoval, SQL will not be executed to delete target objects.
• ManyToMany : SQL will not be executed to delete from the join table.
• ElementCollection : SQL will not be executed to delete from the collection table.
• Cache : Cascaded objects will still be removed from the cache and persistence context.
• Version locking : Version will not be verified on deletion of cascaded object.
• Events : Deletion events may not be executed on the cascaded objects if the objects are not loaded.
• Cascading : The remove operation should still be configured to cascade in the mapping if using CascadeOnDelete.

@CascadeOnDelete Example

This example cascade the deletion of the Employee secondary table, and all of its owned relationships.

@Entity
@SecondaryTable(name="EMP_SALARY")
@CascadeOnDelete
public class Employee{
    @Id
    private long id;
    private String firstName;
    private String lastName;
    @Column(table="EMP_SALARY")
    private String salary;
    @OneToOne(mappedBy="owner", orphanRemoval=true, cascade={CascadeType.ALL})
    @CascadeOnDelete
    private Address address;
    @OneToMany(mappedBy="owner", orphanRemoval=true, cascade={CascadeType.ALL})
    @CascadeOnDelete
    private List<Phone> phones;
    @ManyToMany
    @JoinTable(name="EMP_PROJ")
    @CascadeOnDelete
    private List<Project> projects;
    ...
}

Specifying Cascade on Delete in eclipselink-orm.xml

In the eclipselink-orm.xml descriptor file, specify cascade on delete as shown in the following example:

<cascade-on-delete>true</cascade-on-delete>

See also, DeleteCascade Example

Schema Generation	Schema Generation	@Index
EclipseLink Home JPA User Guide: Table of Contents, Search
How to contribute to this guide...