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