Browse code

modules: readme files regenerated - db_cluster ... [skip ci]

Kamailio Dev authored on 27/10/2021 13:01:17
Showing 1 changed files
... ...
@@ -10,6 +10,10 @@ Daniel-Constantin Mierla
10 10
 
11 11
    <miconda@gmail.com>
12 12
 
13
+Frits Wiersma
14
+
15
+   <frits.wiersma@isp.solcon.nl>
16
+
13 17
    Copyright © 2012 asipto.com
14 18
      __________________________________________________________________
15 19
 
... ...
@@ -31,6 +35,12 @@ Daniel-Constantin Mierla
31 35
               3.4. max_query_length (int)
32 36
 
33 37
         4. Usage
38
+        5. RPC Commands
39
+
40
+              5.1. dbcl.list_clusters
41
+              5.2. dbcl.list_connections
42
+              5.3. dbcl.disable_connection
43
+              5.4. dbcl.enable_connection
34 44
 
35 45
    List of Examples
36 46
 
... ...
@@ -58,6 +68,12 @@ Chapter 1. Admin Guide
58 68
         3.4. max_query_length (int)
59 69
 
60 70
    4. Usage
71
+   5. RPC Commands
72
+
73
+        5.1. dbcl.list_clusters
74
+        5.2. dbcl.list_connections
75
+        5.3. dbcl.disable_connection
76
+        5.4. dbcl.enable_connection
61 77
 
62 78
 1. Overview
63 79
 
... ...
@@ -204,3 +220,58 @@ modparam("acc", "db_url", "cluster://k1")
204 220
 
205 221
 modparam("sqlops", "sqlcon", "ca=>cluster://k1")
206 222
 ...
223
+
224
+5. RPC Commands
225
+
226
+   5.1. dbcl.list_clusters
227
+   5.2. dbcl.list_connections
228
+   5.3. dbcl.disable_connection
229
+   5.4. dbcl.enable_connection
230
+
231
+5.1. dbcl.list_clusters
232
+
233
+   Lists all database clusters.
234
+
235
+   Name: dbcl.list_clusters
236
+
237
+   RPC Command Format:
238
+...
239
+kamcmd dbcl.list_clusters
240
+...
241
+
242
+5.2. dbcl.list_connections
243
+
244
+   Lists all database connections of a specific cluster.
245
+
246
+   Name: dbcl.list_connections
247
+
248
+   RPC Command Format:
249
+...
250
+kamcmd dbcl.list_connections clustername
251
+...
252
+
253
+5.3. dbcl.disable_connection
254
+
255
+   Disable a database connection of a specific cluster for a period. The
256
+   database connection remains open but will not be used for the specified
257
+   period (seconds). The command does not allow to close all database
258
+   connections of the specific cluster. If the database connection is
259
+   already disabled than the new period will overwrite the old period.
260
+
261
+   Name: dbcl.disable_connection
262
+
263
+   RPC Command Format:
264
+...
265
+kamcmd dbcl.disable_connection clustername connectionname period
266
+...
267
+
268
+5.4. dbcl.enable_connection
269
+
270
+   Enable a database connection of a specific cluster.
271
+
272
+   Name: dbcl.enable_connection
273
+
274
+   RPC Command Format:
275
+...
276
+kamcmd dbcl.enable_connection clustername connectionname
277
+...