-
Notifications
You must be signed in to change notification settings - Fork 1.7k
docs: add code sample snippets for welcome page documentation #17744
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.
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
Closed
Closed
Changes from 1 commit
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
88e57cd
docs: add code sample snippets for welcome page documentation
shuoweil ade6557
Skip bigframes sample snippet tests
shuoweil 3db2b49
Add b/522845525 to pytest skip reasons
shuoweil 1cede2e
Enable runnable sample snippet tests
shuoweil 92c38cd
Skip non-runnable snippet tests in samples_test.py
shuoweil 72f32c2
Merge branch 'main' into shuowei-add-bf-example
shuoweil 6558872
docs: remove sample snippets moved to python-docs-samples
shuoweil File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,138 @@ | ||
| # Copyright 2026 Google LLC | ||
| # | ||
| # Licensed under the Apache License, Version 2.0 (the "License"); | ||
| # you may not use this file except in compliance with the License. | ||
| # You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
|
|
||
|
|
||
| def test_query_standard_sql(): | ||
| # [START bigquery_bigframes_query] | ||
| import bigframes.pandas as bpd | ||
|
|
||
| # Set partial ordering mode as the default configuration for BigQuery DataFrames. | ||
| bpd.options.bigquery.ordering_mode = "partial" | ||
|
|
||
| sql = """ | ||
| SELECT name FROM `bigquery-public-data.usa_names.usa_1910_current` | ||
| WHERE state = 'TX' | ||
| LIMIT 100 | ||
| """ | ||
|
|
||
| # Run a query alongside existing SQL. The project will be determined from default credentials. | ||
| df = bpd.read_gbq(sql) | ||
|
|
||
| # Run a query after explicitly specifying a project. | ||
| bpd.options.bigquery.project = "your-project-id" | ||
| df = bpd.read_gbq(sql) | ||
| # [END bigquery_bigframes_query] | ||
| assert df is not None | ||
|
|
||
|
|
||
| def test_query_legacy_sql(): | ||
| # [START bigquery_bigframes_query_legacy] | ||
| import bigframes.pandas as bpd | ||
|
|
||
| # Set partial ordering mode as the default configuration for BigQuery DataFrames. | ||
| bpd.options.bigquery.ordering_mode = "partial" | ||
|
|
||
| sql = """ | ||
| SELECT name FROM [bigquery-public-data:usa_names.usa_1910_current] | ||
| WHERE state = 'TX' | ||
| LIMIT 100 | ||
| """ | ||
|
|
||
| # Run a query using legacy SQL syntax. | ||
| query_config = {"query": {"useLegacySql": True}} | ||
| df = bpd.read_gbq(sql, configuration=query_config) | ||
| # [END bigquery_bigframes_query_legacy] | ||
| assert df is not None | ||
|
|
||
|
|
||
| def test_query_bqstorage(): | ||
| # [START bigquery_bigframes_query_bqstorage] | ||
| import bigframes.pandas as bpd | ||
|
|
||
| # Set partial ordering mode as the default configuration for BigQuery DataFrames. | ||
| bpd.options.bigquery.ordering_mode = "partial" | ||
|
|
||
| sql = """ | ||
| SELECT name FROM `bigquery-public-data.usa_names.usa_1910_current` | ||
| WHERE state = 'TX' | ||
| LIMIT 100 | ||
| """ | ||
|
|
||
| # Read query results into a server-side DataFrame without downloading data. | ||
| df = bpd.read_gbq(sql) | ||
|
|
||
| # When downloading results to an in-memory pandas DataFrame, bigquery-dataframes | ||
| # automatically uses the BigQuery Storage API if installed. | ||
| pandas_df = df.to_pandas() | ||
| # [END bigquery_bigframes_query_bqstorage] | ||
| assert pandas_df is not None | ||
|
|
||
|
|
||
| def test_query_parameters(): | ||
| # [START bigquery_bigframes_query_parameters] | ||
| import bigframes.pandas as bpd | ||
|
|
||
| # Set partial ordering mode as the default configuration for BigQuery DataFrames. | ||
| bpd.options.bigquery.ordering_mode = "partial" | ||
|
|
||
| sql = """ | ||
| SELECT name FROM `bigquery-public-data.usa_names.usa_1910_current` | ||
| WHERE state = @state | ||
| LIMIT 100 | ||
| """ | ||
|
|
||
| query_config = { | ||
| "query": { | ||
| "parameterMode": "NAMED", | ||
| "queryParameters": [ | ||
| { | ||
| "name": "state", | ||
| "parameterType": {"type": "STRING"}, | ||
| "parameterValue": {"value": "TX"}, | ||
| } | ||
| ], | ||
| } | ||
| } | ||
|
|
||
| df = bpd.read_gbq(sql, configuration=query_config) | ||
| # [END bigquery_bigframes_query_parameters] | ||
| assert df is not None | ||
|
|
||
|
|
||
| def test_upload_from_dataframe(): | ||
| # [START bigquery_bigframes_upload_from_dataframe] | ||
| import pandas as pd | ||
|
|
||
| import bigframes.pandas as bpd | ||
|
|
||
| # Set partial ordering mode as the default configuration for BigQuery DataFrames. | ||
| bpd.options.bigquery.ordering_mode = "partial" | ||
|
|
||
| # Create a local pandas DataFrame. | ||
| df = pd.DataFrame( | ||
| { | ||
| "my_string": ["a", "b", "c"], | ||
| "my_int64": [1, 2, 3], | ||
| "my_float64": [4.0, 5.0, 6.0], | ||
| } | ||
| ) | ||
|
|
||
| # Convert the local pandas DataFrame to a BigQuery DataFrame. | ||
| bq_df = bpd.read_pandas(df) | ||
|
|
||
| # Write the DataFrame to a BigQuery table. | ||
| table_id = "your-project.your_dataset.your_table_name" | ||
| bq_df.to_gbq(table_id, if_exists="replace") | ||
| # [END bigquery_bigframes_upload_from_dataframe] | ||
| assert bq_df is not None | ||
|
shuoweil marked this conversation as resolved.
Outdated
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.