feat: add detail documents documents for timestamps

Author: NguyenHoangSon96

CHANGELOG.md

@@ -3,6 +3,7 @@
 ### Features
 
 1. [#229](https://github.com/InfluxCommunity/influxdb3-java/pull/229): Support proxy and custom ssl root certificates
+2. [#233](https://github.com/InfluxCommunity/influxdb3-java/pull/233): More detailed documentation about timestamp handling for query and write functions
 
 ## 1.0.0 [2024-12-11]
 

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

@@ -76,6 +76,9 @@ public interface InfluxDBClient extends AutoCloseable {
      * Write a {@link Point} to the InfluxDB server.
      *
      * @param point the {@link Point} to write, can be null
+     * <p>
+     * Note: the timestamp passed will be converted to nanoseconds since the Unix epoch
+     * by NanosecondConverter helper class
      */
     void writePoint(@Nullable final Point point);
 
@@ -84,13 +87,19 @@ public interface InfluxDBClient extends AutoCloseable {
      *
      * @param point   the {@link Point} to write, can be null
      * @param options the options for writing data to InfluxDB
+     * <p>
+     * Note: the timestamp passed will be converted to nanoseconds since the Unix epoch
+     * by NanosecondConverter helper class
      */
     void writePoint(@Nullable final Point point, @Nonnull final WriteOptions options);
 
     /**
      * Write a list of {@link Point} to the InfluxDB server.
      *
      * @param points the list of {@link Point} to write, cannot be null
+     * <p>
+     * Note: the timestamp passed will be converted to nanoseconds since the Unix epoch
+     * by NanosecondConverter helper class
      */
     void writePoints(@Nonnull final List<Point> points);
 
@@ -99,6 +108,9 @@ public interface InfluxDBClient extends AutoCloseable {
      *
      * @param points  the list of {@link Point} to write, cannot be null
      * @param options the options for writing data to InfluxDB
+     * <p>
+     * Note: the timestamp passed will be converted to nanoseconds since the Unix epoch
+     * by NanosecondConverter helper class
      */
     void writePoints(@Nonnull final List<Point> points, @Nonnull final WriteOptions options);
 
@@ -116,6 +128,8 @@ public interface InfluxDBClient extends AutoCloseable {
      *
      * @param query the SQL query string to execute, cannot be null
      * @return Batches of rows returned by the query
+     * <p>
+     * Note: the timestamp will be returned as a number of nanoseconds since the Unix epoch
      */
     @Nonnull
     Stream<Object[]> query(@Nonnull final String query);
@@ -136,6 +150,8 @@ public interface InfluxDBClient extends AutoCloseable {
      * @param query      the SQL query string to execute, cannot be null
      * @param parameters query named parameters
      * @return Batches of rows returned by the query
+     * <p>
+     * Note: the timestamp will be returned as a number of nanoseconds since the Unix epoch
      */
     @Nonnull
     Stream<Object[]> query(@Nonnull final String query, @Nonnull final Map<String, Object> parameters);
@@ -155,6 +171,8 @@ public interface InfluxDBClient extends AutoCloseable {
      * @param query   the query string to execute, cannot be null
      * @param options the options for querying data from InfluxDB
      * @return Batches of rows returned by the query
+     * <p>
+     * Note: the timestamp will be returned as a number of nanoseconds since the Unix epoch
      */
     @Nonnull
     Stream<Object[]> query(@Nonnull final String query, @Nonnull final QueryOptions options);
@@ -176,6 +194,8 @@ public interface InfluxDBClient extends AutoCloseable {
      * @param parameters query named parameters
      * @param options    the options for querying data from InfluxDB
      * @return Batches of rows returned by the query
+     * <p>
+     * Note: the timestamp will be returned as a number of nanoseconds since the Unix epoch
      */
     @Nonnull
     Stream<Object[]> query(@Nonnull final String query,
@@ -196,6 +216,8 @@ Stream<Object[]> query(@Nonnull final String query,
      *
      * @param query the SQL query string to execute, cannot be null
      * @return Batches of PointValues returned by the query
+     * <p>
+     * Note: the timestamp will be returned as a number of nanoseconds since the Unix epoch
      */
     @Nonnull
     Stream<PointValues> queryPoints(@Nonnull final String query);
@@ -216,6 +238,8 @@ Stream<Object[]> query(@Nonnull final String query,
      * @param query      the SQL query string to execute, cannot be null
      * @param parameters query named parameters
      * @return Batches of PointValues returned by the query
+     * <p>
+     * Note: the timestamp will be returned as a number of nanoseconds since the Unix epoch
      */
     @Nonnull
     Stream<PointValues> queryPoints(@Nonnull final String query, @Nonnull final Map<String, Object> parameters);
@@ -235,6 +259,8 @@ Stream<Object[]> query(@Nonnull final String query,
      * @param query   the query string to execute, cannot be null
      * @param options the options for querying data from InfluxDB
      * @return Batches of PointValues returned by the query
+     * <p>
+     * Note: the timestamp will be returned as a number of nanoseconds since the Unix epoch
      */
     @Nonnull
     Stream<PointValues> queryPoints(@Nonnull final String query, @Nonnull final QueryOptions options);
@@ -257,6 +283,8 @@ Stream<Object[]> query(@Nonnull final String query,
      * @param parameters query named parameters
      * @param options    the options for querying data from InfluxDB
      * @return Batches of PointValues returned by the query
+     * <p>
+     * Note: the timestamp will be returned as a number of nanoseconds since the Unix epoch
      */
     @Nonnull
     Stream<PointValues> queryPoints(@Nonnull final String query,