Project

General

Profile

« Previous | Next » 

Revision 4188

Added by daigle about 16 years ago

Add database properties with new format

View differences:

docs/user/properties.html
293 293
  <div class="property-description-line">
294 294
    <h2 class="property-inline"> Example: </h2> 
295 295
    <p class="property-text">TODO MCD add this</p>
296
  </div>     
296
  </div>    
297 297
  
298
  <br> 
299

  
300
  <a name="database.connectionURI"></a><h1 class="property-main"> database.connectionURI </h1>
301
  <div class="property-description-line">
302
    <h2 class="property-inline"> Default Value: </h2> 
303
    <p class="property-text">jdbc:postgresql://localhost/metacat</p>
304
  </div>
305
  <div class="property-description-line">
306
    <h2 class="property-inline"> Set Method: </h2> 
307
    <p class="property-text">Configuration Utility</p>
308
  </div>
309
  <div class="property-description-line">
310
    <h2 class="property-inline"> Description: </h2> 
311
    <p class="property-text">The jdbc connection URI for the main 
312
    database instance of Metacat.  The uri is formatted like: <br>
313
    &nbsp;&nbsp;&nbsp;&nbsp;jdbc:&lt;database_type&gt;:thin@&lt;your_server_name&gt;:1521:&lt;metacat_database_name&gt;<br>
314
    An empty database must have been created prior to Metacat 
315
    configuration.</p>
316
  </div>
317
  <div class="property-description-line">
318
    <h2 class="property-inline"> Example: </h2> 
319
    <p class="property-text">jdbc:postgresql://yourserver.yourdomain.edu/metacat</p>
320
  </div>   
321
  
298 322
  <a name="database.user"></a><h1 class="property-main"> database.user </h1>
299 323
  <div class="property-description-line">
300 324
    <h2 class="property-inline"> Default Value: </h2> 
......
306 330
  </div>
307 331
  <div class="property-description-line">
308 332
    <h2 class="property-inline"> Description: </h2> 
309
    <p class="property-text">The main database instance for Metacat.  
310
    An empty database must have been created prior to Metacat 
311
    configuration</p>
333
    <p class="property-text">The user for the main database instance 
334
    of Metacat.  The user must have already been created on the database.</p>
312 335
  </div>
313 336
  <div class="property-description-line">
314 337
    <h2 class="property-inline"> Example: </h2> 
315
    <p class="property-text">metacat</p>
338
    <p class="property-text">metacat-user</p>
316 339
  </div>     
317 340
  
341
  <a name="database.password"></a><h1 class="property-main"> database.password </h1>
342
  <div class="property-description-line">
343
    <h2 class="property-inline"> Default Value: </h2> 
344
    <p class="property-text">(none)</p>
345
  </div>
346
  <div class="property-description-line">
347
    <h2 class="property-inline"> Set Method: </h2> 
348
    <p class="property-text">Configuration Utility</p>
349
  </div>
350
  <div class="property-description-line">
351
    <h2 class="property-inline"> Description: </h2> 
352
    <p class="property-text">The password of the user for the main 
353
    database instance of Metacat.  The password must have already been created
354
    for the user.</p>
355
  </div>
356
  <div class="property-description-line">
357
    <h2 class="property-inline"> Example: </h2> 
358
    <p class="property-text">securepassword4843</p>
359
  </div>   
360

  
361
  <a name="database.type"></a><h1 class="property-main"> database.type </h1>
362
  <div class="property-description-line">
363
    <h2 class="property-inline"> Default Value: </h2> 
364
    <p class="property-text">(none)</p>
365
  </div>
366
  <div class="property-description-line">
367
    <h2 class="property-inline"> Set Method: </h2> 
368
    <p class="property-text">Configuration Utility</p>
369
  </div>
370
  <div class="property-description-line">
371
    <h2 class="property-inline"> Description: </h2> 
