Spanner Import/Export INTERLEAVE IN

v1/src/main/java/com/google/cloud/teleport/spanner/AvroSchemaToDdlConverter.java

@@ -31,6 +31,7 @@
 import static com.google.cloud.teleport.spanner.AvroUtil.SPANNER_ENTITY_PROPERTY_GRAPH;
 import static com.google.cloud.teleport.spanner.AvroUtil.SPANNER_FOREIGN_KEY;
 import static com.google.cloud.teleport.spanner.AvroUtil.SPANNER_INDEX;
+import static com.google.cloud.teleport.spanner.AvroUtil.SPANNER_INTERLEAVE_TYPE;
 import static com.google.cloud.teleport.spanner.AvroUtil.SPANNER_LABEL;
 import static com.google.cloud.teleport.spanner.AvroUtil.SPANNER_NAMED_SCHEMA;
 import static com.google.cloud.teleport.spanner.AvroUtil.SPANNER_NODE_TABLE;
@@ -68,6 +69,7 @@
 import com.google.cloud.teleport.spanner.ddl.PropertyGraph.PropertyDeclaration;
 import com.google.cloud.teleport.spanner.ddl.Sequence;
 import com.google.cloud.teleport.spanner.ddl.Table;
+import com.google.cloud.teleport.spanner.ddl.Table.InterleaveType;
 import com.google.cloud.teleport.spanner.ddl.View;
 import com.google.common.annotations.VisibleForTesting;
 import com.google.common.base.Strings;
