polars.read_ipc_stream

polars.read_ipc_stream(
    source: str | Path | IO[bytes] | bytes,
    *,
    columns: list[int] | list[str] | None = None,
    n_rows: int | None = None,
    use_pyarrow: bool = False,
    storage_options: StorageOptionsDict | None = None,
    row_index_name: str | None = None,
    row_index_offset: int = 0,
    rechunk: bool | None = None,
) → DataFrame

Читает данные из потока пакетов записей Arrow IPC в DataFrame.

См. раздел «Формат потоковой передачи» на странице https://arrow.apache.org/docs/python/ipc.html.

Изменено в версии 0.20.4: * Параметр row_count_name переименован в row_index_name. * Параметр row_count_offset переименован в row_index_offset.

Параметры:

source

Путь к файлу или файловому объекту (под «файловым объектом» понимаются объекты с методом read(), например файловый дескриптор, как у встроенной функции open, или экземпляр BytesIO). Если установлена fsspec, она может использоваться для открытия удалённых файлов. Для файловых объектов позиция в потоке после чтения может обновляться некорректно.

columns

Столбцы для выбора. Принимает список индексов столбцов (отсчёт начинается с нуля) или список имён столбцов.

n_rows

Прекратить чтение из потока IPC после чтения n_rows. Допустимо только при use_pyarrow=False.

use_pyarrow

Использовать pyarrow или встроенный считыватель на Rust.

storage_options

Дополнительные параметры для fsspec.open() или конкретного подключения к хранилищу, например хост, порт, имя пользователя, пароль и т. д.

row_index_name

Добавить в DataFrame столбец с индексами строк и заданным именем в качестве первого столбца. Если задано значение None (по умолчанию), столбец с индексами строк не создаётся.

row_index_offset

Начать нумерацию строк с этого смещения. Не может быть отрицательным. Используется, только если задано row_index_name.

rechunk

Убедиться, что все данные расположены непрерывно.

Устарело с версии 1.43.2: Вызовите rechunk для возвращённого DataFrame или возвращённых DataFrame.

Возвращает:

DataFrame