X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=ovsdb%2FSPECS;h=4020241e54e44a17a7b5eb9922724bce784304f8;hb=f1193301162788fadc0f6faa1af9441f93a623d8;hp=ff4015c2749e8c8ddef5230d3d083630afece96d;hpb=ae8f13e29057e233712356b3c03f02a7ef4e1e93;p=openvswitch diff --git a/ovsdb/SPECS b/ovsdb/SPECS index ff4015c2..4020241e 100644 --- a/ovsdb/SPECS +++ b/ovsdb/SPECS @@ -33,10 +33,14 @@ values. Additional notation is presented later. A JSON number with an integer value, within a certain range (currently -2**63...+2**63-1). - + Any JSON value. + + + Any JSON value except null. + A JSON object with the following members: @@ -88,10 +92,11 @@ is represented by , as described below. "comment": optional "tables": {: , ...} required - The "name" identifies the database as a whole. The "comment" - optionally provides more information about the database. The - value of "tables" is a JSON object whose names are table names and - whose values are s. + The "name" identifies the database as a whole. It must be + provided to most JSON-RPC requests to identify the database being + operated on. The "comment" optionally provides more information + about the database. The value of "tables" is a JSON object whose + names are table names and whose values are s. @@ -242,14 +247,33 @@ over HTTP, for these reasons: The database wire protocol consists of the following JSON-RPC methods: +list_dbs +........ + +Request object members: + + "method": "list_dbs" required + "params": [] required + "id": required + +Response object members: + + "result": [, ...] + "error": null + "id": same "id" as request + +This operation retrieves an array whose elements are s +that name the databases that can be accessed over this JSON-RPC +connection. + get_schema .......... Request object members: "method": "get_schema" required - "params": [] required - "id": any JSON value except null required + "params": [] required + "id": required Response object members: @@ -257,17 +281,17 @@ Response object members: "error": null "id": same "id" as request -This operation retrieves a that describes the -hosted database. +This operation retrieves a that describes hosted +database . transact ........ Request object members: - "method": "transact" required - "params": [*] required - "id": any JSON value except null required + "method": "transact" required + "params": [, *] required + "id": required Response object members: @@ -275,9 +299,11 @@ Response object members: "error": null "id": same "id" as request -The "params" array for this method consists of zero or more JSON -objects, each of which represents a single database operation. The -"Operations" section below describes the valid operations. +The "params" array for this method consists of a that +identifies the database to which the transaction applies, followed by +zero or more JSON objects, each of which represents a single database +operation. The "Operations" section below describes the valid +operations. The value of "id" must be unique among all in-flight transactions within the current JSON-RPC session. Otherwise, the server may return @@ -373,9 +399,9 @@ monitor Request object members: - "method": "monitor" required - "params": [, ] required - "id": any JSON value except null required + "method": "monitor" required + "params": [, , ] required + "id": required is an object that maps from a table name to a . @@ -399,13 +425,13 @@ Response object members: "id": same "id" as request This JSON-RPC request enables a client to replicate tables or subsets -of tables. Each specifies a table to be replicated. -The JSON-RPC response to the "monitor" includes the initial contents -of each table. Afterward, when changes to those tables are committed, -the changes are automatically sent to the client using the "update" -monitor notification. This monitoring persists until the JSON-RPC -session terminates or until the client sends a "monitor_cancel" -JSON-RPC request. +of tables within database . Each specifies +a table to be replicated. The JSON-RPC response to the "monitor" +includes the initial contents of each table. Afterward, when changes +to those tables are committed, the changes are automatically sent to +the client using the "update" monitor notification. This monitoring +persists until the JSON-RPC session terminates or until the client +sends a "monitor_cancel" JSON-RPC request. Each describes how to monitor a table: @@ -439,11 +465,11 @@ update Notification object members: "method": "update" - "params": [, ] + "params": [, ] "id": null -The in "params" is the same as the value passed as the -in "params" for the "monitor" request. +The in "params" is the same as the value passed as the + in "params" for the "monitor" request. is an object that maps from a table name to a . @@ -482,8 +508,8 @@ monitor_cancel Request object members: "method": "monitor_cancel" required - "params": [] required - "id": any JSON value except null required + "params": [] required + "id": required Response object members: @@ -491,10 +517,10 @@ Response object members: "error": null "id": the request "id" member -Cancels the ongoing table monitor request, identified by the -in "params" matching the in "params" for an ongoing "monitor" -request. No more "update" messages will be sent for this table -monitor. +Cancels the ongoing table monitor request, identified by the + in "params" matching the in "params" for an +ongoing "monitor" request. No more "update" messages will be sent for +this table monitor. echo .... @@ -503,7 +529,7 @@ Request object members: "method": "echo" required "params": JSON array with any contents required - "id": required + "id": required Response object members: @@ -521,6 +547,12 @@ there or vice versa. Notation for the Wire Protocol ------------------------------ + + + An that names a database. The valid s can be + obtained using a "list-db" request. The is taken from + the "name" member of . + An that names a table.