aboutsummaryrefslogtreecommitdiff
path: root/src/modules/database
diff options
context:
space:
mode:
authorMatt Mayer <[email protected]>2023-03-29 20:36:46 +0700
committerGitHub <[email protected]>2023-03-29 13:36:46 +0000
commit3562e872530b3610d95be71aa6f4f7fdfef7134f (patch)
treec6ba28a9f3cf30e5bf5c0a935fead6bdb2668531 /src/modules/database
parent88e561a5490003a41665eb007c5c28ff0800ae09 (diff)
downloadfaker-3562e872530b3610d95be71aa6f4f7fdfef7134f.tar.xz
faker-3562e872530b3610d95be71aa6f4f7fdfef7134f.zip
docs: add overview guides to specific modules (#1929)
Diffstat (limited to 'src/modules/database')
-rw-r--r--src/modules/database/index.ts6
1 files changed, 6 insertions, 0 deletions
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) {