ovsdb: Document the "mutable" feature for columns.

[sliver-openvswitch.git] / ovsdb / SPECS

diff --git a/ovsdb/SPECS b/ovsdb/SPECS
index d9c92de..260786e 100644 (file)
--- a/ovsdb/SPECS
+++ b/ovsdb/SPECS
@@ -149,11 +149,14 @@ is represented by <database-schema>, as described below.
 
         "type": <type>                            required
         "ephemeral": <boolean>                    optional
 
         "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
 
     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>
 
 
 <type>