Browse code

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

Kamailio Dev authored on 15/05/2019 14:32:26
Showing 1 changed files
... ...
@@ -47,6 +47,7 @@ Olle E. Johansson
47 47
               4.3. default_connection (string)
48 48
               4.4. emptystring (integer)
49 49
               4.5. file_buffer_size (integer)
50
+              4.6. max_result_rows (integer)
50 51
 
51 52
         5. Exported RPC Functions
52 53
 
... ...
@@ -69,11 +70,12 @@ Olle E. Johansson
69 69
    1.6. Set default_connection parameter
70 70
    1.7. Set emptystring parameter
71 71
    1.8. Set file_buffer_size parameter
72
-   1.9. Load the dbtext module
73
-   1.10. Definition of 'subscriber' table (one line)
74
-   1.11. Definition of 'location' and 'aliases' tables (one line)
75
-   1.12. Definition of 'version' table and sample records
76
-   1.13. Configuration file
72
+   1.9. Set max_result_rows parameter
73
+   1.10. Load the dbtext module
74
+   1.11. Definition of 'subscriber' table (one line)
75
+   1.12. Definition of 'location' and 'aliases' tables (one line)
76
+   1.13. Definition of 'version' table and sample records
77
+   1.14. Configuration file
77 78
 
78 79
 Chapter 1. Admin Guide
79 80
 
... ...
@@ -97,6 +99,7 @@ Chapter 1. Admin Guide
97 97
         4.3. default_connection (string)
98 98
         4.4. emptystring (integer)
99 99
         4.5. file_buffer_size (integer)
100
+        4.6. max_result_rows (integer)
100 101
 
101 102
    5. Exported RPC Functions
102 103
 
... ...
@@ -224,6 +227,7 @@ suser:supasswd:xxx:alpha.org:xxx
224 224
    4.3. default_connection (string)
225 225
    4.4. emptystring (integer)
226 226
    4.5. file_buffer_size (integer)
227
+   4.6. max_result_rows (integer)
227 228
 
228 229
 4.1. db_mode (integer)
229 230
 
... ...
@@ -281,13 +285,24 @@ modparam("db_text", "emptystring", 1)
281 281
    size of the buffer used to read the text file. Some presence tables
282 282
    have columns with large content.
283 283
 
284
-   Default value is “16384” (off).
284
+   Default value is “16384”.
285 285
 
286 286
    Example 1.8. Set file_buffer_size parameter
287 287
 ...
288 288
 modparam("db_text", "file_buffer_size", 8192)
289 289
 ...
290 290
 
291
+4.6. max_result_rows (integer)
292
+
293
+   number of rows to read from the text file.
294
+
295
+   Default value is “100000”.
296
+
297
+   Example 1.9. Set max_result_rows parameter
298
+...
299
+modparam("db_text", "max_result_rows", 1000000)
300
+...
301
+
291 302
 5. Exported RPC Functions
292 303
 
293 304
    5.1. db_text.dump
... ...
@@ -328,7 +343,7 @@ modparam("db_text", "file_buffer_size", 8192)
328 328
    database path. So, either you provide an absolute path to database
329 329
    directory or a relative one to “CFG_DIR” directory.
330 330
 
331
-   Example 1.9. Load the dbtext module
331
+   Example 1.10. Load the dbtext module
332 332
 ...
333 333
 loadmodule "/path/to/kamailio/modules_k/db_text.so"
334 334
 ...
... ...
@@ -347,7 +362,7 @@ modparam("module_name", "db_url", "text:///path/to/dbtext/database")
347 347
    in order to have authentication. To use with the given configuration
348 348
    file, the table files must be placed in the '/tmp/serdb' directory.
349 349
 
350
-   Example 1.10. Definition of 'subscriber' table (one line)
350
+   Example 1.11. Definition of 'subscriber' table (one line)
351 351
 ...
352 352
 username(str) domain(str) password(str) first_name(str) last_name(str) phone(str
353 353
 ) email_address(str) datetime_created(int) datetime_modified(int) confirmation(s
... ...
@@ -355,14 +370,14 @@ tr) flag(str) sendnotification(str) greeting(str) ha1(str) ha1b(str) perms(str)
355 355
 allow_find(str) timezone(str,null) rpid(str,null)
356 356
 ...
357 357
 
358
-   Example 1.11. Definition of 'location' and 'aliases' tables (one line)
358
+   Example 1.12. Definition of 'location' and 'aliases' tables (one line)
359 359
 ...
360 360
 username(str) domain(str,null) contact(str,null) received(str) expires(int,null)
361 361
  q(double,null) callid(str,null) cseq(int,null) last_modified(str) flags(int) us
362 362
 er_agent(str) socket(str)
363 363
 ...
364 364
 
365
-   Example 1.12. Definition of 'version' table and sample records
365
+   Example 1.13. Definition of 'version' table and sample records
366 366
 ...
367 367
 table_name(str) table_version(int)
368 368
 subscriber:3
... ...
@@ -370,7 +385,7 @@ location:6
370 370
 aliases:6
371 371
 ...
372 372
 
373
-   Example 1.13. Configuration file
373
+   Example 1.14. Configuration file
374 374
 ...
375 375
 #
376 376
 #