Merge pull request #46 from influxdata/children-shortcode
New children shortcode and page weightspull/47/head
Scott Anderson
GitHub
commit
2584d0a2c0
|
|
@ -58,7 +58,7 @@ menu:
|
|||
v2_0:
|
||||
name: # Article name that only appears in the left nav
|
||||
parent: # Specifies a parent group and nests navigation items
|
||||
weight: # Determines sort order.
|
||||
weight: # Determines sort order in both the nav tree and in article lists.
|
||||
draft: # If true, will not render page on build
|
||||
enterprise_all: # If true, specifies the doc as a whole is specific to InfluxDB Enterprise
|
||||
enterprise_some: # If true, specifies the doc includes some content specific to InfluxDB Enterprise
|
||||
|
|
@ -78,6 +78,15 @@ Search engines use this in search results (not the page's h1) and therefore it s
|
|||
The `name` attribute under the `menu` frontmatter determines the text used in each page's link in the site navigation.
|
||||
It should be short and assume the context of its parent if it has one.
|
||||
|
||||
#### Page Weights
|
||||
To ensure pages are sorted both by weight and their depth in the directory
|
||||
structure, pages should be weighted in "levels."
|
||||
All top level pages are weighted 1-99.
|
||||
The next level is 101-199.
|
||||
Then 201-299 and so on.
|
||||
|
||||
_**Note:** `_index.md` files should be weighted one level up from the other `.md` files in the same directory._
|
||||
|
||||
### Article headings
|
||||
Use only h2-h6 headings in markdown content.
|
||||
h1 headings act as the page title and are populated automatically from the `title` frontmatter.
|
||||
|
|
@ -250,6 +259,23 @@ To automate the listing of articles in a section, use the `{{< children >}}` sho
|
|||
{{< children >}}
|
||||
```
|
||||
|
||||
The children shortcode can also be used to list only "section" articles (those with their own children),
|
||||
or only "page" articles (those with no children) using the `show` argument:
|
||||
|
||||
```md
|
||||
{{< children show="sections" >}}
|
||||
<!-- OR -->
|
||||
{{< children show="pages" >}}
|
||||
```
|
||||
|
||||
_By default, it displays both sections and pages._
|
||||
|
||||
There is also a special use-case designed for listing Flux functions using the `type` argument:
|
||||
|
||||
```md
|
||||
{{< children type="functions" >}}
|
||||
```
|
||||
|
||||
### Reference content
|
||||
The InfluxDB documentation is "task-based," meaning content primarily focuses on
|
||||
what a user is **doing**, not what they are **using**.
|
||||
|
|
|
|||
|
|
@ -3,10 +3,10 @@ title: Collect data with InfluxDB
|
|||
description: >
|
||||
InfluxDB provides multiple ways to collect time series data including using Telegraf,
|
||||
using InfluxDB's built-in data scraper, and using line protocol.
|
||||
weight: 2
|
||||
menu:
|
||||
v2_0:
|
||||
name: Collect data
|
||||
weight: 2
|
||||
---
|
||||
|
||||
_More information about collecting data with InfluxDB v2.0 is coming shortly._
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ description: This is just an example post to show the format of new 2.0 posts
|
|||
menu:
|
||||
v2_0:
|
||||
name: Example post
|
||||
weight: 1
|
||||
weight: 1
|
||||
#enterprise_all: true
|
||||
enterprise_some: true
|
||||
draft: true
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ description: Download, install, and setup InfluxDB, creating a default organizat
|
|||
menu:
|
||||
v2_0:
|
||||
name: Get started
|
||||
weight: 1
|
||||
weight: 1
|
||||
---
|
||||
|
||||
Get started with InfluxDB v2.0 by downloading InfluxDB, installing the necessary
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ description: Manage organizations in InfluxDB using the InfluxDB UI or the influ
|
|||
menu:
|
||||
v2_0:
|
||||
name: Manage organizations
|
||||
weight: 10
|
||||
weight: 10
|
||||
---
|
||||
|
||||
An **organization** is a workspace for a group of users.
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ menu:
|
|||
v2_0:
|
||||
name: Manage buckets
|
||||
parent: Manage organizations
|
||||
weight: 5
|
||||
weight: 105
|
||||
---
|
||||
|
||||
A **bucket** is a named location where time series data is stored.
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ menu:
|
|||
v2_0:
|
||||
name: Create a bucket
|
||||
parent: Manage buckets
|
||||
weight: 1
|
||||
weight: 201
|
||||
---
|
||||
|
||||
Use the InfluxDB user interface (UI) or the `influx` command line interface (CLI)
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ menu:
|
|||
v2_0:
|
||||
name: Delete a bucket
|
||||
parent: Manage buckets
|
||||
weight: 3
|
||||
weight: 203
|
||||
---
|
||||
|
||||
Use the InfluxDB user interface (UI) or the `influx` command line interface (CLI)
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ menu:
|
|||
v2_0:
|
||||
name: Update a bucket
|
||||
parent: Manage buckets
|
||||
weight: 2
|
||||
weight: 202
|
||||
---
|
||||
|
||||
Use the InfluxDB user interface (UI) or the `influx` command line interface (CLI)
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ menu:
|
|||
v2_0:
|
||||
name: View buckets
|
||||
parent: Manage buckets
|
||||
weight: 2
|
||||
weight: 202
|
||||
---
|
||||
|
||||
## View buckets in the InfluxDB UI
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ menu:
|
|||
v2_0:
|
||||
name: Create an organization
|
||||
parent: Manage organizations
|
||||
weight: 1
|
||||
weight: 101
|
||||
---
|
||||
|
||||
Use the InfluxDB user interface (UI) or the `influx` command line interface (CLI)
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ menu:
|
|||
v2_0:
|
||||
name: Delete an organization
|
||||
parent: Manage organizations
|
||||
weight: 4
|
||||
weight: 104
|
||||
---
|
||||
|
||||
Use the InfluxDB user interface (UI) or the `influx` command line interface (CLI)
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ menu:
|
|||
v2_0:
|
||||
name: Manage members
|
||||
parent: Manage organizations
|
||||
weight: 6
|
||||
weight: 106
|
||||
---
|
||||
|
||||
A **member** is a user that belongs to an organization.
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ menu:
|
|||
v2_0:
|
||||
name: Add a member
|
||||
parent: Manage members
|
||||
weight: 1
|
||||
weight: 201
|
||||
draft: true
|
||||
---
|
||||
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ menu:
|
|||
v2_0:
|
||||
name: Remove a member
|
||||
parent: Manage members
|
||||
weight: 3
|
||||
weight: 203
|
||||
draft: true
|
||||
---
|
||||
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ menu:
|
|||
v2_0:
|
||||
name: View members
|
||||
parent: Manage members
|
||||
weight: 2
|
||||
weight: 202
|
||||
---
|
||||
|
||||
Use the InfluxDB user interface (UI) or the `influx` command line interface (CLI)
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ menu:
|
|||
v2_0:
|
||||
name: Update an organization
|
||||
parent: Manage organizations
|
||||
weight: 3
|
||||
weight: 103
|
||||
---
|
||||
|
||||
Use the InfluxDB user interface (UI) or the `influx` command line interface (CLI)
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ menu:
|
|||
v2_0:
|
||||
name: View organizations
|
||||
parent: Manage organizations
|
||||
weight: 2
|
||||
weight: 102
|
||||
---
|
||||
|
||||
Use the InfluxDB user interface (UI) or the `influx` command line interface (CLI)
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@ description: >
|
|||
menu:
|
||||
v2_0:
|
||||
name: Process data
|
||||
weight: 5
|
||||
weight: 5
|
||||
---
|
||||
|
||||
InfluxDB's _**task engine**_ is designed for processing and analyzing data.
|
||||
|
|
@ -23,7 +23,4 @@ The following articles explain how to configure and build tasks using the Influx
|
|||
and via raw Flux scripts with the `influx` command line interface (CLI).
|
||||
They also provide examples of commonly used tasks.
|
||||
|
||||
[Write a task](/v2.0/process-data/write-a-task)
|
||||
[Manage Tasks](/v2.0/process-data/manage-tasks)
|
||||
[Common Tasks](/v2.0/process-data/common-tasks)
|
||||
[Task Options](/v2.0/process-data/task-options)
|
||||
{{< children >}}
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ menu:
|
|||
v2_0:
|
||||
name: Common tasks
|
||||
parent: Process data
|
||||
weight: 4
|
||||
weight: 104
|
||||
---
|
||||
|
||||
The following articles walk through common task use cases.
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ menu:
|
|||
v2_0:
|
||||
name: Downsample data
|
||||
parent: Common tasks
|
||||
weight: 4
|
||||
weight: 201
|
||||
---
|
||||
|
||||
One of the most common use cases for InfluxDB tasks is downsampling data to reduce
|
||||
|
|
|
|||
|
|
@ -8,14 +8,11 @@ menu:
|
|||
v2_0:
|
||||
name: Manage tasks
|
||||
parent: Process data
|
||||
weight: 2
|
||||
weight: 102
|
||||
---
|
||||
|
||||
InfluxDB provides two options for managing the creation, reading, updating, and deletion (CRUD) of tasks -
|
||||
through the InfluxDB user interface (UI) or using the `influx` command line interface (CLI).
|
||||
Both tools can perform all task CRUD operations.
|
||||
|
||||
[Create a task](/v2.0/process-data/manage-tasks/create-task)
|
||||
[View tasks](/v2.0/process-data/manage-tasks/view-tasks)
|
||||
[Update a task](/v2.0/process-data/manage-tasks/update-task)
|
||||
[Delete a task](/v2.0/process-data/manage-tasks/delete-task)
|
||||
{{< children >}}
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ menu:
|
|||
v2_0:
|
||||
name: Create a task
|
||||
parent: Manage tasks
|
||||
weight: 1
|
||||
weight: 201
|
||||
---
|
||||
|
||||
InfluxDB provides multiple ways to create tasks both in the InfluxDB user interface (UI)
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ menu:
|
|||
v2_0:
|
||||
name: Delete a task
|
||||
parent: Manage tasks
|
||||
weight: 4
|
||||
weight: 204
|
||||
---
|
||||
|
||||
## Delete a task in the InfluxDB UI
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ menu:
|
|||
v2_0:
|
||||
name: Update a task
|
||||
parent: Manage tasks
|
||||
weight: 3
|
||||
weight: 203
|
||||
---
|
||||
|
||||
## Update a task in the InfluxDB UI
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ menu:
|
|||
v2_0:
|
||||
name: View tasks
|
||||
parent: Manage tasks
|
||||
weight: 2
|
||||
weight: 202
|
||||
---
|
||||
|
||||
## View tasks in the InfluxDB UI
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ menu:
|
|||
v2_0:
|
||||
name: Task options
|
||||
parent: Process data
|
||||
weight: 5
|
||||
weight: 105
|
||||
---
|
||||
|
||||
Task options define specific information about the task and are specified in your
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ menu:
|
|||
v2_0:
|
||||
name: Write a task
|
||||
parent: Process data
|
||||
weight: 1
|
||||
weight: 101
|
||||
---
|
||||
|
||||
InfluxDB tasks are scheduled Flux scripts that take a stream of input data, modify or analyze
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@ description: >
|
|||
menu:
|
||||
v2_0:
|
||||
name: Query data
|
||||
weight: 2
|
||||
weight: 2
|
||||
---
|
||||
|
||||
Learn to query data stored in InfluxDB using Flux and tools such as the InfluxDB
|
||||
|
|
|
|||
|
|
@ -2,11 +2,11 @@
|
|||
title: Execute queries
|
||||
seotitle: Different ways to query InfluxDB
|
||||
description: There are multiple ways to query data from InfluxDB including the the InfluxDB UI, CLI, and API.
|
||||
weight: 102
|
||||
menu:
|
||||
v2_0:
|
||||
name: Execute queries
|
||||
parent: Query data
|
||||
weight: 2
|
||||
---
|
||||
|
||||
There are multiple ways to execute queries with InfluxDB.
|
||||
|
|
|
|||
|
|
@ -3,11 +3,11 @@ title: Get started with Flux
|
|||
description: >
|
||||
Get started with Flux, InfluxData's functional data scripting language.
|
||||
This step-by-step guide through the basics of writing a Flux query.
|
||||
weight: 101
|
||||
menu:
|
||||
v2_0:
|
||||
name: Get started with Flux
|
||||
parent: Query data
|
||||
weight: 1
|
||||
---
|
||||
|
||||
Flux is InfluxData's functional data scripting language designed for querying,
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ menu:
|
|||
v2_0:
|
||||
name: Query InfluxDB
|
||||
parent: Get started with Flux
|
||||
weight: 1
|
||||
weight: 201
|
||||
---
|
||||
|
||||
This guide walks through the basics of using Flux to query data from InfluxDB.
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ menu:
|
|||
v2_0:
|
||||
name: Syntax basics
|
||||
parent: Get started with Flux
|
||||
weight: 3
|
||||
weight: 203
|
||||
---
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ menu:
|
|||
v2_0:
|
||||
name: Transform data
|
||||
parent: Get started with Flux
|
||||
weight: 2
|
||||
weight: 202
|
||||
---
|
||||
|
||||
When [querying data from InfluxDB](/v2.0/query-data/get-started/query-influxdb),
|
||||
|
|
|
|||
|
|
@ -1,13 +1,13 @@
|
|||
---
|
||||
title: Flux how-to guides
|
||||
description: Helpful guides that walk through both common and complex tasks and use cases for Flux.
|
||||
weight: 103
|
||||
menu:
|
||||
v2_0:
|
||||
name: How-to guides
|
||||
parent: Query data
|
||||
weight: 3
|
||||
---
|
||||
|
||||
The following guides walk through common query uses cases.
|
||||
|
||||
{{% children %}}
|
||||
{{< children >}}
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ menu:
|
|||
v2_0:
|
||||
name: Create custom functions
|
||||
parent: How-to guides
|
||||
weight: 8
|
||||
weight: 208
|
||||
---
|
||||
|
||||
Flux's functional syntax allows for custom functions.
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ menu:
|
|||
v2_0:
|
||||
name: Group data
|
||||
parent: How-to guides
|
||||
weight: 3
|
||||
weight: 203
|
||||
---
|
||||
|
||||
With Flux, you can group data by any column in your queried data set.
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ menu:
|
|||
v2_0:
|
||||
name: Create histograms
|
||||
parent: How-to guides
|
||||
weight: 7
|
||||
weight: 207
|
||||
---
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ menu:
|
|||
v2_0:
|
||||
name: Join data
|
||||
parent: How-to guides
|
||||
weight: 5
|
||||
weight: 205
|
||||
---
|
||||
|
||||
The [`join()` function](/v2.0/reference/flux/functions/transformations/join) merges two or more
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ menu:
|
|||
v2_0:
|
||||
name: Use regular expressions
|
||||
parent: How-to guides
|
||||
weight: 9
|
||||
weight: 209
|
||||
---
|
||||
|
||||
Regular expressions (regexes) are incredibly powerful when matching patterns in large collections of data.
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ menu:
|
|||
v2_0:
|
||||
name: Sort and limit data
|
||||
parent: How-to guides
|
||||
weight: 6
|
||||
weight: 206
|
||||
---
|
||||
|
||||
The [`sort()`function](/v2.0/reference/flux/functions/transformations/sort)
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ menu:
|
|||
v2_0:
|
||||
name: Window and aggregate data
|
||||
parent: How-to guides
|
||||
weight: 2
|
||||
weight: 202
|
||||
---
|
||||
|
||||
A common operation performed with time series data is grouping data into windows of time,
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@ description: >
|
|||
menu:
|
||||
v2_0_ref:
|
||||
name: Command line tools
|
||||
weight: 1
|
||||
weight: 1
|
||||
---
|
||||
|
||||
InfluxDB provides command line tools designed to aid in managing and working
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ menu:
|
|||
v2_0_ref:
|
||||
name: influx
|
||||
parent: Command line tools
|
||||
weight: 1
|
||||
weight: 101
|
||||
---
|
||||
|
||||
The `influx` command line interface (CLI) includes commands to manage many aspects of InfluxDB,
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ menu:
|
|||
v2_0_ref:
|
||||
name: influx auth
|
||||
parent: influx
|
||||
weight: 1
|
||||
weight: 101
|
||||
---
|
||||
|
||||
The `influx auth` command and its subcommands manage authorizations in InfluxDB.
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ menu:
|
|||
v2_0_ref:
|
||||
name: influx auth active
|
||||
parent: influx auth
|
||||
weight: 1
|
||||
weight: 201
|
||||
---
|
||||
|
||||
The `influx auth active` command activates an authorization in InfluxDB.
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ menu:
|
|||
v2_0_ref:
|
||||
name: influx auth create
|
||||
parent: influx auth
|
||||
weight: 1
|
||||
weight: 201
|
||||
---
|
||||
|
||||
The `influx auth create` creates an authorization in InfluxDB.
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ menu:
|
|||
v2_0_ref:
|
||||
name: influx auth delete
|
||||
parent: influx auth
|
||||
weight: 1
|
||||
weight: 201
|
||||
---
|
||||
|
||||
The `influx auth delete` command deletes an authorization in InfluxDB.
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ menu:
|
|||
v2_0_ref:
|
||||
name: influx auth find
|
||||
parent: influx auth
|
||||
weight: 1
|
||||
weight: 201
|
||||
---
|
||||
|
||||
The `influx auth find` command lists and searches authorizations in InfluxDB.
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ menu:
|
|||
v2_0_ref:
|
||||
name: influx auth inactive
|
||||
parent: influx auth
|
||||
weight: 1
|
||||
weight: 201
|
||||
---
|
||||
|
||||
The `influx auth inactive` inactivates an authorization in InfluxDB.
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ menu:
|
|||
v2_0_ref:
|
||||
name: influx bucket
|
||||
parent: influx
|
||||
weight: 1
|
||||
weight: 101
|
||||
---
|
||||
|
||||
The `influx bucket` command and its subcommands manage buckets in InfluxDB.
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ menu:
|
|||
v2_0_ref:
|
||||
name: influx bucket create
|
||||
parent: influx bucket
|
||||
weight: 1
|
||||
weight: 201
|
||||
---
|
||||
|
||||
The `influx bucket create` command creates a new bucket in InfluxDB.
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ menu:
|
|||
v2_0_ref:
|
||||
name: influx bucket delete
|
||||
parent: influx bucket
|
||||
weight: 1
|
||||
weight: 201
|
||||
---
|
||||
|
||||
The `influx bucket delete` command deletes a bucket from InfluxDB and all the data it contains.
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ menu:
|
|||
v2_0_ref:
|
||||
name: influx bucket find
|
||||
parent: influx bucket
|
||||
weight: 1
|
||||
weight: 201
|
||||
---
|
||||
|
||||
The `influx bucket find` command lists and searches for buckets in InfluxDB.
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ menu:
|
|||
v2_0_ref:
|
||||
name: influx bucket update
|
||||
parent: influx bucket
|
||||
weight: 1
|
||||
weight: 201
|
||||
---
|
||||
|
||||
The `influx bucket update` command updates information associated with buckets in InfluxDB.
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ menu:
|
|||
v2_0_ref:
|
||||
name: influx help
|
||||
parent: influx
|
||||
weight: 1
|
||||
weight: 101
|
||||
---
|
||||
|
||||
The `influx help` command provides help for any command in the `influx` command line interface.
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ menu:
|
|||
v2_0_ref:
|
||||
name: influx org
|
||||
parent: influx
|
||||
weight: 1
|
||||
weight: 101
|
||||
---
|
||||
|
||||
The `influx org` command and its subcommands manage organization information in InfluxDB.
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ menu:
|
|||
v2_0_ref:
|
||||
name: influx org create
|
||||
parent: influx org
|
||||
weight: 1
|
||||
weight: 201
|
||||
---
|
||||
|
||||
The `influx org create` creates a new organization in InfluxDB.
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ menu:
|
|||
v2_0_ref:
|
||||
name: influx org delete
|
||||
parent: influx org
|
||||
weight: 1
|
||||
weight: 201
|
||||
---
|
||||
|
||||
The `influx org delete` command deletes an organization in InfluxDB.
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ menu:
|
|||
v2_0_ref:
|
||||
name: influx org find
|
||||
parent: influx org
|
||||
weight: 1
|
||||
weight: 201
|
||||
---
|
||||
|
||||
The `influx org find` lists and searches for organizations in InfluxDB.
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ menu:
|
|||
v2_0_ref:
|
||||
name: influx org members
|
||||
parent: influx org
|
||||
weight: 1
|
||||
weight: 201
|
||||
---
|
||||
|
||||
The `influx org members` command and its subcommands manage organization members in InfluxDB.
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ menu:
|
|||
v2_0_ref:
|
||||
name: influx org members add
|
||||
parent: influx org members
|
||||
weight: 1
|
||||
weight: 301
|
||||
---
|
||||
|
||||
The `influx org members add` command adds a new member to an organization in InfluxDB.
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ menu:
|
|||
v2_0_ref:
|
||||
name: influx org members list
|
||||
parent: influx org members
|
||||
weight: 1
|
||||
weight: 301
|
||||
---
|
||||
|
||||
The `influx org members list` command lists members within an organization in InfluxDB.
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ menu:
|
|||
v2_0_ref:
|
||||
name: influx org members remove
|
||||
parent: influx org members
|
||||
weight: 1
|
||||
weight: 301
|
||||
---
|
||||
|
||||
The `influx org members remove` command removes a member from an organization in InfluxDB.
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ menu:
|
|||
v2_0_ref:
|
||||
name: influx org update
|
||||
parent: influx org
|
||||
weight: 1
|
||||
weight: 201
|
||||
---
|
||||
|
||||
The `influx org update` command updates information related to organizations in InfluxDB.
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@ menu:
|
|||
v2_0_ref:
|
||||
name: influx query
|
||||
parent: influx
|
||||
weight: 1
|
||||
weight: 101
|
||||
---
|
||||
|
||||
The `influx query` command executes a literal Flux query provided as a string
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@ menu:
|
|||
v2_0_ref:
|
||||
name: influx repl
|
||||
parent: influx
|
||||
weight: 1
|
||||
weight: 101
|
||||
---
|
||||
|
||||
The `influx repl` command opens and interactive read-eval-print-loop (REPL)
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@ menu:
|
|||
v2_0_ref:
|
||||
name: influx setup
|
||||
parent: influx
|
||||
weight: 1
|
||||
weight: 101
|
||||
---
|
||||
|
||||
The `influx setup` command walks through the initial InfluxDB setup process,
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ menu:
|
|||
v2_0_ref:
|
||||
name: influx task
|
||||
parent: influx
|
||||
weight: 1
|
||||
weight: 101
|
||||
---
|
||||
|
||||
The `influx task` command and its subcommands manage tasks in InfluxDB.
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ menu:
|
|||
v2_0_ref:
|
||||
name: influx task create
|
||||
parent: influx task
|
||||
weight: 1
|
||||
weight: 201
|
||||
---
|
||||
|
||||
The `influx task create` command creates a new task in InfluxDB.
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ menu:
|
|||
v2_0_ref:
|
||||
name: influx task delete
|
||||
parent: influx task
|
||||
weight: 1
|
||||
weight: 201
|
||||
---
|
||||
|
||||
The `influx task delete` command deletes a task in InfluxDB.
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ menu:
|
|||
v2_0_ref:
|
||||
name: influx task find
|
||||
parent: influx task
|
||||
weight: 1
|
||||
weight: 201
|
||||
---
|
||||
|
||||
The `influx task find` command lists and searches for tasks in InfluxDB.
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ menu:
|
|||
v2_0_ref:
|
||||
name: influx task log
|
||||
parent: influx task
|
||||
weight: 1
|
||||
weight: 201
|
||||
---
|
||||
|
||||
The `influx task log` command and its subcommand `find` output log information related to a task.
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ menu:
|
|||
v2_0_ref:
|
||||
name: influx task log find
|
||||
parent: influx task log
|
||||
weight: 1
|
||||
weight: 301
|
||||
---
|
||||
|
||||
The `influx task log find` command outputs log information related to a task.
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ menu:
|
|||
v2_0_ref:
|
||||
name: influx task retry
|
||||
parent: influx task
|
||||
weight: 1
|
||||
weight: 201
|
||||
---
|
||||
|
||||
The `influx task retry` command retries to run a task in InfluxDB.
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@ menu:
|
|||
v2_0_ref:
|
||||
name: influx task run
|
||||
parent: influx task
|
||||
weight: 1
|
||||
weight: 201
|
||||
---
|
||||
|
||||
The `influx task run` command and its subcommand `find` output information related to runs of a task.
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ menu:
|
|||
v2_0_ref:
|
||||
name: influx task run find
|
||||
parent: influx task run
|
||||
weight: 1
|
||||
weight: 301
|
||||
---
|
||||
|
||||
The `influx task run find` command outputs information related to runs of a task.
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ menu:
|
|||
v2_0_ref:
|
||||
name: influx task update
|
||||
parent: influx task
|
||||
weight: 1
|
||||
weight: 201
|
||||
---
|
||||
|
||||
The `influx task update` command updates information related to tasks in InfluxDB.
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ menu:
|
|||
v2_0_ref:
|
||||
name: influx user
|
||||
parent: influx
|
||||
weight: 1
|
||||
weight: 101
|
||||
---
|
||||
|
||||
The `influx user` command and its subcommands manage user information in InfluxDB.
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ menu:
|
|||
v2_0_ref:
|
||||
name: influx user create
|
||||
parent: influx user
|
||||
weight: 1
|
||||
weight: 201
|
||||
---
|
||||
|
||||
The `influx user create` command creates a new user in InfluxDB.
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ menu:
|
|||
v2_0_ref:
|
||||
name: influx user delete
|
||||
parent: influx user
|
||||
weight: 1
|
||||
weight: 201
|
||||
---
|
||||
|
||||
The `influx user delete` command deletes a specified user in InfluxDB.
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ menu:
|
|||
v2_0_ref:
|
||||
name: influx user find
|
||||
parent: influx user
|
||||
weight: 1
|
||||
weight: 201
|
||||
---
|
||||
|
||||
The `influx user find` command lists and searches for users in InfluxDB.
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ menu:
|
|||
v2_0_ref:
|
||||
name: influx user update
|
||||
parent: influx user
|
||||
weight: 1
|
||||
weight: 201
|
||||
---
|
||||
|
||||
The `influx user update` command updates information related to a user in InfluxDB.
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@ menu:
|
|||
v2_0_ref:
|
||||
name: influx write
|
||||
parent: influx
|
||||
weight: 1
|
||||
weight: 101
|
||||
---
|
||||
|
||||
The `influx write` writes a single line of line protocol to InfluxDB,
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ menu:
|
|||
v2_0_ref:
|
||||
name: influxd
|
||||
parent: Command line tools
|
||||
weight: 2
|
||||
weight: 102
|
||||
---
|
||||
|
||||
The `influxd` daemon starts and runs all the processes necessary for InfluxDB to function.
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ description: Reference articles for Flux functions and the Flux language specifi
|
|||
menu:
|
||||
v2_0_ref:
|
||||
name: Flux query language
|
||||
weight: 2
|
||||
weight: 2
|
||||
---
|
||||
|
||||
The following articles are meant as a reference for Flux functions and the
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ menu:
|
|||
v2_0_ref:
|
||||
name: Flux functions
|
||||
parent: Flux query language
|
||||
weight: 4
|
||||
weight: 101
|
||||
---
|
||||
|
||||
Flux's functional syntax allows you to retrieve, transform, process, and output data easily.
|
||||
|
|
|
|||
|
|
@ -5,10 +5,10 @@ menu:
|
|||
v2_0_ref:
|
||||
parent: Flux functions
|
||||
name: Inputs
|
||||
weight: 1
|
||||
weight: 201
|
||||
---
|
||||
|
||||
Flux input functions define sources of data or display information about data sources.
|
||||
The following input functions are available:
|
||||
|
||||
{{< function-list category="Inputs" menu="v2_0_ref" >}}
|
||||
{{< children type="functions" >}}
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ menu:
|
|||
v2_0_ref:
|
||||
name: buckets
|
||||
parent: Inputs
|
||||
weight: 1
|
||||
weight: 301
|
||||
---
|
||||
|
||||
The `buckets()` function returns a list of buckets in the organization.
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ menu:
|
|||
v2_0_ref:
|
||||
name: from
|
||||
parent: Inputs
|
||||
weight: 1
|
||||
weight: 301
|
||||
---
|
||||
|
||||
The `from()` function retrieves data from an InfluxDB data source.
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ menu:
|
|||
v2_0_ref:
|
||||
name: fromCSV
|
||||
parent: Inputs
|
||||
weight: 1
|
||||
weight: 301
|
||||
---
|
||||
|
||||
The `fromCSV()` function retrieves data from a comma-separated value (CSV) data source.
|
||||
|
|
|
|||
|
|
@ -5,11 +5,11 @@ menu:
|
|||
v2_0_ref:
|
||||
parent: Flux functions
|
||||
name: Miscellaneous
|
||||
weight: 5
|
||||
weight: 205
|
||||
---
|
||||
|
||||
Flux functions primarily retrieve, shape and transform, then output data, however
|
||||
there are functions available that serve other purposes.
|
||||
The following functions are are available but don't fit within other function categories:
|
||||
|
||||
{{< function-list category="Miscellaneous" menu="v2_0_ref" >}}
|
||||
{{< children type="functions" >}}
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ menu:
|
|||
v2_0_ref:
|
||||
name: intervals
|
||||
parent: Miscellaneous
|
||||
weight: 1
|
||||
weight: 301
|
||||
---
|
||||
|
||||
The `intervals()` function generates a set of time intervals over a range of time.
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ menu:
|
|||
v2_0_ref:
|
||||
name: linearBins
|
||||
parent: Miscellaneous
|
||||
weight: 1
|
||||
weight: 301
|
||||
---
|
||||
|
||||
The `linearBins()` function generates a list of linearly separated floats.
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ menu:
|
|||
v2_0_ref:
|
||||
name: logarithmicBins
|
||||
parent: Miscellaneous
|
||||
weight: 1
|
||||
weight: 301
|
||||
---
|
||||
|
||||
The `logarithmicBins()` function generates a list of exponentially separated floats.
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ menu:
|
|||
v2_0_ref:
|
||||
name: systemTime
|
||||
parent: Miscellaneous
|
||||
weight: 1
|
||||
weight: 301
|
||||
---
|
||||
|
||||
The `systemTime()` function returns the current system time.
|
||||
|
|
|
|||
|
|
@ -5,10 +5,10 @@ menu:
|
|||
v2_0_ref:
|
||||
parent: Flux functions
|
||||
name: Outputs
|
||||
weight: 2
|
||||
weight: 202
|
||||
---
|
||||
|
||||
Flux output functions yield results or send data to a specified output destination.
|
||||
The following output functions are are available:
|
||||
|
||||
{{< function-list category="Outputs" menu="v2_0_ref" >}}
|
||||
{{< children type="functions" >}}
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ menu:
|
|||
v2_0_ref:
|
||||
name: to
|
||||
parent: Outputs
|
||||
weight: 1
|
||||
weight: 301
|
||||
---
|
||||
|
||||
The `to()` function writes data to an **InfluxDB v2.0** bucket.
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ menu:
|
|||
v2_0_ref:
|
||||
name: yield
|
||||
parent: Outputs
|
||||
weight: 1
|
||||
weight: 301
|
||||
---
|
||||
|
||||
The `yield()` function indicates the input tables received should be delivered as a result of the query.
|
||||
|
|
|
|||
|
|
@ -5,10 +5,10 @@ menu:
|
|||
v2_0_ref:
|
||||
name: Tests
|
||||
parent: Flux functions
|
||||
weight: 5
|
||||
weight: 205
|
||||
---
|
||||
|
||||
Flux testing functions test piped-forward data in specific ways and return errors if the tests fail.
|
||||
The following testing functions are available:
|
||||
|
||||
{{< function-list category="Tests" menu="v2_0_ref" >}}
|
||||
{{< children type="functions" >}}
|
||||
|
|
|
|||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue