← Back to branch summary

~ubuntu-branches/ubuntu/trusty/hyperestraier/trusty-proposed

« back to all changes in this revision

Viewing changes to doc/rubynativeapi/classes/Estraier/Database.html

  • Committer: Bazaar Package Importer
  • Author(s): Steve Langasek
  • Date: 2006-11-14 05:28:32 UTC
  • mfrom: (2.1.4 feisty)
  • Revision ID: james.westby@ubuntu.com-20061114052832-0lzqzcefn8mt4yqe
Tags: 1.4.9-1.1
* Non-maintainer upload.
* High-urgency upload for RC bugfix.
* Set HOME=$(CURDIR)/junkhome when building, otherwise the package build
  will incorrectly look for headers there -- and fail when the directory
  exists and is unreadable, as happens sometimes on sudo-using
  autobuilders!

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/rubynativeapi/classes/Estraier/Database.html
92
92
      <h3 class="section-bar">Methods</h3>
93
93
 
94
94
      <div class="name-list">
95
 
      <a href="#M000003">close</a>&nbsp;&nbsp;
96
 
      <a href="#M000016">doc_num</a>&nbsp;&nbsp;
97
 
      <a href="#M000011">edit_doc</a>&nbsp;&nbsp;
98
 
      <a href="#M000001">err_msg</a>&nbsp;&nbsp;
99
 
      <a href="#M000004">error</a>&nbsp;&nbsp;
100
 
      <a href="#M000005">fatal</a>&nbsp;&nbsp;
101
 
      <a href="#M000006">flush</a>&nbsp;&nbsp;
102
 
      <a href="#M000012">get_doc</a>&nbsp;&nbsp;
103
 
      <a href="#M000013">get_doc_attr</a>&nbsp;&nbsp;
104
 
      <a href="#M000015">name</a>&nbsp;&nbsp;
105
 
      <a href="#M000022">new</a>&nbsp;&nbsp;
106
 
      <a href="#M000002">open</a>&nbsp;&nbsp;
107
 
      <a href="#M000008">optimize</a>&nbsp;&nbsp;
108
 
      <a href="#M000010">out_doc</a>&nbsp;&nbsp;
109
 
      <a href="#M000009">put_doc</a>&nbsp;&nbsp;
110
 
      <a href="#M000020">scan_doc</a>&nbsp;&nbsp;
111
 
      <a href="#M000019">search</a>&nbsp;&nbsp;
112
 
      <a href="#M000021">set_cache_size</a>&nbsp;&nbsp;
113
 
      <a href="#M000018">size</a>&nbsp;&nbsp;
114
 
      <a href="#M000007">sync</a>&nbsp;&nbsp;
115
 
      <a href="#M000014">uri_to_id</a>&nbsp;&nbsp;
116
 
      <a href="#M000017">word_num</a>&nbsp;&nbsp;
 
95
      <a href="#M000007">add_attr_index</a>&nbsp;&nbsp;
 
96
      <a href="#M000025">add_pseudo_index</a>&nbsp;&nbsp;
 
97
      <a href="#M000004">close</a>&nbsp;&nbsp;
 
98
      <a href="#M000019">doc_num</a>&nbsp;&nbsp;
 
99
      <a href="#M000014">edit_doc</a>&nbsp;&nbsp;
 
100
      <a href="#M000002">err_msg</a>&nbsp;&nbsp;
 
101
      <a href="#M000005">error</a>&nbsp;&nbsp;
 
102
      <a href="#M000006">fatal</a>&nbsp;&nbsp;
 
103
      <a href="#M000008">flush</a>&nbsp;&nbsp;
 
104
      <a href="#M000015">get_doc</a>&nbsp;&nbsp;
 
105
      <a href="#M000016">get_doc_attr</a>&nbsp;&nbsp;
 
106
      <a href="#M000011">merge</a>&nbsp;&nbsp;
 
107
      <a href="#M000018">name</a>&nbsp;&nbsp;
 
108
      <a href="#M000028">new</a>&nbsp;&nbsp;
 
109
      <a href="#M000003">open</a>&nbsp;&nbsp;
 
110
      <a href="#M000010">optimize</a>&nbsp;&nbsp;
 
111
      <a href="#M000013">out_doc</a>&nbsp;&nbsp;
 
112
      <a href="#M000012">put_doc</a>&nbsp;&nbsp;
 
113
      <a href="#M000023">scan_doc</a>&nbsp;&nbsp;
 
114
      <a href="#M000022">search</a>&nbsp;&nbsp;
 
115
      <a href="#M000001">search_meta</a>&nbsp;&nbsp;
 
116
      <a href="#M000024">set_cache_size</a>&nbsp;&nbsp;
 
117
      <a href="#M000027">set_informer</a>&nbsp;&nbsp;
 
118
      <a href="#M000026">set_wildmax</a>&nbsp;&nbsp;
 
119
      <a href="#M000021">size</a>&nbsp;&nbsp;
 
120
      <a href="#M000009">sync</a>&nbsp;&nbsp;
 
121
      <a href="#M000017">uri_to_id</a>&nbsp;&nbsp;
 
