pyarrow.parquet.read_metadata#

pyarrow.parquet.read_metadata(where, memory_map=False, decryption_properties=None, filesystem=None, arrow_extensions_enabled=True)[source]#

Read FileMetaData from footer of a single Parquet file.

Parameters:

wherestr (file path) or file-like object

memory_mapbool, default False

Create memory map when the source is a file path.

decryption_propertiesFileDecryptionProperties, default None

Decryption properties for reading encrypted Parquet files.

filesystemFileSystem, default None

If nothing passed, will be inferred based on path. Path will try to be found in the local on-disk filesystem otherwise it will be parsed as an URI to determine the filesystem.

arrow_extensions_enabledbool, default True

If True, read Parquet logical types as Arrow extension types where possible (e.g. UUID as the canonical arrow.uuid extension type). If False, use the underlying storage types instead.

Returns:

metadataFileMetaData

The metadata of the Parquet file

Examples

>>> import pyarrow as pa
>>> import pyarrow.parquet as pq
>>> table = pa.table({'n_legs': [4, 5, 100],
...                   'animal': ["Dog", "Brittle stars", "Centipede"]})
>>> pq.write_table(table, 'example.parquet')

>>> pq.read_metadata('example.parquet')
<pyarrow._parquet.FileMetaData object at ...>
  created_by: parquet-cpp-arrow version ...
  num_columns: 2
  num_rows: 3
  num_row_groups: 1
  format_version: 2.6
  serialized_size: ...