You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on May 20, 2025. It is now read-only.
Below is the sequence of events that occur when a developer registers a SQL database with Nitric.
60
+
61
+
```mermaid
62
+
sequenceDiagram
63
+
participant Worker as App Worker(s)
64
+
participant SDK as Nitric SDK
65
+
participant Nitric as Nitric CLI
66
+
participant Provider as Nitric Provider <br> (plugin)
67
+
participant IAC as IaC <br> (e.g. Terraform)
68
+
69
+
Worker->>SDK: Register SQL Database
70
+
SDK->>Nitric: Register SQL Database
71
+
72
+
Nitric->>Provider: Forward Nitric Spec
73
+
Provider->>IAC: Provision Database Cluster
74
+
Provider->>IAC: Provision Database Instance
75
+
Provider->>IAC: Provision IAM
76
+
```
77
+
78
+
### Runtime Sequence
79
+
80
+
Below is the runtime flow of a database operation in a Nitric application, using the Nitric SDK. The SDK provides access to the connection details for the SQL database. All database operations are performed as usual, without any additional Nitric-specific steps.
56
81
57
82
```mermaid
58
83
sequenceDiagram
59
-
participant Client as Client
60
-
participant NitricSDK as Nitric SDK
61
-
participant NitricRuntime as Nitric Runtime
62
-
participant SQLDatabase as SQL Database (e.g., PostgreSQL, MySQL)
Here is the sequence of events that occur when a developer registers an Websocket API with Nitric, including the registration of handlers for connection, message, and disconnection events.
53
+
54
+
```mermaid
55
+
sequenceDiagram
56
+
participant Worker as App Worker(s)
57
+
participant SDK as Nitric SDK
58
+
participant Nitric as Nitric CLI
59
+
participant Provider as Nitric Provider <br> (plugin)
60
+
participant IAC as IaC <br> (e.g. Terraform)
61
+
62
+
Worker->>SDK: Register Websocket(s)
63
+
SDK->>Nitric: Register Websocket(s)
64
+
65
+
Worker->>SDK: Register Connection Handler
66
+
SDK->>Nitric: Register Connection Handler
67
+
Worker->>SDK: Register Message Handler
68
+
SDK->>Nitric: Register Message Handler
69
+
Worker->>SDK: Register Disconnection Handler
70
+
SDK->>Nitric: Register Disconnection Handler
71
+
72
+
Nitric->>Provider: Forward Nitric Spec
73
+
Provider->>IAC: Provision Websocket API
74
+
Provider->>IAC: Provision IAM
75
+
```
76
+
77
+
### Runtime Sequence
78
+
79
+
Here is the sequence of events that occur at runtime when a websocket connection is established, messages are sent and received, and the connection is closed.
80
+
50
81
```mermaid
51
82
sequenceDiagram
52
83
participant Client as Client
84
+
participant WSGateway as WebSocket Gateway <br> (e.g. AWS API Gateway)
85
+
participant NitricRuntime as Nitric Runtime <br> (plugin)
53
86
participant NitricSDK as Nitric SDK
54
-
participant NitricRuntime as Nitric Runtime
55
-
participant WebSocketGateway as Cloud WebSocket Gateway (e.g., AWS API Gateway, GCP WebSocket Gateway)
0 commit comments