Coherence-client

Introduction

This is release v2.0.0 of the Python Client for Oracle Coherence. It allows Python applications to act as cache clients to a Coherence cluster using gRPC.

Requirements

* [Coherence CE](https://github.com/oracle/coherence) 22.06.11+ or Coherence 14.1.1.2206.11+, 14.1.2.0+ Commercial edition with a configured [gRPCProxy](https://docs.oracle.com/en/middleware/standalone/coherence/14.1.1.2206/develop-remote-clients/using-coherence-grpc-server.html).
* Usage of module `coherence.ai` requires [Coherence CE](https://github.com/oracle/coherence) 24.09.2+
* Python 3.9.x or later

Updates / New Features
* Added support for new internal gRPC v1 API in CE 24.09+, CE 14.1.2+ and commercial 14.1.2+.
* Added NearCache support to cache frequently accessed data in your Python application.
* Added support to use the Coherence Name Service to lookup gRPC endpoints by specifying the resolve address of `coherence:///host:port` where host is a machine in the cluster and port is the cluster port.
E.g. `coherence:///localhost:7574`
* `coherence.ai` module added to support SimilaritySearch API

Breaking Changes

The following methods have changed their signatures to be `async` in **NamedMap** and **NamedCache** class:

* `async def get_all(...)`
* `async def release(...)`
* `async def invoke_all(...)`
* `async def values(...)`
* `async def keys(...)`
* `async def entries(...)`

What's Changed
* Integrate V1 Protocol Support, and Near Caching by rlubke in https://github.com/oracle/coherence-py-client/pull/180
* Updated Near Caching documentation and new example by rlubke in https://github.com/oracle/coherence-py-client/pull/189
* COH-30144 Implement NSLookup resolution for Python Client by dhirupandey in https://github.com/oracle/coherence-py-client/pull/193
* COH-31333 - Update the session connection log output to be similar to… by dhirupandey in https://github.com/oracle/coherence-py-client/pull/197
* COH-31421 - Integrate Coherence AI changes to main and release a new version to Pypi by dhirupandey in https://github.com/oracle/coherence-py-client/pull/207
* Updated Coherence CE versions to 22.06.11, 24.09.2
* Update jsonpickle requirement to >=3.0,<4.1 by dependabot in https://github.com/oracle/coherence-py-client/pull/174
* Update types-protobuf requirement from 5.27.0.20240626 to 5.29.1.20241207 by dependabot in https://github.com/oracle/coherence-py-client/pull/187
* Update pymitter requirement from >=0.4,<0.6 to >=0.4,<1.1 by dependabot in https://github.com/oracle/coherence-py-client/pull/191
* Update protobuf requirement 5.29.3 by dependabot in https://github.com/oracle/coherence-py-client/pull/195
* Update grpcio requirement to 1.70.0 by dependabot in https://github.com/oracle/coherence-py-client/pull/203
* Update grpcio-tools requirement to 1.70.0 by dependabot in https://github.com/oracle/coherence-py-client/pull/204

**Full Changelog**: https://github.com/oracle/coherence-py-client/compare/v1.1.1...v2.0.0

What's Changed
* Fix version number in coherence/__init__.py and update other locations for release by dhirupandey in https://github.com/oracle/coherence-py-client/pull/145
* Update grpcio requirement from >=1.54,<1.64 to >=1.54,<1.65 by dependabot in https://github.com/oracle/coherence-py-client/pull/142



**Full Changelog**: https://github.com/oracle/coherence-py-client/compare/v1.1.0...v1.1.1

What's Changed
* COH-29986 - Implement missing apis - add_index and remove_index in Python client by dhirupandey in https://github.com/oracle/coherence-py-client/pull/139

**Full Changelog**: https://github.com/oracle/coherence-py-client/compare/v1.0.3...v1.1.0

What's Changed
* COH-29971 - Changes for supporting Python 3.8+ by dhirupandey in https://github.com/oracle/coherence-py-client/pull/133
* COH-29294 - Add missing test for put with TTL by dhirupandey in https://github.com/oracle/coherence-py-client/pull/109
* Update grpcio requirement from >=1.54,<1.61 to >=1.54,<1.63 by dependabot in https://github.com/oracle/coherence-py-client/pull/112
* Update grpcio-tools requirement from >=1.54,<1.61 to >=1.54,<1.63 by dependabot in https://github.com/oracle/coherence-py-client/pull/113
* Update CI builds to use latest CE releases by dhirupandey in https://github.com/oracle/coherence-py-client/pull/105
* COH-29907 - Fix error from "docker-compose: not found" on GitHub CI by dhirupandey in https://github.com/oracle/coherence-py-client/pull/129
* COH-29926 - Archive server logs for CI runs on both GitHub and Jenkins by dhirupandey in https://github.com/oracle/coherence-py-client/pull/130
* COH-29941- Remove destroy() calls during teardown to fix failures in main by dhirupandey in https://github.com/oracle/coherence-py-client/pull/131

**Full Changelog**: https://github.com/oracle/coherence-py-client/compare/v1.0.2...v1.0.3

What's Changed
* Changes to run SSL tests on OEL by dhirupandey in https://github.com/oracle/coherence-py-client/pull/54
* Stop test containers after the test execution by dhirupandey in https://github.com/oracle/coherence-py-client/pull/56
* Revert "Stop test containers after the test execution" by dhirupandey in https://github.com/oracle/coherence-py-client/pull/57
* Update to latest 22.06 CE release. by rlubke in https://github.com/oracle/coherence-py-client/pull/60
* Fix for intermittent hang by rlubke in https://github.com/oracle/coherence-py-client/pull/70
* Changes to test with other Coherence versions by dhirupandey in https://github.com/oracle/coherence-py-client/pull/72
* Update grpcio requirement from >=1.54,<1.59 to >=1.54,<1.60 by dependabot in https://github.com/oracle/coherence-py-client/pull/80
* Replace 23.03 with 23.09. by rlubke in https://github.com/oracle/coherence-py-client/pull/81
* Update grpcio-tools requirement from >=1.54,<1.59 to >=1.54,<1.60 by dependabot in https://github.com/oracle/coherence-py-client/pull/82
* COH-28687 - Display the host its trying to connect in error stack by dhirupandey in https://github.com/oracle/coherence-py-client/pull/84
* Update protobuf requirement from >=4.23,<4.25 to >=4.23,<4.26 by dependabot in https://github.com/oracle/coherence-py-client/pull/86
* COH-28861 - CI Build - error: Missing type parameters for generic type "ValueManipulator" [type-arg] by dhirupandey in https://github.com/oracle/coherence-py-client/pull/88
* Update pymitter requirement from ~0.4 to >=0.4,<0.6 by dependabot in https://github.com/oracle/coherence-py-client/pull/89


**Full Changelog**: https://github.com/oracle/coherence-py-client/compare/v1.0.1...v1.0.2

What is the Coherence Python Client?

- The Coherence Python Client allows Python applications to act as cache clients to a Coherence Cluster using gRPC for the network transport.
- Supported on Coherence CE 22.06.4+ or Coherence 14.1.1.2206.4+ Commercial edition with a configured [gRPC Proxy](https://docs.oracle.com/en/middleware/standalone/coherence/14.1.1.2206/develop-remote-clients/using-coherence-grpc-server.html). (Can get started using the latest coherence docker image)
- Python 3.11.x is required

Features

- Familiar Map-like interface for manipulating cache entries including but not limited to:
- put, put_if_absent, put_all, get, get_all, remove, clear, get_or_default, replace, replace_mapping, size, is_empty, contains_key, contains_value
- Cluster-side querying, aggregation and filtering of map entries
- Cluster-side manipulation of map entries using EntryProcessors
- Registration of listeners to be notified of:
- mutations such as insert, update and delete on Maps
- map lifecycle events such as truncated, released or destroyed
- session lifecycle events such as connected, disconnected, reconnected and closed
- Support for storing Python objects as JSON as well as the ability to serialize to Java objects on the server for access from other Coherence language API’s

Next Steps

- Visit and :star: the [Coherence Python Client repo on GitHub](https://github.com/oracle/coherence-py-client)
- Explore/ Run the [comprehensive examples](https://github.com/oracle/coherence-py-client/tree/main/examples)
- Visit the [Documentation page](https://oracle.github.io/coherence-py-client/)