2 * Copyright (c) 2009, 2010, 2011, 2012, 2013 Nicira, Inc.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
28 #include "command-line.h"
33 #include "dynamic-string.h"
36 #include "lib/table.h"
38 #include "ovsdb-data.h"
39 #include "ovsdb-error.h"
43 #include "stream-ssl.h"
49 VLOG_DEFINE_THIS_MODULE(ovsdb_client
);
52 NEED_NONE
, /* No JSON-RPC connection or database name needed. */
53 NEED_RPC
, /* JSON-RPC connection needed. */
54 NEED_DATABASE
/* JSON-RPC connection and database name needed. */
57 struct ovsdb_client_command
{
59 enum args_needed need
;
62 void (*handler
)(struct jsonrpc
*rpc
, const char *database
,
63 int argc
, char *argv
[]);
66 /* --timestamp: Print a timestamp before each update on "monitor" command? */
67 static bool timestamp
;
69 /* Format for table output. */
70 static struct table_style table_style
= TABLE_STYLE_DEFAULT
;
72 static const struct ovsdb_client_command all_commands
[];
74 static void usage(void) NO_RETURN
;
75 static void parse_options(int argc
, char *argv
[]);
76 static struct jsonrpc
*open_jsonrpc(const char *server
);
77 static void fetch_dbs(struct jsonrpc
*, struct svec
*dbs
);
80 main(int argc
, char *argv
[])
82 const struct ovsdb_client_command
*command
;
86 proctitle_init(argc
, argv
);
87 set_program_name(argv
[0]);
88 parse_options(argc
, argv
);
89 signal(SIGPIPE
, SIG_IGN
);
92 ovs_fatal(0, "missing command name; use --help for help");
95 for (command
= all_commands
; ; command
++) {
97 VLOG_FATAL("unknown command '%s'; use --help for help",
99 } else if (!strcmp(command
->name
, argv
[optind
])) {
105 if (command
->need
!= NEED_NONE
) {
106 if (argc
- optind
> command
->min_args
107 && (isalpha((unsigned char) argv
[optind
][0])
108 && strchr(argv
[optind
], ':'))) {
109 rpc
= open_jsonrpc(argv
[optind
++]);
111 char *sock
= xasprintf("unix:%s/db.sock", ovs_rundir());
112 rpc
= open_jsonrpc(sock
);
119 if (command
->need
== NEED_DATABASE
) {
123 fetch_dbs(rpc
, &dbs
);
124 if (argc
- optind
> command
->min_args
125 && svec_contains(&dbs
, argv
[optind
])) {
126 database
= argv
[optind
++];
127 } else if (dbs
.n
== 1) {
128 database
= xstrdup(dbs
.names
[0]);
129 } else if (svec_contains(&dbs
, "Open_vSwitch")) {
130 database
= "Open_vSwitch";
132 ovs_fatal(0, "no default database for `%s' command, please "
133 "specify a database name", command
->name
);
140 if (argc
- optind
< command
->min_args
||
141 argc
- optind
> command
->max_args
) {
142 VLOG_FATAL("invalid syntax for '%s' (use --help for help)",
146 command
->handler(rpc
, database
, argc
- optind
, argv
+ optind
);
150 if (ferror(stdout
)) {
151 VLOG_FATAL("write to stdout failed");
153 if (ferror(stderr
)) {
154 VLOG_FATAL("write to stderr failed");
161 parse_options(int argc
, char *argv
[])
164 OPT_BOOTSTRAP_CA_CERT
= UCHAR_MAX
+ 1,
169 static const struct option long_options
[] = {
170 {"verbose", optional_argument
, NULL
, 'v'},
171 {"help", no_argument
, NULL
, 'h'},
172 {"version", no_argument
, NULL
, 'V'},
173 {"timestamp", no_argument
, NULL
, OPT_TIMESTAMP
},
176 {"bootstrap-ca-cert", required_argument
, NULL
, OPT_BOOTSTRAP_CA_CERT
},
177 STREAM_SSL_LONG_OPTIONS
,
182 char *short_options
= long_options_to_short_options(long_options
);
187 c
= getopt_long(argc
, argv
, short_options
, long_options
, NULL
);
197 ovs_print_version(0, 0);
201 vlog_set_verbosity(optarg
);
204 DAEMON_OPTION_HANDLERS
206 TABLE_OPTION_HANDLERS(&table_style
)
208 STREAM_SSL_OPTION_HANDLERS
210 case OPT_BOOTSTRAP_CA_CERT
:
211 stream_ssl_set_ca_cert_file(optarg
, true);
222 /* getopt_long() already set the value for us. */
235 printf("%s: Open vSwitch database JSON-RPC client\n"
236 "usage: %s [OPTIONS] COMMAND [ARG...]\n"
237 "\nValid commands are:\n"
238 "\n list-dbs [SERVER]\n"
239 " list databases available on SERVER\n"
240 "\n get-schema [SERVER] [DATABASE]\n"
241 " retrieve schema for DATABASE from SERVER\n"
242 "\n get-schema-version [SERVER] [DATABASE]\n"
243 " retrieve schema for DATABASE from SERVER and report only its\n"
244 " version number on stdout\n"
245 "\n list-tables [SERVER] [DATABASE]\n"
246 " list tables for DATABASE on SERVER\n"
247 "\n list-columns [SERVER] [DATABASE] [TABLE]\n"
248 " list columns in TABLE (or all tables) in DATABASE on SERVER\n"
249 "\n transact [SERVER] TRANSACTION\n"
250 " run TRANSACTION (a JSON array of operations) on SERVER\n"
251 " and print the results as JSON on stdout\n"
252 "\n monitor [SERVER] [DATABASE] TABLE [COLUMN,...]...\n"
253 " monitor contents of COLUMNs in TABLE in DATABASE on SERVER.\n"
254 " COLUMNs may include !initial, !insert, !delete, !modify\n"
255 " to avoid seeing the specified kinds of changes.\n"
256 "\n dump [SERVER] [DATABASE]\n"
257 " dump contents of DATABASE on SERVER to stdout\n"
258 "\nThe default SERVER is unix:%s/db.sock.\n"
259 "The default DATABASE is Open_vSwitch.\n",
260 program_name
, program_name
, ovs_rundir());
261 stream_usage("SERVER", true, true, true);
262 printf("\nOutput formatting options:\n"
263 " -f, --format=FORMAT set output formatting to FORMAT\n"
264 " (\"table\", \"html\", \"csv\", "
266 " --no-headings omit table heading row\n"
267 " --pretty pretty-print JSON in output\n"
268 " --timestamp timestamp \"monitor\" output");
271 printf("\nOther options:\n"
272 " -h, --help display this help message\n"
273 " -V, --version display version information\n");
278 check_txn(int error
, struct jsonrpc_msg
**reply_
)
280 struct jsonrpc_msg
*reply
= *reply_
;
283 ovs_fatal(error
, "transaction failed");
287 ovs_fatal(error
, "transaction returned error: %s",
288 json_to_string(reply
->error
, table_style
.json_flags
));
293 parse_json(const char *s
)
295 struct json
*json
= json_from_string(s
);
296 if (json
->type
== JSON_STRING
) {
297 ovs_fatal(0, "\"%s\": %s", s
, json
->u
.string
);
302 static struct jsonrpc
*
303 open_jsonrpc(const char *server
)
305 struct stream
*stream
;
308 error
= stream_open_block(jsonrpc_stream_open(server
, &stream
,
309 DSCP_DEFAULT
), &stream
);
310 if (error
== EAFNOSUPPORT
) {
311 struct pstream
*pstream
;
313 error
= jsonrpc_pstream_open(server
, &pstream
, DSCP_DEFAULT
);
315 ovs_fatal(error
, "failed to connect or listen to \"%s\"", server
);
318 VLOG_INFO("%s: waiting for connection...", server
);
319 error
= pstream_accept_block(pstream
, &stream
);
321 ovs_fatal(error
, "failed to accept connection on \"%s\"", server
);
324 pstream_close(pstream
);
326 ovs_fatal(error
, "failed to connect to \"%s\"", server
);
329 return jsonrpc_open(stream
);
333 print_json(struct json
*json
)
335 char *string
= json_to_string(json
, table_style
.json_flags
);
336 fputs(string
, stdout
);
341 print_and_free_json(struct json
*json
)
348 check_ovsdb_error(struct ovsdb_error
*error
)
351 ovs_fatal(0, "%s", ovsdb_error_to_string(error
));
355 static struct ovsdb_schema
*
356 fetch_schema(struct jsonrpc
*rpc
, const char *database
)
358 struct jsonrpc_msg
*request
, *reply
;
359 struct ovsdb_schema
*schema
;
361 request
= jsonrpc_create_request("get_schema",
363 json_string_create(database
)),
365 check_txn(jsonrpc_transact_block(rpc
, request
, &reply
), &reply
);
366 check_ovsdb_error(ovsdb_schema_from_json(reply
->result
, &schema
));
367 jsonrpc_msg_destroy(reply
);
373 fetch_dbs(struct jsonrpc
*rpc
, struct svec
*dbs
)
375 struct jsonrpc_msg
*request
, *reply
;
378 request
= jsonrpc_create_request("list_dbs", json_array_create_empty(),
381 check_txn(jsonrpc_transact_block(rpc
, request
, &reply
), &reply
);
382 if (reply
->result
->type
!= JSON_ARRAY
) {
383 ovs_fatal(0, "list_dbs response is not array");
386 for (i
= 0; i
< reply
->result
->u
.array
.n
; i
++) {
387 const struct json
*name
= reply
->result
->u
.array
.elems
[i
];
389 if (name
->type
!= JSON_STRING
) {
390 ovs_fatal(0, "list_dbs response %zu is not string", i
);
392 svec_add(dbs
, name
->u
.string
);
394 jsonrpc_msg_destroy(reply
);
399 do_list_dbs(struct jsonrpc
*rpc
, const char *database OVS_UNUSED
,
400 int argc OVS_UNUSED
, char *argv
[] OVS_UNUSED
)
407 fetch_dbs(rpc
, &dbs
);
408 SVEC_FOR_EACH (i
, db_name
, &dbs
) {
415 do_get_schema(struct jsonrpc
*rpc
, const char *database
,
416 int argc OVS_UNUSED
, char *argv
[] OVS_UNUSED
)
418 struct ovsdb_schema
*schema
= fetch_schema(rpc
, database
);
419 print_and_free_json(ovsdb_schema_to_json(schema
));
420 ovsdb_schema_destroy(schema
);
424 do_get_schema_version(struct jsonrpc
*rpc
, const char *database
,
425 int argc OVS_UNUSED
, char *argv
[] OVS_UNUSED
)
427 struct ovsdb_schema
*schema
= fetch_schema(rpc
, database
);
428 puts(schema
->version
);
429 ovsdb_schema_destroy(schema
);
433 do_list_tables(struct jsonrpc
*rpc
, const char *database
,
434 int argc OVS_UNUSED
, char *argv
[] OVS_UNUSED
)
436 struct ovsdb_schema
*schema
;
437 struct shash_node
*node
;
440 schema
= fetch_schema(rpc
, database
);
442 table_add_column(&t
, "Table");
443 SHASH_FOR_EACH (node
, &schema
->tables
) {
444 struct ovsdb_table_schema
*ts
= node
->data
;
447 table_add_cell(&t
)->text
= xstrdup(ts
->name
);
449 ovsdb_schema_destroy(schema
);
450 table_print(&t
, &table_style
);
454 do_list_columns(struct jsonrpc
*rpc
, const char *database
,
455 int argc OVS_UNUSED
, char *argv
[])
457 const char *table_name
= argv
[0];
458 struct ovsdb_schema
*schema
;
459 struct shash_node
*table_node
;
462 schema
= fetch_schema(rpc
, database
);
465 table_add_column(&t
, "Table");
467 table_add_column(&t
, "Column");
468 table_add_column(&t
, "Type");
469 SHASH_FOR_EACH (table_node
, &schema
->tables
) {
470 struct ovsdb_table_schema
*ts
= table_node
->data
;
472 if (!table_name
|| !strcmp(table_name
, ts
->name
)) {
473 struct shash_node
*column_node
;
475 SHASH_FOR_EACH (column_node
, &ts
->columns
) {
476 const struct ovsdb_column
*column
= column_node
->data
;
480 table_add_cell(&t
)->text
= xstrdup(ts
->name
);
482 table_add_cell(&t
)->text
= xstrdup(column
->name
);
483 table_add_cell(&t
)->json
= ovsdb_type_to_json(&column
->type
);
487 ovsdb_schema_destroy(schema
);
488 table_print(&t
, &table_style
);
492 do_transact(struct jsonrpc
*rpc
, const char *database OVS_UNUSED
,
493 int argc OVS_UNUSED
, char *argv
[])
495 struct jsonrpc_msg
*request
, *reply
;
496 struct json
*transaction
;
498 transaction
= parse_json(argv
[0]);
500 request
= jsonrpc_create_request("transact", transaction
, NULL
);
501 check_txn(jsonrpc_transact_block(rpc
, request
, &reply
), &reply
);
502 print_json(reply
->result
);
504 jsonrpc_msg_destroy(reply
);
508 monitor_print_row(struct json
*row
, const char *type
, const char *uuid
,
509 const struct ovsdb_column_set
*columns
, struct table
*t
)
514 ovs_error(0, "missing %s row", type
);
516 } else if (row
->type
!= JSON_OBJECT
) {
517 ovs_error(0, "<row> is not object");
522 table_add_cell(t
)->text
= xstrdup(uuid
);
523 table_add_cell(t
)->text
= xstrdup(type
);
524 for (i
= 0; i
< columns
->n_columns
; i
++) {
525 const struct ovsdb_column
*column
= columns
->columns
[i
];
526 struct json
*value
= shash_find_data(json_object(row
), column
->name
);
527 struct cell
*cell
= table_add_cell(t
);
529 cell
->json
= json_clone(value
);
530 cell
->type
= &column
->type
;
536 monitor_print(struct json
*table_updates
,
537 const struct ovsdb_table_schema
*table
,
538 const struct ovsdb_column_set
*columns
, bool initial
)
540 struct json
*table_update
;
541 struct shash_node
*node
;
546 table_set_timestamp(&t
, timestamp
);
548 if (table_updates
->type
!= JSON_OBJECT
) {
549 ovs_error(0, "<table-updates> is not object");
552 table_update
= shash_find_data(json_object(table_updates
), table
->name
);
556 if (table_update
->type
!= JSON_OBJECT
) {
557 ovs_error(0, "<table-update> is not object");
561 table_add_column(&t
, "row");
562 table_add_column(&t
, "action");
563 for (i
= 0; i
< columns
->n_columns
; i
++) {
564 table_add_column(&t
, "%s", columns
->columns
[i
]->name
);
566 SHASH_FOR_EACH (node
, json_object(table_update
)) {
567 struct json
*row_update
= node
->data
;
568 struct json
*old
, *new;
570 if (row_update
->type
!= JSON_OBJECT
) {
571 ovs_error(0, "<row-update> is not object");
574 old
= shash_find_data(json_object(row_update
), "old");
575 new = shash_find_data(json_object(row_update
), "new");
577 monitor_print_row(new, "initial", node
->name
, columns
, &t
);
579 monitor_print_row(new, "insert", node
->name
, columns
, &t
);
581 monitor_print_row(old
, "delete", node
->name
, columns
, &t
);
583 monitor_print_row(old
, "old", node
->name
, columns
, &t
);
584 monitor_print_row(new, "new", "", columns
, &t
);
587 table_print(&t
, &table_style
);
592 add_column(const char *server
, const struct ovsdb_column
*column
,
593 struct ovsdb_column_set
*columns
, struct json
*columns_json
)
595 if (ovsdb_column_set_contains(columns
, column
->index
)) {
596 ovs_fatal(0, "%s: column \"%s\" mentioned multiple times",
597 server
, column
->name
);
599 ovsdb_column_set_add(columns
, column
);
600 json_array_add(columns_json
, json_string_create(column
->name
));
604 parse_monitor_columns(char *arg
, const char *server
, const char *database
,
605 const struct ovsdb_table_schema
*table
,
606 struct ovsdb_column_set
*columns
)
608 bool initial
, insert
, delete, modify
;
609 struct json
*mr
, *columns_json
;
610 char *save_ptr
= NULL
;
613 mr
= json_object_create();
614 columns_json
= json_array_create_empty();
615 json_object_put(mr
, "columns", columns_json
);
617 initial
= insert
= delete = modify
= true;
618 for (token
= strtok_r(arg
, ",", &save_ptr
); token
!= NULL
;
619 token
= strtok_r(NULL
, ",", &save_ptr
)) {
620 if (!strcmp(token
, "!initial")) {
622 } else if (!strcmp(token
, "!insert")) {
624 } else if (!strcmp(token
, "!delete")) {
626 } else if (!strcmp(token
, "!modify")) {
629 const struct ovsdb_column
*column
;
631 column
= ovsdb_table_schema_get_column(table
, token
);
633 ovs_fatal(0, "%s: table \"%s\" in %s does not have a "
634 "column named \"%s\"",
635 server
, table
->name
, database
, token
);
637 add_column(server
, column
, columns
, columns_json
);
641 if (columns_json
->u
.array
.n
== 0) {
642 const struct shash_node
**nodes
;
645 n
= shash_count(&table
->columns
);
646 nodes
= shash_sort(&table
->columns
);
647 for (i
= 0; i
< n
; i
++) {
648 const struct ovsdb_column
*column
= nodes
[i
]->data
;
649 if (column
->index
!= OVSDB_COL_UUID
650 && column
->index
!= OVSDB_COL_VERSION
) {
651 add_column(server
, column
, columns
, columns_json
);
656 add_column(server
, ovsdb_table_schema_get_column(table
,"_version"),
657 columns
, columns_json
);
660 if (!initial
|| !insert
|| !delete || !modify
) {
661 struct json
*select
= json_object_create();
662 json_object_put(select
, "initial", json_boolean_create(initial
));
663 json_object_put(select
, "insert", json_boolean_create(insert
));
664 json_object_put(select
, "delete", json_boolean_create(delete));
665 json_object_put(select
, "modify", json_boolean_create(modify
));
666 json_object_put(mr
, "select", select
);
673 do_monitor(struct jsonrpc
*rpc
, const char *database
,
674 int argc
, char *argv
[])
676 const char *server
= jsonrpc_get_name(rpc
);
677 const char *table_name
= argv
[0];
678 struct ovsdb_column_set columns
= OVSDB_COLUMN_SET_INITIALIZER
;
679 struct ovsdb_table_schema
*table
;
680 struct ovsdb_schema
*schema
;
681 struct jsonrpc_msg
*request
;
682 struct json
*monitor
, *monitor_request_array
,
683 *monitor_requests
, *request_id
;
685 schema
= fetch_schema(rpc
, database
);
686 table
= shash_find_data(&schema
->tables
, table_name
);
688 ovs_fatal(0, "%s: %s does not have a table named \"%s\"",
689 server
, database
, table_name
);
692 monitor_request_array
= json_array_create_empty();
696 for (i
= 1; i
< argc
; i
++) {
698 monitor_request_array
,
699 parse_monitor_columns(argv
[i
], server
, database
, table
,
703 /* Allocate a writable empty string since parse_monitor_columns() is
704 * going to strtok() it and that's risky with literal "". */
707 monitor_request_array
,
708 parse_monitor_columns(empty
, server
, database
, table
, &columns
));
711 monitor_requests
= json_object_create();
712 json_object_put(monitor_requests
, table_name
, monitor_request_array
);
714 monitor
= json_array_create_3(json_string_create(database
),
715 json_null_create(), monitor_requests
);
716 request
= jsonrpc_create_request("monitor", monitor
, NULL
);
717 request_id
= json_clone(request
->id
);
718 jsonrpc_send(rpc
, request
);
720 struct jsonrpc_msg
*msg
;
723 error
= jsonrpc_recv_block(rpc
, &msg
);
725 ovsdb_schema_destroy(schema
);
726 ovs_fatal(error
, "%s: receive failed", server
);
729 if (msg
->type
== JSONRPC_REQUEST
&& !strcmp(msg
->method
, "echo")) {
730 jsonrpc_send(rpc
, jsonrpc_create_reply(json_clone(msg
->params
),
732 } else if (msg
->type
== JSONRPC_REPLY
733 && json_equal(msg
->id
, request_id
)) {
734 monitor_print(msg
->result
, table
, &columns
, true);
737 daemon_save_fd(STDOUT_FILENO
);
740 } else if (msg
->type
== JSONRPC_NOTIFY
741 && !strcmp(msg
->method
, "update")) {
742 struct json
*params
= msg
->params
;
743 if (params
->type
== JSON_ARRAY
744 && params
->u
.array
.n
== 2
745 && params
->u
.array
.elems
[0]->type
== JSON_NULL
) {
746 monitor_print(params
->u
.array
.elems
[1],
747 table
, &columns
, false);
751 jsonrpc_msg_destroy(msg
);
755 struct dump_table_aux
{
756 struct ovsdb_datum
**data
;
757 const struct ovsdb_column
**columns
;
762 compare_data(size_t a_y
, size_t b_y
, size_t x
,
763 const struct dump_table_aux
*aux
)
765 return ovsdb_datum_compare_3way(&aux
->data
[a_y
][x
],
767 &aux
->columns
[x
]->type
);
771 compare_rows(size_t a_y
, size_t b_y
, void *aux_
)
773 struct dump_table_aux
*aux
= aux_
;
776 /* Skip UUID columns on the first pass, since their values tend to be
777 * random and make our results less reproducible. */
778 for (x
= 0; x
< aux
->n_columns
; x
++) {
779 if (aux
->columns
[x
]->type
.key
.type
!= OVSDB_TYPE_UUID
) {
780 int cmp
= compare_data(a_y
, b_y
, x
, aux
);
787 /* Use UUID columns as tie-breakers. */
788 for (x
= 0; x
< aux
->n_columns
; x
++) {
789 if (aux
->columns
[x
]->type
.key
.type
== OVSDB_TYPE_UUID
) {
790 int cmp
= compare_data(a_y
, b_y
, x
, aux
);
801 swap_rows(size_t a_y
, size_t b_y
, void *aux_
)
803 struct dump_table_aux
*aux
= aux_
;
804 struct ovsdb_datum
*tmp
= aux
->data
[a_y
];
805 aux
->data
[a_y
] = aux
->data
[b_y
];
806 aux
->data
[b_y
] = tmp
;
810 compare_columns(const void *a_
, const void *b_
)
812 const struct ovsdb_column
*const *ap
= a_
;
813 const struct ovsdb_column
*const *bp
= b_
;
814 const struct ovsdb_column
*a
= *ap
;
815 const struct ovsdb_column
*b
= *bp
;
817 return strcmp(a
->name
, b
->name
);
821 dump_table(const struct ovsdb_table_schema
*ts
, struct json_array
*rows
)
823 const struct ovsdb_column
**columns
;
826 struct ovsdb_datum
**data
;
828 struct dump_table_aux aux
;
829 struct shash_node
*node
;
833 /* Sort columns by name, for reproducibility. */
834 columns
= xmalloc(shash_count(&ts
->columns
) * sizeof *columns
);
836 SHASH_FOR_EACH (node
, &ts
->columns
) {
837 struct ovsdb_column
*column
= node
->data
;
838 if (strcmp(column
->name
, "_version")) {
839 columns
[n_columns
++] = column
;
842 qsort(columns
, n_columns
, sizeof *columns
, compare_columns
);
844 /* Extract data from table. */
845 data
= xmalloc(rows
->n
* sizeof *data
);
846 for (y
= 0; y
< rows
->n
; y
++) {
849 if (rows
->elems
[y
]->type
!= JSON_OBJECT
) {
850 ovs_fatal(0, "row %zu in table %s response is not a JSON object: "
851 "%s", y
, ts
->name
, json_to_string(rows
->elems
[y
], 0));
853 row
= json_object(rows
->elems
[y
]);
855 data
[y
] = xmalloc(n_columns
* sizeof **data
);
856 for (x
= 0; x
< n_columns
; x
++) {
857 const struct json
*json
= shash_find_data(row
, columns
[x
]->name
);
859 ovs_fatal(0, "row %zu in table %s response lacks %s column",
860 y
, ts
->name
, columns
[x
]->name
);
863 check_ovsdb_error(ovsdb_datum_from_json(&data
[y
][x
],
869 /* Sort rows by column values, for reproducibility. */
871 aux
.columns
= columns
;
872 aux
.n_columns
= n_columns
;
873 sort(rows
->n
, compare_rows
, swap_rows
, &aux
);
875 /* Add column headings. */
877 table_set_caption(&t
, xasprintf("%s table", ts
->name
));
878 for (x
= 0; x
< n_columns
; x
++) {
879 table_add_column(&t
, "%s", columns
[x
]->name
);
883 for (y
= 0; y
< rows
->n
; y
++) {
885 for (x
= 0; x
< n_columns
; x
++) {
886 struct cell
*cell
= table_add_cell(&t
);
887 cell
->json
= ovsdb_datum_to_json(&data
[y
][x
], &columns
[x
]->type
);
888 cell
->type
= &columns
[x
]->type
;
889 ovsdb_datum_destroy(&data
[y
][x
], &columns
[x
]->type
);
893 table_print(&t
, &table_style
);
901 do_dump(struct jsonrpc
*rpc
, const char *database
,
902 int argc OVS_UNUSED
, char *argv
[] OVS_UNUSED
)
904 struct jsonrpc_msg
*request
, *reply
;
905 struct ovsdb_schema
*schema
;
906 struct json
*transaction
;
908 const struct shash_node
**tables
;
913 schema
= fetch_schema(rpc
, database
);
914 tables
= shash_sort(&schema
->tables
);
915 n_tables
= shash_count(&schema
->tables
);
917 /* Construct transaction to retrieve entire database. */
918 transaction
= json_array_create_1(json_string_create(database
));
919 for (i
= 0; i
< n_tables
; i
++) {
920 const struct ovsdb_table_schema
*ts
= tables
[i
]->data
;
921 struct json
*op
, *columns
;
922 struct shash_node
*node
;
924 columns
= json_array_create_empty();
925 SHASH_FOR_EACH (node
, &ts
->columns
) {
926 const struct ovsdb_column
*column
= node
->data
;
928 if (strcmp(column
->name
, "_version")) {
929 json_array_add(columns
, json_string_create(column
->name
));
933 op
= json_object_create();
934 json_object_put_string(op
, "op", "select");
935 json_object_put_string(op
, "table", tables
[i
]->name
);
936 json_object_put(op
, "where", json_array_create_empty());
937 json_object_put(op
, "columns", columns
);
938 json_array_add(transaction
, op
);
941 /* Send request, get reply. */
942 request
= jsonrpc_create_request("transact", transaction
, NULL
);
943 check_txn(jsonrpc_transact_block(rpc
, request
, &reply
), &reply
);
945 /* Print database contents. */
946 if (reply
->result
->type
!= JSON_ARRAY
947 || reply
->result
->u
.array
.n
!= n_tables
) {
948 ovs_fatal(0, "reply is not array of %zu elements: %s",
949 n_tables
, json_to_string(reply
->result
, 0));
951 for (i
= 0; i
< n_tables
; i
++) {
952 const struct ovsdb_table_schema
*ts
= tables
[i
]->data
;
953 const struct json
*op_result
= reply
->result
->u
.array
.elems
[i
];
956 if (op_result
->type
!= JSON_OBJECT
957 || !(rows
= shash_find_data(json_object(op_result
), "rows"))
958 || rows
->type
!= JSON_ARRAY
) {
959 ovs_fatal(0, "%s table reply is not an object with a \"rows\" "
961 ts
->name
, json_to_string(op_result
, 0));
964 dump_table(ts
, &rows
->u
.array
);
967 jsonrpc_msg_destroy(reply
);
969 ovsdb_schema_destroy(schema
);
973 do_help(struct jsonrpc
*rpc OVS_UNUSED
, const char *database OVS_UNUSED
,
974 int argc OVS_UNUSED
, char *argv
[] OVS_UNUSED
)
979 /* All command handlers (except for "help") are expected to take an optional
980 * server socket name (e.g. "unix:...") as their first argument. The socket
981 * name argument must be included in max_args (but left out of min_args). The
982 * command name and socket name are not included in the arguments passed to the
983 * handler: the argv[0] passed to the handler is the first argument after the
984 * optional server socket name. The connection to the server is available as
985 * global variable 'rpc'. */
986 static const struct ovsdb_client_command all_commands
[] = {
987 { "list-dbs", NEED_RPC
, 0, 0, do_list_dbs
},
988 { "get-schema", NEED_DATABASE
, 0, 0, do_get_schema
},
989 { "get-schema-version", NEED_DATABASE
, 0, 0, do_get_schema_version
},
990 { "list-tables", NEED_DATABASE
, 0, 0, do_list_tables
},
991 { "list-columns", NEED_DATABASE
, 0, 1, do_list_columns
},
992 { "transact", NEED_RPC
, 1, 1, do_transact
},
993 { "monitor", NEED_DATABASE
, 1, INT_MAX
, do_monitor
},
994 { "dump", NEED_DATABASE
, 0, 0, do_dump
},
996 { "help", NEED_NONE
, 0, INT_MAX
, do_help
},
998 { NULL
, 0, 0, 0, NULL
},