Map¶

class Map(client, service_name, name)¶

Bases: hazelcast.proxy.base.Proxy

Hazelcast Map client proxy to access the map on the cluster.

Concurrent, distributed, observable and queryable map.

This map can work both async(non-blocking) or sync(blocking). Blocking calls return the value of the call and block the execution until return value is calculated. However, async calls return Future and do not block execution. Result of the Future can be used whenever ready. A Future‘s result can be obtained with blocking the execution by calling Future.result().

Example of sync(blocking) usage:

>>> #client is initialized Hazelcast Client.
>>> my_map = client.get_map("map").blocking()# returns sync map, all map functions are blocking
>>> print("map.put", my_map.put("key", "value"))
>>> print("map.contains_key", my_map.contains_key("key"))
>>> print("map.get", my_map.get("key"))
>>> print("map.size", my_map.size())

Example of async(non-blocking) usage:

>>> #client is initialized Hazelcast Client.
>>> my_map = client.get_map("map")
>>> def put_callback(f):
>>>     print("map.put", f.result())
>>> my_map.put("key", "async_val").add_done_callback(put_callback)
>>>
>>> print("map.size", my_map.size().result())
>>>
>>> def contains_key_callback(f):
>>>     print("map.contains_key", f.result())
>>> my_map.contains_key("key").add_done_callback(contains_key_callback)

This class does not allow None to be used as a key or value.

add_entry_listener(include_value=False, key=None, predicate=None, added_func=None, removed_func=None, updated_func=None, evicted_func=None, evict_all_func=None, clear_all_func=None, merged_func=None, expired_func=None)¶

Adds a continuous entry listener for this map. Listener will get notified for map events filtered with given parameters.

Parameters:

include_value – (bool), whether received events include an old value or not (optional).
key – (object), key for filtering the events (optional).
predicate – (Predicate), predicate for filtering the events (optional).
added_func – Function to be called when an entry is added to map (optional).
removed_func – Function to be called when an entry is removed from map (optional).
updated_func – Function to be called when an entry is updated (optional).
evicted_func – Function to be called when an entry is evicted from map (optional).
evict_all_func – Function to be called when entries are evicted from map (optional).
clear_all_func – Function to be called when entries are cleared from map (optional).
merged_func – Function to be called when WAN replicated entry is merged_func (optional).
expired_func – Function to be called when an entry’s live time is expired (optional).

Returns:

(str), a registration id which is used as a key to remove the listener.

See also

Predicate for more info about predicates.

add_index(attribute, ordered=False)¶

Adds an index to this map for the specified entries so that queries can run faster.

Example:

Let’s say your map values are Employee objects.

>>> class Employee(IdentifiedDataSerializable):
>>>     active = false
>>>     age = None
>>>     name = None
>>>     #other fields
>>>
>>>     #methods

If you query your values mostly based on age and active fields, you should consider indexing these.

>>> map = self.client.get_map("employees")
>>> map.add_index("age" , true) #ordered, since we have ranged queries for this field
>>> map.add_index("active", false) #not ordered, because boolean field cannot have range

Parameters:	attribute – (str), index attribute of the value. ordered – (bool), for ordering the index or not (optional).

add_interceptor(interceptor)¶

Adds an interceptor for this map. Added interceptor will intercept operations and execute user defined methods.

Parameters:	interceptor – (object), interceptor for the map which includes user defined methods.
Returns:	(str),id of registered interceptor.

clear()¶

Clears the map.

The MAP_CLEARED event is fired for any registered listeners.

contains_key(key)¶

Determines whether this map contains an entry with the key.

Warning: This method uses __hash__ and __eq__ methods of binary form of the key, not the actual implementations of __hash__ and __eq__ defined in key’s class.

Parameters:	key – (object), the specified key.
Returns:	(bool), `true` if this map contains an entry for the specified key.

contains_value(value)¶

Determines whether this map contains one or more keys for the specified value.

Parameters:	value – (object), the specified value.
Returns:	(bool), `true` if this map contains an entry for the specified value.

delete(key)¶

Removes the mapping for a key from this map if it is present (optional operation).

Unlike remove(object), this operation does not return the removed value, which avoids the serialization cost of the returned value. If the removed value will not be used, a delete operation is preferred over a remove operation for better performance.

The map will not contain a mapping for the specified key once the call returns.

Warning: This method breaks the contract of EntryListener. When an entry is removed by delete(), it fires an EntryEvent with a None oldValue. Also, a listener with predicates will have None values, so only the keys can be queried via predicates.

Parameters:	key – (object), key of the mapping to be deleted.

entry_set(predicate=None)¶

Returns a list clone of the mappings contained in this map.

