Sample readme updates (#135)

anders-swanson · web-flow · commit a6d9d917bf4f · 2024-09-25T09:54:36.000-07:00
* Sample readme updates

Signed-off-by: Anders Swanson &lt;anders.swanson@oracle.com&gt;
diff --git a/database/spring-cloud-stream-binder-oracle-txeventq/README.md b/database/spring-cloud-stream-binder-oracle-txeventq/README.md
@@ -1,4 +1,4 @@
-# [TxEventQ](https://www.oracle.com/database/advanced-queuing/) support for Spring Cloud Stream
+# [Oracle Database Transactional Event Queues](https://www.oracle.com/database/advanced-queuing/) support for Spring Cloud Stream
 
 This version of the binder supports Spring Boot 3+/Spring framework 6+.
 
diff --git a/database/spring-cloud-stream-binder-oracle-txeventq/pom.xml b/database/spring-cloud-stream-binder-oracle-txeventq/pom.xml
@@ -14,7 +14,7 @@
     </parent>
 
     <name>spring-cloud-stream-binder-oracle-txeventq</name>
-    <description>Spring Cloud Stream Binder for Oracle TxEventQ based on JMS</description>
+    <description>Spring Cloud Stream Binder for Oracle Database Transactional Event Queues based on JMS</description>
 
     <organization>
         <name>Oracle America, Inc.</name>
diff --git a/database/spring-cloud-stream-binder-oracle-txeventq/spring-cloud-stream-binder-txeventq-sample/README.md b/database/spring-cloud-stream-binder-oracle-txeventq/spring-cloud-stream-binder-txeventq-sample/README.md
@@ -1,6 +1,6 @@
-# Spring Cloud Stream Binder TxEventQ Sample
+# Spring Cloud Stream Binder for Oracle Database Transactional Event Queues Sample
 
-This sample application demonstrates how to use the Spring Cloud Stream Binder for Oracle TxEventQ in a simple Spring Boot Application.
+This sample application demonstrates how to use the Spring Cloud Stream Binder for Oracle Database Transactional Event Queues in a simple Spring Boot Application.
 
 Spring Cloud Stream exposes a [functional messaging API](https://docs.spring.io/spring-cloud-stream/reference/spring-cloud-stream/producing-and-consuming-messages.html) for producing and consuming messages. In this sample we implement three functional interfaces to produce a series of words, capitalize them, and output them.
 
@@ -22,7 +22,7 @@ To run the tests, use the following command:
 mvn test
 ```
 
-As the test runs, you should see the following output, indicating messages are being processed by the TxEventQ stream binder:
+As the test runs, you should see the following output, indicating messages are being processed by the Oracle Database Transactional Event Queues stream binder:
 
 ```
 Consumed: SPRING
diff --git a/database/spring-cloud-stream-binder-oracle-txeventq/spring-cloud-stream-binder-txeventq-sample/pom.xml b/database/spring-cloud-stream-binder-oracle-txeventq/spring-cloud-stream-binder-txeventq-sample/pom.xml
@@ -9,7 +9,7 @@
     <packaging>jar</packaging>
 
     <name>spring-cloud-stream-binder-txeventq-sample</name>
-    <description>Spring Cloud Stream Binder for Oracle TxEventQ Sample Application</description>
+    <description>Spring Cloud Stream Binder for Oracle Database Transactional Event Queues Sample Application</description>
 
     <organization>
         <name>Oracle America, Inc.</name>
diff --git a/database/starters/README.md b/database/starters/README.md
@@ -4,11 +4,11 @@ Oracle Database Spring Starters implements Spring Boot Starters to facilitate th
 
 The following starters are provided:
 
-| Starter                                                                                    | Description                                                                     |
-|--------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------|
-| [Oracle Spring Boot Starter UCP](oracle-spring-boot-starter-ucp)                           | Autoconfigure UCP for Oracle Database, over the default Hikari Connection Pool. |
-| [Oracle Spring Boot Starter AQJMS](oracle-spring-boot-starter-aqjms)                       | Autoconfigure Oracle Database AQJMS Connections.                                |
-| [Oracle Spring Boot Starter JSON Collections](oracle-spring-boot-starter-json-collections) | Autoconfiguration and utilities for JSON with Oracle Database                   |
-| [Oracle Spring Boot Starter Okafka](oracle-spring-boot-starter-okafka) | Autoconfiguration for Kafka Java Client for Oracle Transactional Event Queues |
+| Starter                                                                                                       | Description                                                                     |
+|---------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------|
+| [Oracle Spring Boot Starter UCP](oracle-spring-boot-starter-ucp)                                              | Autoconfigure UCP for Oracle Database, over the default Hikari Connection Pool. |
+| [Oracle Spring Boot Starter AQJMS](oracle-spring-boot-starter-aqjms)                                          | Autoconfigure Oracle Database AQJMS Connections.                                |
+| [Oracle Spring Boot Starter JSON Collections](oracle-spring-boot-starter-json-collections)                    | Autoconfiguration and utilities for JSON with Oracle Database                   |
+| [Oracle Spring Boot Starter for the Kafka Java Client for Oracle Database Transactional Event Queues](oracle-spring-boot-starter-okafka) | Autoconfiguration for Kafka Java Client for Oracle Transactional Event Queues |
 
 
diff --git a/database/starters/oracle-spring-boot-starter-okafka/pom.xml b/database/starters/oracle-spring-boot-starter-okafka/pom.xml
@@ -15,8 +15,8 @@
     <artifactId>oracle-spring-boot-starter-okafka</artifactId>
     <version>24.2.0</version>
 
-    <name>Oracle Spring Boot Starter - OKafka</name>
-    <description>Spring Boot Starter for Oracle Database Kafka API</description>
+    <name>Oracle Spring Boot Starter - Kafka Java Client for Oracle Database Transactional Event Queues</name>
+    <description>Spring Boot Starter for the Kafka Java Client for Oracle Database Transactional Event Queues</description>
     <url>https://github.com/oracle/spring-cloud-oracle/tree/main/database/starters/oracle-spring-boot-starter-okafka</url>
 
     <organization>
diff --git a/database/starters/oracle-spring-boot-starter-samples/README.md b/database/starters/oracle-spring-boot-starter-samples/README.md
@@ -10,8 +10,8 @@ The Oracle UCP with JPA sample application demonstrates how to use the Oracle Sp
 
 The JSON Relational Duality Views sample application demonstrates how to use the Oracle Spring Boot Starter JSON Collections with [JSON Relational Duality Views](https://docs.oracle.com/en/database/oracle/oracle-database/23/jsnvu/overview-json-relational-duality-views.html). JSON Relational Duality Views layer the advantages of JSON document-style database over existing relational data structures — Powerful JSON views with full CRUD capabilities can be created on relational database schemas, nesting related data into a single document with unified access.
 
-### [OKafka Sample](./oracle-spring-boot-starter-okafka/README.md)
+### [Kafka Java Client for Oracle Database Transactional Event Queues Sample](./oracle-spring-boot-starter-okafka/README.md)
 
-This sample application demonstrates how to use the Oracle Spring Boot Starter OKafka with the [Kafka Java Client for Oracle Transactional Event Queues](https://github.com/oracle/okafka)
+This sample application demonstrates how to use the Oracle Spring Boot Starter for the [Kafka Java Client for Oracle Database Transactional Event Queues](https://github.com/oracle/okafka)
 
-Using an in-database message broker like TxEventQ eliminates the need for external message brokers, reduces overall network traffic, simplifying your overall application architecture — and the OKafka library enables developers to create applications for TxEventQ using familiar Kafka APIs for messaging.
+Using an in-database message broker like Oracle Database Transactional Event Queues eliminates the need for external message brokers, reduces overall network traffic, simplifying your overall application architecture — and the Kafka Java Client for Oracle Database Transactional Event Queues library enables developers to create applications for Oracle Database Transactional Event Queues using familiar Kafka APIs for messaging.
diff --git a/database/starters/oracle-spring-boot-starter-samples/oracle-spring-boot-sample-json-events/README.md b/database/starters/oracle-spring-boot-starter-samples/oracle-spring-boot-sample-json-events/README.md
@@ -1,12 +1,12 @@
-# Oracle Spring Boot Sample for JSON Events and OKafka
+# Oracle Spring Boot Sample for JSON Events and the Kafka Java Client for Oracle Database Transactional Event Queues
 
-This sample application demonstrates how to use the Oracle Spring Boot Starter for OKafka, and the Oracle Spring Starter for JSON Collections with [JSON Relational Duality Views](https://docs.oracle.com/en/database/oracle/oracle-database/23/jsnvu/overview-json-relational-duality-views.html) and [Transactional Event Queues](https://www.oracle.com/database/advanced-queuing/). 
+This sample application demonstrates how to use the Oracle Spring Boot Starter for Kafka Java Clients with Oracle Database Transactional Event Queues and the Oracle Spring Starter for JSON Collections with [JSON Relational Duality Views](https://docs.oracle.com/en/database/oracle/oracle-database/23/jsnvu/overview-json-relational-duality-views.html) and [Transactional Event Queues](https://www.oracle.com/database/advanced-queuing/). 
 
-The same application demonstrates a JSON document ingestion workflow where weather station sensor data is sent to a backend application, using OKafka Producer, Consumer, and JSON Relational Duality Views:
+The ampld application demonstrates a JSON document ingestion workflow where weather station sensor data is sent to a backend application, using a Producer, Consumer, and JSON Relational Duality Views:
 
 1. Raw sensor data is sent to a REST endpoint.
-2. The raw sensor data is parsed as a POJO and produced to an OKafka queue in serialized JSONB format.
-3. The OKafka consumer receives the sensor POJO, enriching and saving the POJO to the database as a JSON Relational Duality View.
+2. The raw sensor data is parsed as a POJO and produced to an Oracle Database Transactional Event Queues topic in serialized JSONB format.
+3. The Oracle Database Transactional Event Queues consumer receives the sensor POJO, enriching and saving the POJO to the database as a JSON Relational Duality View.
 4. After consumption, enriched sensor data can be queried from the database by their weather station ID.
 
 ## Run the sample application
@@ -19,11 +19,11 @@ To run application test, run the following command:
 mvn test
 ```
 
-The test starts the OKafka sensor data consumer, and sends a series of raw weather station events to the producer. The test verifies that the events have been processed and saved to the database, available in JSON Relational Duality View form.
+The test starts a sensor data consumer, and sends a series of raw weather station events to the producer. The test verifies that the events have been processed and saved to the database, available in JSON Relational Duality View form.
 
 ## Configure your project to use Oracle JSON Relational Duality Views
 
-To use OKafka and Oracle JSON Relational Duality Views from your Spring Boot application, add the following Maven dependencies to your project:
+To use Kafka Java Client for Oracle Database Transactional Event Queues and Oracle JSON Relational Duality Views from your Spring Boot application, add the following Maven dependencies to your project:
 
 ```xml
 <dependency>
diff --git a/database/starters/oracle-spring-boot-starter-samples/oracle-spring-boot-sample-json-events/src/test/java/com/oracle/database/spring/jsonevents/JSONEventsSampleTest.java b/database/starters/oracle-spring-boot-starter-samples/oracle-spring-boot-sample-json-events/src/test/java/com/oracle/database/spring/jsonevents/JSONEventsSampleTest.java
@@ -43,7 +43,7 @@ public class JSONEventsSampleTest {
      */
     @DynamicPropertySource
     static void properties(DynamicPropertyRegistry registry) {
-        // Configure for OKafka
+        // Configure the Kafka Java Client for Oracle TxEventQ
         String bootstrapServers = "localhost:" + oracleContainer.getOraclePort();
         String propsPath = new File("src/main/resources").getAbsolutePath();
         registry.add("app.bootstrapServers", () -> bootstrapServers);
@@ -58,8 +58,8 @@ static void properties(DynamicPropertyRegistry registry) {
     public static void setUp() throws Exception {
         // Run the okafka.sql grants as sysdba on the database test container
         oracleContainer.start();
-        oracleContainer.copyFileToContainer(MountableFile.forClasspathResource("okafka.sql"), "/tmp/okafka.sql");
-        oracleContainer.execInContainer("sqlplus", "sys / as sysdba", "@/tmp/okafka.sql");
+        oracleContainer.copyFileToContainer(MountableFile.forClasspathResource("txeventq.sql"), "/tmp/txeventq.sql");
+        oracleContainer.execInContainer("sqlplus", "sys / as sysdba", "@/tmp/txeventq.sql");
     }
 
     @Autowired
diff --git a/database/starters/oracle-spring-boot-starter-samples/oracle-spring-boot-sample-json-events/src/test/resources/txeventq.sql b/database/starters/oracle-spring-boot-starter-samples/oracle-spring-boot-sample-json-events/src/test/resources/txeventq.sql
diff --git a/database/starters/oracle-spring-boot-starter-samples/oracle-spring-boot-sample-okafka/README.md b/database/starters/oracle-spring-boot-starter-samples/oracle-spring-boot-sample-okafka/README.md
@@ -1,18 +1,18 @@
-# Oracle Spring Boot Sample for OKafka
+# Oracle Spring Boot Sample for the Kafka Java Client for Oracle Database Transactional Event Queues
 
-With Oracle Database 23ai, powerful Kafka APIs are easily used to read and write data backed by [Transactional Event Queues (TxEventQ)](https://docs.oracle.com/en/database/oracle/oracle-database/21/adque/aq-introduction.html).
+With Oracle Database 23ai, powerful Kafka APIs are easily used to read and write data backed by [Oracle Database Transactional Event Queues](https://docs.oracle.com/en/database/oracle/oracle-database/21/adque/aq-introduction.html).
 
-If you’re unfamiliar with TxEventQ, it’s a robust, real-time message broker that runs within Oracle Database, designed for high throughput — TxEventQ can handle approximately [100 billion messages per day](https://www.oracle.com/database/advanced-queuing/) on an 8-node Oracle RAC cluster.
+If you’re unfamiliar with Oracle Database Transactional Event Queues, it’s a robust, real-time message broker that runs within Oracle Database, designed for high throughput — Oracle Database Transactional Event Queues can handle approximately [100 billion messages per day](https://www.oracle.com/database/advanced-queuing/) on an 8-node Oracle RAC cluster.
 
-This sample application demonstrates how to use the Oracle Spring Boot Starter OKafka with the [Kafka Java Client for Oracle Transactional Event Queues](https://github.com/oracle/okafka)
+This sample application demonstrates how to use the Oracle Spring Boot Starter for the [Kafka Java Client for Oracle Database Transactional Event Queues](https://github.com/oracle/okafka)
 
-The Spring Boot OKafka sample application includes the following components to demonstrate application development using Kafka APIs for Oracle Transactional Event Queues:
+The Spring Boot sample application includes the following components to demonstrate application development using Kafka APIs for Oracle Transactional Event Queues:
 
-- Sample OKafka Producers and Consumers
-- Connection properties for OKafka with Oracle Database
-- Topic management using OKafka admin client
-- Spring Boot configuration for OKafka
-- A comprehensive test using Spring Boot that produces and consumes data from Transactional Event Queues using OKafka
+- Sample Oracle Database Transactional Event Queues Producers and Consumers
+- Connection properties for Oracle Database Transactional Event Queues
+- Topic management using the Oracle Database Transactional Event Queues admin client
+- Spring Boot configuration for the Kafka Java Client for Oracle Database Transactional Event Queues
+- A comprehensive test using Spring Boot that produces and consumes data from Transactional Event Queues using the Kafka Java Client for Oracle Database Transactional Event Queues
 
 ## Run the sample application
 
@@ -24,9 +24,9 @@ To run the test application, run the following command:
 mvn test
 ```
 
-## Configure your project to use OKafka
+## Configure your project to use the Kafka Java Client for Oracle Database Transactional Event Queues
 
-To use OKafka from your Spring Boot application, add the following Maven dependency to your project:
+To use the Kafka Java Client for Oracle Database Transactional Event Queues from your Spring Boot application, add the following Maven dependency to your project:
 
 ```xml
 <dependency>
diff --git a/database/starters/oracle-spring-boot-starter-samples/oracle-spring-boot-sample-okafka/src/main/java/com/oracle/database/spring/okafka/OKafkaComponent.java b/database/starters/oracle-spring-boot-starter-samples/oracle-spring-boot-sample-okafka/src/main/java/com/oracle/database/spring/okafka/OKafkaComponent.java
@@ -38,7 +38,7 @@ public OKafkaComponent(@Qualifier("applicationTaskExecutor") AsyncTaskExecutor t
 
     @PostConstruct
     public void init() {
-        // Create a new OKafka topic
+        // Create a new TxEventQ topic
         NewTopic topic = new NewTopic(TOPIC_NAME, 1, (short) 1);
         OKafkaUtil.createTopicIfNotExists(kafkaProperties, topic);
 

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# [TxEventQ](https://www.oracle.com/database/advanced-queuing/) support for Spring Cloud Stream`
	`1`	`+# [Oracle Database Transactional Event Queues](https://www.oracle.com/database/advanced-queuing/) support for Spring Cloud Stream`
`2`	`2`
`3`	`3`	`This version of the binder supports Spring Boot 3+/Spring framework 6+.`
`4`	`4`