122
      <a href="#M000020">word_num</a>&nbsp;&nbsp;
117
123
      </div>
118
124
    </div>
119
125
 
283
289
        <tr class="top-aligned-row context-row">
284
290
          <td class="context-item-name">DBPERFNG</td>
285
291
          <td>=</td>
286
 
          <td class="context-item-value">1 &lt;&lt; 6</td>
 
292
          <td class="context-item-value">1 &lt;&lt; 10</td>
287
293
          <td width="3em">&nbsp;</td>
288
294
          <td class="context-item-desc">
289
295
open mode: use perfect N-gram analyzer
291
297
</td>
292
298
        </tr>
293
299
        <tr class="top-aligned-row context-row">
 
300
          <td class="context-item-name">DBCHRCAT</td>
 
301
          <td>=</td>
 
302
          <td class="context-item-value">1 &lt;&lt; 11</td>
 
303
          <td width="3em">&nbsp;</td>
 
304
          <td class="context-item-desc">
 
305
open mode: use character category analyzer
 
306
 
 
307
</td>
 
308
        </tr>
 
309
        <tr class="top-aligned-row context-row">
 
310
          <td class="context-item-name">DBSMALL</td>
 
311
          <td>=</td>
 
312
          <td class="context-item-value">1 &lt;&lt; 20</td>
 
313
          <td width="3em">&nbsp;</td>
 
314
          <td class="context-item-desc">
 
315
open mode: small tuning
 
316
 
 
317
</td>
 
318
        </tr>
 
319
        <tr class="top-aligned-row context-row">
 
320
          <td class="context-item-name">DBLARGE</td>
 
321
          <td>=</td>
 
322
          <td class="context-item-value">1 &lt;&lt; 21</td>
 
323
          <td width="3em">&nbsp;</td>
 
324
          <td class="context-item-desc">
 
325
open mode: large tuning
 
326
 
 
327
</td>
 
328
        </tr>
 
329
        <tr class="top-aligned-row context-row">
 
330
          <td class="context-item-name">DBHUGE</td>
 
331
          <td>=</td>
 
332
          <td class="context-item-value">1 &lt;&lt; 22</td>
 
333
          <td width="3em">&nbsp;</td>
 
334
          <td class="context-item-desc">
 
335
open mode: huge tuning
 
336
 
 
337
</td>
 
338
        </tr>
 
339
        <tr class="top-aligned-row context-row">
 
340
          <td class="context-item-name">DBHUGE2</td>
 
341
          <td>=</td>
 
342
          <td class="context-item-value">1 &lt;&lt; 23</td>
 
343
          <td width="3em">&nbsp;</td>
 
344
          <td class="context-item-desc">
 
345
open mode: huge tuning second
 
346
 
 
347
</td>
 
348
        </tr>
 
349
        <tr class="top-aligned-row context-row">
 
350
          <td class="context-item-name">DBHUGE3</td>
 
351
          <td>=</td>
 
352
          <td class="context-item-value">1 &lt;&lt; 24</td>
 
353
          <td width="3em">&nbsp;</td>
 
354
          <td class="context-item-desc">
 
355
open mode: huge tuning third
 
356
 
 
357
</td>
 
358
        </tr>
 
359
        <tr class="top-aligned-row context-row">
 
360
          <td class="context-item-name">DBSCVOID</td>
 
361
          <td>=</td>
 
362
          <td class="context-item-value">1 &lt;&lt; 25</td>
 
363
          <td width="3em">&nbsp;</td>
 
364
          <td class="context-item-desc">
 
365
open mode: store scores as void
 
366
 
 
367
</td>
 
368
        </tr>
 
369
        <tr class="top-aligned-row context-row">
 
370
          <td class="context-item-name">DBSCINT</td>
 
371
          <td>=</td>
 
372
          <td class="context-item-value">1 &lt;&lt; 26</td>
 
373
          <td width="3em">&nbsp;</td>
 
374
          <td class="context-item-desc">
 
375
open mode: store scores as integer
 
376
 
 
377
</td>
 
378
        </tr>
 
379
        <tr class="top-aligned-row context-row">
 
380
          <td class="context-item-name">DBSCASIS</td>
 
381
          <td>=</td>
 
382
          <td class="context-item-value">1 &lt;&lt; 27</td>
 
383
          <td width="3em">&nbsp;</td>
 
384
          <td class="context-item-desc">
 
385
open mode: refrain from adjustment of scores
 
386
 
 
387
</td>
 
388
        </tr>
 
389
        <tr class="top-aligned-row context-row">
 
390
          <td class="context-item-name">IDXATTRSEQ</td>
 
391
          <td>=</td>
 
392
          <td class="context-item-value">0</td>
 
393
          <td width="3em">&nbsp;</td>
 
394
          <td class="context-item-desc">
 
395
attribute index type: for multipurpose sequencial access method
 
396
 
 
397
</td>
 
398
        </tr>
 
399
        <tr class="top-aligned-row context-row">
 
400
          <td class="context-item-name">IDXATTRSTR</td>
 
