CockroachDB

Author: cristianrgreco

docs/modules/azurite.md

@@ -44,20 +44,20 @@ Choose an image from [Docker Hub](https://hub.docker.com/r/microsoft/azure-stora
 [](../../packages/modules/azurite/src/azurite-container.test.ts) inside_block:createAndInsertOnTable
 <!--/codeinclude-->
 
-### Custom credentials
+### In memory persistence
 
 <!--codeinclude-->
-[](../../packages/modules/azurite/src/azurite-container.test.ts) inside_block:customCredentials
+[](../../packages/modules/azurite/src/azurite-container.test.ts) inside_block:inMemoryPersistence
 <!--/codeinclude-->
 
-### Custom ports
+### With credentials
 
 <!--codeinclude-->
-[](../../packages/modules/azurite/src/azurite-container.test.ts) inside_block:customPorts
+[](../../packages/modules/azurite/src/azurite-container.test.ts) inside_block:customCredentials
 <!--/codeinclude-->
 
-### In memory persistence
+### With ports
 
 <!--codeinclude-->
-[](../../packages/modules/azurite/src/azurite-container.test.ts) inside_block:inMemoryPersistence
+[](../../packages/modules/azurite/src/azurite-container.test.ts) inside_block:customPorts
 <!--/codeinclude-->

docs/modules/cassandra.md

@@ -24,13 +24,13 @@ Choose an image from [Docker Hub](https://hub.docker.com/_/cassandra) and substi
 [](../../packages/modules/cassandra/src/cassandra-container.test.ts) inside_block:connectWithDefaultCredentials
 <!--/codeinclude-->
 
-### Custom credentials
+### With credentials
 
 <!--codeinclude-->
 [](../../packages/modules/cassandra/src/cassandra-container.test.ts) inside_block:connectWithCustomCredentials
 <!--/codeinclude-->
 
-### Custom datacenter / rack
+### With datacenter/rack
 
 <!--codeinclude-->
 [](../../packages/modules/cassandra/src/cassandra-container.test.ts) inside_block:customDataCenterAndRack

docs/modules/chromadb.md

@@ -44,4 +44,4 @@ Choose an image from [Docker Hub](https://hub.docker.com/r/chromadb/chroma) and
 
 <!--codeinclude-->
 [](../../packages/modules/chromadb/src/chromadb-container.test.ts) inside_block:chromaAuth
-<!--/codeinclude-->_
+<!--/codeinclude-->

docs/modules/clickhouse.md

@@ -30,13 +30,13 @@ Choose an image from [Docker Hub](https://hub.docker.com/r/clickhouse/clickhouse
 [](../../packages/modules/clickhouse/src/clickhouse-container.test.ts) inside_block:connectWithUrl
 <!--/codeinclude-->
 
-### Connect with credentials
+### With credentials
 
 <!--codeinclude-->
 [](../../packages/modules/clickhouse/src/clickhouse-container.test.ts) inside_block:connectWithUsernameAndPassword
 <!--/codeinclude-->
 
-### Set database
+### With database
 
 <!--codeinclude-->
 [](../../packages/modules/clickhouse/src/clickhouse-container.test.ts) inside_block:setDatabase

docs/modules/cockroachdb.md

@@ -1,7 +1,4 @@
-# CockroachDB Module
-
-[CockroachDB](https://github.com/cockroachdb/cockroach) is a cloud-native, postgresql compatible, distributed SQL database designed to build, scale, and manage modern, data-intensive applications.
-
+# CockroachDB
 
 ## Install
 
@@ -11,18 +8,40 @@ npm install @testcontainers/cockroachdb --save-dev
 
 ## Examples
 
+These examples use the following libraries:
+
+- [pg](https://www.npmjs.com/package/pg)
+
+        npm install pg
+
+- [@types/pg](https://www.npmjs.com/package/@types/pg)
+
+        npm install @types/pg
+
+---
+
+Choose an image from [Docker Hub](https://hub.docker.com/r/cockroachdb/cockroach) and substitute `IMAGE`.
+
+### Execute a query
+ 
 <!--codeinclude-->
-[Connect and execute query:](../../packages/modules/cockroachdb/src/cockroachdb-container.test.ts) inside_block:connect
+[](../../packages/modules/cockroachdb/src/cockroachdb-container.test.ts) inside_block:cockroachConnect
 <!--/codeinclude-->
 
+### Connect with URI
+
 <!--codeinclude-->
-[Connect and execute query using URI:](../../packages/modules/cockroachdb/src/cockroachdb-container.test.ts) inside_block:uriConnect
+[](../../packages/modules/cockroachdb/src/cockroachdb-container.test.ts) inside_block:uriConnect
 <!--/codeinclude-->
 
+### With database
+
 <!--codeinclude-->
-[Set database:](../../packages/modules/cockroachdb/src/cockroachdb-container.test.ts) inside_block:setDatabase
+[](../../packages/modules/cockroachdb/src/cockroachdb-container.test.ts) inside_block:setDatabase
 <!--/codeinclude-->
 
+### With username
+
 <!--codeinclude-->
-[Set username:](../../packages/modules/cockroachdb/src/cockroachdb-container.test.ts) inside_block:setUsername
+[](../../packages/modules/cockroachdb/src/cockroachdb-container.test.ts) inside_block:setUsername
 <!--/codeinclude-->

mkdocs.yml

@@ -60,9 +60,9 @@ nav:
       - Cassandra: modules/cassandra.md
       - ChromaDB: modules/chromadb.md
       - ClickHouse: modules/clickhouse.md
+      - CockroachDB: modules/cockroachdb.md
       - CosmosDB: modules/cosmosdb.md
       - Couchbase: modules/couchbase.md
-      - CockroachDB: modules/cockroachdb.md
       - Elasticsearch: modules/elasticsearch.md
       - Etcd: modules/etcd.md
       - GCloud: modules/gcloud.md

packages/modules/cockroachdb/src/cockroachdb-container.test.ts

@@ -5,8 +5,8 @@ import { CockroachDbContainer } from "./cockroachdb-container";
 const IMAGE = getImage(__dirname);
 
 describe("CockroachDbContainer", { timeout: 180_000 }, () => {
-  // connect {
   it("should connect and return a query result", async () => {
+    // cockroachConnect {
     await using container = await new CockroachDbContainer(IMAGE).start();
 
     const client = new Client({
@@ -23,62 +23,65 @@ describe("CockroachDbContainer", { timeout: 180_000 }, () => {
     expect(result.rows[0]).toEqual({ "?column?": "1" });
 
     await client.end();
+    // }
   });
-  // }
 
-  // uriConnect {
   it("should work with database URI", async () => {
+    // uriConnect {
     await using container = await new CockroachDbContainer(IMAGE).start();
 
     const client = new Client({
       connectionString: container.getConnectionUri(),
     });
+    // }
+
     await client.connect();
 
     const result = await client.query("SELECT 1");
     expect(result.rows[0]).toEqual({ "?column?": "1" });
 
     await client.end();
   });
-  // }
 
-  // setDatabase {
   it("should set database", async () => {
+    // setDatabase {
     await using container = await new CockroachDbContainer(IMAGE).withDatabase("custom_database").start();
+    // }
 
     const client = new Client({
       host: container.getHost(),
       port: container.getPort(),
       database: container.getDatabase(),
       user: container.getUsername(),
     });
+
     await client.connect();
 
     const result = await client.query("SELECT current_database()");
     expect(result.rows[0]).toEqual({ current_database: "custom_database" });
 
     await client.end();
   });
-  // }
 
-  // setUsername {
   it("should set username", async () => {
+    // setUsername {
     await using container = await new CockroachDbContainer(IMAGE).withUsername("custom_username").start();
+    // }
 
     const client = new Client({
       host: container.getHost(),
       port: container.getPort(),
       database: container.getDatabase(),
       user: container.getUsername(),
     });
+
     await client.connect();
 
     const result = await client.query("SELECT current_user");
     expect(result.rows[0]).toEqual({ current_user: "custom_username" });
 
     await client.end();
   });
-  // }
 
   it("should work with restarted container", async () => {
     await using container = await new CockroachDbContainer(IMAGE).start();