Update readme files

Author: alejandro-du

README.md

@@ -4,17 +4,49 @@
 
 This repository contains examples on how to connect to [MariaDB](https://mariadb.com) databases using a combination of different Java libraries and frameworks.
 
+## Before you run the examples
+
+1. Make sure you have a MariaDB Server ([Enterprise](https://mariadb.com/products/enterprise/) or [Community](https://mariadb.com/products/community-server/)) running. If you don't have a MariaDB server running, you can easily run one using [Docker](https://hub.docker.com/u/mariadb):
+
+```Shell
+docker run --name mariadb --detach --publish 3306:3306 --env MARIADB_ROOT_PASSWORD='RootPassword123!' mariadb
+```
+
+Alternatively, you can [Download](https://mariadb.com/downloads/) and install the server directly on your OS.
+
+2. Connect to the database using [MariaDB Shell](https://mariadb.com/downloads/tools/shell/):
+
+```shell
+mariadb-shell --dsn mariadb://root:'RootPassword123!'@127.0.0.1
+```
+
+Alternatively, you can use any database client compatible with MariaDB.
+
+3. Prepare the database schema and user as follows:
+
+```sql
+CREATE DATABASE demo;
+CREATE USER 'user'@'%' IDENTIFIED BY 'Password123!';
+GRANT SELECT, INSERT, UPDATE, DELETE, DROP ON demo.* TO 'user'@'%';
+
+CREATE TABLE demo.programming_language(
+	pl_id INT PRIMARY KEY AUTO_INCREMENT,
+	pl_name VARCHAR(50) NOT NULL UNIQUE,
+	pl_rating INT
+);
+```
+
 ## JDBC & JPA
 
 - [JDBC (Java Database Connectivity)](jdbc/): The foundational technology used for persistence in Java.
-- [JPA/Hibernate](jpa-hibernate): The de-facto standard for consuming databases from Java apps.
+- [JPA/Hibernate](jpa-hibernate/): The de-facto standard for consuming databases from Java apps.
 
 ## Spring Boot
 
 - [Spring Boot Data JPA](spring-boot-jpa/): Spring-based programming model for data access on top of JPA.
 - [R2DBC ➚](https://github.com/mariadb-developers/reactive-programming-java-examples): Reactive database connectivity.
 - [jOOQ](spring-boot-jooq/): Type-safe SQL queries in Java.
-- [MyBatis](spring-boot-mybatis): Map SQL results to Java methods in a simple way.
+- [MyBatis](spring-boot-mybatis/): Map SQL results to Java methods in a simple way.
 
 ## Jakarta EE (Java EE)
 

jakarta-ee/README.md

@@ -74,38 +74,10 @@ List<ProgrammingLanguage> programmingLanguages = query.getResultList();
 - [MariaDB Connector/J](https://mariadb.com/downloads/connectors/connectors-data-access/java8-connector) 3.2.0 or later
 - An SQL client tool like [MariaDB Shell](https://mariadb.com/downloads/tools/), DBeaver, or an [SQL integration](https://www.youtube.com/watch?v=rJYUTxD-2-M) for your IDE
 - MariaDB server ([Enterprise](https://mariadb.com/products/enterprise/) or [Community](https://mariadb.com/products/community-server/))
-## Preparing the database
-
-If you don't have a MariaDB server running, you can easily run using [Docker](https://hub.docker.com/u/mariadb):
-
-```shell
-docker run --name mariadb -d -p 3306:3306 -e MARIADB_ROOT_PASSWORD='RootPassword123!' mariadb
-```
-
-Alternatively, you can [Download](https://mariadb.com/downloads/) and install the server directly on your OS.
 
-Connect to the database:
-
-```shell
-mariadb-shell --dsn mariadb://root:'RootPassword123!'@127.0.0.1
-```
-
-Alternatively, you can use any database client compatible with MariaDB.
-
-Execute the following SQL statements to create a user for the JakartaEE application, a database (or schema) and a table:
-
-```sql
-CREATE DATABASE demo;
-CREATE USER 'user'@'%' IDENTIFIED BY 'Password123!';
-GRANT SELECT, INSERT, UPDATE, DELETE, DROP ON demo.* TO 'user'@'%';
+## Preparing the database
 
-USE demo;
-CREATE TABLE programming_language(
-	pl_id INT PRIMARY KEY AUTO_INCREMENT,
-	pl_name VARCHAR(50) NOT NULL UNIQUE,
-	pl_rating INT
-);
-```
+See the instructions [here](../README.md).
 
 ## Configuring Glassfish
 
@@ -138,10 +110,6 @@ In the JDBC Connection Pool list, click on **MariaDB**, select the **Additional
  * **user**: `user`
  * **password**: `Password123!`
 
-> If you are using [MariaDB SkySQL](https://mariadb.com/products/skysql/), enable SSL and specify the path to the CA chain file that you can download from the [SkySQL Portal](https://cloud.mariadb.com):
-> 
-> `jdbc:mariadb://demo-db0000xxxx.mdb000xxxx.db.skysql.net:3306/demo?sslMode=verify-ca&serverSslCert=/path/to/your/skysql_chain.pem`
-
 Go to **Resources > JDBC > JDBC Resources**. Click **New** and fill in the following details:
 
 * **JNDI Name**: `mariadb-database`
@@ -163,9 +131,9 @@ To deploy the WAR file to GlassFish using the Administration Console, go to **Ap
 
 ## Check the output
 
-Go to **Monitoring Data > server** and click either the **View Log Files** or **View Raw Log** button. You should be able to see log messages confirming that data was deleted, created, and read. You can also connect to the database and see the data in the `programming_language` table.
+Go to **Monitoring Data > server** and click either the **View Log Files** or **View Raw Log** button. You should be able to see log messages confirming that data was deleted, created, and read.
 
-Connect to the database:
+You can also connect to the database and see the data in the `programming_language` table:
 
 ```shell
 mariadb-shell --dsn mariadb://user:'Password123!'@127.0.0.1

jdbc/README.md

@@ -22,6 +22,8 @@ pool included with the MariaDB JDBC driver:
 See the **README.md** files in each subdirectory to learn how to run the
 examples.
 
+See [this](../README.md) to set up the database.
+
 ## Support and Contribution
 
 Please feel free to submit PR's, issues or requests to this project

jdbc/mariadb-pool/README.md

@@ -10,11 +10,10 @@ Change `Service` constructor to use a `MariaDbPoolDataSource` and run the app ag
 
 ## Requirements
 
-- Java 17 or later. Previous versions should work (update the version
+- Java 21 or later. Previous versions should work (update the version
   in the **pom.xml** file).
 - [Apache Maven](https://maven.apache.org).
-- MariaDB server. If you don't want to install
-  anything extra, try creating a free [SkySQL account](https://cloud.mariadb.com).
+- MariaDB server.
 - An SQL client tool like `mariadb`, DBeaver, or an SQL integration for
   your IDE.
 

jdbc/mariadb-pool/src/main/java/com/example/Service.java

@@ -45,13 +45,6 @@ private Service() throws SQLException {
 		dataSource.setUser("user");
 		dataSource.setPassword("Password123!");
 		this.dataSource = dataSource;
-		/*
-		 * If you are using MariaDB SkySQL (https://mariadb.com/products/skysql),
-		 * enable SSL and specify the path to the CA chain file that you can download
-		 * from the SkySQL Portal (https://cloud.mariadb.com):
-		 * jdbc:mariadb://demo-db0000xxxx.mdb000xxxx.db.skysql.net:5047/demo?sslMode=verify-ca&
-		 * serverSslCert=/path/to/your/skysql_chain.pem
-		 */
 	}
 
 	public static synchronized Service getInstance() throws SQLException {

jdbc/part1/README.md

@@ -17,7 +17,7 @@ the latest version):
 </dependency>
 ```
 
-Open the connection (alternatively use a try-catch block to close the connection automatically):
+Open the connection (alternatively use `try` with resources to close the connection automatically):
 
 ```java
 Connection connection = DriverManager.getConnection(
@@ -26,39 +26,30 @@ Connection connection = DriverManager.getConnection(
 );
 ```
 
-> If you are using [MariaDB SkySQL](https://mariadb.com/products/skysql/), enable SSL and specify the path to the CA chain file that you can download from the [SkySQL Portal](https://cloud.mariadb.com):
-> 
-> `jdbc:mariadb://demo-db0000xxxx.mdb000xxxx.db.skysql.net:5047/database_name?sslMode=verify-ca&serverSslCert=/path/to/your/skysql_chain.pem`
-
-Close the connection (if not using a try-catch block):
+Close the connection (if not using a `try` with resources block):
 
 ```java
 connection.close();
 ```
 
 ## Requirements
 
-- Java 17 or later. Previous versions should work (update the version
+- Java 21 or later. Previous versions should work (update the version
   in the **pom.xml** file).
 - [Apache Maven](https://maven.apache.org).
-- MariaDB server. If you don't want to install
-  anything extra, try creating a free [SkySQL account](https://cloud.mariadb.com).
+- MariaDB server.
 - An SQL client tool like `mariadb`, DBeaver, or an SQL integration for
   your IDE.
 
-## Running the app
+## Preparing the database
 
-Prepare the database:
+See the instructions [here](../../README.md).
 
-```sql
-CREATE DATABASE demo;
-CREATE USER 'user'@'%';
-GRANT ALL ON demo.* TO 'user'@'%' IDENTIFIED BY 'Password123!';
-```
+## Running the app
 
 Run the following from the command line:
 
-```
+```Shell
 git clone [email protected]:mariadb-developers/java-quickstart.git
 cd java-quickstart/jdbc/part1/
 mvn package

jdbc/part1/src/main/java/com/example/Application.java

@@ -31,12 +31,6 @@ private static void initDatabaseConnection() throws SQLException {
 				"jdbc:mariadb://127.0.0.1:3306/demo",
 				"user", "Password123!");
 		System.out.println("Connection valid: " + connection.isValid(5));
-		/*
-		If you are using MariaDB SkySQL (https://mariadb.com/products/skysql),
-		enable SSL and specify the path to the CA chain file that you can download
-		from the SkySQL Portal (https://cloud.mariadb.com):
-			jdbc:mariadb://demo-db0000xxxx.mdb000xxxx.db.skysql.net:5047/demo?sslMode=verify-ca&serverSslCert=/path/to/your/skysql_chain.pem
-		*/
 	}
 
 	private static void closeDatabaseConnection() throws SQLException {

jdbc/part2/README.md

@@ -36,40 +36,44 @@ try (PreparedStatement statement = connection.prepareStatement("""
 
 ## Requirements
 
-- Java 17 or later. Previous versions should work (update the version
+- Java 21 or later. Previous versions should work (update the version
   in the **pom.xml** file).
 - [Apache Maven](https://maven.apache.org).
-- MariaDB server. If you don't want to install
-  anything extra, try creating a free [SkySQL account](https://cloud.mariadb.com).
+- MariaDB server.
 - An SQL client tool like `mariadb`, DBeaver, or an SQL integration for
   your IDE.
 
-## Running the app
-
-Prepare the database:
+## Preparing the database
 
-```sql
-CREATE DATABASE demo;
-CREATE USER 'user'@'%';
-GRANT ALL ON demo.* TO 'user'@'%' IDENTIFIED BY 'password';
+See the instructions [here](../../README.md).
 
-
-USE demo;
-CREATE TABLE programming_language(
-    name VARCHAR(50) NOT NULL UNIQUE,
-    rating INT
-);
-```
+## Running the app
 
 Run the following from the command line:
 
-```
+```Shell
 git clone [email protected]:mariadb-developers/java-quickstart.git
 cd java-quickstart/jdbc/part2/
 mvn package
 java -jar  java -jar target/jdbc-demo-1.0-SNAPSHOT.jar
 ```
 
+## Check the output
+
+You should see the output in the terminal.
+
+You can also connect to the database and see the data in the `programming_language` table:
+
+```shell
+mariadb-shell --dsn mariadb://user:'Password123!'@127.0.0.1
+```
+
+Run the following query:
+
+```SQL
+SELECT * FROM demo.programming_languages;
+```
+
 ## Tutorial
 
 Read the [tutorial](https://dzone.com/articles/jdbc-tutorial-part-2-running-sql-queries) or watch the video for detailed steps on how to implement this example from scratch:

jdbc/part2/src/main/java/com/example/Application.java

@@ -1,6 +1,10 @@
 package com.example;
 
-import java.sql.*;
+import java.sql.Connection;
+import java.sql.DriverManager;
+import java.sql.PreparedStatement;
+import java.sql.ResultSet;
+import java.sql.SQLException;
 
 public class Application {
 
@@ -102,13 +106,6 @@ private static void initDatabaseConnection() throws SQLException {
 				"jdbc:mariadb://localhost:3306/demo",
 				"user", "Password123!");
 		System.out.println("Connection valid: " + connection.isValid(5));
-		/*
-		 * If you are using MariaDB SkySQL (https://mariadb.com/products/skysql),
-		 * enable SSL and specify the path to the CA chain file that you can download
-		 * from the SkySQL Portal (https://cloud.mariadb.com):
-		 * jdbc:mariadb://demo-db0000xxxx.mdb000xxxx.db.skysql.net:5047/demo?sslMode=verify-ca&
-		 * serverSslCert=/path/to/your/skysql_chain.pem
-		 */
 	}
 
 	private static void closeDatabaseConnection() throws SQLException {

jdbc/part3/README.md

@@ -23,10 +23,6 @@ dataSource.username=user
 dataSource.password=Password123!
 ```
 
-> If you are using [MariaDB SkySQL](https://mariadb.com/products/skysql/), enable SSL and specify the path to the CA chain file that you can download from the [SkySQL Portal](https://cloud.mariadb.com):
-> 
-> `jdbc:mariadb://demo-db0000xxxx.mdb000xxxx.db.skysql.net:5047/database_name?sslMode=verify-ca&serverSslCert=/path/to/your/skysql_chain.pem`
-
 Create a `DataSource` at application start:
 
 ```java
@@ -50,40 +46,40 @@ dataSource.close();
 
 ## Requirements
 
-- Java 17 or later. Previous versions should work (update the version
+- Java 21 or later. Previous versions should work (update the version
   in the **pom.xml** file).
 - [Apache Maven](https://maven.apache.org).
-- MariaDB server. If you don't want to install
-  anything extra, try creating a free [SkySQL account](https://cloud.mariadb.com).
+- MariaDB server.
 - An SQL client tool like `mariadb`, DBeaver, or an SQL integration for
   your IDE.
 
-## Running the app
-
-Prepare the database:
-
-```sql
-CREATE DATABASE demo;
-CREATE USER 'user'@'%';
-GRANT ALL ON demo.* TO 'user'@'%' IDENTIFIED BY 'password';
+## Preparing the database
 
+See the instructions [here](../../README.md).
 
-USE demo;
-CREATE TABLE programming_language(
-    name VARCHAR(50) NOT NULL UNIQUE,
-    rating INT
-);
-```
+## Running the app
 
 Run the following from the command line:
 
-```
+```Shell
 git clone [email protected]:mariadb-developers/java-quickstart.git
 cd java-quickstart/jdbc/part3/
 mvn package
 java -jar  java -jar target/jdbc-demo-1.0-SNAPSHOT.jar
 ```
 
-## Tutorial
+## Check the output
 
-*(Work in progress. Stay tuned!)*
+You should see the output in the terminal.
+
+You can also connect to the database and see the data in the `programming_language` table:
+
+```shell
+mariadb-shell --dsn mariadb://user:'Password123!'@127.0.0.1
+```
+
+Run the following query:
+
+```SQL
+SELECT * FROM demo.programming_languages;
+```

jdbc/part3/src/main/resources/database.properties

@@ -2,9 +2,3 @@
 jdbcUrl=jdbc:mariadb://127.0.0.1:3306/demo
 username=user
 password=Password123!
-
-# If you are using MariaDB SkySQL (https://mariadb.com/products/skysql),
-# enable SSL and specify the path to the CA chain file that you can download
-# from the SkySQL Portal (https://cloud.mariadb.com):
-#
-# jdbc:mariadb://demo-db0000xxxx.mdb000xxxx.db.skysql.net:5047/demo?sslMode=verify-ca&serverSslCert=/path/to/your/skysql_chain.pem