Skip to content

Commit 2a1d436

Browse files
docs: comments for write null fields
1 parent d113f81 commit 2a1d436

1 file changed

Lines changed: 25 additions & 3 deletions

File tree

src/main/java/com/influxdb/v3/client/InfluxDBClient.java

Lines changed: 25 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,11 @@ public interface InfluxDBClient extends AutoCloseable {
7878
* @param point the {@link Point} to write, can be null
7979
* <p>
8080
* Note: the timestamp passed will be converted to nanoseconds since the Unix epoch
81-
* by NanosecondConverter helper class
81+
* by NanosecondConverter helper class. <br>
82+
* Warning: If you try to write ONLY ONE Point to Influxdb, but that Point has fields with null values,
83+
* then these fields will NOT be written to Influxdb.
84+
* In the following queries If you explicitly query these null fields like this: "Select normalField, nullField from my_table"
85+
* error will be thrown.
8286
*/
8387
void writePoint(@Nullable final Point point);
8488

@@ -89,7 +93,13 @@ public interface InfluxDBClient extends AutoCloseable {
8993
* @param options the options for writing data to InfluxDB
9094
* <p>
9195
* Note: the timestamp passed will be converted to nanoseconds since the Unix epoch
92-
* by NanosecondConverter helper class
96+
* by NanosecondConverter helper class <br>
97+
* Note: the timestamp passed will be converted to nanoseconds since the Unix epoch
98+
* by NanosecondConverter helper class. <br>
99+
* Warning: If you try to write ONLY ONE Point to Influxdb, but that Point has fields with null values,
100+
* then these fields will NOT be written to Influxdb.
101+
* In the following queries If you explicitly query these null fields like this: "Select normalField, nullField from my_table"
102+
* error will be thrown.
93103
*/
94104
void writePoint(@Nullable final Point point, @Nonnull final WriteOptions options);
95105

@@ -99,7 +109,13 @@ public interface InfluxDBClient extends AutoCloseable {
99109
* @param points the list of {@link Point} to write, cannot be null
100110
* <p>
101111
* Note: the timestamp passed will be converted to nanoseconds since the Unix epoch
102-
* by NanosecondConverter helper class
112+
* by NanosecondConverter helper class <br>
113+
* Note: the timestamp passed will be converted to nanoseconds since the Unix epoch
114+
* by NanosecondConverter helper class. <br>
115+
* Warning: If you try to write ONLY ONE Point to Influxdb, but that Point has fields with null values,
116+
* then these fields will NOT be written to Influxdb.
117+
* In the following queries If you explicitly query these null fields like this: "Select normalField, nullField from my_table"
118+
* error will be thrown.
103119
*/
104120
void writePoints(@Nonnull final List<Point> points);
105121

@@ -111,6 +127,12 @@ public interface InfluxDBClient extends AutoCloseable {
111127
* <p>
112128
* Note: the timestamp passed will be converted to nanoseconds since the Unix epoch
113129
* by NanosecondConverter helper class
130+
* Note: the timestamp passed will be converted to nanoseconds since the Unix epoch
131+
* by NanosecondConverter helper class. <br>
132+
* Warning: If you try to write ONLY ONE Point to Influxdb, but that Point has fields with null values,
133+
* then these fields will NOT be written to Influxdb.
134+
* In the following queries If you explicitly query these null fields like this: "Select normalField, nullField from my_table"
135+
* error will be thrown.
114136
*/
115137
void writePoints(@Nonnull final List<Point> points, @Nonnull final WriteOptions options);
116138

0 commit comments

Comments
 (0)