docs: add db plugins statements (#143)

Co-authored-by: Puria Nafisi Azizi <[email protected]>
dyne · May 24, 2024 · 4a3e333 · 4a3e333
1 parent e2ba53c
commit 4a3e333
Show file tree

Hide file tree

Showing 4 changed files with 4,838 additions and 3,827 deletions.
diff --git a/docs/statements/index.md b/docs/statements/index.md
@@ -29,6 +29,14 @@ neither the open/connect part nor the parameters part are present.
 
 ## Tables of all slangroom statements
 
+## db plugin
+| open/connect | params               | phrase                                  |
+| ------------ | -------------------- | --------------------------------------- |
+| connect      | statement            | execute sql statement                   |
+| connect      | statement,parameters | execute sql statement with parameters   |
+| connect      | record,table         | read the record of the table            |
+| connect      | variable,name,table  | save the variable in the database table |
+
 ## ethereum plugin
 | open/connect | params         | phrase                                           |
 | ------------ | -------------- | ------------------------------------------------ |
@@ -162,17 +170,18 @@ neither the open/connect part nor the parameters part are present.
 |              | token,server_data                     | get claims from token       |
 
 ## pocketbase plugin
-| open/connect | params                              | phrase                             |
-| ------------ | ----------------------------------- | ---------------------------------- |
-|              | pb_address                          | connect to pb_address              |
-|              | pb_address                          | connect capacitor app to pb_client |
-|              | my_credentials                      | login                              |
-|              | list_parameters                     | get some records                   |
-|              | show_parameters                     | get one record                     |
-|              | create_parameters,record_parameters | create record                      |
-|              | update_parameters,record_parameters | update record                      |
-|              | delete_parameters                   | delete record                      |
-|              | url,send_parameters                 | send request                       |
+| open/connect | params                              | phrase                    |
+| ------------ | ----------------------------------- | ------------------------- |
+| connect      |                                     | start pb client           |
+| connect      |                                     | start capacitor pb client |
+|              | my_credentials                      | login                     |
+|              | email                               | ask password reset        |
+|              | list_parameters                     | get some records          |
+|              | show_parameters                     | get one record            |
+|              | create_parameters,record_parameters | create record             |
+|              | update_parameters,record_parameters | update record             |
+|              | delete_parameters                   | delete record             |
+|              | url,send_parameters                 | send request              |
 
 ## qrcode plugin
 | open/connect | params | phrase         |

diff --git a/docs/statements/index.mjs b/docs/statements/index.mjs
@@ -9,6 +9,7 @@ import {markdownTable} from "markdown-table";
 // slangroom
 import {Slangroom} from "@slangroom/core";
 // packages
+import {db} from "@slangroom/db";
 import {ethereum} from "@slangroom/ethereum";
 import {fs as sl_fs} from "@slangroom/fs";
 import {git} from "@slangroom/git";
@@ -52,7 +53,8 @@ const generateTable = (plugin, name) => {
 }
 
 [
-    [ethereum, 'ethereum'],
+	[db, 'db'],
+	[ethereum, 'ethereum'],
 	[sl_fs, 'fs'],
 	[git, 'git'],
 	[helpers, 'helpers'],

diff --git a/docs/statements/package.json b/docs/statements/package.json
@@ -11,6 +11,7 @@
   "license": "ISC",
   "dependencies": {
     "@slangroom/core": "workspace:^",
+    "@slangroom/db": "workspace:^",
     "@slangroom/ethereum": "workspace:^",
     "@slangroom/fs": "workspace:^",
     "@slangroom/git": "workspace:^",