Mariadb

Author: cristianrgreco

docs/modules/mariadb.md

@@ -1,8 +1,4 @@
-# MariaDB Module
-
-[MariaDB](https://mariadb.org/) is one of the most popular open source relational databases. It’s made by the original developers of MySQL and guaranteed to stay open source. It is part of most cloud offerings and the default in most Linux distributions.
-
-
+# MariaDB
 
 ## Install
 
@@ -12,18 +8,34 @@ npm install @testcontainers/mariadb --save-dev
 
 ## Examples
 
+These examples use the following libraries:
+
+- [mariadb](https://www.npmjs.com/package/mariadb)
+
+        npm install mariadb
+
+Choose an image from the [container registry](https://hub.docker.com/_/mariadb) and substitute `IMAGE`.
+
+### Execute a query
+
 <!--codeinclude-->
-[Connect and execute query:](../../packages/modules/mariadb/src/mariadb-container.test.ts) inside_block:connect
+[](../../packages/modules/mariadb/src/mariadb-container.test.ts) inside_block:mariaDbConnect
 <!--/codeinclude-->
 
+### Connect via URI
+
 <!--codeinclude-->
-[Connect and execute query using URI:](../../packages/modules/mariadb/src/mariadb-container.test.ts) inside_block:uriConnect
+[](../../packages/modules/mariadb/src/mariadb-container.test.ts) inside_block:mariaDbUriConnect
 <!--/codeinclude-->
 
+### With user
+
 <!--codeinclude-->
-[Set username:](../../packages/modules/mariadb/src/mariadb-container.test.ts) inside_block:setUsername
+[](../../packages/modules/mariadb/src/mariadb-container.test.ts) inside_block:mariaDbSetUsername
 <!--/codeinclude-->
 
+### With database
+
 <!--codeinclude-->
-[Insert & fetch data:](../../packages/modules/mariadb/src/mariadb-container.test.ts) inside_block:insertAndFetchData
+[](../../packages/modules/mariadb/src/mariadb-container.test.ts) inside_block:mariaDbSetDatabase
 <!--/codeinclude-->

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

@@ -4,9 +4,9 @@ import { MariaDbContainer } from "./mariadb-container";
 
 const IMAGE = getImage(__dirname);
 
-describe("MariaDb", { timeout: 240_000 }, () => {
-  // connect {
+describe("MariaDbContainer", { timeout: 240_000 }, () => {
   it("should connect and execute query", async () => {
+    // mariaDbConnect {
     await using container = await new MariaDbContainer(IMAGE).start();
 
     const client = await mariadb.createConnection({
@@ -21,11 +21,11 @@ describe("MariaDb", { timeout: 240_000 }, () => {
     expect(rows).toEqual([{ res: 1 }]);
 
     await client.end();
+    // }
   });
-  // }
 
-  // uriConnect {
   it("should work with database URI", async () => {
+    // mariaDbUriConnect {
     const username = "testUser";
     const password = "testPassword";
     const database = "testDB";
@@ -36,6 +36,7 @@ describe("MariaDb", { timeout: 240_000 }, () => {
       .withUserPassword(password)
       .withDatabase(database)
       .start();
+
     expect(container.getConnectionUri()).toEqual(
       `mariadb://${username}:${password}@${container.getHost()}:${container.getPort()}/${database}`
     );
@@ -45,14 +46,15 @@ describe("MariaDb", { timeout: 240_000 }, () => {
       .withRootPassword(password)
       .withDatabase(database)
       .start();
+
     expect(rootContainer.getConnectionUri(true)).toEqual(
       `mariadb://root:${password}@${rootContainer.getHost()}:${rootContainer.getPort()}/${database}`
     );
+    // }
   });
-  // }
 
-  // setDatabase {
   it("should set database", async () => {
+    // mariaDbSetDatabase {
     await using container = await new MariaDbContainer(IMAGE).withDatabase("customDatabase").start();
 
     const client = await mariadb.createConnection({
@@ -67,11 +69,11 @@ describe("MariaDb", { timeout: 240_000 }, () => {
     expect(rows).toEqual([{ res: "customDatabase" }]);
 
     await client.end();
+    // }
   });
-  // }
 
-  // setUsername {
   it("should set username", async () => {
+    // mariaDbSetUsername {
     await using container = await new MariaDbContainer(IMAGE).withUsername("customUsername").start();
 
     const client = await mariadb.createConnection({
@@ -86,43 +88,8 @@ describe("MariaDb", { timeout: 240_000 }, () => {
     expect(rows).toEqual([{ res: "customUsername@%" }]);
 
     await client.end();
+    // }
   });
-  // }
-
-  // insertAndFetchData {
-  it("should create a table, insert a row, and fetch that row", async () => {
-    await using container = await new MariaDbContainer(IMAGE).start();
-
-    const client = await mariadb.createConnection({
-      host: container.getHost(),
-      port: container.getPort(),
-      database: container.getDatabase(),
-      user: container.getUsername(),
-      password: container.getUserPassword(),
-    });
-
-    // Create table
-    await client.query(`
-        CREATE TABLE users (
-          id INT AUTO_INCREMENT PRIMARY KEY,
-          name VARCHAR(255) NOT NULL,
-          email VARCHAR(255) NOT NULL UNIQUE
-        );
-      `);
-
-    // Insert a row
-    const name = "John Doe";
-    const email = "[email protected]";
-    const insertResult = await client.query("INSERT INTO users (name, email) VALUES (?, ?)", [name, email]);
-    expect(insertResult.affectedRows).toBe(1);
-
-    // Fetch the row
-    const [user] = await client.query("SELECT id, name, email FROM users WHERE email = ?", [email]);
-    expect(user).toEqual({ id: expect.any(Number), name, email });
-
-    await client.end();
-  });
-  // }
 
   it("should work with restarted container", async () => {
     await using container = await new MariaDbContainer(IMAGE).start();