nmdb/nmdb.1

   1 .TH nmdb 1 "11/Sep/2006"
   2 .SH NAME
   3 nmdb - A multiprotocol network database manager
   4 .SH SYNOPSIS
   5 nmdb [-b backend] [-d dbpath]
   6   [-l lower] [-L upper]
   7   [-t tcpport] [-T tcpaddr]
   8   [-u udpport] [-U udpaddr]
   9   [-s sctpport] [-S sctpaddr]
  10   [-c nobj] [-o fname] [-f] [-p] [-h]
  11
  12 .SH DESCRIPTION
  13
  14 nmdb is a network database that can use different protocols to communicate
  15 with its clients. At the moment, it supports TIPC, TCP, UDP and SCTP.
  16
  17 It can also be used as a generic caching system (pretty much like memcached),
  18 because it has a very fast cache that can be used without impacting on the
  19 database.
  20
  21 The database is accessed with the
  22 .BR libnmdb (3)
  23 library. Consult its manual page for programming information. Python bindings
  24 are also available.
  25
  26 For additional documentation, go to the project's website at
  27 .IR http://blitiri.com.ar/p/nmdb .
  28
  29 .SH OPTIONS
  30 .TP
  31 .B "-b backend"
  32 Which database library to use as backend. It can be one of tdb, tc, qdbm, bdb,
  33 or null, although not all of them may be available, depending on build-time
  34 options. On doubt, use the default.
  35 .TP
  36 .B "-d dbpath"
  37 Indicate the path to the database file to use. It will be created if it
  38 doesn't exist. If a name is not provided, "database" will be used.
  39 .TP
  40 .B "-l lower"
  41 Lower TIPC port number to bind to. Defaults to 10. It's useful if you want to
  42 run more than one nmdb instance in the same TIPC cluster.
  43 .TP
  44 .B "-L upper"
  45 Upper TIPC port number to bind to. Defaults to the same value
  46 .B lower
  47 is defined. Useful mainly for passive mode.
  48 .TP
  49 .B "-t tcpport"
  50 TCP listening port. Defaults to 26010.
  51 .TP
  52 .B "-T tcpaddr"
  53 IP listening address for TCP. Defaults to all local addresses.
  54 .TP
  55 .B "-u udpport"
  56 UDP listening port. Defaults to 26010.
  57 .TP
  58 .B "-U udpaddr"
  59 IP listening address for UDP. Defaults to all local addresses.
  60 .TP
  61 .B "-s sctpport"
  62 SCTP listening port. Defaults to 26010.
  63 .TP
  64 .B "-S sctpaddr"
  65 IP listening address for SCTP. Defaults to all local addresses.
  66 .TP
  67 .B "-c nobj"
  68 Sets the maximum number of objects the cache will held, in thousands. Note
  69 that the size of the memory used by the cache layer depends on the size of the
  70 object exclusively. It defaults to 128, so the default cache size has space to
  71 hold 128 thousand objects.
  72 .TP
  73 .B "-o fname"
  74 Enable logging into the given file name. By default, output the debugging
  75 information to stdout.
  76 .TP
  77 .B "-f"
  78 Stay in the foreground, don't fork. Useful for debugging. The default is to
  79 fork.
  80 .TP
  81 .B "-p"
  82 Enable passive mode, where the server never replies requests, but acts upon
  83 them. It's useful when you want to have a live database mirror, in case the
  84 main node fails. It still requires a manual restart to became active, but at
  85 least you have a recent up-to-date database. Be aware that it's not widely
  86 tested (although it should work fine), and do
  87 .I not
  88 start an active and a passive server in the same machine (it misbehaves under
  89 some circumstances, and doesn't make much sense anyway).
  90 .TP
  91 .B "-r"
  92 Read-only mode. The server will refuse any request that would alter the
  93 database and/or cache. Useful for redundancy and replication.
  94 .TP
  95 .B "-h"
  96 Show a brief help.
  97
  98 .SH INVOCATION EXAMPLE
  99 To run the server with the database at /var/lib/nmdb-db:
 100 .B "nmdb -d /var/lib/nmdb-db"
 101
 102 Be
 103 .I very
 104 careful not to start more than one nmdb instance on the same port at the same
 105 time, even if it's on different machines. TIPC allows you to bind the same
 106 port many times (and it's a very good feature), and all of them will get the
 107 messages, which will result in several answers, which will confuse the
 108 clients. This behaviour is different from the normal IP networking, where you
 109 can't bind a port twice.
 110
 111 .SH SEE ALSO
 112 .BR libnmdb (3).
 113
 114 .SH AUTHORS
 115 Created by Alberto Bertogli (albertito@blitiri.com.ar).
 116
 117 .SH CONTACT
 118
 119 If you want to report bugs, or have any questions or comments, just let me
 120 know at albertito@blitiri.com.ar.
 121