ofproto: Fix byte order for OFP_VLAN_NONE to dl_vlan in struct flow.

[openvswitch] / ovsdb / SPECS

diff --git a/ovsdb/SPECS b/ovsdb/SPECS
index d2de137aab30421be9787be3552b7b0c906cf03d..cbd69defc3f62fc1b929815f1357ef9fb90f995f 100644 (file)
--- 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).
 
     A JSON number with an integer value, within a certain range
     (currently -2**63...+2**63-1).
 

-<value>
+<json-value>

 
     Any JSON value.
 
 
     Any JSON value.
 

+<nonnull-json-value>
+
+    Any JSON value except null.
+

 <error>
 
     A JSON object with the following members:
 <error>
 
     A JSON object with the following members:


@@ -85,25 +89,22 @@ is represented by <database-schema>, as described below.
     A JSON object with the following members:
 
         "name": <id>                            required
     A JSON object with the following members:
 
         "name": <id>                            required

-        "comment": <string>                     optional

         "tables": {<id>: <table-schema>, ...}   required
 
     The "name" identifies the database as a whole.  It must be
     provided to most JSON-RPC requests to identify the database being
         "tables": {<id>: <table-schema>, ...}   required
 
     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 <table-schema>s.
+    operated on.  The value of "tables" is a JSON object whose names
+    are table names and whose values are <table-schema>s.

 
 <table-schema>
 
     A JSON object with the following members:
 
 
 <table-schema>
 
     A JSON object with the following members:
 

-        "comment": <string>                       optional

         "columns": {<id>: <column-schema>, ...}   required
         "columns": {<id>: <column-schema>, ...}   required

+        "maxRows": <integer>                      optional

 
 

-    The "comment" optionally provides information about this table for
-    a human reader.  The value of "columns" is a JSON object whose
-    names are column names and whose values are <column-schema>s.
+    The value of "columns" is a JSON object whose names are column
+    names and whose values are <column-schema>s.

 
     Every table has the following columns whose definitions are not
     included in the schema:
 
     Every table has the following columns whose definitions are not
     included in the schema:


@@ -122,19 +123,24 @@ is represented by <database-schema>, as described below.
         the database process is stopped and then started again, each
         "_version" also changes to a new random value.
 
         the database process is stopped and then started again, each
         "_version" also changes to a new random value.
 

+    If "maxRows" is specified, as a positive integer, it limits the
+    maximum number of rows that may be present in the table.  This is
+    a "deferred" constraint, enforced only at transaction commit time
+    (see the "transact" request below).  If "maxRows" is not
+    specified, the size of the table is limited only by the resources
+    available to the database server.
+

 <column-schema>
 
     A JSON object with the following members:
 
 <column-schema>
 
     A JSON object with the following members:
 

-        "comment": <string>                       optional

         "type": <type>                            required
         "ephemeral": <boolean>                    optional
 
         "type": <type>                            required
         "ephemeral": <boolean>                    optional
 

-    The "comment" optionally provides information about this column
-    for a human reader.  The "type" specifies the type of data stored
-    in this column.  If "ephemeral" is specified as true, then this
-    column's values are not guaranteed to be durable; they may be lost
-    when the database restarts.
+    The "type" specifies the type of data stored in this column.  If
+    "ephemeral" is specified as true, then this column's values are
+    not guaranteed to be durable; they may be lost when the database
+    restarts.

 
 <type>
 
 
 <type>
 


@@ -169,19 +175,26 @@ is represented by <database-schema>, as described below.
     <atomic-type> or a JSON object with the following members:
 
         "type": <atomic-type>              required
     <atomic-type> or a JSON object with the following members:
 
         "type": <atomic-type>              required

+        "enum": <value>                    optional

         "minInteger": <integer>            optional, integers only
         "maxInteger": <integer>            optional, integers only
         "minReal": <real>                  optional, reals only
         "maxReal": <real>                  optional, reals only 
         "minInteger": <integer>            optional, integers only
         "maxInteger": <integer>            optional, integers only
         "minReal": <real>                  optional, reals only
         "maxReal": <real>                  optional, reals only 

