Skip to content

docs: add details for bigquery_connection in @bpd.udf docstring #1609

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

Merged
tswast merged 6 commits into from
Apr 11, 2025
Merged

docs: add details for bigquery_connection in @bpd.udf docstring #1609

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f72e182
chore: add details for bigquery_connection in udf docstring
jialuoo Apr 10, 2025
43fbc10
quick fix
jialuoo Apr 10, 2025
b1cf809
Merge branch 'main' into udf-doc
tswast Apr 11, 2025
942efb7
Update bigframes/functions/_function_session.py
jialuoo Apr 11, 2025
3869c79
resolve the comments
jialuoo Apr 11, 2025
d456bda
sync the docstring
jialuoo Apr 11, 2025
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
7 changes: 7 additions & 0 deletions bigframes/functions/_function_session.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -775,6 +775,13 @@ def udf(
Name of the BigQuery connection. It is used to provide an
identity to the serverless instances running the user code. It
helps BigQuery manage and track the resources used by the udf.
This connection is required for internet access and for
interacting with other GCP services. To access GCP services, the
appropriate IAM permissions must also be granted to the
connection's Service Account. When it defaults to None, the udf
will be created without any connection. A udf without a
connection has no internet access and no access to other GCP
services.
name (str, Optional):
Explicit name of the persisted BigQuery managed function. Use it
with caution, because more than one users working in the same
Expand Down
16 changes: 10 additions & 6 deletions bigframes/session/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1513,12 +1513,16 @@ def udf(
format. If this parameter is not provided then session dataset
id is used.
bigquery_connection (str, Optional):
Name of the BigQuery connection. You should either have the
connection already created in the `location` you have chosen, or
you should have the Project IAM Admin role to enable the service
to create the connection for you if you need it. If this
parameter is not provided then the BigQuery connection from the
session is used.
Name of the BigQuery connection. It is used to provide an
identity to the serverless instances running the user code. It
helps BigQuery manage and track the resources used by the udf.
This connection is required for internet access and for
interacting with other GCP services. To access GCP services, the
appropriate IAM permissions must also be granted to the
connection's Service Account. When it defaults to None, the udf
will be created without any connection. A udf without a
connection has no internet access and no access to other GCP
services.
name (str, Optional):
Explicit name of the persisted BigQuery managed function. Use it
with caution, because more than one users working in the same
Expand Down