401
          <td>=</td>
 
402
          <td class="context-item-value">1</td>
 
403
          <td width="3em">&nbsp;</td>
 
404
          <td class="context-item-desc">
 
405
attribute index type: for narrowing with attributes as strings
 
406
 
 
407
</td>
 
408
        </tr>
 
409
        <tr class="top-aligned-row context-row">
 
410
          <td class="context-item-name">IDXATTRNUM</td>
 
411
          <td>=</td>
 
412
          <td class="context-item-value">2</td>
 
413
          <td width="3em">&nbsp;</td>
 
414
          <td class="context-item-desc">
 
415
attribute index type: for narrowing with attributes as numbers
 
416
 
 
417
</td>
 
418
        </tr>
 
419
        <tr class="top-aligned-row context-row">
294
420
          <td class="context-item-name">OPTNOPURGE</td>
295
421
          <td>=</td>
296
422
          <td class="context-item-value">1 &lt;&lt; 0</td>
311
437
</td>
312
438
        </tr>
313
439
        <tr class="top-aligned-row context-row">
 
440
          <td class="context-item-name">MGCLEAN</td>
 
441
          <td>=</td>
 
442
          <td class="context-item-value">1 &lt;&lt; 0</td>
 
443
          <td width="3em">&nbsp;</td>
 
444
          <td class="context-item-desc">
 
445
merge option: clean up dispensable regions
 
446
 
 
447
</td>
 
448
        </tr>
 
449
        <tr class="top-aligned-row context-row">
314
450
          <td class="context-item-name">PDCLEAN</td>
315
451
          <td>=</td>
316
452
          <td class="context-item-value">1 &lt;&lt; 0</td>
317
453
          <td width="3em">&nbsp;</td>
318
454
          <td class="context-item-desc">
319
 
<a href="Database.html#M000009">put_doc</a> option: clean up dispensable
 
455
<a href="Database.html#M000012">put_doc</a> option: clean up dispensable
320
456
regions
321
457
 
322
458
</td>
323
459
        </tr>
324
460
        <tr class="top-aligned-row context-row">
 
461
          <td class="context-item-name">PDWEIGHT</td>
 
462
          <td>=</td>
 
463
          <td class="context-item-value">1 &lt;&lt; 1</td>
 
464
          <td width="3em">&nbsp;</td>
 
465
          <td class="context-item-desc">
 
466
<a href="Database.html#M000012">put_doc</a> option: weight scores
 
467
statically when indexing
 
468
 
 
469
</td>
 
470
        </tr>
 
471
        <tr class="top-aligned-row context-row">
325
472
          <td class="context-item-name">ODCLEAN</td>
326
473
          <td>=</td>
327
474
          <td class="context-item-value">1 &lt;&lt; 0</td>
328
475
          <td width="3em">&nbsp;</td>
329
476
          <td class="context-item-desc">
330
 
<a href="Database.html#M000010">out_doc</a> option: clean up dispensable
 
477
<a href="Database.html#M000013">out_doc</a> option: clean up dispensable
331
478
regions
332
479
 
333
480
</td>
338
485
          <td class="context-item-value">1 &lt;&lt; 0</td>
339
486
          <td width="3em">&nbsp;</td>
340
487
          <td class="context-item-desc">
341
 
<a href="Database.html#M000012">get_doc</a> option: no attributes
 
488
<a href="Database.html#M000015">get_doc</a> option: no attributes
342
489
 
343
490
</td>
344
491
        </tr>
348
495
          <td class="context-item-value">1 &lt;&lt; 1</td>
349
496
          <td width="3em">&nbsp;</td>
350
497
          <td class="context-item-desc">
351
 
<a href="Database.html#M000012">get_doc</a> option: no text
 
498
<a href="Database.html#M000015">get_doc</a> option: no text
 
499
 
 
500
</td>
 
501
        </tr>
 
502
        <tr class="top-aligned-row context-row">
 
503
          <td class="context-item-name">GDNOKWD</td>
 
504
          <td>=</td>
 
505
          <td class="context-item-value">1 &lt;&lt; 2</td>
 
506
          <td width="3em">&nbsp;</td>
 
507
          <td class="context-item-desc">
 
508
<a href="Database.html#M000015">get_doc</a> option: no keywords
352
509
 
353
510
</td>
354
511
        </tr>
365
522
    <div id="methods">
366
523
      <h3 class="section-bar">Public Class methods</h3>
367
524
 
368
 
      <div id="method-M000022" class="method-detail">
369
 
        <a name="M000022"></a>
 
525
      <div id="method-M000028" class="method-detail">
 
526
        <a name="M000028"></a>
370
527
 
371
528
        <div class="method-heading">
372
 
          <a href="Database.src/M000022.html" target="Code" class="method-signature"
373
 
            onclick="popupCode('Database.src/M000022.html');return false;">
 
529
          <a href="Database.src/M000028.html" target="Code" class="method-signature"
 
530
            onclick="popupCode('Database.src/M000028.html');return false;">
374
531
          <span class="method-name">new</span><span class="method-args">()</span>
375
532
          </a>
