Skip to content

Commit efde8be

Browse files
docs: comments for write null fields (#374)
1 parent d113f81 commit efde8be

1 file changed

Lines changed: 25 additions & 4 deletions

File tree

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

Lines changed: 25 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,12 @@ 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: Fields with {@code null} values in a {@link Point} are not written to InfluxDB.
83+
*
84+
* If such fields are later queried explicitly, for example:
85+
* {@code SELECT normalField, nullField FROM my_table}
86+
* an error will be thrown.
8287
*/
8388
void writePoint(@Nullable final Point point);
8489

@@ -89,7 +94,12 @@ public interface InfluxDBClient extends AutoCloseable {
8994
* @param options the options for writing data to InfluxDB
9095
* <p>
9196
* Note: the timestamp passed will be converted to nanoseconds since the Unix epoch
92-
* by NanosecondConverter helper class
97+
* by NanosecondConverter helper class. <br>
98+
* Warning: Fields with {@code null} values in a {@link Point} are not written to InfluxDB.
99+
*
100+
* If such fields are later queried explicitly, for example:
101+
* {@code SELECT normalField, nullField FROM my_table}
102+
* an error will be thrown.
93103
*/
94104
void writePoint(@Nullable final Point point, @Nonnull final WriteOptions options);
95105

@@ -99,7 +109,11 @@ 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+
* Warning: If the provided list contains only one {@link Point}, and that {@code Point}
114+
* contains fields with {@code null} values, those fields are not written to InfluxDB.
115+
* If such fields are later queried explicitly, for example:
116+
* {@code SELECT normalField, nullField FROM my_table} an error will be thrown.
103117
*/
104118
void writePoints(@Nonnull final List<Point> points);
105119

@@ -110,7 +124,14 @@ public interface InfluxDBClient extends AutoCloseable {
110124
* @param options the options for writing data to InfluxDB
111125
* <p>
112126
* Note: the timestamp passed will be converted to nanoseconds since the Unix epoch
113-
* by NanosecondConverter helper class
127+
* by NanosecondConverter helper class. <br>
128+
*
129+
* Warning: If the provided list contains only one {@link Point}, and that {@code Point}
130+
* contains fields with {@code null} values, those fields are not written to InfluxDB.
131+
*
132+
* If such fields are later queried explicitly, for example:
133+
* {@code SELECT normalField, nullField FROM my_table}
134+
* an error will be thrown.
114135
*/
115136
void writePoints(@Nonnull final List<Point> points, @Nonnull final WriteOptions options);
116137

0 commit comments

Comments
 (0)