From 78ca3ffb40ae0c8108d00a8a43e76aa3f626b696 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dea=20Mar=C3=ADa=20L=C3=A9on?= Date: Mon, 17 Jul 2023 16:20:54 +0200 Subject: [PATCH] Example read_gbq --- ci/code_checks.sh | 1 - pandas/io/gbq.py | 13 +++++++++++++ 2 files changed, 13 insertions(+), 1 deletion(-) diff --git a/ci/code_checks.sh b/ci/code_checks.sh index 989ef6958d2e6..4cbbec0c625e2 100755 --- a/ci/code_checks.sh +++ b/ci/code_checks.sh @@ -96,7 +96,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then pandas.read_sas \ pandas.read_spss \ pandas.read_sql_query \ - pandas.read_gbq \ pandas.io.stata.StataReader.data_label \ pandas.io.stata.StataReader.value_labels \ pandas.io.stata.StataReader.variable_labels \ diff --git a/pandas/io/gbq.py b/pandas/io/gbq.py index 597369bb12703..6a0105abda71d 100644 --- a/pandas/io/gbq.py +++ b/pandas/io/gbq.py @@ -162,6 +162,19 @@ def read_gbq( -------- pandas_gbq.read_gbq : This function in the pandas-gbq library. DataFrame.to_gbq : Write a DataFrame to Google BigQuery. + + Examples + -------- + Example taken from `Google BigQuery documentation + `_ + + >>> sql = "SELECT name FROM table_name WHERE state = 'TX' LIMIT 100;" + >>> df = pd.read_gbq(sql, dialect="standard") # doctest: +SKIP + >>> project_id = "your-project-id" # doctest: +SKIP + >>> df = pd.read_gbq(sql, + ... project_id=project_id, + ... dialect="standard" + ... ) # doctest: +SKIP """ pandas_gbq = _try_import()