aboutsummaryrefslogtreecommitdiff
path: root/docs/api/database.md
diff options
context:
space:
mode:
authorJess <[email protected]>2022-01-12 19:48:48 -0500
committerGitHub <[email protected]>2022-01-12 19:48:48 -0500
commit71e902599651b645cdb6996c8cd562e8007a32ea (patch)
tree368e83ffbeb836d5c66ad7af53c765c7444a26cb /docs/api/database.md
parenta590f266e02d8f8a2cac65cb6e8bd395bf04074b (diff)
downloadfaker-71e902599651b645cdb6996c8cd562e8007a32ea.tar.xz
faker-71e902599651b645cdb6996c8cd562e8007a32ea.zip
feat: adding documentation with vitepress (#80)
Diffstat (limited to 'docs/api/database.md')
-rw-r--r--docs/api/database.md35
1 files changed, 35 insertions, 0 deletions
diff --git a/docs/api/database.md b/docs/api/database.md
new file mode 100644
index 00000000..c9be1533
--- /dev/null
+++ b/docs/api/database.md
@@ -0,0 +1,35 @@
+# Database
+
+[[toc]]
+
+## Column
+
+Return database column name
+
+```js
+faker.database.column(); // createdAt
+```
+
+## Type
+
+Return database column type
+
+```js
+faker.database.type(); // text
+```
+
+## Collation
+
+Return database collation
+
+```js
+faker.database.collation(); // cp1250_general_ci
+```
+
+## Engine
+
+Return database engine
+
+```js
+faker.database.engine(); // MyISAM
+```