source: vendor/current/docs/manpages/dbwrap_tool.1@ 989

Last change on this file since 989 was 989, checked in by Silvan Scherrer, 9 years ago

Samba Server: update vendor to version 4.4.7
File size: 5.0 KB
Line 
1'\" t
2.\" Title: dbwrap_tool
3.\" Author: [see the "AUTHOR" section]
4.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
5.\" Date: 10/25/2016
6.\" Manual: System Administration tools
7.\" Source: Samba 4.4
8.\" Language: English
9.\"
10.TH "DBWRAP_TOOL" "1" "10/25/2016" "Samba 4\&.4" "System Administration tools"
11.\" -----------------------------------------------------------------
12.\" * Define some portability stuff
13.\" -----------------------------------------------------------------
14.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15.\" http://bugs.debian.org/507673
16.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18.ie \n(.g .ds Aq \(aq
19.el .ds Aq '
20.\" -----------------------------------------------------------------
21.\" * set default formatting
22.\" -----------------------------------------------------------------
23.\" disable hyphenation
24.nh
25.\" disable justification (adjust text to left margin only)
26.ad l
27.\" -----------------------------------------------------------------
28.\" * MAIN CONTENT STARTS HERE *
29.\" -----------------------------------------------------------------
30.SH "NAME"
31dbwrap_tool \- low level TDB/CTDB manipulation tool using the dbwrap interface
32.SH "SYNOPSIS"
33.HP \w'\ 'u
34dbwrap_tool [\-\-persistent] [\-\-non\-persistent] [\-d\ <debug\ level>] [\-s\ <config\ file>] [\-l\ <log\ file\ base>] [\-V] [\-\-option=<name>=<value>] {<database>} {<operation>} [<key>\ [<type>\ [<value>]]]
35.SH "DESCRIPTION"
36.PP
37This tool is part of the
38\fBsamba\fR(7)
39suite\&.
40.PP
41The dbwrap_tool program is used to read and manipulate TDB/CTDB databases using the dbwrap interface\&.
42.PP
43The following database operations are available:
44.sp
45.RS 4
46.ie n \{\
47\h'-04'\(bu\h'+03'\c
48.\}
49.el \{\
50.sp -1
51.IP \(bu 2.3
52.\}
53fetch: fetch a record
54.RE
55.sp
56.RS 4
57.ie n \{\
58\h'-04'\(bu\h'+03'\c
59.\}
60.el \{\
61.sp -1
62.IP \(bu 2.3
63.\}
64store: create or modify a record
65.RE
66.sp
67.RS 4
68.ie n \{\
69\h'-04'\(bu\h'+03'\c
70.\}
71.el \{\
72.sp -1
73.IP \(bu 2.3
74.\}
75delete: remove a record
76.RE
77.sp
78.RS 4
79.ie n \{\
80\h'-04'\(bu\h'+03'\c
81.\}
82.el \{\
83.sp -1
84.IP \(bu 2.3
85.\}
86exists: test for existence of a record
87.RE
88.sp
89.RS 4
90.ie n \{\
91\h'-04'\(bu\h'+03'\c
92.\}
93.el \{\
94.sp -1
95.IP \(bu 2.3
96.\}
97erase: remove all records
98.RE
99.sp
100.RS 4
101.ie n \{\
102\h'-04'\(bu\h'+03'\c
103.\}
104.el \{\
105.sp -1
106.IP \(bu 2.3
107.\}
108listkeys: list all available records
109.RE
110.sp
111.RS 4
112.ie n \{\
113\h'-04'\(bu\h'+03'\c
114.\}
115.el \{\
116.sp -1
117.IP \(bu 2.3
118.\}
119listwatchers: list processes, which are waiting for changes in a record
120.RE
121.sp
122.RE
123.PP
124The following types are available:
125.sp
126.RS 4
127.ie n \{\
128\h'-04'\(bu\h'+03'\c
129.\}
130.el \{\
131.sp -1
132.IP \(bu 2.3
133.\}
134int32: signed 32bit integer
135.RE
136.sp
137.RS 4
138.ie n \{\
139\h'-04'\(bu\h'+03'\c
140.\}
141.el \{\
142.sp -1
143.IP \(bu 2.3
144.\}
145uint32: unsigned 32bit integer
146.RE
147.sp
148.RS 4
149.ie n \{\
150\h'-04'\(bu\h'+03'\c
151.\}
152.el \{\
153.sp -1
154.IP \(bu 2.3
155.\}
156string: "hello world"
157.RE
158.sp
159.RS 4
160.ie n \{\
161\h'-04'\(bu\h'+03'\c
162.\}
163.el \{\
164.sp -1
165.IP \(bu 2.3
166.\}
167hex: hex strings like "68656C6C6F20776F726C6400" ("hello world")
168.RE
169.sp
170.RE
171.SH "OPTIONS"
172.PP
173\-\-persistent
174.RS 4
175Open the database as a persistent database\&.
176.sp
177Exactly one of \-\-persistent and \-\-non\-persistent must be specified\&.
178.RE
179.PP
180\-\-non\-persistent
181.RS 4
182Open the database as a non\-persistent database\&.
183.sp
184Caveat: opening a database as non\-persistent when there is currently no other opener will wipe the database\&.
185.sp
186Exactly one of \-\-persistent and \-\-non\-persistent must be specified\&.
187.RE
188.SH "COMMANDS"
189.SS "fetch"
190.HP \w'\ 'u
191dbwrap_tool <database> fetch <key> <type>
192
193.SS "store"
194.HP \w'\ 'u
195dbwrap_tool <database> store <key> <type> <value>
196
197.SS "delete"
198.HP \w'\ 'u
199dbwrap_tool <database> delete <key>
200
201.SS "exists"
202.HP \w'\ 'u
203dbwrap_tool <database> exists <key>
204
205.SS "erase"
206.HP \w'\ 'u
207dbwrap_tool <database> erase
208.SS "listkeys"
209.HP \w'\ 'u
210dbwrap_tool <database> listkeys
211
212.SS "listwatchers"
213.HP \w'\ 'u
214dbwrap_tool <database> listwatchers
215
216.SH "EXAMPLES"
217.PP
218List all keys from winbindd_idmap\&.tdb
219.RS 4
220dbwrap_tool
221\-\-persistent winbindd_idmap\&.tdb listkeys
222.RE
223.PP
224Fetch record with key "USER HWM" as uint32
225.RS 4
226dbwrap_tool
227\-\-persistent winbindd_idmap\&.tdb fetch "USER HWM" uint32
228.RE
229.PP
230Remove record with key "USER HWM"
231.RS 4
232dbwrap_tool
233\-\-persistent winbindd_idmap\&.tdb remove "USER HWM"
234.RE
235.PP
236Store and overwrite record "USER HWM" with value 214
237.RS 4
238uint32:
239dbwrap_tool
240\-\-persistent winbindd_idmap\&.tdb store "USER HWM" uint32 214
241hex:
242dbwrap_tool
243\-\-persistent winbindd_idmap\&.tdb store "USER HWM" hex D6000000
244.RE
245.SH "NOTES"
246.PP
247Use with caution!
248.SH "VERSION"
249.PP
250This man page is correct for version 3 of the Samba suite\&.
251.SH "SEE ALSO"
252.PP
253\fBsmbd\fR(8),
254\fBsamba\fR(7)
255.SH "AUTHOR"
256.PP
257The 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\&.
258.PP
259The dbwrap_tool manpage was written by Bjoern Baumbach\&.
Note: See TracBrowser for help on using the repository browser.