-
Notifications
You must be signed in to change notification settings - Fork 453
feat(BigQuery): Add support for Stateless Queries #8943
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
Draft
Hectorhammett
wants to merge
5
commits into
main
Choose a base branch
from
statelessquery-prototype
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
210a289
Stateless query prototype:
Hectorhammett e844b37
Continue prototype for Stateless query
Hectorhammett 71174bd
Functioning version of Stateless query
Hectorhammett 5ef86ea
Change location of constant for job creation mode
Hectorhammett 8fcd59e
Fix snippet tests
Hectorhammett 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
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
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
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
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,111 @@ | ||
| <?php | ||
| /** | ||
| * Copyright 2026 Google Inc. All Rights Reserved. | ||
| * | ||
| * 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. | ||
| */ | ||
|
|
||
| namespace Google\Cloud\BigQuery; | ||
|
|
||
| use Ramsey\Uuid\Uuid; | ||
|
|
||
| /** | ||
| * Represents a configuration for a stateless query. | ||
| * | ||
| * This class is used internally by {@see BigQueryClient::runQuery()} to | ||
| * determine if a query can be executed using the stateless `jobs.query` | ||
| * endpoint and to build the corresponding request. | ||
| * | ||
| * @internal | ||
| */ | ||
| class StatelessJobConfiguration implements JobConfigurationInterface | ||
| { | ||
| use JobConfigurationTrait; | ||
| const JOB_CREATION_MODE_OPTIONAL = 'JOB_CREATION_OPTIONAL'; | ||
|
|
||
| /** | ||
| * Returns an array that represents a QueryRequest for a stateless query. | ||
| * Returns null if one of the conditions are not met for a stateless query. | ||
| * | ||
| * @return array<mixed>|null | ||
| */ | ||
| public static function getQueryRequest(JobConfigurationInterface $jobConfiguration): array|null | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The fact that this returns an array when the object itself implements a if ($query->isStateless()) {
$stateless = StatelessJobConfiguration::fromQueryConfiguration($query);
$request = $stateless->toArray();
} |
||
| { | ||
| $config = $jobConfiguration->toArray(); | ||
| $queryConfig = $config['configuration']['query']; | ||
|
|
||
| if ( | ||
| isset($queryConfig['destinationTable']) || | ||
| isset($queryConfig['tableDefinitions']) || | ||
| isset($queryConfig['createDisposition']) || | ||
| isset($queryConfig['writeDisposition']) || | ||
| ( | ||
| isset($queryConfig['priority']) && | ||
| $queryConfig['priority'] !== 'INTERACTIVE' | ||
| ) || | ||
| (isset($queryConfig['useLegacySql']) && $queryConfig['useLegacySql']) || | ||
| isset($queryConfig['maximumBillingTier']) || | ||
| isset($queryConfig['timePartitioning']) || | ||
| isset($queryConfig['rangePartitioning']) || | ||
| isset($queryConfig['clustering']) || | ||
| isset($queryConfig['destinationEncryptionConfiguration']) || | ||
| isset($queryConfig['schemaUpdateOptions']) || | ||
| isset($queryConfig['jobTimeoutMs']) || | ||
| isset($queryConfig['jobId']) | ||
| ) { | ||
| return null; | ||
| } | ||
|
|
||
| if (isset($config['configuration']['dryRun']) && $config['configuration']['dryRun']) { | ||
| return null; | ||
| } | ||
|
|
||
| // Creating a jobConfiguration from the library sets the JobId always meaning we do not have a way | ||
| // to determine if this jobId was set by the user or our library. | ||
| // We check if this was autogenerated to circumvent this issue. | ||
| if ( | ||
| isset($config['jobReference']['jobId']) && | ||
| method_exists($jobConfiguration, 'isJobIdGenerated') && | ||
| !$jobConfiguration->isJobIdGenerated() | ||
| ) { | ||
| return null; | ||
| } | ||
|
|
||
| return [ | ||
| 'query' => $queryConfig['query'], | ||
| 'maxResults' => $queryConfig['maxResults'] ?? null, | ||
| 'defaultDataset' => $queryConfig['defaultDataset'] ?? null, | ||
| 'timeoutMs' => $queryConfig['timeoutMs'] ?? null, | ||
| 'useQueryCache' => $queryConfig['useQueryCache'] ?? null, | ||
| 'useLegacySql' => false, | ||
| 'queryParameters' => $queryConfig['queryParameters'] ?? null, | ||
| 'parameterMode' => $queryConfig['parameterMode'] ?? null, | ||
| 'labels' => $config['configuration']['labels'] ?? null, | ||
| 'createSession' => $queryConfig['createSession'] ?? null, | ||
| 'maximumBytesBilled' => $queryConfig['maximumBytesBilled'] ?? null, | ||
| 'location' => $config['jobReference']['location'] ?? null, | ||
| 'requestId' => $config['jobReference']['jobId'], | ||
| 'jobCreationMode' => self::JOB_CREATION_MODE_OPTIONAL | ||
| ]; | ||
| } | ||
|
|
||
| /** | ||
| * Generate a Job ID. | ||
| * | ||
| * @return string | ||
| */ | ||
| protected static function generateJobId() | ||
| { | ||
| return Uuid::uuid4()->toString(); | ||
| } | ||
| } | ||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this was accidental