Skip to content

Commit d6383cd

Browse files
sandersonCopilotjstirnaman
authored
Get started with InfluxDB 3 Explorer (#6155)
* add get started content to explorer docs * add get started content to explorer docs * Apply suggestions from code review Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update content/influxdb3/explorer/get-started.md Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
1 parent 050c971 commit d6383cd

File tree

4 files changed

+176
-26
lines changed

4 files changed

+176
-26
lines changed

‎content/influxdb3/explorer/get-started.md

Lines changed: 132 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
1+
---
2+
title: Get started with InfluxDB 3 Explorer
3+
description: >
4+
Learn how to use InfluxDB 3 Explorer to connect to InfluxDB 3, write data, and
5+
query data.
6+
menu:
7+
influxdb3_explorer:
8+
name: Get started
9+
weight: 3
10+
---
11+
12+
Get started with {{% product-name %}} by connecting it to an InfluxDB 3 instance,
13+
writing data to InfluxDB, and then querying that data. This guide walks you
14+
through each of those steps.
15+
16+
1. [Connect to an InfluxDB 3 server](#connect-to-an-influxdb-3-server)
17+
2. [Write data to InfluxDB](#write-data-to-influxdb)
18+
3. [Query data from InfluxDB](#query-data-from-influxdb)
19+
20+
> [!Note]
21+
> This guide assumes you have already [installed {{% product-name %}}](/influxdb3/explorer/install/).
22+
23+
## Connect to an InfluxDB 3 server
24+
25+
InfluxDB 3 Explorer supports the following InfluxDB 3 products:
26+
27+
- [InfluxDB 3 Core](/influxdb3/core/)
28+
- [InfluxDB 3 Enterprise](/influxdb3/enterprise/)
29+
30+
1. Navigate to **Configure** > **Servers**.
31+
2. Click **+ Connect Your First Server**.
32+
3. Provide the following InfluxDB 3 server information:
33+
34+
- **Server name**: A name to identify the InfluxDB 3 server you're connecting to.
35+
- **Server URL**: The URL used to connect to your InfluxDB 3 server.
36+
- Select the protocol to use (http or https).
37+
- Provide the host and, if necessary, the port.
38+
- **Token**: The authorization token to use to connect to your InfluxDB 3 server.
39+
We recommend using an InfluxDB 3 _admin_ token.
40+
41+
> [!Important]
42+
> #### Token permissions may limit Explorer functionality
43+
>
44+
> The permissions associated with the provided token determine what
45+
> databases you can access using this server configuration. InfluxDB 3
46+
> tokens with limited permissions may not be able to use some Explorer
47+
> functionality.
48+
49+
4. Click **Add Server**.
50+
51+
InfluxDB 3 Explorer attempts to verify the connection. If successful, Explorer
52+
saves the server configuration and selects it as the active server.
53+
54+
> [!Note]
55+
> If you already have data in your InfluxDB 3 instance, skip to
56+
> [Query data from InfluxDB](#query-data-from-influxdb).
57+
58+
## Write data to InfluxDB
59+
60+
{{% product-name %}} lets you write data to InfluxDB 3 and provides multiple
61+
options. For this getting started guide, use Explorer to write one of the
62+
sample data sets to InfluxDB:
63+
64+
1. Navigate to **Write Data** > **Sample/Dev Data**.
65+
2. Select any of the available sample data sets.
66+
3. Click **Write Sample Data**.
67+
68+
{{% product-name %}} creates a new database and then writes the sample data to
69+
the database.
70+
71+
### Other write methods
72+
73+
{{% product-name %}} provides other ways to write data to InfluxDB, including
74+
the following:
75+
76+
- Line protocol
77+
- CSV or JSON
78+
- InfluxDB 3 client libraries
79+
- Telegraf
80+
81+
## Query data from InfluxDB
82+
83+
To use {{% product-name %}} to query data from InfluxDB 3, navigate to
84+
**Query Data** > **Data Explorer**.
85+
86+
The _Data Explorer_ lets you explore the
87+
schema of your database and automatically builds SQL queries by either
88+
selecting columns in the _Schema Browser_ or by using _Natural Language_ with
89+
the {{% product-name %}} OpenAI integration.
90+
91+
For this getting started guide, use the Schema Browser to build a SQL query
92+
that returns data from the newly written sample data set.
93+
94+
1. On the **Data Explorer** in the **Schema** column, select the database you
95+
want to query from the database dropdown menu.
96+
Once selected, all tables in the database appear.
97+
2. Click the name of the table you want to query to expand and view all the
98+
columns in that table.
99+
3. Select each column you want to query.
100+
As you select columns in the Schema Browser, Explorer generates and updates
101+
an SQL query in the _Query pane_.
102+
4. Use the time range dropdown menu above the Query pane to select a time range
103+
to query. You can select one of the predefined relative time ranges, or you
104+
can select _Custom Range_ to define an absolute time range to query.
105+
5. With columns and a time range selected, click **Run Query**.
106+
107+
{{% product-name %}} runs the query and returns the results in the _Results pane_.
108+
The Results pane provides three view options:
109+
110+
- **Table** _(default)_: Displays raw query results in paginated table format.
111+
- **Line**: Displays query results in a line graph.
112+
- **Bar**: Displays query results in a bar graph.
113+
114+
> [!Tip]
115+
> SQL query results may not be ordered by `time` and Line and Bar graph
116+
> visualizations may behave unexpectedly. To order results by time:
117+
>
118+
> - Ensure that you query the `time` column
119+
> - Update the query to include an `ORDER BY time` clause.
120+
121+
Congratulations! You have successfully used {{% product-name %}} to connect to,
122+
write data to, and query data from an InfluxDB 3 instance.
123+
124+
## Video walkthrough
125+
126+
{{< youtube "zW2Hi1Ki4Eo" >}}
127+
128+
<!--
129+
## Next steps
130+
131+
TO-DO: Provide links to deeper content as we release it
132+
-->

‎content/influxdb3/explorer/get-started/_index.md

Lines changed: 0 additions & 14 deletions
This file was deleted.

‎content/influxdb3/explorer/get-started/connect.md

Lines changed: 0 additions & 12 deletions
This file was deleted.

‎content/influxdb3/explorer/manage-databases.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
title: Manage databases with InfluxDB 3 Explorer
3+
seotitle: Manage InfluxDB databases with InfluxDB 3 Explorer
4+
menu:
5+
influxdb3_explorer:
6+
name: Manage Databases
7+
draft: true
8+
---
9+
10+
<!--
11+
MARKED AS DRAFT.
12+
SAVING CONTENT FOR A FUTURE PR.
13+
-->
14+
15+
## View databases
16+
17+
## Create a database
18+
19+
> [!Important]
20+
> Using {{% product-name %}} to create a database in InfluxDB 3 requires that
21+
> Explorer is running in [admin mode](/influxdb3/explorer/install/#run-in-query-or-admin-mode)
22+
> and that the token used in the InfluxDB 3 server configuration is an
23+
> [admin token](/influxdb3/enterprise/admin/tokens/admin/).
24+
25+
To use {{% product-name %}} to create a new database in an InfluxDB 3 instance:
26+
27+
1. Navigate to **Manage Databases**.
28+
2. Click **+ Create New**.
29+
3. Provide a **Database name**.
30+
_For information about naming restrictions, see
31+
[InfluxDB 3 naming restrictions](/influxdb3/enterprise/admin/databases/create/#database-naming-restrictions)._
32+
4. _(Optional)_ Specify a **Retention Period** for the database.
33+
This determines how long InfluxDB retains data (based on timestamp) in the
34+
database before expiring and removing the data. If no retention period is
35+
specified, InfluxDB does not expire data in the database.
36+
37+
Set the following:
38+
39+
- **Retention Period**: The number of time units to retain data.
40+
- **Unit**: The unit of time to use in the retention period definition.
41+
42+
5. Click **{{< icon "check" >}} Create Database**.
43+
44+
## Delete a database

0 commit comments

Comments
 (0)