376
533
        </div>
382
539
        </div>
383
540
      </div>
384
541
 
 
542
      <div id="method-M000001" class="method-detail">
 
543
        <a name="M000001"></a>
 
544
 
 
545
        <div class="method-heading">
 
546
          <a href="Database.src/M000001.html" target="Code" class="method-signature"
 
547
            onclick="popupCode('Database.src/M000001.html');return false;">
 
548
          <span class="method-name">search_meta</span><span class="method-args">(dbs, cond)</span>
 
549
          </a>
 
550
        </div>
 
551
      
 
552
        <div class="method-description">
 
553
          <p>
 
554
Search plural databases for documents corresponding a condition.
 
555
`dbs&#8217; specifies an array whose elements are database objects.
 
556
`cond&#8217; specifies a condition object. The return value is a result
 
557
object. On error, `nil&#8217; is returned.
 
558
</p>
 
559
        </div>
 
560
      </div>
 
561
 
385
562
      <h3 class="section-bar">Public Instance methods</h3>
386
563
 
387
 
      <div id="method-M000003" class="method-detail">
388
 
        <a name="M000003"></a>
389
 
 
390
 
        <div class="method-heading">
391
 
          <a href="Database.src/M000003.html" target="Code" class="method-signature"
392
 
            onclick="popupCode('Database.src/M000003.html');return false;">
 
564
      <div id="method-M000007" class="method-detail">
 
565
        <a name="M000007"></a>
 
566
 
 
567
        <div class="method-heading">
 
568
          <a href="Database.src/M000007.html" target="Code" class="method-signature"
 
569
            onclick="popupCode('Database.src/M000007.html');return false;">
 
570
          <span class="method-name">add_attr_index</span><span class="method-args">(name, type)</span>
 
571
          </a>
 
572
        </div>
 
573
      
 
574
        <div class="method-description">
 
575
          <p>
 
576
Add an index for narrowing or sorting with document attributes.
 
577
`name&#8217; specifies the name of an attribute. `type&#8217; specifies the
 
578
data type of attribute index; `Database::IDXATTRSEQ&#8217; for multipurpose
 
579
sequencial access method, `Database::IDXATTRSTR&#8217; for narrowing with
 
580
attributes as strings, `Database::IDXATTRNUM&#8217; for narrowing with
 
581
attributes as numbers. The return value is true if success, else it is
 
582
false.
 
583
</p>
 
584
        </div>
 
585
      </div>
 
586
 
 
587
      <div id="method-M000025" class="method-detail">
 
588
        <a name="M000025"></a>
 
589
 
 
590
        <div class="method-heading">
 
591
          <a href="Database.src/M000025.html" target="Code" class="method-signature"
 
592
            onclick="popupCode('Database.src/M000025.html');return false;">
 
593
          <span class="method-name">add_pseudo_index</span><span class="method-args">(path)</span>
 
594
          </a>
 
595
        </div>
 
596
      
 
597
        <div class="method-description">
 
598
          <p>
 
599
Add a pseudo index directory. `path&#8217; specifies the path of a pseudo
 
600
index directory. The return value is true if success, else it is false.
 
601
</p>
 
602
        </div>
 
603
      </div>
 
604
 
 
605
      <div id="method-M000004" class="method-detail">
 
606
        <a name="M000004"></a>
 
607
 
 
608
        <div class="method-heading">
 
609
          <a href="Database.src/M000004.html" target="Code" class="method-signature"
 
610
            onclick="popupCode('Database.src/M000004.html');return false;">
393
611
          <span class="method-name">close</span><span class="method-args">()</span>
394
612
          </a>
395
613
        </div>
401
619
        </div>
402
620
      </div>
403
621
 
404
 
      <div id="method-M000016" class="method-detail">
405
 
        <a name="M000016"></a>
 
622
      <div id="method-M000019" class="method-detail">
 
623
        <a name="M000019"></a>
406
624
 
407
625
        <div class="method-heading">
408
 
          <a href="Database.src/M000016.html" target="Code" class="method-signature"
409
 
            onclick="popupCode('Database.src/M000016.html');return false;">
 
626
          <a href="Database.src/M000019.html" target="Code" class="method-signature"
 
627
            onclick="popupCode('Database.src/M000019.html');return false;">
410
628
          <span class="method-name">doc_num</span><span class="method-args">()</span>
411
629
          </a>
412
630
        </div>
419
637
        </div>
420
638
      </div>
421
639
 
422
 
      <div id="method-M000011" class="method-detail">
423
 
        <a name="M000011"></a>
 
640
      <div id="method-M000014" class="method-detail">
 
641
        <a name="M000014"></a>
424
642
 
425
643
        <div class="method-heading">
426
 
          <a href="Database.src/M000011.html" target="Code" class="method-signature"
427
 
            onclick="popupCode('Database.src/M000011.html');return false;">
 
644
          <a href="Database.src/M000014.html" target="Code" class="method-signature"
 
645
            onclick="popupCode('Database.src/M000014.html');return false;">
428
646
          <span class="method-name">edit_doc</span><span class="method-args">(doc)</span>
