diff --git a/content/influxdb/cloud/api-guide/_index.md b/content/influxdb/cloud/api-guide/_index.md index d3c6413bf..80a437541 100644 --- a/content/influxdb/cloud/api-guide/_index.md +++ b/content/influxdb/cloud/api-guide/_index.md @@ -1,11 +1,27 @@ --- -title: Build with the InfluxDB API +title: Develop with the InfluxDB API seotitle: Use the InfluxDB API description: Interact with InfluxDB Cloud using a rich API for writing and querying data and more. weight: 3 menu: influxdb_cloud: name: Develop with the API +influxdb/cloud/tags: [api] --- -{{< duplicate-oss >}} +The InfluxDB v2 API provides a programmatic interface for interactions with InfluxDB. +Access the InfluxDB API using the `/api/v2/` endpoint. + +## InfluxDB client libraries +InfluxDB client libraries are language-specific packages that integrate with the InfluxDB v2 API. +For information about supported client libraries, see [InfluxDB client libraries](/influxdb/cloud/tools/client-libraries/). + +## InfluxDB Cloud API documentation +InfluxDB Cloud API documentation + +## InfluxDB v1 compatibility API documentation +The InfluxDB v2 API includes [InfluxDB 1.x compatibility endpoints](/influxdb/cloud/reference/api/influxdb-1x/) +that work with InfluxDB 1.x client libraries and third-party integrations like +[Grafana](https://grafana.com) and others. + +View full v1 compatibility API documentation diff --git a/content/influxdb/cloud/api-guide/api_intro.md b/content/influxdb/cloud/api-guide/api_intro.md new file mode 100644 index 000000000..3118fd2ff --- /dev/null +++ b/content/influxdb/cloud/api-guide/api_intro.md @@ -0,0 +1,12 @@ +--- +title: API Quick Start +seotitle: Use the InfluxDB API +description: Interact with InfluxDB Cloud using a rich API for writing and querying data and more. +weight: 3 +menu: + influxdb_cloud: + name: Quick start + parent: Develop with the API +--- + +{{< duplicate-oss >}} diff --git a/content/influxdb/cloud/api-guide/client-libraries/_index.md b/content/influxdb/cloud/api-guide/client-libraries/_index.md index ef7cf4129..d2accfb56 100644 --- a/content/influxdb/cloud/api-guide/client-libraries/_index.md +++ b/content/influxdb/cloud/api-guide/client-libraries/_index.md @@ -9,7 +9,7 @@ aliases: - /influxdb/cloud/reference/api/client-libraries/ menu: influxdb_cloud: - name: Use client libraries + name: Client libraries parent: Develop with the API influxdb/cloud/tags: [client libraries] --- diff --git a/content/influxdb/cloud/tools/client-libraries/arduino.md b/content/influxdb/cloud/api-guide/client-libraries/arduino.md similarity index 92% rename from content/influxdb/cloud/tools/client-libraries/arduino.md rename to content/influxdb/cloud/api-guide/client-libraries/arduino.md index cff58349d..b031863bf 100644 --- a/content/influxdb/cloud/tools/client-libraries/arduino.md +++ b/content/influxdb/cloud/api-guide/client-libraries/arduino.md @@ -7,7 +7,7 @@ list_note: _– contributed by [tobiasschuerg](https://github.com/tobiasschuerg) menu: influxdb_cloud: name: Arduino - parent: Use client libraries + parent: Client libraries url: https://github.com/tobiasschuerg/InfluxDB-Client-for-Arduino weight: 201 --- diff --git a/content/influxdb/cloud/tools/client-libraries/csharp.md b/content/influxdb/cloud/api-guide/client-libraries/csharp.md similarity index 90% rename from content/influxdb/cloud/tools/client-libraries/csharp.md rename to content/influxdb/cloud/api-guide/client-libraries/csharp.md index 315118ec8..48f90a12d 100644 --- a/content/influxdb/cloud/tools/client-libraries/csharp.md +++ b/content/influxdb/cloud/api-guide/client-libraries/csharp.md @@ -6,7 +6,7 @@ external_url: https://github.com/influxdata/influxdb-client-csharp menu: influxdb_cloud: name: C# - parent: Use client libraries + parent: Client libraries url: https://github.com/influxdata/influxdb-client-csharp weight: 201 --- diff --git a/content/influxdb/cloud/tools/client-libraries/go.md b/content/influxdb/cloud/api-guide/client-libraries/go.md similarity index 85% rename from content/influxdb/cloud/tools/client-libraries/go.md rename to content/influxdb/cloud/api-guide/client-libraries/go.md index b3920aa84..dddac2dbc 100644 --- a/content/influxdb/cloud/tools/client-libraries/go.md +++ b/content/influxdb/cloud/api-guide/client-libraries/go.md @@ -7,7 +7,7 @@ description: > menu: influxdb_cloud: name: Go - parent: Use client libraries + parent: Client libraries influxdb/cloud/tags: [client libraries, Go] weight: 201 aliases: diff --git a/content/influxdb/cloud/tools/client-libraries/java.md b/content/influxdb/cloud/api-guide/client-libraries/java.md similarity index 90% rename from content/influxdb/cloud/tools/client-libraries/java.md rename to content/influxdb/cloud/api-guide/client-libraries/java.md index 327fb1756..ef96742a7 100644 --- a/content/influxdb/cloud/tools/client-libraries/java.md +++ b/content/influxdb/cloud/api-guide/client-libraries/java.md @@ -6,7 +6,7 @@ external_url: https://github.com/influxdata/influxdb-client-java menu: influxdb_cloud: name: Java - parent: Use client libraries + parent: Client libraries url: https://github.com/influxdata/influxdb-client-java weight: 201 --- diff --git a/content/influxdb/cloud/tools/client-libraries/js.md b/content/influxdb/cloud/api-guide/client-libraries/js.md similarity index 86% rename from content/influxdb/cloud/tools/client-libraries/js.md rename to content/influxdb/cloud/api-guide/client-libraries/js.md index 456d50f2b..d907f2a82 100644 --- a/content/influxdb/cloud/tools/client-libraries/js.md +++ b/content/influxdb/cloud/api-guide/client-libraries/js.md @@ -7,7 +7,7 @@ description: > menu: influxdb_cloud: name: JavaScript - parent: Use client libraries + parent: Client libraries influxdb/cloud/tags: [client libraries, JavaScript] weight: 201 aliases: diff --git a/content/influxdb/cloud/tools/client-libraries/kotlin.md b/content/influxdb/cloud/api-guide/client-libraries/kotlin.md similarity index 91% rename from content/influxdb/cloud/tools/client-libraries/kotlin.md rename to content/influxdb/cloud/api-guide/client-libraries/kotlin.md index 9e5149add..7d50fe9b7 100644 --- a/content/influxdb/cloud/tools/client-libraries/kotlin.md +++ b/content/influxdb/cloud/api-guide/client-libraries/kotlin.md @@ -6,7 +6,7 @@ external_url: https://github.com/influxdata/influxdb-client-java/tree/master/cli menu: influxdb_cloud: name: Kotlin - parent: Use client libraries + parent: Client libraries url: https://github.com/influxdata/influxdb-client-java/tree/master/client-kotlin weight: 201 --- diff --git a/content/influxdb/cloud/tools/client-libraries/php.md b/content/influxdb/cloud/api-guide/client-libraries/php.md similarity index 90% rename from content/influxdb/cloud/tools/client-libraries/php.md rename to content/influxdb/cloud/api-guide/client-libraries/php.md index 68ce52639..b29c29e2e 100644 --- a/content/influxdb/cloud/tools/client-libraries/php.md +++ b/content/influxdb/cloud/api-guide/client-libraries/php.md @@ -6,7 +6,7 @@ external_url: https://github.com/influxdata/influxdb-client-php menu: influxdb_cloud: name: PHP - parent: Use client libraries + parent: Client libraries url: https://github.com/influxdata/influxdb-client-php weight: 201 --- diff --git a/content/influxdb/cloud/tools/client-libraries/python.md b/content/influxdb/cloud/api-guide/client-libraries/python.md similarity index 87% rename from content/influxdb/cloud/tools/client-libraries/python.md rename to content/influxdb/cloud/api-guide/client-libraries/python.md index 7f0735840..240a0dfc8 100644 --- a/content/influxdb/cloud/tools/client-libraries/python.md +++ b/content/influxdb/cloud/api-guide/client-libraries/python.md @@ -6,7 +6,7 @@ description: > menu: influxdb_cloud: name: Python - parent: Use client libraries + parent: Client libraries influxdb/cloud/tags: [client libraries, python] aliases: - /influxdb/cloud/reference/api/client-libraries/python/ diff --git a/content/influxdb/cloud/tools/client-libraries/ruby.md b/content/influxdb/cloud/api-guide/client-libraries/ruby.md similarity index 90% rename from content/influxdb/cloud/tools/client-libraries/ruby.md rename to content/influxdb/cloud/api-guide/client-libraries/ruby.md index 454cc9aac..544c34953 100644 --- a/content/influxdb/cloud/tools/client-libraries/ruby.md +++ b/content/influxdb/cloud/api-guide/client-libraries/ruby.md @@ -6,7 +6,7 @@ external_url: https://github.com/influxdata/influxdb-client-ruby menu: influxdb_cloud: name: Ruby - parent: Use client libraries + parent: Client libraries url: https://github.com/influxdata/influxdb-client-ruby weight: 201 --- diff --git a/content/influxdb/cloud/tools/client-libraries/scala.md b/content/influxdb/cloud/api-guide/client-libraries/scala.md similarity index 91% rename from content/influxdb/cloud/tools/client-libraries/scala.md rename to content/influxdb/cloud/api-guide/client-libraries/scala.md index 89872b574..bc3a931b7 100644 --- a/content/influxdb/cloud/tools/client-libraries/scala.md +++ b/content/influxdb/cloud/api-guide/client-libraries/scala.md @@ -6,7 +6,7 @@ external_url: https://github.com/influxdata/influxdb-client-java/tree/master/cli menu: influxdb_cloud: name: Scala - parent: Use client libraries + parent: Client libraries url: https://github.com/influxdata/influxdb-client-java/tree/master/client-scala weight: 201 --- diff --git a/content/influxdb/cloud/tools/client-libraries/swift.md b/content/influxdb/cloud/api-guide/client-libraries/swift.md similarity index 90% rename from content/influxdb/cloud/tools/client-libraries/swift.md rename to content/influxdb/cloud/api-guide/client-libraries/swift.md index 9f94f5265..3a1997ff6 100644 --- a/content/influxdb/cloud/tools/client-libraries/swift.md +++ b/content/influxdb/cloud/api-guide/client-libraries/swift.md @@ -6,7 +6,7 @@ external_url: https://github.com/influxdata/influxdb-client-swift menu: influxdb_cloud: name: Swift - parent: Use client libraries + parent: Client libraries url: https://github.com/influxdata/influxdb-client-swift weight: 201 --- diff --git a/content/influxdb/cloud/tools/postman.md b/content/influxdb/cloud/api-guide/postman.md similarity index 100% rename from content/influxdb/cloud/tools/postman.md rename to content/influxdb/cloud/api-guide/postman.md diff --git a/content/influxdb/cloud/reference/api/_index.md b/content/influxdb/cloud/reference/api/_index.md index d10cf0905..a94b4a1f7 100644 --- a/content/influxdb/cloud/reference/api/_index.md +++ b/content/influxdb/cloud/reference/api/_index.md @@ -11,6 +11,10 @@ influxdb/cloud/tags: [api] The InfluxDB v2 API provides a programmatic interface for interactions with InfluxDB. Access the InfluxDB API using the `/api/v2/` endpoint. +## InfluxDB client libraries +InfluxDB client libraries are language-specific packages that integrate with the InfluxDB v2 API. +For information about supported client libraries, see [InfluxDB client libraries](/influxdb/cloud/tools/client-libraries/). + ## InfluxDB Cloud API documentation InfluxDB Cloud API documentation @@ -20,7 +24,3 @@ that work with InfluxDB 1.x client libraries and third-party integrations like [Grafana](https://grafana.com) and others. View full v1 compatibility API documentation - -## InfluxDB client libraries -InfluxDB client libraries are language-specific packages that integrate with the InfluxDB v2 API. -For information about supported client libraries, see [InfluxDB client libraries](/influxdb/cloud/tools/client-libraries/). diff --git a/content/influxdb/cloud/tools/api/_index.md b/content/influxdb/cloud/tools/api/_index.md deleted file mode 100644 index b82cd2778..000000000 --- a/content/influxdb/cloud/tools/api/_index.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Working with the InfluxDB API -seotitle: Use the InfluxDB API -description: Interact with InfluxDB using a rich API for writing and querying data and more. -weight: 103 -menu: - influxdb_cloud: - name: Working with the API - parent: Tools & integrations ---- - -{{< duplicate-oss >}} diff --git a/content/influxdb/cloud/tools/client-libraries/_index.md b/content/influxdb/cloud/tools/client-libraries/_index.md deleted file mode 100644 index 9faa81639..000000000 --- a/content/influxdb/cloud/tools/client-libraries/_index.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: Use InfluxDB client libraries -description: > - InfluxDB client libraries are language-specific tools that integrate with the InfluxDB v2 API. - View the list of available client libraries. -weight: 101 -aliases: - - /influxdb/cloud/reference/client-libraries/ - - /influxdb/cloud/reference/api/client-libraries/ -menu: - influxdb_cloud: - name: Use client libraries - parent: Tools & integrations -influxdb/cloud/tags: [client libraries] ---- - -{{< duplicate-oss >}} diff --git a/content/influxdb/cloud/write-data/developer-tools/api.md b/content/influxdb/cloud/write-data/developer-tools/api.md index 1bd1f34d0..a6257e97d 100644 --- a/content/influxdb/cloud/write-data/developer-tools/api.md +++ b/content/influxdb/cloud/write-data/developer-tools/api.md @@ -7,6 +7,8 @@ menu: influxdb_cloud: name: InfluxDB API parent: Developer tools + name: Write data + parent: Javascript --- Write data to InfluxDB using an HTTP request to the InfluxDB API `/write` endpoint. Use the `POST` request method and include the following in your request: diff --git a/content/influxdb/v2.0/api-guide/_index.md b/content/influxdb/v2.0/api-guide/_index.md index 1f01714fd..c778db2f1 100644 --- a/content/influxdb/v2.0/api-guide/_index.md +++ b/content/influxdb/v2.0/api-guide/_index.md @@ -6,45 +6,28 @@ weight: 3 menu: influxdb_2_0: name: Develop with the API +influxdb/v2.0/tags: [api] --- -InfluxDB offers a rich API and [client libraries](/influxdb/v2.0/api/client-libraries) ready to integrate with your application. -This section will guide you through the most commonly used API methods. +The InfluxDB v2 API provides a programmatic interface for interactions with InfluxDB. +Access the InfluxDB API using the `/api/v2/` endpoint. -For detailed documentation on the entire API, see [InfluxDBv2 API Reference](/influxdb/v2.0/reference/api/#influxdb-v2-api-documentation). +## InfluxDB client libraries +InfluxDB client libraries are language-specific packages that integrate with the InfluxDB v2 API. +For information about supported client libraries, see [InfluxDB client libraries](/influxdb/v2.0/tools/client-libraries/). -{{% note %}} -If you are interacting with InfluxDB 1.x, see the [1.x compatibility API](/influxdb/v2.0/reference/api/influxdb-1x/). -{{% /note %}} +## InfluxDB v2 API documentation +InfluxDB OSS 2.0 API documentation -## Bootstrap your application +#### View InfluxDB API documentation locally +InfluxDB API documentation is built into the `influxd` service and represents +the API specific to the current version of InfluxDB. +To view the API documentation locally, [start InfluxDB](/influxdb/v2.0/get-started/#start-influxdb) +and visit the `/docs` endpoint in a browser ([localhost:8086/docs](http://localhost:8086/docs)). -With most API requests, you'll need to provide a minimum of your InfluxDB URL, Organization, and Authorization Token. +## InfluxDB v1 compatibility API documentation +The InfluxDB v2 API includes [InfluxDB 1.x compatibility endpoints](/influxdb/v2.0/reference/api/influxdb-1x/) +that work with InfluxDB 1.x client libraries and third-party integrations like +[Grafana](https://grafana.com) and others. -[Install InfluxDB OSS v2.x](/influxdb/v2.0/install/) or upgrade to -an [InfluxDB Cloud account](/influxdb/cloud/sign-up). - -### Authentication - -Before diving into the API, use the InfluxDB UI to -[create an initial authentication token](/influxdb/v2.0/security/tokens/create-token/) for your application. - -InfluxDB uses [authentication tokens](/influxdb/cloud/security/tokens/) to authorize API requests. -Include your authentication token as an `Authorization` header in each request. - -```sh -{{% api/curl/auth %}} -``` - -## Bucket API - -Before writing data you'll need to create a Bucket in InfluxDB. -[Create a bucket](/influxdb/v2.0/buckets/developer-tools/api/) using an HTTP request to the InfluxDB API `bucket` endpoint. - -## Write API - -[Write data to InfluxDB](/influxdb/v2.0/write-data/developer-tools/api/) using an HTTP request to the InfluxDB API `/write` endpoint. - -## Query API - -[Query from InfluxDB](/influxdb/v2.0/query-data/execute-queries/influx-api/) using an HTTP request to the `/query` endpoint. +View full v1 compatibility API documentation diff --git a/content/influxdb/v2.0/api-guide/api_intro.md b/content/influxdb/v2.0/api-guide/api_intro.md new file mode 100644 index 000000000..3ed861fc3 --- /dev/null +++ b/content/influxdb/v2.0/api-guide/api_intro.md @@ -0,0 +1,57 @@ +--- +title: API Quick Start +seotitle: Use the InfluxDB API +description: Interact with InfluxDB 2.0 using a rich API for writing and querying data and more. +weight: 3 +menu: + influxdb_2_0: + name: Quick Start + parent: Develop with the API +--- + +InfluxDB offers a rich API and [client libraries](/influxdb/v2.0/api-guide/client-libraries) ready to integrate with your application. Use popular tools like Curl and [Postman](/influxdb/v2.0/api-guide/postman) for rapidly testing API requests. + +This section will guide you through the most commonly used API methods. + +For detailed documentation on the entire API, see [InfluxDBv2 API Reference](/influxdb/v2.0/reference/api/#influxdb-v2-api-documentation). + +{{% note %}} +If you are interacting with InfluxDB 1.x, see the [1.x compatibility API](/influxdb/v2.0/reference/api/influxdb-1x/). +{{% /note %}} + +## Bootstrap your application + +With most API requests, you'll need to provide a minimum of your InfluxDB URL, Organization, and Authorization Token. + +[Install InfluxDB OSS v2.x](/influxdb/v2.0/install/) or upgrade to +an [InfluxDB Cloud account](/influxdb/cloud/sign-up). + +### Authentication + +Before diving into the API, use the InfluxDB UI to +[create an initial authentication token](/influxdb/v2.0/security/tokens/create-token/) for your application. + +InfluxDB uses [authentication tokens](/influxdb/v2.0/security/tokens/) to authorize API requests. +Include your authentication token as an `Authorization` header in each request. + +```sh +curl --request POST http://localhost:8086/api/v2/write \ + --header "Authorization: Token YOURAUTHTOKEN" \ + --data-urlencode "org=myorg" \ + --data-urlencode "bucket=example-bucket" +``` + +Postman is another popular tool for exploring APIs. See how to [send authenticated requests with Postman](/{{< latest "influxdb" >}}/api-guide/postman/#send-authenticated-api-requests-with-postman). + +## Bucket API + +Before writing data you'll need to create a Bucket in InfluxDB. +[Create a bucket](/influxdb/v2.0/buckets/developer-tools/api/) using an HTTP request to the InfluxDB API `bucket` endpoint. + +## Write API + +[Write data to InfluxDB](/influxdb/v2.0/write-data/developer-tools/api/) using an HTTP request to the InfluxDB API `/write` endpoint. + +## Query API + +[Query from InfluxDB](/influxdb/v2.0/query-data/execute-queries/influx-api/) using an HTTP request to the `/query` endpoint. diff --git a/content/influxdb/v2.0/api-guide/client-libraries/_index.md b/content/influxdb/v2.0/api-guide/client-libraries/_index.md index 370fe80cf..877714882 100644 --- a/content/influxdb/v2.0/api-guide/client-libraries/_index.md +++ b/content/influxdb/v2.0/api-guide/client-libraries/_index.md @@ -9,7 +9,7 @@ aliases: - /influxdb/v2.0/reference/api/client-libraries/ menu: influxdb_2_0: - name: Use client libraries + name: Client libraries parent: Develop with the API influxdb/v2.0/tags: [client libraries] --- diff --git a/content/influxdb/v2.0/api-guide/client-libraries/arduino.md b/content/influxdb/v2.0/api-guide/client-libraries/arduino.md index f88b0df9d..8945805bb 100644 --- a/content/influxdb/v2.0/api-guide/client-libraries/arduino.md +++ b/content/influxdb/v2.0/api-guide/client-libraries/arduino.md @@ -7,7 +7,7 @@ list_note: _– contributed by [tobiasschuerg](https://github.com/tobiasschuerg) menu: influxdb_2_0: name: Arduino - parent: Use client libraries + parent: Client libraries url: https://github.com/tobiasschuerg/InfluxDB-Client-for-Arduino weight: 201 --- diff --git a/content/influxdb/v2.0/api-guide/client-libraries/csharp.md b/content/influxdb/v2.0/api-guide/client-libraries/csharp.md index 73ffb81f9..8eb90a7cb 100644 --- a/content/influxdb/v2.0/api-guide/client-libraries/csharp.md +++ b/content/influxdb/v2.0/api-guide/client-libraries/csharp.md @@ -6,7 +6,7 @@ external_url: https://github.com/influxdata/influxdb-client-csharp menu: influxdb_2_0: name: C# - parent: Use client libraries + parent: Client libraries url: https://github.com/influxdata/influxdb-client-csharp weight: 201 --- diff --git a/content/influxdb/v2.0/api-guide/client-libraries/go.md b/content/influxdb/v2.0/api-guide/client-libraries/go.md index c06200711..3f12ef026 100644 --- a/content/influxdb/v2.0/api-guide/client-libraries/go.md +++ b/content/influxdb/v2.0/api-guide/client-libraries/go.md @@ -7,7 +7,7 @@ description: > menu: influxdb_2_0: name: Go - parent: Use client libraries + parent: Client libraries influxdb/v2.0/tags: [client libraries, Go] weight: 201 aliases: diff --git a/content/influxdb/v2.0/api-guide/client-libraries/java.md b/content/influxdb/v2.0/api-guide/client-libraries/java.md index 8a17da6a6..01e67b67a 100644 --- a/content/influxdb/v2.0/api-guide/client-libraries/java.md +++ b/content/influxdb/v2.0/api-guide/client-libraries/java.md @@ -6,7 +6,7 @@ external_url: https://github.com/influxdata/influxdb-client-java menu: influxdb_2_0: name: Java - parent: Use client libraries + parent: Client libraries url: https://github.com/influxdata/influxdb-client-java weight: 201 --- diff --git a/content/influxdb/v2.0/api-guide/client-libraries/js.md b/content/influxdb/v2.0/api-guide/client-libraries/js-browser.md similarity index 97% rename from content/influxdb/v2.0/api-guide/client-libraries/js.md rename to content/influxdb/v2.0/api-guide/client-libraries/js-browser.md index 67c0541a4..b61ff0984 100644 --- a/content/influxdb/v2.0/api-guide/client-libraries/js.md +++ b/content/influxdb/v2.0/api-guide/client-libraries/js-browser.md @@ -3,11 +3,11 @@ title: JavaScript client library seotitle: InfluxDB JavaScript client library list_title: JavaScript description: > - Use the JavaScript client library to interact with InfluxDB. + Use the JavaScript client library for web browsers to interact with InfluxDB. menu: influxdb_2_0: - name: JavaScript - parent: Use client libraries + name: Javascript (Browser) + parent: Client libraries influxdb/v2.0/tags: [client libraries, JavaScript] weight: 201 aliases: @@ -79,7 +79,7 @@ Use the Javascript library to write data to InfluxDB in a Node.js environment. ```js import {InfluxDB, Point} from '@influxdata/influxdb-client' - + const influxDB = new InfluxDB({url, token}) const writeApi = influxDB.getWriteApi(org, bucket) ``` diff --git a/content/influxdb/v2.0/tools/client-libraries/js.md b/content/influxdb/v2.0/api-guide/client-libraries/js/_index.md similarity index 63% rename from content/influxdb/v2.0/tools/client-libraries/js.md rename to content/influxdb/v2.0/api-guide/client-libraries/js/_index.md index 67c0541a4..1e21f051d 100644 --- a/content/influxdb/v2.0/tools/client-libraries/js.md +++ b/content/influxdb/v2.0/api-guide/client-libraries/js/_index.md @@ -3,83 +3,79 @@ title: JavaScript client library seotitle: InfluxDB JavaScript client library list_title: JavaScript description: > - Use the JavaScript client library to interact with InfluxDB. + Use the Node.js JavaScript client library to interact with InfluxDB. menu: influxdb_2_0: - name: JavaScript - parent: Use client libraries + name: Node.js + parent: Client libraries influxdb/v2.0/tags: [client libraries, JavaScript] weight: 201 aliases: - /influxdb/v2.0/reference/api/client-libraries/js/ --- -Use the [InfluxDB JavaScript client library](https://github.com/influxdata/influxdb-client-js) to integrate InfluxDB into JavaScript scripts and applications. This client supports both client-side (browser) and server-side (NodeJS) environments. +Use the [InfluxDB JavaScript client library](https://github.com/influxdata/influxdb-client-js) to integrate InfluxDB into your Node.js application. -This guide presumes some familiarity with JavaScript, browser environments, and InfluxDB. -If just getting started, see [Get started with InfluxDB](/influxdb/v2.0/get-started/). +In this guide, you'll start a Node.js project from scratch and code some simple API operations. See the [client repo](https://github.com/influxdata/influxdb-client-js) for more [complete examples](https://github.com/influxdata/influxdb-client-js/tree/master/examples). -## Before you begin +## Install -1. Install [NodeJS](https://nodejs.org/en/download/package-manager/). +1. Install [Node.js](https://nodejs.org/en/download/package-manager/). 2. Ensure that InfluxDB is running and you can connect to it. For information about what URL to use to connect to InfluxDB OSS or InfluxDB Cloud, see [InfluxDB URLs](/influxdb/v2.0/reference/urls/). -## Easiest way to get started -1. Clone the [examples directory](https://github.com/influxdata/influxdb-client-js/tree/master/examples) in the [influxdb-client-js](https://github.com/influxdata/influxdb-client-js) repo. -2. Navigate to the `examples` directory: +3. Start a new Node.js project: - ```js - cd examples - ``` -3. Install `yarn` or `npm` dependencies as needed: - -```js - yarn install - npm install -``` - -3. Update your `./env` and `index.html` with the name of your InfluxDB [bucket](/influxdb/v2.0/organizations/buckets/), [organization](/influxdb/v2.0/organizations/), [token](/influxdb/v2.0/security/tokens/), and `proxy` which relies upon proxy to forward requests to the target InfluxDB. -4. Run the following command to run the application at [http://localhost:3001/examples/index.html]() - - ```sh - npm run browser - ``` - -## Boilerplate for the InfluxDB Javascript client library -Use the Javascript library to write data to and query data from InfluxDB in a browser. - -1. To write a data point to InfluxDB using the JavaScript library, import the latest InfluxDB Javascript library in your script. - - ```js - import {InfluxDB, Point} from 'https://unpkg.com/@influxdata/influxdb-client/dist/index.browser.mjs' + ```sh + npm init influx-node-app ``` -2. Define constants for your InfluxDB [bucket](/influxdb/v2.0/organizations/buckets/), [organization](/influxdb/v2.0/organizations/), [token](/influxdb/v2.0/security/tokens/), and `proxy` which relies on a proxy to forward requests to the target InfluxDB instance. + Answer or `Enter` through the prompts. - ```js - const proxy = '/influx' - const token = 'example-token' - const org = 'example-org' - const bucket = 'example-bucket' +## Install dependencies +The JavaScript client contains two packages. Add both as dependencies of your project. + +{{% note %}} +`npm` package manager is included with Node.js. +{{% /note %}} + +1. Change to your project directory: + + ```sh + cd influx-node-app ``` -3. Instantiate the InfluxDB JavaScript client and pass in the `proxy` and `token` parameters. +2. Install `@influxdata/influxdb-client` for querying and writing data: - ```js - const influxDB = new InfluxDB({proxy, token}) + ```sh + npm install --save @influxdata/influxdb-client ``` +3. Install `@influxdata/influxdb-client-apis` for access to the InfluxDB management APIs: + + ```sh + npm install --save @influxdata/influxdb-client-apis + ``` + + + +## Configure your environment +1. Configure environment variables. Update your `./env` with the name of your InfluxDB [bucket](/influxdb/v2.0/organizations/buckets/), [organization](/influxdb/v2.0/organizations/), [token](/influxdb/v2.0/security/tokens/), and [url](/influxdb/v2.0/urls). + ## Write data to InfluxDB with JavaScript Use the Javascript library to write data to InfluxDB in a Node.js environment. +{{% note %}} +This library supports browser and server-side (Node.js) Javascript environments. Use `@influxdata/influxdb-client` in your Node.js project. +{{% /note %}} + 1. Instantiate an `InfluxDB` client. Provide your InfluxDB `url` and `token`. 2. Use the `getWriteApi` method of the instantiated InfluxDB client to create a **write client**. Provide your InfluxDB `org` and `bucket`. ```js import {InfluxDB, Point} from '@influxdata/influxdb-client' - + const influxDB = new InfluxDB({url, token}) const writeApi = influxDB.getWriteApi(org, bucket) ``` diff --git a/content/influxdb/v2.0/api-guide/client-libraries/kotlin.md b/content/influxdb/v2.0/api-guide/client-libraries/kotlin.md index 026892ddb..8337421c9 100644 --- a/content/influxdb/v2.0/api-guide/client-libraries/kotlin.md +++ b/content/influxdb/v2.0/api-guide/client-libraries/kotlin.md @@ -6,7 +6,7 @@ external_url: https://github.com/influxdata/influxdb-client-java/tree/master/cli menu: influxdb_2_0: name: Kotlin - parent: Use client libraries + parent: Client libraries url: https://github.com/influxdata/influxdb-client-java/tree/master/client-kotlin weight: 201 --- diff --git a/content/influxdb/v2.0/api-guide/client-libraries/php.md b/content/influxdb/v2.0/api-guide/client-libraries/php.md index 44ef25ce3..ae5d9f03c 100644 --- a/content/influxdb/v2.0/api-guide/client-libraries/php.md +++ b/content/influxdb/v2.0/api-guide/client-libraries/php.md @@ -6,7 +6,7 @@ external_url: https://github.com/influxdata/influxdb-client-php menu: influxdb_2_0: name: PHP - parent: Use client libraries + parent: Client libraries url: https://github.com/influxdata/influxdb-client-php weight: 201 --- diff --git a/content/influxdb/v2.0/api-guide/client-libraries/python.md b/content/influxdb/v2.0/api-guide/client-libraries/python.md index 1e1c48dcb..6f6e541b1 100644 --- a/content/influxdb/v2.0/api-guide/client-libraries/python.md +++ b/content/influxdb/v2.0/api-guide/client-libraries/python.md @@ -6,7 +6,7 @@ description: > menu: influxdb_2_0: name: Python - parent: Use client libraries + parent: Client libraries influxdb/v2.0/tags: [client libraries, python] aliases: - /influxdb/v2.0/reference/api/client-libraries/python/ diff --git a/content/influxdb/v2.0/api-guide/client-libraries/ruby.md b/content/influxdb/v2.0/api-guide/client-libraries/ruby.md index 11daa6e04..eefd98d84 100644 --- a/content/influxdb/v2.0/api-guide/client-libraries/ruby.md +++ b/content/influxdb/v2.0/api-guide/client-libraries/ruby.md @@ -6,7 +6,7 @@ external_url: https://github.com/influxdata/influxdb-client-ruby menu: influxdb_2_0: name: Ruby - parent: Use client libraries + parent: Client libraries url: https://github.com/influxdata/influxdb-client-ruby weight: 201 --- diff --git a/content/influxdb/v2.0/api-guide/client-libraries/scala.md b/content/influxdb/v2.0/api-guide/client-libraries/scala.md index a49e0ffc0..150c124fe 100644 --- a/content/influxdb/v2.0/api-guide/client-libraries/scala.md +++ b/content/influxdb/v2.0/api-guide/client-libraries/scala.md @@ -6,7 +6,7 @@ external_url: https://github.com/influxdata/influxdb-client-java/tree/master/cli menu: influxdb_2_0: name: Scala - parent: Use client libraries + parent: Client libraries url: https://github.com/influxdata/influxdb-client-java/tree/master/client-scala weight: 201 --- diff --git a/content/influxdb/v2.0/api-guide/client-libraries/swift.md b/content/influxdb/v2.0/api-guide/client-libraries/swift.md index c046356be..72a0f27d3 100644 --- a/content/influxdb/v2.0/api-guide/client-libraries/swift.md +++ b/content/influxdb/v2.0/api-guide/client-libraries/swift.md @@ -6,7 +6,7 @@ external_url: https://github.com/influxdata/influxdb-client-swift menu: influxdb_2_0: name: Swift - parent: Use client libraries + parent: Client libraries url: https://github.com/influxdata/influxdb-client-swift weight: 201 --- diff --git a/content/influxdb/v2.0/tools/postman.md b/content/influxdb/v2.0/api-guide/postman.md similarity index 100% rename from content/influxdb/v2.0/tools/postman.md rename to content/influxdb/v2.0/api-guide/postman.md diff --git a/content/influxdb/v2.0/reference/api/_index.md b/content/influxdb/v2.0/reference/api/_index.md index d99f44cf6..32ad601f8 100644 --- a/content/influxdb/v2.0/reference/api/_index.md +++ b/content/influxdb/v2.0/reference/api/_index.md @@ -13,17 +13,6 @@ aliases: The InfluxDB v2 API provides a programmatic interface for interactions with InfluxDB. Access the InfluxDB API using the `/api/v2/` endpoint. -## Authentication -InfluxDB uses [authentication tokens](/influxdb/v2.0/security/tokens/) to authorize API requests. -Include your authentication token as an `Authorization` header in each request. - -```sh -curl --request POST http://localhost:8086/api/v2/write \ - --header "Authorization: Token YOURAUTHTOKEN" \ - --data-urlencode "org=myorg" \ - --data-urlencode "bucket=example-bucket" -``` - ## InfluxDB v2 API documentation InfluxDB OSS 2.0 API documentation @@ -39,7 +28,3 @@ that work with InfluxDB 1.x client libraries and third-party integrations like [Grafana](https://grafana.com) and others. View full v1 compatibility API documentation - -## InfluxDB client libraries -InfluxDB client libraries are language-specific packages that integrate with the InfluxDB v2 API. -For information about supported client libraries, see [InfluxDB client libraries](/influxdb/v2.0/tools/client-libraries/). diff --git a/content/influxdb/v2.0/tools/api/_index.md b/content/influxdb/v2.0/tools/api/_index.md deleted file mode 100644 index 9d90fc6ec..000000000 --- a/content/influxdb/v2.0/tools/api/_index.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: Working with the InfluxDB API -seotitle: Use the InfluxDB API -description: Interact with InfluxDB 2.0 using a rich API for writing and querying data and more. -weight: 103 -menu: - influxdb_2_0: - name: Working with the API - parent: Tools & integrations ---- - -InfluxDB offers a rich API that you can use to create applications. -The following pages offer general guides to the most commonly used API methods. - -For detailed documentation on the entire API, see [InfluxDBv2 API Documentation](/influxdb/v2.0/reference/api/#influxdb-v2-api-documentation). - -{{% note %}} -If you are interacting with InfluxDB 1.x, see the [1.x compatibility API](/influxdb/v2.0/reference/api/influxdb-1x/). -{{% /note %}} - -Use the following API endpoints to write and query data: - -## Write API - -[Write data to InfluxDB](/influxdb/v2.0/write-data/developer-tools/api/) using an HTTP request to the InfluxDB API `/write` endpoint. - -## Query API - -[Query from InfluxDB](/influxdb/v2.0/query-data/execute-queries/influx-api/) using an HTTP request to the `/query` endpoint. diff --git a/content/influxdb/v2.0/tools/client-libraries/_index.md b/content/influxdb/v2.0/tools/client-libraries/_index.md deleted file mode 100644 index 938b7273a..000000000 --- a/content/influxdb/v2.0/tools/client-libraries/_index.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: Use InfluxDB client libraries -description: > - InfluxDB client libraries are language-specific tools that integrate with the InfluxDB v2 API. - View the list of available client libraries. -weight: 101 -aliases: - - /influxdb/v2.0/reference/client-libraries/ - - /influxdb/v2.0/reference/api/client-libraries/ -menu: - influxdb_2_0: - name: Use client libraries - parent: Tools & integrations -influxdb/v2.0/tags: [client libraries] ---- - -InfluxDB client libraries are language-specific packages that integrate with the InfluxDB v2 API. -The following **InfluxDB v2** client libraries are available: - -{{% note %}} -These client libraries are in active development and may not be feature-complete. -This list will continue to grow as more client libraries are released. -{{% /note %}} - -{{< children type="list" >}} diff --git a/content/influxdb/v2.0/tools/client-libraries/arduino.md b/content/influxdb/v2.0/tools/client-libraries/arduino.md deleted file mode 100644 index f88b0df9d..000000000 --- a/content/influxdb/v2.0/tools/client-libraries/arduino.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: InfluxDB Arduino client library -list_title: Arduino -description: Use the Arduino client library to interact with InfluxDB. -external_url: https://github.com/tobiasschuerg/InfluxDB-Client-for-Arduino -list_note: _– contributed by [tobiasschuerg](https://github.com/tobiasschuerg)_ -menu: - influxdb_2_0: - name: Arduino - parent: Use client libraries - url: https://github.com/tobiasschuerg/InfluxDB-Client-for-Arduino -weight: 201 ---- diff --git a/content/influxdb/v2.0/tools/client-libraries/csharp.md b/content/influxdb/v2.0/tools/client-libraries/csharp.md deleted file mode 100644 index 73ffb81f9..000000000 --- a/content/influxdb/v2.0/tools/client-libraries/csharp.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: InfluxDB C# client library -list_title: C# -description: Use the C# client library to interact with InfluxDB. -external_url: https://github.com/influxdata/influxdb-client-csharp -menu: - influxdb_2_0: - name: C# - parent: Use client libraries - url: https://github.com/influxdata/influxdb-client-csharp -weight: 201 ---- diff --git a/content/influxdb/v2.0/tools/client-libraries/go.md b/content/influxdb/v2.0/tools/client-libraries/go.md deleted file mode 100644 index c06200711..000000000 --- a/content/influxdb/v2.0/tools/client-libraries/go.md +++ /dev/null @@ -1,205 +0,0 @@ ---- -title: Go client library -seotitle: InfluxDB Go client library -list_title: Go -description: > - Use the Go client library to interact with InfluxDB. -menu: - influxdb_2_0: - name: Go - parent: Use client libraries -influxdb/v2.0/tags: [client libraries, Go] -weight: 201 -aliases: - - /influxdb/v2.0/reference/api/client-libraries/go/ ---- - -Use the [InfluxDB Go client library](https://github.com/influxdata/influxdb-client-go) to integrate InfluxDB into Go scripts and applications. - -This guide presumes some familiarity with Go and InfluxDB. -If just getting started, see [Get started with InfluxDB](/influxdb/v2.0/get-started/). - -## Before you begin - -1. [Install Go 1.13 or later](https://golang.org/doc/install). -2. Add the client package your to your project dependencies. - - ```sh - # Add InfluxDB Go client package to your project go.mod - go get github.com/influxdata/influxdb-client-go - ``` -3. Ensure that InfluxDB is running and you can connect to it. - For information about what URL to use to connect to InfluxDB OSS or InfluxDB Cloud, see [InfluxDB URLs](/influxdb/v2.0/reference/urls/). - -## Boilerplate for the InfluxDB Go Client Library - -Use the Go library to write and query data from InfluxDB. - -1. In your Go program, import the necessary packages and specify the entry point of your executable program. - - ```go - package main - - import ( - "context" - "fmt" - "time" - - "github.com/influxdata/influxdb-client-go/v2" - ) - ``` - -2. Define variables for your InfluxDB [bucket](/influxdb/v2.0/organizations/buckets/), [organization](/influxdb/v2.0/organizations/), and [token](/influxdb/v2.0/security/tokens/). - - ```go - bucket := "example-bucket" - org := "example-org" - token := "example-token" - // Store the URL of your InfluxDB instance - url := "http://localhost:8086" - ``` - -3. Create the the InfluxDB Go client and pass in the `url` and `token` parameters. - - ```go - client := influxdb2.NewClient(url, token) - ``` - -4. Create a **write client** with the `WriteAPIBlocking` method and pass in the `org` and `bucket` parameters. - - ```go - writeAPI := client.WriteAPIBlocking(org, bucket) - ``` - -5. To query data, create an InfluxDB **query client** and pass in your InfluxDB `org`. - - ```go - queryAPI := client.QueryAPI(org) - ``` - -## Write data to InfluxDB with Go - -Use the Go library to write data to InfluxDB. - -1. Create a [point](/influxdb/v2.0/reference/glossary/#point) and write it to InfluxDB using the `WritePoint` method of the API writer struct. - -2. Close the client to flush all pending writes and finish. - - ```go - p := influxdb2.NewPoint("stat", - map[string]string{"unit": "temperature"}, - map[string]interface{}{"avg": 24.5, "max": 45}, - time.Now()) - writeAPI.WritePoint(context.Background(), p) - client.Close() - ``` - -### Complete example write script - -```go -func main() { - bucket := "example-bucket" - org := "example-org" - token := "example-token" - // Store the URL of your InfluxDB instance - url := "http://localhost:8086" - // Create new client with default option for server url authenticate by token - client := influxdb2.NewClient(url, token) - // User blocking write client for writes to desired bucket - writeAPI := client.WriteAPIBlocking(org, bucket) - // Create point using full params constructor - p := influxdb2.NewPoint("stat", - map[string]string{"unit": "temperature"}, - map[string]interface{}{"avg": 24.5, "max": 45}, - time.Now()) - // Write point immediately - writeAPI.WritePoint(context.Background(), p) - // Ensures background processes finishes - client.Close() -} -``` -## Query data from InfluxDB with Go -Use the Go library to query data to InfluxDB. - -1. Create a Flux query and supply your `bucket` parameter. - - ```js - from(bucket:"") - |> range(start: -1h) - |> filter(fn: (r) => r._measurement == "stat") - ``` - - The query client sends the Flux query to InfluxDB and returns the results as a FluxRecord object with a table structure. - -**The query client includes the following methods:** - -- `Query`: Sends the Flux query to InfluxDB. -- `Next`: Iterates over the query response. -- `TableChanged`: Identifies when the group key changes. -- `Record`: Returns the last parsed FluxRecord and gives access to value and row properties. -- `Value`: Returns the actual field value. - -```go -result, err := queryAPI.Query(context.Background(), `from(bucket:"") - |> range(start: -1h) - |> filter(fn: (r) => r._measurement == "stat")`) -if err == nil { - for result.Next() { - if result.TableChanged() { - fmt.Printf("table: %s\n", result.TableMetadata().String()) - } - fmt.Printf("value: %v\n", result.Record().Value()) - } - if result.Err() != nil { - fmt.Printf("query parsing error: %s\n", result.Err().Error()) - } -} else { - panic(err) -} -``` - -**The FluxRecord object includes the following methods for accessing your data:** - -- `Table()`: Returns the index of the table the record belongs to. -- `Start()`: Returns the inclusive lower time bound of all records in the current table. -- `Stop()`: Returns the exclusive upper time bound of all records in the current table. -- `Time()`: Returns the time of the record. -- `Value() `: Returns the actual field value. -- `Field()`: Returns the field name. -- `Measurement()`: Returns the measurement name of the record. -- `Values()`: Returns a map of column values. -- `ValueByKey()`: Returns a value from the record for given column key. - -### Complete example query script - -```go - func main() { - // Create client - client := influxdb2.NewClient(url, token) - // Get query client - queryAPI := client.QueryAPI(org) - // Get QueryTableResult - result, err := queryAPI.Query(context.Background(), `from(bucket:"my-bucket")|> range(start: -1h) |> filter(fn: (r) => r._measurement == "stat")`) - if err == nil { - // Iterate over query response - for result.Next() { - // Notice when group key has changed - if result.TableChanged() { - fmt.Printf("table: %s\n", result.TableMetadata().String()) - } - // Access data - fmt.Printf("value: %v\n", result.Record().Value()) - } - // Check for an error - if result.Err() != nil { - fmt.Printf("query parsing error: %s\n", result.Err().Error()) - } - } else { - panic(err) - } - // Ensures background processes finishes - client.Close() -} -``` - -For more information, see the [Go client README on GitHub](https://github.com/influxdata/influxdb-client-go). diff --git a/content/influxdb/v2.0/tools/client-libraries/java.md b/content/influxdb/v2.0/tools/client-libraries/java.md deleted file mode 100644 index 8a17da6a6..000000000 --- a/content/influxdb/v2.0/tools/client-libraries/java.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: InfluxDB Java client library -list_title: Java -description: Use the Java client library to interact with InfluxDB. -external_url: https://github.com/influxdata/influxdb-client-java -menu: - influxdb_2_0: - name: Java - parent: Use client libraries - url: https://github.com/influxdata/influxdb-client-java -weight: 201 ---- diff --git a/content/influxdb/v2.0/tools/client-libraries/kotlin.md b/content/influxdb/v2.0/tools/client-libraries/kotlin.md deleted file mode 100644 index 026892ddb..000000000 --- a/content/influxdb/v2.0/tools/client-libraries/kotlin.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: InfluxDB Kotlin client library -list_title: Kotlin -description: Use the Kotlin client library to interact with InfluxDB. -external_url: https://github.com/influxdata/influxdb-client-java/tree/master/client-kotlin -menu: - influxdb_2_0: - name: Kotlin - parent: Use client libraries - url: https://github.com/influxdata/influxdb-client-java/tree/master/client-kotlin -weight: 201 ---- diff --git a/content/influxdb/v2.0/tools/client-libraries/php.md b/content/influxdb/v2.0/tools/client-libraries/php.md deleted file mode 100644 index 44ef25ce3..000000000 --- a/content/influxdb/v2.0/tools/client-libraries/php.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: InfluxDB PHP client library -list_title: PHP -description: Use the PHP client library to interact with InfluxDB. -external_url: https://github.com/influxdata/influxdb-client-php -menu: - influxdb_2_0: - name: PHP - parent: Use client libraries - url: https://github.com/influxdata/influxdb-client-php -weight: 201 ---- diff --git a/content/influxdb/v2.0/tools/client-libraries/python.md b/content/influxdb/v2.0/tools/client-libraries/python.md deleted file mode 100644 index 1e1c48dcb..000000000 --- a/content/influxdb/v2.0/tools/client-libraries/python.md +++ /dev/null @@ -1,174 +0,0 @@ ---- -title: Python client library -list_title: Python -description: > - Use the Python client library to interact with InfluxDB. -menu: - influxdb_2_0: - name: Python - parent: Use client libraries -influxdb/v2.0/tags: [client libraries, python] -aliases: - - /influxdb/v2.0/reference/api/client-libraries/python/ - - /influxdb/v2.0/reference/api/client-libraries/python-cl-guide/ -weight: 201 ---- - -Use the [InfluxDB Python client library](https://github.com/influxdata/influxdb-client-python) to integrate InfluxDB into Python scripts and applications. - -This guide presumes some familiarity with Python and InfluxDB. -If just getting started, see [Get started with InfluxDB](/influxdb/v2.0/get-started/). - -## Before you begin - -1. Install the InfluxDB Python library: - - ```sh - pip install influxdb-client - ``` - -2. Ensure that InfluxDB is running. - If running InfluxDB locally, visit http://localhost:8086. - (If using InfluxDB Cloud, visit the URL of your InfluxDB Cloud UI. - For example: https://us-west-2-1.aws.cloud2.influxdata.com.) - -## Write data to InfluxDB with Python - -We are going to write some data in [line protocol](/influxdb/v2.0/reference/syntax/line-protocol/) using the Python library. - -1. In your Python program, import the InfluxDB client library and use it to write data to InfluxDB. - - ```python - import influxdb_client - from influxdb_client.client.write_api import SYNCHRONOUS - ``` - -2. Define a few variables with the name of your [bucket](/influxdb/v2.0/organizations/buckets/), [organization](/influxdb/v2.0/organizations/), and [token](/influxdb/v2.0/security/tokens/). - - ```python - bucket = "" - org = "" - token = "" - # Store the URL of your InfluxDB instance - url="http://localhost:8086" - ``` - -3. Instantiate the client. The `InfluxDBClient` object takes three named parameters: `url`, `org`, and `token`. Pass in the named parameters. - - ```python - client = influxdb_client.InfluxDBClient( - url=url, - token=token, - org=org - ) - ``` - The `InfluxDBClient` object has a `write_api` method used for configuration. - -4. Instantiate a **write client** using the `client` object and the `write_api` method. Use the `write_api` method to configure the writer object. - - ```python - write_api = client.write_api(write_options=SYNCHRONOUS) - ``` - -5. Create a [point](/influxdb/v2.0/reference/glossary/#point) object and write it to InfluxDB using the `write` method of the API writer object. The write method requires three parameters: `bucket`, `org`, and `record`. - - ```python - p = influxdb_client.Point("my_measurement").tag("location", "Prague").field("temperature", 25.3) - write_api.write(bucket=bucket, org=org, record=p) - ``` - -### Complete example write script - -```python -import influxdb_client -from influxdb_client.client.write_api import SYNCHRONOUS - -bucket = "" -org = "" -token = "" -# Store the URL of your InfluxDB instance -url="http://localhost:8086" - -client = influxdb_client.InfluxDBClient( - url=url, - token=token, - org=org -) - -write_api = client.write_api(write_options=SYNCHRONOUS) - -p = influxdb_client.Point("my_measurement").tag("location", "Prague").field("temperature", 25.3) -write_api.write(bucket=bucket, org=org, record=p) -``` -## Query data from InfluxDB with Python - -1. Instantiate the **query client**. - - ```python - query_api = client.query_api() - ``` - -2. Create a Flux query. - - ```python - query = ‘ from(bucket:"my-bucket")\ - |> range(start: -10m)\ - |> filter(fn:(r) => r._measurement == "my_measurement")\ - |> filter(fn: (r) => r.location == "Prague")\ - |> filter(fn:(r) => r._field == "temperature" )‘ - ``` - - The query client sends the Flux query to InfluxDB and returns a Flux object with a table structure. - -3. Pass the `query()` method two named parameters:`org` and `query`. - - ```python - result = client.query_api().query(org=org, query=query) - ``` - -4. Iterate through the tables and records in the Flux object. - - Use the `get_value()` method to return values. - - Use the `get_field()` method to return fields. - - ```python - results = [] - for table in result: - for record in table.records: - results.append((record.get_field(), record.get_value())) - - print(results) - [(temperature, 25.3)] - ``` - -**The Flux object provides the following methods for accessing your data:** - -- `get_measurement()`: Returns the measurement name of the record. -- `get_field()`: Returns the field name. -- `get_value()`: Returns the actual field value. -- `values()`: Returns a map of column values. -- `values.get("")`: Returns a value from the record for given column. -- `get_time()`: Returns the time of the record. -- `get_start()`: Returns the inclusive lower time bound of all records in the current table. -- `get_stop()`: Returns the exclusive upper time bound of all records in the current table. - - -### Complete example query script - -```python -query_api = client.query_api() -query = ‘ from(bucket:"my-bucket")\ -|> range(start: -10m)\ -|> filter(fn:(r) => r._measurement == "my_measurement")\ -|> filter(fn: (r) => r.location == "Prague")\ -|> filter(fn:(r) => r._field == "temperature" )‘ -result = client.query_api().query(org=org, query=query) -results = [] -for table in result: - for record in table.records: - results.append((record.get_field(), record.get_value())) - -print(results) -[(temperature, 25.3)] -``` - -For more information, see the [Python client README on GitHub](https://github.com/influxdata/influxdb-client-python). diff --git a/content/influxdb/v2.0/tools/client-libraries/ruby.md b/content/influxdb/v2.0/tools/client-libraries/ruby.md deleted file mode 100644 index 11daa6e04..000000000 --- a/content/influxdb/v2.0/tools/client-libraries/ruby.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: InfluxDB Ruby client library -list_title: Ruby -description: Use the Ruby client library to interact with InfluxDB. -external_url: https://github.com/influxdata/influxdb-client-ruby -menu: - influxdb_2_0: - name: Ruby - parent: Use client libraries - url: https://github.com/influxdata/influxdb-client-ruby -weight: 201 ---- diff --git a/content/influxdb/v2.0/tools/client-libraries/scala.md b/content/influxdb/v2.0/tools/client-libraries/scala.md deleted file mode 100644 index a49e0ffc0..000000000 --- a/content/influxdb/v2.0/tools/client-libraries/scala.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: InfluxDB Scala client library -list_title: Scala -description: Use the Scala client library to interact with InfluxDB. -external_url: https://github.com/influxdata/influxdb-client-java/tree/master/client-scala -menu: - influxdb_2_0: - name: Scala - parent: Use client libraries - url: https://github.com/influxdata/influxdb-client-java/tree/master/client-scala -weight: 201 ---- diff --git a/content/influxdb/v2.0/tools/client-libraries/swift.md b/content/influxdb/v2.0/tools/client-libraries/swift.md deleted file mode 100644 index c046356be..000000000 --- a/content/influxdb/v2.0/tools/client-libraries/swift.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: InfluxDB Swift client library -list_title: Swift -description: Use the Swift client library to interact with InfluxDB. -external_url: https://github.com/influxdata/influxdb-client-swift -menu: - influxdb_2_0: - name: Swift - parent: Use client libraries - url: https://github.com/influxdata/influxdb-client-swift -weight: 201 ----