-        "reMatch": <string>                optional, strings only
-        "reComment": <string>              optional, strings only

         "minLength": <integer>             optional, strings only
         "maxLength": <integer>             optional, strings only
         "refTable": <id>                   optional, uuids only
         "minLength": <integer>             optional, strings only
         "maxLength": <integer>             optional, strings only
         "refTable": <id>                   optional, uuids only

+        "refType": "strong" or "weak"      optional, only with "refTable"

 
     An <atomic-type> by itself is equivalent to a JSON object with a
     single member "type" whose value is the <atomic-type>.
 
 
     An <atomic-type> by itself is equivalent to a JSON object with a
     single member "type" whose value is the <atomic-type>.
 

+    "enum" may be specified as a <value> whose type is a set of one
+    or more values specified for the member "type".  If "enum" is
+    specified, then the valid values of the <base-type> are limited to
+    those in the <value>.
+
+    "enum" is mutually exclusive with the following constraints.
+

     If "type" is "integer", then "minInteger" or "maxInteger" or both
     may also be specified, restricting the valid integer range.  If
     both are specified, then the maxInteger must be greater than or
     If "type" is "integer", then "minInteger" or "maxInteger" or both
     may also be specified, restricting the valid integer range.  If
     both are specified, then the maxInteger must be greater than or


@@ -192,27 +205,24 @@ is represented by <database-schema>, as described below.
     specified, then the maxReal must be greater than or equal to
     minReal.
 
     specified, then the maxReal must be greater than or equal to
     minReal.
 

-    If "type" is "string", then:
+    If "type" is "string", then "minLength" and "maxLength" or both
+    may be specified, restricting the valid length of value strings.
+    If both are specified, then maxLength must be greater than or
+    equal to minLength.  String length is measured in characters (not
+    bytes or UTF-16 code units).

 
 

-        "reMatch" may be a JavaScript (Perl 5-like) regular expression
-        that restricts the allowed values.  The regular expression
-        must match the entire string value, that is, it is treated as
-        if it begins with ^ and ends with $, regardless of whether it
-        really does.
-
-        If "reMatch" is specified, then "reComment" may be a string
-        that describes the allowed values, phrased so that it fits
-        into a sentence such as "This value must be...".
+    If "type" is "uuid", then "refTable", if present, must be the name
+    of a table within this database.  If "refTable" is specified, then
+    "refType" may also be specified.  If "refTable" is set, the effect
+    depends on "refType":

 
 

-        "minLength" and "maxLength" or both may be specified,
-        restricting the valid length of value strings.  If both are
-        specified, then maxLength must be greater than or equal to
-        minLength.  String length is measured in characters (not bytes
-        or UTF-16 code units).
+        - If "refType" is "strong" or if "refType" is omitted, the
+          allowed UUIDs are limited to UUIDs for rows in the named
+          table.

 
 

