Merge branch 'master' into late-arriving-data

pull/4386/head
kelseiv 2022-08-26 17:38:30 -07:00 committed by GitHub
commit 4e88febd15
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
19 changed files with 371 additions and 245 deletions

View File

@ -1,7 +1,7 @@
---
title: InfluxDB API client library tutorials
seotitle: Get started with InfluxDB API client libraries
description: Follow step-by-step tutorials to for InfluxDB API client libraries in your favorite framework or language.
title: InfluxDB API client library starter
seotitle: Starter tutorial for InfluxDB API client libraries
description: Follow step-by-step tutorials to build an IoT dashboard with API client libraries in your favorite framework or language.
weight: 4
menu:
influxdb_cloud:
@ -10,4 +10,4 @@ menu:
influxdb/cloud/tags: [api]
---
{{< children >}}
{{< duplicate-oss >}}

View File

@ -1,13 +0,0 @@
---
title: InfluxDB API client library starter
seotitle: Starter tutorial for InfluxDB API client libraries
description: Follow step-by-step tutorials to build an IoT dashboard with API client libraries in your favorite framework or language.
weight: 4
menu:
influxdb_cloud:
name: Client library starter
parent: Client library tutorials
influxdb/cloud/tags: [api]
---
{{< duplicate-oss >}}

View File

@ -9,8 +9,8 @@ menu:
influxdb_cloud:
identifier: client-library-starter-js
name: JavaScript
parent: Client library starter
parent: Client library tutorials
influxdb/cloud/tags: [api, javascript, nodejs]
---
{{% duplicate-oss %}}
{{< duplicate-oss >}}

View File

@ -10,8 +10,8 @@ menu:
influxdb_cloud:
identifier: client-library-starter-py
name: Python
parent: Client library starter
parent: Client library tutorials
influxdb/cloud/tags: [api, python]
---
{{% duplicate-oss %}}
{{< duplicate-oss >}}

View File

