Merge branch 'main' into 8319-hostless-urls-not-parsed-correctly

Author: eddumelendez

docs/modules/databases/clickhouse.md

@@ -1,5 +1,21 @@
 # Clickhouse Module
 
+Testcontainers module for [ClickHouse](https://hub.docker.com/r/clickhouse/clickhouse-server)
+
+## Usage example
+
+You can start a ClickHouse container instance from any Java application by using:
+
+<!--codeinclude-->
+[Container definition](../../../modules/clickhouse/src/test/java/org/testcontainers/clickhouse/ClickHouseContainerTest.java) inside_block:container
+<!--/codeinclude-->
+
+### Testcontainers JDBC URL
+
+`jdbc:tc:clickhouse:18.10.3:///databasename`
+
+See [JDBC](./jdbc.md) for documentation.
+
 ## Adding this module to your project dependencies
 
 Add the following dependency to your `pom.xml`/`build.gradle` file:

docs/modules/databases/cockroachdb.md

@@ -1,7 +1,23 @@
 # CockroachDB Module
 
+Testcontainers module for [CockroachDB](https://hub.docker.com/r/cockroachdb/cockroach)
+
+## Usage example
+
+You can start a CockroachDB container instance from any Java application by using:
+
+<!--codeinclude-->
+[Container definition](../../../modules/cockroachdb/src/test/java/org/testcontainers/junit/cockroachdb/SimpleCockroachDBTest.java) inside_block:container
+<!--/codeinclude-->
+
 See [Database containers](./index.md) for documentation and usage that is common to all relational database container types.
 
+### Testcontainers JDBC URL
+
+`jdbc:tc:cockroach:v21.2.3:///databasename`
+
+See [JDBC](./jdbc.md) for documentation.
+
 ## Adding this module to your project dependencies
 
 Add the following dependency to your `pom.xml`/`build.gradle` file:

docs/modules/databases/cratedb.md

@@ -1,7 +1,23 @@
 # CrateDB Module
 
+Testcontainers module for [CrateDB](https://hub.docker.com/_/crate)
+
+## Usage example
+
+You can start a CrateDB container instance from any Java application by using:
+
+<!--codeinclude-->
+[Container definition](../../../modules/cratedb/src/test/java/org/testcontainers/junit/cratedb/SimpleCrateDBTest.java) inside_block:container
+<!--/codeinclude-->
+
 See [Database containers](./index.md) for documentation and usage that is common to all relational database container types.
 
+### Testcontainers JDBC URL
+
+`jdbc:tc:cratedb:5.2.3:///databasename`
+
+See [JDBC](./jdbc.md) for documentation.
+
 ## Adding this module to your project dependencies
 
 Add the following dependency to your `pom.xml`/`build.gradle` file:

docs/modules/databases/databend.md

@@ -1,5 +1,21 @@
 # Databend Module
 
+Testcontainers module for [Databend](https://hub.docker.com/r/datafuselabs/databend)
+
+## Usage example
+
+You can start a Databend container instance from any Java application by using:
+
+<!--codeinclude-->
+[Container definition](../../../modules/databend/src/test/java/org/testcontainers/databend/DatabendContainerTest.java) inside_block:container
+<!--/codeinclude-->
+
+### Testcontainers JDBC URL
+
+`jdbc:tc:databend:v1.2.615:///databasename`
+
+See [JDBC](./jdbc.md) for documentation.
+
 ## Adding this module to your project dependencies
 
 Add the following dependency to your `pom.xml`/`build.gradle` file:

docs/modules/databases/db2.md

@@ -1,34 +1,28 @@
 # DB2 Module
 
-!!! note
-    This module is INCUBATING. While it is ready for use and operational in the current version of Testcontainers, it is possible that it may receive breaking changes in the future. See [our contributing guidelines](/contributing/#incubating-modules) for more information on our incubating modules policy.
-
-See [Database containers](./index.md) for documentation and usage that is common to all relational database container types.
+Testcontainers module for [DB2](https://hub.docker.com/r/ibmcom/db2)
 
 ## Usage example
 
-Running DB2 as a stand-in for in a test:
-
-```java
-public class SomeTest {
-
-    @ClassRule
-    public Db2Container db2 = new Db2Container()
-        .acceptLicense();
-    
-    @Test
-    public void someTestMethod() {
-        String url = db2.getJdbcUrl();
+You can start a DB2 container instance from any Java application by using:
 
-        ... create a connection and run test as normal
-    }
-```
+<!--codeinclude-->
+[Container definition](../../../modules/db2/src/test/java/org/testcontainers/junit/db2/SimpleDb2Test.java) inside_block:container
+<!--/codeinclude-->
 
 !!! warning "EULA Acceptance"
     Due to licencing restrictions you are required to accept an EULA for this container image. To indicate that you accept the DB2 image EULA, call the `acceptLicense()` method, or place a file at the root of the classpath named `container-license-acceptance.txt`, e.g. at `src/test/resources/container-license-acceptance.txt`. This file should contain the line: `ibmcom/db2:11.5.0.0a` (or, if you are overriding the docker image name/tag, update accordingly).
 
     Please see the [`ibmcom/db2` image documentation](https://hub.docker.com/r/ibmcom/db2) for a link to the EULA document.
 
+See [Database containers](./index.md) for documentation and usage that is common to all relational database container types.
+
+### Testcontainers JDBC URL
+
+`jdbc:tc:db2:11.5.0.0a:///databasename`
+
+See [JDBC](./jdbc.md) for documentation.
+
 ## Adding this module to your project dependencies
 
 Add the following dependency to your `pom.xml`/`build.gradle` file:

docs/modules/databases/jdbc.md

@@ -37,11 +37,11 @@ Insert `tc:` after `jdbc:` as follows. Note that the hostname, port and database
 
 #### Using CrateDB
 
-`jdbc:tc:cratedb:5.2.3//localhost:5432/crate`
+`jdbc:tc:cratedb:5.2.3:///databasename`
 
 #### Using DB2
 
-`jdbc:tc:db2:11.5.0.0a//localhost:5432/crate`
+`jdbc:tc:db2:11.5.0.0a:///databasename`
 
 #### Using MariaDB
 

docs/modules/databases/mariadb.md

@@ -1,7 +1,23 @@
 # MariaDB Module
 
+Testcontainers module for [MariaDB](https://hub.docker.com/_/mariadb)
+
+## Usage example
+
+You can start a MySQL container instance from any Java application by using:
+
+<!--codeinclude-->
+[Container definition](../../../modules/mariadb/src/test/java/org/testcontainers/junit/mariadb/SimpleMariaDBTest.java) inside_block:container
+<!--/codeinclude-->
+
 See [Database containers](./index.md) for documentation and usage that is common to all relational database container types.
 
+### Testcontainers JDBC URL
+
+`jdbc:tc:mariadb:10.3.39:///databasename`
+
+See [JDBC](./jdbc.md) for documentation.
+
 ## MariaDB `root` user password
 
 If no custom password is specified, the container will use the default user password `test` for the `root` user as well.

docs/modules/databases/mssqlserver.md

@@ -1,30 +1,28 @@
 # MS SQL Server Module
 
-See [Database containers](./index.md) for documentation and usage that is common to all relational database container types.
+Testcontainers module for [MS SQL Server](https://mcr.microsoft.com/en-us/artifact/mar/mssql/server/)
 
 ## Usage example
 
-Running MS SQL Server as a stand-in for in a test:
-
-```java
-public class SomeTest {
+You can start a MS SQL Server container instance from any Java application by using:
 
-    @Rule
-    public MSSQLServerContainer mssqlserver = new MSSQLServerContainer()
-        .acceptLicense();
-    
-    @Test
-    public void someTestMethod() {
-        String url = mssqlserver.getJdbcUrl();
-
-        ... create a connection and run test as normal
-```
+<!--codeinclude-->
+[Container definition](../../../modules/mssqlserver/src/test/java/org/testcontainers/junit/mssqlserver/SimpleMSSQLServerTest.java) inside_block:container
+<!--/codeinclude-->
 
 !!! warning "EULA Acceptance"
     Due to licencing restrictions you are required to accept an EULA for this container image. To indicate that you accept the MS SQL Server image EULA, call the `acceptLicense()` method, or place a file at the root of the classpath named `container-license-acceptance.txt`, e.g. at `src/test/resources/container-license-acceptance.txt`. This file should contain the line: `mcr.microsoft.com/mssql/server:2017-CU12` (or, if you are overriding the docker image name/tag, update accordingly).
 
     Please see the [`microsoft-mssql-server` image documentation](https://hub.docker.com/_/microsoft-mssql-server#environment-variables) for a link to the EULA document.
 
+See [Database containers](./index.md) for documentation and usage that is common to all relational database container types.
+
+### Testcontainers JDBC URL
+
+`jdbc:tc:sqlserver:2017-CU12:///databasename`
+
+See [JDBC](./jdbc.md) for documentation.
+
 ## Adding this module to your project dependencies
 
 Add the following dependency to your `pom.xml`/`build.gradle` file:

docs/modules/databases/mysql.md

@@ -1,7 +1,23 @@
 # MySQL Module
 
+Testcontainers module for [MySQL](https://hub.docker.com/_/mysql)
+
+## Usage example
+
+You can start a MySQL container instance from any Java application by using:
+
+<!--codeinclude-->
+[Container definition](../../../modules/mysql/src/test/java/org/testcontainers/junit/mysql/SimpleMySQLTest.java) inside_block:container
+<!--/codeinclude-->
+
 See [Database containers](./index.md) for documentation and usage that is common to all relational database container types.
 
+### Testcontainers JDBC URL
+
+`jdbc:tc:mysql:8.0.36:///databasename`
+
+See [JDBC](./jdbc.md) for documentation.
+
 ## Overriding MySQL my.cnf settings
 
 For MySQL databases, it is possible to override configuration settings using resources on the classpath. Assuming `somepath/mysql_conf_override`

docs/modules/databases/oceanbase.md

@@ -1,7 +1,23 @@
 # OceanBase Module
 
+Testcontainers module for [OceanBase](https://hub.docker.com/r/oceanbase/oceanbase-ce)
+
+## Usage example
+
+You can start an OceanBase container instance from any Java application by using:
+
+<!--codeinclude-->
+[Container definition](../../../modules/oceanbase/src/test/java/org/testcontainers/oceanbase/SimpleOceanBaseCETest.java) inside_block:container
+<!--/codeinclude-->
+
 See [Database containers](./index.md) for documentation and usage that is common to all relational database container types.
 
+### Testcontainers JDBC URL
+
+`jdbc:tc:oceanbasece:4.2.1-lts:///databasename`
+
+See [JDBC](./jdbc.md) for documentation.
+
 ## Adding this module to your project dependencies
 
 Add the following dependency to your `pom.xml`/`build.gradle` file: