Tighten formatting of CREATE examples in InfluxQL spec pages#6935
Closed
Tighten formatting of CREATE examples in InfluxQL spec pages#6935
Conversation
Add documentation for meta node's `[meta] https-insecure-certificate` configuration. This configuration is available in >= 1.12.3.
Add documentation for `https-insecure-certificate` configuration in `[cluster]` and `[http]` sections.
Add `[tls] advanced-expiration` setting for data nodes.
* 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>
… docs Fix grammar, formatting, and accuracy issues across the new v1.12.3 configuration and backup compression documentation.
…d 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.
… 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 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)
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
…ixes The clause order correction is a bug fix, not a new feature.
#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>
Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Check formatting of CREATE example code blocks in spec.md pages
Tighten formatting of CREATE examples in InfluxQL spec pages
Mar 13, 2026
jstirnaman
approved these changes
Mar 13, 2026
jstirnaman
added
product:v1
Contributor
|
Contributor
PR Preview
Pages included in this preview
Preview auto-deploys on push. Will be cleaned up when PR closes. |
Contributor
Preview Pages for Review2 page(s) changed in this PR: @github-copilot please review the preview pages listed above using the template below: Visual Review PromptReview the rendered documentation pages at the preview URLs listed below. ChecklistFor each preview URL, verify:
OutputFollow the shared review comment format, severity definitions, and label Adapt the "Files Reviewed" section to list preview URLs instead of file Preview URLs |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates InfluxDB v1 OSS and Enterprise documentation, primarily improving InfluxQL reference readability (reflowing examples and restructuring sections), and also adding/adjusting related configuration and release note content.
Changes:
- Reformat and clarify InfluxQL spec content for OSS and Enterprise (wrapped examples, adjusted clause ordering notes, section/heading cleanup, and added/updated statement examples).
- Update database/retention policy docs to reflect
FUTURE LIMIT+PAST LIMITordering and expand ALTER syntax references. - Add new v1.12.3 release notes and document new TLS-related configuration options and Enterprise backup compression flags.
Reviewed changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| content/influxdb/v1/query_language/spec.md | Reflows examples and refines spec structure/links (including notes about FUTURE/PAST LIMIT ordering). |
| content/influxdb/v1/query_language/manage-database.md | Updates CREATE/ALTER retention policy syntax and FUTURE/PAST LIMIT documentation ordering. |
| content/influxdb/v1/administration/config.md | Adds new documented config options (https-insecure-certificate, advanced-expiration) and trims formatting. |
| content/influxdb/v1/about_the_project/release-notes.md | Adds v1.12.3 release notes and updates some existing release-note links. |
| content/enterprise_influxdb/v1/tools/influxd-ctl/backup.md | Expands influxd-ctl backup flags and adds a backup compression section and examples. |
| content/enterprise_influxdb/v1/query_language/spec.md | Mirrors OSS spec readability updates and expands/adjusts statement docs and examples. |
| content/enterprise_influxdb/v1/query_language/manage-database.md | Mirrors OSS manage-database updates for FUTURE/PAST LIMIT ordering and ALTER syntax. |
| content/enterprise_influxdb/v1/administration/configure/config-meta-nodes.md | Documents new https-insecure-certificate option and fixes a config cross-link. |
| content/enterprise_influxdb/v1/administration/configure/config-data-nodes.md | Documents new https-insecure-certificate and advanced-expiration options in relevant sections. |
| content/enterprise_influxdb/v1/about-the-project/release-notes.md | Adds Enterprise v1.12.3 release notes and updates a number of internal links. |
You can also share your feedback on Copilot code review. Take the survey.
|
|
||
| ``` | ||
| show_tag_keys_stmt = "SHOW TAG KEYS" [on_clause] [ from_clause ] [ where_clause ] | ||
| show_tag_keys_stmt = "SHOW TAG KEYS" [on_clause] [with_key_clause] [ from_clause ] [ where_clause ] |
Comment on lines
+91
to
+92
| We do not recommend changing the values for `-gzipBlockCount` and `-gzipBlockSize`. | ||
| These are set to sensible defaults (block size is `1048576` bytes (`1024*1024`)) per the [pgzip library](https://github.com/klauspost/pgzip). |
Comment on lines
+138
to
+141
| The following example uses the fastest possible compression speeds for backup: | ||
|
|
||
| ```sh | ||
| influxd-ctl backup -strategy full -gzipBlockSize 10485760 -gzipBlockCount 28 -gzipCompressionLevel none . |
Comment on lines
+17
to
+22
| ## v1.12.3 {date="2026-01-12"} | ||
|
|
||
| ### Features | ||
|
|
||
| - Add [`https-insecure-certificate` configuration option](/influxdb/v1/administration/config/#https-insecure-certificate) | ||
| to skip file permission checking for TLS certificate and private key files. |
| - Use latest version of InfluxQL package. | ||
| - Add `-lponly` flag to [`influx export`](/influxdb/v2/reference/cli/influx/export/) sub-command. | ||
| - Add the ability to [track number of values](/platform/monitoring/influxdata-platform/tools/measurements-internal/#valueswrittenok) written via the [/debug/vars HTTP endpoint](/influxdb/v1/tools/api/#debug-vars-http-endpoint). | ||
| - Add the ability to [track number of values](/platform/monitoring/influxdata-platform/tools/measurements-internal/#valueswrittenok) written via the [`/debug/vars` HTTP endpoint](/influxdb/v1/tools/api/#debugvars-http-endpoint). |
|
|
||
| The query creates a database called `NOAA_water_database`. | ||
| It also creates a default retention policy for `NOAA_water_database` with a `DURATION` of three days, a [replication factor](/enterprise_influxdb/v1/concepts/glossary/#replication-factor) of one, a [shard group](/enterprise_influxdb/v1/concepts/glossary/#shard-group) duration of one hour, and with the name `liquid`. | ||
| It also creates a default retention policy for `NOAA_water_database` with a `DURATION` of three days, a [replication factor](/enterprise_influxdb/v1/concepts/glossary/#replication-factor-rf) of one, a [shard group](/enterprise_influxdb/v1/concepts/glossary/#shard-group) duration of one hour, and with the name `liquid`. |
Contributor
|
Superseded by #6950 and separate fix-up PRs |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
CREATE statement examples in the InfluxQL spec pages had long, hard-to-scan lines. Reformatted the examples to wrap comments and clauses for readability while keeping syntax unchanged.
Example (before vs after wrapping):
📍 Connect Copilot coding agent with Jira, Azure Boards or Linear to delegate work to Copilot in one click without leaving your project management tool.