1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
|
#The MIT License (MIT)
#Copyright (c) 2014 Microsoft Corporation
#Permission is hereby granted, free of charge, to any person obtaining a copy
#of this software and associated documentation files (the "Software"), to deal
#in the Software without restriction, including without limitation the rights
#to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
#copies of the Software, and to permit persons to whom the Software is
#furnished to do so, subject to the following conditions:
#The above copyright notice and this permission notice shall be included in all
#copies or substantial portions of the Software.
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
#IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
#FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
#AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
#LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
#OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
#SOFTWARE.
"""Internal class for query execution context implementation in the Azure Cosmos database service.
"""
from collections import deque
import azure.cosmos.retry_utility as retry_utility
import azure.cosmos.http_constants as http_constants
import azure.cosmos.base as base
class _QueryExecutionContextBase(object):
"""
This is the abstract base execution context class.
"""
def __init__(self, client, options):
"""
Constructor
:param CosmosClient client:
:param dict options:
The request options for the request.
"""
self._client = client
self._options = options
self._is_change_feed = 'changeFeed' in options and options['changeFeed'] is True
self._continuation = None
if 'continuation' in options and self._is_change_feed:
self._continuation = options['continuation']
self._has_started = False
self._has_finished = False
self._buffer = deque()
def _has_more_pages(self):
return not self._has_started or self._continuation
def fetch_next_block(self):
"""Returns a block of results with respecting retry policy.
This method only exists for backward compatibility reasons. (Because QueryIterable
has exposed fetch_next_block api).
:return:
List of results.
:rtype: list
"""
if not self._has_more_pages():
return []
if len(self._buffer):
# if there is anything in the buffer returns that
res = list(self._buffer)
self._buffer.clear()
return res
else:
# fetches the next block
return self._fetch_next_block()
def _fetch_next_block(self):
raise NotImplementedError
def __iter__(self):
"""Returns itself as an iterator"""
return self
def next(self):
"""Returns the next query result.
:return:
The next query result.
:rtype: dict
:raises StopIteration: If no more result is left.
"""
if self._has_finished:
raise StopIteration
if not len(self._buffer):
results = self.fetch_next_block()
self._buffer.extend(results)
if not len(self._buffer):
raise StopIteration
return self._buffer.popleft()
def __next__(self):
# supports python 3 iterator
return self.next()
def _fetch_items_helper_no_retries(self, fetch_function):
"""Fetches more items and doesn't retry on failure
:return:
List of fetched items.
:rtype: list
"""
fetched_items = []
# Continues pages till finds a non empty page or all results are exhausted
while self._continuation or not self._has_started:
if not self._has_started:
self._has_started = True
self._options['continuation'] = self._continuation
(fetched_items, response_headers) = fetch_function(self._options)
fetched_items
continuation_key = http_constants.HttpHeaders.Continuation
# Use Etag as continuation token for change feed queries.
if self._is_change_feed:
continuation_key = http_constants.HttpHeaders.ETag
# In change feed queries, the continuation token is always populated. The hasNext() test is whether
# there is any items in the response or not.
if not self._is_change_feed or len(fetched_items) > 0:
self._continuation = response_headers.get(continuation_key)
else:
self._continuation = None
if fetched_items:
break
return fetched_items
def _fetch_items_helper_with_retries(self, fetch_function):
def callback():
return self._fetch_items_helper_no_retries(fetch_function)
return retry_utility._Execute(self._client, self._client._global_endpoint_manager, callback)
class _DefaultQueryExecutionContext(_QueryExecutionContextBase):
"""
This is the default execution context.
"""
def __init__(self, client, options, fetch_function):
"""
Constructor
:param CosmosClient client:
:param dict options:
The request options for the request.
:param method fetch_function:
Will be invoked for retrieving each page
Example of `fetch_function`:
>>> def result_fn(result):
>>> return result['Databases']
"""
super(_DefaultQueryExecutionContext, self).__init__(client, options)
self._fetch_function = fetch_function
def _fetch_next_block(self):
while super(_DefaultQueryExecutionContext, self)._has_more_pages() and len(self._buffer) == 0:
return self._fetch_items_helper_with_retries(self._fetch_function)
class _MultiCollectionQueryExecutionContext(_QueryExecutionContextBase):
"""
This class is used if it is client side partitioning
"""
def __init__(self, client, options, database_link, query, partition_key):
"""
Constructor
:param CosmosClient client:
:param dict options:
The request options for the request.
:param str database_link: database self link or ID based link
:param (str or dict) query:
Partition_key (str): partition key for the query
"""
super(_MultiCollectionQueryExecutionContext, self).__init__(client, options)
self._current_collection_index = 0
self._collection_links = []
self._collection_links_length = 0
self._query = query
self._client = client
partition_resolver = client.GetPartitionResolver(database_link)
if(partition_resolver is None):
raise ValueError(client.PartitionResolverErrorMessage)
else:
self._collection_links = partition_resolver.ResolveForRead(partition_key)
self._collection_links_length = len(self._collection_links)
if self._collection_links is None:
raise ValueError("_collection_links is None.")
if self._collection_links_length <= 0:
raise ValueError("_collection_links_length is not greater than 0.")
# Creating the QueryFeed for the first collection
path = base.GetPathFromLink(self._collection_links[self._current_collection_index], 'docs')
collection_id = base.GetResourceIdOrFullNameFromLink(self._collection_links[self._current_collection_index])
self._current_collection_index += 1
def fetch_fn(options):
return client.QueryFeed(path,
collection_id,
query,
options)
self._fetch_function = fetch_fn
def _has_more_pages(self):
return not self._has_started or self._continuation or (self._collection_links and self._current_collection_index < self._collection_links_length)
def _fetch_next_block(self):
"""Fetches the next block of query results.
This iterates fetches the next block of results from the current collection link.
Once the current collection results were exhausted. It moves to the next collection link.
:return:
List of fetched items.
:rtype: list
"""
# Fetch next block of results by executing the query against the current document collection
fetched_items = self._fetch_items_helper_with_retries(self._fetch_function)
# If there are multiple document collections to query for(in case of partitioning), keep looping through each one of them,
# creating separate feed queries for each collection and fetching the items
while not fetched_items:
if self._collection_links and self._current_collection_index < self._collection_links_length:
path = base.GetPathFromLink(self._collection_links[self._current_collection_index], 'docs')
collection_id = base.GetResourceIdOrFullNameFromLink(self._collection_links[self._current_collection_index])
self._continuation = None
self._has_started = False
def fetch_fn(options):
return self._client.QueryFeed(path,
collection_id,
self._query,
options)
self._fetch_function = fetch_fn
fetched_items = self._fetch_items_helper_with_retries(self._fetch_function)
self._current_collection_index += 1
else:
break
return fetched_items
|
