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

@@ -16,6 +16,7 @@
 package io.polaris.extension.persistence.impl.eclipselink;
 
 import io.polaris.core.PolarisDiagnostics;
+import io.polaris.core.PolarisUtils;
 import io.polaris.core.entity.PolarisBaseEntity;
 import io.polaris.core.entity.PolarisEntitiesActiveKey;
 import io.polaris.core.entity.PolarisEntityActiveRecord;
@@ -34,7 +35,10 @@
 import jakarta.persistence.TypedQuery;
 import java.util.ArrayList;
 import java.util.List;
+import java.util.Optional;
 import java.util.stream.Collectors;
+import java.util.stream.IntStream;
+
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 import org.slf4j.Logger;
@@ -409,4 +413,58 @@ 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");
+
+    List<String> directoryList = new ArrayList<>();
+    String queryString = """
+        SELECT
+            location
+        FROM
+            ModelEntityActive
+        WHERE
+            location IS NOT NULL
+            AND typeCode = :table_code
+            AND (
+                location LIKE CONCAT(:location, '%')
+                OR :location LIKE CONCAT(location, '%')
+            )
+    """;
+
+    int MAX_DIRECTORIES_IN_QUERY = 32;
+    Optional<List<String>> directories = PolarisUtils.pathToDirectories(location, MAX_DIRECTORIES_IN_QUERY);
+    if (directories.isPresent()) {
+      directoryList = directories.get();
+      queryString = IntStream.range(0, directoryList.size())
+          .mapToObj(i ->
+              "SELECT location " +
+              "FROM ModelEntityActive " +
+              "WHERE location IS NOT NULL " +
+              "AND typeCode = :table_code " +
+              "AND location = :directory_" + i
+          )
+          .collect(Collectors.joining(" UNION ALL "));
+
+      queryString += " UNION ALL " +
+                     "SELECT location " +
+                     "FROM ModelEntityActive " +
+                     "WHERE location IS NOT NULL " +
+                     "AND typeCode = :table_code " +
+                     "AND location LIKE :locationPrefix";
+    }
+
+    TypedQuery<String> query = session.createQuery(queryString, String.class)
+        .setParameter("table_code", PolarisEntityType.TABLE_LIKE.getCode())
+        .setParameter("locationPrefix", location + "%");
+
+    for (int i = 0; i < directoryList.size(); i++) {
+      query.setParameter("directory_" + i, directoryList.get(i));
+    }
+
+    return query.getResultStream().findFirst().isPresent();
+  }
 }

extension/persistence/eclipselink/src/test/java/com/snowflake/polaris/persistence/impl/eclipselink/PolarisEclipseLinkMetaStoreTest.java

@@ -25,6 +25,8 @@
 import io.polaris.extension.persistence.impl.eclipselink.PolarisEclipseLinkMetaStoreSessionImpl;
 import io.polaris.extension.persistence.impl.eclipselink.PolarisEclipseLinkStore;
 import java.time.ZoneId;
+
+import org.junit.jupiter.api.Test;
 import org.mockito.Mockito;
 
 /**

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,56 @@
+/*
+ * 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;
+
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Optional;
+
+/** 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;
+    }
+  }
+
+  /**
+   * Given a path like `/a/b/c`, find all directories in the path such as [`/`, `/a/`, `/a/b/`,
+   * `/a/b/c`]
+   */
+  public static Optional<List<String>> pathToDirectories(String path, int maxSegments) {
+    List<String> directories = new ArrayList<>();
+    String[] splitPath = path.split("/", -1);
+
+    if (splitPath.length - 2 > maxSegments) {
+      return Optional.empty();
+    } else {
+      StringBuilder currentPath = new StringBuilder();
+      for (int i = 0; i < splitPath.length - 1; i++) {
+        currentPath.append(splitPath[i]).append("/");
+        directories.add(currentPath.toString());
+      }
+      // Chop off the protocol:
+      return Optional.of(directories.subList(1, directories.size()));
+    }
+  }
+}

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

@@ -19,6 +19,7 @@
 import com.fasterxml.jackson.core.JsonProcessingException;
 import com.fasterxml.jackson.core.type.TypeReference;
 import com.fasterxml.jackson.databind.ObjectMapper;
+import io.polaris.core.PolarisUtils;
 import java.util.HashMap;
 import java.util.Map;
 import java.util.Objects;
@@ -113,6 +114,15 @@ public String getProperties() {
     return properties != null ? properties : EMPTY_MAP_STRING;
   }
 
