Enforce globally unique table locations

extension/persistence/eclipselink/src/main/java/io/polaris/extension/persistence/impl/eclipselink/PolarisEclipseLinkMetaStoreSessionImpl.java

@@ -461,7 +461,8 @@ public List<PolarisEntityActiveRecord> lookupEntityActiveBatch(
                 entity.getParentId(),
                 entity.getName(),
                 entity.getTypeCode(),
-                entity.getSubTypeCode()));
+                entity.getSubTypeCode(),
+                entity.getLocation()));
   }
 
   @Override
@@ -690,4 +691,9 @@ public void rollback() {
       session.getTransaction().rollback();
     }
   }
+
+  @Override
+  public boolean locationOverlapsWithExistingTableLike(@NotNull PolarisCallContext callContext, String location) {
+    return this.store.locationOverlapsWithExistingTableLike(localSession.get(), location);
+  }
 }

extension/persistence/eclipselink/src/main/java/io/polaris/extension/persistence/impl/eclipselink/PolarisEclipseLinkStore.java

@@ -409,4 +409,33 @@ void deletePrincipalSecrets(EntityManager session, String clientId) {
 
     session.remove(modelPrincipalSecrets);
   }
+
+  boolean locationOverlapsWithExistingTableLike(EntityManager session, String location) {
+    if (location == null) {
+      return false;
+    }
+    diagnosticServices.check(session != null, "session_is_null");
+
+    return session
+        .createQuery(
+            """
+                SELECT
+                    1
+                FROM
+                    ModelEntityActive
+                WHERE
+                    location IS NOT NULL
+                    AND typeCode = :table_code
+                    AND (
+                        location LIKE CONCAT(:location, '%')
+                        OR :location LIKE CONCAT(location, '%')
+                    )
+            """,
+            ModelEntityDropped.class)
+        .setParameter("location", location)
+        .setParameter("table_code", PolarisEntityType.TABLE_LIKE.getCode())
+        .getResultStream()
+        .findFirst()
+        .isPresent();
+  }
 }

polaris-core/src/main/java/io/polaris/core/PolarisConfiguration.java

