[WSO2-Release] [Release 3.1.1] update documentation for release 3.1.1

siddhi-io · Aug 6, 2019 · efc6b01 · efc6b01
1 parent acecc68
commit efc6b01
Show file tree

Hide file tree

Showing 5 changed files with 166 additions and 54 deletions.
diff --git a/README.md b/README.md
@@ -19,11 +19,11 @@ For information on <a target="_blank" href="https://siddhi.io/">Siddhi</a> and i
 
 ## Latest API Docs 
 
-Latest API Docs is <a target="_blank" href="https://siddhi-io.github.io/siddhi-store-redis/api/3.1.0">3.1.0</a>.
+Latest API Docs is <a target="_blank" href="https://siddhi-io.github.io/siddhi-store-redis/api/3.1.1">3.1.1</a>.
 
 ## Features
 
-* <a target="_blank" href="https://siddhi-io.github.io/siddhi-store-redis/api/3.1.0/#redis-store">redis</a> *<a target="_blank" href="https://siddhi.io/en/v5.0/docs/query-guide/#store">(Store)</a>*<br><div style="padding-left: 1em;"><p>This extension assigns data source and connection instructions to event tables. It also implements read write operations on connected datasource. This extension only can be used to read the data which persisted using the same extension since unique implementation has been used to map the relational data in to redis's key and value representation</p></div>
+* <a target="_blank" href="https://siddhi-io.github.io/siddhi-store-redis/api/3.1.1/#redis-store">redis</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#store">Store</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">This extension assigns data source and connection instructions to event tables. It also implements read write operations on connected datasource. This extension only can be used to read the data which persisted using the same extension since unique implementation has been used to map the relational data in to redis's key and value representation</p></p></div>
 
 ## Dependencies 
 

