From e481e68a01d3cb0ca5f6195093fd2db440dd16b5 Mon Sep 17 00:00:00 2001 From: meelahme Date: Fri, 18 Apr 2025 13:14:21 -0700 Subject: [PATCH 1/7] updating database create for consistency --- content/shared/influxdb3-cli/delete/database.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/shared/influxdb3-cli/delete/database.md b/content/shared/influxdb3-cli/delete/database.md index cba8750afb..d5f5311310 100644 --- a/content/shared/influxdb3-cli/delete/database.md +++ b/content/shared/influxdb3-cli/delete/database.md @@ -11,7 +11,7 @@ influxdb3 delete database [OPTIONS] ## 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. Environment variable: `INFLUXDB3_DATABASE_NAME` From 0c85184b22d89e34a8a5258b268654f685a68501 Mon Sep 17 00:00:00 2001 From: meelahme Date: Fri, 18 Apr 2025 13:39:36 -0700 Subject: [PATCH 2/7] Adding distinct cache value example --- .../influxdb3-cli/create/distinct_cache.md | 31 ++++++++++++++++++- 1 file changed, 30 insertions(+), 1 deletion(-) diff --git a/content/shared/influxdb3-cli/create/distinct_cache.md b/content/shared/influxdb3-cli/create/distinct_cache.md index 008a5e965a..63df8c30f6 100644 --- a/content/shared/influxdb3-cli/create/distinct_cache.md +++ b/content/shared/influxdb3-cli/create/distinct_cache.md @@ -49,4 +49,33 @@ You can use the following environment variables to set command options: | `INFLUXDB3_DATABASE_NAME` | `--database` | | `INFLUXDB3_AUTH_TOKEN` | `--token` | - +## Examples + +### Create a distinct value cache + +{{% code-placeholders "(DATABASE|TABLE|COLUMN|CACHE)_NAME" %}} + + + +```bash +influxdb3 create distinct_cache \ + --database DATABASE_NAME \ + --table TABLE_NAME \ + --column COLUMN_NAME \ + CACHE_NAME +``` + +{{% /code-placeholders %}} + +In the example above, replace the following: + +- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: + Database name +- {{% code-placeholder-key %}}`TABLE_NAME`{{% /code-placeholder-key %}}: + Table name +- {{% code-placeholder-key %}}`CACHE_NAME`{{% /code-placeholder-key %}}: + Name of the distinct value cache to delete +- {{% code-placeholder-key %}}`COLUMN_NAME`{{% /code-placeholder-key %}}: Column to cache distinct values from + + + From 4746e6ed2ad230b4859dbac68e5e8b57282af2af Mon Sep 17 00:00:00 2001 From: meelahme Date: Fri, 18 Apr 2025 13:59:52 -0700 Subject: [PATCH 3/7] Adding a create last value cache example --- .../shared/influxdb3-cli/create/last_cache.md | 27 ++++++++++++++++++- 1 file changed, 26 insertions(+), 1 deletion(-) diff --git a/content/shared/influxdb3-cli/create/last_cache.md b/content/shared/influxdb3-cli/create/last_cache.md index e155cba7ab..79eff93e9a 100644 --- a/content/shared/influxdb3-cli/create/last_cache.md +++ b/content/shared/influxdb3-cli/create/last_cache.md @@ -38,4 +38,29 @@ You can use the following environment variables to set command options: | `INFLUXDB3_DATABASE_NAME` | `--database` | | `INFLUXDB3_AUTH_TOKEN` | `--token` | - +## Examples + +### Create a last value cache + +{{% code-placeholders "(DATABASE|TABLE|CACHE)_NAME (TAG_COLUMN|FIELD_COLUMN)" %}} + + + +```bash +influxdb3 create last_cache \ + --database DATABASE_NAME \ + --table TABLE_NAME \ + --tag-columns TAG_COLUMN \ + --field-columns FIELD_COLUMN \ + CACHE_NAME +``` + +{{% /code-placeholders %}} + +In the example above, replace the following: + +- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: Database name +- {{% code-placeholder-key %}}`TABLE_NAME`{{% /code-placeholder-key %}}: Table name +- {{% code-placeholder-key %}}`TAG_COLUMN`{{% /code-placeholder-key %}}: Column to use as a tag key for the cache +- {{% code-placeholder-key %}}`FIELD_COLUM`N{{% /code-placeholder-key %}}: Column to cache the last value from +- {{% code-placeholder-key %}}`CACHE_NAME`{{% /code-placeholder-key %}}: Name for the new last value cache \ No newline at end of file From 22c9fc486db21209c09ee4c691dbc268ef5e8c97 Mon Sep 17 00:00:00 2001 From: meelahme Date: Fri, 18 Apr 2025 14:18:13 -0700 Subject: [PATCH 4/7] Adding a create plugin example --- content/shared/influxdb3-cli/create/plugin.md | 25 ++++++++++++++++++- 1 file changed, 24 insertions(+), 1 deletion(-) diff --git a/content/shared/influxdb3-cli/create/plugin.md b/content/shared/influxdb3-cli/create/plugin.md index 07271a8da5..ad95c47b76 100644 --- a/content/shared/influxdb3-cli/create/plugin.md +++ b/content/shared/influxdb3-cli/create/plugin.md @@ -39,4 +39,27 @@ You can use the following environment variables to set command options: | `INFLUXDB3_DATABASE_NAME` | `--database` | | `INFLUXDB3_AUTH_TOKEN` | `--token` | - +## Examples + +### Create a plugin + +{{% code-placeholders "(DATABASE|PLUGIN)_NAME (FILENAME|FUNCTION_NAME)" %}} + + + +```bash +influxdb3 create plugin \ + --database DATABASE_NAME \ + --filename FILENAME.py \ + --entry-point FUNCTION_NAME \ + PLUGIN_NAME +``` + +{{% /code-placeholders %}} + +In the example above, replace the following: + +- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: Database name +- {{% code-placeholder-key %}}`FILENAME.py`{{% /code-placeholder-key %}}: Name of the plugin Python file (must be in the plugin directory) +- {{% code-placeholder-key %}}`FUNCTION_NAME`{{% /code-placeholder-key %}}: Name of the function in the Python file to use as the entry point +- {{% code-placeholder-key %}}`PLUGIN_NAME`{{% /code-placeholder-key %}}: Name for the new plugin \ No newline at end of file From 4f11fc160b5d422988ee83ca2aeda317282625c8 Mon Sep 17 00:00:00 2001 From: meelahme Date: Fri, 18 Apr 2025 14:42:01 -0700 Subject: [PATCH 5/7] adding a creating token example --- content/shared/influxdb3-cli/create/token.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/content/shared/influxdb3-cli/create/token.md b/content/shared/influxdb3-cli/create/token.md index 276f32151f..253a2914c3 100644 --- a/content/shared/influxdb3-cli/create/token.md +++ b/content/shared/influxdb3-cli/create/token.md @@ -6,11 +6,24 @@ The `influxdb3 create token` command creates a new authentication token. ```bash -influxdb3 create token +influxdb3 create token ``` ## Options | Option | | Description | | :----- | :------- | :--------------------- | +| |`-- admin`| Create an admin token | | `-h` | `--help` | Print help information | + +## Examples + +### Create an admin token + + + +```bash +influxdb3 create token --admin +``` + +This creates an admin token with full access to the system. From 419955462b63a7c1274a0e09f5fb2d2ceb00bd7a Mon Sep 17 00:00:00 2001 From: Jameelah Mercer <36314199+MeelahMe@users.noreply.github.com> Date: Fri, 18 Apr 2025 15:33:04 -0700 Subject: [PATCH 6/7] Update content/shared/influxdb3-cli/create/token.md Co-authored-by: Jason Stirnaman --- content/shared/influxdb3-cli/create/token.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/shared/influxdb3-cli/create/token.md b/content/shared/influxdb3-cli/create/token.md index 253a2914c3..ac8c775e71 100644 --- a/content/shared/influxdb3-cli/create/token.md +++ b/content/shared/influxdb3-cli/create/token.md @@ -6,7 +6,7 @@ The `influxdb3 create token` command creates a new authentication token. ```bash -influxdb3 create token +influxdb3 create token ``` ## Options From d72eccddc9600ef15ce2a51913696f0f824e5886 Mon Sep 17 00:00:00 2001 From: Jameelah Mercer <36314199+MeelahMe@users.noreply.github.com> Date: Fri, 18 Apr 2025 15:33:10 -0700 Subject: [PATCH 7/7] Update content/shared/influxdb3-cli/create/token.md Co-authored-by: Jason Stirnaman --- content/shared/influxdb3-cli/create/token.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/shared/influxdb3-cli/create/token.md b/content/shared/influxdb3-cli/create/token.md index ac8c775e71..cc96802538 100644 --- a/content/shared/influxdb3-cli/create/token.md +++ b/content/shared/influxdb3-cli/create/token.md @@ -13,7 +13,7 @@ influxdb3 create token | Option | | Description | | :----- | :------- | :--------------------- | -| |`-- admin`| Create an admin token | +| |`--admin`| Create an admin token | | `-h` | `--help` | Print help information | ## Examples