Skip to content

Commit

Permalink
Add doc page on DB2 module
Browse files Browse the repository at this point in the history
  • Loading branch information
aguibert committed Jul 13, 2019
1 parent 7208542 commit 5e6e49b
Show file tree
Hide file tree
Showing 2 changed files with 51 additions and 0 deletions.
47 changes: 47 additions & 0 deletions docs/modules/databases/db2.md
@@ -0,0 +1,47 @@
# DB2 Module

See [Database containers](./index.md) for documentation and usage that is common to all relational database container types.

## 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();

... create a connection and run test as normal
}
```

!!! 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.

## Adding this module to your project dependencies

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

```groovy tab='Gradle'
testCompile "org.testcontainers:db2:{{latest_version}}"
```
```xml tab='Maven'
<dependency>
<groupId>org.testcontainers</groupId>
<artifactId>db2</artifactId>
<version>{{latest_version}}</version>
<scope>test</scope>
</dependency>
```
!!! hint
Adding this Testcontainers library JAR will not automatically add a database driver JAR to your project. You should ensure that your project also has a suitable database driver as a dependency.
Expand Up @@ -65,6 +65,10 @@ protected void configure() {
addEnv("ARCHIVE_LOGS", "false");
}

/**
* Accepts the license for the DB2 container by setting the LICENSE=accept
* variable as described at <a href="https://hub.docker.com/r/ibmcom/db2">https://hub.docker.com/r/ibmcom/db2</a>
*/
public SELF acceptLicense() {
addEnv("LICENSE", "accept");
return self();
Expand Down

0 comments on commit 5e6e49b

Please sign in to comment.