pyarrow.dataset.IpcFileFormat

class pyarrow.dataset.IpcFileFormat

Bases: FileFormat

__init__(*args, **kwargs)

Methods

__init__(*args, **kwargs)
equals(self, IpcFileFormat other)	Parameters:
inspect(self, file[, filesystem])	Infer the schema of a file.
make_fragment(self, file[, filesystem, ...])	Make a FileFragment from a given file.
make_write_options(self, **kwargs)	Parameters:

Attributes

default_extname
default_fragment_scan_options

default_extname

default_fragment_scan_options

equals(self, IpcFileFormat other)

Parameters:

otherpyarrow.dataset.IpcFileFormat

Returns:

True

inspect(self, file, filesystem=None)

Infer the schema of a file.

Parameters:

filefile-like object, path-like or str

The file or file path to infer a schema from.

filesystemFilesystem, optional

If filesystem is given, file must be a string and specifies the path of the file to read from the filesystem.

Returns:

schemaSchema

The schema inferred from the file

make_fragment(self, file, filesystem=None, Expression partition_expression=None, *, file_size=None)

Make a FileFragment from a given file.

Parameters:

filefile-like object, path-like or str

The file or file path to make a fragment from.

filesystemFilesystem, optional

If filesystem is given, file must be a string and specifies the path of the file to read from the filesystem.

partition_expressionExpression, optional

An expression that is guaranteed true for all rows in the fragment. Allows fragment to be potentially skipped while scanning with a filter.

file_sizeint, optional

The size of the file in bytes. Can improve performance with high-latency filesystems when file size needs to be known before reading.

Returns:

fragmentFragment

The file fragment

make_write_options(self, **kwargs)

Parameters:

**kwargsdict

Returns:

pyarrow.ipc.IpcWriteOptions