429
647
          </a>
430
648
        </div>
437
655
        </div>
438
656
      </div>
439
657
 
440
 
      <div id="method-M000001" class="method-detail">
441
 
        <a name="M000001"></a>
 
658
      <div id="method-M000002" class="method-detail">
 
659
        <a name="M000002"></a>
442
660
 
443
661
        <div class="method-heading">
444
 
          <a href="Database.src/M000001.html" target="Code" class="method-signature"
445
 
            onclick="popupCode('Database.src/M000001.html');return false;">
 
662
          <a href="Database.src/M000002.html" target="Code" class="method-signature"
 
663
            onclick="popupCode('Database.src/M000002.html');return false;">
446
664
          <span class="method-name">err_msg</span><span class="method-args">(ecode)</span>
447
665
          </a>
448
666
        </div>
455
673
        </div>
456
674
      </div>
457
675
 
458
 
      <div id="method-M000004" class="method-detail">
459
 
        <a name="M000004"></a>
460
 
 
461
 
        <div class="method-heading">
462
 
          <a href="Database.src/M000004.html" target="Code" class="method-signature"
463
 
            onclick="popupCode('Database.src/M000004.html');return false;">
464
 
          <span class="method-name">error</span><span class="method-args">()</span>
465
 
          </a>
466
 
        </div>
467
 
      
468
 
        <div class="method-description">
469
 
          <p>
470
 
Get the last happened error code. The return value is the last happened
471
 
error code.
472
 
</p>
473
 
        </div>
474
 
      </div>
475
 
 
476
676
      <div id="method-M000005" class="method-detail">
477
677
        <a name="M000005"></a>
478
678
 
479
679
        <div class="method-heading">
480
680
          <a href="Database.src/M000005.html" target="Code" class="method-signature"
481
681
            onclick="popupCode('Database.src/M000005.html');return false;">
482
 
          <span class="method-name">fatal</span><span class="method-args">()</span>
 
682
          <span class="method-name">error</span><span class="method-args">()</span>
483
683
          </a>
484
684
        </div>
485
685
      
486
686
        <div class="method-description">
487
687
          <p>
488
 
Check whether the database has a fatal error. The return value is true if
489
 
the database has fatal erroor, else it is false.
 
688
Get the last happened error code. The return value is the last happened
 
689
error code.
490
690
</p>
491
691
        </div>
492
692
      </div>
497
697
        <div class="method-heading">
498
698
          <a href="Database.src/M000006.html" target="Code" class="method-signature"
499
699
            onclick="popupCode('Database.src/M000006.html');return false;">
 
700
          <span class="method-name">fatal</span><span class="method-args">()</span>
 
701
          </a>
 
702
        </div>
 
703
      
 
704
        <div class="method-description">
 
705
          <p>
 
706
Check whether the database has a fatal error. The return value is true if
 
707
the database has fatal erroor, else it is false.
 
708
</p>
 
709
        </div>
 
710
      </div>
 
711
 
 
712
      <div id="method-M000008" class="method-detail">
 
713
        <a name="M000008"></a>
 
714
 
 
715
        <div class="method-heading">
 
716
          <a href="Database.src/M000008.html" target="Code" class="method-signature"
 
717
            onclick="popupCode('Database.src/M000008.html');return false;">
500
718
          <span class="method-name">flush</span><span class="method-args">(max)</span>
501
719
          </a>
502
720
        </div>
510
728
        </div>
511
729
      </div>
512
730
 
513
 
      <div id="method-M000012" class="method-detail">
514
 
        <a name="M000012"></a>
 
731
      <div id="method-M000015" class="method-detail">
 
732
        <a name="M000015"></a>
515
733
 
516
734
        <div class="method-heading">
517
 
          <a href="Database.src/M000012.html" target="Code" class="method-signature"
518
 
            onclick="popupCode('Database.src/M000012.html');return false;">
 
735
          <a href="Database.src/M000015.html" target="Code" class="method-signature"
 
736
            onclick="popupCode('Database.src/M000015.html');return false;">
519
737
          <span class="method-name">get_doc</span><span class="method-args">(id, options)</span>
520
738
          </a>
521
739
        </div>
523
741
        <div class="method-description">
524
742
          <p>
525
743
Retrieve a document. `id&#8217; specifies the ID number of a registered
526
 
document. `options&#8217; specifies options: `Database.GDNOATTR&#8217; to
527
 
ignore attributes, `Database.GDNOTEXT&#8217; to ignore the body text. The
528
 
two can be specified at the same time by bitwise or. The return value is a
529
 
document object. On error, `nil&#8217; is returned.
 
744
document. `options&#8217; specifies options: `Database::GDNOATTR&#8217; to
 
745
ignore attributes, `Database::GDNOTEXT&#8217; to ignore the body text,
 
746
`Database::GDNOKWD&#8217; to ignore keywords. The three can be specified at
 
747
the same time by bitwise or. The return value is a document object. On
 
