From 0c4d0e1814ae344f1e1255b8d665c0957e756ee1 Mon Sep 17 00:00:00 2001 From: Priyanshi Gupta Date: Wed, 10 Aug 2022 22:44:52 +0530 Subject: [PATCH 01/12] [docs] added docs for vertx pg client for Java --- .../develop/build-apps/java/ycql-4.6.md | 6 + .../preview/develop/build-apps/java/ycql.md | 6 + .../develop/build-apps/java/ysql-ebean.md | 6 + .../develop/build-apps/java/ysql-hibernate.md | 6 + .../develop/build-apps/java/ysql-jdbc-ssl.md | 6 + .../develop/build-apps/java/ysql-jdbc.md | 6 + .../develop/build-apps/java/ysql-sdyb.md | 6 + .../build-apps/java/ysql-spring-data.md | 6 + .../build-apps/java/ysql-vertx-pg-client.md | 214 ++++++++++++++++++ .../develop/build-apps/java/ysql-yb-jdbc.md | 6 + .../reference/drivers/ysql-client-drivers.md | 8 + 11 files changed, 276 insertions(+) create mode 100644 docs/content/preview/develop/build-apps/java/ysql-vertx-pg-client.md diff --git a/docs/content/preview/develop/build-apps/java/ycql-4.6.md b/docs/content/preview/develop/build-apps/java/ycql-4.6.md index 6a7cca465740..344d76f51253 100644 --- a/docs/content/preview/develop/build-apps/java/ycql-4.6.md +++ b/docs/content/preview/develop/build-apps/java/ycql-4.6.md @@ -24,6 +24,12 @@ type: docs YSQL - JDBC +
  • + + + YSQL - Vertx PG Client + +
  • diff --git a/docs/content/preview/develop/build-apps/java/ycql.md b/docs/content/preview/develop/build-apps/java/ycql.md index 32813cb8141d..8d906aa1dd2f 100644 --- a/docs/content/preview/develop/build-apps/java/ycql.md +++ b/docs/content/preview/develop/build-apps/java/ycql.md @@ -24,6 +24,12 @@ type: docs YSQL - JDBC
    • +
  • + + + YSQL - Vertx PG Client + +
  • diff --git a/docs/content/preview/develop/build-apps/java/ysql-ebean.md b/docs/content/preview/develop/build-apps/java/ysql-ebean.md index b5ebaa247e84..c1e043745e8a 100644 --- a/docs/content/preview/develop/build-apps/java/ysql-ebean.md +++ b/docs/content/preview/develop/build-apps/java/ysql-ebean.md @@ -25,6 +25,12 @@ type: docs YSQL - JDBC
    • +
  • + + + YSQL - Vertx PG Client + +
  • diff --git a/docs/content/preview/develop/build-apps/java/ysql-hibernate.md b/docs/content/preview/develop/build-apps/java/ysql-hibernate.md index 4a982db6dcf1..61c8ae97b1f1 100644 --- a/docs/content/preview/develop/build-apps/java/ysql-hibernate.md +++ b/docs/content/preview/develop/build-apps/java/ysql-hibernate.md @@ -25,6 +25,12 @@ type: docs YSQL - JDBC
    • +
  • + + + YSQL - Vertx PG Client + +
  • diff --git a/docs/content/preview/develop/build-apps/java/ysql-jdbc-ssl.md b/docs/content/preview/develop/build-apps/java/ysql-jdbc-ssl.md index aec20a9a4c65..3cfd3ddee83d 100644 --- a/docs/content/preview/develop/build-apps/java/ysql-jdbc-ssl.md +++ b/docs/content/preview/develop/build-apps/java/ysql-jdbc-ssl.md @@ -24,6 +24,12 @@ type: docs YSQL - JDBC
    • +
  • + + + YSQL - Vertx PG Client + +
  • diff --git a/docs/content/preview/develop/build-apps/java/ysql-jdbc.md b/docs/content/preview/develop/build-apps/java/ysql-jdbc.md index 5a02031466a7..bfe21f432dac 100644 --- a/docs/content/preview/develop/build-apps/java/ysql-jdbc.md +++ b/docs/content/preview/develop/build-apps/java/ysql-jdbc.md @@ -24,6 +24,12 @@ type: docs YSQL - JDBC
    • +
  • + + + YSQL - Vertx PG Client + +
  • diff --git a/docs/content/preview/develop/build-apps/java/ysql-sdyb.md b/docs/content/preview/develop/build-apps/java/ysql-sdyb.md index 0e4130df62e5..499d3d0cbf02 100644 --- a/docs/content/preview/develop/build-apps/java/ysql-sdyb.md +++ b/docs/content/preview/develop/build-apps/java/ysql-sdyb.md @@ -25,6 +25,12 @@ type: docs YSQL - JDBC
    • +
  • + + + YSQL - Vertx PG Client + +
  • diff --git a/docs/content/preview/develop/build-apps/java/ysql-spring-data.md b/docs/content/preview/develop/build-apps/java/ysql-spring-data.md index eaf19ed00a20..f44104844d73 100644 --- a/docs/content/preview/develop/build-apps/java/ysql-spring-data.md +++ b/docs/content/preview/develop/build-apps/java/ysql-spring-data.md @@ -24,6 +24,12 @@ type: docs YSQL - JDBC
    • +
  • + + + YSQL - Vertx PG Client + +
  • diff --git a/docs/content/preview/develop/build-apps/java/ysql-vertx-pg-client.md b/docs/content/preview/develop/build-apps/java/ysql-vertx-pg-client.md new file mode 100644 index 000000000000..17a6cb434237 --- /dev/null +++ b/docs/content/preview/develop/build-apps/java/ysql-vertx-pg-client.md @@ -0,0 +1,214 @@ +--- +title: Build a Java application that uses YSQL +headerTitle: Build a Java application +linkTitle: Java +description: Build a sample Java application with the Vertx PG Client and use the YSQL API to connect to and interact with YugabyteDB. +menu: + preview: + parent: build-apps + name: Java + identifier: java-10 + weight: 550 +type: page +isTocNested: true +showAsideToc: true +--- + + + +[Vertx PG client](https://vertx.io/docs/vertx-pg-client/java/) is the client for PostgreSQL with the simple APIs for communicating with the Database. It is reactive and non-blocking client for handling the database connections with single threaded API. + +As this client is for PostgreSQL and YugabyteDB is wire compatible with PostgreSQL, it is also supported by YugabyteDB with one [limitation](#limitation). + +## Prerequisites + +This tutorial assumes that: + +- YugabyteDB is up and running. If you are new to YugabyteDB, you can download, install, and have YugabyteDB up and running within five minutes by following the steps in [Quick start](../../../../quick-start/). +- Java Development Kit (JDK) 1.8, or later, is installed. +- [Apache Maven](https://maven.apache.org/index.html) 3.3 or later, is installed. + +## Create and configure the Java project + +1. Create a project called "MySample". + + ```sh + $ mvn archetype:generate \ + -DgroupId=com.yugabyte \ + -DartifactId=vertx-pg-example \ + -DarchetypeArtifactId=maven-archetype-quickstart \ + -DinteractiveMode=false + + $ cd vertx-pg-example + ``` + +1. Add the following dependency for the vertx pg client within the `` element in the `pom.xml` file. + + ```xml + + io.vertx + vertx-pg-client + 4.3.2 + + ``` + +1. Install the added dependency. + + ```sh + $ mvn install + ``` + +## Create the sample Java application + +1. Copy the following Java code to a new file named `src/main/java/com/yugabyte/vertxPgExample.java`: + + ```java + package com.yugabyte; + + import io.vertx.core.Promise; + import io.vertx.core.Vertx; + import io.vertx.pgclient.PgConnectOptions; + import io.vertx.pgclient.PgPool; + import io.vertx.sqlclient.PoolOptions; + import io.vertx.sqlclient.Tuple; + import io.vertx.sqlclient.Row; + import io.vertx.sqlclient.RowStream; + + public class vertxPgExample { + public static void main(String[] args) { + + PgConnectOptions options = new PgConnectOptions() + .setPort(5433) + .setHost("127.0.0.1") + .setDatabase("vertx_pg_test") + .setUser("yugabyte") + .setPassword("yugabyte"); + + Vertx vertx = Vertx.vertx(); + // creating the PgPool with configuration as option and maxsize 10. + PgPool pool = PgPool.pool(vertx, options, new PoolOptions().setMaxSize(10)); + + //getting a connection from the pool and running the example on that + pool.getConnection().compose(connection -> { + Promise promise = Promise.promise(); + // create a test table + connection.query("create table test(id int primary key, name text)").execute() + .compose(v -> { + // insert some test data + return connection.query("insert into test values (1, 'Hello'), (2, 'World'), (3,'Example'), (4, 'Vertx'), (5, 'Yugabyte')").execute(); + }) + .compose(v -> { + // prepare the query + return connection.prepare("select * from test order by id"); + }) + .map(preparedStatement -> { + // create a stream for the prepared statement + return preparedStatement.createStream(50, Tuple.tuple()); + }) + .onComplete(ar -> { + if (ar.succeeded()) { + RowStream stream = ar.result(); + stream + .exceptionHandler(promise::fail) + .endHandler(promise::complete) + .handler(row -> System.out.println(row.toJson())); // Printing each row as JSON + } else { + promise.fail(ar.cause()); + } + }); + return promise.future().onComplete(v -> { + // close the connection + connection.close(); + }); + }).onComplete(ar -> { + if (ar.succeeded()) { + System.out.println("Example ran successfully!"); + } else { + ar.cause().printStackTrace(); + } + }); + + } + } + ``` + +1. Run your new program. + + ```sh + $ mvn -q package exec:java -DskipTests -Dexec.mainClass=com.yugabyte.vertxPgExample + ``` + + You should see the following as the output: + + ```output + {"id":1,"name":"Hello"} + {"id":2,"name":"World"} + {"id":3,"name":"Example"} + {"id":4,"name":"Vertx"} + {"id":5,"name":"Yugabyte"} + Example ran successfully! + ``` +## Limitation + +[PubSub](https://vertx.io/docs/vertx-pg-client/java/#_pubsub) feature of Vertx PG client is currently not supported with YugabyteDB. diff --git a/docs/content/preview/develop/build-apps/java/ysql-yb-jdbc.md b/docs/content/preview/develop/build-apps/java/ysql-yb-jdbc.md index fb5ad70bbd9a..21b77a763e39 100644 --- a/docs/content/preview/develop/build-apps/java/ysql-yb-jdbc.md +++ b/docs/content/preview/develop/build-apps/java/ysql-yb-jdbc.md @@ -30,6 +30,12 @@ type: docs YSQL - JDBC
    • +
  • + + + YSQL - Vertx PG Client + +
  • diff --git a/docs/content/preview/reference/drivers/ysql-client-drivers.md b/docs/content/preview/reference/drivers/ysql-client-drivers.md index 956b5699c0e0..664334f65b10 100644 --- a/docs/content/preview/reference/drivers/ysql-client-drivers.md +++ b/docs/content/preview/reference/drivers/ysql-client-drivers.md @@ -150,6 +150,14 @@ To download binary JAR files, go to [PostgreSQL JDBC driver – Downloads](https To get the latest versions for projects using [Apache Maven](https://maven.apache.org), see [Maven Central Repository Search](https://search.maven.org/artifact/org.postgresql/postgresql/42.2.14.jre7/jar). +### Vertx PG Client + +[Vertx PG client](https://vertx.io/docs/vertx-pg-client/java/) is the client for PostgreSQL with the simple APIs for communicating with the Database. It is reactive and non-blocking client for handling the database connections with single threaded API. + +For a tutorial on building a sample Java application with the Vertx PG Client, see [Build a Java application](../../../develop/build-apps/java/ysql-vertx-pg-client/). + +To get the latest versions for projects using [Apache Maven](https://maven.apache.org), see [Maven Central Repository of Vertx PG Client](https://mvnrepository.com/artifact/io.vertx/vertx-pg-client). + ## Node.JS ### node-postgres From 7b9484079be03ae415b7680bb7433f0c64aeb2a2 Mon Sep 17 00:00:00 2001 From: Priyanshi Gupta Date: Thu, 11 Aug 2022 10:55:21 +0530 Subject: [PATCH 02/12] [docs] added docs for vertx pg client for Java --- .../preview/develop/build-apps/java/ysql-vertx-pg-client.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/content/preview/develop/build-apps/java/ysql-vertx-pg-client.md b/docs/content/preview/develop/build-apps/java/ysql-vertx-pg-client.md index 17a6cb434237..7db497b76af9 100644 --- a/docs/content/preview/develop/build-apps/java/ysql-vertx-pg-client.md +++ b/docs/content/preview/develop/build-apps/java/ysql-vertx-pg-client.md @@ -141,7 +141,7 @@ This tutorial assumes that: PgConnectOptions options = new PgConnectOptions() .setPort(5433) .setHost("127.0.0.1") - .setDatabase("vertx_pg_test") + .setDatabase("yugabyte") .setUser("yugabyte") .setPassword("yugabyte"); From 82b1feedf5680567d35e3491a5311d48fe1c5c31 Mon Sep 17 00:00:00 2001 From: Priyanshi Gupta Date: Tue, 16 Aug 2022 01:28:26 +0530 Subject: [PATCH 03/12] Update docs/content/preview/develop/build-apps/java/ysql-vertx-pg-client.md Co-authored-by: Aishwarya Chakravarthy --- .../preview/develop/build-apps/java/ysql-vertx-pg-client.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/content/preview/develop/build-apps/java/ysql-vertx-pg-client.md b/docs/content/preview/develop/build-apps/java/ysql-vertx-pg-client.md index 7db497b76af9..1d26f9476e65 100644 --- a/docs/content/preview/develop/build-apps/java/ysql-vertx-pg-client.md +++ b/docs/content/preview/develop/build-apps/java/ysql-vertx-pg-client.md @@ -77,7 +77,7 @@ showAsideToc: true
    • -[Vertx PG client](https://vertx.io/docs/vertx-pg-client/java/) is the client for PostgreSQL with the simple APIs for communicating with the Database. It is reactive and non-blocking client for handling the database connections with single threaded API. +[Vertx PG Client](https://vertx.io/docs/vertx-pg-client/java/) is the client for PostgreSQL with simple APIs to communicate with the database. It is a reactive and non-blocking client for handling the database connections with a single threaded API. As this client is for PostgreSQL and YugabyteDB is wire compatible with PostgreSQL, it is also supported by YugabyteDB with one [limitation](#limitation). From 349d51954a5d53287312a677d2b4129ff6cb676d Mon Sep 17 00:00:00 2001 From: Priyanshi Gupta Date: Tue, 16 Aug 2022 01:31:33 +0530 Subject: [PATCH 04/12] Update docs/content/preview/develop/build-apps/java/ysql-vertx-pg-client.md Co-authored-by: Aishwarya Chakravarthy --- .../preview/develop/build-apps/java/ysql-vertx-pg-client.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/content/preview/develop/build-apps/java/ysql-vertx-pg-client.md b/docs/content/preview/develop/build-apps/java/ysql-vertx-pg-client.md index 1d26f9476e65..4180fe730ec8 100644 --- a/docs/content/preview/develop/build-apps/java/ysql-vertx-pg-client.md +++ b/docs/content/preview/develop/build-apps/java/ysql-vertx-pg-client.md @@ -85,7 +85,7 @@ As this client is for PostgreSQL and YugabyteDB is wire compatible with PostgreS This tutorial assumes that: -- YugabyteDB is up and running. If you are new to YugabyteDB, you can download, install, and have YugabyteDB up and running within five minutes by following the steps in [Quick start](../../../../quick-start/). +- YugabyteDB up and running. Download and install YugabyteDB by following the steps in [Quick start](../../../../quick-start/). - Java Development Kit (JDK) 1.8, or later, is installed. - [Apache Maven](https://maven.apache.org/index.html) 3.3 or later, is installed. From 56220d9557543666b05c928e3daae103765ab714 Mon Sep 17 00:00:00 2001 From: Priyanshi Gupta Date: Tue, 16 Aug 2022 01:31:39 +0530 Subject: [PATCH 05/12] Update docs/content/preview/develop/build-apps/java/ysql-vertx-pg-client.md Co-authored-by: Aishwarya Chakravarthy --- .../preview/develop/build-apps/java/ysql-vertx-pg-client.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/content/preview/develop/build-apps/java/ysql-vertx-pg-client.md b/docs/content/preview/develop/build-apps/java/ysql-vertx-pg-client.md index 4180fe730ec8..00ca1bd15aee 100644 --- a/docs/content/preview/develop/build-apps/java/ysql-vertx-pg-client.md +++ b/docs/content/preview/develop/build-apps/java/ysql-vertx-pg-client.md @@ -103,7 +103,7 @@ This tutorial assumes that: $ cd vertx-pg-example ``` -1. Add the following dependency for the vertx pg client within the `` element in the `pom.xml` file. +1. Add the following dependency for the Vertx PG Client within the `` element in the `pom.xml` file. ```xml From 33aea5548f4a7046d3d3375a6357ef4713be8cbd Mon Sep 17 00:00:00 2001 From: Priyanshi Gupta Date: Tue, 16 Aug 2022 01:31:45 +0530 Subject: [PATCH 06/12] Update docs/content/preview/develop/build-apps/java/ysql-vertx-pg-client.md Co-authored-by: Aishwarya Chakravarthy --- .../preview/develop/build-apps/java/ysql-vertx-pg-client.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/content/preview/develop/build-apps/java/ysql-vertx-pg-client.md b/docs/content/preview/develop/build-apps/java/ysql-vertx-pg-client.md index 00ca1bd15aee..89e5c1dfb774 100644 --- a/docs/content/preview/develop/build-apps/java/ysql-vertx-pg-client.md +++ b/docs/content/preview/develop/build-apps/java/ysql-vertx-pg-client.md @@ -121,7 +121,7 @@ This tutorial assumes that: ## Create the sample Java application -1. Copy the following Java code to a new file named `src/main/java/com/yugabyte/vertxPgExample.java`: +1. Copy the following Java code to a new file `src/main/java/com/yugabyte/vertxPgExample.java`: ```java package com.yugabyte; From 91e9c8acd5c1d2ed1490480da7029ac26db3fa4a Mon Sep 17 00:00:00 2001 From: Priyanshi Gupta Date: Tue, 16 Aug 2022 01:47:46 +0530 Subject: [PATCH 07/12] Update docs/content/preview/develop/build-apps/java/ysql-vertx-pg-client.md Co-authored-by: Aishwarya Chakravarthy --- .../preview/develop/build-apps/java/ysql-vertx-pg-client.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/content/preview/develop/build-apps/java/ysql-vertx-pg-client.md b/docs/content/preview/develop/build-apps/java/ysql-vertx-pg-client.md index 89e5c1dfb774..a23f8fff9f85 100644 --- a/docs/content/preview/develop/build-apps/java/ysql-vertx-pg-client.md +++ b/docs/content/preview/develop/build-apps/java/ysql-vertx-pg-client.md @@ -193,7 +193,7 @@ This tutorial assumes that: } ``` -1. Run your new program. +1. Run the program. ```sh $ mvn -q package exec:java -DskipTests -Dexec.mainClass=com.yugabyte.vertxPgExample From 50d83272f3b3b68a30b0109507bcde0cc668d4e6 Mon Sep 17 00:00:00 2001 From: Priyanshi Gupta Date: Tue, 16 Aug 2022 01:47:54 +0530 Subject: [PATCH 08/12] Update docs/content/preview/develop/build-apps/java/ysql-vertx-pg-client.md Co-authored-by: Aishwarya Chakravarthy --- .../preview/develop/build-apps/java/ysql-vertx-pg-client.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/content/preview/develop/build-apps/java/ysql-vertx-pg-client.md b/docs/content/preview/develop/build-apps/java/ysql-vertx-pg-client.md index a23f8fff9f85..2ad5a856c5db 100644 --- a/docs/content/preview/develop/build-apps/java/ysql-vertx-pg-client.md +++ b/docs/content/preview/develop/build-apps/java/ysql-vertx-pg-client.md @@ -211,4 +211,4 @@ This tutorial assumes that: ``` ## Limitation -[PubSub](https://vertx.io/docs/vertx-pg-client/java/#_pubsub) feature of Vertx PG client is currently not supported with YugabyteDB. +[Pub/sub](https://vertx.io/docs/vertx-pg-client/java/#_pubsub) feature of Vertx PG client is currently not supported with YugabyteDB. From d203ce32622cc2c496e759ecf962b9bce0de2d16 Mon Sep 17 00:00:00 2001 From: Priyanshi Gupta Date: Tue, 16 Aug 2022 01:48:02 +0530 Subject: [PATCH 09/12] Update docs/content/preview/reference/drivers/ysql-client-drivers.md Co-authored-by: Aishwarya Chakravarthy --- docs/content/preview/reference/drivers/ysql-client-drivers.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/content/preview/reference/drivers/ysql-client-drivers.md b/docs/content/preview/reference/drivers/ysql-client-drivers.md index 664334f65b10..58f204eaf457 100644 --- a/docs/content/preview/reference/drivers/ysql-client-drivers.md +++ b/docs/content/preview/reference/drivers/ysql-client-drivers.md @@ -152,7 +152,7 @@ To get the latest versions for projects using [Apache Maven](https://maven.apach ### Vertx PG Client -[Vertx PG client](https://vertx.io/docs/vertx-pg-client/java/) is the client for PostgreSQL with the simple APIs for communicating with the Database. It is reactive and non-blocking client for handling the database connections with single threaded API. +[Vertx PG Client](https://vertx.io/docs/vertx-pg-client/java/) is the client for PostgreSQL with simple APIs to communicate with the database. It is a reactive and non-blocking client for handling the database connections with a single threaded API. For a tutorial on building a sample Java application with the Vertx PG Client, see [Build a Java application](../../../develop/build-apps/java/ysql-vertx-pg-client/). From 96b0c71cda26a12cc3b95be813087a9af76f8fc1 Mon Sep 17 00:00:00 2001 From: Priyanshi Gupta Date: Tue, 16 Aug 2022 12:50:25 +0530 Subject: [PATCH 10/12] changes after review --- .../develop/build-apps/java/ysql-vertx-pg-client.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/docs/content/preview/develop/build-apps/java/ysql-vertx-pg-client.md b/docs/content/preview/develop/build-apps/java/ysql-vertx-pg-client.md index 2ad5a856c5db..d4973e8aa990 100644 --- a/docs/content/preview/develop/build-apps/java/ysql-vertx-pg-client.md +++ b/docs/content/preview/develop/build-apps/java/ysql-vertx-pg-client.md @@ -79,7 +79,7 @@ showAsideToc: true [Vertx PG Client](https://vertx.io/docs/vertx-pg-client/java/) is the client for PostgreSQL with simple APIs to communicate with the database. It is a reactive and non-blocking client for handling the database connections with a single threaded API. -As this client is for PostgreSQL and YugabyteDB is wire compatible with PostgreSQL, it is also supported by YugabyteDB with one [limitation](#limitation). +Because Vertx is a PostgreSQL client and YugabyteDB is PostgreSQL compatible, it is supported by YugabyteDB with a [limitation](#limitation). ## Prerequisites @@ -102,6 +102,14 @@ This tutorial assumes that: $ cd vertx-pg-example ``` +1. Add the following below the `` element. + + ```xml + + 1.8 + 1.8 + + ``` 1. Add the following dependency for the Vertx PG Client within the `` element in the `pom.xml` file. @@ -211,4 +219,5 @@ This tutorial assumes that: ``` ## Limitation -[Pub/sub](https://vertx.io/docs/vertx-pg-client/java/#_pubsub) feature of Vertx PG client is currently not supported with YugabyteDB. +[PubSub](https://vertx.io/docs/vertx-pg-client/java/#_pubsub) feature of Vertx PG client is currently not supported with YugabyteDB. This limitation will be lifted when `LISTEN`/`NOTIFY` support is added to YugabyteDB. Tracking issue: [#1872](https://github.com/yugabyte/yugabyte-db/issues/1872). + From 21a6909d33b5055975f4cf815a4af0fc20f0a503 Mon Sep 17 00:00:00 2001 From: Priyanshi Gupta Date: Thu, 18 Aug 2022 13:26:08 +0530 Subject: [PATCH 11/12] more comments after review --- .../build-apps/java/ysql-vertx-pg-client.md | 20 +++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/content/preview/develop/build-apps/java/ysql-vertx-pg-client.md b/docs/content/preview/develop/build-apps/java/ysql-vertx-pg-client.md index d4973e8aa990..f1d8197ac6c9 100644 --- a/docs/content/preview/develop/build-apps/java/ysql-vertx-pg-client.md +++ b/docs/content/preview/develop/build-apps/java/ysql-vertx-pg-client.md @@ -1,17 +1,14 @@ --- title: Build a Java application that uses YSQL headerTitle: Build a Java application -linkTitle: Java +linkTitle: More examples description: Build a sample Java application with the Vertx PG Client and use the YSQL API to connect to and interact with YugabyteDB. menu: preview: - parent: build-apps - name: Java + parent: cloud-java identifier: java-10 weight: 550 -type: page -isTocNested: true -showAsideToc: true +type: docs ---
      @@ -85,13 +82,16 @@ Because Vertx is a PostgreSQL client and YugabyteDB is PostgreSQL compatible, it This tutorial assumes that: -- YugabyteDB up and running. Download and install YugabyteDB by following the steps in [Quick start](../../../../quick-start/). +- YugabyteDB up and running. Download and install the latest version of YugabyteDB by following the steps in [Quick start](../../../../quick-start/). +{{< note title="Note" >}} +The `executeBatch()` API of the Vertx PG Client is supported in the YugabyteDB version - `2.15.2.0-b0` onwards. +{{< /note >}} - Java Development Kit (JDK) 1.8, or later, is installed. - [Apache Maven](https://maven.apache.org/index.html) 3.3 or later, is installed. ## Create and configure the Java project -1. Create a project called "MySample". +1. Create a project called "vertx-pg-example". ```sh $ mvn archetype:generate \ @@ -102,7 +102,7 @@ This tutorial assumes that: $ cd vertx-pg-example ``` -1. Add the following below the `` element. +1. Add the following properties in the `pom.xml` file within the `` element. ```xml @@ -219,5 +219,5 @@ This tutorial assumes that: ``` ## Limitation -[PubSub](https://vertx.io/docs/vertx-pg-client/java/#_pubsub) feature of Vertx PG client is currently not supported with YugabyteDB. This limitation will be lifted when `LISTEN`/`NOTIFY` support is added to YugabyteDB. Tracking issue: [#1872](https://github.com/yugabyte/yugabyte-db/issues/1872). +[Pub/sub](https://vertx.io/docs/vertx-pg-client/java/#_pubsub) feature of Vertx PG client is currently not supported with YugabyteDB. This limitation will go away when `LISTEN`/`NOTIFY` support is added to YugabyteDB. See [GitHub issue](https://github.com/yugabyte/yugabyte-db/issues/1872). From 7bb14c7de07be47f82e7fcdfca1f1428a1940780 Mon Sep 17 00:00:00 2001 From: Priyanshi Gupta Date: Thu, 18 Aug 2022 14:28:50 +0530 Subject: [PATCH 12/12] more comments after review --- .../preview/develop/build-apps/java/ysql-vertx-pg-client.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/content/preview/develop/build-apps/java/ysql-vertx-pg-client.md b/docs/content/preview/develop/build-apps/java/ysql-vertx-pg-client.md index f1d8197ac6c9..0852df123b22 100644 --- a/docs/content/preview/develop/build-apps/java/ysql-vertx-pg-client.md +++ b/docs/content/preview/develop/build-apps/java/ysql-vertx-pg-client.md @@ -76,7 +76,7 @@ type: docs [Vertx PG Client](https://vertx.io/docs/vertx-pg-client/java/) is the client for PostgreSQL with simple APIs to communicate with the database. It is a reactive and non-blocking client for handling the database connections with a single threaded API. -Because Vertx is a PostgreSQL client and YugabyteDB is PostgreSQL compatible, it is supported by YugabyteDB with a [limitation](#limitation). +Since YugabyteDB is wire compatible with PostgreSQL, Vertx PG Client works with YugabyteDB as well. ## Prerequisites