+  public String getLocation() {
+    if (getType() == PolarisEntityType.TABLE_LIKE) {
+      return PolarisUtils.terminateWithSlash(
+          getPropertiesAsMap().get(PolarisEntityConstants.ENTITY_BASE_LOCATION));
+    } else {
+      return null;
+    }
+  }
+
   @JsonIgnore
   public Map<String, String> getPropertiesAsMap() {
     if (properties == null) {

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

@@ -38,6 +38,9 @@ public class PolarisEntityActiveRecord {
   // code representing the subtype of that entity
   private final int subTypeCode;
 
+  // location of the entity where applicable
+  private final String location;
+
   public long getCatalogId() {
     return catalogId;
   }
@@ -66,6 +69,10 @@ public int getSubTypeCode() {
     return subTypeCode;
   }
 
+  public String getLocation() {
+    return location;
+  }
+
   public PolarisEntitySubType getSubType() {
     return PolarisEntitySubType.fromCode(this.subTypeCode);
   }
@@ -77,13 +84,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 +103,7 @@ public PolarisEntityActiveRecord(PolarisBaseEntity entity) {
     this.typeCode = entity.getTypeCode();
     this.name = entity.getName();
     this.subTypeCode = entity.getSubTypeCode();
+    this.location = entity.getLocation();
   }
 
   @Override
@@ -106,12 +116,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 +141,9 @@ public String toString() {
         + typeCode
         + ", subTypeCode="
         + subTypeCode
+        + ", location='"
+        + location
+        + '\''
         + '}';
   }
 }

polaris-core/src/main/java/io/polaris/core/persistence/PolarisMetaStoreManager.java

@@ -1479,4 +1479,7 @@ PolarisMetaStoreManager.CachedEntryResult refreshCachedEntity(
       @NotNull PolarisEntityType entityType,
       long entityCatalogId,
       long entityId);
+
+  boolean locationOverlapsWithExistingTableLike(
+      @NotNull PolarisCallContext callCtx, @NotNull String location);
 }

polaris-core/src/main/java/io/polaris/core/persistence/PolarisMetaStoreManagerImpl.java

@@ -132,6 +132,10 @@ private void persistNewEntity(
       @NotNull PolarisMetaStoreSession ms,
       @NotNull PolarisBaseEntity entity) {
 
+    if (entity.getType().getCode() == PolarisEntityType.TABLE_LIKE.getCode()) { // TODO remove
+      System.out.println("DEBUG");
+    }
+
     // validate the entity type and subtype
     callCtx.getDiagServices().checkNotNull(entity, "unexpected_null_entity");
     callCtx
@@ -1163,6 +1167,8 @@ public Map<String, String> deserializeProperties(PolarisCallContext callCtx, Str
     // get metastore we should be using
     PolarisMetaStoreSession ms = callCtx.getMetaStore();
 
+    // TODO remove this comment
+
     // need to run inside a read/write transaction
     return ms.runInTransaction(
         callCtx,
@@ -2410,4 +2416,12 @@ public Map<String, String> getInternalPropertyMap(
                 entityCatalogId,
                 entityId));
   }
+
+  public boolean locationOverlapsWithExistingTableLike(
+      @NotNull PolarisCallContext callCtx, @NotNull String location) {
+    // get metastore we should be using
+    PolarisMetaStoreSession ms = callCtx.getMetaStore();
+
+    return ms.locationOverlapsWithExistingTableLike(callCtx, location);
+  }
 }

polaris-core/src/main/java/io/polaris/core/persistence/PolarisMetaStoreSession.java

@@ -521,4 +521,14 @@ boolean hasChildren(
 
   /** Rollback the current transaction */
   void rollback();
+
+  /**
+   * Check if the given location overlaps with any existing entity
+   *
+   * @param callContext the polaris call context
+   * @param location the location to check existing entities against
+   * @return true if any entity's location overlaps with the specified location
+   */
+  boolean locationOverlapsWithExistingTableLike(
+      @NotNull PolarisCallContext callContext, String location);
 }

polaris-core/src/main/java/io/polaris/core/persistence/PolarisTreeMapMetaStoreSessionImpl.java

@@ -298,7 +298,8 @@ public PolarisEntityActiveRecord lookupEntityActive(
             entity.getParentId(),
             entity.getName(),
             entity.getTypeCode(),
-            entity.getSubTypeCode());
+            entity.getSubTypeCode(),
+            entity.getLocation());
   }
 
   /** {@inheritDoc} */
@@ -345,7 +346,8 @@ public List<PolarisEntityActiveRecord> lookupEntityActiveBatch(
                 entity.getParentId(),
                 entity.getName(),
                 entity.getTypeCode(),
-                entity.getSubTypeCode()));
+                entity.getSubTypeCode(),
+                entity.getLocation()));
   }
 
   @Override
@@ -565,4 +567,19 @@ PolarisStorageIntegration<T> loadPolarisStorageIntegration(
   public void rollback() {
     this.store.rollback();
   }
+
+  @Override
+  public boolean locationOverlapsWithExistingTableLike(
+      @NotNull PolarisCallContext callContext, String location) {
+    return this.store
+        .getSliceEntitiesActive()
+        .valueExists(
+            polarisBaseEntity -> {
+              return location != null
+                  && polarisBaseEntity.getLocation() != null
+                  && polarisBaseEntity.getType() == PolarisEntityType.TABLE_LIKE
+                  && (polarisBaseEntity.getLocation().startsWith(location)
+                      || location.startsWith(polarisBaseEntity.getLocation()));
+            });
+  }
 }