Shortcuts on this page
r m x toggle line displays
j k next/prev highlighted chunk
0 (zero) top of page
1 (one) first highlighted chunk
1# Copyright 2018 Google LLC
2#
3# Licensed under the Apache License, Version 2.0 (the "License");
4# you may not use this file except in compliance with the License.
5# You may obtain a copy of the License at
6#
7# http://www.apache.org/licenses/LICENSE-2.0
8#
9# Unless required by applicable law or agreed to in writing, software
10# distributed under the License is distributed on an "AS IS" BASIS,
11# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12# See the License for the specific language governing permissions and
13# limitations under the License.
15from google.api_core import exceptions
16from google.api_core import retry
17import google.api_core.future.polling
18from google.auth import exceptions as auth_exceptions # type: ignore
19import requests.exceptions
22_RETRYABLE_REASONS = frozenset(
23 ["rateLimitExceeded", "backendError", "internalError", "badGateway"]
24)
26_UNSTRUCTURED_RETRYABLE_TYPES = (
27 ConnectionError,
28 exceptions.TooManyRequests,
29 exceptions.InternalServerError,
30 exceptions.BadGateway,
31 exceptions.ServiceUnavailable,
32 requests.exceptions.ChunkedEncodingError,
33 requests.exceptions.ConnectionError,
34 requests.exceptions.Timeout,
35 auth_exceptions.TransportError,
36)
38_DEFAULT_RETRY_DEADLINE = 10.0 * 60.0 # 10 minutes
40# Ambiguous errors (e.g. internalError, backendError, rateLimitExceeded) retry
41# until the full `_DEFAULT_RETRY_DEADLINE`. This is because the
42# `jobs.getQueryResults` REST API translates a job failure into an HTTP error.
43#
44# TODO(https://github.com/googleapis/python-bigquery/issues/1903): Investigate
45# if we can fail early for ambiguous errors in `QueryJob.result()`'s call to
46# the `jobs.getQueryResult` API.
47#
48# We need `_DEFAULT_JOB_DEADLINE` to be some multiple of
49# `_DEFAULT_RETRY_DEADLINE` to allow for a few retries after the retry
50# timeout is reached.
51#
52# Note: This multiple should actually be a multiple of
53# (2 * _DEFAULT_RETRY_DEADLINE). After an ambiguous exception, the first
54# call from `job_retry()` refreshes the job state without actually restarting
55# the query. The second `job_retry()` actually restarts the query. For a more
56# detailed explanation, see the comments where we set `restart_query_job = True`
57# in `QueryJob.result()`'s inner `is_job_done()` function.
58_DEFAULT_JOB_DEADLINE = 2.0 * (2.0 * _DEFAULT_RETRY_DEADLINE)
61def _should_retry(exc):
62 """Predicate for determining when to retry.
64 We retry if and only if the 'reason' is 'backendError'
65 or 'rateLimitExceeded'.
66 """
67 if not hasattr(exc, "errors") or len(exc.errors) == 0:
68 # Check for unstructured error returns, e.g. from GFE
69 return isinstance(exc, _UNSTRUCTURED_RETRYABLE_TYPES)
71 reason = exc.errors[0]["reason"]
72 return reason in _RETRYABLE_REASONS
75DEFAULT_RETRY = retry.Retry(predicate=_should_retry, deadline=_DEFAULT_RETRY_DEADLINE)
76"""The default retry object.
78Any method with a ``retry`` parameter will be retried automatically,
79with reasonable defaults. To disable retry, pass ``retry=None``.
80To modify the default retry behavior, call a ``with_XXX`` method
81on ``DEFAULT_RETRY``. For example, to change the deadline to 30 seconds,
82pass ``retry=bigquery.DEFAULT_RETRY.with_deadline(30)``.
83"""
86def _should_retry_get_job_conflict(exc):
87 """Predicate for determining when to retry a jobs.get call after a conflict error.
89 Sometimes we get a 404 after a Conflict. In this case, we
90 have pretty high confidence that by retrying the 404, we'll
91 (hopefully) eventually recover the job.
92 https://github.com/googleapis/python-bigquery/issues/2134
94 Note: we may be able to extend this to user-specified predicates
95 after https://github.com/googleapis/python-api-core/issues/796
96 to tweak existing Retry object predicates.
97 """
98 return isinstance(exc, exceptions.NotFound) or _should_retry(exc)
101# Pick a deadline smaller than our other deadlines since we want to timeout
102# before those expire.
103_DEFAULT_GET_JOB_CONFLICT_DEADLINE = _DEFAULT_RETRY_DEADLINE / 3.0
104_DEFAULT_GET_JOB_CONFLICT_RETRY = retry.Retry(
105 predicate=_should_retry_get_job_conflict,
106 deadline=_DEFAULT_GET_JOB_CONFLICT_DEADLINE,
107)
108"""Private, may be removed in future."""
111# Note: Take care when updating DEFAULT_TIMEOUT to anything but None. We
112# briefly had a default timeout, but even setting it at more than twice the
113# theoretical server-side default timeout of 2 minutes was not enough for
114# complex queries. See:
115# https://github.com/googleapis/python-bigquery/issues/970#issuecomment-921934647
116DEFAULT_TIMEOUT = None
117"""The default API timeout.
119This is the time to wait per request. To adjust the total wait time, set a
120deadline on the retry object.
121"""
123job_retry_reasons = (
124 "jobBackendError",
125 "jobInternalError",
126 "jobRateLimitExceeded",
127)
130def _job_should_retry(exc):
131 # Sometimes we have ambiguous errors, such as 'backendError' which could
132 # be due to an API problem or a job problem. For these, make sure we retry
133 # our is_job_done() function.
134 #
135 # Note: This won't restart the job unless we know for sure it's because of
136 # the job status and set restart_query_job = True in that loop. This means
137 # that we might end up calling this predicate twice for the same job
138 # but from different paths: (1) from jobs.getQueryResults RetryError and
139 # (2) from translating the job error from the body of a jobs.get response.
140 #
141 # Note: If we start retrying job types other than queries where we don't
142 # call the problematic getQueryResults API to check the status, we need
143 # to provide a different predicate, as there shouldn't be ambiguous
144 # errors in those cases.
145 if isinstance(exc, exceptions.RetryError):
146 exc = exc.cause
148 # Per https://github.com/googleapis/python-bigquery/issues/1929, sometimes
149 # retriable errors make their way here. Because of the separate
150 # `restart_query_job` logic to make sure we aren't restarting non-failed
151 # jobs, it should be safe to continue and not totally fail our attempt at
152 # waiting for the query to complete.
153 if _should_retry(exc):
154 return True
156 if not hasattr(exc, "errors") or len(exc.errors) == 0:
157 return False
159 reason = exc.errors[0]["reason"]
160 return reason in job_retry_reasons
163DEFAULT_JOB_RETRY = retry.Retry(
164 predicate=_job_should_retry, deadline=_DEFAULT_JOB_DEADLINE
165)
166"""
167The default job retry object.
168"""
171def _query_job_insert_should_retry(exc):
172 # Per https://github.com/googleapis/python-bigquery/issues/2134, sometimes
173 # we get a 404 error. In this case, if we get this far, assume that the job
174 # doesn't actually exist and try again. We can't add 404 to the default
175 # job_retry because that happens for errors like "this table does not
176 # exist", which probably won't resolve with a retry.
177 if isinstance(exc, exceptions.RetryError):
178 exc = exc.cause
180 if isinstance(exc, exceptions.NotFound):
181 message = exc.message
182 # Don't try to retry table/dataset not found, just job not found.
183 # The URL contains jobs, so use whitespace to disambiguate.
184 return message is not None and " job" in message.lower()
186 return _job_should_retry(exc)
189_DEFAULT_QUERY_JOB_INSERT_RETRY = retry.Retry(
190 predicate=_query_job_insert_should_retry,
191 # jobs.insert doesn't wait for the job to complete, so we don't need the
192 # long _DEFAULT_JOB_DEADLINE for this part.
193 deadline=_DEFAULT_RETRY_DEADLINE,
194)
195"""Private, may be removed in future."""
198DEFAULT_GET_JOB_TIMEOUT = 128
199"""
200Default timeout for Client.get_job().
201"""
203POLLING_DEFAULT_VALUE = google.api_core.future.polling.PollingFuture._DEFAULT_VALUE
204"""
205Default value defined in google.api_core.future.polling.PollingFuture.
206"""