ovsdb: Document the "mutable" feature for columns.
authorBen Pfaff <blp@nicira.com>
Fri, 22 Oct 2010 16:58:12 +0000 (09:58 -0700)
committerBen Pfaff <blp@nicira.com>
Fri, 22 Oct 2010 21:48:08 +0000 (14:48 -0700)
This feature has been implemented in OVSDB since the beginning, but until
now it was undocumented.

ovsdb/SPECS

index d9c92dead942ae7aded4f09f7bd160689471c168..260786edb9bbd37d935344b26864531b90cf9cd9 100644 (file)
@@ -149,11 +149,14 @@ is represented by <database-schema>, as described below.
 
         "type": <type>                            required
         "ephemeral": <boolean>                    optional
+        "mutable": <boolean>                      optional
 
     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.
+    restarts.  If "mutable" is specified as false, then this column's
+    values may not be modified after they are initially set with the
+    "insert" operation.
 
 <type>