@@ -613,6 +615,16 @@ public Table toTable(String tableName, Schema schema) {
     if (!Strings.isNullOrEmpty(spannerParent)) {
       table.interleaveInParent(spannerParent);
 
+      // Process the interleave type.
+      String spannerInterleaveType = schema.getProp(SPANNER_INTERLEAVE_TYPE);
+      if (!Strings.isNullOrEmpty(spannerInterleaveType)) {
+        table.interleaveType(
+            spannerInterleaveType.equals("IN") ? InterleaveType.IN : InterleaveType.IN_PARENT);
+      } else {
+        // Default to IN_PARENT for backwards compatibility with older exports.
+        table.interleaveType(InterleaveType.IN_PARENT);
+      }
+
       // Process the on delete action.
       String onDeleteAction = schema.getProp(SPANNER_ON_DELETE_ACTION);
       if (onDeleteAction == null) {

v1/src/main/java/com/google/cloud/teleport/spanner/AvroUtil.java

@@ -43,6 +43,7 @@ private AvroUtil() {}
   public static final String SPANNER_ON_DELETE_ACTION = "spannerOnDeleteAction";
   public static final String SPANNER_OPTION = "spannerOption_";
   public static final String SPANNER_PARENT = "spannerParent";
+  public static final String SPANNER_INTERLEAVE_TYPE = "spannerInterleaveType";
   public static final String SPANNER_PRIMARY_KEY = "spannerPrimaryKey";
   public static final String SPANNER_REMOTE = "spannerRemote";
   public static final String SPANNER_SEQUENCE_OPTION = "sequenceOption_";

v1/src/main/java/com/google/cloud/teleport/spanner/DdlToAvroSchemaConverter.java

@@ -33,6 +33,7 @@
 import static com.google.cloud.teleport.spanner.AvroUtil.SPANNER_ENTITY_PROPERTY_GRAPH;
 import static com.google.cloud.teleport.spanner.AvroUtil.SPANNER_FOREIGN_KEY;
 import static com.google.cloud.teleport.spanner.AvroUtil.SPANNER_INDEX;
+import static com.google.cloud.teleport.spanner.AvroUtil.SPANNER_INTERLEAVE_TYPE;
 import static com.google.cloud.teleport.spanner.AvroUtil.SPANNER_LABEL;
 import static com.google.cloud.teleport.spanner.AvroUtil.SPANNER_NAME;
 import static com.google.cloud.teleport.spanner.AvroUtil.SPANNER_NAMED_SCHEMA;
@@ -69,6 +70,7 @@
 import com.google.cloud.teleport.spanner.ddl.PropertyGraph;
 import com.google.cloud.teleport.spanner.ddl.Sequence;
 import com.google.cloud.teleport.spanner.ddl.Table;
+import com.google.cloud.teleport.spanner.ddl.Table.InterleaveType;
 import com.google.cloud.teleport.spanner.ddl.View;
 import com.google.common.collect.ImmutableList;
 import java.util.ArrayList;
@@ -119,6 +121,9 @@ public Collection<Schema> convert(Ddl ddl) {
       recordBuilder.prop(GOOGLE_STORAGE, "CloudSpanner");
       if (table.interleaveInParent() != null) {
         recordBuilder.prop(SPANNER_PARENT, table.interleaveInParent());
+        recordBuilder.prop(
+            SPANNER_INTERLEAVE_TYPE,
+            table.interleaveType() == InterleaveType.IN ? "IN" : "IN PARENT");
         recordBuilder.prop(
             SPANNER_ON_DELETE_ACTION, table.onDeleteCascade() ? "cascade" : "no action");
       }

v1/src/main/java/com/google/cloud/teleport/spanner/ddl/InformationSchemaScanner.java

@@ -28,6 +28,7 @@
 import com.google.cloud.spanner.ResultSet;
 import com.google.cloud.spanner.Statement;
 import com.google.cloud.teleport.spanner.ddl.ForeignKey.ReferentialAction;
+import com.google.cloud.teleport.spanner.ddl.Table.InterleaveType;
 import com.google.cloud.teleport.spanner.proto.ExportProtos.Export;
 import com.google.common.annotations.VisibleForTesting;
 import com.google.common.base.Optional;
@@ -228,7 +229,7 @@ private void listTables(Ddl.Builder builder) {
       case GOOGLE_STANDARD_SQL:
         queryBuilder =
             Statement.newBuilder(
-                "SELECT t.table_schema, t.table_name, t.parent_table_name, t.on_delete_action FROM"
+                "SELECT t.table_schema, t.table_name, t.parent_table_name, t.interleave_type, t.on_delete_action FROM"
                     + " information_schema.tables AS t"
                     + " WHERE t.table_schema NOT IN"
                     + " ('INFORMATION_SCHEMA', 'SPANNER_SYS')");
@@ -241,7 +242,7 @@ private void listTables(Ddl.Builder builder) {
       case POSTGRESQL:
         queryBuilder =
             Statement.newBuilder(
-                "SELECT t.table_schema, t.table_name, t.parent_table_name, t.on_delete_action FROM"
+                "SELECT t.table_schema, t.table_name, t.parent_table_name, t.interleave_type, t.on_delete_action FROM"
                     + " information_schema.tables AS t"
                     + " WHERE t.table_schema NOT IN "
                     + "('information_schema', 'spanner_sys', 'pg_catalog')");
@@ -272,18 +273,39 @@ private void listTables(Ddl.Builder builder) {
       // Parent table and child table has to be in same schema.
       String parentTableName =
           resultSet.isNull(2) ? null : getQualifiedName(tableSchema, resultSet.getString(2));
-      String onDeleteAction = resultSet.isNull(3) ? null : resultSet.getString(3);
+      String interleaveTypeStr = resultSet.isNull(3) ? null : resultSet.getString(3);
+      Table.InterleaveType interleaveType = null;
+      if (!Strings.isNullOrEmpty(interleaveTypeStr)) {
+        interleaveType =
+            interleaveTypeStr.equals("IN PARENT") ? InterleaveType.IN_PARENT : InterleaveType.IN;
+      }
+      String onDeleteAction = resultSet.isNull(4) ? null : resultSet.getString(4);
+
+      boolean hasParentTable = !Strings.isNullOrEmpty(parentTableName);
+      boolean hasInterleaveType = !Strings.isNullOrEmpty(interleaveTypeStr);
+      boolean hasOnDeleteAction = !Strings.isNullOrEmpty(onDeleteAction);
+
+      // If parent_table_name is set, then it is required that there also be an interleave_type.
+      // Conversely, if there is no parent, then there should also be no interleave_type.
+      if (hasParentTable != hasInterleaveType) {
+        throw new IllegalStateException(
+            String.format(
+                "Invalid combination of parentTableName %s and interleaveType %s",
+                parentTableName, interleaveTypeStr));
+      }
 
-      // Error out when the parent table or on delete action are set incorrectly.
-      if (Strings.isNullOrEmpty(parentTableName) != Strings.isNullOrEmpty(onDeleteAction)) {
+      // If this table is interleaved with IN PARENT semantics, then an ON DELETE action is
+      // required. Conversely, if this table is interleaved with IN semantics or is not interleaved
+      // at all, then it is required that there not be an ON DELETE action.
+      if ((interleaveType == InterleaveType.IN_PARENT) == hasOnDeleteAction) {
         throw new IllegalStateException(
             String.format(
-                "Invalid combination of parentTableName %s and onDeleteAction %s",
+                "Invalid combination of IN PARENT %s and onDeleteAction %s",
                 parentTableName, onDeleteAction));
       }
 
       boolean onDeleteCascade = false;
-      if (onDeleteAction != null) {
+      if (hasOnDeleteAction) {
         if (onDeleteAction.equals("CASCADE")) {
           onDeleteCascade = true;
         } else if (!onDeleteAction.equals("NO ACTION")) {
@@ -296,6 +318,7 @@ private void listTables(Ddl.Builder builder) {
       builder
           .createTable(tableName)
           .interleaveInParent(parentTableName)
+          .interleaveType(interleaveType)
           .onDeleteCascade(onDeleteCascade)
           .endTable();
     }

v1/src/main/java/com/google/cloud/teleport/spanner/ddl/Table.java

@@ -39,6 +39,14 @@ public abstract class Table implements Serializable {
   @Nullable
   public abstract String interleaveInParent();
 
+  public enum InterleaveType {
+    IN,
+    IN_PARENT
+  };
+
+  @Nullable
+  public abstract InterleaveType interleaveType();
+
   public abstract ImmutableList<IndexColumn> primaryKeys();
 
   public abstract boolean onDeleteCascade();
@@ -117,7 +125,8 @@ private void prettyPrintPg(
     appendable.append("\n)");
     if (interleaveInParent() != null) {
       appendable
-          .append(" \nINTERLEAVE IN PARENT ")
+          .append(" \nINTERLEAVE IN ")
+          .append(interleaveType() == InterleaveType.IN ? "" : "PARENT ")
           .append(quoteIdentifier(interleaveInParent(), dialect()));
       if (onDeleteCascade()) {
         appendable.append(" ON DELETE CASCADE");
@@ -156,7 +165,8 @@ private void prettyPrintGsql(
     appendable.append(")");
     if (interleaveInParent() != null) {
       appendable
-          .append(",\nINTERLEAVE IN PARENT ")
+          .append(",\nINTERLEAVE IN ")
+          .append(interleaveType() == InterleaveType.IN ? " " : "PARENT ")
           .append(quoteIdentifier(interleaveInParent(), dialect()));
       if (onDeleteCascade()) {
         appendable.append(" ON DELETE CASCADE");
@@ -206,6 +216,8 @@ Builder ddlBuilder(Ddl.Builder ddlBuilder) {
 
     public abstract Builder interleaveInParent(String parent);
 
+    public abstract Builder interleaveType(Table.InterleaveType type);
+
     abstract Builder primaryKeys(ImmutableList<IndexColumn> value);
 
     abstract Builder onDeleteCascade(boolean onDeleteCascade);