Back to Testcontainers Java

YugabyteDB Module

docs/modules/databases/yugabytedb.md

2.0.52.0 KB
Original Source

YugabyteDB Module

Testcontainers module for YugabyteDB

See Database containers for documentation and usage that is common to all database container types.

YugabyteDB supports two APIs.

  • Yugabyte Structured Query Language YSQL is a fully-relational API that is built by the PostgreSQL code
  • Yugabyte Cloud Query Language YCQL is a semi-relational SQL API that has its roots in the Cassandra Query Language

Usage example

YSQL API

<!--codeinclude-->

Creating a YSQL container inside_block:creatingYSQLContainer

<!--/codeinclude-->

Testcontainers JDBC URL

jdbc:tc:yugabyte:2.14.4.0-b26:///databasename

See JDBC for documentation.

YCQL API

<!--codeinclude-->

Creating a YCQL container inside_block:creatingYCQLContainer

<!--/codeinclude-->

Adding this module to your project dependencies

Add the following dependency to your pom.xml/build.gradle file:

=== "Gradle" groovy testImplementation "org.testcontainers:testcontainers-yugabytedb:{{latest_version}}" === "Maven" xml <dependency> <groupId>org.testcontainers</groupId> <artifactId>testcontainers-yugabytedb</artifactId> <version>{{latest_version}}</version> <scope>test</scope> </dependency>

!!! hint Adding this Testcontainers library JAR will not automatically add the Yugabytedb driver JAR to your project. You should ensure that your project has the Yugabytedb driver as a dependency, if you plan on using it. Refer to the driver page YSQL and YCQL for instructions.