Influxdata
/
docs-v2
mirror of https://github.com/influxdata/docs-v2.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs: make description less ambiguous about what the function does

pull/5629/head
B Tasker 2024-10-02 14:28:29 +01:00
parent 59d8998db8
commit 8948cd5486
No known key found for this signature in database
GPG Key ID: F289CDD2317B182C
1 changed files with 15 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
content/flux/v0/stdlib/influxdata/influxdb/cardinality.md
View File

@ -1,7 +1,7 @@
---
title: influxdb.cardinality() function
description: >
`influxdb.cardinality()` returns the series cardinality of data stored in InfluxDB.
`influxdb.cardinality()` returns the series cardinality of data retrieved from InfluxDB.
menu:
flux_v0_ref:
name: influxdb.cardinality
@ -28,9 +28,16 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md
------------------------------------------------------------------------------->
`influxdb.cardinality()` returns the series cardinality of data stored in InfluxDB.
`influxdb.cardinality()` returns the series cardinality of data retrieved from InfluxDB.
{{% note %}}
Although this function is similar to InfluxQL's [`SHOW SERIES CARDINALITY`](/influxdb/v1/query_language/spec/#show-series-cardinality),
it works in a slightly different manner.
`influxdb.cardinality()` is time bounded and reports the cardinality of the data that's passed into it rather than the cardinality of the bucket as a whole.
{{% /note %}}
##### Function type signature
@ -107,6 +114,12 @@ The cardinality calculation excludes points that match the specified start time.
Use a relative duration or absolute time. For example, `-1h` or `2019-08-28T22:00:00Z`.
Durations are relative to `now()`. Default is `now()`.
{{% note %}}
The default value is `now()`, so any points that have been written into the future will
not be counted unless a future `stop` date is provided.
{{% /note %}}
### predicate
Predicate function that filters records.