748
error, `nil&#8217; is returned.
530
749
</p>
531
750
        </div>
532
751
      </div>
533
752
 
534
 
      <div id="method-M000013" class="method-detail">
535
 
        <a name="M000013"></a>
 
753
      <div id="method-M000016" class="method-detail">
 
754
        <a name="M000016"></a>
536
755
 
537
756
        <div class="method-heading">
538
 
          <a href="Database.src/M000013.html" target="Code" class="method-signature"
539
 
            onclick="popupCode('Database.src/M000013.html');return false;">
 
757
          <a href="Database.src/M000016.html" target="Code" class="method-signature"
 
758
            onclick="popupCode('Database.src/M000016.html');return false;">
540
759
          <span class="method-name">get_doc_attr</span><span class="method-args">(id, name)</span>
541
760
          </a>
542
761
        </div>
551
770
        </div>
552
771
      </div>
553
772
 
554
 
      <div id="method-M000015" class="method-detail">
555
 
        <a name="M000015"></a>
556
 
 
557
 
        <div class="method-heading">
558
 
          <a href="Database.src/M000015.html" target="Code" class="method-signature"
559
 
            onclick="popupCode('Database.src/M000015.html');return false;">
 
773
      <div id="method-M000011" class="method-detail">
 
774
        <a name="M000011"></a>
 
775
 
 
776
        <div class="method-heading">
 
777
          <a href="Database.src/M000011.html" target="Code" class="method-signature"
 
778
            onclick="popupCode('Database.src/M000011.html');return false;">
 
779
          <span class="method-name">merge</span><span class="method-args">(name, options)</span>
 
780
          </a>
 
781
        </div>
 
782
      
 
783
        <div class="method-description">
 
784
          <p>
 
785
Merge another database. `name&#8217; specifies the name of another database
 
786
directory. `options&#8217; specifies options: `Database::MGCLEAN&#8217; to
 
787
clean up dispensable regions of the deleted document. The return value is
 
788
true if success, else it is false.
 
789
</p>
 
790
        </div>
 
791
      </div>
 
792
 
 
793
      <div id="method-M000018" class="method-detail">
 
794
        <a name="M000018"></a>
 
795
 
 
796
        <div class="method-heading">
 
797
          <a href="Database.src/M000018.html" target="Code" class="method-signature"
 
798
            onclick="popupCode('Database.src/M000018.html');return false;">
560
799
          <span class="method-name">name</span><span class="method-args">()</span>
561
800
          </a>
562
801
        </div>
568
807
        </div>
569
808
      </div>
570
809
 
571
 
      <div id="method-M000002" class="method-detail">
572
 
        <a name="M000002"></a>
 
810
      <div id="method-M000003" class="method-detail">
 
811
        <a name="M000003"></a>
573
812
 
574
813
        <div class="method-heading">
575
 
          <a href="Database.src/M000002.html" target="Code" class="method-signature"
576
 
            onclick="popupCode('Database.src/M000002.html');return false;">
 
814
          <a href="Database.src/M000003.html" target="Code" class="method-signature"
 
815
            onclick="popupCode('Database.src/M000003.html');return false;">
577
816
          <span class="method-name">open</span><span class="method-args">(name, omode)</span>
578
817
          </a>
579
818
        </div>
593
832
performed without blocking. If `Database::DBNOLCK&#8217; is used, the
594
833
application is responsible for exclusion control. `Database::DBCREAT&#8217;
595
834
can be added to by bitwise or: `Database::DBPERFNG&#8217;, which means
596
 
N-gram analysis is performed against European text also. The return value
597
 
is true if success, else it is false.
 
835
N-gram analysis is performed against European text also,
 
836
`Database::DBCHACAT&#8217;, which means character category analysis is
 
837
performed instead of N-gram analysis, `Database::DBSMALL&#8217;, which
 
838
means the index is tuned to register less than 50000 documents,
 
839
`Database::DBLARGE&#8217;, which means the index is tuned to register more
 
840
than 300000 documents, `Database::DBHUGE&#8217;, which means the index is
 
841
tuned to register more than 1000000 documents, `Database::DBHUGE2&#8217;,
 
842
which means the index is tuned to register more than 5000000 documents,
 
843
`Database::DBHUGE3&#8217;, which means the index is tuned to register more
 
844
than 10000000 documents, `Database::DBSCVOID&#8217;, which means scores are
 
845
stored as void, `Database::DBSCINT&#8217;, which means scores are stored as
 
846
32-bit integer, `Database::DBSCASIS&#8217;, which means scores are stored
 
847
as-is and marked not to be tuned when search. The return value is true if
 
848
success, else it is false.
598
849
</p>
599
850
        </div>
600
851
      </div>
601
852
 
602
 
      <div id="method-M000008" class="method-detail">
603
 
        <a name="M000008"></a>
 
853
      <div id="method-M000010" class="method-detail">
 
854
        <a name="M000010"></a>
604
855
 
605
856
        <div class="method-heading">
606
 
          <a href="Database.src/M000008.html" target="Code" class="method-signature"
607
 
            onclick="popupCode('Database.src/M000008.html');return false;">
 
857
          <a href="Database.src/M000010.html" target="Code" class="method-signature"
 
