git.m6w6.name Git - awesomized/libmemcached/blob - docs/libmemcached_configuration.rst

   1 ========================
   2 Configuring Libmemcached
   3 ========================
   4
   5 Libmemcached implements a custom language for configuring and modifying servers.
   6
   7 .. describe:: --SERVER=<servername>:<optional_port>/?<optional_weight>
   8
   9 Provide a servername to be used by the client. Providing a weight will cause weighting to occur with all hosts with each server getting a default weight of 1.
  10
  11 .. describe:: --VERIFY-KEY
  12
  13 Verify that keys that are being used fit within the design of the protocol being used.
  14
  15 .. describe:: --AUTO-EJECT_HOSTS
  16
  17 Enable the behavior MEMCACHED_BEHAVIOR_AUTO_EJECT_HOSTS.
  18
  19 .. describe:: --BINARY-PROTOCOL
  20
  21 Force all connections to use the binary protocol.
  22
  23 .. describe:: --BUFFER-REQUESTS
  24
  25 Enable MEMCACHED_BEHAVIOR_BUFFER_REQUESTS.
  26
  27 .. describe:: --CONFIGURE-FILE=
  28
  29 Provide a configuration file to be used to load requests. Beware that by using a configuration file libmemcached will reset memcached_st based on information only contained in the file.
  30
  31 .. describe:: --CONNECT-TIMEOUT=
  32
  33 Enable MEMCACHED_BEHAVIOR_CONNECT_TIMEOUT.
  34
  35 .. describe:: --DISTRIBUTION=
  36
  37 Set the distribution model used by the client.  See :manpage:`` for more details.
  38
  39 .. describe:: --HASH=
  40
  41 Set the hashing alogrthm used for placing keys on servers.
  42
  43 .. describe:: --HASH-WITH-PREFIX_KEY
  44
  45 .. describe:: --IO-BYTES-WATERMARK=
  46
  47 .. describe:: --IO-KEY-PREFETCH=
  48
  49 .. describe:: --IO-MSG-WATERMARK=
  50
  51 .. describe:: --NOREPLY
  52
  53 .. describe:: --NUMBER-OF-REPLICAS=
  54
  55 Set the nummber of servers that keys will be replicated to.
  56
  57 .. describe:: --POLL-TIMEOUT=
  58
  59 .. describe:: --RANDOMIZE-REPLICA-READ
  60
  61 Select randomly the server within the replication pool to read from.
  62
  63 .. describe:: --RCV-TIMEOUT=
  64
  65 .. describe:: --RETRY-TIMEOUT=
  66
  67 See :manpage:`memcached_behavior_set(3)` for MEMCACHED_BEHAVIOR_RETRY_TIMEOUT
  68
  69 .. describe:: --SERVER-FAILURE-LIMIT=
  70
  71 See :manpage:`memcached_behavior_set(3)` for MEMCACHED_BEHAVIOR_SERVER_FAILURE_LIMIT
  72
  73 .. describe:: --SND-TIMEOUT=
  74
  75 See :manpage:`memcached_behavior_set(3)` for MEMCACHED_BEHAVIOR_SND_TIMEOUT
  76
  77 .. describe:: --SOCKET-RECV-SIZE=
  78
  79 See :manpage:`memcached_behavior_set(3)` for MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE
  80
  81 .. describe:: --SOCKET-SEND-SIZE=
  82
  83 See :manpage:`memcached_behavior_set(3)` for MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE
  84
  85 .. describe:: --SORT-HOSTS
  86
  87 When adding new servers always calculate their distribution based on sorted naming order.
  88
  89 .. describe:: --SUPPORT-CAS
  90
  91 See :manpage:`memcached_behavior_set(3)` for MEMCACHED_BEHAVIOR_SUPPORT_CAS
  92
  93 .. describe:: --TCP-NODELAY
  94
  95 See :manpage:`memcached_behavior_set(3)` for MEMCACHED_BEHAVIOR_TCP_NODELAY
  96
  97 .. describe:: --TCP-KEEPALIVE
  98
  99 See :manpage:`memcached_behavior_set(3)` for MEMCACHED_BEHAVIOR_TCP_KEEPALIVE
 100
 101 .. describe:: --TCP-KEEPIDLE
 102
 103 .. describe:: --USE-UDP
 104
 105 See :manpage:`memcached_behavior_set(3)` for MEMCACHED_BEHAVIOR_USE_UDP
 106
 107 .. describe:: --PREFIX-KEY=
 108
 109 .. describe:: INCLUDE
 110
 111 Include a file in configuration. Unlike --CONFIGURE-FILE= this will not reset memcached_st
 112
 113 .. describe:: RESET
 114
 115 Reset memcached_st and continue to process.
 116
 117 .. describe:: END
 118
 119 End configutation processing.
 120
 121 .. describe:: ERROR
 122
 123 End configutation processing and throw an error.