-    If "type" is "uuid", then "refTable", if present, must be the name
-    of a table within this database.  If "refTable" is set, the
-    allowed UUIDs are limited to UUIDs for rows in the named table.
+        - If "refType" is "weak", then any UUIDs are allowed, but
+          UUIDs that do not correspond to rows in the named table will
+          be automatically deleted.

 
     "refTable" constraints are "deferred" constraints: they are
     enforced only at transaction commit time (see the "transact"
 
     "refTable" constraints are "deferred" constraints: they are
     enforced only at transaction commit time (see the "transact"


@@ -241,6 +251,8 @@ over HTTP, for these reasons:
 
     * The JSON-RPC specification for HTTP transport is incomplete.
 
 
     * The JSON-RPC specification for HTTP transport is incomplete.
 

+We are using TCP port 6632 for the database JSON-RPC connection.
+

 The database wire protocol consists of the following JSON-RPC methods:
 
 list_dbs
 The database wire protocol consists of the following JSON-RPC methods:
 
 list_dbs


@@ -250,7 +262,7 @@ Request object members:
 
     "method": "list_dbs"              required
     "params": []                      required
 
     "method": "list_dbs"              required
     "params": []                      required

-    "id": any JSON value except null  required
+    "id": <nonnull-json-value>        required

 
 Response object members:
 
 
 Response object members:
 


@@ -269,7 +281,7 @@ Request object members:
 
     "method": "get_schema"            required
     "params": [<db-name>]             required
 
     "method": "get_schema"            required
     "params": [<db-name>]             required

-    "id": any JSON value except null  required
+    "id": <nonnull-json-value>        required

 
 Response object members:
 
 
 Response object members:
 


@@ -287,7 +299,7 @@ Request object members:
 
     "method": "transact"                  required
     "params": [<db-name>, <operation>*]   required
 
     "method": "transact"                  required
     "params": [<db-name>, <operation>*]   required

-    "id": any JSON value except null      required
+    "id": <nonnull-json-value>            required

 
 Response object members:
 
 
 Response object members:
 


@@ -345,11 +357,25 @@ include at least the following:
 
         When the commit was attempted, a column's value referenced the
         UUID for a row that did not exist in the table named by the
 
         When the commit was attempted, a column's value referenced the
         UUID for a row that did not exist in the table named by the

-        column's <base-type> key or value "refTable".  (This can be
-        caused by inserting a row that references a nonexistent row,
-        by deleting a row that is still referenced by another row, by
-        specifying the UUID for a row in the wrong table, and other
-        ways.)
+        column's <base-type> key or value "refTable" that has a
+        "refType" of "strong".  (This can be caused by inserting a row
+        that references a nonexistent row, by deleting a row that is
+        still referenced by another row, by specifying the UUID for a
+        row in the wrong table, and other ways.)
+
+    "error": "constraint violation"
+
+        A column with a <base-type> key or value "refTable" whose
+        "refType" is "weak" became empty due to deletion(s) caused
+        because the rows that it referenced were deleted (or never
+        existed, if the column's row was inserted within the
+        transaction), and this column is not allowed to be empty
+        because its <type> has a "min" of 1.
+
+    "error": "constraint violation"
+
+        The number of rows in a table exceeds the maximum number
+        permitted by the table's "maxRows" value (see <table-schema>).

 
 If "params" contains one or more "wait" operations, then the
 transaction may take an arbitrary amount of time to complete.  The
 
 If "params" contains one or more "wait" operations, then the
 transaction may take an arbitrary amount of time to complete.  The


@@ -395,9 +421,9 @@ monitor
 
 Request object members:
 
 
 Request object members:
 

-    "method": "monitor"                                   required
-    "params": [<db-name>, <value>, <monitor-requests>]    required
-    "id": any JSON value except null                      required
+    "method": "monitor"                                       required
+    "params": [<db-name>, <json-value>, <monitor-requests>]   required
+    "id": <nonnull-json-value>                                required

 
 <monitor-requests> is an object that maps from a table name to a
 <monitor-request>.
 
 <monitor-requests> is an object that maps from a table name to a
 <monitor-request>.


@@ -461,11 +487,11 @@ update
 Notification object members:
 
     "method": "update"
 Notification object members:
 
     "method": "update"

-    "params": [<value>, <table-updates>]
+    "params": [<json-value>, <table-updates>]

     "id": null
 
     "id": null
 

-The <value> in "params" is the same as the value passed as the <value>
-in "params" for the "monitor" request.
+The <json-value> in "params" is the same as the value passed as the
+<json-value> in "params" for the "monitor" request.

 
 <table-updates> is an object that maps from a table name to a
 <table-update>.
 
 <table-updates> is an object that maps from a table name to a
 <table-update>.


@@ -504,8 +530,8 @@ monitor_cancel
 Request object members:
 
     "method": "monitor_cancel"                              required
 Request object members:
 
     "method": "monitor_cancel"                              required

-    "params": [<value>]                                     required
-    "id": any JSON value except null                        required
+    "params": [<json-value>]                                required
+    "id": <nonnull-json-value>                              required

 
 Response object members:
 
 
 Response object members:
 


@@ -513,10 +539,10 @@ Response object members:
     "error": null
     "id": the request "id" member
 
     "error": null
     "id": the request "id" member
 

-Cancels the ongoing table monitor request, identified by the <value>
-in "params" matching the <value> 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
+<json-value> in "params" matching the <json-value> in "params" for an
+ongoing "monitor" request.  No more "update" messages will be sent for
+this table monitor.

 
 echo
 ....
 
 echo
 ....


@@ -525,7 +551,7 @@ Request object members:
 
     "method": "echo"                                required
     "params": JSON array with any contents          required
 
     "method": "echo"                                required
     "params": JSON array with any contents          required

-    "id": <value>                                   required
+    "id": <json-value>                              required

 
 Response object members:
 
 
 Response object members: