92
92
<h3 class="section-bar">Methods</h3>
94
94
<div class="name-list">
95
<a href="#M000019">doc_num</a>
96
<a href="#M000009">edit_doc</a>
97
<a href="#M000014">etch_doc</a>
98
<a href="#M000015">etch_doc_by_uri</a>
99
<a href="#M000010">get_doc</a>
100
<a href="#M000012">get_doc_attr</a>
101
<a href="#M000013">get_doc_attr_by_uri</a>
102
<a href="#M000011">get_doc_by_uri</a>
103
<a href="#M000018">label</a>
104
<a href="#M000017">name</a>
105
<a href="#M000026">new</a>
106
<a href="#M000007">out_doc</a>
107
<a href="#M000008">out_doc_by_uri</a>
108
<a href="#M000006">put_doc</a>
109
<a href="#M000022">search</a>
95
<a href="#M000025">admins</a>
96
<a href="#M000024">cache_usage</a>
97
<a href="#M000021">doc_num</a>
98
<a href="#M000011">edit_doc</a>
99
<a href="#M000016">etch_doc</a>
100
<a href="#M000017">etch_doc_by_uri</a>
101
<a href="#M000012">get_doc</a>
102
<a href="#M000014">get_doc_attr</a>
103
<a href="#M000015">get_doc_attr_by_uri</a>
104
<a href="#M000013">get_doc_by_uri</a>
105
<a href="#M000020">label</a>
106
<a href="#M000027">links</a>
107
<a href="#M000019">name</a>
108
<a href="#M000032">new</a>
109
<a href="#M000007">optimize</a>
110
<a href="#M000009">out_doc</a>
111
<a href="#M000010">out_doc_by_uri</a>
112
<a href="#M000008">put_doc</a>
113
<a href="#M000028">search</a>
110
114
<a href="#M000004">set_auth</a>
111
<a href="#M000025">set_link</a>
115
<a href="#M000031">set_link</a>
112
116
<a href="#M000002">set_proxy</a>
113
<a href="#M000023">set_snippet_width</a>
117
<a href="#M000029">set_snippet_width</a>
114
118
<a href="#M000003">set_timeout</a>
115
119
<a href="#M000001">set_url</a>
116
<a href="#M000024">set_user</a>
117
<a href="#M000021">size</a>
120
<a href="#M000030">set_user</a>
121
<a href="#M000023">size</a>
118
122
<a href="#M000005">status</a>
119
<a href="#M000016">uri_to_id</a>
120
<a href="#M000020">word_num</a>
123
<a href="#M000006">sync</a>
124
<a href="#M000018">uri_to_id</a>
125
<a href="#M000026">users</a>
126
<a href="#M000022">word_num</a>
139
145
<div id="methods">
140
146
<h3 class="section-bar">Public Class methods</h3>
142
<div id="method-M000026" class="method-detail">
143
<a name="M000026"></a>
148
<div id="method-M000032" class="method-detail">
149
<a name="M000032"></a>
145
151
<div class="method-heading">
146
<a href="Node.src/M000026.html" target="Code" class="method-signature"
147
onclick="popupCode('Node.src/M000026.html');return false;">
152
<a href="Node.src/M000032.html" target="Code" class="method-signature"
153
onclick="popupCode('Node.src/M000032.html');return false;">
148
154
<span class="method-name">new</span><span class="method-args">()</span>
159
165
<h3 class="section-bar">Public Instance methods</h3>
161
<div id="method-M000019" class="method-detail">
162
<a name="M000019"></a>
164
<div class="method-heading">
165
<a href="Node.src/M000019.html" target="Code" class="method-signature"
166
onclick="popupCode('Node.src/M000019.html');return false;">
167
<div id="method-M000025" class="method-detail">
168
<a name="M000025"></a>
170
<div class="method-heading">
171
<a href="Node.src/M000025.html" target="Code" class="method-signature"
172
onclick="popupCode('Node.src/M000025.html');return false;">
173
<span class="method-name">admins</span><span class="method-args">()</span>
177
<div class="method-description">
179
Get an array of names of administrators. The return value is an array
180
object of names of administrators. On error, `nil’ is returned.
185
<div id="method-M000024" class="method-detail">
186
<a name="M000024"></a>
188
<div class="method-heading">
189
<a href="Node.src/M000024.html" target="Code" class="method-signature"
190
onclick="popupCode('Node.src/M000024.html');return false;">
191
<span class="method-name">cache_usage</span><span class="method-args">()</span>
195
<div class="method-description">
197
Get the usage ratio of the cache. The return value is the usage ratio of
198
the cache. On error, -1.0 is returned.
203
<div id="method-M000021" class="method-detail">
204
<a name="M000021"></a>
206
<div class="method-heading">
207
<a href="Node.src/M000021.html" target="Code" class="method-signature"
208
onclick="popupCode('Node.src/M000021.html');return false;">
167
209
<span class="method-name">doc_num</span><span class="method-args">()</span>
179
<div id="method-M000009" class="method-detail">
180
<a name="M000009"></a>
221
<div id="method-M000011" class="method-detail">
222
<a name="M000011"></a>
182
224
<div class="method-heading">
183
<a href="Node.src/M000009.html" target="Code" class="method-signature"
184
onclick="popupCode('Node.src/M000009.html');return false;">
225
<a href="Node.src/M000011.html" target="Code" class="method-signature"
226
onclick="popupCode('Node.src/M000011.html');return false;">
185
227
<span class="method-name">edit_doc</span><span class="method-args">(doc)</span>
197
<div id="method-M000014" class="method-detail">
198
<a name="M000014"></a>
239
<div id="method-M000016" class="method-detail">
240
<a name="M000016"></a>
200
242
<div class="method-heading">
201
<a href="Node.src/M000014.html" target="Code" class="method-signature"
202
onclick="popupCode('Node.src/M000014.html');return false;">
243
<a href="Node.src/M000016.html" target="Code" class="method-signature"
244
onclick="popupCode('Node.src/M000016.html');return false;">
203
245
<span class="method-name">etch_doc</span><span class="method-args">(id)</span>
216
<div id="method-M000015" class="method-detail">
217
<a name="M000015"></a>
258
<div id="method-M000017" class="method-detail">
259
<a name="M000017"></a>
219
261
<div class="method-heading">
220
<a href="Node.src/M000015.html" target="Code" class="method-signature"
221
onclick="popupCode('Node.src/M000015.html');return false;">
262
<a href="Node.src/M000017.html" target="Code" class="method-signature"
263
onclick="popupCode('Node.src/M000017.html');return false;">
222
264
<span class="method-name">etch_doc_by_uri</span><span class="method-args">(uri)</span>
235
<div id="method-M000010" class="method-detail">
236
<a name="M000010"></a>
238
<div class="method-heading">
239
<a href="Node.src/M000010.html" target="Code" class="method-signature"
240
onclick="popupCode('Node.src/M000010.html');return false;">
241
<span class="method-name">get_doc</span><span class="method-args">(id)</span>
245
<div class="method-description">
247
Retrieve a document. `id’ specifies the ID number of a registered
248
document. The return value is a document object. On error, `nil’ is
254
277
<div id="method-M000012" class="method-detail">
255
278
<a name="M000012"></a>
257
280
<div class="method-heading">
258
281
<a href="Node.src/M000012.html" target="Code" class="method-signature"
259
282
onclick="popupCode('Node.src/M000012.html');return false;">
283
<span class="method-name">get_doc</span><span class="method-args">(id)</span>
287
<div class="method-description">
289
Retrieve a document. `id’ specifies the ID number of a registered
290
document. The return value is a document object. On error, `nil’ is
296
<div id="method-M000014" class="method-detail">
297
<a name="M000014"></a>
299
<div class="method-heading">
300
<a href="Node.src/M000014.html" target="Code" class="method-signature"
301
onclick="popupCode('Node.src/M000014.html');return false;">
260
302
<span class="method-name">get_doc_attr</span><span class="method-args">(id, name)</span>
274
<div id="method-M000013" class="method-detail">
275
<a name="M000013"></a>
316
<div id="method-M000015" class="method-detail">
317
<a name="M000015"></a>
277
319
<div class="method-heading">
278
<a href="Node.src/M000013.html" target="Code" class="method-signature"
279
onclick="popupCode('Node.src/M000013.html');return false;">
320
<a href="Node.src/M000015.html" target="Code" class="method-signature"
321
onclick="popupCode('Node.src/M000015.html');return false;">
280
322
<span class="method-name">get_doc_attr_by_uri</span><span class="method-args">(uri, name)</span>
294
<div id="method-M000011" class="method-detail">
295
<a name="M000011"></a>
336
<div id="method-M000013" class="method-detail">
337
<a name="M000013"></a>
297
339
<div class="method-heading">
298
<a href="Node.src/M000011.html" target="Code" class="method-signature"
299
onclick="popupCode('Node.src/M000011.html');return false;">
340
<a href="Node.src/M000013.html" target="Code" class="method-signature"
341
onclick="popupCode('Node.src/M000013.html');return false;">
300
342
<span class="method-name">get_doc_by_uri</span><span class="method-args">(uri)</span>
313
<div id="method-M000018" class="method-detail">
314
<a name="M000018"></a>
355
<div id="method-M000020" class="method-detail">
356
<a name="M000020"></a>
316
358
<div class="method-heading">
317
<a href="Node.src/M000018.html" target="Code" class="method-signature"
318
onclick="popupCode('Node.src/M000018.html');return false;">
359
<a href="Node.src/M000020.html" target="Code" class="method-signature"
360
onclick="popupCode('Node.src/M000020.html');return false;">
319
361
<span class="method-name">label</span><span class="method-args">()</span>
331
<div id="method-M000017" class="method-detail">
332
<a name="M000017"></a>
334
<div class="method-heading">
335
<a href="Node.src/M000017.html" target="Code" class="method-signature"
336
onclick="popupCode('Node.src/M000017.html');return false;">
373
<div id="method-M000027" class="method-detail">
374
<a name="M000027"></a>
376
<div class="method-heading">
377
<a href="Node.src/M000027.html" target="Code" class="method-signature"
378
onclick="popupCode('Node.src/M000027.html');return false;">
379
<span class="method-name">links</span><span class="method-args">()</span>
383
<div class="method-description">
385
Get an array of expressions of links. The return value is an array object
386
of expressions of links. Each element is a TSV string and has three fields
387
of the URL, the label, and the score. On error, `nil’ is returned.
392
<div id="method-M000019" class="method-detail">
393
<a name="M000019"></a>
395
<div class="method-heading">
396
<a href="Node.src/M000019.html" target="Code" class="method-signature"
397
onclick="popupCode('Node.src/M000019.html');return false;">
337
398
<span class="method-name">name</span><span class="method-args">()</span>
352
413
<div class="method-heading">
353
414
<a href="Node.src/M000007.html" target="Code" class="method-signature"
354
415
onclick="popupCode('Node.src/M000007.html');return false;">
416
<span class="method-name">optimize</span><span class="method-args">()</span>
420
<div class="method-description">
422
Optimize the database. The return value is true if success, else it is
428
<div id="method-M000009" class="method-detail">
429
<a name="M000009"></a>
431
<div class="method-heading">
432
<a href="Node.src/M000009.html" target="Code" class="method-signature"
433
onclick="popupCode('Node.src/M000009.html');return false;">
355
434
<span class="method-name">out_doc</span><span class="method-args">(id)</span>
367
<div id="method-M000008" class="method-detail">
368
<a name="M000008"></a>
446
<div id="method-M000010" class="method-detail">
447
<a name="M000010"></a>
370
449
<div class="method-heading">
371
<a href="Node.src/M000008.html" target="Code" class="method-signature"
372
onclick="popupCode('Node.src/M000008.html');return false;">
450
<a href="Node.src/M000010.html" target="Code" class="method-signature"
451
onclick="popupCode('Node.src/M000010.html');return false;">
373
452
<span class="method-name">out_doc_by_uri</span><span class="method-args">(uri)</span>
388
<div id="method-M000006" class="method-detail">
389
<a name="M000006"></a>
467
<div id="method-M000008" class="method-detail">
468
<a name="M000008"></a>
391
470
<div class="method-heading">
392
<a href="Node.src/M000006.html" target="Code" class="method-signature"
393
onclick="popupCode('Node.src/M000006.html');return false;">
471
<a href="Node.src/M000008.html" target="Code" class="method-signature"
472
onclick="popupCode('Node.src/M000008.html');return false;">
394
473
<span class="method-name">put_doc</span><span class="method-args">(doc)</span>
407
<div id="method-M000022" class="method-detail">
408
<a name="M000022"></a>
486
<div id="method-M000028" class="method-detail">
487
<a name="M000028"></a>
410
489
<div class="method-heading">
411
<a href="Node.src/M000022.html" target="Code" class="method-signature"
412
onclick="popupCode('Node.src/M000022.html');return false;">
490
<a href="Node.src/M000028.html" target="Code" class="method-signature"
491
onclick="popupCode('Node.src/M000028.html');return false;">
413
492
<span class="method-name">search</span><span class="method-args">(cond, depth)</span>
417
496
<div class="method-description">
419
Search documents corresponding a condition. `cond’ specifies a
498
Search for documents corresponding a condition. `cond’ specifies a
420
499
condition object. `depth’ specifies the depth of meta search. The
421
500
return value is a node result object. On error, `nil’ is returned.
445
<div id="method-M000025" class="method-detail">
446
<a name="M000025"></a>
524
<div id="method-M000031" class="method-detail">
525
<a name="M000031"></a>
448
527
<div class="method-heading">
449
<a href="Node.src/M000025.html" target="Code" class="method-signature"
450
onclick="popupCode('Node.src/M000025.html');return false;">
528
<a href="Node.src/M000031.html" target="Code" class="method-signature"
529
onclick="popupCode('Node.src/M000031.html');return false;">
451
530
<span class="method-name">set_link</span><span class="method-args">(url, label, credit)</span>
484
<div id="method-M000023" class="method-detail">
485
<a name="M000023"></a>
563
<div id="method-M000029" class="method-detail">
564
<a name="M000029"></a>
487
566
<div class="method-heading">
488
<a href="Node.src/M000023.html" target="Code" class="method-signature"
489
onclick="popupCode('Node.src/M000023.html');return false;">
567
<a href="Node.src/M000029.html" target="Code" class="method-signature"
568
onclick="popupCode('Node.src/M000029.html');return false;">
490
569
<span class="method-name">set_snippet_width</span><span class="method-args">(wwidth, hwidth, awidth)</span>
544
<div id="method-M000024" class="method-detail">
545
<a name="M000024"></a>
623
<div id="method-M000030" class="method-detail">
624
<a name="M000030"></a>
547
626
<div class="method-heading">
548
<a href="Node.src/M000024.html" target="Code" class="method-signature"
549
onclick="popupCode('Node.src/M000024.html');return false;">
627
<a href="Node.src/M000030.html" target="Code" class="method-signature"
628
onclick="popupCode('Node.src/M000030.html');return false;">
550
629
<span class="method-name">set_user</span><span class="method-args">(name, mode)</span>
564
<div id="method-M000021" class="method-detail">
565
<a name="M000021"></a>
643
<div id="method-M000023" class="method-detail">
644
<a name="M000023"></a>
567
646
<div class="method-heading">
568
<a href="Node.src/M000021.html" target="Code" class="method-signature"
569
onclick="popupCode('Node.src/M000021.html');return false;">
647
<a href="Node.src/M000023.html" target="Code" class="method-signature"
648
onclick="popupCode('Node.src/M000023.html');return false;">
570
649
<span class="method-name">size</span><span class="method-args">()</span>
600
<div id="method-M000016" class="method-detail">
601
<a name="M000016"></a>
603
<div class="method-heading">
604
<a href="Node.src/M000016.html" target="Code" class="method-signature"
605
onclick="popupCode('Node.src/M000016.html');return false;">
679
<div id="method-M000006" class="method-detail">
680
<a name="M000006"></a>
682
<div class="method-heading">
683
<a href="Node.src/M000006.html" target="Code" class="method-signature"
684
onclick="popupCode('Node.src/M000006.html');return false;">
685
<span class="method-name">sync</span><span class="method-args">()</span>
689
<div class="method-description">
691
Synchronize updating contents of the database. The return value is true if
692
success, else it is false.
697
<div id="method-M000018" class="method-detail">
698
<a name="M000018"></a>
700
<div class="method-heading">
701
<a href="Node.src/M000018.html" target="Code" class="method-signature"
702
onclick="popupCode('Node.src/M000018.html');return false;">
606
703
<span class="method-name">uri_to_id</span><span class="method-args">(uri)</span>
619
<div id="method-M000020" class="method-detail">
620
<a name="M000020"></a>
622
<div class="method-heading">
623
<a href="Node.src/M000020.html" target="Code" class="method-signature"
624
onclick="popupCode('Node.src/M000020.html');return false;">
716
<div id="method-M000026" class="method-detail">
717
<a name="M000026"></a>
719
<div class="method-heading">
720
<a href="Node.src/M000026.html" target="Code" class="method-signature"
721
onclick="popupCode('Node.src/M000026.html');return false;">
722
<span class="method-name">users</span><span class="method-args">()</span>
726
<div class="method-description">
728
Get an array of names of users. The return value is an array object of
729
names of users. On error, `nil’ is returned.
734
<div id="method-M000022" class="method-detail">
735
<a name="M000022"></a>
737
<div class="method-heading">
738
<a href="Node.src/M000022.html" target="Code" class="method-signature"
739
onclick="popupCode('Node.src/M000022.html');return false;">
625
740
<span class="method-name">word_num</span><span class="method-args">()</span>