372
    <p class="property-text">The type of database you are running.  Currently, 
373
    there are two supported types, Oracle and Postgres.</p>
374
  </div>
375
  <div class="property-description-line">
376
    <h2 class="property-inline"> Example: </h2> 
377
    <p class="property-text">postgres</p>
378
  </div>   
318 379
  
380
  <a name="database.driver"></a><h1 class="property-main"> database.driver </h1>
381
  <div class="property-description-line">
382
    <h2 class="property-inline"> Default Value: </h2> 
383
    <p class="property-text">(none)</p>
384
  </div>
385
  <div class="property-description-line">
386
    <h2 class="property-inline"> Set Method: </h2> 
387
    <p class="property-text">Configuration Utility</p>
388
  </div>
389
  <div class="property-description-line">
390
    <h2 class="property-inline"> Description: </h2> 
391
    <p class="property-text">The JDBC driver to be used to access the main 
392
    database instance of Metacat.  There is one of these associated with each
393
    type of database.</p>
394
  </div>
395
  <div class="property-description-line">
396
    <h2 class="property-inline"> Example: </h2> 
397
    <p class="property-text">org.postgresql.Driver</p>
398
  </div> 
319 399
  
400
  <a name="database.adapter"></a><h1 class="property-main"> database.adapter </h1>
401
  <div class="property-description-line">
402
    <h2 class="property-inline"> Default Value: </h2> 
403
    <p class="property-text">(none)</p>
404
  </div>
405
  <div class="property-description-line">
406
    <h2 class="property-inline"> Set Method: </h2> 
407
    <p class="property-text">Configuration Utility</p>
408
  </div>
409
  <div class="property-description-line">
410
    <h2 class="property-inline"> Description: </h2> 
411
    <p class="property-text">The adapter class that allows Metacat to access your 
412
    database type.  There is one of these associated with each type of database.</p>
413
  </div>
414
  <div class="property-description-line">
415
    <h2 class="property-inline"> Example: </h2> 
416
    <p class="property-text">edu.ucsb.nceas.dbadapter.PostgresqlAdapter</p>
417
  </div>   
320 418
  
419
  <a name="database.scriptsuffix"></a><h1 class="property-main"> database.scriptsuffix.&lt;database_type&gt; </h1>
420
  <div class="property-description-line">
421
    <h2 class="property-inline"> Default Value: </h2> 
422
    <p class="property-text">
423
      <br>&nbsp;&nbsp;&nbsp;&nbsp;database.scriptsuffix.postgres=postgres.sql<br>
424
      &nbsp;&nbsp;&nbsp;&nbsp;database.scriptsuffix.oracle=oracle.sql
425
    </p>
426
  </div>
427
  <div class="property-description-line">
428
    <h2 class="property-inline"> Set Method: </h2> 
429
    <p class="property-text">Configuration Utility</p>
430
  </div>
431
  <div class="property-description-line">
432
    <h2 class="property-inline"> Description: </h2> 
433
    <p class="property-text">There is a database.scriptsuffix entry for every
434
      supported type of database.  These tell the system which database scripts
435
      to run when installing or updating database schema.</p>
436
  </div>
437
  <div class="property-description-line">
438
    <h2 class="property-inline"> Example: </h2> 
439
    <p class="property-text">postgres.sql</p>
440
  </div>   
441
  
442
  <a name="database.upgradeVersion"></a><h1 class="property-main"> database.upgradeVersion.&lt;database_version&gt; </h1>
443
  <div class="property-description-line">
444
    <h2 class="property-inline"> Default Value: </h2> 
445
    <p class="property-text">
446
      <br>&nbsp;&nbsp;&nbsp;&nbsp;database.upgradeVersion.0.0.0=xmltables,loaddtdschema<br>
447
          &nbsp;&nbsp;&nbsp;&nbsp;database.upgradeVersion.1.2.0=upgrade-db-to-1.2<br>
