Skip to content

Commit c8a5e8e

Browse files
authored
chore: update readme to use 2.x InfluxDB version (#318)
1 parent e64f903 commit c8a5e8e

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

56 files changed

+225
-225
lines changed

README.md

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,15 @@
99
[![GitHub pull requests](https://img.shields.io/github/issues-pr-raw/influxdata/influxdb-client-java.svg)](https://github.com/influxdata/influxdb-client-java/pulls)
1010
[![Slack Status](https://img.shields.io/badge/slack-join_chat-white.svg?logo=slack&style=social)](https://www.influxdata.com/slack)
1111

12-
This repository contains the reference JVM clients for the InfluxDB 2.0. Currently, Java, Reactive, Kotlin and Scala clients are implemented.
12+
This repository contains the reference JVM clients for the InfluxDB 2.x. Currently, Java, Reactive, Kotlin and Scala clients are implemented.
1313

1414
#### Note: Use this client library with InfluxDB 2.x and InfluxDB 1.8+ ([see details](#influxdb-18-api-compatibility)). For connecting to InfluxDB 1.7 or earlier instances, use the [influxdb-java](https://github.com/influxdata/influxdb-java) client library.
1515

1616
- [Features](#features)
1717
- [Clients](#clients)
1818
- [How To Use](#how-to-use)
19-
- [Writes and Queries in InfluxDB 2.0](#writes-and-queries-in-influxdb-20)
20-
- [Use Management API to create a new Bucket in InfluxDB 2.0](#use-management-api-to-create-a-new-bucket-in-influxdb-20)
19+
- [Writes and Queries in InfluxDB 2.x](#writes-and-queries-in-influxdb-2x)
20+
- [Use Management API to create a new Bucket in InfluxDB 2.x](#use-management-api-to-create-a-new-bucket-in-influxdb-2x)
2121
- [Flux queries in InfluxDB 1.7+](#flux-queries-in-influxdb-17)
2222
- [Build Requirements](#build-requirements)
2323
- [Contributing](#contributing)
@@ -27,20 +27,20 @@ This repository contains the reference JVM clients for the InfluxDB 2.0. Current
2727

2828
This section contains links to the client library documentation.
2929

30-
* [Product documentation](https://docs.influxdata.com/influxdb/v2.0/api-guide/client-libraries/), [Getting Started](#how-to-use)
30+
* [Product documentation](https://docs.influxdata.com/influxdb/v2.x/api-guide/client-libraries/), [Getting Started](#how-to-use)
3131
* [Examples](examples)
3232
* [API Reference](https://influxdata.github.io/influxdb-client-java/influxdb-client-java/apidocs/index.html)
3333
* [Changelog](CHANGELOG.md)
3434

3535
## Features
3636

37-
- InfluxDB 2.0 client
37+
- InfluxDB 2.x client
3838
- Querying data using the Flux language
3939
- Writing data using
4040
- [Line Protocol](https://docs.influxdata.com/influxdb/v1.6/write_protocols/line_protocol_tutorial/)
4141
- [Data Point](https://github.com/influxdata/influxdb-client-java/blob/master/client/src/main/java/org/influxdata/client/write/Point.java#L46)
4242
- POJO
43-
- InfluxDB 2.0 Management API client for managing
43+
- InfluxDB 2.x Management API client for managing
4444
- sources, buckets
4545
- tasks
4646
- authorizations
@@ -50,16 +50,16 @@ This section contains links to the client library documentation.
5050

5151
## Clients
5252

53-
The Java, Reactive, OSGi, Kotlin and Scala clients are implemented for the InfluxDB 2.0:
53+
The Java, Reactive, OSGi, Kotlin and Scala clients are implemented for the InfluxDB 2.x:
5454

5555
| Client | Description | Documentation | Compatibility |
5656
| --- | --- | --- | --- |
57-
| **[java](./client)** | The reference Java client that allows query, write and InfluxDB 2.0 management. | [javadoc](https://influxdata.github.io/influxdb-client-java/influxdb-client-java/apidocs/index.html), [readme](./client#influxdb-client-java/)| 2.0 |
58-
| **[reactive](./client-reactive)** | The reference RxJava client for the InfluxDB 2.0 that allows query and write in a reactive way.| [javadoc](https://influxdata.github.io/influxdb-client-java/influxdb-client-reactive/apidocs/index.html), [readme](./client-reactive#influxdb-client-reactive/) |2.0 |
59-
| **[kotlin](./client-kotlin)** | The reference Kotlin client that allows query and write for the InfluxDB 2.0 by Kotlin [Channel](https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.channels/-channel/index.html) and [Flow](https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html) coroutines. | [KDoc](https://influxdata.github.io/influxdb-client-java/influxdb-client-kotlin/dokka/influxdb-client-kotlin/com.influxdb.client.kotlin/index.html), [readme](./client-kotlin#influxdb-client-kotlin/) | 2.0|
60-
| **[scala](./client-scala)** | The reference Scala client that allows query and write for the InfluxDB 2.0 by [Akka Streams](https://doc.akka.io/docs/akka/2.6/stream/). | [Scaladoc](https://influxdata.github.io/influxdb-client-java/client-scala/cross/influxdb-client-scala_2.13/scaladocs/com/influxdb/client/scala/index.html), [readme](./client-scala#influxdb-client-scala/) | 2.0 |
61-
| **[osgi](./client-osgi)** | The reference OSGi (R6) client embedding Java and reactive clients and providing standard features (declarative services, configuration, event processing) for the InfluxDB 2.0. | [javadoc](https://influxdata.github.io/influxdb-client-java/influxdb-client-osgi/apidocs/index.html), [readme](./client-osgi) | 2.0 |
62-
| **[karaf](./karaf)** | The Apache Karaf feature definition for the InfluxDB 2.0. | [readme](./karaf) | 2.0 |
57+
| **[java](./client)** | The reference Java client that allows query, write and InfluxDB 2.x management. | [javadoc](https://influxdata.github.io/influxdb-client-java/influxdb-client-java/apidocs/index.html), [readme](./client#influxdb-client-java/)| 2.x |
58+
| **[reactive](./client-reactive)** | The reference RxJava client for the InfluxDB 2.x that allows query and write in a reactive way.| [javadoc](https://influxdata.github.io/influxdb-client-java/influxdb-client-reactive/apidocs/index.html), [readme](./client-reactive#influxdb-client-reactive/) |2.x |
59+
| **[kotlin](./client-kotlin)** | The reference Kotlin client that allows query and write for the InfluxDB 2.x by Kotlin [Channel](https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.channels/-channel/index.html) and [Flow](https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html) coroutines. | [KDoc](https://influxdata.github.io/influxdb-client-java/influxdb-client-kotlin/dokka/influxdb-client-kotlin/com.influxdb.client.kotlin/index.html), [readme](./client-kotlin#influxdb-client-kotlin/) | 2.x|
60+
| **[scala](./client-scala)** | The reference Scala client that allows query and write for the InfluxDB 2.x by [Akka Streams](https://doc.akka.io/docs/akka/2.6/stream/). | [Scaladoc](https://influxdata.github.io/influxdb-client-java/client-scala/cross/influxdb-client-scala_2.13/scaladocs/com/influxdb/client/scala/index.html), [readme](./client-scala#influxdb-client-scala/) | 2.x |
61+
| **[osgi](./client-osgi)** | The reference OSGi (R6) client embedding Java and reactive clients and providing standard features (declarative services, configuration, event processing) for the InfluxDB 2.x. | [javadoc](https://influxdata.github.io/influxdb-client-java/influxdb-client-osgi/apidocs/index.html), [readme](./client-osgi) | 2.x |
62+
| **[karaf](./karaf)** | The Apache Karaf feature definition for the InfluxDB 2.x. | [readme](./karaf) | 2.x |
6363

6464
There is also possibility to use the Flux language over the InfluxDB 1.7+ provided by:
6565

@@ -78,7 +78,7 @@ Flux flux = Flux
7878

7979
| Module | Description | Documentation | Compatibility |
8080
| --- | --- | --- | --- |
81-
| **[flux-dsl](./flux-dsl)** | A Java query builder for the Flux language | [javadoc](https://influxdata.github.io/influxdb-client-java/flux-dsl/apidocs/index.html), [readme](./flux-dsl#flux-dsl/)| 1.7+, 2.0 |
81+
| **[flux-dsl](./flux-dsl)** | A Java query builder for the Flux language | [javadoc](https://influxdata.github.io/influxdb-client-java/flux-dsl/apidocs/index.html), [readme](./flux-dsl#flux-dsl/)| 1.7+, 2.x |
8282

8383

8484
## How To Use
@@ -87,9 +87,9 @@ This clients are hosted in Maven central Repository.
8787

8888
If you want to use it with the Maven, you have to add only the dependency on the artifact.
8989

90-
### Writes and Queries in InfluxDB 2.0
90+
### Writes and Queries in InfluxDB 2.x
9191

92-
The following example demonstrates how to write data to InfluxDB 2.0 and read them back using the Flux language.
92+
The following example demonstrates how to write data to InfluxDB 2.x and read them back using the Flux language.
9393

9494
#### Installation
9595

@@ -203,9 +203,9 @@ public class InfluxDB2Example {
203203
}
204204
```
205205

206-
### Use Management API to create a new Bucket in InfluxDB 2.0
206+
### Use Management API to create a new Bucket in InfluxDB 2.x
207207

208-
The following example demonstrates how to use a InfluxDB 2.0 Management API. For further information see [client documentation](./client#management-api).
208+
The following example demonstrates how to use a InfluxDB 2.x Management API. For further information see [client documentation](./client#management-api).
209209

210210
#### Installation
211211

@@ -292,14 +292,14 @@ public class InfluxDB2ManagementExample {
292292

293293
### InfluxDB 1.8 API compatibility
294294

295-
[InfluxDB 1.8.0 introduced forward compatibility APIs](https://docs.influxdata.com/influxdb/v1.8/tools/api/#influxdb-2-0-api-compatibility-endpoints) for InfluxDB 2.0. This allow you to easily move from InfluxDB 1.x to InfluxDB 2.0 Cloud or open source.
295+
[InfluxDB 1.8.0 introduced forward compatibility APIs](https://docs.influxdata.com/influxdb/v1.8/tools/api/#influxdb-2-0-api-compatibility-endpoints) for InfluxDB 2.x. This allow you to easily move from InfluxDB 1.x to InfluxDB 2.x Cloud or open source.
296296

297297
The following forward compatible APIs are available:
298298

299299
| API | Endpoint | Description |
300300
|:----------|:----------|:----------|
301-
| [QueryApi.java](client/src/main/java/com/influxdb/client/QueryApi.java) | [/api/v2/query](https://docs.influxdata.com/influxdb/latest/tools/api/#api-v2-query-http-endpoint) | Query data in InfluxDB 1.8.0+ using the InfluxDB 2.0 API and [Flux](https://docs.influxdata.com/flux/latest/) _(endpoint should be enabled by [`flux-enabled` option](https://docs.influxdata.com/influxdb/latest/administration/config/#flux-enabled-false))_ |
302-
| [WriteApi.java](client/src/main/java/com/influxdb/client/WriteApi.java) | [/api/v2/write](https://docs.influxdata.com/influxdb/latest/tools/api/#api-v2-write-http-endpoint) | Write data to InfluxDB 1.8.0+ using the InfluxDB 2.0 API |
301+
| [QueryApi.java](client/src/main/java/com/influxdb/client/QueryApi.java) | [/api/v2/query](https://docs.influxdata.com/influxdb/latest/tools/api/#api-v2-query-http-endpoint) | Query data in InfluxDB 1.8.0+ using the InfluxDB 2.x API and [Flux](https://docs.influxdata.com/flux/latest/) _(endpoint should be enabled by [`flux-enabled` option](https://docs.influxdata.com/influxdb/latest/administration/config/#flux-enabled-false))_ |
302+
| [WriteApi.java](client/src/main/java/com/influxdb/client/WriteApi.java) | [/api/v2/write](https://docs.influxdata.com/influxdb/latest/tools/api/#api-v2-write-http-endpoint) | Write data to InfluxDB 1.8.0+ using the InfluxDB 2.x API |
303303
| [health()](client/src/main/java/com/influxdb/client/InfluxDBClient.java#L236) | [/health](https://docs.influxdata.com/influxdb/latest/tools/api/#health-http-endpoint) | Check the health of your InfluxDB instance |
304304

305305
For detail info see [InfluxDB 1.8 example](examples/src/main/java/example/InfluxDB18Example.java).
@@ -395,7 +395,7 @@ public class FluxExample {
395395
* Java 1.8+ (tested with jdk8)
396396
* Maven 3.0+ (tested with maven 3.5.0)
397397
* Docker daemon running
398-
* The latest InfluxDB 2.0 and InfluxDB 1.X docker instances, which can be started using the `./scripts/influxdb-restart.sh` script
398+
* The latest InfluxDB 2.x and InfluxDB 1.X docker instances, which can be started using the `./scripts/influxdb-restart.sh` script
399399

400400

401401
Once these are in place you can build influxdb-client-java with all tests with:
@@ -429,4 +429,4 @@ If you would like to contribute code you can do through GitHub by forking the re
429429

430430
## License
431431

432-
The InfluxDB 2.0 JVM Based Clients are released under the [MIT License](https://opensource.org/licenses/MIT).
432+
The InfluxDB 2.x JVM Based Clients are released under the [MIT License](https://opensource.org/licenses/MIT).

client-kotlin/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22

33
[![KDoc](https://img.shields.io/badge/KDoc-link-brightgreen.svg)](https://influxdata.github.io/influxdb-client-java/influxdb-client-kotlin/dokka/influxdb-client-kotlin/com.influxdb.client.kotlin/index.html)
44

5-
The reference Kotlin client that allows query and write for the InfluxDB 2.0 by Kotlin Channel coroutines.
5+
The reference Kotlin client that allows query and write for the InfluxDB 2.x by Kotlin Channel coroutines.
66

77
## Documentation
88

99
This section contains links to the client library documentation.
1010

11-
* [Product documentation](https://docs.influxdata.com/influxdb/v2.0/api-guide/client-libraries/), [Getting Started](#queries)
11+
* [Product documentation](https://docs.influxdata.com/influxdb/latest/api-guide/client-libraries/), [Getting Started](#queries)
1212
* [Examples](../examples)
1313
* [API Reference](https://influxdata.github.io/influxdb-client-java/influxdb-client-kotlin/dokka/influxdb-client-kotlin/com.influxdb.client.kotlin/index.html)
1414
* [Changelog](../CHANGELOG.md)

client-kotlin/pom.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,9 @@
3333
<artifactId>influxdb-client-kotlin</artifactId>
3434
<packaging>jar</packaging>
3535

36-
<name>The Kotlin InfluxDB 2.0 Client</name>
36+
<name>The Kotlin InfluxDB 2.x Client</name>
3737
<description>
38-
The reference Kotlin client that allows query and write for the InfluxDB 2.0
38+
The reference Kotlin client that allows query and write for the InfluxDB 2.x
3939
by Kotlin Channel and Flow coroutines.
4040
</description>
4141

client-kotlin/src/main/kotlin/com/influxdb/client/kotlin/InfluxDBClientKotlin.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ import java.io.Closeable
2727
import javax.annotation.Nonnull
2828

2929
/**
30-
* The reference Kotlin client that allows query and write for the InfluxDB 2.0 by Kotlin Channel coroutines.
30+
* The reference Kotlin client that allows query and write for the InfluxDB 2.x by Kotlin Channel coroutines.
3131
*
3232
* @author Jakub Bednar (bednar@github) (07/02/2019 13:11)
3333
*/

client-kotlin/src/main/kotlin/com/influxdb/client/kotlin/InfluxDBClientKotlinFactory.kt

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ class InfluxDBClientKotlinFactory {
3535
companion object {
3636

3737
/**
38-
* Create an instance of the InfluxDB 2.0 client that is configured via {@code influx2.properties}.
38+
* Create an instance of the InfluxDB 2.x client that is configured via {@code influx2.properties}.
3939
* The {@code influx2.properties} has to be located on classpath.
4040
*
4141
* @return client
@@ -50,7 +50,7 @@ class InfluxDBClientKotlinFactory {
5050
}
5151

5252
/**
53-
* Create an instance of the InfluxDB 2.0 client. The url could be a connection string with various configurations.
53+
* Create an instance of the InfluxDB 2.x client. The url could be a connection string with various configurations.
5454
*
5555
* e.g.: "http://localhost:8086?readTimeout=5000&amp;connectTimeout=5000&amp;logLevel=BASIC
5656
*
@@ -67,7 +67,7 @@ class InfluxDBClientKotlinFactory {
6767
}
6868

6969
/**
70-
* Create an instance of the InfluxDB 2.0 reactive client.
70+
* Create an instance of the InfluxDB 2.x reactive client.
7171
*
7272
* <p>
7373
* The <i>username/password</i> auth is based on
@@ -95,7 +95,7 @@ class InfluxDBClientKotlinFactory {
9595
}
9696

9797
/**
98-
* Create an instance of the InfluxDB 2.0 reactive client.
98+
* Create an instance of the InfluxDB 2.x reactive client.
9999
*
100100
* @param url the url to connect to the InfluxDB
101101
* @param token the token to use for the authorization
@@ -108,7 +108,7 @@ class InfluxDBClientKotlinFactory {
108108
}
109109

110110
/**
111-
* Create an instance of the InfluxDB 2.0 reactive client.
111+
* Create an instance of the InfluxDB 2.x reactive client.
112112
*
113113
* @param url the url to connect to the InfluxDB
114114
* @param token the token to use for the authorization
@@ -122,7 +122,7 @@ class InfluxDBClientKotlinFactory {
122122
}
123123

124124
/**
125-
* Create an instance of the InfluxDB 2.0 reactive client.
125+
* Create an instance of the InfluxDB 2.x reactive client.
126126
*
127127
* @param url the url to connect to the InfluxDB
128128
* @param token the token to use for the authorization
@@ -144,7 +144,7 @@ class InfluxDBClientKotlinFactory {
144144
}
145145

146146
/**
147-
* Create an instance of the InfluxDB 2.0 reactive client.
147+
* Create an instance of the InfluxDB 2.x reactive client.
148148
*
149149
* @param options the connection configuration
150150
* @return client

client-kotlin/src/main/kotlin/com/influxdb/client/kotlin/WriteKotlinApi.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ import com.influxdb.client.write.Point
2626
import kotlinx.coroutines.flow.Flow
2727

2828
/**
29-
* The Kotlin API to write time-series data into InfluxDB 2.0.
29+
* The Kotlin API to write time-series data into InfluxDB 2.x.
3030
*
3131
* @author Jakub Bednar (20/04/2021 8:18)
3232
*/

client-legacy/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ The client that allow perform Flux Query against the InfluxDB 1.7+.
88

99
This section contains links to the client library documentation.
1010

11-
* [Product documentation](https://docs.influxdata.com/influxdb/v2.0/api-guide/client-libraries/), [Getting Started](#create-client)
11+
* [Product documentation](https://docs.influxdata.com/influxdb/latest/api-guide/client-libraries/), [Getting Started](#create-client)
1212
* [Examples](../examples)
1313
* [API Reference](https://influxdata.github.io/influxdb-client-java/influxdb-client-flux/apidocs/index.html)
1414
* [Changelog](../CHANGELOG.md)

client-osgi/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# OSGi Client Bundle for InfluxDB 2.0
1+
# OSGi Client Bundle for InfluxDB 2.x
22

33
[![javadoc](https://img.shields.io/badge/javadoc-link-brightgreen.svg)](https://influxdata.github.io/influxdb-client-java/influxdb-client-osgi/apidocs/index.html)
44

5-
OSGi (R6) client bundle contains InfluxDB 2.0 client and dependencies excluding Kotlin and JSR-305 (FindBugs).
5+
OSGi (R6) client bundle contains InfluxDB 2.x client and dependencies excluding Kotlin and JSR-305 (FindBugs).
66

77
## Services
88

client-osgi/pom.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,9 @@
3434
<artifactId>influxdb-client-osgi</artifactId>
3535
<packaging>bundle</packaging>
3636

37-
<name>The OSGi InfluxDB 2.0 Client</name>
37+
<name>The OSGi InfluxDB 2.x Client</name>
3838
<description>
39-
InfluxDB 2.0 Java client extension for OSGi environments.
39+
InfluxDB 2.x Java client extension for OSGi environments.
4040
</description>
4141

4242
<url>https://github.com/influxdata/influxdb-client-java/tree/master/client-osgi</url>

client-reactive/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
[![javadoc](https://img.shields.io/badge/javadoc-link-brightgreen.svg)](https://influxdata.github.io/influxdb-client-java/influxdb-client-reactive/apidocs/index.html)
44

5-
The reference reactive Java client for InfluxDB 2.0. The client provide supports for asynchronous stream processing with backpressure as is defined by the [Reactive Streams specification](http://www.reactive-streams.org/).
5+
The reference reactive Java client for InfluxDB 2.x. The client provide supports for asynchronous stream processing with backpressure as is defined by the [Reactive Streams specification](http://www.reactive-streams.org/).
66

77
## Important
88

@@ -13,7 +13,7 @@ That means no request to InfluxDB is trigger until register a subscription to `P
1313

1414
This section contains links to the client library documentation.
1515

16-
* [Product documentation](https://docs.influxdata.com/influxdb/v2.0/api-guide/client-libraries/), [Getting Started](#queries)
16+
* [Product documentation](https://docs.influxdata.com/influxdb/latest/api-guide/client-libraries/), [Getting Started](#queries)
1717
* [Examples](../examples)
1818
* [API Reference](https://influxdata.github.io/influxdb-client-java/influxdb-client-reactive/apidocs/index.html)
1919
* [Changelog](../CHANGELOG.md)

0 commit comments

Comments
 (0)