858
            onclick="popupCode('Database.src/M000010.html');return false;">
608
859
          <span class="method-name">optimize</span><span class="method-args">(options)</span>
609
860
          </a>
610
861
        </div>
620
871
        </div>
621
872
      </div>
622
873
 
623
 
      <div id="method-M000010" class="method-detail">
624
 
        <a name="M000010"></a>
 
874
      <div id="method-M000013" class="method-detail">
 
875
        <a name="M000013"></a>
625
876
 
626
877
        <div class="method-heading">
627
 
          <a href="Database.src/M000010.html" target="Code" class="method-signature"
628
 
            onclick="popupCode('Database.src/M000010.html');return false;">
 
878
          <a href="Database.src/M000013.html" target="Code" class="method-signature"
 
879
            onclick="popupCode('Database.src/M000013.html');return false;">
629
880
          <span class="method-name">out_doc</span><span class="method-args">(id, options)</span>
630
881
          </a>
631
882
        </div>
633
884
        <div class="method-description">
634
885
          <p>
635
886
Remove a document. `id&#8217; specifies the ID number of a registered
636
 
document. `options&#8217; specifies options: `Database.ODCLEAN&#8217; to
 
887
document. `options&#8217; specifies options: `Database::ODCLEAN&#8217; to
637
888
clean up dispensable regions of the deleted document. The return value is
638
889
true if success, else it is false.
639
890
</p>
640
891
        </div>
641
892
      </div>
642
893
 
643
 
      <div id="method-M000009" class="method-detail">
644
 
        <a name="M000009"></a>
 
894
      <div id="method-M000012" class="method-detail">
 
895
        <a name="M000012"></a>
645
896
 
646
897
        <div class="method-heading">
647
 
          <a href="Database.src/M000009.html" target="Code" class="method-signature"
648
 
            onclick="popupCode('Database.src/M000009.html');return false;">
 
898
          <a href="Database.src/M000012.html" target="Code" class="method-signature"
 
899
            onclick="popupCode('Database.src/M000012.html');return false;">
649
900
          <span class="method-name">put_doc</span><span class="method-args">(doc, options)</span>
650
901
          </a>
651
902
        </div>
654
905
          <p>
655
906
Add a document. `doc&#8217; specifies a document object. The document
656
907
object should have the URI attribute. `options&#8217; specifies options:
657
 
`Database.PDCLEAN&#8217; to clean up dispensable regions of the overwritten
658
 
document. The return value is true if success, else it is false.
 
908
`Database::PDCLEAN&#8217; to clean up dispensable regions of the
 
909
overwritten document. The return value is true if success, else it is
 
910
false.
659
911
</p>
660
912
        </div>
661
913
      </div>
662
914
 
663
 
      <div id="method-M000020" class="method-detail">
664
 
        <a name="M000020"></a>
 
915
      <div id="method-M000023" class="method-detail">
 
916
        <a name="M000023"></a>
665
917
 
666
918
        <div class="method-heading">
667
 
          <a href="Database.src/M000020.html" target="Code" class="method-signature"
668
 
            onclick="popupCode('Database.src/M000020.html');return false;">
 
919
          <a href="Database.src/M000023.html" target="Code" class="method-signature"
 
920
            onclick="popupCode('Database.src/M000023.html');return false;">
669
921
          <span class="method-name">scan_doc</span><span class="method-args">(doc, cond)</span>
670
922
          </a>
671
923
        </div>
681
933
        </div>
682
934
      </div>
683
935
 
684
 
      <div id="method-M000019" class="method-detail">
685
 
        <a name="M000019"></a>
 
936
      <div id="method-M000022" class="method-detail">
 
937
        <a name="M000022"></a>
686
938
 
687
939
        <div class="method-heading">
688
 
          <a href="Database.src/M000019.html" target="Code" class="method-signature"
689
 
            onclick="popupCode('Database.src/M000019.html');return false;">
 
940
          <a href="Database.src/M000022.html" target="Code" class="method-signature"
 
941
            onclick="popupCode('Database.src/M000022.html');return false;">
690
942
          <span class="method-name">search</span><span class="method-args">(cond)</span>
691
943
          </a>
692
944
        </div>
693
945
      
694
946
        <div class="method-description">
695
947
          <p>
696
 