448
          &nbsp;&nbsp;&nbsp;&nbsp;database.upgradeVersion.1.3.0=upgrade-db-to-1.3<br>
449
          &nbsp;&nbsp;&nbsp;&nbsp;database.upgradeVersion.1.4.0=upgrade-db-to-1.4<br>
450
          &nbsp;&nbsp;&nbsp;&nbsp;database.upgradeVersion.1.5.0=upgrade-db-to-1.5<br>
451
          &nbsp;&nbsp;&nbsp;&nbsp;database.upgradeVersion.1.6.0=upgrade-db-to-1.6<br>
452
          &nbsp;&nbsp;&nbsp;&nbsp;database.upgradeVersion.1.7.0=upgrade-db-to-1.7<br>
453
          &nbsp;&nbsp;&nbsp;&nbsp;database.upgradeVersion.1.8.0=upgrade-db-to-1.8<br>
454
          &nbsp;&nbsp;&nbsp;&nbsp;database.upgradeVersion.1.9.0=upgrade-db-to-1.9
455
    </p>
456
  </div>
457
  <div class="property-description-line">
458
    <h2 class="property-inline"> Set Method: </h2> 
459
    <p class="property-text">Configuration Utility</p>
460
  </div>
461
  <div class="property-description-line">
462
    <h2 class="property-inline"> Description: </h2> 
463
    <p class="property-text">There is a database.scriptsuffix entry for every
464
      metacat database schema version. (Note that a schema version corresponds
465
      to an application version.) These tell the system which database scripts
466
      to run when installing or updating database schema.</p>
467
  </div>
468
  <div class="property-description-line">
469
    <h2 class="property-inline"> Example: </h2> 
470
    <p class="property-text">upgrade-db-to-1.2</p>
471
  </div>   
472
  
473
  <a name="database.initialConnections"></a><h1 class="property-main"> database.initialConnections </h1>
474
  <div class="property-description-line">
475
    <h2 class="property-inline"> Default Value: </h2> 
476
    <p class="property-text">5</p>
477
  </div>
478
  <div class="property-description-line">
479
    <h2 class="property-inline"> Set Method: </h2> 
480
    <p class="property-text">Manual</p>
481
  </div>
482
  <div class="property-description-line">
483
    <h2 class="property-inline"> Description: </h2> 
484
    <p class="property-text"> The number of initial connection that 
485
      Metacat creates to the database.</p>
486
  </div>
487
  <div class="property-description-line">
488
    <h2 class="property-inline"> Example: </h2> 
489
    <p class="property-text">5</p>
490
  </div>   
491
  
492
  <a name="database.incrementConnections"></a><h1 class="property-main"> database.incrementConnections </h1>
493
  <div class="property-description-line">
494
    <h2 class="property-inline"> Default Value: </h2> 
495
    <p class="property-text">5</p>
496
  </div>
497
  <div class="property-description-line">
498
    <h2 class="property-inline"> Set Method: </h2> 
499
    <p class="property-text">Manual</p>
500
  </div>
501
  <div class="property-description-line">
502
    <h2 class="property-inline"> Description: </h2> 
503
    <p class="property-text"> The number of connections that are created 
504
      when Metacat needs more connections.</p>
505
  </div>
506
  <div class="property-description-line">
507
    <h2 class="property-inline"> Example: </h2> 
508
    <p class="property-text">5</p>
509
  </div>   
510
  
511
  <a name="database.maximumConnections"></a><h1 class="property-main"> database.maximumConnections </h1>
512
  <div class="property-description-line">
513
    <h2 class="property-inline"> Default Value: </h2> 
514
    <p class="property-text">25</p>
515
  </div>
516
  <div class="property-description-line">
517
    <h2 class="property-inline"> Set Method: </h2> 
518
    <p class="property-text">Manual</p>
519
  </div>
520
  <div class="property-description-line">
