-
Notifications
You must be signed in to change notification settings - Fork 321
chore: 3.7 update #6557
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
chore: 3.7 update #6557
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
16 changes: 16 additions & 0 deletions
16
content/influxdb3/core/reference/cli/influxdb3/show/retention.md
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| --- | ||
| title: influxdb3 show retention | ||
| description: > | ||
| The `influxdb3 show retention` command displays retention policies and effective | ||
| retention periods for tables in your InfluxDB 3 Core server. | ||
| menu: | ||
| influxdb3_core: | ||
| parent: influxdb3 show | ||
| name: influxdb3 show retention | ||
| weight: 410 | ||
| source: /shared/influxdb3-cli/show/retention.md | ||
| --- | ||
|
|
||
| <!-- | ||
| //SOURCE content/shared/influxdb3-cli/show/retention.md | ||
| --> |
16 changes: 16 additions & 0 deletions
16
content/influxdb3/enterprise/reference/cli/influxdb3/show/retention.md
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| --- | ||
| title: influxdb3 show retention | ||
| description: > | ||
| The `influxdb3 show retention` command displays effective | ||
| retention periods for tables in your InfluxDB 3 Enterprise server. | ||
| menu: | ||
| influxdb3_enterprise: | ||
| parent: influxdb3 show | ||
| name: influxdb3 show retention | ||
| weight: 410 | ||
| source: /shared/influxdb3-cli/show/retention.md | ||
| --- | ||
|
|
||
| <!-- | ||
| //SOURCE content/shared/influxdb3-cli/show/retention.md | ||
| --> |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,90 @@ | ||
| The `influxdb3 show retention` command displays effective retention periods for tables in your {{< product-name >}} server. | ||
|
|
||
| ## Usage | ||
|
|
||
| <!--pytest.mark.skip--> | ||
|
|
||
| ```bash | ||
| influxdb3 show retention [OPTIONS] | ||
| ``` | ||
|
|
||
| ## Options | ||
|
|
||
| | Option | | Description | | ||
| | :----- | :----------- | :--------------------------------------------------------------------------------------- | | ||
| | `-H` | `--host` | Host URL of the running {{< product-name >}} server (default is `http://127.0.0.1:8181`) | | ||
| | | `--token` | *({{< req >}})* Authentication token | | ||
| | | `--database` | Filter retention information by database name | | ||
| | | `--format` | Output format (`pretty` *(default)*, `json`, `jsonl`, `csv`, or `parquet`) | | ||
| | | `--tls-ca` | Path to a custom TLS certificate authority (for testing or self-signed certificates) | | ||
| | `-h` | `--help` | Print help information | | ||
| | | `--help-all` | Print detailed help information | | ||
|
|
||
| ### Option environment variables | ||
|
|
||
| You can use the following environment variables to set command options: | ||
|
|
||
| | Environment Variable | Option | | ||
| | :------------------------ | :----------- | | ||
| | `INFLUXDB3_HOST_URL` | `--host` | | ||
| | `INFLUXDB3_DATABASE_NAME` | `--database` | | ||
| | `INFLUXDB3_AUTH_TOKEN` | `--token` | | ||
|
|
||
| ## Examples | ||
|
|
||
| - [Show retention for all tables](#show-retention-for-all-tables) | ||
| - [Show retention for a specific database](#show-retention-for-a-specific-database) | ||
| - [Show retention in JSON format](#show-retention-in-json-format) | ||
|
|
||
| ### Show retention for all tables | ||
|
|
||
| <!--pytest.mark.skip--> | ||
|
|
||
| ```bash | ||
| influxdb3 show retention \ | ||
| --host http://localhost:8181 \ | ||
| --token YOUR_AUTH_TOKEN | ||
| ``` | ||
|
|
||
| ### Show retention for a specific database | ||
|
|
||
| <!--pytest.mark.skip--> | ||
|
|
||
| ```bash | ||
| influxdb3 show retention \ | ||
| --host http://localhost:8181 \ | ||
| --token YOUR_AUTH_TOKEN \ | ||
| --database mydb | ||
| ``` | ||
|
|
||
| ### Show retention in JSON format | ||
|
|
||
| <!--pytest.mark.skip--> | ||
|
|
||
| ```bash | ||
| influxdb3 show retention \ | ||
| --host http://localhost:8181 \ | ||
| --token YOUR_AUTH_TOKEN \ | ||
| --format json | ||
| ``` | ||
|
|
||
| ## Output | ||
|
|
||
| The command displays the following information for each table: | ||
|
|
||
| - **Database**: The database name | ||
| - **Table**: The table name | ||
| - **Retention**: The *effective* retention period in human-readable format (for example, "7d" for 7 days, "24h" for 24 hours, "infinite" for no retention) | ||
| - **Source**: Where the retention is defined (`table`, `database`, or `infinite`) | ||
|
|
||
| ### Example output | ||
|
|
||
| ``` | ||
| Database | Table | Retention | Source | ||
| ---------|-------------|-----------|---------- | ||
| mydb | cpu | 7d | database | ||
| mydb | mem | 24h | table | ||
| mydb | disk | infinite | infinite | ||
| ``` | ||
|
|
||
| Tables with table-level retention policies override the database-level retention. Tables without explicit retention policies inherit the database retention or have infinite retention if none is set. |
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
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@jstirnaman On further review, this should not be here. Especially because this was for Core/Ent and I believe this is for all v3. However, not sure how to update our actual HTTP API docs for this, so not sure where to land that. It's not significant enough to warrant its own docs imo outside of the API spec.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm making a small change, but it belongs here. I'll work on API docs after this.