fix: clarify behaviour of influxdb.cardinality()
#5629
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The functionality of
influxdb.cardinality()
is not directly analogous toSHOW SERIES CARDINALITY
because it's time bounded.Unlike the InfluxQL command, it reports the cardinality of a specific dataset, but is often the cause of confusion as a result of being interpreted as providing the cardinality of the bucket as a whole.
There are various caveats which need to be considered when using it to obtain the cardinality of the bucket as a whole
start
needs to be earlier than the earliest timestamp (some docs pages suggest1
which is good)stop
needs to be later than the latest timestamp (the default isnow()
which is problematic if users are writing into the future)Note: a corresponding change will need to be made in the Flux code comments, but I thought it best to work on wording here first.
Describe your proposed changes here.
(if necessary)