Skip to content

Adding adequate CLI examples for creating triggers #6002

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

Draft
wants to merge 7 commits into
base: master
Choose a base branch
from

Conversation

MeelahMe
Copy link
Contributor

Closes #5949

@MeelahMe MeelahMe linked an issue Apr 18, 2025 that may be closed by this pull request
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR updates the CLI documentation for deleting databases to include clearer examples of valid database names.

  • Updated the DATABASE_NAME argument description to specify acceptable naming conventions.
Comments suppressed due to low confidence (1)

content/shared/influxdb3-cli/delete/database.md:14

  • [nitpick] Consider clarifying the naming convention by explicitly stating that while the first character must be alphanumeric, subsequent characters may include dashes and underscores. For example, add a note indicating that dashes and underscores cannot be used as the first character.
- **DATABASE_NAME**: The name of the database to delete. Valid database names are alphanumeric and start with a letter or number. Dashes (`-`) and underscores (`_`) are allowed.

Copy link
Contributor

@jstirnaman jstirnaman left a comment

Choose a reason for hiding this comment

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

Good work - just be sure to test your examples against the latest versions.

@@ -39,4 +39,27 @@ You can use the following environment variables to set command options:
| `INFLUXDB3_DATABASE_NAME` | `--database` |
| `INFLUXDB3_AUTH_TOKEN` | `--token` |

<!-- TODO: GET EXAMPLES -->
## Examples
Copy link
Contributor

Choose a reason for hiding this comment

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

plugin operations don't exist anymore. We should delete this and any other pages for plugin CRUD commands.

@@ -11,7 +11,7 @@ influxdb3 delete database [OPTIONS] <DATABASE_NAME>

## Arguments

- **DATABASE_NAME**: The name of the database to delete.
- **DATABASE_NAME**: The name of the database to delete. Valid database names are alphanumeric and start with a letter or number. Dashes (`-`) and underscores (`_`) are allowed.
Copy link
Contributor

Choose a reason for hiding this comment

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

Name requirements are really only necessary for create, b/c you need to know what chars you can use. For delete, you just need to know the existing database name. However, if we don't already mention the (token) permissions required, we should add that.

@MeelahMe MeelahMe removed the request for review from sanderson April 18, 2025 22:26
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.

Add API reference examples to Influxdb3
2 participants