com.google.cloud.spanner.hibernate

Annotation Type Interleaved

@Documented
 @Target(value=TYPE)
 @Retention(value=RUNTIME)
public @interface Interleaved

This annotation can be used to annotate an Entity class that should be interleaved in a parent table. This annotation is Cloud Spanner specific and is only used when automatic schema generation is used. If you create your schema manually, you may leave this annotation out.

To generate the following schema:

 CREATE TABLE ParentTable (ParentId INT64, Name STRING(MAX)) PRIMARY KEY (ParentId);
 CREATE TABLE ChildTable (ParentId INT64, ChildId INT64, ChildName STRING(MAX))
              PRIMARY KEY (ParentId, ChildId),
              INTERLEAVE IN PARENT ParentTable
 

The following Java definition should be used:

 @Entity
 @Table(name = "ParentTable")
 public class Parent {
   @Id
   private Long parentId;

   @Column
   private String name;
   ...
 }

 @Entity
 @Table(name = "ChildTable")
 @Interleaved(parentEntity = Parent.class)
 public class Child {
   public static class ChildId implements Serializable {
     private Long parentId;
     private Long childId;
     ...
   }

   @EmbeddedId
   private ChildId id;

   @Column
   private String ChildName
   ...
 }
 

Since:

1.1

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
Class<?>	parentEntity The parent table that this table will be interleaved in.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	cascadeDelete Indicates whether when a row from the parent table is deleted that the child rows in this table will automatically be deleted as well.

Element Detail

parentEntity

public abstract Class<?> parentEntity

The parent table that this table will be interleaved in. This must be specified for this annotation.

Returns:

the entity class of the parent table

cascadeDelete

public abstract boolean cascadeDelete

Indicates whether when a row from the parent table is deleted that the child rows in this table will automatically be deleted as well. (default = false)

Returns:

true if ON DELETE CASCADE should be added to the CREATE TABLE string.

Default:

false