]> granicus.if.org Git - pdns/commitdiff
dnsdist: Set CDB/LMDB KVS version to 1.4.0 as experimental
authorRemi Gacogne <remi.gacogne@powerdns.com>
Tue, 27 Aug 2019 08:49:48 +0000 (10:49 +0200)
committerRemi Gacogne <remi.gacogne@powerdns.com>
Tue, 27 Aug 2019 08:49:48 +0000 (10:49 +0200)
pdns/dnsdistdist/docs/reference/kvs.rst
pdns/dnsdistdist/docs/rules-actions.rst

index 6dc92aac0b610e373970dd6167c9095e9f6f4d97..48cfe061890421920bfef8334acf22e5dc149719 100644 (file)
@@ -3,6 +3,8 @@ Key Value Store functions and objects
 
 These are all the functions, objects and methods related to the CDB and LMDB key value stores.
 
+As of 1.4.0, the CDB and LMDB code is considered experimental.
+
 A lookup into a key value store can be done via the :func:`KeyValueStoreLookupRule` rule or
 the :func:`KeyValueStoreLookupAction` action, using the usual selectors to match the incoming
 queries for which the lookup should be done.
@@ -40,7 +42,7 @@ If the value found in the LMDB database for the key '\8powerdns\3com\0' was 'thi
 
 .. class:: KeyValueStore
 
-  .. versionadded:: 1.5.0
+  .. versionadded:: 1.4.0
 
   Represents a Key Value Store
 
@@ -64,12 +66,12 @@ If the value found in the LMDB database for the key '\8powerdns\3com\0' was 'thi
 
   .. method:: KeyValueStore:reload()
 
-    Reload the database if this is supported by the underlying store. As of 1.5.0, only CDB stores can be reloaded, and this method is a no-op for LMDB stores.
+    Reload the database if this is supported by the underlying store. As of 1.4.0, only CDB stores can be reloaded, and this method is a no-op for LMDB stores.
 
 
 .. function:: KeyValueLookupKeyQName([wireFormat]) -> KeyValueLookupKey
 
-  .. versionadded:: 1.5.0
+  .. versionadded:: 1.4.0
 
   Return a new KeyValueLookupKey object that, when passed to :func:`KeyValueStoreLookupAction` or :func:`KeyValueStoreLookupRule`, will return the qname of the query in DNS wire format.
 
@@ -77,13 +79,13 @@ If the value found in the LMDB database for the key '\8powerdns\3com\0' was 'thi
 
 .. function:: KeyValueLookupKeySourceIP() -> KeyValueLookupKey
 
-  .. versionadded:: 1.5.0
+  .. versionadded:: 1.4.0
 
   Return a new KeyValueLookupKey object that, when passed to :func:`KeyValueStoreLookupAction` or :func:`KeyValueStoreLookupRule`, will return the source IP of the client in network byte-order.
 
 .. function:: KeyValueLookupKeySuffix([minLabels [, wireFormat]]) -> KeyValueLookupKey
 
-  .. versionadded:: 1.5.0
+  .. versionadded:: 1.4.0
 
   Return a new KeyValueLookupKey object that, when passed to :func:`KeyValueStoreLookupAction` or :func:`KeyValueStoreLookupRule`, will return a vector of keys based on the labels of the qname in DNS wire format or plain text.
   For example if the qname is sub.domain.powerdns.com. the following keys will be returned:
@@ -105,13 +107,13 @@ If the value found in the LMDB database for the key '\8powerdns\3com\0' was 'thi
 
 .. function:: KeyValueLookupKeyTag() -> KeyValueLookupKey
 
-  .. versionadded:: 1.5.0
+  .. versionadded:: 1.4.0
 
   Return a new KeyValueLookupKey object that, when passed to :func:`KeyValueStoreLookupAction`, will return the value of the corresponding tag for this query, if it exists.
 
 .. function:: newCDBKVStore(filename, refreshDelay) -> KeyValueStore
 
-  .. versionadded:: 1.5.0
+  .. versionadded:: 1.4.0
 
   Return a new KeyValueStore object associated to the corresponding CDB database. The modification time
   of the CDB file will be checked every 'refrehDelay' second and the database re-opened if needed.
@@ -121,7 +123,7 @@ If the value found in the LMDB database for the key '\8powerdns\3com\0' was 'thi
 
 .. function:: newLMDBKVStore(filename, dbName) -> KeyValueStore
 
-  .. versionadded:: 1.5.0
+  .. versionadded:: 1.4.0
 
   Return a new KeyValueStore object associated to the corresponding LMDB database. The database must have been created
   with the ``MDB_NOSUBDIR`` flag.
index c1e7519d18808a27dd50fc2e2bb669d05fc689f3..14453177e170863901477623f73091bf5055abc2 100644 (file)
@@ -598,7 +598,9 @@ These ``DNSRule``\ s be one of the following items:
   :param str path: The exact HTTP path to match on
 
 .. function:: KeyValueStoreLookupRule(kvs, lookupKey)
-  .. versionadded:: 1.5.0
+  .. versionadded:: 1.4.0
+
+  As of 1.4.0, this code is considered experimental.
 
   Return true if the key returned by 'lookupKey' exists in the key value store referenced by 'kvs'.
   The store can be a CDB (:func:`newCDBKVStore`) or a LMDB database (:func:`newLMDBKVStore`).
@@ -970,7 +972,9 @@ The following actions exist.
 
 .. function:: KeyValueStoreLookupAction(kvs, lookupKey, destinationTag)
 
-  .. versionadded:: 1.5.0
+  .. versionadded:: 1.4.0
+
+  As of 1.4.0, this code is considered experimental.
 
   Does a lookup into the key value store referenced by 'kvs' using the key returned by 'lookupKey',
   and storing the result if any into the tag named 'destinationTag'.