Warning: The list is NOT backed by the map, so changes to the map are NOT reflected in the list, and vice-versa.

Parameters:	predicate – (Predicate), predicate for the map to filter entries (optional).
Returns:	(Sequence), the list of key-value tuples in the map.

See also

Predicate for more info about predicates.

evict(key)¶

Evicts the specified key from this map.

Warning: This method uses __hash__ and __eq__ methods of binary form of the key, not the actual implementations of __hash__ and __eq__ defined in key’s class.

Parameters:	key – (object), key to evict.
Returns:	(bool), `true` if the key is evicted, `false` otherwise.

evict_all()¶

Evicts all keys from this map except the locked ones.

The EVICT_ALL event is fired for any registered listeners.

execute_on_entries(entry_processor, predicate=None)¶

Applies the user defined EntryProcessor to all the entries in the map or entries in the map which satisfies the predicate if provided. Returns the results mapped by each key in the map.

Parameters:	entry_processor – (object), A stateful serializable object which represents the EntryProcessor defined on server side. This object must have a serializable EntryProcessor counter part registered on server side with the actual `org.hazelcast.map.EntryProcessor` implementation. predicate – (Predicate), predicate for filtering the entries (optional).
Returns:	(Sequence), list of map entries which includes the keys and the results of the entry process.

See also

Predicate for more info about predicates.

execute_on_key(key, entry_processor)¶

Applies the user defined EntryProcessor to the entry mapped by the key. Returns the object which is the result of EntryProcessor’s process method.

Parameters:	key – (object), specified key for the entry to be processed. entry_processor – (object), A stateful serializable object which represents the EntryProcessor defined on server side. This object must have a serializable EntryProcessor counter part registered on server side with the actual `org.hazelcast.map.EntryProcessor` implementation.
Returns:	(object), result of entry process.

execute_on_keys(keys, entry_processor)¶

Applies the user defined EntryProcessor to the entries mapped by the collection of keys. Returns the results mapped by each key in the collection.

Parameters:	keys – (Collection), collection of the keys for the entries to be processed. entry_processor – (object), A stateful serializable object which represents the EntryProcessor defined on server side. This object must have a serializable EntryProcessor counter part registered on server side with the actual `org.hazelcast.map.EntryProcessor` implementation.
Returns:	(Sequence), list of map entries which includes the keys and the results of the entry process.

flush()¶: Flushes all the local dirty entries.

force_unlock(key)¶

Releases the lock for the specified key regardless of the lock owner. It always successfully unlocks the key, never blocks, and returns immediately.

Warning: This method uses __hash__ and __eq__ methods of binary form of the key, not the actual implementations of __hash__ and __eq__ defined in key’s class.

Parameters:	key – (object), the key to lock.

get(key)¶

Returns the value for the specified key, or None if this map does not contain this key.

Warning: This method returns a clone of original value, modifying the returned value does not change the actual value in the map. One should put modified value back to make changes visible to all nodes.

>>> value = map.get(key)
>>> value.update_some_property()
>>> map.put(key,value)

Warning 2: This method uses __hash__ and __eq__ methods of binary form of the key, not the actual implementations of __hash__ and __eq__ defined in key’s class.

Parameters:	key – (object), the specified key.
Returns:	(object), the value for the specified key.

get_all(keys)¶

Returns the entries for the given keys.

Warning: The returned map is NOT backed by the original map, so changes to the original map are NOT reflected in the returned map, and vice-versa.

Warning 2: This method uses __hash__ and __eq__ methods of binary form of the key, not the actual implementations of __hash__ and __eq__ defined in key’s class.

Parameters:	keys – (Collection), keys to get.
Returns:	(dict), dictionary of map entries.

get_entry_view(key)¶

Returns the EntryView for the specified key.

Warning: This method returns a clone of original mapping, modifying the returned value does not change the actual value in the map. One should put modified value back to make changes visible to all nodes.

Warning 2: This method uses __hash__ and __eq__ methods of binary form of the key, not the actual implementations of __hash__ and __eq__ defined in key’s class.

Parameters:	key – (object), the key of the entry.
Returns:	(EntryView), EntryView of the specified key.

See also

EntryView for more info about EntryView.

is_empty()¶

Returns true if this map contains no key-value mappings.

Returns:	(bool), `true` if this map contains no key-value mappings.

is_locked(key)¶

Checks the lock for the specified key. If the lock is acquired, it returns true. Otherwise, it returns false.

Warning: This method uses __hash__ and __eq__ methods of binary form of the key, not the actual implementations of __hash__ and __eq__ defined in key’s class.

Parameters:	key – (object), the key that is checked for lock
Returns:	(bool), `true` if lock is acquired, `false` otherwise.

key_set(predicate=None)¶

