Skip to content

Commit

Permalink
fix: add doc string
Browse files Browse the repository at this point in the history
Co-authored-by: Jakub Bednář <[email protected]>
  • Loading branch information
alespour and bednar authored Jul 26, 2023
1 parent 2d3c9c7 commit 292de82
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions Client/Config/WriteOptions.cs
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,27 @@

namespace InfluxDB3.Client.Config;

/// <summary>
/// The WriteOptions class holds the configuration for writing data to InfluxDB.
///
/// You can configure following options:
/// - Precision: The default precision to use for the timestamp of points if no precision is specified in the write API call.
/// - GzipThreshold: The threshold in bytes for gzipping the body. The default value is 1000.
///
/// If you want create client with custom options, you can use the following code:
/// <code>
/// using var client = new InfluxDBClient(new InfluxDBClientConfigs{
/// HostUrl = "https://us-east-1-1.aws.cloud2.influxdata.com",
/// Organization = "my-org",
/// Database = "my-database",
/// WriteOptions = new WriteOptions
/// {
/// Precision = WritePrecision.S,
/// GzipThreshold = 4096
/// }
/// });
/// </code>
/// </summary>
public class WriteOptions
{
/// <summary>
Expand Down

0 comments on commit 292de82

Please sign in to comment.