-
Notifications
You must be signed in to change notification settings - Fork 313
Add comprehensive introductory content to CLI and API reference pages #6324
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
Closed
Closed
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
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
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 |
---|---|---|
@@ -1,14 +1,28 @@ | ||
--- | ||
title: Command line tools | ||
description: > | ||
View command line tools used to manage and interact with InfluxDB 3 Core. | ||
InfluxDB 3 Core provides powerful command line tools for database | ||
administration, data management, and system operations. These CLI tools enable | ||
you to efficiently manage your InfluxDB instance, write and query data, and | ||
perform administrative tasks from the command line. | ||
menu: | ||
influxdb3_core: | ||
name: CLIs | ||
parent: Reference | ||
weight: 101 | ||
--- | ||
|
||
View command line tools used to run, manage, and interact with InfluxDB 3 Core: | ||
InfluxDB 3 Core provides powerful command line tools for database administration, data management, and system operations. | ||
These CLI tools enable you to efficiently manage your InfluxDB instance, write and query data, and perform administrative tasks from the command line. | ||
|
||
The command line interface offers a streamlined way to: | ||
|
||
- Start and configure your InfluxDB 3 Core instance | ||
- Create and manage databases and tables | ||
- Write and query time series data | ||
- Perform system administration tasks | ||
- Automate database operations in scripts and workflows | ||
|
||
The following command line tools are available for InfluxDB 3 Core: | ||
|
||
{{< children >}} |
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
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 |
---|---|---|
@@ -1,14 +1,28 @@ | ||
--- | ||
title: Command line tools | ||
description: > | ||
View command line tools used to manage and interact with InfluxDB 3 Enterprise. | ||
InfluxDB 3 Enterprise provides powerful command line tools for database | ||
administration, data management, and system operations. These CLI tools enable | ||
you to efficiently manage your InfluxDB Enterprise instance, write and query data, | ||
and perform administrative tasks from the command line. | ||
menu: | ||
influxdb3_enterprise: | ||
name: CLIs | ||
parent: Reference | ||
weight: 101 | ||
--- | ||
|
||
View command line tools used to run, manage, and interact with InfluxDB 3 Enterprise: | ||
InfluxDB 3 Enterprise provides powerful command line tools for database administration, data management, and system operations. | ||
These CLI tools enable you to efficiently manage your InfluxDB Enterprise instance, write and query data, and perform administrative tasks from the command line. | ||
|
||
The command line interface offers a streamlined way to: | ||
|
||
- Start and configure your InfluxDB 3 Enterprise instance | ||
- Create and manage databases and tables | ||
- Write and query time series data | ||
- Perform system administration tasks | ||
- Automate database operations in scripts and workflows | ||
|
||
The following command line tools are available for InfluxDB 3 Enterprise: | ||
|
||
{{< children >}} |
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 |
---|---|---|
@@ -1,7 +1,18 @@ | ||
The InfluxDB HTTP API provides a programmatic interface for interactions with | ||
{{% product-name %}}, such as writing and querying data, triggering Processing | ||
engine plugins, and managing an InfluxDB 3 instance. | ||
The API includes endpoints for backward compatibility with | ||
InfluxDB v1 and v2 workloads, clients, and third-party tools. | ||
The InfluxDB HTTP API provides a comprehensive programmatic interface for all interactions with | ||
{{% product-name %}}, including writing and querying time series data, triggering Processing | ||
engine plugins, and managing your InfluxDB 3 instance. | ||
|
||
The API is designed for flexibility and performance, offering multiple endpoints to accommodate | ||
different use cases and client library requirements. | ||
Whether you're building real-time monitoring applications, data analytics pipelines, or custom | ||
integrations, the InfluxDB HTTP API provides the tools you need. | ||
|
||
The API includes endpoints for: | ||
|
||
- **Data operations**: Write time series data, execute SQL and InfluxQL queries | ||
- **Database management**: Create and manage databases, tables, and schemas | ||
- **Authentication and authorization**: Manage API tokens and access controls | ||
- **System administration**: Monitor system health and performance metrics | ||
- **Backward compatibility**: Support for InfluxDB v1 and v2 workloads, clients, and third-party tools | ||
|
||
<a class="btn" href="/influxdb3/{{% product-key %}}/api/v3/">{{% product-name %}} HTTP API</a> |
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.
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.