def __cache_local_peek(conn, cache_info, key, key_hint, peek_modes, query_id):
if peek_modes is None:
peek_modes = []
elif not isinstance(peek_modes, (list, tuple)):
peek_modes = [peek_modes]
query_struct = Query(
OP_CACHE_LOCAL_PEEK,
[
('cache_info', CacheInfo),
('key', key_hint or AnyDataObject),
('peek_modes', ByteArray),
],
query_id=query_id,
)
return query_perform(query_struct,
conn,
query_params={
'cache_info': cache_info,
'key': key,
'peek_modes': peek_modes,
},
response_config=[
('value', AnyDataObject),
],
post_process_fun=__post_process_value_by_key('value'))
def cache_clear(
connection: 'Connection',
cache: Union[str, int],
binary=False,
query_id=None,
) -> 'APIResult':
"""
Clears the cache without notifying listeners or cache writers.
:param connection: connection to Ignite server,
:param cache: name or ID of the cache,
:param binary: (optional) pass True to keep the value in binary form.
False by default,
:param query_id: (optional) a value generated by client and returned
as-is in response.query_id. When the parameter is omitted, a random
value is generated,
:return: API result data object. Contains zero status on success,
non-zero status and an error description otherwise.
"""
query_struct = Query(
OP_CACHE_CLEAR,
[
('hash_code', Int),
('flag', Byte),
],
query_id=query_id,
)
return query_struct.perform(
connection,
query_params={
'hash_code': cache_id(cache),
'flag': 1 if binary else 0,
},
)
def __scan(conn, cache_info, page_size, partitions, local, query_id):
query_struct = Query(
OP_QUERY_SCAN,
[
('cache_info', CacheInfo),
('filter', Null),
('page_size', Int),
('partitions', Int),
('local', Bool),
],
query_id=query_id,
)
return query_perform(query_struct,
conn,
query_params={
'cache_info': cache_info,
'filter': None,
'page_size': page_size,
'partitions': partitions,
'local': 1 if local else 0,
},
response_config=[
('cursor', Long),
('data', Map),
('more', Bool),
],
post_process_fun=__query_result_post_process)
def sql_fields_cursor_get_page(
connection: 'Connection',
cursor: int,
field_count: int,
query_id=None,
) -> APIResult:
"""
Retrieves the next query result page by cursor ID from `sql_fields`.
:param connection: connection to Ignite server,
:param cursor: cursor ID,
:param field_count: a number of fields in a row,
:param query_id: (optional) a value generated by client and returned as-is
in response.query_id. When the parameter is omitted, a random value
is generated,
:return: API result data object. Contains zero status and a value
of type dict with results on success, non-zero status and an error
description otherwise.
Value dict is of following format:
* `data`: list, result values,
* `more`: bool, True if more data is available for subsequent
‘sql_fields_cursor_get_page’ calls.
"""
query_struct = Query(
OP_QUERY_SQL_FIELDS_CURSOR_GET_PAGE,
[
('cursor', Long),
],
query_id=query_id,
)
_, send_buffer = query_struct.from_python({
'cursor': cursor,
})
connection.send(send_buffer)
response_struct = Response([
('data',
StructArray([('field_{}'.format(i), AnyDataObject)
for i in range(field_count)])),
('more', Bool),
])
response_class, recv_buffer = response_struct.parse(connection)
response = response_class.from_buffer_copy(recv_buffer)
result = APIResult(response)
if result.status != 0:
return result
value = response_struct.to_python(response)
result.value = {'data': [], 'more': value['more']}
for row_dict in value['data']:
row = []
for field_key in sorted(row_dict.keys()):
row.append(row_dict[field_key])
result.value['data'].append(row)
return result
def __cache_replace_if_equals(connection, cache_info, key, sample, value,
key_hint, sample_hint, value_hint, query_id):
query_struct = Query(
OP_CACHE_REPLACE_IF_EQUALS,
[
('cache_info', CacheInfo),
('key', key_hint or AnyDataObject),
('sample', sample_hint or AnyDataObject),
('value', value_hint or AnyDataObject),
],
query_id=query_id,
)
return query_perform(
query_struct,
connection,
query_params={
'cache_info': cache_info,
'key': key,
'sample': sample,
'value': value,
},
response_config=[
('success', Bool),
],
post_process_fun=__post_process_value_by_key('success'))
def __cache_destroy(connection, cache, query_id):
query_struct = Query(OP_CACHE_DESTROY, [('hash_code', Int)],
query_id=query_id)
return query_perform(query_struct,
connection,
query_params={'hash_code': cache_id(cache)})
def resource_close(connection: 'Connection',
cursor: int,
query_id=None) -> APIResult:
"""
Closes a resource, such as query cursor.
:param connection: connection to Ignite server,
:param cursor: cursor ID,
:param query_id: (optional) a value generated by client and returned as-is
in response.query_id. When the parameter is omitted, a random value
is generated,
:return: API result data object. Contains zero status on success,
non-zero status and an error description otherwise.
"""
query_struct = Query(
OP_RESOURCE_CLOSE,
[
('cursor', Long),
],
query_id=query_id,
)
return query_struct.perform(
connection,
query_params={
'cursor': cursor,
},
)
def cache_get_or_create(
connection: 'Connection',
name: str,
query_id=None,
) -> 'APIResult':
"""
Creates a cache with a given name. Does nothing if the cache exists.
:param connection: connection to Ignite server,
:param name: cache name,
:param query_id: (optional) a value generated by client and returned as-is
in response.query_id. When the parameter is omitted, a random value
is generated,
:return: API result data object. Contains zero status if a cache is
created successfully, non-zero status and an error description otherwise.
"""
query_struct = Query(
OP_CACHE_GET_OR_CREATE_WITH_NAME,
[
('cache_name', String),
],
query_id=query_id,
)
return query_struct.perform(
connection,
query_params={
'cache_name': name,
},
)
def cache_destroy(
connection: 'Connection',
cache: Union[str, int],
query_id=None,
) -> 'APIResult':
"""
Destroys cache with a given name.
:param connection: connection to Ignite server,
:param cache: name or ID of the cache,
:param query_id: (optional) a value generated by client and returned as-is
in response.query_id. When the parameter is omitted, a random value
is generated,
:return: API result data object.
"""
query_struct = Query(
OP_CACHE_DESTROY,
[
('hash_code', Int),
],
query_id=query_id,
)
return query_struct.perform(
connection,
query_params={
'hash_code': cache_id(cache),
},
)
def cache_remove_if_equals(
connection: 'Connection',
cache: Union[str, int],
key,
sample,
key_hint=None,
sample_hint=None,
binary=False,
query_id=None,
) -> 'APIResult':
"""
Removes an entry with a given key if provided value is equal to
actual value, notifying listeners and cache writers.
:param connection: connection to Ignite server,
:param cache: name or ID of the cache,
:param key: key for the cache entry,
:param sample: a sample to compare the stored value with,
:param key_hint: (optional) Ignite data type, for which the given key
should be converted,
:param sample_hint: (optional) Ignite data type, for whic
the given sample should be converted
:param binary: (optional) pass True to keep the value in binary form.
False by default,
:param query_id: (optional) a value generated by client and returned
as-is in response.query_id. When the parameter is omitted, a random
value is generated,
:return: API result data object. Contains zero status and a boolean
success code, or non-zero status and an error description if something
has gone wrong.
"""
query_struct = Query(
OP_CACHE_REMOVE_IF_EQUALS,
[
('hash_code', Int),
('flag', Byte),
('key', key_hint or AnyDataObject),
('sample', sample_hint or AnyDataObject),
],
query_id=query_id,
)
result = query_struct.perform(
connection,
query_params={
'hash_code': cache_id(cache),
'flag': 1 if binary else 0,
'key': key,
'sample': sample,
},
response_config=[
('success', Bool),
],
)
if result.status == 0:
result.value = result.value['success']
return result
def cache_get_and_replace(
connection: 'Connection',
cache: Union[str, int],
key,
value,
key_hint=None,
value_hint=None,
binary=False,
query_id=None,
) -> 'APIResult':
"""
Puts a value with a given key to cache, returning previous value
for that key, if and only if there is a value currently mapped
for that key.
:param connection: connection to Ignite server,
:param cache: name or ID of the cache,
:param key: key for the cache entry. Can be of any supported type,
:param value: value for the key,
:param key_hint: (optional) Ignite data type, for which the given key
should be converted,
:param value_hint: (optional) Ignite data type, for which the given value
should be converted.
:param binary: pass True to keep the value in binary form. False
by default,
:param query_id: a value generated by client and returned as-is
in response.query_id. When the parameter is omitted, a random value
is generated,
:return: API result data object. Contains zero status and an old value
or None on success, non-zero status and an error description otherwise.
"""
query_struct = Query(
OP_CACHE_GET_AND_REPLACE,
[
('hash_code', Int),
('flag', Byte),
('key', key_hint or AnyDataObject),
('value', value_hint or AnyDataObject),
],
query_id=query_id,
)
result = query_struct.perform(
connection,
query_params={
'hash_code': cache_id(cache),
'flag': 1 if binary else 0,
'key': key,
'value': value,
},
response_config=[
('value', AnyDataObject),
],
)
if result.status == 0:
result.value = result.value['value']
return result
def cache_put_if_absent(
connection: 'Connection',
cache: Union[str, int],
key,
value,
key_hint=None,
value_hint=None,
binary=False,
query_id=None,
) -> 'APIResult':
"""
Puts a value with a given key to cache only if the key
does not already exist.
:param connection: connection to Ignite server,
:param cache: name or ID of the cache,
:param key: key for the cache entry. Can be of any supported type,
:param value: value for the key,
:param key_hint: (optional) Ignite data type, for which the given key
should be converted,
:param value_hint: (optional) Ignite data type, for which the given value
should be converted.
:param binary: (optional) pass True to keep the value in binary form. False
by default,
:param query_id: (optional) a value generated by client and returned as-is
in response.query_id. When the parameter is omitted, a random value
is generated,
:return: API result data object. Contains zero status on success,
non-zero status and an error description otherwise.
"""
query_struct = Query(
OP_CACHE_PUT_IF_ABSENT,
[
('hash_code', Int),
('flag', Byte),
('key', key_hint or AnyDataObject),
('value', value_hint or AnyDataObject),
],
query_id=query_id,
)
result = query_struct.perform(
connection,
query_params={
'hash_code': cache_id(cache),
'flag': 1 if binary else 0,
'key': key,
'value': value,
},
response_config=[
('success', Bool),
],
)
if result.status == 0:
result.value = result.value['success']
return result
def __cluster_get_state(connection, query_id):
if not connection.protocol_context.is_cluster_api_supported():
raise NotSupportedByClusterError(
'Cluster API is not supported by the cluster')
query_struct = Query(OP_CLUSTER_GET_STATE, query_id=query_id)
return query_perform(query_struct,
connection,
response_config=[('state', Byte)],
post_process_fun=__post_process_get_state)
def __resource_close(conn, cursor, query_id):
query_struct = Query(
OP_RESOURCE_CLOSE,
[
('cursor', Long),
],
query_id=query_id,
)
return query_perform(query_struct, conn, query_params={
'cursor': cursor,
})
def cache_get_size(
connection: 'Connection',
cache: Union[str, int],
peek_modes=0,
binary=False,
query_id=None,
) -> 'APIResult':
"""
Gets the number of entries in cache.
:param connection: connection to Ignite server,
:param cache: name or ID of the cache,
:param peek_modes: (optional) limit count to near cache partition
(PeekModes.NEAR), primary cache (PeekModes.PRIMARY), or backup cache
(PeekModes.BACKUP). Defaults to all cache partitions (PeekModes.ALL),
:param binary: (optional) pass True to keep the value in binary form.
False by default,
:param query_id: (optional) a value generated by client and returned as-is
in response.query_id. When the parameter is omitted, a random value
is generated,
:return: API result data object. Contains zero status and a number of
cache entries on success, non-zero status and an error description
otherwise.
"""
if not isinstance(peek_modes, (list, tuple)):
if peek_modes == 0:
peek_modes = []
else:
peek_modes = [peek_modes]
query_struct = Query(
OP_CACHE_GET_SIZE,
[
('hash_code', Int),
('flag', Byte),
('peek_modes', PeekModes),
],
query_id=query_id,
)
result = query_struct.perform(
connection,
query_params={
'hash_code': cache_id(cache),
'flag': 1 if binary else 0,
'peek_modes': peek_modes,
},
response_config=[
('count', Long),
],
)
if result.status == 0:
result.value = result.value['count']
return result
def __cluster_set_state(connection, state, query_id):
if not connection.protocol_context.is_cluster_api_supported():
raise NotSupportedByClusterError(
'Cluster API is not supported by the cluster')
query_struct = Query(OP_CLUSTER_CHANGE_STATE, [('state', Byte)],
query_id=query_id)
return query_perform(query_struct,
connection,
query_params={
'state': state,
})
def __get_binary_type(conn, binary_type, query_id):
query_struct = Query(OP_GET_BINARY_TYPE, [
('type_id', Int),
],
query_id=query_id,
response_type=BinaryTypeResponse)
return query_perform(query_struct,
conn,
query_params={
'type_id': entity_id(binary_type),
})
def __sql_fields(conn, cache, query_str, page_size, query_args, schema,
statement_type, distributed_joins, local, replicated_only,
enforce_join_order, collocated, lazy, include_field_names,
max_rows, timeout, binary, query_id):
if query_args is None:
query_args = []
query_struct = Query(OP_QUERY_SQL_FIELDS, [
('hash_code', Int),
('flag', Byte),
('schema', String),
('page_size', Int),
('max_rows', Int),
('query_str', String),
('query_args', AnyDataArray()),
('statement_type', StatementType),
('distributed_joins', Bool),
('local', Bool),
('replicated_only', Bool),
('enforce_join_order', Bool),
('collocated', Bool),
('lazy', Bool),
('timeout', Long),
('include_field_names', Bool),
],
query_id=query_id,
response_type=SQLResponse)
return query_perform(
query_struct,
conn,
query_params={
'hash_code': cache_id(cache),
'flag': 1 if binary else 0,
'schema': schema,
'page_size': page_size,
'max_rows': max_rows,
'query_str': query_str,
'query_args': query_args,
'statement_type': statement_type,
'distributed_joins': distributed_joins,
'local': local,
'replicated_only': replicated_only,
'enforce_join_order': enforce_join_order,
'collocated': collocated,
'lazy': lazy,
'timeout': timeout,
'include_field_names': include_field_names,
},
include_field_names=include_field_names,
has_cursor=True,
)
def cache_get(
connection: 'Connection',
cache: Union[str, int],
key,
key_hint=None,
binary=False,
query_id=None,
) -> 'APIResult':
"""
Retrieves a value from cache by key.
:param connection: connection to Ignite server,
:param cache: name or ID of the cache,
:param key: key for the cache entry. Can be of any supported type,
:param key_hint: (optional) Ignite data type, for which the given key
should be converted,
:param binary: (optional) pass True to keep the value in binary form.
False by default,
:param query_id: (optional) a value generated by client and returned as-is
in response.query_id. When the parameter is omitted, a random value
is generated,
:return: API result data object. Contains zero status and a value
retrieved on success, non-zero status and an error description on failure.
"""
query_struct = Query(
OP_CACHE_GET,
[
('hash_code', Int),
('flag', Byte),
('key', key_hint or AnyDataObject),
],
query_id=query_id,
)
result = query_struct.perform(
connection,
query_params={
'hash_code': cache_id(cache),
'flag': 1 if binary else 0,
'key': key,
},
response_config=[
('value', AnyDataObject),
],
)
if result.status != 0:
return result
result.value = result.value['value']
return result
def __cache_clear(connection, cache_info, query_id):
query_struct = Query(
OP_CACHE_CLEAR,
[
('cache_info', CacheInfo),
],
query_id=query_id,
)
return query_perform(
query_struct,
connection,
query_params={
'cache_info': cache_info,
},
)
def __cache_remove_all(connection, cache_info, query_id):
query_struct = Query(
OP_CACHE_REMOVE_ALL,
[
('cache_info', CacheInfo),
],
query_id=query_id,
)
return query_perform(
query_struct,
connection,
query_params={
'cache_info': cache_info,
},
)
def __cache_clear_keys(connection, cache_info, keys, query_id):
query_struct = Query(
OP_CACHE_CLEAR_KEYS,
[
('cache_info', CacheInfo),
('keys', AnyDataArray()),
],
query_id=query_id,
)
return query_perform(
query_struct,
connection,
query_params={
'cache_info': cache_info,
'keys': keys,
},
)
def __cache_clear_key(connection, cache_info, key, key_hint, query_id):
query_struct = Query(
OP_CACHE_CLEAR_KEY,
[
('cache_info', CacheInfo),
('key', key_hint or AnyDataObject),
],
query_id=query_id,
)
return query_perform(
query_struct,
connection,
query_params={
'cache_info': cache_info,
'key': key,
},
)
def cache_get_all(
connection: 'Connection',
cache: Union[str, int],
keys: Iterable,
binary=False,
query_id=None,
) -> 'APIResult':
"""
Retrieves multiple key-value pairs from cache.
:param connection: connection to Ignite server,
:param cache: name or ID of the cache,
:param keys: list of keys or tuples of (key, key_hint),
:param binary: (optional) pass True to keep the value in binary form.
False by default,
:param query_id: (optional) a value generated by client and returned as-is
in response.query_id. When the parameter is omitted, a random value
is generated,
:return: API result data object. Contains zero status and a dict, made of
retrieved key-value pairs, non-zero status and an error description
on failure.
"""
query_struct = Query(
OP_CACHE_GET_ALL,
[
('hash_code', Int),
('flag', Byte),
('keys', AnyDataArray()),
],
query_id=query_id,
)
result = query_struct.perform(
connection,
query_params={
'hash_code': cache_id(cache),
'flag': 1 if binary else 0,
'keys': keys,
},
response_config=[
('data', Map),
],
)
if result.status == 0:
result.value = dict(result.value)['data']
return result
def __cache_put_all(connection, cache_info, pairs, query_id):
query_struct = Query(
OP_CACHE_PUT_ALL,
[
('cache_info', CacheInfo),
('data', Map),
],
query_id=query_id,
)
return query_perform(
query_struct,
connection,
query_params={
'cache_info': cache_info,
'data': pairs,
},
)
def cache_contains_keys(
connection: 'Connection',
cache: Union[str, int],
keys: Iterable,
binary=False,
query_id=None,
) -> 'APIResult':
"""
Returns a value indicating whether all given keys are present in cache.
:param connection: connection to Ignite server,
:param cache: name or ID of the cache,
:param keys: a list of keys or (key, type hint) tuples,
:param binary: pass True to keep the value in binary form. False
by default,
:param query_id: a value generated by client and returned as-is
in response.query_id. When the parameter is omitted, a random value
is generated,
:return: API result data object. Contains zero status and a bool value
retrieved on success: `True` when all keys are present, `False` otherwise,
non-zero status and an error description on failure.
"""
query_struct = Query(
OP_CACHE_CONTAINS_KEYS,
[
('hash_code', Int),
('flag', Byte),
('keys', AnyDataArray()),
],
query_id=query_id,
)
result = query_struct.perform(
connection,
query_params={
'hash_code': cache_id(cache),
'flag': 1 if binary else 0,
'keys': keys,
},
response_config=[
('value', Bool),
],
)
if result.status == 0:
result.value = result.value['value']
return result
def __cache_get_configuration(connection, cache_info, query_id):
query_struct = Query(
OP_CACHE_GET_CONFIGURATION,
[
('cache_info', CacheInfo)
],
query_id=query_id,
)
return query_perform(query_struct, connection,
query_params={
'cache_info': cache_info
},
response_config=[
('cache_config', get_cache_config_struct(connection.protocol_context))
],
post_process_fun=__post_process_cache_config
)
def scan_cursor_get_page(
connection: 'Connection',
cursor: int,
query_id=None,
) -> APIResult:
"""
Fetches the next scan query cursor page by cursor ID that is obtained
from `scan` function.
:param connection: connection to Ignite server,
:param cursor: cursor ID,
:param query_id: (optional) a value generated by client and returned as-is
in response.query_id. When the parameter is omitted, a random value
is generated,
:return: API result data object. Contains zero status and a value
of type dict with results on success, non-zero status and an error
description otherwise.
Value dict is of following format:
* `data`: dict, result rows as key-value pairs,
* `more`: bool, True if more data is available for subsequent
‘scan_cursor_get_page’ calls.
"""
query_struct = Query(
OP_QUERY_SCAN_CURSOR_GET_PAGE,
[
('cursor', Long),
],
query_id=query_id,
)
result = query_struct.perform(
connection,
query_params={
'cursor': cursor,
},
response_config=[
('data', Map),
('more', Bool),
],
)
if result.status == 0:
result.value = dict(result.value)
return result
def __scan_cursor_get_page(conn, cursor, query_id):
query_struct = Query(
OP_QUERY_SCAN_CURSOR_GET_PAGE,
[
('cursor', Long),
],
query_id=query_id,
)
return query_perform(query_struct,
conn,
query_params={
'cursor': cursor,
},
response_config=[
('data', Map),
('more', Bool),
],
post_process_fun=__query_result_post_process)
def __cache_put(connection, cache_info, key, value, key_hint, value_hint,
query_id):
query_struct = Query(
OP_CACHE_PUT,
[
('cache_info', CacheInfo),
('key', key_hint or AnyDataObject),
('value', value_hint or AnyDataObject),
],
query_id=query_id,
)
return query_perform(query_struct,
connection,
query_params={
'cache_info': cache_info,
'key': key,
'value': value
})
