@lowdefy/docs 4.0.0-alpha.5 → 4.0.0-alpha.6

package/CHANGELOG.md

@@ -3,6 +3,22 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [4.0.0-alpha.6](https://github.com/lowdefy/lowdefy/compare/v4.0.0-alpha.5...v4.0.0-alpha.6) (2022-01-20)
+
+
+### Bug Fixes
+
+* **docs:** Added redis connection documentation. ([ee1620b](https://github.com/lowdefy/lowdefy/commit/ee1620bb41d8aa3f32e05e9b7e03c7986365c59f))
+
+
+### Features
+
+* Add _diff to client operators as well as server. ([4e23fec](https://github.com/lowdefy/lowdefy/commit/4e23fec8a4985d7453dfcf750298bc0bedeb34a2))
+
+
+
+
+
 # [4.0.0-alpha.5](https://github.com/lowdefy/lowdefy/compare/v4.0.0-alpha.4...v4.0.0-alpha.5) (2021-11-27)
 
 **Note:** Version bump only for package @lowdefy/docs

package/connections/Redis.yaml

@@ -0,0 +1,147 @@
+# Copyright 2020-2021 Lowdefy, Inc
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+
+#     http://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+_ref:
+  path: templates/general.yaml.njk
+  vars:
+    pageId: Redis
+    pageTitle: Redis
+    section: Connections
+    filePath: connections/Redis.yaml
+    content:
+      - id: markdown_intro
+        type: MarkdownWithCode
+        properties:
+          content: |
+            [`Redis`](http://redis.io/) is an open-source, in-memory key-value data structure store. Redis offers a set of versatile in-memory data structures (strings, hashes, lists, sets, sorted sets with range queries, bitmaps, hyperloglogs, geospatial indexes, and streams) that allow the creation of many custom applications. Key use cases for Redis include database, caching, session management and message broker.
+
+            Lowdefy integrates with Redis using the one of the recommended [Node.js clients (node-redis)](https://github.com/redis/node-redis).
+
+      - id: markdown_connection
+        type: MarkdownWithCode
+        properties:
+          content: |
+            ## Connections
+
+            Connection types:
+              - Redis
+
+            ### Redis
+
+            #### Properties
+            - `connection: object | string `: __Required__ - Connection object or string to pass to the [`redis client`](https://github.com/redis/node-redis) redis client.
+
+            The connection object accepts will be passed to the redis client verbatim, so check out the [configuration instructions](https://github.com/redis/node-redis/blob/master/docs/client-configuration.md).
+
+            #### Examples
+
+            ###### Redis with connection object:
+            ```yaml
+            connections:
+              - id: redis
+                type: Redis
+                properties:
+                  connection:
+                    username: 
+                      _secret: REDIS_USERNAME
+                    password: 
+                      _secret: REDIS_PASSWORD
+                    database:
+                      _secret: REDIS_DATABASE
+                    socket:
+                      host:
+                        _secret: REDIS_HOST
+                      port:
+                        _secret: REDIS_PORT
+            ```
+            Environment variables:
+            ```
+            LOWDEFY_SECRET_REDIS_USERNAME = user
+            LOWDEFY_SECRET_REDIS_PASSWORD = password
+            LOWDEFY_SECRET_REDIS_DATABASE = 4
+            LOWDEFY_SECRET_REDIS_HOST = redis.server.com
+            LOWDEFY_SECRET_REDIS_PORT = 5000
+            ```
+
+            ###### Redis with connection string:
+            ```yaml
+            connections:
+              - id: redis
+                type: Redis
+                properties:
+                  connection:
+                    _secret: REDIS_CONNECTION_STRING
+            ```
+            Environment variables:
+            ```
+            LOWDEFY_SECRET_REDIS_CONNECTION_STRING = redis://user:password@redis:server.com:5000/4'
+            ```
+      - id: markdown_requests
+        type: MarkdownWithCode
+        properties:
+          content: |
+            ## Requests
+
+            Request types:
+              - Redis
+
+            ### Redis
+
+            #### Properties
+
+            - `command: string`: **Required** - Redis command to be executed, accepts all of the [out-of-the-box Redis commands](https://redis.io/commands).
+            - `parameters: array`: An array of parameters to be passed to the redis command.
+            - `modifiers: object`: The redis modififers to be passed to the redis command.
+
+            #### Examples
+
+            ###### Setting a key-value pair in redis:
+
+            ```yaml
+            id: redisRequest
+            type: Redis
+            connectionId: redis
+            properties:
+              command: set
+              parameters:
+                - key
+                - value
+            ```
+
+            ###### Getting a value from redis:
+
+            ```yaml
+            id: redisRequest
+            type: Redis
+            connectionId: redis
+            properties:
+              command: get
+              parameters:
+                - key
+            ```
+
+            ###### Setting a key-value pair only if key does not exist:
+
+            ````yaml
+            id: redisRequest
+            type: Redis
+            connectionId: redis
+            properties:
+              command: set
+              parameters:
+                - key
+                - value
+              modififers:
+                nx: true
+            ```

package/menus.yaml

@@ -515,6 +515,9 @@
         - id: PostgreSQL
           type: MenuLink
           pageId: PostgreSQL
+        - id: Redis
+          type: MenuLink
+          pageId: Redis
         - id: SendGridMail
           type: MenuLink
           pageId: SendGridMail

package/operators/_diff.yaml

@@ -19,7 +19,6 @@ _ref:
     pageId: _diff
     pageTitle: _diff
     filePath: operators/_diff.yaml
-    env: Server Only
     methods:
       - name: deep
         types: |

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lowdefy/docs",
-  "version": "4.0.0-alpha.5",
+  "version": "4.0.0-alpha.6",
   "license": "Apache-2.0",
   "description": "",
   "homepage": "https://lowdefy.com",
@@ -40,5 +40,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "995fcdb020927f3cdc626fc99c15a2e4137bd962"
+  "gitHead": "2530e31af795b6a3c75ac8f72c8dbe0ab5d1251b"
 }

package/pages.yaml

@@ -143,6 +143,7 @@
 - _ref: connections/MySQL.yaml
 # - _ref: connections/OracleDB.yaml
 - _ref: connections/PostgreSQL.yaml
+- _ref: connections/Redis.yaml
 - _ref: connections/SendGridMail.yaml
 - _ref: connections/SQLite.yaml
 - _ref: connections/Stripe.yaml