diff --git a/docs/api/3.1.1.md b/docs/api/3.1.1.md
@@ -0,0 +1,104 @@
+# API Docs - v3.1.1
+
+!!! Info "Tested Siddhi Core version: *<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/">5.1.2</a>*"
+    It could also support other Siddhi Core minor versions.
+
+## Store
+
+### redis *<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#store">(Store)</a>*
+<p></p>
+<p style="word-wrap: break-word;margin: 0;">This extension assigns data source and connection instructions to event tables. It also implements read write operations on connected datasource. This extension only can be used to read the data which persisted using the same extension since unique implementation has been used to map the relational data in to redis's key and value representation</p>
+<p></p>
+<span id="syntax" class="md-typeset" style="display: block; font-weight: bold;">Syntax</span>
+
+```
+@Store(type="redis", table.name="<STRING>", cluster.mode="<BOOL>", nodes="<STRING>", ttl.seconds="<LONG>", ttl.on.update="<BOOL>", ttl.on.read="<BOOL>")
+@PrimaryKey("PRIMARY_KEY")
+@Index("INDEX")
+```
+
+<span id="query-parameters" class="md-typeset" style="display: block; color: rgba(0, 0, 0, 0.54); font-size: 12.8px; font-weight: bold;">QUERY PARAMETERS</span>
+<table>
+    <tr>
+        <th>Name</th>
+        <th style="min-width: 20em">Description</th>
+        <th>Default Value</th>
+        <th>Possible Data Types</th>
+        <th>Optional</th>
+        <th>Dynamic</th>
+    </tr>
+    <tr>
+        <td style="vertical-align: top">table.name</td>
+        <td style="vertical-align: top; word-wrap: break-word"><p style="word-wrap: break-word;margin: 0;">The name with which the event table should be persisted in the store. If noname is specified via this parameter, the event table is persisted with the same name as the Siddhi table.</p></td>
+        <td style="vertical-align: top">The tale name defined in the siddhi app</td>
+        <td style="vertical-align: top">STRING</td>
+        <td style="vertical-align: top">Yes</td>
+        <td style="vertical-align: top">No</td>
+    </tr>
+    <tr>
+        <td style="vertical-align: top">cluster.mode</td>
+        <td style="vertical-align: top; word-wrap: break-word"><p style="word-wrap: break-word;margin: 0;">This will decide the redis mode. if this is false, client will connect to a single redis node.</p></td>
+        <td style="vertical-align: top">false</td>
+        <td style="vertical-align: top">BOOL</td>
+        <td style="vertical-align: top">No</td>
+        <td style="vertical-align: top">No</td>
+    </tr>
+    <tr>
+        <td style="vertical-align: top">nodes</td>
+        <td style="vertical-align: top; word-wrap: break-word"><p style="word-wrap: break-word;margin: 0;">host, port and the password of the node(s).In single node mode node details can be provided as follows- "node='hosts:port@password'" <br>In clustered mode host and port of all the master nodes should be provided separated by a comma(,). As an example "nodes = 'localhost:30001,localhost:30002'".</p></td>
+        <td style="vertical-align: top">localhost:6379@root</td>
+        <td style="vertical-align: top">STRING</td>
+        <td style="vertical-align: top">Yes</td>
+        <td style="vertical-align: top">No</td>
+    </tr>
+    <tr>
+        <td style="vertical-align: top">ttl.seconds</td>
+        <td style="vertical-align: top; word-wrap: break-word"><p style="word-wrap: break-word;margin: 0;">Time to live in seconds for each record</p></td>
+        <td style="vertical-align: top">-1</td>
+        <td style="vertical-align: top">LONG</td>
+        <td style="vertical-align: top">Yes</td>
+        <td style="vertical-align: top">No</td>
+    </tr>
+    <tr>
+        <td style="vertical-align: top">ttl.on.update</td>
+        <td style="vertical-align: top; word-wrap: break-word"><p style="word-wrap: break-word;margin: 0;">Set ttl on row update</p></td>
+        <td style="vertical-align: top">false</td>
+        <td style="vertical-align: top">BOOL</td>
+        <td style="vertical-align: top">Yes</td>
+        <td style="vertical-align: top">No</td>
+    </tr>
+    <tr>
+        <td style="vertical-align: top">ttl.on.read</td>
+        <td style="vertical-align: top; word-wrap: break-word"><p style="word-wrap: break-word;margin: 0;">Set ttl on read rows</p></td>
+        <td style="vertical-align: top">false</td>
+        <td style="vertical-align: top">BOOL</td>
+        <td style="vertical-align: top">Yes</td>
+        <td style="vertical-align: top">No</td>
+    </tr>
+</table>
+
+<span id="examples" class="md-typeset" style="display: block; font-weight: bold;">Examples</span>
+<span id="example-1" class="md-typeset" style="display: block; color: rgba(0, 0, 0, 0.54); font-size: 12.8px; font-weight: bold;">EXAMPLE 1</span>
+```
+@store(type='redis',nodes='localhost:6379@root',table.name='fooTable',cluster.mode=false)define table fooTable(time long, date String)
+```
+<p></p>
+<p style="word-wrap: break-word;margin: 0;">Above example will create a redis table with the name fooTable and work on asingle redis node.</p>
+<p></p>
+<span id="example-2" class="md-typeset" style="display: block; color: rgba(0, 0, 0, 0.54); font-size: 12.8px; font-weight: bold;">EXAMPLE 2</span>
+```
+@Store(type='redis', table.name='SweetProductionTable', nodes='localhost:30001,localhost:30002,localhost:30003', cluster.mode='true')
+@primaryKey('symbol')
+@index('price') 
+define table SweetProductionTable (symbol string, price float, volume long);
+```
+<p></p>
+<p style="word-wrap: break-word;margin: 0;">Above example demonstrate how to use the redis extension to connect in to redis cluster. Please note that, as nodes all the master node's host and port should be provided in order to work correctly. In clustered node password will not besupported</p>
+<p></p>
+<span id="example-3" class="md-typeset" style="display: block; color: rgba(0, 0, 0, 0.54); font-size: 12.8px; font-weight: bold;">EXAMPLE 3</span>
+```
+@store(type='redis',nodes='localhost:6379@root',table.name='fooTable', ttl.seconds='30', ttl.onUpdate='true', ttl.onRead='true')define table fooTable(time long, date String)
+```
+<p></p>
+<p style="word-wrap: break-word;margin: 0;">Above example will create a redis table with the name fooTable and work on asingle redis node.  All rows inserted, updated or read will have its ttl set to 30 seconds</p>
+<p></p>
diff --git a/docs/api/latest.md b/docs/api/latest.md
@@ -1,12 +1,16 @@
-# API Docs - v3.1.0
+# API Docs - v3.1.1
 