Returns a List clone of the keys contained in this map or the keys of the entries filtered with the predicate if provided.

Warning: The list is NOT backed by the map, so changes to the map are NOT reflected in the list, and vice-versa.

Parameters:	predicate – (Predicate), predicate to filter the entries (optional).
Returns:	(Sequence), a list of the clone of the keys.

See also

Predicate for more info about predicates.

load_all(keys=None, replace_existing_values=True)¶

Loads all keys from the store at server side or loads the given keys if provided.

Parameters:	keys – (Collection), keys of the entry values to load (optional). replace_existing_values – (bool), whether the existing values will be replaced or not with those loaded

from the server side MapLoader (optional).

lock(key, ttl=-1)¶

Acquires the lock for the specified key infinitely or for the specified lease time if provided.

If the lock is not available, the current thread becomes disabled for thread scheduling purposes and lies dormant until the lock has been acquired.

You get a lock whether the value is present in the map or not. Other threads (possibly on other systems) would block on their invoke of lock() until the non-existent key is unlocked. If the lock holder introduces the key to the map, the put() operation is not blocked. If a thread not holding a lock on the non-existent key tries to introduce the key while a lock exists on the non-existent key, the put() operation blocks until it is unlocked.

Scope of the lock is this map only. Acquired lock is only for the key in this map.

Locks are re-entrant; so, if the key is locked N times, it should be unlocked N times before another thread can acquire it.

Warning: This method uses __hash__ and __eq__ methods of binary form of the key, not the actual implementations of __hash__ and __eq__ defined in key’s class.

Parameters:	key – (object), the key to lock. ttl – (int), time in seconds to wait before releasing the lock (optional).

put(key, value, ttl=-1)¶

Associates the specified value with the specified key in this map. If the map previously contained a mapping for the key, the old value is replaced by the specified value. If ttl is provided, entry will expire and get evicted after the ttl.

Warning: This method returns a clone of the previous value, not the original (identically equal) value previously put into the map.

Warning: This method uses __hash__ and __eq__ methods of binary form of the key, not the actual implementations of __hash__ and __eq__ defined in key’s class.

Parameters:	key – (object), the specified key. value – (object), the value to associate with the key. ttl – (int), maximum time in seconds for this entry to stay, if not provided, the value configured on server side configuration will be used(optional).
Returns:	(object), previous value associated with key or `None` if there was no mapping for key.

put_all(map)¶

Copies all of the mappings from the specified map to this map. No atomicity guarantees are given. In the case of a failure, some of the key-value tuples may get written, while others are not.

Parameters:	map – (dict), map which includes mappings to be stored in this map.

put_if_absent(key, value, ttl=-1)¶

Associates the specified key with the given value if it is not already associated. If ttl is provided, entry will expire and get evicted after the ttl.

This is equivalent to:

>>> if not map.contains_key(key):
>>>     return map.put(key,value)
>>> else:
>>>     return map.get(key)

except that the action is performed atomically.

Warning: This method returns a clone of the previous value, not the original (identically equal) value previously put into the map.

Warning 2: This method uses __hash__ and __eq__ methods of binary form of the key, not the actual implementations of __hash__ and __eq__ defined in key’s class.

Parameters:	key – (object), key of the entry. value – (object), value of the entry. ttl – (int), maximum time in seconds for this entry to stay in the map, if not provided, the value configured on server side configuration will be used (optional).
Returns:	(object), old value of the entry.

put_transient(key, value, ttl=-1)¶

Same as put(TKey, TValue, Ttl), but MapStore defined at the server side will not be called.

Warning: This method uses __hash__ and __eq__ methods of binary form of the key, not the actual implementations of __hash__ and __eq__ defined in key’s class.

Parameters:	key – (object), key of the entry. value – (object), value of the entry. ttl – (int), maximum time in seconds for this entry to stay in the map, if not provided, the value configured on server side configuration will be used (optional).

remove(key)¶

Removes the mapping for a key from this map if it is present. The map will not contain a mapping for the specified key once the call returns.

Warning: This method uses __hash__ and __eq__ methods of binary form of the key, not the actual implementations of __hash__ and __eq__ defined in key’s class.

Parameters:	key – (object), key of the mapping to be deleted.
Returns:	(object), the previous value associated with key, or `None` if there was no mapping for key.

remove_if_same(key, value)¶

Removes the entry for a key only if it is currently mapped to a given value.

This is equivalent to:

>>> if map.contains_key(key) and map.get(key).equals(value):
>>>     map.remove(key)
>>>     return true
>>> else:
>>>     return false

except that the action is performed atomically.

Warning: This method uses __hash__ and __eq__ methods of binary form of the key, not the actual implementations of __hash__ and __eq__ defined in key’s class.

