https://embedded-workflow-builder.netlify.app/assets/js/3afb40b4.3ebf616f.js

1"use strict";(self.webpackChunkembedded_workflow_builder_docs=self.webpackChunkembedded_workflow_builder_docs||[]).push([["5782"],{61442(e,n,t){t.r(n),t.d(n,{metadata:()=>s,default:()=>a,frontMatter:()=>d,contentTitle:()=>l,toc:()=>h,assets:()=>c});var s=JSON.parse('{"id":"connectors/redis","title":"Redis Connector","description":"Manage items in a Redis database","source":"@site/docs/connectors/redis.md","sourceDirName":"connectors","slug":"/connectors/redis","permalink":"/connectors/redis","draft":false,"unlisted":false,"tags":[],"version":"current","frontMatter":{"title":"Redis Connector","sidebar_label":"Redis","description":"Manage items in a Redis database"},"sidebar":"docs","previous":{"title":"Recursive Flow","permalink":"/connectors/recursive-flow"},"next":{"title":"Redshift","permalink":"/connectors/aws-redshift"}}'),i=t(74848),r=t(28453);let d={title:"Redis Connector",sidebar_label:"Redis",description:"Manage items in a Redis database"},l,c={},h=[{value:"API Documentation",id:"api-documentation",level:2},{value:"Connections",id:"connections",level:2},{value:"Redis Connection",id:"redis",level:3},{value:"Prerequisites",id:"prerequisites",level:4},{value:"Configure the Connection",id:"configure-the-connection",level:4},{value:"TLS Configuration",id:"tls-configuration",level:4},{value:"Actions",id:"actions",level:2},{value:"Delete Key",id:"deletekey",level:3},{value:"Flush All",id:"flushall",level:3},{value:"Get",id:"get",level:3},{value:"Get Time",id:"gettime",level:3},{value:"Keys",id:"keys",level:3},{value:"Ping",id:"ping",level:3},{value:"Set",id:"set",level:3}];function o(e){let n={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",img:"img",li:"li",p:"p",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.img,{alt:"Redis",src:t(57624).A+"#connector-icon",width:"32",height:"32"}),"\n",(0,i.jsx)(n.a,{href:"https://redis.io/",children:"Redis"})," is an in-memory data structure store used as a key-value database, cache, and message broker.\nThe ",(0,i.jsx)(n.strong,{children:"Redis"})," component provides the ability to create, read, update, and delete data inside a Redis database."]}),"\n",(0,i.jsx)(n.h2,{id:"api-documentation",children:"API Documentation"}),"\n",(0,i.jsxs)(n.p,{children:["This component was built using the ",(0,i.jsx)(n.a,{href:"https://redis.io/docs/latest/commands/",children:"Redis command reference"}),"."]}),"\n",(0,i.jsx)(n.h2,{id:"connections",children:"Connections"}),"\n",(0,i.jsx)(n.h3,{id:"redis",children:"Redis Connection"}),"\n",(0,i.jsx)(n.p,{children:"Authenticate requests to a Redis server."}),"\n",(0,i.jsx)(n.p,{children:"A Redis connection requires host and port information, along with optional authentication and TLS configuration."}),"\n",(0,i.jsx)(n.h4,{id:"prerequisites",children:"Prerequisites"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"A Redis server instance accessible from the network"}),"\n",(0,i.jsx)(n.li,{children:"Authentication credentials if the server requires them"}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"configure-the-connection",children:"Configure the Connection"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Host"}),": Enter the hostname or IP address of the Redis server"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Port"}),": Enter the Redis server port (default is typically ",(0,i.jsx)(n.code,{children:"6379"}),")"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Password"}),": Enter the Redis server password"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Username"}),": Enter the Redis username (optional - required only if ACL-based authentication is enabled)"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Database"}),": Enter the logical database number to connect to (optional, e.g., ",(0,i.jsx)(n.code,{children:"0"}),")"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"tls-configuration",children:"TLS Configuration"}),"\n",(0,i.jsx)(n.p,{children:"For encrypted connections, enable TLS and provide the necessary certificates:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Use TLS"}),": Set to ",(0,i.jsx)(n.code,{children:"true"})," to enable TLS for the connection"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Client Key"}),": Provide the client private key for mutual TLS authentication (optional)"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Client Certificate"}),": Provide the client certificate for mutual TLS authentication (optional)"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"CA Certificate"}),": Provide the CA certificate to verify the server's identity (optional - if not provided, the server certificate is not verified)"]}),"\n"]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,i.jsxs)(n.table,{children:[(0,i.jsx)(n.thead,{children:(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.th,{children:"Input"}),(0,i.jsx)(n.th,{children:"Comments"}),(0,i.jsx)(n.th,{children:"Default"})]})}),(0,i.jsxs)(n.tbody,{children:[(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.td,{children:"Host"}),(0,i.jsx)(n.td,{children:"Provide the string value for the host of the server."}),(0,i.jsx)(n.td,{children:"192.168.0.1"})]}),(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.td,{children:"Port"}),(0,i.jsx)(n.td,{children:"The port of the redis server."}),(0,i.jsx)(n.td,{})]}),(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.td,{children:"Password"}),(0,i.jsx)(n.td,{}),(0,i.jsx)(n.td,{})]}),(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.td,{children:"Username"}),(0,i.jsx)(n.td,{}),(0,i.jsx)(n.td,{})]}),(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.td,{children:"Database"}),(0,i.jsx)(n.td,{children:"Select a logical database to connect to."}),(0,i.jsx)(n.td,{})]}),(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.td,{children:"Use TLS"}),(0,i.jsx)(n.td,{children:"Set to true to enable TLS for the connection."}),(0,i.jsx)(n.td,{children:"false"})]}),(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.td,{children:"Client Key"}),(0,i.jsx)(n.td,{children:"Provide the client key for the TLS connection."}),(0,i.jsx)(n.td,{})]}),(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.td,{children:"Client Certificate"}),(0,i.jsx)(n.td,{children:"Provide the client certificate for the TLS connection."}),(0,i.jsx)(n.td,{})]}),(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.td,{children:"CA Certificate"}),(0,i.jsx)(n.td,{children:"Provide the CA certificate for the TLS connection. If not provided, the connection will not be verified."}),(0,i.jsx)(n.td,{})]})]})]}),"\n",(0,i.jsx)(n.h2,{id:"actions",children:"Actions"}),"\n",(0,i.jsx)(n.h3,{id:"deletekey",children:"Delete Key"}),"\n",(0,i.jsx)(n.p,{children:"Delete the value of a key"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,i.jsxs)(n.table,{children:[(0,i.jsx)(n.thead,{children:(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.th,{children:"Input"}),(0,i.jsx)(n.th,{children:"Comments"}),(0,i.jsx)(n.th,{children:"Default"})]})}),(0,i.jsxs)(n.tbody,{children:[(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.td,{children:"Key"}),(0,i.jsx)(n.td,{children:"Provide a string value for key of the item."}),(0,i.jsx)(n.td,{})]}),(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.td,{children:"Connection"}),(0,i.jsx)(n.td,{}),(0,i.jsx)(n.td,{})]})]})]}),"\n",(0,i.jsx)(n.h3,{id:"flushall",children:"Flush All"}),"\n",(0,i.jsx)(n.p,{children:"Delete all the keys of all the existing databases, not just the currently selected one"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,i.jsxs)(n.table,{children:[(0,i.jsx)(n.thead,{children:(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.th,{children:"Input"}),(0,i.jsx)(n.th,{children:"Comments"}),(0,i.jsx)(n.th,{children:"Default"})]})}),(0,i.jsx)(n.tbody,{children:(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.td,{children:"Connection"}),(0,i.jsx)(n.td,{}),(0,i.jsx)(n.td,{})]})})]}),"\n",(0,i.jsx)(n.h3,{id:"get",children:"Get"}),"\n",(0,i.jsx)(n.p,{children:"Get the value of a key"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,i.jsxs)(n.table,{children:[(0,i.jsx)(n.thead,{children:(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.th,{children:"Input"}),(0,i.jsx)(n.th,{children:"Comments"}),(0,i.jsx)(n.th,{children:"Default"})]})}),(0,i.jsxs)(n.tbody,{children:[(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.td,{children:"Connection"}),(0,i.jsx)(n.td,{}),(0,i.jsx)(n.td,{})]}),(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.td,{children:"Key"}),(0,i.jsx)(n.td,{children:"Provide a string value for key of the item."}),(0,i.jsx)(n.td,{})]})]})]}),"\n",(0,i.jsx)(n.h3,{id:"gettime",children:"Get Time"}),"\n",(0,i.jsx)(n.p,{children:"Get the local time of the redis server"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,i.jsxs)(n.table,{children:[(0,i.jsx)(n.thead,{children:(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.th,{children:"Input"}),(0,i.jsx)(n.th,{children:"Comments"}),(0,i.jsx)(n.th,{children:"Default"})]})}),(0,i.jsx)(n.tbody,{children:(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.td,{children:"Connection"}),(0,i.jsx)(n.td,{}),(0,i.jsx)(n.td,{})]})})]}),"\n",(0,i.jsx)(n.h3,{id:"keys",children:"Keys"}),"\n",(0,i.jsx)(n.p,{children:"Returns all keys matching a specified pattern"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,i.jsxs)(n.table,{children:[(0,i.jsx)(n.thead,{children:(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.th,{children:"Input"}),(0,i.jsx)(n.th,{children:"Comments"}),(0,i.jsx)(n.th,{children:"Default"})]})}),(0,i.jsxs)(n.tbody,{children:[(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.td,{children:"Key"}),(0,i.jsx)(n.td,{children:"Provide a string value for key of the item."}),(0,i.jsx)(n.td,{})]}),(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.td,{children:"Connection"}),(0,i.jsx)(n.td,{}),(0,i.jsx)(n.td,{})]})]})]}),"\n",(0,i.jsx)(n.h3,{id:"ping",children:"Ping"}),"\n",(0,i.jsx)(n.p,{children:"Send a ping to the redis server"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,i.jsxs)(n.table,{children:[(0,i.jsx)(n.thead,{children:(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.th,{children:"Input"}),(0,i.jsx)(n.th,{children:"Comments"}),(0,i.jsx)(n.th,{children:"Default"})]})}),(0,i.jsx)(n.tbody,{children:(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.td,{children:"Connection"}),(0,i.jsx)(n.td,{}),(0,i.jsx)(n.td,{})]})})]}),"\n",(0,i.jsx)(n.h3,{id:"set",children:"Set"}),"\n",(0,i.jsx)(n.p,{children:"Set the value of a key"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,i.jsxs)(n.table,{children:[(0,i.jsx)(n.thead,{children:(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.th,{children:"Input"}),(0,i.jsx)(n.th,{children:"Comments"}),(0,i.jsx)(n.th,{children:"Default"})]})}),(0,i.jsxs)(n.tbody,{children:[(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.td,{children:"Key"}),(0,i.jsx)(n.td,{children:"Provide a string value for key of the item."}),(0,i.jsx)(n.td,{})]}),(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.td,{children:"Value"}),(0,i.jsx)(n.td,{children:"Provide a string for the value to be set."}),(0,i.jsx)(n.td,{})]}),(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.td,{children:"Connection"}),(0,i.jsx)(n.td,{}),(0,i.jsx)(n.td,{})]})]})]})]})}function a(e={}){let{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(o,{...e})}):o(e)}},57624(e,n,t){t.d(n,{A:()=>s});let s="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAACXBIWXMAABcRAAAXEQHKJvM/AAAH7klEQVRYhb1Xa2wU5xUdG1TRFrIz6931rnfn+2ZmX96nDUgVrVJopVZJW0VppVLEn6ZKVSVRfjRVfhC1jVBfP9KkVaWmLwgx3l0/cYCQEJIQcIDwKKGkMfa+bGzj2iGEppQEbB6zc6r77YO1i9oG2n7S7uy87j3n3HPvzErSbS5IUsPtxvjIC5LUOLhGWlxNTtvKfuP/MmkDJdm48UaS8jG+BHXH6Hw9uNte/WulRVgrLao/VlwZ8A8HnBvyEd/+fFtgMh9RD+fCLT/MJvXQPNB0bx24/3jhhqQ1FrlweFk+pq3LxbUX8hE2+97dd2J6VRyjTMHUyjDeXb0c+bg2J84n9LWDUefSfxXv5onXzkcMoGF0VWJFoT34i3zSmJpqD2C63W/luB1/+e4D5tWpSfP99LPWXHbYnPjGV8ycasP08oB1JqkjF+eTw1H+86G4N/nvFJVE4jp0+VDIUWjzfycbbjmQN1zmt

1N+JMcOJkUBzKRfXzemHv219OLgX1twcaFmmiQsDvRj/+petXISZhYReOpM0cL49gPGEfi0b468NR7X7Jtq4XK/KPEUIRCGhfzYX1zdlY+z8VLAZM6tXYOr+9dbMow+b0488aE2uuweF9gAKK8Ioropj7HOfwpVCDme//yjGv7QG43cuRzHGMRTjGAy1lHp8snks7LXOtvutc+0BUuWdfIz/upjgq+Z1zFhCuy8bYydHE7r1Tpsfo1GG9377q5J56ZKJUgm1ZZq4NjWJM99ah6zhQi7Ugol7v4jCihCGDReOBNx4JeDGDsOFPs2BHyxtxGOflPCU/WPmS5qjNJbQMNNmWOMJHYW4tueEx/MJaUCTeT7OZ8+2+VFM6KVcTDOzUWZ9eGBfOWk9gMrvd3/6OLK6E4U2P7J+F3KGE6eCHhwIe7HTcGFAdwoAjy9rxI9sjXjGvRSDATcltYpx7XouznEk5Jmj3NImZtO7mXJpb6AZb0WZVUzoGI1xcjSmHvgm/vqbX+JCpgN/63wG5574CU5/4dMYdn0c+bBXlGN09UoqE86suwfFVh9yCR3HIyr2Bj3YrTnwdpThTJsfk0k/hqIM+4Nua5vWhK0+2wc9LYoqDTCb0cuUKxmmoIsp1m7DiT9SoDhH0XAhq8oY0ZowosrIGk7MPPIQLu7ajsvHDuPqaBGly5dQmr2MyfX3Iht0I580UIxrGE3oIjFtT7T6sMfvQg+3Y6sqW91MwXOaMtvjV1Spg9vkTiafSDEZKVW2OlUZabpAd+BAxIfhpIExYtoeQL4tgPGv3YX3t/wO187O1Cpz7okfC4B5KmMleTau4XDYi+d1J4gcxU0x2UqpMu2bHaryWM2Eb0Z96/cF3FcHtCYBQoApAxKoXw4040RERSGuoxj0YMRnEwpNf+8hnP/D02XWMY7RhIFTMY7XQx5UYqE+Vh9vsl4LuKks1yfbjKcgSYuklwJ2XzbGLk6ToWKadTjcgueNetTlLe0TmzdafciStHENecOJouEUjN+KMrwaaEYvt5fvU2XMUzPUgpEYp7kguuDtiHd2l6EwaQuzGQNa09yhsLjAmiDJEzr+FFHxir8ZfdxeYaKUP6oMMtH+oAfHYxxHowx7/M3knxpguob2XzCcONbqQyGhg+Lm4hreCHstItKp2j54lkzYxWxGlypfIaR9WpMluiGi4nRCx3jSwHCMC/TbdYdgU2VXqeU/HSMFXq3EGKvEOBVjGAzWymLRfc9p9tl+UqDf7XZ2qvJEplwrYcIq+qOtPtGOhJ5YUHfs9rvQvSBpWRUHXg96BODxmoo+4Z+e+WWxejjdf8fmmgkPh7wbiHk3t5e7oHIxsSPUgyEPhmJMBD6dNPDnKMPeoBs7dYcAejDcIuQloAT4SLgFuxb4qK4s1smIiomE/nvxUCITjsTYxamkQYPC2h90ixrXs6MgxIJ6+c1WVZiOkhXjeu33SKVUN3N/tSwE/HTSsKi8J1srJkwxm75Na5o7WHapNV5j4V3A4kbddxoO0eM05YgNge5fAJquL7vfI8BVTXgo1GLt0B3YWjXhQNmEc1SbXm4vCQOVkYpPtb0WdgOVqZvbhaz1SmXq3F+smjDKsa8CstMnX6d7Brgyu4Mm4Rb3UmcXV2Z26U1iFG9VZTOjKqVduhNHWr01E2ZjHAdDnvndUAHTWQHzsv8GeDLhiUh5BHcze4niUuLtmr1Cxr55Y/WR3KM7QmnVvinDlL/v0JrQrwm2pU5VNgk1oR+Klt1NNT8e8eFFv4smm6g5GZhMKrqFytfqFQZNq7JI3MMUUNwuVZlLMXtfD1M+s/BtrIG+0l67r4spG1Kqkt/G7dSrxNbqUGWzmyklakF60hGI04myV6g9CVg2poleJ8CUlEq6TbMLxmlVOZtW5SfT2rJwNWGFfUP19aixn+ZyZXVwaUmK276aUpUXu5hyldD3lqU2SRky0aGwV7iaJua+gIecLsqXVhVrO6nIReKTGa48uNl3h70+cX2ueetmJ7tVJZZW7U+mmTJDgQc0MVRoXlzPMIWmWrW+1g7NTkPqatqn7OzSlLs2rpEWV+NQ3I/yx6VhUJIW10wiVLHJaW67P6UqR4ktSdvLFfTzcuIuVbmQVpWnUz4lvuDFkwjd+p8ULFCFQGW47fMZJnenVWUizZShDFN+1ulRWBU8XVNJ/F9dDaRK/at0B+dLBtesuWWZb3lRovry/N8S32SRGrf1J/Qfc+dy4mF6zbUAAAAASUVORK5CYII="},28453(e,n,t){t.d(n,{R:()=>d,x:()=>l});var s=t(96540);let i={},r=s.createContext(i);function d(e){let n=s.useContext(r);return s.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:d(e.components),s.createElement(r.Provider,{value:n},e.children)}}}]);