polars.read_parquet_metadata

polars.read_parquet_metadata(
    source: str | Path | IO[bytes] | bytes,
    storage_options: StorageOptionsDict | None = None,
    credential_provider: CredentialProviderFunction | Literal['auto'] | None = 'auto',
    retries: int | None = None,
) → dict[str, str]

Получить пользовательские метаданные на уровне файла Parquet, не читая данные.

Предупреждение

Эта функциональность считается экспериментальной. Она может быть удалена или изменена в любой момент без того, чтобы это считалось несовместимым изменением.

Параметры:

source

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

storage_options

Параметры, указывающие, как подключиться к облачному провайдеру.

В настоящее время поддерживаются следующие облачные провайдеры: AWS, GCP и Azure. Список поддерживаемых ключей:

• aws
• gcp
• azure
• Hugging Face (hf://): принимает API-ключ в параметре token: {'token': '...'} или через переменную окружения HF_TOKEN.

Если storage_options не задан, Polars попытается получить необходимые сведения из переменных окружения.

credential_provider

Функция, которую можно вызвать для получения учетных данных облачного хранилища. Ожидается, что функция вернет словарь с ключами учетных данных и необязательным временем истечения срока действия учетных данных.

Предупреждение

Эта функциональность считается нестабильной. Она может быть изменена в любой момент без того, чтобы это считалось несовместимым изменением.

retries

Количество повторных попыток при сбое доступа к облачному экземпляру.

Устарело с версии 1.37.1: Вместо этого передайте {“max_retries”: n} через storage_options.

Возвращает:

dict

Словарь с метаданными. Пустой, если пользовательские метаданные отсутствуют.