docs-xml/manpages/dbwrap_tool.1.xml


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160

<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
<refentry id="dbwrap_tool.1">

<refmeta>
	<refentrytitle>dbwrap_tool</refentrytitle>
	<manvolnum>1</manvolnum>
	<refmiscinfo class="source">Samba</refmiscinfo>
	<refmiscinfo class="manual">System Administration tools</refmiscinfo>
	<refmiscinfo class="version">4.0</refmiscinfo>
</refmeta>


<refnamediv>
	<refname>dbwrap_tool</refname>
	<refpurpose>low level TDB/CTDB manipulation tool using the dbwrap interface</refpurpose>
</refnamediv>

<refsynopsisdiv>
	<cmdsynopsis>
		<command>dbwrap_tool</command>
		<arg choice="req">&lt;database&gt;</arg>
		<arg choice="req">&lt;operation&gt;</arg>
		<arg choice="opt">&lt;key&gt;
			<arg choice="opt">&lt;type&gt;
				<arg choice="opt">&lt;value&gt;</arg>
			</arg>
		</arg>
	</cmdsynopsis>
</refsynopsisdiv>

<refsect1>
	<title>DESCRIPTION</title>

	<para>This tool is part of the <citerefentry><refentrytitle>samba</refentrytitle>
	<manvolnum>7</manvolnum></citerefentry> suite.</para>

	<para>The dbwrap_tool program is used to read and manipulate
	TDB/CTDB databases using the dbwrap interface.</para>

	<para>The following database operations are available:
	<itemizedlist>
		<listitem><para>fetch: fetch a record</para></listitem>
		<listitem><para>store: create or modify a record</para></listitem>
		<listitem><para>delete: remove a record</para></listitem>
		<listitem><para>erase: remove all records</para></listitem>
		<listitem><para>listkeys: list all available records</para></listitem>
		<listitem><para>listwatchers: list processes, which are waiting for changes in a record</para></listitem>
	</itemizedlist>
	</para>
	<para>The following types are available:
	<itemizedlist>
		<listitem><para>int32: signed 32bit integer</para></listitem>
		<listitem><para>uint32: unsigned 32bit integer</para></listitem>
		<listitem><para>string: "hello world"</para></listitem>
		<listitem><para>hex: hex strings like "68656C6C6F20776F726C6400" ("hello world")</para></listitem>
	</itemizedlist>
	</para>
</refsect1>

<refsect1>
	<title>OPTIONS</title>

	<para>None.</para>
	<!--
	<variablelist>
	</variablelist>
	-->
</refsect1>

<refsect1>
	<title>COMMANDS</title>
	<refsect2>
		<title>fetch</title>
		<cmdsynopsis>
			<command>dbwrap_tool</command> &lt;database&gt; fetch &lt;key&gt; &lt;type&gt;
		</cmdsynopsis>
	</refsect2>
	<refsect2>
		<title>store</title>
		<cmdsynopsis>
			<command>dbwrap_tool</command> &lt;database&gt; store &lt;key&gt; &lt;type&gt; &lt;value&gt;
		</cmdsynopsis>
	</refsect2>
	<refsect2>
		<title>delete</title>
		<cmdsynopsis>
			<command>dbwrap_tool</command> &lt;database&gt; delete &lt;key&gt;
		</cmdsynopsis>
	</refsect2>
	<refsect2>
		<title>erase</title>
		<cmdsynopsis>
			<command>dbwrap_tool</command> &lt;database&gt; erase </cmdsynopsis>
	</refsect2>
	<refsect2>
		<title>listkeys</title>
		<cmdsynopsis>
			<command>dbwrap_tool</command> &lt;database&gt; listkeys
		</cmdsynopsis>
	</refsect2>
	<refsect2>
		<title>listwatchers</title>
		<cmdsynopsis>
			<command>dbwrap_tool</command> &lt;database&gt; listwatchers
		</cmdsynopsis>
	</refsect2>
</refsect1>

<refsect1>
	<title>EXAMPLES</title>
	<variablelist>
		<varlistentry><term>List all keys from winbindd_idmap.tdb</term>
			<listitem><para><command>dbwrap_tool</command> winbindd_idmap.tdb listkeys</para></listitem>
		</varlistentry>
		<varlistentry><term>Fetch record with key "USER HWM" as uint32</term>
			<listitem><para><command>dbwrap_tool</command> winbindd_idmap.tdb fetch "USER HWM" uint32</para></listitem>
		</varlistentry>
		<varlistentry><term>Remove record with key "USER HWM"</term>
			<listitem><para><command>dbwrap_tool</command> winbindd_idmap.tdb remove "USER HWM"</para></listitem>
		</varlistentry>
		<varlistentry><term>Store and overwrite record "USER HWM" with value 214</term>
			<listitem><para>uint32: <command>dbwrap_tool</command> winbindd_idmap.tdb store "USER HWM" uint32 214</para></listitem>
			<listitem><para>hex: <command>dbwrap_tool</command> winbindd_idmap.tdb store "USER HWM" hex D6000000</para></listitem>
		</varlistentry>
	</variablelist>
</refsect1>

<refsect1>
	<title>NOTES</title>

	<para>Use with caution!</para>
</refsect1>


<refsect1>
	<title>VERSION</title>

	<para>This man page is correct for version 3 of the Samba suite.</para>
</refsect1>

<refsect1>
	<title>SEE ALSO</title>
	<para><citerefentry><refentrytitle>smbd</refentrytitle>
	<manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>samba</refentrytitle>
	<manvolnum>7</manvolnum></citerefentry></para>
</refsect1>

<refsect1>
	<title>AUTHOR</title>

	<para>The original Samba software and related utilities
	were created by Andrew Tridgell. Samba is now developed
	by the Samba Team as an Open Source project similar
	to the way the Linux kernel is developed.</para>

	<para>The dbwrap_tool manpage was written by Bjoern Baumbach.</para>
</refsect1>

</refentry>