diff options
Diffstat (limited to 'src/modules/database')
| -rw-r--r-- | src/modules/database/index.ts | 6 |
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) { |