521
    <h2 class="property-inline"> Description: </h2> 
522
    <p class="property-text"> The maximum number of database connections 
523
      Metacat can make.</p>
524
  </div>
525
  <div class="property-description-line">
526
    <h2 class="property-inline"> Example: </h2> 
527
    <p class="property-text">25</p>
528
  </div>   
529

  
530
  <a name="database.maximumConnectionAge"></a><h1 class="property-main"> database.maximumConnectionAge </h1>
531
  <div class="property-description-line">
532
    <h2 class="property-inline"> Default Value: </h2> 
533
    <p class="property-text">120000</p>
534
  </div>
535
  <div class="property-description-line">
536
    <h2 class="property-inline"> Set Method: </h2> 
537
    <p class="property-text">Manual</p>
538
  </div>
539
  <div class="property-description-line">
540
    <h2 class="property-inline"> Description: </h2> 
541
    <p class="property-text"> The maximum time in milliseconds that a database
542
      connection can live.</p>
543
  </div>
544
  <div class="property-description-line">
545
    <h2 class="property-inline"> Example: </h2> 
546
    <p class="property-text">120000</p>
547
  </div>   
548
  
549
  <a name="database.maximumConnectionTime"></a><h1 class="property-main"> database.maximumConnectionTime </h1>
550
  <div class="property-description-line">
551
    <h2 class="property-inline"> Default Value: </h2> 
552
    <p class="property-text">60000</p>
553
  </div>
554
  <div class="property-description-line">
555
    <h2 class="property-inline"> Set Method: </h2> 
556
    <p class="property-text">Manual</p>
557
  </div>
558
  <div class="property-description-line">
559
    <h2 class="property-inline"> Description: </h2> 
560
    <p class="property-text"> The maximum time in milliseconds that a database
561
      connection can accumulate in actual connection time.</p>
562
  </div>
563
  <div class="property-description-line">
564
    <h2 class="property-inline"> Example: </h2> 
565
    <p class="property-text">60000</p>
566
  </div>   
567

  
568
  <a name="database.maximumUsageNumber"></a><h1 class="property-main"> database.maximumUsageNumber </h1>
569
  <div class="property-description-line">
570
    <h2 class="property-inline"> Default Value: </h2> 
571
    <p class="property-text">100</p>
572
  </div>
573
  <div class="property-description-line">
574
    <h2 class="property-inline"> Set Method: </h2> 
575
    <p class="property-text">Manual</p>
576
  </div>
577
  <div class="property-description-line">
578
    <h2 class="property-inline"> Description: </h2> 
579
    <p class="property-text"> The maximum number of times a single connection
580
      can be used.</p>
581
  </div>
582
  <div class="property-description-line">
583
    <h2 class="property-inline"> Example: </h2> 
584
    <p class="property-text">100</p>
585
  </div>   
586

  
587
  <a name="database.numberOfIndexingThreads"></a><h1 class="property-main"> database.numberOfIndexingThreads </h1>
588
  <div class="property-description-line">
589
    <h2 class="property-inline"> Default Value: </h2> 
590
    <p class="property-text">5</p>
591
  </div>
592
  <div class="property-description-line">
593
    <h2 class="property-inline"> Set Method: </h2> 
594
    <p class="property-text">Manual</p>
595
  </div>
596
  <div class="property-description-line">
597
    <h2 class="property-inline"> Description: </h2> 
598
    <p class="property-text"> The number of threads available for indexing.</p>
599
  </div>
600
  <div class="property-description-line">
601
    <h2 class="property-inline"> Example: </h2> 
602
    <p class="property-text">5</p>
603
  </div>   
604
  
605
  <a name="database.indexingTimerTaskTime"></a><h1 class="property-main"> database.indexingTimerTaskTime </h1>
606
  <div class="property-description-line">
607
    <h2 class="property-inline"> Default Value: </h2> 
608
    <p class="property-text">604800000</p>
