Skip to content

Commit 82061f7

Browse files
committed
docs(catalog): clarify Hadoop catalog supports local filesystem only
Update Catalog and NewCatalog docstrings to note that only local filesystem paths are currently supported.
1 parent 284ecf9 commit 82061f7

1 file changed

Lines changed: 4 additions & 3 deletions

File tree

catalog/hadoop/hadoop.go

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -94,16 +94,17 @@ func validateIdentifier(ident table.Identifier) error {
9494

9595
// Catalog is a filesystem-based Iceberg catalog that requires no external
9696
// metastore. All state lives on disk as directories and versioned JSON
97-
// metadata files.
97+
// metadata files. Currently only local filesystem paths are supported.
9898
type Catalog struct {
9999
name string
100100
warehouse string
101101
props iceberg.Properties
102102
}
103103

104104
// NewCatalog creates a new Hadoop catalog rooted at the given warehouse path.
105-
// The warehouse directory is not created on construction; it is created
106-
// implicitly by the first CreateNamespace call.
105+
// Currently only local filesystem paths are supported. The warehouse directory
106+
// is not created on construction; it is created implicitly by the first
107+
// CreateNamespace call.
107108
func NewCatalog(name, warehouse string, props iceberg.Properties) (*Catalog, error) {
108109
if warehouse == "" {
109110
return nil, errors.New("hadoop catalog requires a warehouse path")

0 commit comments

Comments
 (0)