pandas.read_gbq

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

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

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

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

Parameters

query:str

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

project_id:str, optional

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

index_col:str, optional

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

col_order:list(str), optional

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

reauth:bool, default False

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

auth_local_webserver:bool, default True

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

Новое в версии 0.2.0 pandas-gbq.

Изменено в версии 1.5.0: Значение по умолчанию изменено на True. Google устарел auth_local_webserver = False “внеполосный” (копировать-вставить) поток.

dialect:str, default ‘legacy’

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

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

'legacy'

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

'standard'

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

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.

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.

max_results:int, optional

Если задано, ограничьте максимальное количество строк, извлекаемых из результатов запроса.

Новое в версии 0.12.0 pandas-gbq.

Новое в версии 1.1.0.

progress_bar_type:Optional, str

Если задано, используйте библиотеку tqdm для отображения прогресс-бара во время загрузки данных. Установите пакет tqdm для использования этой функции.

Возможные значения progress_bar_type включают:

None

Без прогресс-бара.

'tqdm'

Используйте функцию tqdm.tqdm() для вывода прогресс-бара в sys.stderr.

'tqdm_notebook'

Используйте функцию tqdm.tqdm_notebook() для отображения прогресс-бара в качестве виджета Jupyter Notebook.

'tqdm_gui'

Используйте функцию tqdm.tqdm_gui() для отображения прогресс-бара в виде графического диалогового окна.

Обратите внимание, что эта функция требует версию 0.12.0 или более позднюю пакета pandas-gbq . А также пакет tqdm. Несколько отличается от pandas-gbq, здесь значение по умолчанию None.

Новое в версии 1.0.0.

Returns

df: DataFrame

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

См. также

pandas_gbq.read_gbq

Эта функция в библиотеке pandas-gbq.

DataFrame.to_gbq

Запись DataFrame в Google BigQuery.