Search documents corresponding a condition. `cond&#8217; specifies a
 
948
Search for documents corresponding a condition. `cond&#8217; specifies a
697
949
condition object. The return value is a result object. On error,
698
950
`nil&#8217; is returned.
699
951
</p>
700
952
        </div>
701
953
      </div>
702
954
 
703
 
      <div id="method-M000021" class="method-detail">
704
 
        <a name="M000021"></a>
 
955
      <div id="method-M000024" class="method-detail">
 
956
        <a name="M000024"></a>
705
957
 
706
958
        <div class="method-heading">
707
 
          <a href="Database.src/M000021.html" target="Code" class="method-signature"
708
 
            onclick="popupCode('Database.src/M000021.html');return false;">
 
959
          <a href="Database.src/M000024.html" target="Code" class="method-signature"
 
960
            onclick="popupCode('Database.src/M000024.html');return false;">
709
961
          <span class="method-name">set_cache_size</span><span class="method-args">(size, anum, tnum, rnum)</span>
710
962
          </a>
711
963
        </div>
726
978
        </div>
727
979
      </div>
728
980
 
729
 
      <div id="method-M000018" class="method-detail">
730
 
        <a name="M000018"></a>
731
 
 
732
 
        <div class="method-heading">
733
 
          <a href="Database.src/M000018.html" target="Code" class="method-signature"
734
 
            onclick="popupCode('Database.src/M000018.html');return false;">
 
981
      <div id="method-M000027" class="method-detail">
 
982
        <a name="M000027"></a>
 
983
 
 
984
        <div class="method-heading">
 
985
          <a href="Database.src/M000027.html" target="Code" class="method-signature"
 
986
            onclick="popupCode('Database.src/M000027.html');return false;">
 
987
          <span class="method-name">set_informer</span><span class="method-args">(informer)</span>
 
988
          </a>
 
989
        </div>
 
990
      
 
991
        <div class="method-description">
 
992
          <p>
 
993
Set the callback function to inform of database events. `informer&#8217;
 
994
specifies an arbitrary object with a method named as `inform&#8217;. The
 
995
method should have one parameter for a string of a message of each event.
 
996
The return value is always `nil&#8217;.
 
997
</p>
 
998
        </div>
 
999
      </div>
 
1000
 
 
1001
      <div id="method-M000026" class="method-detail">
 
1002
        <a name="M000026"></a>
 
1003
 
 
1004
        <div class="method-heading">
 
1005
          <a href="Database.src/M000026.html" target="Code" class="method-signature"
 
1006
            onclick="popupCode('Database.src/M000026.html');return false;">
 
1007
          <span class="method-name">set_wildmax</span><span class="method-args">(num)</span>
 
1008
          </a>
 
1009
        </div>
 
1010
      
 
1011
        <div class="method-description">
 
1012
          <p>
 
1013
Set the maximum number of expansion of wild cards. `num&#8217; specifies
 
1014
the maximum number of expansion of wild cards. The return value is always
 
1015
`nil&#8217;.
 
1016
</p>
 
1017
        </div>
 
1018
      </div>
 
1019
 
 
1020
      <div id="method-M000021" class="method-detail">
 
1021
        <a name="M000021"></a>
 
1022
 
 
1023
        <div class="method-heading">
 
1024
          <a href="Database.src/M000021.html" target="Code" class="method-signature"
 
1025
            onclick="popupCode('Database.src/M000021.html');return false;">
735
1026
          <span class="method-name">size</span><span class="method-args">()</span>
736
1027
          </a>
737
1028
        </div>
743
1034
        </div>
744
1035
      </div>
745
1036
 
746
 
      <div id="method-M000007" class="method-detail">
747
 
        <a name="M000007"></a>
 
1037
      <div id="method-M000009" class="method-detail">
 
1038
        <a name="M000009"></a>
748
1039
 
749
1040
        <div class="method-heading">
750
 
          <a href="Database.src/M000007.html" target="Code" class="method-signature"
751
 
            onclick="popupCode('Database.src/M000007.html');return false;">
 
1041
          <a href="Database.src/M000009.html" target="Code" class="method-signature"
 
1042
            onclick="popupCode('Database.src/M000009.html');return false;">
752
1043
          <span class="method-name">sync</span><span class="method-args">()</span>
753
1044
          </a>
754
1045
        </div>
761
1052
        </div>
762
1053
      </div>
763
1054
 
764
 
      <div id="method-M000014" class="method-detail">
765
 
        <a name="M000014"></a>
 
1055
      <div id="method-M000017" class="method-detail">
 
1056
        <a name="M000017"></a>
766
1057
 
767
1058
        <div class="method-heading">
768
 
          <a href="Database.src/M000014.html" target="Code" class="method-signature"
769
 
            onclick="popupCode('Database.src/M000014.html');return false;">
 
1059
          <a href="Database.src/M000017.html" target="Code" class="method-signature"
 
1060
            onclick="popupCode('Database.src/M000017.html');return false;">
770
1061
          <span class="method-name">uri_to_id</span><span class="method-args">(uri)</span>
771
1062
          </a>
772
1063
        </div>
780
1071
        </div>
781
1072
      </div>
782
1073
 
783
 
      <div id="method-M000017" class="method-detail">
784
 
        <a name="M000017"></a>
 
1074
      <div id="method-M000020" class="method-detail">
 
1075
        <a name="M000020"></a>
785
1076
 
786
1077
        <div class="method-heading">
787
 
          <a href="Database.src/M000017.html" target="Code" class="method-signature"
788
 
            onclick="popupCode('Database.src/M000017.html');return false;">
 
1078
          <a href="Database.src/M000020.html" target="Code" class="method-signature"
 
1079
            onclick="popupCode('Database.src/M000020.html');return false;">
789
1080
          <span class="method-name">word_num</span><span class="method-args">()</span>
790
1081
          </a>
791
1082
        </div>