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.

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

Эта функция требует пакета 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'

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

'standard'

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

location:str, optional

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

Добавлена в версии 0.5.0 pandas-gbq.

configuration:dict, optional

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

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

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

credentials:google.auth.credentials.Credentials, optional

Учетные данные для доступа к Google API. Используйте этот параметр для переопределения стандартных учетных данных, например, для использования Compute Engine google.auth.compute_engine.Credentials или Service Account 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.

max_results:int, optional

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

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() для отображения полосы прогресса в виде графического диалогового окна.

Returns:

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"
...                  )