@ -3,8 +3,8 @@ title: Check if a value exists
seotitle: Use Flux to check if a value exists
list_title: Exists
description: >
Use the Flux `exists` operator to check if a record contains a key or if that
key's value is `null`.
Use the `exists` operator to check if a row record contains a column or if a
column's value is _null_.
menu:
influxdb_1_7:
name: Exists
@ -20,63 +20,87 @@ list_code_example: |
```
---
Use the Flux `exists` operator to check if a record contains a key or if that
key's value is `null`.
Use the `exists` operator to check if a row record contains a column or if a
column's value is _null_.
```js
p = {firstName: "John", lastName: "Doe", age: 42}
exists p.firstName
// Returns true
exists p.height
// Returns false
(r) => exists r.column
```
If you're just getting started with Flux queries, check out the following:
- [Get started with Flux](/influxdb/v1.7/flux/get-started/) for a conceptual overview of Flux and parts of a Flux query.
- [Execute queries](/influxdb/v1.7/flux/guides/execute-queries/) to discover a variety of ways to run your queries.
- [Get started with Flux](/{{< latest "flux" >}}/get-started/) for a conceptual overview of Flux and parts of a Flux query.
- [Execute queries](/influxdb/v2.4/query-data/execute-queries/) to discover a variety of ways to run your queries.
Use `exists` with row functions (
[`filter()`](/{{< latest "flux" >}}/stdlib/universe/filter/),
[`map()`](/{{< latest "flux" >}}/stdlib/universe/map/),
[`reduce()`](/{{< latest "flux" >}}/stdlib/universe/reduce/))
to check if a row includes a column or if the value for that column is `null`.
to check if a row includes a column or if the value for that column is _null_.
#### Filter null values
```js
from(bucket: "db/rp")
from(bucket: "example-bucket")
|> range(start: -5m)
|> filter(fn: (r) => exists r._value)
```
#### Map values based on existence
```js
from(bucket: "default")
|> range(start: -30s)
|> map(fn: (r) => ({
r with
human_readable:
if exists r._value then "${r._field} is ${string(v:r._value)}."
else "${r._field} has no value."
}))
|> map(
fn: (r) => ({r with
human_readable: if exists r._value then
"${r._field} is ${string(v: r._value)}."
else
"${r._field} has no value.",
}),
)
```
#### Ignore null values in a custom aggregate function
```js
customSumProduct = (tables=<-) =>
tables
customSumProduct = (tables=<-) => tables
|> reduce(
identity: {sum: 0.0, product: 1.0},
fn: (r, accumulator) => ({
r with
sum:
if exists r._value then r._value + accumulator.sum
else accumulator.sum,
product:
if exists r._value then r.value * accumulator.product
else accumulator.product
})
fn: (r, accumulator) => ({r with
sum: if exists r._value then
r._value + accumulator.sum
else
accumulator.sum,
product: if exists r._value then
r.value * accumulator.product
else
accumulator.product,
}),
)
```
#### Check if a statically defined record contains a key
When you use the [record literal syntax](/flux/v0.x/data-types/composite/record/#record-syntax)
to statically define a record, Flux knows the record type and what keys to expect.
- If the key exists in the static record, `exists` returns `true`.
- If the key does not exist in the static record, because the record type is
statically known, `exists` returns an error.
```js
import "internal/debug"
p = {
firstName: "John",
lastName: "Doe",
age: 42,
}
exists p.firstName
// Returns true
exists p.height
// Returns "error: record is missing label height"
```

View File

@ -3,8 +3,8 @@ title: Check if a value exists
seotitle: Use Flux to check if a value exists
list_title: Exists
description: >
Use the Flux `exists` operator to check if a record contains a key or if that
key's value is `null`.
Use the `exists` operator to check if a row record contains a column or if a
column's value is _null_.
menu:
influxdb_1_8:
name: Exists
@ -20,63 +20,87 @@ list_code_example: |
```
---
Use the Flux `exists` operator to check if a record contains a key or if that
key's value is `null`.
Use the `exists` operator to check if a row record contains a column or if a
column's value is _null_.
```js
p = {firstName: "John", lastName: "Doe", age: 42}
exists p.firstName
// Returns true
exists p.height
// Returns false
(r) => exists r.column
```
If you're just getting started with Flux queries, check out the following:
- [Get started with Flux](/influxdb/v1.8/flux/get-started/) for a conceptual overview of Flux and parts of a Flux query.
- [Execute queries](/influxdb/v1.8/flux/guides/execute-queries/) to discover a variety of ways to run your queries.
- [Get started with Flux](/{{< latest "flux" >}}/get-started/) for a conceptual overview of Flux and parts of a Flux query.
- [Execute queries](/influxdb/v2.4/query-data/execute-queries/) to discover a variety of ways to run your queries.
Use `exists` with row functions (
[`filter()`](/{{< latest "flux" >}}/stdlib/universe/filter/),
[`map()`](/{{< latest "flux" >}}/stdlib/universe/map/),
[`reduce()`](/{{< latest "flux" >}}/stdlib/universe/reduce/))
to check if a row includes a column or if the value for that column is `null`.
to check if a row includes a column or if the value for that column is _null_.
#### Filter null values
```js
from(bucket: "db/rp")
from(bucket: "example-bucket")
|> range(start: -5m)
|> filter(fn: (r) => exists r._value)
```
#### Map values based on existence
```js
from(bucket: "default")
|> range(start: -30s)
|> map(fn: (r) => ({
r with
human_readable:
if exists r._value then "${r._field} is ${string(v:r._value)}."
else "${r._field} has no value."
}))
|> map(
fn: (r) => ({r with
human_readable: if exists r._value then
"${r._field} is ${string(v: r._value)}."
else
"${r._field} has no value.",
}),
)
```
#### Ignore null values in a custom aggregate function
```js
customSumProduct = (tables=<-) =>
tables
customSumProduct = (tables=<-) => tables
|> reduce(
identity: {sum: 0.0, product: 1.0},
fn: (r, accumulator) => ({
r with
sum:
if exists r._value then r._value + accumulator.sum
else accumulator.sum,
product:
if exists r._value then r.value * accumulator.product
else accumulator.product
})
fn: (r, accumulator) => ({r with
sum: if exists r._value then
r._value + accumulator.sum
else
accumulator.sum,
product: if exists r._value then
r.value * accumulator.product
else
accumulator.product,
}),
)
```
#### Check if a statically defined record contains a key
When you use the [record literal syntax](/flux/v0.x/data-types/composite/record/#record-syntax)
to statically define a record, Flux knows the record type and what keys to expect.
- If the key exists in the static record, `exists` returns `true`.
- If the key does not exist in the static record, because the record type is
statically known, `exists` returns an error.
```js
import "internal/debug"
p = {
firstName: "John",
lastName: "Doe",
age: 42,
}
exists p.firstName
// Returns true
exists p.height
// Returns "error: record is missing label height"
```

View File

@ -3,8 +3,8 @@ title: Check if a value exists
seotitle: Use Flux to check if a value exists
list_title: Exists
description: >
Use the Flux `exists` operator to check if a record contains a key or if that
key's value is `null`.
Use the `exists` operator to check if a row record contains a column or if a
column's value is _null_.
influxdb/v2.0/tags: [exists]
menu:
influxdb_2_0:
@ -24,31 +24,26 @@ list_code_example: |
```
---
Use the Flux `exists` operator to check if a record contains a key or if that
key's value is `null`.
Use the `exists` operator to check if a row record contains a column or if a
column's value is _null_.
```js
p = {firstName: "John", lastName: "Doe", age: 42}
exists p.firstName
// Returns true
exists p.height
// Returns false
(r) => exists r.column
```
If you're just getting started with Flux queries, check out the following:
- [Get started with Flux](/{{< latest "flux" >}}/get-started/) for a conceptual overview of Flux and parts of a Flux query.
- [Execute queries](/influxdb/v2.0/query-data/execute-queries/) to discover a variety of ways to run your queries.
- [Execute queries](/influxdb/v2.4/query-data/execute-queries/) to discover a variety of ways to run your queries.
Use `exists` with row functions (
[`filter()`](/{{< latest "flux" >}}/stdlib/universe/filter/),
[`map()`](/{{< latest "flux" >}}/stdlib/universe/map/),
[`reduce()`](/{{< latest "flux" >}}/stdlib/universe/reduce/))
to check if a row includes a column or if the value for that column is `null`.
to check if a row includes a column or if the value for that column is _null_.
#### Filter null values
```js
from(bucket: "example-bucket")
|> range(start: -5m)
@ -56,31 +51,60 @@ from(bucket: "example-bucket")
```
#### Map values based on existence
```js
from(bucket: "default")
|> range(start: -30s)
|> map(fn: (r) => ({
r with
human_readable:
if exists r._value then "${r._field} is ${string(v:r._value)}."
else "${r._field} has no value."
}))
|> map(
fn: (r) => ({r with
human_readable: if exists r._value then
"${r._field} is ${string(v: r._value)}."
else
"${r._field} has no value.",
}),
)
```
#### Ignore null values in a custom aggregate function
```js
customSumProduct = (tables=<-) =>
tables
customSumProduct = (tables=<-) => tables
|> reduce(
identity: {sum: 0.0, product: 1.0},
fn: (r, accumulator) => ({
r with
sum:
if exists r._value then r._value + accumulator.sum
else accumulator.sum,
product:
if exists r._value then r.value * accumulator.product
else accumulator.product
})
fn: (r, accumulator) => ({r with
sum: if exists r._value then
r._value + accumulator.sum
else
accumulator.sum,
product: if exists r._value then
r.value * accumulator.product
else
accumulator.product,
}),
)
```
#### Check if a statically defined record contains a key
When you use the [record literal syntax](/flux/v0.x/data-types/composite/record/#record-syntax)
to statically define a record, Flux knows the record type and what keys to expect.
- If the key exists in the static record, `exists` returns `true`.
- If the key does not exist in the static record, because the record type is
statically known, `exists` returns an error.
```js
import "internal/debug"
p = {
firstName: "John",
lastName: "Doe",
age: 42,
}
exists p.firstName
// Returns true
exists p.height
// Returns "error: record is missing label height"
```

View File

@ -3,8 +3,8 @@ title: Check if a value exists
seotitle: Use Flux to check if a value exists
list_title: Exists
description: >
Use the Flux `exists` operator to check if a record contains a key or if that
key's value is `null`.
Use the `exists` operator to check if a row record contains a column or if a
column's value is _null_.
influxdb/v2.1/tags: [exists]
menu:
influxdb_2_1:
@ -24,31 +24,26 @@ list_code_example: |
```
---
Use the Flux `exists` operator to check if a record contains a key or if that
key's value is `null`.
Use the `exists` operator to check if a row record contains a column or if a
column's value is _null_.
```js
p = {firstName: "John", lastName: "Doe", age: 42}
exists p.firstName
// Returns true
exists p.height
// Returns false
(r) => exists r.column
```
If you're just getting started with Flux queries, check out the following:
- [Get started with Flux](/{{< latest "flux" >}}/get-started/) for a conceptual overview of Flux and parts of a Flux query.
- [Execute queries](/influxdb/v2.1/query-data/execute-queries/) to discover a variety of ways to run your queries.
- [Execute queries](/influxdb/v2.4/query-data/execute-queries/) to discover a variety of ways to run your queries.
Use `exists` with row functions (
[`filter()`](/{{< latest "flux" >}}/stdlib/universe/filter/),
[`map()`](/{{< latest "flux" >}}/stdlib/universe/map/),
[`reduce()`](/{{< latest "flux" >}}/stdlib/universe/reduce/))
to check if a row includes a column or if the value for that column is `null`.
to check if a row includes a column or if the value for that column is _null_.
#### Filter null values
```js
from(bucket: "example-bucket")
|> range(start: -5m)
@ -56,6 +51,7 @@ from(bucket: "example-bucket")
```
#### Map values based on existence
```js
from(bucket: "default")
|> range(start: -30s)
@ -70,6 +66,7 @@ from(bucket: "default")
```
#### Ignore null values in a custom aggregate function
```js
customSumProduct = (tables=<-) => tables
|> reduce(
@ -86,3 +83,28 @@ customSumProduct = (tables=<-) => tables
}),
)
```
#### Check if a statically defined record contains a key
When you use the [record literal syntax](/flux/v0.x/data-types/composite/record/#record-syntax)
to statically define a record, Flux knows the record type and what keys to expect.
- If the key exists in the static record, `exists` returns `true`.
- If the key does not exist in the static record, because the record type is
statically known, `exists` returns an error.
```js
import "internal/debug"
p = {
firstName: "John",
lastName: "Doe",
age: 42,
}
exists p.firstName
// Returns true
exists p.height
// Returns "error: record is missing label height"
```

View File

@ -3,8 +3,8 @@ title: Check if a value exists
seotitle: Use Flux to check if a value exists
list_title: Exists
description: >
Use the Flux `exists` operator to check if a record contains a key or if that
key's value is `null`.
Use the `exists` operator to check if a row record contains a column or if a
column's value is _null_.
influxdb/v2.2/tags: [exists]
menu:
influxdb_2_2:
@ -24,31 +24,26 @@ list_code_example: |
```
---
Use the Flux `exists` operator to check if a record contains a key or if that
key's value is `null`.
Use the `exists` operator to check if a row record contains a column or if a
column's value is _null_.
```js
p = {firstName: "John", lastName: "Doe", age: 42}
exists p.firstName
// Returns true
exists p.height
// Returns false
(r) => exists r.column
```
If you're just getting started with Flux queries, check out the following:
- [Get started with Flux](/{{< latest "flux" >}}/get-started/) for a conceptual overview of Flux and parts of a Flux query.
- [Execute queries](/influxdb/v2.2/query-data/execute-queries/) to discover a variety of ways to run your queries.
- [Execute queries](/influxdb/v2.4/query-data/execute-queries/) to discover a variety of ways to run your queries.
Use `exists` with row functions (
[`filter()`](/{{< latest "flux" >}}/stdlib/universe/filter/),
[`map()`](/{{< latest "flux" >}}/stdlib/universe/map/),
[`reduce()`](/{{< latest "flux" >}}/stdlib/universe/reduce/))
to check if a row includes a column or if the value for that column is `null`.
to check if a row includes a column or if the value for that column is _null_.
#### Filter null values
```js
from(bucket: "example-bucket")
|> range(start: -5m)
@ -56,6 +51,7 @@ from(bucket: "example-bucket")
```
#### Map values based on existence
```js
from(bucket: "default")
|> range(start: -30s)
@ -70,6 +66,7 @@ from(bucket: "default")
```
#### Ignore null values in a custom aggregate function
```js
customSumProduct = (tables=<-) => tables
|> reduce(
@ -86,3 +83,28 @@ customSumProduct = (tables=<-) => tables
}),
)
```
#### Check if a statically defined record contains a key
When you use the [record literal syntax](/flux/v0.x/data-types/composite/record/#record-syntax)
to statically define a record, Flux knows the record type and what keys to expect.
- If the key exists in the static record, `exists` returns `true`.
- If the key does not exist in the static record, because the record type is
statically known, `exists` returns an error.
```js
import "internal/debug"
p = {
firstName: "John",
lastName: "Doe",
age: 42,
}
exists p.firstName
// Returns true
exists p.height
// Returns "error: record is missing label height"
```

View File

@ -1,7 +1,7 @@
---
title: InfluxDB API client library tutorials
seotitle: Get started with InfluxDB API client libraries
description: Follow step-by-step tutorials to for InfluxDB API client libraries in your favorite framework or language.
title: InfluxDB API client library starter
seotitle: Starter tutorial for InfluxDB API client libraries
description: Follow step-by-step tutorials to build an IoT dashboard with API client libraries in your favorite framework or language.
weight: 4
menu:
influxdb_2_3:
@ -10,4 +10,21 @@ menu:
influxdb/v2.3/tags: [api]
---
Follow step-by-step tutorials to build an Internet-of-Things (IoT) application with InfluxData client libraries and your favorite framework or language.
InfluxData and the user community maintain client libraries for developers who want to take advantage of:
- Idioms for InfluxDB requests, responses, and errors.
- Common patterns in a familiar programming language.
- Faster development and less boilerplate code.
In these tutorials, you'll use the InfluxDB API and
client libraries to build a modern application, and learn the following:
- InfluxDB core concepts.
- How the application interacts with devices and InfluxDB.
- How to authenticate apps and devices to the API.
- How to install a client library.
- How to write and query data in InfluxDB.
- How to use the InfluxData UI libraries to format data and create visualizations.
{{< children >}}

View File

@ -1,30 +0,0 @@
---
title: InfluxDB API client library starter
seotitle: Starter tutorial for InfluxDB API client libraries
description: Follow step-by-step tutorials to build an IoT dashboard with API client libraries in your favorite framework or language.
weight: 4
menu:
influxdb_2_3:
name: Client library starter
parent: Client library tutorials
influxdb/v2.3/tags: [api]
---
Follow step-by-step tutorials to build an Internet-of-Things (IoT) application with InfluxData client libraries and your favorite framework or language.
InfluxData and the user community maintain client libraries for developers who want to take advantage of:
- Idioms for InfluxDB requests, responses, and errors.
- Common patterns in a familiar programming language.
- Faster development and less boilerplate code.
These tutorials walk through using the InfluxDB API and
client libraries to build a modern application as you learn the following:
- InfluxDB core concepts.
- How the application interacts with devices and InfluxDB.
- How to authenticate apps and devices to the API.
- How to install a client library.
- How to write and query data in InfluxDB.
- How to use the InfluxData UI libraries to format data and create visualizations.
{{< children >}}

View File

@ -9,7 +9,7 @@ menu:
influxdb_2_3:
identifier: client-library-starter-js
name: JavaScript
parent: Client library starter
parent: Client library tutorials
influxdb/v2.3/tags: [api, javascript, nodejs]
---

View File

@ -10,7 +10,7 @@ menu:
influxdb_2_3:
identifier: client-library-starter-py
name: Python
parent: Client library starter
parent: Client library tutorials
influxdb/v2.3/tags: [api, python]
---

View File

@ -3,8 +3,8 @@ title: Check if a value exists
seotitle: Use Flux to check if a value exists
list_title: Exists
description: >
Use the Flux `exists` operator to check if a record contains a key or if that
key's value is `null`.
Use the `exists` operator to check if a row record contains a column or if a
column's value is _null_.
influxdb/v2.3/tags: [exists]
menu:
influxdb_2_3:
@ -24,31 +24,26 @@ list_code_example: |
```
---
Use the Flux `exists` operator to check if a record contains a key or if that
key's value is `null`.
Use the `exists` operator to check if a row record contains a column or if a
column's value is _null_.
```js
p = {firstName: "John", lastName: "Doe", age: 42}
exists p.firstName
// Returns true
exists p.height
// Returns false
(r) => exists r.column
```
If you're just getting started with Flux queries, check out the following:
- [Get started with Flux](/{{< latest "flux" >}}/get-started/) for a conceptual overview of Flux and parts of a Flux query.
- [Execute queries](/influxdb/v2.3/query-data/execute-queries/) to discover a variety of ways to run your queries.
- [Execute queries](/influxdb/v2.4/query-data/execute-queries/) to discover a variety of ways to run your queries.
Use `exists` with row functions (
[`filter()`](/{{< latest "flux" >}}/stdlib/universe/filter/),
[`map()`](/{{< latest "flux" >}}/stdlib/universe/map/),
[`reduce()`](/{{< latest "flux" >}}/stdlib/universe/reduce/))
to check if a row includes a column or if the value for that column is `null`.
to check if a row includes a column or if the value for that column is _null_.
#### Filter null values
```js
from(bucket: "example-bucket")
|> range(start: -5m)
@ -56,6 +51,7 @@ from(bucket: "example-bucket")
```
#### Map values based on existence
```js
from(bucket: "default")
|> range(start: -30s)
@ -70,6 +66,7 @@ from(bucket: "default")
```
#### Ignore null values in a custom aggregate function
```js
customSumProduct = (tables=<-) => tables
|> reduce(
@ -86,3 +83,28 @@ customSumProduct = (tables=<-) => tables
}),
)
```
#### Check if a statically defined record contains a key
When you use the [record literal syntax](/flux/v0.x/data-types/composite/record/#record-syntax)
to statically define a record, Flux knows the record type and what keys to expect.
- If the key exists in the static record, `exists` returns `true`.
- If the key does not exist in the static record, because the record type is
statically known, `exists` returns an error.
```js
import "internal/debug"
p = {
firstName: "John",
lastName: "Doe",
age: 42,
}
exists p.firstName
// Returns true
exists p.height
// Returns "error: record is missing label height"
```

View File

@ -10,4 +10,21 @@ menu:
influxdb/v2.4/tags: [api]
---
Follow step-by-step tutorials to build an Internet-of-Things (IoT) application with InfluxData client libraries and your favorite framework or language.
InfluxData and the user community maintain client libraries for developers who want to take advantage of:
- Idioms for InfluxDB requests, responses, and errors.
- Common patterns in a familiar programming language.
- Faster development and less boilerplate code.
In these tutorials, you'll use the InfluxDB API and
client libraries to build a modern application, and learn the following:
- InfluxDB core concepts.
- How the application interacts with devices and InfluxDB.
- How to authenticate apps and devices to the API.
- How to install a client library.
- How to write and query data in InfluxDB.
- How to use the InfluxData UI libraries to format data and create visualizations.
{{< children >}}

View File

@ -1,30 +0,0 @@
---
title: InfluxDB API client library starter
seotitle: Starter tutorial for InfluxDB API client libraries
description: Follow step-by-step tutorials to build an IoT dashboard with API client libraries in your favorite framework or language.
weight: 4
menu:
influxdb_2_4:
name: Client library starter
parent: Client library tutorials
influxdb/v2.4/tags: [api]
---
Follow step-by-step tutorials to build an Internet-of-Things (IoT) application with InfluxData client libraries and your favorite framework or language.
InfluxData and the user community maintain client libraries for developers who want to take advantage of:
- Idioms for InfluxDB requests, responses, and errors.
- Common patterns in a familiar programming language.
- Faster development and less boilerplate code.
These tutorials walk through using the InfluxDB API and
client libraries to build a modern application as you learn the following:
- InfluxDB core concepts.
- How the application interacts with devices and InfluxDB.
- How to authenticate apps and devices to the API.
- How to install a client library.
- How to write and query data in InfluxDB.
- How to use the InfluxData UI libraries to format data and create visualizations.
{{< children >}}

View File

@ -9,7 +9,7 @@ menu:
influxdb_2_4:
identifier: client-library-starter-js
name: JavaScript
parent: Client library starter
parent: Client library tutorials
influxdb/v2.4/tags: [api, javascript, nodejs]
---

View File

@ -10,7 +10,7 @@ menu:
influxdb_2_4:
identifier: client-library-starter-py
name: Python
parent: Client library starter
parent: Client library tutorials
influxdb/v2.4/tags: [api, python]
---

View File

@ -3,8 +3,8 @@ title: Check if a value exists
seotitle: Use Flux to check if a value exists
list_title: Exists
description: >
Use the Flux `exists` operator to check if a record contains a key or if that
key's value is `null`.
Use the Flux `exists` operator to check if a row record contains a column or if
that column's value is `null`.
influxdb/v2.4/tags: [exists]
menu:
influxdb_2_4:
@ -24,17 +24,11 @@ list_code_example: |
```
---
Use the Flux `exists` operator to check if a record contains a key or if that
key's value is `null`.
Use the `exists` operator to check if a row record contains a column or if a
column's value is _null_.
```js
p = {firstName: "John", lastName: "Doe", age: 42}
exists p.firstName
// Returns true
exists p.height
// Returns false
(r) => exists r.column
```
If you're just getting started with Flux queries, check out the following:
@ -46,9 +40,10 @@ Use `exists` with row functions (
[`filter()`](/{{< latest "flux" >}}/stdlib/universe/filter/),
[`map()`](/{{< latest "flux" >}}/stdlib/universe/map/),
[`reduce()`](/{{< latest "flux" >}}/stdlib/universe/reduce/))
to check if a row includes a column or if the value for that column is `null`.
to check if a row includes a column or if the value for that column is _null_.
#### Filter null values
```js
from(bucket: "example-bucket")
|> range(start: -5m)
@ -56,6 +51,7 @@ from(bucket: "example-bucket")
```
#### Map values based on existence
```js
from(bucket: "default")
|> range(start: -30s)
@ -70,6 +66,7 @@ from(bucket: "default")
```
#### Ignore null values in a custom aggregate function
```js
customSumProduct = (tables=<-) => tables
|> reduce(
@ -86,3 +83,33 @@ customSumProduct = (tables=<-) => tables
}),
)
```
#### Check if a statically defined record contains a key
When you use the [record literal syntax](/flux/v0.x/data-types/composite/record/#record-syntax)
to statically define a record, Flux knows the record type and what keys to expect.
- If the key exists in the static record, `exists` returns `true`.
- If the key exists in the static record, but has a _null_ value, `exists` returns `false`.
- If the key does not exist in the static record, because the record type is
statically known, `exists` returns an error.
```js
import "internal/debug"
p = {
firstName: "John",
lastName: "Doe",
age: 42,
height: debug.null(type: "int"),
}
exists p.firstName
// Returns true
exists p.height
// Returns false
exists p.hairColor
// Returns "error: record is missing label hairColor"
```