[Feature Request] Add pyiceberg.catalog.hadoop.HadoopCatalog (filesystem-only catalog)
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 42/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Active
- Domain
- data-engineering, databases
Research direction
Start by reading the existing catalog implementations and MetastoreCatalog, then inspect PyArrowFileIO._initialize_fs and the downstream daft/catalog/__gravitino/__catalog.py usage named in the issue. Compare the requested behavior with Java Iceberg's HadoopCatalog and HadoopTables references. Done means filesystem-only namespace and table operations, Java-compatible metadata resolution, and a documented or public path for custom filesystem schemes.
Written by the indexing model from the issue text.
Description
Is your feature request related to a problem? Please describe.
Java Iceberg ships a filesystem-only HadoopCatalog / HadoopTables, where table metadata lives under <warehouse>/<db>.db/<table>/metadata/ with no external metastore. PyIceberg currently has no equivalent — the available catalog types are rest / hive / glue / dynamodb / sql / in-memory / bigquery.
This gap matters in two ways:
-
Interop with Java-side HadoopCatalog tables. Tables created by Java
HadoopCatalog(common in lightweight deployments without a metastore) cannot be opened through any supported PyIceberg catalog. Users must fall back toStaticTable.from_metadataand resolve the latestmetadata.jsonthemselves, which loses catalog semantics (no namespace listing, no create/commit). -
Downstream projects already assume the module exists. Daft's Gravitino integration imports
from pyiceberg.catalog.hadoop import HadoopCatalogand callsHadoopCatalog("gravitino_reader", props).load_table(table_dir)to open a table from a storage location (daft/catalog/__gravitino/_catalog.py). Against PyIceberg 0.11.x this raisesTypeError: HadoopCatalog.__init__() takes 2 positional arguments but 3 were given, and against versions without the module it fails at import time.
Describe the solution you'd like
A pyiceberg.catalog.hadoop.HadoopCatalog (subclassing MetastoreCatalog) implementing Java HadoopCatalog semantics:
warehouseproperty as the root location- table dir =
<warehouse>/<namespace>/<table> - metadata at
<table_dir>/metadata/v{n}.metadata.jsonplus aversion-hint.textholding the current version - latest-version resolution: read
version-hint.text, fall back to scanningmetadata/for the maxv{n}(matching Java behavior) - namespace/table create/list/commit driven purely by the warehouse filesystem (no metastore calls)
Additional context / pitfalls observed while prototyping
Happy to contribute a PR if this is in scope. A few notes from an internal prototype:
-
Metadata file naming. Java HadoopCatalog uses
v{n}.metadata.json+version-hint.text, but tables created by JDBC/REST catalogs use00000-<uuid>.metadata.jsonwith no version-hint. To open those as well, the scan fallback should accept both patterns (v(\d+)\.metadata\.jsonand\d{5}-.*\.metadata\.json), or at least document the limitation. -
Filesystem abstraction.
__init__should derive the filesystem from the catalog's FileIO (PyArrowFileIO) instead of hardcodingpyarrow.fs.HadoopFileSystem.from_uri(warehouse). The JVM-backedHadoopFileSystemonly supportshdfs://and fails for object-store schemes (s3://, and custom schemes), so routing through FileIO keeps it scheme-agnostic. -
Atomicity.
create_table/commit_tableuse create-if-absent onv{n}.metadata.jsonfor optimistic concurrency — safe on HDFS but not atomic on plain object stores (S3 has no create-if-absent guarantee). Java has the same caveat; worth documenting or using a conditional-write primitive where available.
Adapting a custom storage scheme (Tencent Cloud TBDSFS as a concrete case)
A related gap surfaced while prototyping against Tencent Cloud TBDS's distributed filesystem scheme tbdsfs://<cluster>/<path> (exposed by a Python client, plus a JVM fs.tbdsfs.impl):
-
PyArrowFileIO._initialize_fs(scheme, netloc)only understands a fixed set of schemes (hdfs / s3 / gs / file / abfs / ...), so anytbdsfs://...location raisesValueError: Unrecognized filesystem type in URI: tbdsfs. -
There is no public, documented way to plug in a custom filesystem. The only workaround today is monkey-patching a private method:
- Implement a
pyarrow.fs.FileSystemHandlersubclass wrapping the TBDSFS Python client, wrap it inpyarrow.fs.PyFileSystem, then patchPyArrowFileIO._initialize_fsto return that filesystem whenscheme == "tbdsfs". - pyarrow 21's
PyFileSystemcallback also has non-obvious contracts any custom handler must satisfy: single paths arrive as one-element lists;get_file_infomust return a one-element list; and for scheme'd URIs the netloc is prepended into the path (e.g.internal/usr/..., without a leading slash).
- Implement a
This works, but it depends on patching a private API (_initialize_fs), which is brittle across PyIceberg releases.
Suggested improvement: a documented, public extension point for registering an arbitrary pyarrow.fs.FileSystem (or a custom FileIO) per scheme — e.g. a register_file_system(scheme, factory) helper, or a scheme → FileSystem mapping read from FileIO/catalog properties — so non-standard object stores and filesystems can be integrated without touching internals. This would also naturally address the HadoopCatalog.__init__ filesystem-abstraction point above.
References
- Java:
org.apache.iceberg.hadoop.HadoopCatalog/HadoopTables - Downstream usage that currently breaks:
daft/catalog/__gravitino/_catalog.py→_open_iceberg_table
- Dominant language
- Python
- Stars
- 1.1k
- Forks
- 589
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 72
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from apache/iceberg-python
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
apache/iceberg-python#3996 ·
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
apache/iceberg-python#3979 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
apache/iceberg-python#3885 ·
-
[Bug] PyArrowFileIO fails to propagate s3.ssl.ca-cert to pyarrow.fs.S3FileSystem tls_ca_file_path Open
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
apache/iceberg-python#3866 · 1 comment ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
apache/iceberg-python#3836 · 1 comment ·
All issues in apache/iceberg-python
Similar issues
-
Add: hunch Open
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
AbdelStark/awesome-typesafe#104 ·
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
DiamondLightSource/dodal#2211 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
openml/openml-python#1749 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
sipyourdrink-ltd/bernstein#6191 ·