609
  </div>
610
  <div class="property-description-line">
611
    <h2 class="property-inline"> Set Method: </h2> 
612
    <p class="property-text">Manual</p>
613
  </div>
614
  <div class="property-description-line">
615
    <h2 class="property-inline"> Description: </h2> 
616
    <p class="property-text"> The time in milliseconds between indexing.</p>
617
  </div>
618
  <div class="property-description-line">
619
    <h2 class="property-inline"> Example: </h2> 
620
    <p class="property-text">604800000</p>
621
  </div>    
622
  
623
  <a name="database.indexingInitialDelay"></a><h1 class="property-main"> database.indexingInitialDelay </h1>
624
  <div class="property-description-line">
625
    <h2 class="property-inline"> Default Value: </h2> 
626
    <p class="property-text">3600000</p>
627
  </div>
628
  <div class="property-description-line">
629
    <h2 class="property-inline"> Set Method: </h2> 
630
    <p class="property-text">Manual</p>
631
  </div>
632
  <div class="property-description-line">
633
    <h2 class="property-inline"> Description: </h2> 
634
    <p class="property-text"> The delay in milliseconds before first indexing is executed.</p>
635
  </div>
636
  <div class="property-description-line">
637
    <h2 class="property-inline"> Example: </h2> 
638
    <p class="property-text">3600000</p>
639
  </div>  
640
 
641
  <a name="database.maximumIndexDelay"></a><h1 class="property-main"> database.maximumIndexDelay </h1>
642
  <div class="property-description-line">
643
    <h2 class="property-inline"> Default Value: </h2> 
644
    <p class="property-text">5000</p>
645
  </div>
646
  <div class="property-description-line">
647
    <h2 class="property-inline"> Set Method: </h2> 
648
    <p class="property-text">Manual</p>
649
  </div>
650
  <div class="property-description-line">
651
    <h2 class="property-inline"> Description: </h2> 
652
    <p class="property-text"> The time in milliseconds that an indexing thread
653
      will wait when it can't get a doc id before retrying the indexing.</p>
654
  </div>
655
  <div class="property-description-line">
656
    <h2 class="property-inline"> Example: </h2> 
657
    <p class="property-text">5000</p>
658
  </div>   
659
 
660
  <a name="database.runDBConnectionRecycleThread"></a><h1 class="property-main"> database.runDBConnectionRecycleThread </h1>
661
  <div class="property-description-line">
662
    <h2 class="property-inline"> Default Value: </h2> 
663
    <p class="property-text">off</p>
664
  </div>
665
  <div class="property-description-line">
666
    <h2 class="property-inline"> Set Method: </h2> 
667
    <p class="property-text">Manual</p>
668
  </div>
669
  <div class="property-description-line">
670
    <h2 class="property-inline"> Description: </h2> 
671
    <p class="property-text"> Determines whether the database connection
672
      pool should run a thread to recycle connections.  Possible values are
673
      "on" and "off"</p>
674
  </div>
675
  <div class="property-description-line">
676
    <h2 class="property-inline"> Example: </h2> 
677
    <p class="property-text">off</p>
678
  </div>  
679
  
680
  <a name="database.cycleTimeOfDBConnection"></a><h1 class="property-main"> database.cycleTimeOfDBConnection </h1>
681
  <div class="property-description-line">
682
    <h2 class="property-inline"> Default Value: </h2> 
683
    <p class="property-text">30000</p>
684
  </div>
685
  <div class="property-description-line">
686
    <h2 class="property-inline"> Set Method: </h2> 
687
    <p class="property-text">Manual</p>
688
  </div>
689
  <div class="property-description-line">
690
    <h2 class="property-inline"> Description: </h2> 
691
    <p class="property-text"> The time in milliseconds between connection
692
      recycling runs.</p>
693
  </div>
694
  <div class="property-description-line">
