Mysql

Author: cristianrgreco

docs/modules/mysql.md

@@ -1,6 +1,4 @@
-# MySQL Module
-
-[MySQL](https://www.mysql.com/) is the world's most popular open source database. With its proven performance, reliability and ease-of-use, MySQL has become the leading database choice for web-based applications, covering the entire range from personal projects and websites, via e-commerce and information services, all the way to high profile web properties including Facebook, Twitter, YouTube, Yahoo! and many more.
+# MySQL
 
 ## Install
 
@@ -10,18 +8,28 @@ npm install @testcontainers/mysql --save-dev
 
 ## Examples
 
-<!--codeinclude-->
-[Connect and execute query:](../../packages/modules/mysql/src/mysql-container.test.ts) inside_block:connect
-<!--/codeinclude-->
+These examples use the following libraries:
+
+- [mysql2](https://www.npmjs.com/package/mysql2)
+
+        npm install mysql2
+
+Choose an image from the [container registry](https://hub.docker.com/_/mysql) and substitute `IMAGE`.
+
+### Execute a query
 
 <!--codeinclude-->
-[Connect and execute query using URI:](../../packages/modules/mysql/src/mysql-container.test.ts) inside_block:uriConnect
+[](../../packages/modules/mysql/src/mysql-container.test.ts) inside_block:mysqlConnect
 <!--/codeinclude-->
 
+### Execute a query inside the container
+
 <!--codeinclude-->
-[Set username:](../../packages/modules/mysql/src/mysql-container.test.ts) inside_block:setUsername
+[](../../packages/modules/mysql/src/mysql-container.test.ts) inside_block:mysqlExecuteQuery
 <!--/codeinclude-->
 
+### With credentials
+
 <!--codeinclude-->
-[Execute a query inside the container:](../../packages/modules/mysql/src/mysql-container.test.ts) inside_block:executeQuery
+[](../../packages/modules/mysql/src/mysql-container.test.ts) inside_block:mysqlUriConnect
 <!--/codeinclude-->

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

@@ -5,8 +5,8 @@ import { MySqlContainer } from "./mysql-container";
 const IMAGE = getImage(__dirname);
 
 describe("MySqlContainer", { timeout: 240_000 }, () => {
-  // connect {
   it("should connect and execute query", async () => {
+    // mysqlConnect {
     await using container = await new MySqlContainer(IMAGE).start();
 
     const client = await createConnection({
@@ -21,38 +21,38 @@ describe("MySqlContainer", { timeout: 240_000 }, () => {
     expect(rows).toEqual([{ res: 1 }]);
 
     await client.end();
+    // }
   });
-  // }
 
-  // uriConnect {
   it("should work with database URI", async () => {
+    // mysqlUriConnect {
     const username = "testUser";
     const password = "testPassword";
     const database = "testDB";
 
-    // Test non-root user
     await using container = await new MySqlContainer(IMAGE)
       .withUsername(username)
       .withUserPassword(password)
       .withDatabase(database)
       .start();
+
     expect(container.getConnectionUri()).toEqual(
       `mysql://${username}:${password}@${container.getHost()}:${container.getPort()}/${database}`
     );
 
-    // Test root user
     await using rootContainer = await new MySqlContainer(IMAGE)
       .withRootPassword(password)
       .withDatabase(database)
       .start();
+
     expect(rootContainer.getConnectionUri(true)).toEqual(
       `mysql://root:${password}@${rootContainer.getHost()}:${rootContainer.getPort()}/${database}`
     );
+    // }
   });
-  // }
 
-  // setDatabase {
   it("should set database", async () => {
+    // mysqlSetDatabase {
     await using container = await new MySqlContainer(IMAGE).withDatabase("customDatabase").start();
 
     const client = await createConnection({
@@ -67,10 +67,10 @@ describe("MySqlContainer", { timeout: 240_000 }, () => {
     expect(rows).toEqual([{ res: "customDatabase" }]);
 
     await client.end();
+    // }
   });
-  // }
 
-  // setUsername {
+  // mysqlSetUsername {
   it("should set username", async () => {
     await using container = await new MySqlContainer(IMAGE).withUsername("customUsername").start();
 
@@ -89,12 +89,13 @@ describe("MySqlContainer", { timeout: 240_000 }, () => {
   });
   // }
 
-  // executeQuery {
   it("should execute a query and return the result", async () => {
+    // mysqlExecuteQuery {
     await using container = await new MySqlContainer(IMAGE).start();
 
-    const queryResult = await container.executeQuery("SELECT 1 as res");
-    expect(queryResult).toEqual(expect.stringContaining("res\n1\n"));
+    const result = await container.executeQuery("SELECT 1 as res");
+    expect(result).toEqual(expect.stringContaining("res\n1\n"));
+    // }
   });
 
   it("should execute a query as root user", async () => {
@@ -108,7 +109,6 @@ describe("MySqlContainer", { timeout: 240_000 }, () => {
     const rootQueryResult = await container.executeQuery("SELECT CURRENT_USER() as user", [], true);
     expect(rootQueryResult).toEqual(expect.stringContaining("user\nroot"));
   });
-  // }
 
   it("should work with restarted container", async () => {
     await using container = await new MySqlContainer(IMAGE).start();