Spec-Zone.ru › pandas 0.25

pandas.read_gbq

pandas.read_gbq(query, project_id=None, index_col=None, col_order=None, reauth=False, auth_local_webserver=False, dialect=None, location=None, configuration=None, credentials=None, use_bqstorage_api=None, private_key=None, verbose=None) [source]

Загрузка данных из Google BigQuery.

Для этой функции требуется пакет pandas-gbq.

Инструкции по аутентификации см. в руководстве Как аутентифицироваться с Google BigQuery.

Параметры:
query : str

Запрос SQL-подобного вида для возврата значений данных.

project_id : str, optional

Идентификатор проекта учетной записи Google BigQuery. Необязательно, если доступен из среды.

index_col : str, optional

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

col_order : list(str), optional

Список имен столбцов BigQuery в желаемом порядке для результирующей DataFrame.

reauth : boolean, default False

Принудительно переаутентифицировать пользователя Google BigQuery. Это полезно, если используются несколько учетных записей.

auth_local_webserver : boolean, default False

Использовать локальный поток веб-сервера вместо потока консоли при получении учетных данных пользователя.

Введено в версии 0.2.0 pandas-gbq.

dialect : str, default ‘legacy’

Примечание: значение по умолчанию будет изменено на «standard» в будущей версии.

Диалект синтаксиса SQL для использования. Значение может быть одним из:

'legacy'

Использовать устаревший диалект SQL BigQuery. Для получения дополнительной информации см. Документация по устаревшему SQL BigQuery.

'standard'

Использовать стандартный SQL BigQuery, совместимый со стандартом SQL 2011. Для получения дополнительной информации см. Документация по стандартному SQL BigQuery.

Изменено в версии 0.24.0.

location : str, optional

Расположение, где должен выполняться запрос задания. Список доступных расположений см. в документации по расположениям BigQuery. Расположение должно соответствовать расположению всех наборов данных, используемых в запросе.

Введено в версии 0.5.0 pandas-gbq.

configuration : dict, optional

Параметры конфигурации запроса для обработки задания. Например:

configuration = {‘query’: {‘useQueryCache’: False}}

Для получения дополнительной информации см. Справочник BigQuery REST API.

credentials : google.auth.credentials.Credentials, optional

Учетные данные для доступа к Google API. Используйте этот параметр для переопределения учетных данных по умолчанию, например, для использования Compute Engine google.auth.compute_engine.Credentials или учетной записи службы google.oauth2.service_account.Credentials напрямую.

Введено в версии 0.8.0 pandas-gbq.

Введено в версии 0.24.0.

use_bqstorage_api : bool, default False

Использовать BigQuery Storage API для быстрого скачивания результатов запроса, но с повышенными затратами. Для использования этого API сначала включите его в консоли Cloud. Вы также должны иметь разрешение bigquery.readsessions.create для проекта, на счет которого оплачиваются запросы.

Эта функция требует версии 0.10.0 или выше пакета pandas-gbq. Она также требует пакетов google-cloud-bigquery-storage и fastavro.

Введено в версии 0.25.0.

private_key : str, deprecated

Устарело в версии pandas-gbq 0.8.0. Используйте параметр credentials и google.oauth2.service_account.Credentials.from_service_account_info() или google.oauth2.service_account.Credentials.from_service_account_file() вместо него.

Приватный ключ учетной записи службы в формате JSON. Может быть путем к файлу или содержимым строки. Это полезно для аутентификации удаленного сервера (например, Jupyter/IPython notebook на удаленном хосте).

verbose : None, deprecated

Устарело в версии pandas-gbq 0.4.0. Используйте модуль verbose : None, deprecated для изменения уровня подробности вместо него.

Возвращает:
df: DataFrame

DataFrame, представляющий результаты запроса.

См. также

pandas_gbq.read_gbq
Эта функция в библиотеке pandas-gbq.
DataFrame.to_gbq
Запись DataFrame в Google BigQuery.

© 2008–2012, AQR Capital Management, LLC, Lambda Foundry, Inc. and PyData Development Team
Licensed under the 3-clause BSD License.
https://pandas.pydata.org/pandas-docs/version/0.25.0/reference/api/pandas.read_gbq.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API