pandas.read_gbq#

pandas.read_gbq(запрос, project_id=None, index_col=None, col_order=None, повторная аутентификация=False, auth_local_webserver=True, диалект=None, location=None, конфигурация=None, учётные данные=None, use_bqstorage_api=None, max_results=None, progress_bar_type=None)[источник]#

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

Устарело с версии 2.2.0: Пожалуйста, используйте pandas_gbq.read_gbq вместо этого.

Эта функция требует пакет pandas-gbq.

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

Параметры:

запросstr

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

project_idstr, optional

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

index_colstr, optional

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

col_orderlist(str), optional

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

повторная аутентификацияbool, по умолчанию False

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

auth_local_webserverbool, по умолчанию True

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

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

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

диалектstr, по умолчанию ‘legacy’

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

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

'legacy': Использовать устаревший SQL-диалект BigQuery. Для получения дополнительной информации см. Справочник по Legacy SQL BigQuery.
'standard': Используйте стандартный SQL BigQuery, который соответствует стандарту SQL 2011. Для получения дополнительной информации см. Справочник по BigQuery Standard SQL.

locationstr, optional

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

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

конфигурацияdict, optional

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

configuration = {'query': {'useQueryCache': False}}

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

учётные данныеgoogle.auth.credentials.Credentials, опционально

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

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

use_bqstorage_apibool, по умолчанию False

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

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

max_resultsint, необязательный

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

progress_bar_typeНеобязательно, str

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

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

None: Без индикатора выполнения.
'tqdm': Используйте tqdm.tqdm() функция для вывода прогресс-бара в sys.stderr.
'tqdm_notebook': Используйте tqdm.tqdm_notebook() функция для отображения прогресс-бара как виджета Jupyter notebook.
'tqdm_gui': Используйте tqdm.tqdm_gui() функция для отображения прогресс-бара в виде графического диалогового окна.

Возвращает:

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

Смотрите также

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

Примеры

Пример взят из Документация Google BigQuery

>>> sql = "SELECT name FROM table_name WHERE state = 'TX' LIMIT 100;"
>>> df = pd.read_gbq(sql, dialect="standard")  
>>> project_id = "your-project-id"  
>>> df = pd.read_gbq(sql,
...                  project_id=project_id,
...                  dialect="standard"
...                  )  