-## Store
-
-### redis *<a target="_blank" href="https://siddhi.io/en/v5.0/docs/query-guide/#store">(Store)</a>*
+!!! Info "Tested Siddhi Core version: *<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/">5.1.2</a>*"
+    It could also support other Siddhi Core minor versions.
 
-<p style="word-wrap: break-word">This extension assigns data source and connection instructions to event tables. It also implements read write operations on connected datasource. This extension only can be used to read the data which persisted using the same extension since unique implementation has been used to map the relational data in to redis's key and value representation</p>
+## Store
 
+### redis *<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#store">(Store)</a>*
+<p></p>
+<p style="word-wrap: break-word;margin: 0;">This extension assigns data source and connection instructions to event tables. It also implements read write operations on connected datasource. This extension only can be used to read the data which persisted using the same extension since unique implementation has been used to map the relational data in to redis's key and value representation</p>
+<p></p>
 <span id="syntax" class="md-typeset" style="display: block; font-weight: bold;">Syntax</span>
+
 ```
 @Store(type="redis", table.name="<STRING>", cluster.mode="<BOOL>", nodes="<STRING>", ttl.seconds="<LONG>", ttl.on.update="<BOOL>", ttl.on.read="<BOOL>")
 @PrimaryKey("PRIMARY_KEY")
@@ -25,47 +29,47 @@
     </tr>
     <tr>
         <td style="vertical-align: top">table.name</td>
-        <td style="vertical-align: top; word-wrap: break-word">The name with which the event table should be persisted in the store. If noname is specified via this parameter, the event table is persisted with the same name as the Siddhi table.</td>
+        <td style="vertical-align: top; word-wrap: break-word"><p style="word-wrap: break-word;margin: 0;">The name with which the event table should be persisted in the store. If noname is specified via this parameter, the event table is persisted with the same name as the Siddhi table.</p></td>
         <td style="vertical-align: top">The tale name defined in the siddhi app</td>
         <td style="vertical-align: top">STRING</td>
         <td style="vertical-align: top">Yes</td>
         <td style="vertical-align: top">No</td>
     </tr>
     <tr>
         <td style="vertical-align: top">cluster.mode</td>
-        <td style="vertical-align: top; word-wrap: break-word">This will decide the redis mode. if this is false, client will connect to a single redis node.</td>
+        <td style="vertical-align: top; word-wrap: break-word"><p style="word-wrap: break-word;margin: 0;">This will decide the redis mode. if this is false, client will connect to a single redis node.</p></td>
         <td style="vertical-align: top">false</td>
         <td style="vertical-align: top">BOOL</td>
         <td style="vertical-align: top">No</td>
         <td style="vertical-align: top">No</td>
     </tr>
     <tr>
         <td style="vertical-align: top">nodes</td>
-        <td style="vertical-align: top; word-wrap: break-word">host, port and the password of the node(s).In single node mode node details can be provided as follows- "node='hosts:port@password'" <br>In clustered mode host and port of all the master nodes should be provided separated by a comma(,). As an example "nodes = 'localhost:30001,localhost:30002'".</td>
+        <td style="vertical-align: top; word-wrap: break-word"><p style="word-wrap: break-word;margin: 0;">host, port and the password of the node(s).In single node mode node details can be provided as follows- "node='hosts:port@password'" <br>In clustered mode host and port of all the master nodes should be provided separated by a comma(,). As an example "nodes = 'localhost:30001,localhost:30002'".</p></td>
         <td style="vertical-align: top">localhost:6379@root</td>
         <td style="vertical-align: top">STRING</td>
         <td style="vertical-align: top">Yes</td>
         <td style="vertical-align: top">No</td>
     </tr>
     <tr>
         <td style="vertical-align: top">ttl.seconds</td>
-        <td style="vertical-align: top; word-wrap: break-word">Time to live in seconds for each record</td>
+        <td style="vertical-align: top; word-wrap: break-word"><p style="word-wrap: break-word;margin: 0;">Time to live in seconds for each record</p></td>
         <td style="vertical-align: top">-1</td>
         <td style="vertical-align: top">LONG</td>
         <td style="vertical-align: top">Yes</td>
         <td style="vertical-align: top">No</td>
     </tr>
     <tr>
         <td style="vertical-align: top">ttl.on.update</td>
-        <td style="vertical-align: top; word-wrap: break-word">Set ttl on row update</td>
+        <td style="vertical-align: top; word-wrap: break-word"><p style="word-wrap: break-word;margin: 0;">Set ttl on row update</p></td>
         <td style="vertical-align: top">false</td>
         <td style="vertical-align: top">BOOL</td>
         <td style="vertical-align: top">Yes</td>
         <td style="vertical-align: top">No</td>
     </tr>
     <tr>
         <td style="vertical-align: top">ttl.on.read</td>
-        <td style="vertical-align: top; word-wrap: break-word">Set ttl on read rows</td>
+        <td style="vertical-align: top; word-wrap: break-word"><p style="word-wrap: break-word;margin: 0;">Set ttl on read rows</p></td>
         <td style="vertical-align: top">false</td>
         <td style="vertical-align: top">BOOL</td>
         <td style="vertical-align: top">Yes</td>
@@ -78,20 +82,23 @@
 ```
 @store(type='redis',nodes='localhost:6379@root',table.name='fooTable',cluster.mode=false)define table fooTable(time long, date String)
 ```
-<p style="word-wrap: break-word">Above example will create a redis table with the name fooTable and work on asingle redis node.</p>
-
+<p></p>
+<p style="word-wrap: break-word;margin: 0;">Above example will create a redis table with the name fooTable and work on asingle redis node.</p>
+<p></p>
 <span id="example-2" class="md-typeset" style="display: block; color: rgba(0, 0, 0, 0.54); font-size: 12.8px; font-weight: bold;">EXAMPLE 2</span>
 ```
 @Store(type='redis', table.name='SweetProductionTable', nodes='localhost:30001,localhost:30002,localhost:30003', cluster.mode='true')
 @primaryKey('symbol')
 @index('price') 
 define table SweetProductionTable (symbol string, price float, volume long);
 ```
-<p style="word-wrap: break-word">Above example demonstrate how to use the redis extension to connect in to redis cluster. Please note that, as nodes all the master node's host and port should be provided in order to work correctly. In clustered node password will not besupported</p>
-
+<p></p>
+<p style="word-wrap: break-word;margin: 0;">Above example demonstrate how to use the redis extension to connect in to redis cluster. Please note that, as nodes all the master node's host and port should be provided in order to work correctly. In clustered node password will not besupported</p>
+<p></p>
 <span id="example-3" class="md-typeset" style="display: block; color: rgba(0, 0, 0, 0.54); font-size: 12.8px; font-weight: bold;">EXAMPLE 3</span>
 ```
 @store(type='redis',nodes='localhost:6379@root',table.name='fooTable', ttl.seconds='30', ttl.onUpdate='true', ttl.onRead='true')define table fooTable(time long, date String)
 ```
-<p style="word-wrap: break-word">Above example will create a redis table with the name fooTable and work on asingle redis node.  All rows inserted, updated or read will have its ttl set to 30 seconds</p>
-
+<p></p>
+<p style="word-wrap: break-word;margin: 0;">Above example will create a redis table with the name fooTable and work on asingle redis node.  All rows inserted, updated or read will have its ttl set to 30 seconds</p>
+<p></p>
diff --git a/docs/index.md b/docs/index.md
@@ -19,11 +19,11 @@ For information on <a target="_blank" href="https://siddhi.io/">Siddhi</a> and i
 
 ## Latest API Docs 
 
-Latest API Docs is <a target="_blank" href="https://siddhi-io.github.io/siddhi-store-redis/api/3.1.0">3.1.0</a>.
+Latest API Docs is <a target="_blank" href="https://siddhi-io.github.io/siddhi-store-redis/api/3.1.1">3.1.1</a>.
 
 ## Features
 
-* <a target="_blank" href="https://siddhi-io.github.io/siddhi-store-redis/api/3.1.0/#redis-store">redis</a> *<a target="_blank" href="https://siddhi.io/en/v5.0/docs/query-guide/#store">(Store)</a>*<br><div style="padding-left: 1em;"><p>This extension assigns data source and connection instructions to event tables. It also implements read write operations on connected datasource. This extension only can be used to read the data which persisted using the same extension since unique implementation has been used to map the relational data in to redis's key and value representation</p></div>
+* <a target="_blank" href="https://siddhi-io.github.io/siddhi-store-redis/api/3.1.1/#redis-store">redis</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#store">Store</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">This extension assigns data source and connection instructions to event tables. It also implements read write operations on connected datasource. This extension only can be used to read the data which persisted using the same extension since unique implementation has been used to map the relational data in to redis's key and value representation</p></p></div>
 
 ## Dependencies 
 

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -12,42 +12,43 @@ theme:
     primary: teal
     accent: teal
 extra_css:
-  - assets/stylesheets/extra.css
+- assets/stylesheets/extra.css
 extra_javascript:
-  - assets/javascripts/extra.js
+- assets/javascripts/extra.js
 extra:
   social:
-    - type: github
-      link: https://github.com/siddhi-io/siddhi
-    - type: medium
-      link: https://medium.com/siddhi-io
-    - type: twitter
-      link: https://twitter.com/siddhi_io
-    - type: linkedin
-      link: https://www.linkedin.com/groups/13553064
+  - type: github
+    link: https://github.com/siddhi-io/siddhi
+  - type: medium
+    link: https://medium.com/siddhi-io
+  - type: twitter
+    link: https://twitter.com/siddhi_io
+  - type: linkedin
+    link: https://www.linkedin.com/groups/13553064
 google_analytics:
-  - UA-103065-28
-  - auto
+- UA-103065-28
+- auto
 markdown_extensions:
-  - markdown.extensions.admonition
+- markdown.extensions.admonition
 pages:
-  - Information: index.md
-  - API Docs:
-      - latest: api/latest.md
-      - 3.1.0: api/3.1.0.md
-      - 3.0.0: api/3.0.0.md
-      - 2.1.0: api/2.1.0.md
-      - 2.0.1: api/2.0.1.md
-      - 2.0.0: api/2.0.0.md
-      - 1.0.11: api/1.0.11.md
-      - 1.0.10: api/1.0.10.md
-      - 1.0.9: api/1.0.9.md
-      - 1.0.8: api/1.0.8.md
-      - 1.0.7: api/1.0.7.md
-      - 1.0.6: api/1.0.6.md
-      - 1.0.5: api/1.0.5.md
-      - 1.0.4: api/1.0.4.md
-      - 1.0.3: api/1.0.3.md
-      - 1.0.2: api/1.0.2.md
-      - 1.0.1: api/1.0.1.md
-  - License: license.md
+- Information: index.md
+- API Docs:
+  - latest: api/latest.md
+  - 3.1.1: api/3.1.1.md
+  - 3.1.0: api/3.1.0.md
+  - 3.0.0: api/3.0.0.md
+  - 2.1.0: api/2.1.0.md
+  - 2.0.1: api/2.0.1.md
+  - 2.0.0: api/2.0.0.md
+  - 1.0.11: api/1.0.11.md
+  - 1.0.10: api/1.0.10.md
+  - 1.0.9: api/1.0.9.md
+  - 1.0.8: api/1.0.8.md
+  - 1.0.7: api/1.0.7.md
+  - 1.0.6: api/1.0.6.md
+  - 1.0.5: api/1.0.5.md
+  - 1.0.4: api/1.0.4.md
+  - 1.0.3: api/1.0.3.md
+  - 1.0.2: api/1.0.2.md
+  - 1.0.1: api/1.0.1.md
+- License: license.md