From 3562e872530b3610d95be71aa6f4f7fdfef7134f Mon Sep 17 00:00:00 2001
From: Matt Mayer <152770+matthewmayer@users.noreply.github.com>
Date: Wed, 29 Mar 2023 20:36:46 +0700
Subject: docs: add overview guides to specific modules (#1929)

---
 src/modules/database/index.ts | 6 ++++++
 1 file changed, 6 insertions(+)

(limited to 'src/modules/database')

diff --git a/src/modules/database/index.ts b/src/modules/database/index.ts
index 88a7609a..5f497721 100644
--- a/src/modules/database/index.ts
+++ b/src/modules/database/index.ts
@@ -2,6 +2,12 @@ import type { Faker } from '../..';
 
 /**
  * Module to generate database related entries.
+ *
+ * ### Overview
+ *
+ * Traditional relational database tables have data organized in columns with specific types - [`column()`](https://next.fakerjs.dev/api/database.html#column), [`type()`](https://next.fakerjs.dev/api/database.html#type). The database usually has an [`engine()`](https://next.fakerjs.dev/api/database.html#engine) and a default [`collation()`](https://next.fakerjs.dev/api/database.html#collation) for sorting.
+ *
+ * For the NoSQL database MongoDB, [`mongodbObjectId()`](https://next.fakerjs.dev/api/database.html#mongodbobjectid) provides a random ID.
  */
 export class DatabaseModule {
   constructor(private readonly faker: Faker) {
-- 
cgit v1.2.3