From: tierno <alfonso.tiernosepulveda@telefonica.com>
Date: Tue, 27 Nov 2018 11:03:36 +0000 (+0100)
Subject: Adding more parameters to db_set for array edition
X-Git-Tag: v5.0.2
X-Git-Url: https://osm.etsi.org/gitweb/?a=commitdiff_plain;h=refs%2Ftags%2Fv5.0.2;hp=c837a7819c5388b276ada7f29a085cd251119e4b;p=osm%2Fcommon.git

Adding more parameters to db_set for array edition

Change-Id: Ic57f8a8b9780cc1becd206b227f7bed10ad30f4a
Signed-off-by: tierno <alfonso.tiernosepulveda@telefonica.com>
---

diff --git a/osm_common/__init__.py b/osm_common/__init__.py
index 858586c..ecd9261 100644
--- a/osm_common/__init__.py
+++ b/osm_common/__init__.py
@@ -15,6 +15,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-version = '0.1.13'
+version = '0.1.14'
 # TODO add package version filling commit id with 0's; e.g.:  '5.0.0.post11+00000000.dirty-1'
-date_version = '2018-11-12'
+date_version = '2018-11-27'
diff --git a/osm_common/dbbase.py b/osm_common/dbbase.py
index b418079..d199dde 100644
--- a/osm_common/dbbase.py
+++ b/osm_common/dbbase.py
@@ -130,7 +130,7 @@ class DbBase(object):
         """
         raise DbException("Method 'create' not implemented")
 
-    def set_one(self, table, q_filter, update_dict, fail_on_empty=True):
+    def set_one(self, table, q_filter, update_dict, fail_on_empty=True, unset=None, pull=None, push=None):
         """
         Modifies an entry at database
         :param table: collection or table
@@ -138,6 +138,12 @@ class DbBase(object):
         :param update_dict: Plain dictionary with the content to be updated. It is a dot separated keys and a value
         :param fail_on_empty: If nothing matches filter it returns None unless this flag is set tu True, in which case
         it raises a DbException
+        :param unset: Plain dictionary with the content to be removed if exist. It is a dot separated keys, value is
+                      ignored. If not exist, it is ignored
+        :param pull: Plain dictionary with the content to be removed from an array. It is a dot separated keys and value
+                     if exist in the array is removed. If not exist, it is ignored
+        :param push: Plain dictionary with the content to be appended to an array. It is a dot separated keys and value
+                     is appended to the end of the array
         :return: Dict with the number of entries modified. None if no matching is found.
         """
         raise DbException("Method 'set_one' not implemented")
diff --git a/osm_common/dbmongo.py b/osm_common/dbmongo.py
index 57ce082..5334ef9 100644
--- a/osm_common/dbmongo.py
+++ b/osm_common/dbmongo.py
@@ -306,7 +306,7 @@ class DbMongo(DbBase):
         except Exception as e:  # TODO refine
             raise DbException(e)
 
-    def set_one(self, table, q_filter, update_dict, fail_on_empty=True):
+    def set_one(self, table, q_filter, update_dict, fail_on_empty=True, unset=None, pull=None, push=None):
         """
         Modifies an entry at database
         :param table: collection or table
@@ -314,12 +314,28 @@ class DbMongo(DbBase):
         :param update_dict: Plain dictionary with the content to be updated. It is a dot separated keys and a value
         :param fail_on_empty: If nothing matches filter it returns None unless this flag is set tu True, in which case
         it raises a DbException
+        :param unset: Plain dictionary with the content to be removed if exist. It is a dot separated keys, value is
+                      ignored. If not exist, it is ignored
+        :param pull: Plain dictionary with the content to be removed from an array. It is a dot separated keys and value
+                     if exist in the array is removed. If not exist, it is ignored
+        :param push: Plain dictionary with the content to be appended to an array. It is a dot separated keys and value
+                     is appended to the end of the array
         :return: Dict with the number of entries modified. None if no matching is found.
         """
         try:
+            db_oper = {}
+            if update_dict:
+                db_oper["$set"] = update_dict
+            if unset:
+                db_oper["$unset"] = unset
+            if pull:
+                db_oper["$pull"] = pull
+            if push:
+                db_oper["$push"] = push
+
             with self.lock:
                 collection = self.db[table]
-                rows = collection.update_one(self._format_filter(q_filter), {"$set": update_dict})
+                rows = collection.update_one(self._format_filter(q_filter), db_oper)
             if rows.matched_count == 0:
                 if fail_on_empty:
                     raise DbException("Not found any {} with filter='{}'".format(table[:-1], q_filter),