docs-xml/manpages/dbwrap_tool.1.xml

   1 <?xml version="1.0" encoding="iso-8859-1"?>
   2 <!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
   3 <refentry id="dbwrap_tool.1">
   4
   5 <refmeta>
   6         <refentrytitle>dbwrap_tool</refentrytitle>
   7         <manvolnum>1</manvolnum>
   8         <refmiscinfo class="source">Samba</refmiscinfo>
   9         <refmiscinfo class="manual">System Administration tools</refmiscinfo>
  10         <refmiscinfo class="version">4.1</refmiscinfo>
  11 </refmeta>
  12
  13
  14 <refnamediv>
  15         <refname>dbwrap_tool</refname>
  16         <refpurpose>low level TDB/CTDB manipulation tool using the dbwrap interface</refpurpose>
  17 </refnamediv>
  18
  19 <refsynopsisdiv>
  20         <cmdsynopsis>
  21                 <command>dbwrap_tool</command>
  22                 <arg choice="opt">--persistent</arg>
  23                 <arg choice="opt">--non-persistent</arg>
  24                 <arg choice="opt">-d &lt;debug level&gt;</arg>
  25                 <arg choice="opt">-s &lt;config file&gt;</arg>
  26                 <arg choice="opt">-l &lt;log file base&gt;</arg>
  27                 <arg choice="opt">-V</arg>
  28                 <arg choice="opt">--option=&lt;name&gt;=&lt;value&gt;</arg>
  29                 <arg choice="req">&lt;database&gt;</arg>
  30                 <arg choice="req">&lt;operation&gt;</arg>
  31                 <arg choice="opt">&lt;key&gt;
  32                         <arg choice="opt">&lt;type&gt;
  33                                 <arg choice="opt">&lt;value&gt;</arg></arg></arg>
  34         </cmdsynopsis>
  35 </refsynopsisdiv>
  36
  37 <refsect1>
  38         <title>DESCRIPTION</title>
  39
  40         <para>This tool is part of the <citerefentry><refentrytitle>samba</refentrytitle>
  41         <manvolnum>7</manvolnum></citerefentry> suite.</para>
  42
  43         <para>The dbwrap_tool program is used to read and manipulate
  44         TDB/CTDB databases using the dbwrap interface.</para>
  45
  46         <para>The following database operations are available:
  47         <itemizedlist>
  48                 <listitem><para>fetch: fetch a record</para></listitem>
  49                 <listitem><para>store: create or modify a record</para></listitem>
  50                 <listitem><para>delete: remove a record</para></listitem>
  51                 <listitem><para>exists: test for existence of a record</para></listitem>
  52                 <listitem><para>erase: remove all records</para></listitem>
  53                 <listitem><para>listkeys: list all available records</para></listitem>
  54                 <listitem><para>listwatchers: list processes, which are waiting for changes in a record</para></listitem>
  55         </itemizedlist>
  56         </para>
  57         <para>The following types are available:
  58         <itemizedlist>
  59                 <listitem><para>int32: signed 32bit integer</para></listitem>
  60                 <listitem><para>uint32: unsigned 32bit integer</para></listitem>
  61                 <listitem><para>string: "hello world"</para></listitem>
  62                 <listitem><para>hex: hex strings like "68656C6C6F20776F726C6400" ("hello world")</para></listitem>
  63         </itemizedlist>
  64         </para>
  65 </refsect1>
  66
  67 <refsect1>
  68         <title>OPTIONS</title>
  69
  70         <variablelist>
  71                 <varlistentry>
  72                         <term>--persistent</term>
  73                         <listitem><para>Open the database as a persistent database.
  74                         </para>
  75                         <para>
  76                         Exactly one of --persistent and --non-persistent must be
  77                         specified.
  78                         </para></listitem>
  79                 </varlistentry>
  80                 <varlistentry>
  81                         <term>--non-persistent</term>
  82                         <listitem><para>Open the database as a non-persistent database.
  83                         </para>
  84                         <para>
  85                         Caveat: opening a database as non-persistent when there
  86                         is currently no other opener will wipe the database.
  87                         </para>
  88                         <para>
  89                         Exactly one of --persistent and --non-persistent must be
  90                         specified.
  91                         </para></listitem>
  92                 </varlistentry>
  93                 &popt.common.samba.client;
  94                 &popt.autohelp;
  95         </variablelist>
  96 </refsect1>
  97
  98 <refsect1>
  99         <title>COMMANDS</title>
 100         <refsect2>
 101                 <title>fetch</title>
 102                 <cmdsynopsis>
 103                         <command>dbwrap_tool</command> &lt;database&gt; fetch &lt;key&gt; &lt;type&gt;
 104                 </cmdsynopsis>
 105         </refsect2>
 106         <refsect2>
 107                 <title>store</title>
 108                 <cmdsynopsis>
 109                         <command>dbwrap_tool</command> &lt;database&gt; store &lt;key&gt; &lt;type&gt; &lt;value&gt;
 110                 </cmdsynopsis>
 111         </refsect2>
 112         <refsect2>
 113                 <title>delete</title>
 114                 <cmdsynopsis>
 115                         <command>dbwrap_tool</command> &lt;database&gt; delete &lt;key&gt;
 116                 </cmdsynopsis>
 117         </refsect2>
 118         <refsect2>
 119                 <title>exists</title>
 120                 <cmdsynopsis>
 121                         <command>dbwrap_tool</command> &lt;database&gt; exists &lt;key&gt;
 122                 </cmdsynopsis>
 123         </refsect2>
 124         <refsect2>
 125                 <title>erase</title>
 126                 <cmdsynopsis>
 127                         <command>dbwrap_tool</command> &lt;database&gt; erase </cmdsynopsis>
 128         </refsect2>
 129         <refsect2>
 130                 <title>listkeys</title>
 131                 <cmdsynopsis>
 132                         <command>dbwrap_tool</command> &lt;database&gt; listkeys
 133                 </cmdsynopsis>
 134         </refsect2>
 135         <refsect2>
 136                 <title>listwatchers</title>
 137                 <cmdsynopsis>
 138                         <command>dbwrap_tool</command> &lt;database&gt; listwatchers
 139                 </cmdsynopsis>
 140         </refsect2>
 141 </refsect1>
 142
 143 <refsect1>
 144         <title>EXAMPLES</title>
 145         <variablelist>
 146                 <varlistentry><term>List all keys from winbindd_idmap.tdb</term>
 147                         <listitem><para><command>dbwrap_tool</command> --persistent winbindd_idmap.tdb listkeys</para></listitem>
 148                 </varlistentry>
 149                 <varlistentry><term>Fetch record with key "USER HWM" as uint32</term>
 150                         <listitem><para><command>dbwrap_tool</command> --persistent winbindd_idmap.tdb fetch "USER HWM" uint32</para></listitem>
 151                 </varlistentry>
 152                 <varlistentry><term>Remove record with key "USER HWM"</term>
 153                         <listitem><para><command>dbwrap_tool</command> --persistent winbindd_idmap.tdb remove "USER HWM"</para></listitem>
 154                 </varlistentry>
 155                 <varlistentry><term>Store and overwrite record "USER HWM" with value 214</term>
 156                         <listitem><para>uint32: <command>dbwrap_tool</command> --persistent winbindd_idmap.tdb store "USER HWM" uint32 214</para></listitem>
 157                         <listitem><para>hex: <command>dbwrap_tool</command> --persistent winbindd_idmap.tdb store "USER HWM" hex D6000000</para></listitem>
 158                 </varlistentry>
 159         </variablelist>
 160 </refsect1>
 161
 162 <refsect1>
 163         <title>NOTES</title>
 164
 165         <para>Use with caution!</para>
 166 </refsect1>
 167
 168
 169 <refsect1>
 170         <title>VERSION</title>
 171
 172         <para>This man page is correct for version 3 of the Samba suite.</para>
 173 </refsect1>
 174
 175 <refsect1>
 176         <title>SEE ALSO</title>
 177         <para><citerefentry><refentrytitle>smbd</refentrytitle>
 178         <manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>samba</refentrytitle>
 179         <manvolnum>7</manvolnum></citerefentry></para>
 180 </refsect1>
 181
 182 <refsect1>
 183         <title>AUTHOR</title>
 184
 185         <para>The original Samba software and related utilities
 186         were created by Andrew Tridgell. Samba is now developed
 187         by the Samba Team as an Open Source project similar
 188         to the way the Linux kernel is developed.</para>
 189
 190         <para>The dbwrap_tool manpage was written by Bjoern Baumbach.</para>
 191 </refsect1>
 192
 193 </refentry>