mirror of
https://github.com/jwetzell/showbridge-docs.git
synced 2026-05-14 05:24:21 +00:00
add docs for db and redis
This commit is contained in:
@@ -0,0 +1,19 @@
|
||||
---
|
||||
title: Query
|
||||
sidebar:
|
||||
order: 1
|
||||
---
|
||||
The `db.query` processor will issue a query to the specified module and return the result to the next processor in line.
|
||||
|
||||
- **type**: `db.query`
|
||||
- **params**:
|
||||
- **module**: the id of the [module](/concepts/modules) to issue query to.
|
||||
- **query**: the query to execute.
|
||||
### Example
|
||||
Issue a `SELECT` statement to a module with id `sqlite`.
|
||||
```
|
||||
- type: db.query
|
||||
params:
|
||||
module: sqlite
|
||||
query: "SELECT * from users;"
|
||||
```
|
||||
@@ -0,0 +1,20 @@
|
||||
---
|
||||
title: Get
|
||||
sidebar:
|
||||
order: 1
|
||||
---
|
||||
The `kv.get` processor gets the value associated with a key from a compatible module. The output payload is the value if the key is found.
|
||||
|
||||
- **type**: `kv.get`
|
||||
- **params**:
|
||||
- **module**: id of the module
|
||||
- **key**: the key to look up
|
||||
|
||||
### Example
|
||||
This will attempt to get the value for the `counter` key from the module with an id of `redis`
|
||||
```
|
||||
- type: kv.get
|
||||
params:
|
||||
module: redis
|
||||
key: counter
|
||||
```
|
||||
@@ -0,0 +1,22 @@
|
||||
---
|
||||
title: Set
|
||||
sidebar:
|
||||
order: 2
|
||||
---
|
||||
The `kv.set` processor sets the value associated with a key from a compatible module. The payload is unchanged so whatever is received by this payload is output unless any errors are encountered.
|
||||
|
||||
- **type**: `kv.set`
|
||||
- **params**:
|
||||
- **module**: id of the module
|
||||
- **key**: the key to look up
|
||||
- **value**: the value to set
|
||||
|
||||
### Example
|
||||
This will attempt to set the key `hello` to `world` using the module with an id of `redis`
|
||||
```
|
||||
- type: kv.set
|
||||
params:
|
||||
module: redis
|
||||
key: hello
|
||||
value: world
|
||||
```
|
||||
Reference in New Issue
Block a user