Skip to content

Commit

Permalink
COH-31223: Update CE 14.1.2.0 docs
Browse files Browse the repository at this point in the history
[git-p4: depot-paths = "//dev/coherence-ce/release/coherence-ce-v14.1.2.0/": change = 113038]
  • Loading branch information
chpatel3 committed Dec 19, 2024
1 parent 34bd031 commit 9736e21
Show file tree
Hide file tree
Showing 4 changed files with 49 additions and 15 deletions.
20 changes: 11 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,8 +101,8 @@ Coherence Maps provide a number of features:

* Fundamental **key-based access**: get/put getAll/putAll.
* Client-side and storage-side events:
* **MapListeners** to asynchronously notify clients of changes to data.
* **EventInterceptors** (either sync or async) to be notified storage level events, including
* **MapListeners** to asynchronously notify clients of changes to data.
* **EventInterceptors** (either sync or async) to be notified storage level events, including
mutations, partition transfer, failover, and so on.
* **NearCaches** - Locally cached data based on previous requests with local content
invalidated upon changes in the storage tier.
Expand All @@ -119,7 +119,7 @@ to execute processing logic for the appropriate entries with exclusive access.
associating data (thus being on the same partition) and manipulating other entries
on the same partition, potentially across different maps.
* **Non-blocking / async NamedMap API**
* **Polyglot clients** - Access the same NamedMap API from C++, Go, Java, JavaScript, .NET, or Python.
* **Polyglot clients** - Access the same NamedMap API from [C++](https://github.com/oracle/coherence-cpp-extend-client), [Go](https://github.com/oracle/coherence-go-client), Java, [JavaScript](https://github.com/oracle/coherence-js-client), [.NET](https://github.com/oracle/coherence-dotnet-extend-client), or [Python](https://github.com/oracle/coherence-py-client)
* **Portable Object Format** - Optimized serialization format, with the ability to
navigate the serialized form for optimized queries, aggregations, or data processing.
* **Integration with Databases** - Database and third party data integration with
Expand All @@ -130,10 +130,13 @@ the storage capacity, the cluster, and parallelizable subscribers.
* **Repository API** - a framework implementing the Repository pattern from Domain-Driven Design,
abstracting persistent storage implementation from application code, with advanced features like
support for pagination, projections, streaming, and updating in-place
* **Microservices integration** - broad and close integration with Helidon, Micronaut, and Spring for
developing microservices applications using Coherence as a data source or cache
* **coherence-concurrent** - Coherence-backed implementations of types from the `java.util.concurrent`
package enabling distributed process coordination through the grid
* **coherence-concurrent** - Coherence-backed implementations of types from the `java.util.concurrent` package enabling distributed process coordination through the grid
* **Atomics** - for implementing e.g. atomic counters shared between cluster, with an optional asynchronous API
* **Executors** - for submitting tasks to be executed in the cluster
* **Locks** - for implementing lock-based concurrency control across multiple cluster members
* **Queues** - for implementing blocking queue / dequeue behavior across multiple cluster members
* **Semaphores** - for implementing synchronization of execution across multiple cluster members
* **Microservices integration** - broad and close integration with [Helidon](https://docs.oracle.com/en/middleware/standalone/coherence/14.1.2/integrate/index.html), [Micronaut](https://micronaut-projects.github.io/micronaut-coherence/latest/guide/), and [Spring](https://spring.coherence.community/4.3.0/#/about/01_overview) for developing microservices applications using Coherence as a data source or cache

Coherence also provides a number of non-functional features:

Expand All @@ -158,8 +161,7 @@ JMX server that provides a view of all members of the cluster.
* **Management over REST** - All JMX data and operations can be performed over REST,
including cluster wide thread dumps and heapdumps.
* **Non-cluster Access** - Provides access to the cluster from the outside via proxies,
for distant (high latency) clients and for non-Java languages such as C++, Go, JavaScript,
.NET, and Python.
for distant (high latency) clients and for non-Java languages such as [C++](https://github.com/oracle/coherence-cpp-extend-client), [Go](https://github.com/oracle/coherence-go-client), [JavaScript](https://github.com/oracle/coherence-js-client), [.NET](https://github.com/oracle/coherence-dotnet-extend-client), and [Python](https://github.com/oracle/coherence-py-client).
* **Kubernetes friendly** - Enables seamless and safe deployment of applications to k8s with
our own [operator](https://github.com/oracle/coherence-operator).

Expand Down
2 changes: 1 addition & 1 deletion prj/docs/about/01_overview.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ Oracle Coherence commercial edition product documentation.
[CARD]
.API Docs
[icon=library_books,link=../api/java/index.html,link-type=url]
[icon=library_books,link=docs/about/04_api.adoc]
--
Browse the Coherence CE API Docs.
--
Expand Down
16 changes: 11 additions & 5 deletions prj/docs/about/02_introduction.adoc
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
///////////////////////////////////////////////////////////////////////////////
Copyright (c) 2000, 2021, Oracle and/or its affiliates.
Copyright (c) 2000, 2024, Oracle and/or its affiliates.

Licensed under the Universal Permissive License v 1.0 as shown at
http://oss.oracle.com/licenses/upl.
https://oss.oracle.com/licenses/upl.
///////////////////////////////////////////////////////////////////////////////
= Introduction
Expand All @@ -29,6 +29,7 @@ a cache will be represented by an implementation of `NamedCache<K,V>`.
Cache is an unfortunate name, as many customers use Coherence as a system-of-record rather than a lossy store of data.
A cache is hosted by a service, generally the PartitionedService, and is the entry point to storing, retrieving,
aggregating, querying, and streaming data.
There are a number of features that caches provide:
* Fundamental *key-based access*: get/put getAll/putAll
Expand All @@ -42,14 +43,19 @@ There are a number of features that caches provide:
* *Data local processing* - an ability to send a function to the relevant storage node to execute processing logic for the appropriate entries with exclusive access
* *Partition local transactions* - an ability to perform scalable transactions by associating data (thus being on the same partition) and manipulating other entries on the same partition potentially across caches
* *Non-blocking / async NamedCache API*
* *Polyglot clients* - access the same NamedCache API from C{pp}, Go, Java, JavaScript, .NET, or Python
* *Polyglot clients* - access the same NamedCache API from https://github.com/oracle/coherence-cpp-extend-client[C++], https://github.com/oracle/coherence-go-client[Go], Java, https://github.com/oracle/coherence-js-client[JavaScript], https://github.com/oracle/coherence-dotnet-extend-client[.NET], or https://github.com/oracle/coherence-py-client[Python]
* *Portable Object Format* - optimized serialization format, with the ability to navigate the serialized form for optimized queries, aggregations, or data processing
* *Integration with Databases* - Database & third party data integration with CacheStores including both synchronous or asynchronous writes
* *CohQL* - ansi-style query language with a console for adhoc queries
* *Topics* - distributed topics implementation offering pub/sub messaging with the storage capacity the cluster and parallelizable subscribers
* *Repository API* - a framework implementing the Repository pattern from Domain-Driven Design, abstracting persistent storage implementation from application code, with advanced features like support for pagination, projections, streaming, and updating in-place
* *Microservices integration* - broad and close integration with Helidon, Micronaut, and Spring for developing microservices applications using Coherence as a data source or cache
* *coherence-concurrent* - Coherence-backed implementations of types from the `java.util.concurrent` package enabling distributed process coordination through the grid
** *Atomics* - for implementing e.g. atomic counters shared between cluster, with an optional asynchronous API
** *Executors* - for submitting tasks to be executed in the cluster
** *Locks* - for implementing lock-based concurrency control across multiple cluster members
** *Queues* - for implementing blocking queue / dequeue behavior across multiple cluster members
** *Semaphores* - for implementing synchronization of execution across multiple cluster members
* *Microservices integration* - broad and close integration with https://docs.oracle.com/en/middleware/standalone/coherence/14.1.2/integrate/index.html[Helidon], https://micronaut-projects.github.io/micronaut-coherence/latest/guide/[Micronaut], and https://spring.coherence.community/4.3.0/#/about/01_overview[Spring] for developing microservices applications using Coherence as a data source or cache
There are also a number of non-functional features that Coherence provides:
Expand All @@ -62,7 +68,7 @@ There are also a number of non-functional features that Coherence provides:
* *Lossy redundancy* - ability to reduce the redundancy guarantee by making backups and/or persistence asynchronous from a client perspective
* *Single Mangement View* - provides insight into the cluster with a single JMX server that provides a view of all members of the cluster
* *Management over REST* - all JMX data and operations can be performed over REST, including cluster wide thread dumps and heapdumps
* *Non-cluster Access* - access to the cluster from the outside via proxies, for distant (high latency) clients and for non-Java languages such as C{pp}, Go, JavaScript, .NET, and Python
* *Non-cluster Access* - access to the cluster from the outside via proxies, for distant (high latency) clients and for non-Java languages such as https://github.com/oracle/coherence-cpp-extend-client[C++], https://github.com/oracle/coherence-go-client[Go], https://github.com/oracle/coherence-js-client[JavaScript], https://github.com/oracle/coherence-dotnet-extend-client[.NET], or https://github.com/oracle/coherence-py-client[Python]
* *Kubernetes friendly* - seamlessly and safely deploy applications to k8s with our own https://github.com/oracle/coherence-operator[operator]
Expand Down
26 changes: 26 additions & 0 deletions prj/docs/about/04_api.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
///////////////////////////////////////////////////////////////////////////////
Copyright (c) 2000, 2024, Oracle and/or its affiliates.

Licensed under the Universal Permissive License v 1.0 as shown at
https://oss.oracle.com/licenses/upl.
///////////////////////////////////////////////////////////////////////////////
= API Docs
:description: Oracle Coherence CE Documentation
:keywords: coherence, API, Java, .NET, C++, Python, Go, JavaScript documentation
// DO NOT remove this header - it might look like a duplicate of the header above, but
// both they serve a purpose, and the docs will look wrong if it is removed.
== API Docs
- https://oracle.github.io/coherence/{version-coherence-maven}/api/java/index.html[Coherence CE Java API]
- https://docs.oracle.com/en/middleware/fusion-middleware/coherence/14.1.2.0/net-reference/html[Coherence .NET Client API]
- https://docs.oracle.com/en/middleware/fusion-middleware/coherence/14.1.2.0/cplus-reference/index.html[Coherence C++ Client API]
- https://oracle.github.io/coherence-py-client/api_reference.html[Coherence Python Client API]
- https://pkg.go.dev/github.com/oracle/coherence-go-client/v2/coherence#pkg-index[Coherence Go Client API]
- https://oracle.github.io/coherence-js-client/[Coherence JavaScript Client API]

0 comments on commit 9736e21

Please sign in to comment.