blob: 6c3595cc4fc88e44a733856436e4101ad582bce4 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
|
import { ModuleBase } from '../../internal/module-base';
/**
* Module to generate database related entries.
*
* ### Overview
*
* Traditional relational database tables have data organized in columns with specific types - [`column()`](https://fakerjs.dev/api/database.html#column), [`type()`](https://fakerjs.dev/api/database.html#type). The database usually has an [`engine()`](https://fakerjs.dev/api/database.html#engine) and a default [`collation()`](https://fakerjs.dev/api/database.html#collation) for sorting.
*
* For the NoSQL database MongoDB, [`mongodbObjectId()`](https://fakerjs.dev/api/database.html#mongodbobjectid) provides a random ID.
*/
export class DatabaseModule extends ModuleBase {
/**
* Returns a random database column name.
*
* @example
* faker.database.column() // 'createdAt'
*
* @since 4.0.0
*/
column(): string {
return this.faker.helpers.arrayElement(
this.faker.definitions.database.column
);
}
/**
* Returns a random database column type.
*
* @example
* faker.database.type() // 'timestamp'
*
* @since 4.0.0
*/
type(): string {
return this.faker.helpers.arrayElement(
this.faker.definitions.database.type
);
}
/**
* Returns a random database collation.
*
* @example
* faker.database.collation() // 'utf8_unicode_ci'
*
* @since 4.0.0
*/
collation(): string {
return this.faker.helpers.arrayElement(
this.faker.definitions.database.collation
);
}
/**
* Returns a random database engine.
*
* @example
* faker.database.engine() // 'ARCHIVE'
*
* @since 4.0.0
*/
engine(): string {
return this.faker.helpers.arrayElement(
this.faker.definitions.database.engine
);
}
/**
* Returns a MongoDB [ObjectId](https://docs.mongodb.com/manual/reference/method/ObjectId/) string.
*
* @example
* faker.database.mongodbObjectId() // 'e175cac316a79afdd0ad3afb'
*
* @since 6.2.0
*/
mongodbObjectId(): string {
return this.faker.string.hexadecimal({
length: 24,
casing: 'lower',
prefix: '',
});
}
}
|
