MCPcopy Create free account
hub / github.com/apache/arrow / read_metadata

Function read_metadata

python/pyarrow/parquet/core.py:2397–2452  ·  view source on GitHub ↗

Read FileMetaData from footer of a single Parquet file. Parameters ---------- where : str (file path) or file-like object memory_map : bool, default False Create memory map when the source is a file path. decryption_properties : FileDecryptionProperties, default Non

(where, memory_map=False, decryption_properties=None,
                  filesystem=None, arrow_extensions_enabled=True)

Source from the content-addressed store, hash-verified

2395
2396
2397def read_metadata(where, memory_map=False, decryption_properties=None,
2398 filesystem=None, arrow_extensions_enabled=True):
2399 """
2400 Read FileMetaData from footer of a single Parquet file.
2401
2402 Parameters
2403 ----------
2404 where : str (file path) or file-like object
2405 memory_map : bool, default False
2406 Create memory map when the source is a file path.
2407 decryption_properties : FileDecryptionProperties, default None
2408 Decryption properties for reading encrypted Parquet files.
2409 filesystem : FileSystem, default None
2410 If nothing passed, will be inferred based on path.
2411 Path will try to be found in the local on-disk filesystem otherwise
2412 it will be parsed as an URI to determine the filesystem.
2413 arrow_extensions_enabled : bool, default True
2414 If True, read Parquet logical types as Arrow extension types where
2415 possible (e.g. UUID as the canonical `arrow.uuid` extension type).
2416 If False, use the underlying storage types instead.
2417
2418 Returns
2419 -------
2420 metadata : FileMetaData
2421 The metadata of the Parquet file
2422
2423 Examples
2424 --------
2425 >>> import pyarrow as pa
2426 >>> import pyarrow.parquet as pq
2427 >>> table = pa.table({'n_legs': [4, 5, 100],
2428 ... 'animal': ["Dog", "Brittle stars", "Centipede"]})
2429 >>> pq.write_table(table, 'example.parquet')
2430
2431 >>> pq.read_metadata('example.parquet')
2432 <pyarrow._parquet.FileMetaData object at ...>
2433 created_by: parquet-cpp-arrow version ...
2434 num_columns: 2
2435 num_rows: 3
2436 num_row_groups: 1
2437 format_version: 2.6
2438 serialized_size: ...
2439 """
2440 filesystem, where = _resolve_filesystem_and_path(where, filesystem)
2441 file_ctx = nullcontext()
2442 if filesystem is not None:
2443 file_ctx = where = filesystem.open_input_file(where)
2444
2445 with file_ctx:
2446 file = ParquetFile(
2447 where,
2448 memory_map=memory_map,
2449 decryption_properties=decryption_properties,
2450 arrow_extensions_enabled=arrow_extensions_enabled,
2451 )
2452 return file.metadata
2453
2454

Callers 4

write_metadataFunction · 0.85
read_fieldMethod · 0.85
read_schemaMethod · 0.85

Calls 3

ParquetFileClass · 0.85
open_input_fileMethod · 0.45

Tested by

no test coverage detected