[iceberg] branch master updated: API: Clarify set and remove methods for namespace properties (#3198)

[bl...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

blue pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/iceberg.git


The following commit(s) were added to refs/heads/master by this push:
     new f96f06e  API: Clarify set and remove methods for namespace properties (#3198)
f96f06e is described below

commit f96f06ea07841c137a98a25e4edf62c508475801
Author: Ryan Blue <bl...@apache.org>
AuthorDate: Tue Sep 28 11:05:33 2021 -0700

    API: Clarify set and remove methods for namespace properties (#3198)
---
 .../main/java/org/apache/iceberg/catalog/SupportsNamespaces.java  | 8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)

diff --git a/api/src/main/java/org/apache/iceberg/catalog/SupportsNamespaces.java b/api/src/main/java/org/apache/iceberg/catalog/SupportsNamespaces.java
index 115e28f..901fc39 100644
--- a/api/src/main/java/org/apache/iceberg/catalog/SupportsNamespaces.java
+++ b/api/src/main/java/org/apache/iceberg/catalog/SupportsNamespaces.java
@@ -105,7 +105,9 @@ public interface SupportsNamespaces {
   boolean dropNamespace(Namespace namespace) throws NamespaceNotEmptyException;
 
   /**
-   * Apply a set of metadata to a namespace in the catalog.
+   * Set a collection of properties on a namespace in the catalog.
+   * <p>
+   * Properties that are not in the given map are not modified or removed by this method.
    *
    * @param namespace a namespace. {@link Namespace}
    * @param properties a collection of metadata to apply to the namespace
@@ -115,7 +117,9 @@ public interface SupportsNamespaces {
   boolean setProperties(Namespace namespace, Map<String, String> properties) throws NoSuchNamespaceException;
 
   /**
-   * Remove a set of metadata from a namespace in the catalog.
+   * Remove a set of property keys from a namespace in the catalog.
+   * <p>
+   * Properties that are not in the given set are not modified or removed by this method.
    *
    * @param namespace a namespace. {@link Namespace}
    * @param properties a collection of metadata to apply to the namespace