Skip to content

Commit 646bf6e

Browse files
committed
[pipelines/destination] add LightDB State data destination
Adds docs for LightDB State data destination. Signed-off-by: Daniel Mangum <georgedanielmangum@gmail.com>
1 parent 26fd4ab commit 646bf6e

1 file changed

Lines changed: 60 additions & 0 deletions

File tree

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
---
2+
title: lightdb-state
3+
---
4+
5+
| | |
6+
|---|:---:|
7+
|__Latest Version__| `v1.0.0` |
8+
|__Input Content Type__| `application/json` |
9+
10+
:::usage
11+
Sending data to LightDB State incurs usage costs after exceeding the free tier.
12+
See [Golioth pricing](https://golioth.io/pricing) for more information.
13+
:::
14+
15+
The LightDB State destination sends data to [LightDB
16+
State](/application-services/lightdb-state). Data must arrive as or be
17+
transformed into JSON in order to be successfully delivered to LightDB State.
18+
19+
If a `path` is specified, it will be used to nest the message data in the
20+
device's LightDB State JSON document. If the `path` parameter is omitted, the
21+
stream path will be used for nesting.
22+
23+
### Parameters
24+
25+
|Parameter|Type|Description|Required|
26+
|---|---|---|:---:|
27+
|`path`|`string`| A fixed path to nest the JSON object. | |
28+
29+
### Example Usage
30+
31+
Because LightDB State is hosted by Golioth, no credentials are required to
32+
deliver data to the service.
33+
34+
```yaml
35+
destination:
36+
type: lightdb-state
37+
version: v1
38+
parameters:
39+
path: /latest/stream
40+
```
41+
42+
### Example Input
43+
44+
```json
45+
{
46+
"temp": 32
47+
}
48+
```
49+
50+
### Example Output
51+
52+
```json
53+
{
54+
"latest": {
55+
"stream": {
56+
"temp": 32
57+
}
58+
}
59+
}
60+
```

0 commit comments

Comments
 (0)