Parameters:	key – (object), the specified key. value – (object), remove the key if it has this value.
Returns:	(bool), `true` if the value was removed.

remove_entry_listener(registration_id)¶

Removes the specified entry listener. Returns silently if there is no such listener added before.

Parameters:	registration_id – (str), id of registered listener.
Returns:	(bool), `true` if registration is removed, `false` otherwise.

replace(key, value)¶

Replaces the entry for a key only if it is currently mapped to some value.

This is equivalent to:

>>> if map.contains_key(key):
>>>     return map.put(key,value)
>>> else:
>>>     return None

except that the action is performed atomically.

Warning: This method uses __hash__ and __eq__ methods of binary form of the key, not the actual implementations of __hash__ and __eq__ defined in key’s class.

Warning 2: This method returns a clone of the previous value, not the original (identically equal) value previously put into the map.

Parameters:	key – (object), the specified key. value – (object), the value to replace the previous value.
Returns:	(object), previous value associated with key, or `None` if there was no mapping for key.

replace_if_same(key, old_value, new_value)¶

Replaces the entry for a key only if it is currently mapped to a given value.

This is equivalent to:

>>> if map.contains_key(key) and map.get(key).equals(old_value):
>>>     map.put(key, new_value)
>>>     return true
>>> else:
>>>     return false

except that the action is performed atomically.

Warning: This method uses __hash__ and __eq__ methods of binary form of the key, not the actual implementations of __hash__ and __eq__ defined in key’s class.

Parameters:	key – (object), the specified key. old_value – (object), replace the key value if it is the old value. new_value – (object), the new value to replace the old value.
Returns:	(bool), `true` if the value was replaced.

set(key, value, ttl=-1)¶

Puts an entry into this map. Similar to the put operation except that set doesn’t return the old value, which is more efficient. If ttl is provided, entry will expire and get evicted after the ttl.

Warning: This method uses __hash__ and __eq__ methods of binary form of the key, not the actual implementations of __hash__ and __eq__ defined in key’s class.

Parameters:	key – (object), key of the entry. value – (object), value of the entry. ttl – (int), maximum time in seconds for this entry to stay in the map, 0 means infinite. If ttl is not provided, the value configured on server side configuration will be used (optional).

size()¶

Returns the number of entries in this map.

Returns:	(int), number of entries in this map.

try_lock(key, ttl=-1, timeout=0)¶

Tries to acquire the lock for the specified key. When the lock is not available,

If timeout is not provided, the current thread doesn’t wait and returns false immediately.

If a timeout is provided, the current thread becomes disabled for thread scheduling purposes and lies dormant until one of the followings happens:

the lock is acquired by the current thread, or

the specified waiting time elapses.

If ttl is provided, lock will be released after this time elapses.

Parameters:	key – (object), key to lock in this map. ttl – (int), time in seconds to wait before releasing the lock (optional). timeout – (int), maximum time in seconds to wait for the lock (optional).
Returns:	(bool), `true` if the lock was acquired and otherwise, `false`.

try_put(key, value, timeout=0)¶

Tries to put the given key and value into this map and returns immediately if timeout is not provided. If timeout is provided, operation waits until it is completed or timeout is reached.

Parameters:	key – (object), key of the entry. value – (object), value of the entry. timeout – (int), operation timeout in seconds (optional).
Returns:	(bool), `true` if the put is successful, `false` otherwise.

try_remove(key, timeout=0)¶

Tries to remove the given key from this map and returns immediately if timeout is not provided. If timeout is provided, operation waits until it is completed or timeout is reached.

Parameters:	key – (object), key of the entry to be deleted. timeout – (int), operation timeout in seconds (optional).
Returns:	(bool), `true` if the remove is successful, `false` otherwise.

unlock(key)¶

Releases the lock for the specified key. It never blocks and returns immediately. If the current thread is the holder of this lock, then the hold count is decremented. If the hold count is zero, then the lock is released.

Parameters:	key – (object), the key to lock.

values(predicate=None)¶

Returns a list clone of the values contained in this map or values of the entries which are filtered with the predicate if provided.

Warning: The list is NOT backed by the map, so changes to the map are NOT reflected in the list, and vice-versa.

Parameters:	predicate – (Predicate), predicate to filter the entries (optional).
Returns:	(Sequence), a list of clone of the values contained in this map.

See also

Predicate for more info about predicates.

class MapFeatNearCache(client, service_name, name)¶

Bases: hazelcast.proxy.map.Map

Map proxy implementation featuring Near Cache

clear()¶

evict_all()¶

load_all(keys=None, replace_existing_values=True)¶

create_near_cache(serialization_service, near_cache_config)¶

create_map_proxy(client, service_name, name, **kwargs)¶