From 329e972af94b642b286f201d42bf6f3fbe3aa0c4 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Edd=C3=BA=20Mel=C3=A9ndez=20Gonzales?=
 <eddu.melendez@gmail.com>
Date: Tue, 20 Feb 2024 12:44:45 -0500
Subject: [PATCH] Improve postgres docs (#8340)

Display how to use other compatible images such as `pgvector`, `postgis`, `timescaledb`.
---
 docs/modules/databases/postgres.md            | 22 +++++++
 .../containers/CompatibleImageTest.java       | 64 +++++++++++++++++++
 2 files changed, 86 insertions(+)
 create mode 100644 modules/postgresql/src/test/java/org/testcontainers/containers/CompatibleImageTest.java

diff --git a/docs/modules/databases/postgres.md b/docs/modules/databases/postgres.md
index b7632d78293..d07e77937b9 100644
--- a/docs/modules/databases/postgres.md
+++ b/docs/modules/databases/postgres.md
@@ -2,6 +2,28 @@
 
 See [Database containers](./index.md) for documentation and usage that is common to all relational database container types.
 
+## Compatible images
+
+`PostgreSQLContainer` can also be used with the following images:
+
+* [pgvector/pgvector](https://hub.docker.com/r/pgvector/pgvector)
+
+<!--codeinclude-->
+[Using pgvector](../../../modules/postgresql/src/test/java/org/testcontainers/containers/CompatibleImageTest.java) inside_block:pgvectorContainer
+<!--/codeinclude-->
+
+* [postgis/postgis](https://registry.hub.docker.com/r/postgis/postgis)
+
+<!--codeinclude-->
+[Using PostGIS](../../../modules/postgresql/src/test/java/org/testcontainers/containers/CompatibleImageTest.java) inside_block:postgisContainer
+<!--/codeinclude-->
+
+* [timescale/timescaledb](https://hub.docker.com/r/timescale/timescaledb)
+
+<!--codeinclude-->
+[Using TimescaleDB](../../../modules/postgresql/src/test/java/org/testcontainers/containers/CompatibleImageTest.java) inside_block:timescaledbContainer
+<!--/codeinclude-->
+
 ## Adding this module to your project dependencies
 
 Add the following dependency to your `pom.xml`/`build.gradle` file:
diff --git a/modules/postgresql/src/test/java/org/testcontainers/containers/CompatibleImageTest.java b/modules/postgresql/src/test/java/org/testcontainers/containers/CompatibleImageTest.java
new file mode 100644
index 00000000000..2bb1c6c3d54
--- /dev/null
+++ b/modules/postgresql/src/test/java/org/testcontainers/containers/CompatibleImageTest.java
@@ -0,0 +1,64 @@
+package org.testcontainers.containers;
+
+import org.junit.Test;
+import org.testcontainers.db.AbstractContainerDatabaseTest;
+import org.testcontainers.utility.DockerImageName;
+
+import java.sql.ResultSet;
+import java.sql.SQLException;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+public class CompatibleImageTest extends AbstractContainerDatabaseTest {
+
+    @Test
+    public void pgvector() throws SQLException {
+        try (
+            // pgvectorContainer {
+            PostgreSQLContainer<?> pgvector = new PostgreSQLContainer<>(
+                DockerImageName.parse("pgvector/pgvector:pg16").asCompatibleSubstituteFor("postgres")
+            )
+            // }
+        ) {
+            pgvector.start();
+
+            ResultSet resultSet = performQuery(pgvector, "SELECT 1");
+            int resultSetInt = resultSet.getInt(1);
+            assertThat(resultSetInt).as("A basic SELECT query succeeds").isEqualTo(1);
+        }
+    }
+
+    @Test
+    public void postgis() throws SQLException {
+        try (
+            // postgisContainer {
+            PostgreSQLContainer<?> postgis = new PostgreSQLContainer<>(
+                DockerImageName.parse("postgis/postgis:16-3.4-alpine").asCompatibleSubstituteFor("postgres")
+            )
+            // }
+        ) {
+            postgis.start();
+
+            ResultSet resultSet = performQuery(postgis, "SELECT 1");
+            int resultSetInt = resultSet.getInt(1);
+            assertThat(resultSetInt).as("A basic SELECT query succeeds").isEqualTo(1);
+        }
+    }
+
+    @Test
+    public void timescaledb() throws SQLException {
+        try (
+            // timescaledbContainer {
+            PostgreSQLContainer<?> timescaledb = new PostgreSQLContainer<>(
+                DockerImageName.parse("timescale/timescaledb:2.14.2-pg16").asCompatibleSubstituteFor("postgres")
+            )
+            // }
+        ) {
+            timescaledb.start();
+
+            ResultSet resultSet = performQuery(timescaledb, "SELECT 1");
+            int resultSetInt = resultSet.getInt(1);
+            assertThat(resultSetInt).as("A basic SELECT query succeeds").isEqualTo(1);
+        }
+    }
+}