Add Delete service (influxdata#44)

Author: rolincova

CHANGELOG.md

@@ -2,7 +2,7 @@
 
 ### API
 1. [#42](https://github.com/influxdata/influxdb-client-csharp/pull/42): Updated swagger to latest version
-
+2. [#43](https://github.com/influxdata/influxdb-client-csharp/issues/43) Added DeleteApi
 
 ## 1.1.0 [2019-10-11]
 

Client.Test/ItDeleteApiTest.cs

@@ -0,0 +1,146 @@
+using System;
+using System.Collections.Generic;
+using System.Configuration;
+using System.Threading.Tasks;
+using InfluxDB.Client.Api.Domain;
+using InfluxDB.Client.Core;
+using InfluxDB.Client.Writes;
+using NUnit.Framework;
+
+namespace InfluxDB.Client.Test
+{
+ [TestFixture]
+ public class ItDeleteApiTest : AbstractItClientTest
+ {
+ [SetUp]
+ public new async Task SetUp()
+ {
+ _organization = await FindMyOrg();
+
+ var retention = new BucketRetentionRules(BucketRetentionRules.TypeEnum.Expire, 3600);
+
+ _bucket = await Client.GetBucketsApi()
+ .CreateBucketAsync(GenerateName("h2o"), retention, _organization);
+
+ //
+ // Add Permissions to read and write to the Bucket
+ //
+ var resource =
+ new PermissionResource(PermissionResource.TypeEnum.Buckets, _bucket.Id, null, _organization.Id);
+
+ var readBucket = new Permission(Permission.ActionEnum.Read, resource);
+ var writeBucket = new Permission(Permission.ActionEnum.Write, resource);
+
+ var loggedUser = await Client.GetUsersApi().MeAsync();
+ Assert.IsNotNull(loggedUser);
+
+ var authorization = await Client.GetAuthorizationsApi()
+ .CreateAuthorizationAsync(await FindMyOrg(), new List<Permission> {readBucket, writeBucket});
+
+ _token = authorization.Token;
+
+ Client.Dispose();
+ var options = new InfluxDBClientOptions.Builder().Url(InfluxDbUrl).AuthenticateToken(_token.ToCharArray())
+ .Org(_organization.Id).Bucket(_bucket.Id).Build();
+ Client = InfluxDBClientFactory.Create(options);
+ _queryApi = Client.GetQueryApi();
+ }
+ 
+ [TearDown]
+ protected new void After()
+ {
+ _writeApi.Dispose();
+ }
+
+ private Bucket _bucket;
+ private QueryApi _queryApi;
+ private WriteApi _writeApi;
+ private DeleteApi _deleteApi;
+ private Organization _organization;
+ private string _token;
+ 
+ [Measurement("h2o")]
+ private class H20Measurement
+ {
+ [Column("location", IsTag = true)] public string Location { get; set; }
+
+ [Column("level")] public double? Level { get; set; }
+
+ [Column(IsTimestamp = true)] public DateTime Time { get; set; }
+ }
+
+ [Test]
+ public async Task Delete()
+ {
+ Client.Dispose();
+
+ Environment.SetEnvironmentVariable("point-datacenter", "LA");
+ ConfigurationManager.AppSettings["point-sensor.version"] = "1.23a";
+
+ var options = new InfluxDBClientOptions.Builder().Url(InfluxDbUrl)
+ .AuthenticateToken(_token.ToCharArray())
+ .AddDefaultTag("id", "132-987-655")
+ .AddDefaultTag("customer", "California Miner")
+ .AddDefaultTag("env-var", "${env.point-datacenter}")
+ .AddDefaultTag("sensor-version", "${point-sensor.version}")
+ .Build();
+
+ Client = InfluxDBClientFactory.Create(options);
+
+ var point = PointData.Measurement("h2o_feet").Tag("location", "west").Field("water_level", 1);
+ var point2 = PointData.Measurement("h2o_feet").Tag("location", "west").Field("water_level", 2);
+ var point3 = PointData.Measurement("h2o_feet").Tag("location", "west").Field("water_level", 3);
+ var point4 = PointData.Measurement("h2o_feet").Tag("location", "west").Field("water_level", 4);
+ var point5 = PointData.Measurement("h2o_feet").Tag("location", "west").Field("water_level", 5);
+ var point6 = PointData.Measurement("h2o_feet").Tag("location", "west").Field("water_level", 6);
+
+ _writeApi = Client.GetWriteApi();
+ var listener = new WriteApiTest.EventListener(_writeApi);
+ _writeApi.WritePoint(_bucket.Name, _organization.Id, point);
+ _writeApi.Flush();
+
+ listener.WaitToSuccess();
+ 
+ _writeApi.WritePoint(_bucket.Name, _organization.Id, point2);
+ _writeApi.Flush();
+
+ listener.WaitToSuccess();
+ 
+ _writeApi.WritePoint(_bucket.Name, _organization.Id, point3);
+ _writeApi.Flush();
+
+ listener.WaitToSuccess();
+ 
+ _writeApi.WritePoint(_bucket.Name, _organization.Id, point4);
+ _writeApi.Flush();
+
+ listener.WaitToSuccess();
+ 
+ _writeApi.WritePoint(_bucket.Name, _organization.Id, point5);
+ _writeApi.Flush();
+
+ listener.WaitToSuccess();
+ 
+ _writeApi.WritePoint(_bucket.Name, _organization.Id, point6);
+ _writeApi.Flush();
+
+ listener.WaitToSuccess();
+
+ string query = "from(bucket:\"" + _bucket.Name +
+ "\") |> range(start: 1970-01-01T00:00:00.000000001Z) |> pivot(rowKey:[\"_time\"], columnKey: [\"_field\"], valueColumn: \"_value\")";
+
+ _queryApi = Client.GetQueryApi();
+ var tables = await _queryApi.QueryAsync(query, _organization.Id);
+
+ Assert.AreEqual(1, tables.Count);
+ Assert.AreEqual(6, tables[0].Records.Count);
+
+ _deleteApi = Client.GetDeleteApi();
+ await _deleteApi.Delete(DateTime.Now.AddHours(-1), DateTime.Now, "", _bucket, _organization);
+ 
+ var tablesAfterDelete = await _queryApi.QueryAsync(query, _organization.Id);
+ 
+ Assert.AreEqual(0, tablesAfterDelete.Count);
+ }
+ }
+}

Client/DeleteApi.cs

@@ -0,0 +1,73 @@
+using System;
+using System.Diagnostics;
+using System.Threading.Tasks;
+using InfluxDB.Client.Api.Domain;
+using InfluxDB.Client.Api.Service;
+using InfluxDB.Client.Core;
+using NodaTime;
+
+namespace InfluxDB.Client
+{
+ public class DeleteApi
+ {
+ private readonly DefaultService _service;
+
+ protected internal DeleteApi(DefaultService service)
+ {
+ Arguments.CheckNotNull(service, nameof(service));
+
+ _service = service;
+ }
+ 
+ /// <summary>
+ /// Delete Time series data from InfluxDB.
+ /// </summary>
+ /// <param name="start">Start time</param>
+ /// <param name="stop">Stop time</param>
+ /// <param name="predicate">Sql where like delete statement</param>
+ /// <param name="bucket">The bucket from which data will be deleted</param>
+ /// <param name="org">The organization of the above bucket</param>
+ public async Task Delete(DateTime start, DateTime stop, string predicate, Bucket bucket, Organization org)
+ {
+ Arguments.CheckNotNull(start, "Start is required");
+ Arguments.CheckNotNull(stop, "Stop is required");
+ Arguments.CheckNotNull(predicate, "Predicate is required");
+ Arguments.CheckNotNull(bucket, "Bucket is required");
+ Arguments.CheckNotNull(org, "Organization is required");
+ 
+ await Delete(start, stop, predicate, bucket.Id, org.Id);
+ }
+ 
+ /// <summary>
+ /// Delete Time series data from InfluxDB.
+ /// </summary>
+ /// <param name="start">Start time</param>
+ /// <param name="stop">Stop time</param>
+ /// <param name="predicate">Sql where like delete statement</param>
+ /// <param name="bucket">The bucket from which data will be deleted</param>
+ /// <param name="org">The organization of the above bucket</param>
+ public async Task Delete(DateTime start, DateTime stop, string predicate, string bucket, string org)
+ {
+ Arguments.CheckNotNull(start, "Start is required");
+ Arguments.CheckNotNull(stop, "Stop is required");
+ Arguments.CheckNotNull(predicate, "Predicate is required");
+ Arguments.CheckNonEmptyString(bucket, "Bucket is required");
+ Arguments.CheckNonEmptyString(org, "Organization is required");
+ 
+ var predicateRequest = new DeletePredicateRequest(start, stop, predicate);
+
+ await Delete(predicateRequest, bucket, org);
+ }
+
+ /// <summary>
+ /// Delete Time series data from InfluxDB.
+ /// </summary>
+ /// <param name="predicate">Predicate delete request</param>
+ /// <param name="bucket">The bucket from which data will be deleted</param>
+ /// <param name="org">The organization of the above bucket</param>
+ public async Task Delete(DeletePredicateRequest predicate, string bucket, string org)
+ {
+ await _service.DeletePostAsync(predicate, null, org, bucket, null, null);
+ }
+ }
+}

Client/InfluxDBClient.cs

@@ -284,6 +284,20 @@ public ChecksApi GetChecksApi()
 
  return new ChecksApi(service);
  }
+ 
+ /// <summary>
+ /// Get the Delete client.
+ /// </summary>
+ /// <returns>the new client instance for Delete API</returns>
+ public DeleteApi GetDeleteApi()
+ {
+ var service = new DefaultService((Configuration) _apiClient.Configuration)
+ {
+ ExceptionFactory = _exceptionFactory
+ };
+
+ return new DeleteApi(service);
+ }
 
  /// <summary>
  /// Set the log level for the request and response information.

Client/README.md

@@ -12,6 +12,7 @@ The reference client that allows query, write and management (bucket, organizati
  - [Data Point](#by-data-point) 
  - [POCO](#by-poco)
  - [Default Tags](#default-tags)
+- [Delete data](#delete-data) 
 - [InfluxDB 2.0 Management API](#management-api)
  - sources, buckets
  - tasks
@@ -546,6 +547,35 @@ writeApi.EventHandler += (sender, eventArgs) =>
 };
 ```
 
+## Delete Data
+
+Delete data from specified bucket:
+
+```c#
+using InfluxDB.Client;
+using InfluxDB.Client.Api.Domain;
+
+namespace Examples
+{
+ public static class WriteLineProtocol
+ {
+ private static readonly char[] Token = "".ToCharArray();
+
+ public static void Main(string[] args)
+ {
+ var influxDBClient = InfluxDBClientFactory.Create("http://localhost:9999", Token);
+
+ //
+ // Delete data
+ //
+ await influxDB.GetDeleteApi().Delete(DateTime.UtcNow.AddMinutes(-1), DateTime.Now, "", "bucket", "org");
+ 
+ influxDBClient.Dispose();
+ }
+ }
+}
+```
+
 ## Management API
 
 The client has following management API:

Examples/PlatformExample.cs

@@ -117,7 +117,11 @@ public static async Task Example(InfluxDBClient influxDB)
  Console.WriteLine($"{fluxRecord.GetTime()}: {fluxRecord.GetValue()}");
  });
  });
-
+ 
+ //
+ // Delete data
+ //
+ await influxDB.GetDeleteApi().Delete(DateTime.UtcNow.AddMinutes(-1), DateTime.Now, "", temperatureBucket, medicalGMBH);
 
  influxDB.Dispose();
  }