feat(db): mention fake driver

AthennaIO · Jan 9, 2024 · e2873ec · e2873ec
1 parent 3b13dc5
commit e2873ec
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 5 deletions.
diff --git a/docs/database/getting-started.mdx b/docs/database/getting-started.mdx
@@ -60,12 +60,23 @@ is already present in your application's `Path.config('database.ts')`
 configuration file, so be sure to review this file to become
 familiar with its contents:
 
-| Driver name |                          Website |                                           Built with |
+| Driver name |             Website              |                                           Built with |
 |:------------|:--------------------------------:|-----------------------------------------------------:|
-| `mongo`     |         https://www.mongodb.com/ |   [mongoose](https://www.npmjs.com/package/mongoose) |
-| `mysql`     |           https://www.mysql.com/ |           [knex](https://www.npmjs.com/package/knex) |
-| `sqlite`    |          https://www.sqlite.org/ |           [knex](https://www.npmjs.com/package/knex) |
-| `postgres`  |      https://www.postgresql.org/ |           [knex](https://www.npmjs.com/package/knex) |
+| `mongo`     |     https://www.mongodb.com/     |   [mongoose](https://www.npmjs.com/package/mongoose) |
+| `mysql`     |      https://www.mysql.com/      |           [knex](https://www.npmjs.com/package/knex) |
+| `sqlite`    |     https://www.sqlite.org/      |           [knex](https://www.npmjs.com/package/knex) |
+| `postgres`  |   https://www.postgresql.org/    |           [knex](https://www.npmjs.com/package/knex) |
+
+:::note
+
+Athenna has another driver called `fake` that is very helpful when running tests.
+The `fake` driver got the same signature of all other drivers, but it returns
+empty objects and arrays in executors methods like `find()`, which is perfect to use
+within the [`Mock`](/docs/testing/mocking) class. For more information
+about the `FakeDriver`, take a look at the
+[mocking database documentation section.](/docs/testing/mocking#mocking-database)
+
+:::
 
 ### Overview of some environment variables
 

diff --git a/docs/testing/mocking.mdx b/docs/testing/mocking.mdx
@@ -994,3 +994,8 @@ export default class GreetTest {
   }
 }
 ```
+
+
+## Mocking database
+
+Coming soon...