@@ -23,6 +23,10 @@ public class PolarisConfiguration {
   public static final String ALLOW_NAMESPACE_LOCATION_OVERLAP = "ALLOW_NAMESPACE_LOCATION_OVERLAP";
   public static final String ALLOW_EXTERNAL_METADATA_FILE_LOCATION =
       "ALLOW_EXTERNAL_METADATA_FILE_LOCATION";
+  public static final String ENFORCE_GLOBALLY_UNIQUE_TABLE_LOCATIONS =
+      "ENFORCE_GLOBALLY_UNIQUE_TABLE_LOCATIONS";
+  public static final String ENFORCE_TABLE_LOCATIONS_INSIDE_NAMESPACE_LOCATIONS =
+      "ENFORCE_TABLE_LOCATIONS_INSIDE_NAMESPACE_LOCATIONS";
 
   public static final String ALLOW_OVERLAPPING_CATALOG_URLS = "ALLOW_OVERLAPPING_CATALOG_URLS";
 
@@ -39,6 +43,8 @@ public class PolarisConfiguration {
   public static final boolean DEFAULT_ALLOW_TABLE_LOCATION_OVERLAP = false;
   public static final boolean DEFAULT_ALLOW_EXTERNAL_METADATA_FILE_LOCATION = false;
   public static final boolean DEFAULT_ALLOW_NAMESPACE_LOCATION_OVERLAP = false;
+  public static final boolean DEFAULT_ENFORCE_GLOBALLY_UNIQUE_TABLE_LOCATIONS = false;
+  public static final boolean DEFAULT_ENFORCE_TABLE_LOCATIONS_INSIDE_NAMESPACE_LOCATIONS = true;
 
   private PolarisConfiguration() {}
 }

polaris-core/src/main/java/io/polaris/core/PolarisUtils.java

@@ -0,0 +1,37 @@
+/*
+ * Copyright (c) 2024 Snowflake Computing Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+package io.polaris.core;
+
+/**
+ * A collection of utilities for polaris-core
+ */
+public class PolarisUtils {
+
+    /**
+     * Given some path, append a `/` if it doesn't already end with one
+     */
+    public static String terminateWithSlash(String path) {
+        if (path == null) {
+            return null;
+        } else if (!path.endsWith("/")) {
+            return path + "/";
+        } else {
+            return path;
+        }
+    }
+}

polaris-core/src/main/java/io/polaris/core/entity/NamespaceEntity.java

@@ -70,7 +70,7 @@ public Builder(Namespace namespace) {
       setName(namespace.level(namespace.length() - 1));
     }
 
-    public Builder setBaseLocation(String baseLocation) {
+    private Builder setBaseLocation(String baseLocation) {
       properties.put(PolarisEntityConstants.ENTITY_BASE_LOCATION, baseLocation);
       return this;
     }
@@ -82,6 +82,12 @@ public Builder setParentNamespace(Namespace namespace) {
       return this;
     }
 
+    public Builder setLocation(String location) {
+      super.setLocation(location);
+      setBaseLocation(location);
+      return this;
+    }
+
     public NamespaceEntity build() {
       return new NamespaceEntity(buildBase());
     }

polaris-core/src/main/java/io/polaris/core/entity/PolarisBaseEntity.java

@@ -61,6 +61,9 @@ public class PolarisBaseEntity extends PolarisEntityCore {
   // current version for that entity, will be monotonically incremented
   protected int grantRecordsVersion;
 
+  // The location of the entity
+  protected String location;
+
   public int getSubTypeCode() {
     return subTypeCode;
   }
@@ -113,6 +116,14 @@ public String getProperties() {
     return properties != null ? properties : EMPTY_MAP_STRING;
   }
 
+  public String getLocation() {
+    return this.location;
+  }
+
+  public void setLocation(String location) {
+    this.location = location;
+  }
+
   @JsonIgnore
   public Map<String, String> getPropertiesAsMap() {
     if (properties == null) {
@@ -239,6 +250,7 @@ public PolarisBaseEntity(PolarisBaseEntity entity) {
     this.properties = entity.getProperties();
     this.internalProperties = entity.getInternalProperties();
     this.grantRecordsVersion = entity.getGrantRecordsVersion();
+    this.location = entity.getLocation();
   }
 
   /** Build the DTO for a new entity */

polaris-core/src/main/java/io/polaris/core/entity/PolarisEntity.java

@@ -87,7 +87,8 @@ private PolarisEntity(
       @JsonProperty("properties") String properties,
       @JsonProperty("internalProperties") String internalProperties,
       @JsonProperty("entityVersion") int entityVersion,
-      @JsonProperty("grantRecordsVersion") int grantRecordsVersion) {
+      @JsonProperty("grantRecordsVersion") int grantRecordsVersion,
+      @JsonProperty("location") String location) {
     super(catalogId, id, type, subType, parentId, name);
     this.createTimestamp = createTimestamp;
     this.dropTimestamp = dropTimestamp;
@@ -97,6 +98,7 @@ private PolarisEntity(
     this.internalProperties = internalProperties;
     this.entityVersion = entityVersion;
     this.grantRecordsVersion = grantRecordsVersion;
+    this.location = location;
   }
 
   public PolarisEntity(
@@ -113,7 +115,7 @@ public PolarisEntity(
       Map<String, String> properties,
       Map<String, String> internalProperties,
       int entityVersion,
-      int grantRecordsVersion) {
+      int grantRecordsVersion, String location) {
     super(catalogId, id, type, subType, parentId, name);
     this.createTimestamp = createTimestamp;
     this.dropTimestamp = dropTimestamp;
@@ -123,6 +125,7 @@ public PolarisEntity(
     this.setInternalPropertiesAsMap(internalProperties);
     this.entityVersion = entityVersion;
     this.grantRecordsVersion = grantRecordsVersion;
+    this.location = location;
   }
 
   public static PolarisEntity of(PolarisBaseEntity sourceEntity) {
@@ -184,6 +187,7 @@ public PolarisEntity(@NotNull PolarisBaseEntity sourceEntity) {
     this.internalProperties = sourceEntity.getInternalProperties();
     this.entityVersion = sourceEntity.getEntityVersion();
     this.grantRecordsVersion = sourceEntity.getGrantRecordsVersion();
+    this.location = sourceEntity.getLocation();
   }
 
   @JsonIgnore
@@ -201,6 +205,11 @@ public NameAndId nameAndId() {
     return new NameAndId(name, id);
   }
 
+  @JsonIgnore
+  public String getLocation() {
+    return location;
+  }
+
   @Override
   public String toString() {
     StringBuilder sb = new StringBuilder();
@@ -211,6 +220,7 @@ public String toString() {
     sb.append(";type=" + getType());
     sb.append(";subType=" + getSubType());
     sb.append(";internalProperties=" + getInternalPropertiesAsMap());
+    sb.append(";location=" + getLocation());
     return sb.toString();
   }
 
@@ -232,7 +242,8 @@ public boolean equals(Object o) {
         && subTypeCode == that.subTypeCode
         && Objects.equals(name, that.name)
         && Objects.equals(properties, that.properties)
-        && Objects.equals(internalProperties, that.internalProperties);
+        && Objects.equals(internalProperties, that.internalProperties)
+        && Objects.equals(location, that.location);
   }
 
   @Override
@@ -251,7 +262,8 @@ public int hashCode() {
         properties,
         internalProperties,
         entityVersion,
-        grantRecordsVersion);
+        grantRecordsVersion,
+        location);
   }
 
   public static class Builder extends BaseBuilder<PolarisEntity, Builder> {
@@ -284,6 +296,7 @@ public abstract static class BaseBuilder<T extends PolarisEntity, B extends Base
     protected Map<String, String> internalProperties;
     protected int entityVersion;
     protected int grantRecordsVersion;
+    protected String location;
 
     protected BaseBuilder() {
       this.catalogId = -1;
@@ -300,6 +313,7 @@ protected BaseBuilder() {
       this.internalProperties = new HashMap<>();
       this.entityVersion = 1;
       this.grantRecordsVersion = 1;
+      this.location = null;
     }
 
     protected BaseBuilder(T original) {
@@ -317,6 +331,7 @@ protected BaseBuilder(T original) {
       this.internalProperties = new HashMap<>(original.getInternalPropertiesAsMap());
       this.entityVersion = original.entityVersion;
       this.grantRecordsVersion = original.grantRecordsVersion;
+      this.location = original.location;
     }
 
     public abstract T build();
@@ -338,7 +353,8 @@ public PolarisEntity buildBase() {
           properties,
           internalProperties,
           entityVersion,
-          grantRecordsVersion);
+          grantRecordsVersion,
+          location);
     }
 
     public B setCatalogId(long catalogId) {
@@ -419,5 +435,10 @@ public B setGrantRecordsVersion(int grantRecordsVersion) {
       this.grantRecordsVersion = grantRecordsVersion;
       return (B) this;
     }
+
+    public B setLocation(String location) {
+      this.location = location;
+      return (B) this;
+    }
   }
 }

polaris-core/src/main/java/io/polaris/core/entity/PolarisEntityActiveRecord.java

@@ -17,6 +17,8 @@
 
 import com.fasterxml.jackson.annotation.JsonCreator;
 import com.fasterxml.jackson.annotation.JsonProperty;
+import jakarta.persistence.Column;
+
 import java.util.Objects;
 
 public class PolarisEntityActiveRecord {
@@ -38,6 +40,10 @@ public class PolarisEntityActiveRecord {
   // code representing the subtype of that entity
   private final int subTypeCode;
 
+  // location of the entity
+  @Column(nullable = true)
+  private String location;
+
   public long getCatalogId() {
     return catalogId;
   }
@@ -66,6 +72,10 @@ public int getSubTypeCode() {
     return subTypeCode;
   }
 
+  public String getLocation() {
+    return location;
+  }
+
   public PolarisEntitySubType getSubType() {
     return PolarisEntitySubType.fromCode(this.subTypeCode);
   }
@@ -77,13 +87,15 @@ public PolarisEntityActiveRecord(
       @JsonProperty("parentId") long parentId,
       @JsonProperty("name") String name,
       @JsonProperty("typeCode") int typeCode,
-      @JsonProperty("subTypeCode") int subTypeCode) {
+      @JsonProperty("subTypeCode") int subTypeCode,
+      @JsonProperty("location") String location) {
     this.catalogId = catalogId;
     this.id = id;
     this.parentId = parentId;
     this.name = name;
     this.typeCode = typeCode;
     this.subTypeCode = subTypeCode;
+    this.location = location;
   }
 
   /** Constructor to create the object with provided entity */
@@ -94,6 +106,7 @@ public PolarisEntityActiveRecord(PolarisBaseEntity entity) {
     this.typeCode = entity.getTypeCode();
     this.name = entity.getName();
     this.subTypeCode = entity.getSubTypeCode();
+    this.location = entity.getLocation();
   }
 
   @Override
@@ -106,12 +119,13 @@ public boolean equals(Object o) {
         && parentId == that.parentId
         && typeCode == that.typeCode
         && subTypeCode == that.subTypeCode
-        && Objects.equals(name, that.name);
+        && Objects.equals(name, that.name)
+        && Objects.equals(location, that.location);
   }
 
   @Override
   public int hashCode() {
-    return Objects.hash(catalogId, id, parentId, name, typeCode, subTypeCode);
+    return Objects.hash(catalogId, id, parentId, name, typeCode, subTypeCode, location);
   }
 
   @Override
@@ -130,6 +144,9 @@ public String toString() {
         + typeCode
         + ", subTypeCode="
         + subTypeCode
+        + ", location='"
+        + location
+        + '\''
         + '}';
   }
 }