Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Difference between revisions of "EclipseLink/UserGuide/JPA/Advanced JPA Development/Schema Generation/CascadeOnDelete"

m
(25 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
 +
'''This page is now obsolete. Please see the [http://eclipse.org/eclipselink/documentation/2.4/jpa/extensions/a_cascadeondelete.htm EclipseLink JPA Extensions Guide] for current information.'''
 +
 +
----
 +
 +
 +
 
{{EclipseLink_UserGuide
 
{{EclipseLink_UserGuide
 
|info=y
 
|info=y
Line 5: Line 12:
 
|eclipselinktype=JPA
 
|eclipselinktype=JPA
 
|api=y
 
|api=y
|apis=[http://www.eclipse.org/eclipselink/api/latest/eclipse/persistence/annotations/CascadeOnDelete.html CascadeOnDelete]
+
|apis=
 +
*[http://www.eclipse.org/eclipselink/api/latest/org/eclipse/persistence/annotations/CascadeOnDelete.html @CascadeOnDelete]
 +
|examples=y
 +
|example=
 +
*[[EclipseLink/Examples/JPA/DeleteCascade|DeleteCascade Example]]
 
}}  
 
}}  
  
 
= @CascadeOnDelete  =
 
= @CascadeOnDelete  =
 
 
>>>>>> THIS PAGE IS IN PROGRESS. PLEASE SEE DISCUSSION PAGE. <<<<<<
 
  
 
ON DELETE CASCADE is a database foreign key constraint option that automatically removes the dependent rows.  
 
ON DELETE CASCADE is a database foreign key constraint option that automatically removes the dependent rows.  
  
Use the [http://www.eclipse.org/eclipselink/api/latest/eclipse/persistence/annotations/CascadeOnDelete.html <tt>@CascadeOnDelete</tt>] annotation or the <tt><cascade-on-delete></tt> XML element to specify that a delete operation performed on a database object is cascaded on secondary or related tables.  
+
Use the [http://www.eclipse.org/eclipselink/api/latest/eclipse/persistence/annotations/CascadeOnDelete.html <tt>@CascadeOnDelete</tt>] annotation to specify that a delete operation performed on a database object is cascaded on secondary or related tables.  
  
{| cellpadding="2" border="1"
+
=====''CascadeOnDelete Behavior''=====
|+ ''CascadeOnDelete''
+
{| cellpadding="2" border="1" cellspacing=0
 
|-
 
|-
| '''Performing a CascadeOnDelete on this object...'''  
+
| '''Entity/Mapping'''  
| '''Does this...'''
+
| '''Behavior'''
 
|-
 
|-
 
| Entity  
 
| Entity  
Line 27: Line 35:
 
|-
 
|-
 
| OneToOne mapping  
 
| OneToOne mapping  
| The deletion of the related object is cascaded on the database. This is only allowed for mappedBy/target-foriegn key OneToOne mappings (because of constraint direction).
+
| The deletion of the related object is cascaded on the database.
 +
This is only allowed for mappedBy/target-foriegn key OneToOne mappings (because of constraint direction).
 
|-
 
|-
 
| OneToMany mapping  
 
| OneToMany mapping  
| For a OneToMany using a mappedBy of JoinColumn, the deletion of the related objects is cascaded on the database.
+
| For a OneToMany using a mappedBy or JoinColumn, the deletion of the related objects is cascaded on the database.
| For a OneToMany using a JoinTable, the deletion of the join table is cascaded on the database. (Target objects cannot be cascaded even if private because of constraint direction).
+
For a OneToMany using a JoinTable, the deletion of the join table is cascaded on the database (target objects cannot be cascaded even if private because of constraint direction).
 
|-
 
|-
 
| ManyToMany mapping  
 
| ManyToMany mapping  
| The deletion of the join table is cascaded on the database. (Target objects cannot be cascaded even if private because of constraint direction).
+
| The deletion of the join table is cascaded on the database (target objects cannot be cascaded even if private because of constraint direction).
 
|-
 
|-
 
| ElementCollection mapping
 
| ElementCollection mapping
Line 40: Line 49:
 
|}
 
|}
  
<br> <source lang="java">
 
@Target(value={METHOD,FIELD,TYPE})
 
@Retention(value=RUNTIME)
 
public @interface CascadeOnDelete
 
</source>
 
  
Usage of @CascadeOnDelete has the following behavior:
+
<tt>@CascadeOnDelete</tt> has the following behavior:
  
* DDL generation : if DDL generation is used, the generated constraint will include the cascade deletion option.
+
* 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).
 
* 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.
 
* OneToOne : If the mapping uses cascading or orphanRemoval, SQL will not be executed to delete target object.
Line 56: Line 60:
 
* Cache : Cascaded objects will still be removed from the cache and persistence context.
 
* 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.
 
* 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.
  
= Configuration File  =
+
== @CascadeOnDelete Example ==
 +
This example cascade the deletion of the Employee secondary table, and all of its owned relationships.
 +
<source lang="java">
 +
@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;
 +
    ...
 +
}
 +
</source>
  
In the <tt>orm.xml</tt> descriptor file, specify cascade on delete as follows:  
+
== Specifying Cascade on Delete in eclipselink-orm.xml ==
 +
 
 +
In the <tt>eclipselink-orm.xml</tt> descriptor file, specify cascade on delete as shown in the following example:  
 
<source lang="xml">
 
<source lang="xml">
 
<cascade-on-delete>true</cascade-on-delete>
 
<cascade-on-delete>true</cascade-on-delete>
</entity>
+
</source>
</source>
+
 
 +
See also, [[EclipseLink/Examples/JPA/DeleteCascade|DeleteCascade Example]]
 
<br> {{EclipseLink_JPA
 
<br> {{EclipseLink_JPA
|previous =[[EclipseLink/UserGuide/JPA/Advanced_JPA_Development/Schema_Generation|Schema Generation]]
+
|previous=[[EclipseLink/UserGuide/JPA/Advanced_JPA_Development/Schema_Generation|Schema Generation]]
|up       =[[EclipseLink/UserGuide/JPA/Advanced_JPA_Development/Schema_Generation|Schema Generation]]
+
|up     =[[EclipseLink/UserGuide/JPA/Advanced_JPA_Development/Schema_Generation|Schema Generation]]
|next =[[EclipseLink/UserGuide/JPA/Advanced_JPA_Development/Schema_Generation/Appending_strings_to_CREATE_TABLE_statements|Appending Strings to CREATE_TABLE Statements]]
+
|next =[[EclipseLink/UserGuide/JPA/Advanced JPA Development/Schema Generation/Index|@Index]]
 
|version=2.2.0 DRAFT}}
 
|version=2.2.0 DRAFT}}

Revision as of 08:40, 17 August 2012

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




EclipseLink JPA

Eclipselink-logo.gif
EclipseLink
Website
Download
Community
Mailing ListForumsIRCmattermost
Issues
OpenHelp WantedBug Day
Contribute
Browse Source


@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
Entity/Mapping Behavior
Entity Defines that secondary or joined inheritance tables should cascade the delete on the database
OneToOne mapping The deletion of the related object is cascaded on the database.

This is only allowed for mappedBy/target-foriegn key OneToOne mappings (because of constraint direction).

OneToMany mapping For a OneToMany using a mappedBy or JoinColumn, the deletion of the related objects is cascaded on the database.

For a OneToMany using a JoinTable, the deletion of the join table is cascaded on the database (target objects cannot be cascaded even if private because of constraint direction).

ManyToMany mapping The deletion of the join table is cascaded on the database (target objects cannot be cascaded even if private because of constraint direction).
ElementCollection mapping The deletion of the collection table is cascaded on the database.


@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


Eclipselink-logo.gif
Version: 2.2.0 DRAFT
Other versions...

Copyright © Eclipse Foundation, Inc. All Rights Reserved.