Add alter_retention_policy method to the client.

geodimm · geodimm · commit e683a1c933b2 · 2015-05-04T17:19:58.000+01:00
diff --git a/influxdb/client.py b/influxdb/client.py
@@ -470,6 +470,43 @@ def create_retention_policy(self, name, duration, replication,
 
         self.query(query_string)
 
+    def alter_retention_policy(self, name, database=None,
+                               duration=None, replication=None, default=None):
+        """Mofidy an existing retention policy for a database.
+
+        :param name: the name of the retention policy to modify
+        :type name: str
+        :param database: the database for which the retention policy is
+            modified. Defaults to current client's database
+        :type database: str
+        :param duration: the new duration of the existing retention policy.
+            Durations such as 1h, 90m, 12h, 7d, and 4w, are all supported
+            and mean 1 hour, 90 minutes, 12 hours, 7 day, and 4 weeks,
+            respectively. For infinite retention – meaning the data will
+            never be deleted – use 'INF' for duration.
+            The minimum retention period is 1 hour.
+        :type duration: str
+        :param replication: the new replication of the existing
+            retention policy
+        :type replication: str
+        :param default: whether or not to set the modified policy as default
+        :type default: bool
+
+        .. note:: at least one of duration, replication, or default flag
+            should be set. Otherwise the operation will fail.
+        """
+        query_string = (
+            "ALTER RETENTION POLICY {} ON {}"
+        ).format(name, database or self._database)
+        if duration:
+            query_string += " DURATION {}".format(duration)
+        if replication:
+            query_string += " REPLICATION {}".format(replication)
+        if default is True:
+            query_string += " DEFAULT"
+
+        self.query(query_string)
+
     def get_list_retention_policies(self, database=None):
         """Get the list of retention policies for a database.
 
diff --git a/tests/influxdb/client_test.py b/tests/influxdb/client_test.py
@@ -490,6 +490,44 @@ def test_create_retention_policy(self):
                 'db duration 1d replication 4'
             )
 
+    def test_alter_retention_policy(self):
+        example_response = '{"results":[{}]}'
+
+        with requests_mock.Mocker() as m:
+            m.register_uri(
+                requests_mock.GET,
+                "http://localhost:8086/query",
+                text=example_response
+            )
+            # Test alter duration
+            self.cli.alter_retention_policy('somename', 'db',
+                                            duration='4d')
+            self.assertEqual(
+                m.last_request.qs['q'][0],
+                'alter retention policy somename on db duration 4d'
+            )
+            # Test alter replication
+            self.cli.alter_retention_policy('somename', 'db',
+                                            replication=4)
+            self.assertEqual(
+                m.last_request.qs['q'][0],
+                'alter retention policy somename on db replication 4'
+            )
+
+            # Test alter default
+            self.cli.alter_retention_policy('somename', 'db',
+                                            default=True)
+            self.assertEqual(
+                m.last_request.qs['q'][0],
+                'alter retention policy somename on db default'
+            )
+
+    @raises(Exception)
+    def test_alter_retention_policy_invalid(self):
+        cli = InfluxDBClient('host', 8086, 'username', 'password')
+        with _mocked_session(cli, 'get', 400):
+            self.cli.alter_retention_policy('somename', 'db')
+
     def test_get_list_retention_policies(self):
         example_response = \
             '{"results": [{"series": [{"values": [["fsfdsdf", "24h0m0s", 2]],'\
diff --git a/tests/influxdb/client_test_with_server.py b/tests/influxdb/client_test_with_server.py
@@ -657,6 +657,61 @@ def test_create_retention_policy(self):
             rsp
         )
 
+    def test_alter_retention_policy(self):
+        self.cli.create_retention_policy('somename', '1d', 1)
+
+        # Test alter duration
+        self.cli.alter_retention_policy('somename', 'db',
+                                        duration='4d')
+        rsp = self.cli.get_list_retention_policies()
+        self.assertEqual(
+            [{'duration': '0', 'default': True,
+              'replicaN': 1, 'name': 'default'},
+             {'duration': '96h0m0s', 'default': False,
+              'replicaN': 1, 'name': 'somename'}],
+            rsp
+        )
+
+        # Test alter replication
+        self.cli.alter_retention_policy('somename', 'db',
+                                        replication=4)
+        rsp = self.cli.get_list_retention_policies()
+        self.assertEqual(
+            [{'duration': '0', 'default': True,
+              'replicaN': 1, 'name': 'default'},
+             {'duration': '96h0m0s', 'default': False,
+              'replicaN': 4, 'name': 'somename'}],
+            rsp
+        )
+
+        # Test alter default
+        self.cli.alter_retention_policy('somename', 'db',
+                                        default=True)
+        rsp = self.cli.get_list_retention_policies()
+        self.assertEqual(
+            [{'duration': '0', 'default': False,
+              'replicaN': 1, 'name': 'default'},
+             {'duration': '96h0m0s', 'default': True,
+              'replicaN': 4, 'name': 'somename'}],
+            rsp
+        )
+
+    def test_alter_retention_policy_invalid(self):
+        self.cli.create_retention_policy('somename', '1d', 1)
+        with self.assertRaises(InfluxDBClientError) as ctx:
+            self.cli.alter_retention_policy('somename', 'db')
+        self.assertEqual(400, ctx.exception.code)
+        self.assertIn('{"error":"error parsing query: ',
+                      ctx.exception.content)
+        rsp = self.cli.get_list_retention_policies()
+        self.assertEqual(
+            [{'duration': '0', 'default': True,
+              'replicaN': 1, 'name': 'default'},
+             {'duration': '24h0m0s', 'default': False,
+              'replicaN': 1, 'name': 'somename'}],
+            rsp
+        )
+
     def test_issue_143(self):
         pt = partial(point, 'a_serie_name', timestamp='2015-03-30T16:16:37Z')
         pts = [