695
    <h2 class="property-inline"> Example: </h2> 
696
    <p class="property-text">30000</p>
697
  </div>   
698
  
699
  <a name="database.queryignoredparams"></a><h1 class="property-main"> database.queryignoredparams </h1>
700
  <div class="property-description-line">
701
    <h2 class="property-inline"> Default Value: </h2> 
702
    <p class="property-text">enableediting,foo</p>
703
  </div>
704
  <div class="property-description-line">
705
    <h2 class="property-inline"> Set Method: </h2> 
706
    <p class="property-text">Manual</p>
707
  </div>
708
  <div class="property-description-line">
709
    <h2 class="property-inline"> Description: </h2> 
710
    <p class="property-text"> Parameters to ignore in a structured
711
      xml query.</p>
712
  </div>
713
  <div class="property-description-line">
714
    <h2 class="property-inline"> Example: </h2> 
715
    <p class="property-text">enableediting</p>
716
  </div> 
717
  
718
  <a name="database.usexmlindex"></a><h1 class="property-main"> database.usexmlindex </h1>
719
  <div class="property-description-line">
720
    <h2 class="property-inline"> Default Value: </h2> 
721
    <p class="property-text">true</p>
722
  </div>
723
  <div class="property-description-line">
724
    <h2 class="property-inline"> Set Method: </h2> 
725
    <p class="property-text">Manual</p>
726
  </div>
727
  <div class="property-description-line">
728
    <h2 class="property-inline"> Description: </h2> 
729
    <p class="property-text"> Determines whether to use xml 
730
      indexes when finding documents.  Possible values are true
731
      and false.</p>
732
  </div>
733
  <div class="property-description-line">
734
    <h2 class="property-inline"> Example: </h2> 
735
    <p class="property-text">true</p>
736
  </div>
737
  
738
  
739
     
740

  
321 741
  <table border="1">
322 742
    <tr>
323 743
      <td><b>Property</b></td>
......
325 745
      <td><b>Possible or default value</b></td>
326 746
    </tr>
327 747
    <tr>
328
      <td>user</td>
329
      <td>The username that Metacat uses to access the backend database.</td>
330
      <td>&nbsp;</td>
331
    </tr>
332
    <tr>
333
      <td>password</td>
334
      <td>The password that Metacat uses to access the backend database.</td>
335
      <td>&nbsp;</td>
336
    </tr>
337
    <tr>
338
      <td>defaultDB</td>
339
      <td>The JDBC connection string that Metacat uses to connect to the backend
340
      database.</td>
341
      <td>jdbc:oracle:thin:@server.domain.com:1521:Metacat</td>
342
    </tr>
343
    <tr>
344
      <td>dbDriver</td>
345
      <td>The JDBC driver to be used to access the backend database.</td>
346
      <td>oracle.jdbc.driver.OracleDriver</td>
347
    </tr>
348
    <tr>
349
      <td>dbAdapter</td>
350
      <td>The name of the RDBMS Adapter Class that Metacat uses to get specific
351
          features in the backend database.</td>
352
      <td>edu.ucsb.nceas.dbadapter.OracleAdapter</td>
353
    </tr>
354
    <tr>
355
      <td>initialConnections</td>
356
      <td>The number of initial connection that Metacat creates to the database.</td>
357
      <td>5</td>
358
    </tr>
359
    <tr>
360
      <td>incrementConnections</td>
361
      <td>The number of connections that are created when Metacat needs more 
362
      connections.</td>
363
      <td>5</td>
364
    </tr>
365
    <tr>
366
      <td>maximumConnections</td>
367
      <td>The maximum number of database connection Metacat can make.</td>
368
      <td>25</td>
369
    </tr>
370
    <tr>
371 748
      <td>config-dir</td>
372 749
      <td>directory where the style-sets exist</td>
373 750
      <td>/opt/tomcat/webapps/metacat/lib</td>

Also available in: Unified diff