From 42e2ebca630d6a4bcda9752178c5a3c2494d95e0 Mon Sep 17 00:00:00 2001 From: Google Colaboratory Team Date: Fri, 2 May 2025 08:06:21 -0700 Subject: [PATCH] No public description PiperOrigin-RevId: 754006811 --- google/colab/colab.modspec.json | 4 + google/colab/sql/LICENSE | 202 ++++++++++++++++++++++++++++++++ google/colab/sql/__init__.py | 18 +++ google/colab/sql/_bigquery.py | 152 ++++++++++++++++++++++++ 4 files changed, 376 insertions(+) create mode 100644 google/colab/sql/LICENSE create mode 100644 google/colab/sql/__init__.py create mode 100644 google/colab/sql/_bigquery.py diff --git a/google/colab/colab.modspec.json b/google/colab/colab.modspec.json index 056f8d65..7ba93b92 100644 --- a/google/colab/colab.modspec.json +++ b/google/colab/colab.modspec.json @@ -43,6 +43,10 @@ "name": "google.colab.snippets", "type": "MODULE" }, + { + "name": "google.colab.sql", + "type": "PACKAGE" + }, { "name": "google.colab.syntax", "type": "MODULE" diff --git a/google/colab/sql/LICENSE b/google/colab/sql/LICENSE new file mode 100644 index 00000000..8bed6440 --- /dev/null +++ b/google/colab/sql/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2017 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. diff --git a/google/colab/sql/__init__.py b/google/colab/sql/__init__.py new file mode 100644 index 00000000..478a2710 --- /dev/null +++ b/google/colab/sql/__init__.py @@ -0,0 +1,18 @@ +# Copyright 2025 Google Inc. +# +# 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. +"""Colab SQL library.""" + +from google.colab.sql import _bigquery + +__all__ = ["_bigquery"] diff --git a/google/colab/sql/_bigquery.py b/google/colab/sql/_bigquery.py new file mode 100644 index 00000000..f0201038 --- /dev/null +++ b/google/colab/sql/_bigquery.py @@ -0,0 +1,152 @@ +# Copyright 2025 Google Inc. +# +# 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. +"""Colab functions for SQL cells interacting with BigQuery.""" + +from typing import Iterable, Mapping, TypedDict + +from google.auth import credentials +from google.auth import exceptions as auth_exceptions +from google.cloud import bigquery + + +__all__ = ['validate_sql'] + +# BigQuery client to use for all requests from functions in this module. +# TODO: b/414366687 - Consider thread-safe approach. +_client: bigquery.Client | None = None + + +class TableReference(TypedDict): + """A reference to a BigQuery table.""" + + project_id: str + dataset_id: str + table_id: str + + +class TableSchemaEntry(TypedDict): + """An item in the schema of a BigQuery table.""" + + name: str + field_type: str + mode: str + description: str + + +class ValidationError(TypedDict): + """SQL validation error information.""" + + messages: list[str] + + +class ValidationSuccess(TypedDict): + """Successful SQL validation.""" + + bytes_processed: int + tables: list[TableReference] + schema: list[TableSchemaEntry] + + +class ValidationFailure(TypedDict): + """Failed SQL validation.""" + + authorization_failed: bool + error: ValidationError + + +ValidationResult = ValidationSuccess | ValidationFailure + + +def set_credentials( + creds: credentials.Credentials | None = None, + project_id: str | None = None, +): + """Sets the credentials and project ID to use for BigQuery requests. + + This resets the internal Client object used by the other functions in this + module. + + Args: + creds: The credentials to use for BigQuery requests. + project_id: The project ID to use for BigQuery requests. + """ + global _client + _client = bigquery.Client(project=project_id, credentials=creds) + + +def _get_client() -> bigquery.Client: + """Returns the client to use for BigQuery requests.""" + global _client + if not _client: + _client = bigquery.Client() + return _client + + +def validate_sql(sql: str) -> ValidationResult: + """Validates the SQL syntax and returns a ValidationResult object. + + This method is intended to be used by the Colab FE to utilize BigQuery's + dry-run validation engine. + + Args: + sql: The SQL to validate. + + Returns: + ValidationResult object. + """ + try: + validation_job = _get_client().query( + sql, job_config=bigquery.job.QueryJobConfig(dry_run=True) + ) + tables = [ + TableReference( + project_id=t.project, + dataset_id=t.dataset_id, + table_id=t.table_id, + ) + for t in validation_job.referenced_tables + ] + schema = [ + TableSchemaEntry( + name=f.name, + field_type=f.field_type, + mode=f.mode, + description=f.description, + ) + for f in validation_job.schema + ] + result = ValidationSuccess( + bytes_processed=validation_job.total_bytes_processed, + tables=tables, + schema=schema, + ) + except auth_exceptions.GoogleAuthError as e: + validation_error = ValidationError(messages=[str(e)]) + result = ValidationFailure( + error=validation_error, authorization_failed=True + ) + except Exception as e: # pylint: disable=broad-exception-caught + validation_error = ValidationError(messages=[str(e)]) + # Join all error messages if multiple errors are present. + if hasattr(e, 'errors') and isinstance(e.errors, Iterable): + error_messages = [] + for error in e.errors: + if isinstance(error, Mapping) and 'message' in error: + error_messages.append(error['message']) + validation_error['messages'] = error_messages + result = ValidationFailure( + error=validation_error, authorization_failed=False + ) + + return result