Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: bigframes.options.bigquery.project and location are optional in some circumstances #548

Merged
merged 3 commits into from
Apr 3, 2024
Merged

docs: bigframes.options.bigquery.project and location are optional in some circumstances #548

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bcc2777
docs: `bigframes.options.bigquery.project` and `location` are optiona…
tswast Mar 29, 2024
e3bd7bf
update quickstart too
tswast Mar 29, 2024
ddea5e1
Merge branch 'main' into tswast-project-and-locaton
tswast Apr 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion samples/snippets/quickstart.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,9 @@ def run_quickstart(project_id: str):
import bigframes.pandas as bpd

# Set BigQuery DataFrames options
# Note: The project option is not required in all environments.
# On BigQuery Studio, the project ID is automatically detected.
bpd.options.bigquery.project = your_gcp_project_id
bpd.options.bigquery.location = "us"

# Create a DataFrame from a BigQuery table
query_or_table = "bigquery-public-data.ml_datasets.penguins"
Expand Down
7 changes: 7 additions & 0 deletions samples/snippets/set_options_test.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,14 @@ def test_bigquery_dataframes_set_options():
REGION = "US" # @param {type:"string"}

# Set BigQuery DataFrames options
# Note: The project option is not required in all environments.
# On BigQuery Studio, the project ID is automatically detected.
bpd.options.bigquery.project = PROJECT_ID

# Note: The location option is not required.
# It defaults to the location of the first table or query
# passed to read_gbq(). For APIs where a location can't be
# auto-detected, the location defaults to the "US" location.
bpd.options.bigquery.location = REGION

# [END bigquery_dataframes_set_options]
Expand Down