nastra commented on code in PR #7196:
URL: https://github.com/apache/iceberg/pull/7196#discussion_r1192241720
##########
api/src/main/java/org/apache/iceberg/catalog/SupportsNamespaces.java:
##########
@@ -68,19 +68,21 @@ default void createNamespace(Namespace namespace) {
* exist and must be returned by this discovery method. For example, if
table a.b.t exists, this
* method must return ["a"] in the result array.
*
- * @return an List of namespace {@link Namespace} names
+ * @return a List of namespace {@link Namespace} names
*/
default List<Namespace> listNamespaces() {
return listNamespaces(Namespace.empty());
}
/**
- * List namespaces from the namespace.
+ * List the next level namespaces from the given namespace.
Review Comment:
I think `child` namespace might be a better term. To me it also seems that
it would be better to replace `SELECT` example with an actual `Namespace`
instance example. What about
```
/**
* List child namespaces from the namespace.
*
* <p>For two existing tables named 'a.b.c.table' and 'a.b.d.table', this
method returns:
*
* <ul>
* <li>Given: {@code Namespace.empty()}
* <li>Returns: {@code Namespace.of("a")}
* </ul>
*
* <ul>
* <li>Given: {@code Namespace.of("a")}
* <li>Returns: {@code Namespace.of("a", "b")}
* </ul>
*
* <ul>
* <li>Given: {@code Namespace.of("a", "b")}
* <li>Returns: {@code Namespace.of("a", "b", "c")} and {@code
Namespace.of("a", "b", "d")}
* </ul>
*
* <ul>
* <li>Given: {@code Namespace.of("a", "b", "c")}
* <li>Returns: nothing, because there are no child namespaces
* </ul>
*
* @return a List of child {@link Namespace} names from the given namespace
* @throws NoSuchNamespaceException If the namespace does not exist
(optional)
*/
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
