Skip to content

Commit

Permalink
docs: bigframes.options.bigquery.project and location are optiona…
Browse files Browse the repository at this point in the history
…l in some circumstances (#548)

Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
- [ ] Make sure to open an issue as a [bug/issue](https://togithub.com/googleapis/python-bigquery-dataframes/issues/new/choose) before writing your code!  That way we can discuss the change, evaluate designs, and agree on the general idea
- [ ] Ensure the tests and linter pass
- [ ] Code coverage does not decrease (if any source code was changed)
- [ ] Appropriate docs were updated (if necessary)

Follow-up to launch feedback and https://togithub.com/googleapis/python-bigquery-dataframes/pull/451
🦕
  • Loading branch information
tswast authored and Genesis929 committed Apr 9, 2024
1 parent d9d3100 commit 076cd39
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 1 deletion.
3 changes: 2 additions & 1 deletion samples/snippets/quickstart.py
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
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

0 comments on commit 076cd39

Please sign in to comment.