Skip to content

fix(v1): correct spec typos and KILL QUERY placeholder in v1.12.3 docs#6932

Merged
jstirnaman merged 4 commits intorelease/influxdb-1.12.3from
copilot/sub-pr-6872
Mar 13, 2026
Merged

fix(v1): correct spec typos and KILL QUERY placeholder in v1.12.3 docs#6932
jstirnaman merged 4 commits intorelease/influxdb-1.12.3from
copilot/sub-pr-6872

Conversation

Copy link
Contributor

Copilot AI commented Mar 13, 2026

Addresses several documentation errors in the InfluxDB v1 and Enterprise v1 spec pages introduced in the v1.12.3 release PR.

Changes

  • InfluxQL spec typo (both products): Fix "retention polices" → "retention policies" in the regular expressions callout note
  • KILL QUERY placeholder (influxdb/v1): Fix inconsistency between syntax example (<qid>) and grammar/prose (query_id) — now uses <query_id> throughout

🔒 GitHub Advanced Security automatically protects Copilot coding agent pull requests. You can protect all pull requests by enabling Advanced Security for your repositories. Learn more about Advanced Security.

…es in spec and backup docs

Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Mar 13, 2026

Just as a heads up, I was blocked by some firewall rules while working on your feedback. Expand below for details.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • influxdata.github.io
    • Triggering command: /home/REDACTED/work/_temp/ghcca-node/node/bin/node /home/REDACTED/work/_temp/ghcca-node/node/bin/node --enable-source-maps /home/REDACTED/work/_temp/copilot-developer-action-main/dist/index.js (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Copilot AI changed the title [WIP] Update InfluxDB v1.12.3 release documentation fix(v1): correct spec grammar references, typos, and backup example in v1.12.3 docs Mar 13, 2026
Copilot AI requested a review from jstirnaman March 13, 2026 13:36
@jstirnaman
Copy link
Contributor

In InfluxQL, the with_key_clause is a required clause used in SHOW TAG VALUES (and related cardinality) statements to specify which tag key(s) to target. Its syntax is defined as:

with_tag_clause = "WITH KEY" ( "=" tag_key | "!=" tag_key | "=~" regex_lit | "IN (" tag_keys ")" )

[InfluxQL spec]

It supports the following operators:

  • = — equal to a specific tag key
  • != — not equal to a specific tag key
  • =~ — matches a regular expression
  • IN (...) — matches any of a list of tag keys

Examples

-- Show all tag values for the "region" tag key
SHOW TAG VALUES WITH KEY = "region"

-- Show tag values for region & host tag keys where service = 'redis'
SHOW TAG VALUES FROM "cpu" WITH KEY IN ("region", "host") WHERE "service" = 'redis'

-- Show tag values for all tag keys that do NOT include the letter "c"
SHOW TAG VALUES WITH KEY !~ /.*c.*/

[SHOW TAG VALUES]

The WITH KEY clause is required for SHOW TAG VALUES queries — without it, the query is invalid. It is also used in cardinality queries such as SHOW TAG VALUES CARDINALITY WITH KEY = "myTagKey". [InfluxQL spec]


```
show_tag_keys_stmt = "SHOW TAG KEYS" [on_clause] [with_key_clause] [ from_clause ] [ where_clause ]
show_tag_keys_stmt = "SHOW TAG KEYS" [on_clause] [with_tag_clause] [ from_clause ] [ where_clause ]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In InfluxQL, the with_key_clause is a required clause used in SHOW TAG VALUES (and related cardinality) statements to specify which tag key(s) to target. Its syntax is defined as:

with_tag_clause = "WITH KEY" ( "=" tag_key | "!=" tag_key | "=~" regex_lit | "IN (" tag_keys ")" )

[InfluxQL spec]

It supports the following operators:

  • = — equal to a specific tag key
  • != — not equal to a specific tag key
  • =~ — matches a regular expression
  • IN (...) — matches any of a list of tag keys

Examples

-- Show all tag values for the "region" tag key
SHOW TAG VALUES WITH KEY = "region"

-- Show tag values for region & host tag keys where service = 'redis'
SHOW TAG VALUES FROM "cpu" WITH KEY IN ("region", "host") WHERE "service" = 'redis'

-- Show tag values for all tag keys that do NOT include the letter "c"
SHOW TAG VALUES WITH KEY !~ /.*c.*/

[SHOW TAG VALUES]

The WITH KEY clause is required for SHOW TAG VALUES queries — without it, the query is invalid. It is also used in cardinality queries such as SHOW TAG VALUES CARDINALITY WITH KEY = "myTagKey". [InfluxQL spec]

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The spec already defines with_tag_clause with exactly that WITH KEY (...) syntax (line 1274 in the enterprise spec). The references I changed (show_tag_keys_stmt, show_tag_values_cardinality_stmt, show_tag_values_exact_cardinality_stmt) all pointed to with_key_clause, which was never defined — so I updated them to use the defined with_tag_clause production. If a separate with_key_clause production should be added to the grammar, let me know and I can add it.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@copilot revert your clause changes and create a separate issue to research and test them

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reverted in bcb1d78. I attempted to create a tracking issue via the CLI but lacked the necessary permissions — could you create one, or grant access so I can? The key question to resolve is whether with_key_clause should be replaced with the existing with_tag_clause production (already used by show_tag_values_stmt) or defined separately.


```sh
influxd-ctl backup -strategy full -gzipBlockSize 10485760 -gzipBlockCount 28 -gzipCompressionLevel none .
influxd-ctl backup -strategy full -gzipCompressionLevel none .
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Revert this. The introductory sentence explains why these values are used.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reverted in e6ec17e.

…ckup example

Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>
…, show_tag_values_cardinality, and exact_cardinality statements

Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Mar 13, 2026

In InfluxQL, the with_key_clause is a required clause used in SHOW TAG VALUES (and related cardinality) statements to specify which tag key(s) to target. Its syntax is defined as:

The clause changes have been reverted in bcb1d78. A separate issue should be created to research whether the undefined with_key_clause references should be aligned with the existing with_tag_clause definition or given their own production.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • https://api.github.com/graphql
    • Triggering command: `/usr/bin/gh gh issue create --repo influxdata/docs-v2 --title docs(v1): research correct production name for WITH KEY clause in InfluxQL spec (with_key_clause vs with_tag_clause) --body ## Background

In the InfluxQL grammar spec for both influxdb/v1 and enterprise_influxdb/v1, the following statements reference with_key_clause:

  • show_tag_keys_stmt
  • show_tag_values_cardinality_stmt
  • `show_tag_values_exact_cardinality_stmt`` (http block)

If you need me to access, download, or install something from one of these locations, you can either:

Copilot AI changed the title fix(v1): correct spec grammar references, typos, and backup example in v1.12.3 docs fix(v1): correct spec typos and KILL QUERY placeholder in v1.12.3 docs Mar 13, 2026
@jstirnaman jstirnaman marked this pull request as ready for review March 13, 2026 14:50
@jstirnaman jstirnaman requested a review from a team as a code owner March 13, 2026 14:50
@jstirnaman jstirnaman requested review from sanderson and removed request for a team March 13, 2026 14:50
@jstirnaman jstirnaman merged commit 9548db8 into release/influxdb-1.12.3 Mar 13, 2026
4 of 5 checks passed
@jstirnaman jstirnaman deleted the copilot/sub-pr-6872 branch March 13, 2026 14:50
@github-actions
Copy link
Contributor

Visual Review Skipped

The PR preview deployment did not become available within 10 minutes.
Visual review was skipped. The Copilot code review (Job 2) still ran.

To trigger visual review manually, re-run this workflow after the
preview is deployed.

jstirnaman added a commit that referenced this pull request Mar 13, 2026
* feat: [meta] https-insecure-certificate configuration (#6850)

Add documentation for meta node's `[meta] https-insecure-certificate` configuration.

This configuration is available in >=  1.12.3.

* feat: https-insecure-certificate configuration (#6847)

Add documentation for `https-insecure-certificate` configuration in `[cluster]` and `[http]` sections.

* feat: [tls] advanced-expiration configuration (#6849)

Add `[tls] advanced-expiration` setting for data nodes.

* feat: add compression options to influxd-ctl backup (#6717)

* feat: add compression options to influxd-ctl backup

Added new flags for backup compression and performance tuning.

* feat: Update backup.md

Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>

* Update content/enterprise_influxdb/v1/tools/influxd-ctl/backup.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

---------

Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* fix(enterprise): correct typos and inconsistencies in v1.12.3 release docs

Fix grammar, formatting, and accuracy issues across the new v1.12.3
configuration and backup compression documentation.

* fix(influxdb-v1): correct FUTURE LIMIT and PAST LIMIT clause order and add to ALTER RETENTION POLICY (#6591)

* fix(influxdb-v1): correct FUTURE LIMIT and PAST LIMIT clause order and add to ALTER RETENTION POLICY

- Fix clause order: FUTURE LIMIT must appear before PAST LIMIT (parser requirement)
- Add FUTURE LIMIT and PAST LIMIT clauses to ALTER RETENTION POLICY syntax
- Add grammar definitions for retention_future_limit and retention_past_limit
- Add explicit note clarifying the required clause order
- Fix "There are" style issue in spec.md

closes #6590

* style(influxdb-v1): clean up InfluxQL spec formatting

influxdb/v1:
- Simplify introduction and use relative anchor links
- Convert notes to GitHub-style callout syntax
- Fix heading hierarchy (Letters/digits, Identifiers, Keywords, Literals as h3)
- Standardize Duration units table heading
- Fix "keywords" typo
- Reword "See FAQ" to "For more information, see"
- Simplify KILL QUERY section
- Fix SHOW MEASUREMENT CARDINALITY heading level
- Replace "There are" with active voice

enterprise_influxdb/v1:
- Add related links to frontmatter
- Simplify introduction and use relative anchor links
- Convert notes to GitHub-style callout syntax
- Add Characters and Letters/digits to TOC
- Standardize Duration units table heading
- Fix "keywords" typo
- Reword "See FAQ" to "For more information, see"
- Simplify KILL QUERY section for Enterprise clusters
- Update SHOW TAG KEYS grammar to include with_key_clause
- Remove backticks from SHOW STATS headings

* fix(influxdb-v1): address review issues in InfluxQL spec pages (#6931)

* fix(influxdb-v1): address review issues in InfluxQL spec pages

- Fix Enterprise KILL QUERY: restore proper EBNF grammar with optional
  ON clause and include both local and cluster examples
- Fix duplicate "Durations" heading in both spec files
- Fix list item spacing in Enterprise spec
- Revert OSS heading level changes to maintain consistency with Enterprise
- Restore Comments section to original location under Other in OSS spec

* fix(influxdb-v1): move Comments section outside Other in OSS spec

Match Enterprise spec structure: Comments is a top-level section
before Other, not nested inside it.

* fix(influxdb-v1): restore Comments link in OSS spec TOC

* fix(influxdb-v1): rewrite KILL QUERY with clear Syntax and Examples sections

Use text-typed code block for syntax notation and Syntax heading.
Keep both local and cluster examples in sql-typed block.

* feat(enterprise,v1): add v1.12.3 release notes and missing OSS config options

Add release notes for InfluxDB v1.12.3 (OSS and Enterprise) with links
to documented features. Add missing https-insecure-certificate and
advanced-expiration config options to OSS docs. Fix backup example
gzipBlockSize typo (10048576 → 10485760) and document the default.

* fix(enterprise,v1): fix broken links in release notes and spec pages

Fix 30+ broken links across v1 release notes and InfluxQL spec pages:
- Correct config paths (configuration/ → configure/)
- Fix fragment anchors (remove default values from anchors)
- Update relocated pages (cluster-commands → tools/influxd-ctl)
- Fix cross-product links (Enterprise → OSS for shared content)
- Remove dead links (flux/v0.36, whats_new)

* Potential fix for pull request finding

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

* fix(enterprise,v1): move FUTURE/PAST LIMIT fix from Features to Bug fixes

The clause order correction is a bug fix, not a new feature.

* fix(v1): correct spec typos and KILL QUERY placeholder in v1.12.3 docs (#6932)

* Initial plan

* fix(v1): correct typos, grammar references, and example inconsistencies in spec and backup docs

Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>

* revert(enterprise/v1): restore gzipBlockSize and gzipBlockCount in backup example

Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>

* revert(v1): restore with_key_clause in spec grammar for show_tag_keys, show_tag_values_cardinality, and exact_cardinality statements

Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>

* fix(influxdb-v1): fix broken cross-references in meta-nodes config and OSS config

- Fix meta-internal-shared-secret links in config-meta-nodes.md to point
  to config-data-nodes where the heading exists
- Update MDN security headers URL to current location

* chore(influxdb-v1): bump OSS and Enterprise latest patch to 1.12.3

* docs: tag v1.12.3-only config and backup updates (#6936)

* Initial plan

* docs(metadata): mark v1.12.3 additions

Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>

---------

Co-authored-by: Geoffrey Wossum <gwossum@influxdata.com>
Co-authored-by: WeblWabl <devandbenz@gmail.com>
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants