2 Commits 49d7b18e61 ... 3895d8e325

Author SHA1 Message Date
  Matthias Ladkau 3895d8e325 doc: Modifying main README.md 2 years ago
  Matthias Ladkau 49d7b18e61 doc: Modifying main README.md 2 years ago
1 changed files with 24 additions and 24 deletions
  1. 24 24
      ecal.md

+ 24 - 24
ecal.md

@@ -35,33 +35,33 @@ EliasDB specific events which can be handled:
 --
 The ECAL interpreter in EliasDB receives the following events:
 
-Web Request | ECAL event kind | Event state contents | Description
--|-|-|-
-/db/api/|`db.web.api`| bodyJSON, bodyString, header, method, path, pathList, query | Any web request to /db/api/... These endpoints are public and never require authentication.
-/db/ecal/|`db.web.ecal`| bodyJSON, bodyString, header, method, path, pathList, query | Any web request to /db/ecal/... These endpoints are considered internal and require authentication if access control is enabled.
-/db/sock/|`db.web.sock`| bodyJSON, bodyString, commID, header, method, path, pathList, query | Any web request to /db/sock/... These endpoints are used to initiate websocket connections.
--|`db.web.sock.data`| commID, data, header, method, path, pathList, query | An existing websocket connection received some JSON object data. If the close attribute of the object is set to true then the websocket connection is closed.
+| Web Request | ECAL event kind | Event state contents | Description |
+| --- | ---| --- | --- |
+| /db/api/|`db.web.api`| bodyJSON, bodyString, header, method, path, pathList, query | Any web request to /db/api/... These endpoints are public and never require authentication. |
+| /db/ecal/|`db.web.ecal`| bodyJSON, bodyString, header, method, path, pathList, query | Any web request to /db/ecal/... These endpoints are considered internal and require authentication if access control is enabled. |
+| /db/sock/|`db.web.sock`| bodyJSON, bodyString, commID, header, method, path, pathList, query | Any web request to /db/sock/... These endpoints are used to initiate websocket connections. |
+| - |`db.web.sock.data`| commID, data, header, method, path, pathList, query | An existing websocket connection received some JSON object data. If the close attribute of the object is set to true then the websocket connection is closed. |
 
 EliasDB can receive the following events from the ECAL interpreter:
 
-ECAL event kind | Event state contents | Description
--|-|-
-db.web.sock.msg | commID, payload, close | The payload is send to a client with an open websocket identified by the commID.
-
-
-EliasDB Graph Event | ECAL event kind | Event state contents | Description
--|-|-|-
-graph.EventNodeCreated | `db.node.created` | part, trans, node | A node was created.
-graph.EventNodeUpdated | `db.node.updated` | part, trans, node, old_node | A node was updated.
-graph.EventNodeDeleted | `db.node.deleted` | part, trans, node | A node was deleted.
-graph.EventEdgeCreated | `db.edge.created` | part, trans, edge | An edge was created.
-graph.EventEdgeUpdated | `db.edge.updated` | part, trans, edge, old_edge | An edge was updated.
-graph.EventEdgeDeleted | `db.edge.deleted` | part, trans, edge | An edge was deleted.
-graph.EventNodeStore | `db.node.store` | part, trans, node | A node is about to be stored (always overwriting existing values).
-graph.EventNodeUpdate | `db.node.update` | part, trans, node | A node is about to be updated.
-graph.EventNodeDelete | `db.node.delete` | part, trans, key, kind | A node is about to be deleted.
-graph.EventEdgeStore | `db.edge.store` | part, trans, edge | An edge is about to be stored.
-graph.EventEdgeDelete | `db.edge.delete` | part, trans, key, kind | An edge is about to be deleted.
+| ECAL event kind | Event state contents | Description |
+| --- | --- | --- |
+| db.web.sock.msg | commID, payload, close | The payload is send to a client with an open websocket identified by the commID. |
+
+
+| EliasDB Graph Event | ECAL event kind | Event state contents | Description |
+| --- | --- | --- | --- |
+| graph.EventNodeCreated | `db.node.created` | part, trans, node | A node was created. |
+| graph.EventNodeUpdated | `db.node.updated` | part, trans, node, old_node | A node was updated. |
+| graph.EventNodeDeleted | `db.node.deleted` | part, trans, node | A node was deleted. |
+| graph.EventEdgeCreated | `db.edge.created` | part, trans, edge | An edge was created. |
+| graph.EventEdgeUpdated | `db.edge.updated` | part, trans, edge, old_edge | An edge was updated. |
+| graph.EventEdgeDeleted | `db.edge.deleted` | part, trans, edge | An edge was deleted. |
+| graph.EventNodeStore | `db.node.store` | part, trans, node | A node is about to be stored (always overwriting existing values). |
+| graph.EventNodeUpdate | `db.node.update` | part, trans, node | A node is about to be updated. |
+| graph.EventNodeDelete | `db.node.delete` | part, trans, key, kind | A node is about to be deleted. |
+| graph.EventEdgeStore | `db.edge.store` | part, trans, edge | An edge is about to be stored. |
+| graph.EventEdgeDelete | `db.edge.delete` | part, trans, key, kind | An edge is about to be deleted. |
 
 Note: EliasDB will wait for the event cascade to be finished before performing the actual operation (e.g. inserting a node). If the event handling requires a time consuming operation then a new parallel event cascade can be started using `addEvent` with a scope:
 ```