X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=ovsdb%2Fovsdb-tool.1.in;h=3c2a37c294d1f50f965d653b89cfd4c3b0fc0dbe;hb=c84933bf9a73e334207b6b309749d9e9c3b04812;hp=c2c2ce32d7452d9ca0cafb58ef004bc5e2953890;hpb=a0bc29a541fc7dc6e20137d5558e2094d614e6ab;p=sliver-openvswitch.git diff --git a/ovsdb/ovsdb-tool.1.in b/ovsdb/ovsdb-tool.1.in index c2c2ce32d..3c2a37c29 100644 --- a/ovsdb/ovsdb-tool.1.in +++ b/ovsdb/ovsdb-tool.1.in @@ -14,11 +14,26 @@ ovsdb\-tool \- Open vSwitch database management utility .SH SYNOPSIS \fBovsdb\-tool \fR[\fIoptions\fR] \fBcreate\fI db schema\fR .br +\fBovsdb\-tool \fR[\fIoptions\fR] \fBcompact \fIdb \fR[\fItarget\fR] +.br +\fBovsdb\-tool \fR[\fIoptions\fR] \fBconvert\fI db schema +\fR[\fItarget\fR] +.br +\fBovsdb\-tool \fR[\fIoptions\fR] \fBneeds\-conversion\fI db schema\fR +.br +\fBovsdb\-tool \fR[\fIoptions\fR] \fBdb\-version\fI db\fR +.br +\fBovsdb\-tool \fR[\fIoptions\fR] \fBschema\-version\fI schema\fR +.br +\fBovsdb\-tool \fR[\fIoptions\fR] \fBdb\-cksum\fI db\fR +.br +\fBovsdb\-tool \fR[\fIoptions\fR] \fBschema\-cksum\fI schema\fR +.br \fBovsdb\-tool \fR[\fIoptions\fR] \fBquery\fI db transaction\fR .br \fBovsdb\-tool \fR[\fIoptions\fR] \fBtransact\fI db transaction\fR .br -\fBovsdb\-tool \fR[\fIoptions\fR] [\fB-m\fR | \fB--more\fR]... \fBshow\-log\fI db\fR +\fBovsdb\-tool \fR[\fIoptions\fR] [\fB\-m\fR | \fB\-\-more\fR]... \fBshow\-log\fI db\fR .br \fBovsdb\-tool help\fR .so lib/vlog-syn.man @@ -63,6 +78,34 @@ ignored. Columns that exist in \fIschema\fR but not in \fIdb\fR are set to their default values. All of \fIschema\fR's constraints apply in full. . +.IP "\fBneeds\-conversion\fI db schema\fR" +Reads the schema embedded in \fIdb\fR and the standalone schema in +\fIschema\fR and compares them. If the schemas are the same, prints +\fBno\fR on stdout; if they differ, print \fByes\fR. +. +.IP "\fBdb\-version\fI db\fR" +.IQ "\fBschema\-version\fI schema\fR" +Prints the version number in the schema embedded within the database +\fIdb\fR or in the standalone schema \fIschema\fR on stdout. A schema +version number has the form \fIx\fB.\fIy\fB.\fIz\fR. See +\fBovs\-vswitchd.conf.db\fR(5) for details. +.IP +Schema version numbers and Open vSwitch version numbers are +independent. +.IP +If \fIschema\fR or \fIdb\fR was created before schema versioning was +introduced, then it will not have a version number and this command +will print a blank line. +. +.IP "\fBdb\-cksum\fI db\fR" +.IQ "\fBschema\-cksum\fI schema\fR" +Prints the checksum in the schema embedded within the database +\fIdb\fR or of the standalone schema \fIschema\fR on stdout. +.IP +If \fIschema\fR or \fIdb\fR was created before schema checksums were +introduced, then it will not have a checksum and this command +will print a blank line. +. .IP "\fBquery\fI db transaction\fR" Opens \fIdb\fR, executes \fItransaction\fR on it, and prints the results. The \fItransaction\fR must be a JSON array in the format of @@ -71,7 +114,7 @@ described in the OVSDB specification. .IP The \fIdb\fR is opened for read-only access, so this command may safely run concurrently with other database activity, including -\fBovsdb-server\fR and other database writers. The \fItransaction\fR +\fBovsdb\-server\fR and other database writers. The \fItransaction\fR may specify database modifications, but these will have no effect on \fIdb\fR. . @@ -83,19 +126,19 @@ JSON array in the format of the \fBparams\fR array for the JSON-RPC .IP The \fIdb\fR is opened and locked for read/write access, so this command will fail if the database is opened for writing by any other -process, including \fBovsdb-server\fR(1). Use \fBovsdb\-client\fR(1), +process, including \fBovsdb\-server\fR(1). Use \fBovsdb\-client\fR(1), instead, to write to a database that is served by -\fBovsdb-server\fR(1). +\fBovsdb\-server\fR(1). . -.IP "\fBshow-log\fI db\fR" +.IP "\fBshow\-log\fI db\fR" Prints a summary of the records in \fBdb\fR's log, including the time and date at which each database change occurred and any associated comment. This may be useful for debugging. .PP -To increase the verbosity of output, add \fB-m\fR (or \fB--more\fR) -one or more times to the command line. With one \fB-m\fR, +To increase the verbosity of output, add \fB\-m\fR (or \fB\-\-more\fR) +one or more times to the command line. With one \fB\-m\fR, \fBshow\-log\fR prints a summary of the records added, deleted, or -modified by each transaction. With two \fB-m\fRs, \fBshow\-log\fR +modified by each transaction. With two \fB\-m\fRs, \fBshow\-log\fR also prints the values of the columns modified by each change to a record. .