Jump to: navigation, search

Difference between revisions of "EclipseLink/UserGuide/JPA/Basic JPA Development/Mapping/Basic Mappings/Transient"

m (New page: {{EclipseLink_UserGuide|info=y|toc=n}} =@Transient= {{EclipseLink_JPA |previous=Temporal |next= ...)
 
(Example: @Transient Annotation)
 
(7 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{EclipseLink_UserGuide|info=y|toc=n}}
+
{{EclipseLink_UserGuide
 +
|info=y
 +
|toc=n
 +
|eclipselink=y
 +
|eclipselinktype=JPA
 +
|api=y
 +
|apis=
 +
* [http://www.eclipse.org/eclipselink/api/latest/javax/persistence/Transient.html @Transient]
 +
}}
 +
 
 
=@Transient=
 
=@Transient=
 +
By default, EclipseLink persistence provider assumes that all the fields of an entity are persistent.
 +
 +
Use the <tt>@Transient</tt> annotation or <code><nowiki><transient></nowiki></code> XML to specify a field or property of an entity that is not persistent (for example, a field or property that is used at run time, but that is not part of the entity's state).
 +
 +
EclipseLink persistence provider will not persist (or create database schema) for a property or field annotated with <tt>@Transient</tt>.
 +
 +
This annotation can be used with <tt>@Entity</tt>, <tt>@MappedSuperclass</tt>, and <tt>@Embeddable</tt>.
 +
{{EclipseLink_Spec
 +
|section=Section 8.1 "Entity"}}
 +
 +
The <tt>@Transient</tt> annotation does not have attributes.
 +
 +
If a field is marked as Java <code>transient</code> it will also be ignored.
 +
 +
The following example shows how to use the <tt>@Transient</tt> annotation to specify <tt>Employee</tt> field <tt>currentSession</tt> as not persistent. EclipseLink persistence provider will not persist this field.
 +
 +
======'' Example: @Transient Annotation''======
 +
<source lang="java">
 +
@Entity
 +
public class Employee implements Serializable {
 +
    @Id
 +
    int id;
 +
 +
    @Transient
 +
    Session currentSession;
 +
    ...
 +
}
 +
</source>
 +
 +
======''Example: Using <code><nowiki><transient></nowiki></code> XML''======
 +
<source lang="xml">
 +
<entity class="Employee">
 +
    <attributes>
 +
        <id name="id"/>
 +
        <transient name="currentSession"/>
 +
        ...
 +
    </attributes>
 +
</entity>
 +
</source>
 +
 +
{{EclipseLink_Spec
 +
|section=Section 11.1.48 "Transient Annotation"}}
  
  
  
 
{{EclipseLink_JPA
 
{{EclipseLink_JPA
|previous=[[EclipseLink/UserGuide/JPA/Basic JPA Development/Mapping/Basic Mappings/Enumerated|Temporal]]
+
|previous=[[EclipseLink/UserGuide/JPA/Basic JPA Development/Mapping/Basic Mappings/Lob|@Lob]]
|next=    [[EclipseLink/UserGuide/JPA/Basic JPA Development/Mapping/Basic Mappings/Column|Column]]
+
|next=    [[EclipseLink/UserGuide/JPA/Basic JPA Development/Mapping/Basic Mappings/Column|@Column]]
 
|up=      [[EclipseLink/UserGuide/JPA/Basic JPA Development/Mapping/Basic Mappings|Basic Mappings]]
 
|up=      [[EclipseLink/UserGuide/JPA/Basic JPA Development/Mapping/Basic Mappings|Basic Mappings]]
}}
+
|version= 2.1.0}}

Latest revision as of 14:16, 27 October 2011

EclipseLink JPA

link="http://wiki.eclipse.org/EclipseLink"
EclipseLink
Website
Download
Community
Mailing ListForumsIRC
Bugzilla
Open
Help Wanted
Bug Day
Contribute
Browse Source

Elug api package icon.png Key API


@Transient

By default, EclipseLink persistence provider assumes that all the fields of an entity are persistent.

Use the @Transient annotation or <transient> XML to specify a field or property of an entity that is not persistent (for example, a field or property that is used at run time, but that is not part of the entity's state).

EclipseLink persistence provider will not persist (or create database schema) for a property or field annotated with @Transient.

This annotation can be used with @Entity, @MappedSuperclass, and @Embeddable.

Elug javaspec icon.gif

For more information, see Section 8.1 "Entity" in the JPA Specification.

The @Transient annotation does not have attributes.

If a field is marked as Java transient it will also be ignored.

The following example shows how to use the @Transient annotation to specify Employee field currentSession as not persistent. EclipseLink persistence provider will not persist this field.

Example: @Transient Annotation
@Entity
public class Employee implements Serializable {
    @Id
    int id;
 
    @Transient
    Session currentSession;
    ...
}
Example: Using <transient> XML
<entity class="Employee">
    <attributes>
        <id name="id"/>
        <transient name="currentSession"/>
        ...
    </attributes>
</entity>
Elug javaspec icon.gif

For more information, see Section 11.1.48 "Transient Annotation" in the JPA Specification.


Eclipselink-logo.gif
Version: 2.1.0
Other versions...