diff --git a/content/influxdb3/explorer/get-started.md b/content/influxdb3/explorer/get-started.md new file mode 100644 index 000000000..244191130 --- /dev/null +++ b/content/influxdb3/explorer/get-started.md @@ -0,0 +1,132 @@ +--- +title: Get started with InfluxDB 3 Explorer +description: > + Learn how to use InfluxDB 3 Explorer to connect to InfluxDB 3, write data, and + query data. +menu: + influxdb3_explorer: + name: Get started +weight: 3 +--- + +Get started with {{% product-name %}} by connecting it to an InfluxDB 3 instance, +writing data to InfluxDB, and then querying that data. This guide walks you +through each of those steps. + +1. [Connect to an InfluxDB 3 server](#connect-to-an-influxdb-3-server) +2. [Write data to InfluxDB](#write-data-to-influxdb) +3. [Query data from InfluxDB](#query-data-from-influxdb) + +> [!Note] +> This guide assumes you have already [installed {{% product-name %}}](/influxdb3/explorer/install/). + +## Connect to an InfluxDB 3 server + +InfluxDB 3 Explorer supports the following InfluxDB 3 products: + +- [InfluxDB 3 Core](/influxdb3/core/) +- [InfluxDB 3 Enterprise](/influxdb3/enterprise/) + +1. Navigate to **Configure** > **Servers**. +2. Click **+ Connect Your First Server**. +3. Provide the following InfluxDB 3 server information: + + - **Server name**: A name to identify the InfluxDB 3 server you're connecting to. + - **Server URL**: The URL used to connect to your InfluxDB 3 server. + - Select the protocol to use (http or https). + - Provide the host and, if necessary, the port. + - **Token**: The authorization token to use to connect to your InfluxDB 3 server. + We recommend using an InfluxDB 3 _admin_ token. + + > [!Important] + > #### Token permissions may limit Explorer functionality + > + > The permissions associated with the provided token determine what + > databases you can access using this server configuration. InfluxDB 3 + > tokens with limited permissions may not be able to use some Explorer + > functionality. + +4. Click **Add Server**. + +InfluxDB 3 Explorer attempts to verify the connection. If successful, Explorer +saves the server configuration and selects it as the active server. + +> [!Note] +> If you already have data in your InfluxDB 3 instance, skip to +> [Query data from InfluxDB](#query-data-from-influxdb). + +## Write data to InfluxDB + +{{% product-name %}} lets you write data to InfluxDB 3 and provides multiple +options. For this getting started guide, use Explorer to write one of the +sample data sets to InfluxDB: + +1. Navigate to **Write Data** > **Sample/Dev Data**. +2. Select any of the available sample data sets. +3. Click **Write Sample Data**. + +{{% product-name %}} creates a new database and then writes the sample data to +the database. + +### Other write methods + +{{% product-name %}} provides other ways to write data to InfluxDB, including +the following: + +- Line protocol +- CSV or JSON +- InfluxDB 3 client libraries +- Telegraf + +## Query data from InfluxDB + +To use {{% product-name %}} to query data from InfluxDB 3, navigate to +**Query Data** > **Data Explorer**. + +The _Data Explorer_ lets you explore the +schema of your database and automatically builds SQL queries by either +selecting columns in the _Schema Browser_ or by using _Natural Language_ with +the {{% product-name %}} OpenAI integration. + +For this getting started guide, use the Schema Browser to build a SQL query +that returns data from the newly written sample data set. + +1. On the **Data Explorer** in the **Schema** column, select the database you + want to query from the database dropdown menu. + Once selected, all tables in the database appear. +2. Click the name of the table you want to query to expand and view all the + columns in that table. +3. Select each column you want to query. + As you select columns in the Schema Browser, Explorer generates and updates + an SQL query in the _Query pane_. +4. Use the time range dropdown menu above the Query pane to select a time range + to query. You can select one of the predefined relative time ranges, or you + can select _Custom Range_ to define an absolute time range to query. +5. With columns and a time range selected, click **Run Query**. + +{{% product-name %}} runs the query and returns the results in the _Results pane_. +The Results pane provides three view options: + +- **Table** _(default)_: Displays raw query results in paginated table format. +- **Line**: Displays query results in a line graph. +- **Bar**: Displays query results in a bar graph. + +> [!Tip] +> SQL query results may not be ordered by `time` and Line and Bar graph +> visualizations may behave unexpectedly. To order results by time: +> +> - Ensure that you query the `time` column +> - Update the query to include an `ORDER BY time` clause. + +Congratulations! You have successfully used {{% product-name %}} to connect to, +write data to, and query data from an InfluxDB 3 instance. + +## Video walkthrough + +{{< youtube "zW2Hi1Ki4Eo" >}} + + diff --git a/content/influxdb3/explorer/get-started/_index.md b/content/influxdb3/explorer/get-started/_index.md deleted file mode 100644 index e15e4a3c4..000000000 --- a/content/influxdb3/explorer/get-started/_index.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: Get started using InfluxDB 3 Explorer -description: Follow steps to get started using InfluxDB 3 Explorer. -menu: - influxdb3_explorer: - name: Get started -weight: 3 ---- - -Follow steps to get started using InfluxDB 3 Explorer. - -{{< youtube "zW2Hi1Ki4Eo" >}} - - diff --git a/content/influxdb3/explorer/get-started/connect.md b/content/influxdb3/explorer/get-started/connect.md deleted file mode 100644 index 7d717c024..000000000 --- a/content/influxdb3/explorer/get-started/connect.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Connect to a server -description: - Use InfluxDB 3 Explorer to connect to an InfluxDB 3 server. -menu: - influxdb3_explorer: - parent: Get started -weight: 101 -draft: true ---- - -Use InfluxDB 3 Explorer to connect to an InfluxDB 3 server. \ No newline at end of file diff --git a/content/influxdb3/explorer/manage-databases.md b/content/influxdb3/explorer/manage-databases.md new file mode 100644 index 000000000..e076f3707 --- /dev/null +++ b/content/influxdb3/explorer/manage-databases.md @@ -0,0 +1,44 @@ +--- +title: Manage databases with InfluxDB 3 Explorer +seotitle: Manage InfluxDB databases with InfluxDB 3 Explorer +menu: + influxdb3_explorer: + name: Manage Databases +draft: true +--- + + + +## View databases + +## Create a database + +> [!Important] +> Using {{% product-name %}} to create a database in InfluxDB 3 requires that +> Explorer is running in [admin mode](/influxdb3/explorer/install/#run-in-query-or-admin-mode) +> and that the token used in the InfluxDB 3 server configuration is an +> [admin token](/influxdb3/enterprise/admin/tokens/admin/). + +To use {{% product-name %}} to create a new database in an InfluxDB 3 instance: + +1. Navigate to **Manage Databases**. +2. Click **+ Create New**. +3. Provide a **Database name**. + _For information about naming restrictions, see + [InfluxDB 3 naming restrictions](/influxdb3/enterprise/admin/databases/create/#database-naming-restrictions)._ +4. _(Optional)_ Specify a **Retention Period** for the database. + This determines how long InfluxDB retains data (based on timestamp) in the + database before expiring and removing the data. If no retention period is + specified, InfluxDB does not expire data in the database. + + Set the following: + + - **Retention Period**: The number of time units to retain data. + - **Unit**: The unit of time to use in the retention period definition. + +5. Click **{{< icon "check" >}} Create Database**. + +## Delete a database \ No newline at end of file