Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 22 additions & 6 deletions DOCS-SHORTCODES.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@
{{< req "This is Required" >}}
```

**Output:** This is required

Check notice on line 61 in DOCS-SHORTCODES.md

View workflow job for this annotation

GitHub Actions / Vale style check

write-good.E-Prime

Try to avoid using 'is'.

If using other named arguments like `key` or `color`, use the `text` argument to customize the text of the required message.

Expand All @@ -74,13 +74,13 @@
{{< req type="key" >}}

- {{< req "\*" >}} **This element is required**
- {{< req "\*" >}} **This element is also required**

Check notice on line 77 in DOCS-SHORTCODES.md

View workflow job for this annotation

GitHub Actions / Vale style check

write-good.E-Prime

Try to avoid using 'is'.
- **This element is NOT required**
```

### Change color of required text

Use the `color` argument to change the color of required text. The following colors are available:

Check notice on line 83 in DOCS-SHORTCODES.md

View workflow job for this annotation

GitHub Actions / Vale style check

write-good.E-Prime

Try to avoid using 'are'.

- blue
- green
Expand Down Expand Up @@ -117,7 +117,7 @@

### Latest patch version

Use the `{{< latest-patch >}}` shortcode to add the latest patch version of a product. By default, this shortcode parses the product and minor version from the URL. To specify a specific product and minor version, use the `product` and `version` arguments. Easier to maintain being you update the version number in the `data/products.yml` file instead of updating individual links and code examples.

Check notice on line 120 in DOCS-SHORTCODES.md

View workflow job for this annotation

GitHub Actions / Vale style check

write-good.E-Prime

Try to avoid using 'being'.

```md
{{< latest-patch >}}
Expand Down Expand Up @@ -146,7 +146,7 @@
- **method**: HTTP request method (get, post, patch, put, or delete)
- **endpoint**: API endpoint
- **api-ref**: Link the endpoint to a specific place in the API documentation
- **influxdb_host**: Specify which InfluxDB product host to use *if the `endpoint` contains the `influxdb/host` shortcode*. Uses the current InfluxDB product as default. Supports the following product values:
- **influxdb\_host**: Specify which InfluxDB product host to use *if the `endpoint` contains the `influxdb/host` shortcode*. Uses the current InfluxDB product as default. Supports the following product values:
- oss
- cloud
- serverless
Expand All @@ -165,14 +165,14 @@

### Tabbed Content

To create "tabbed" content (content that is changed by a users' selection), use the following three shortcodes in combination:

Check notice on line 168 in DOCS-SHORTCODES.md

View workflow job for this annotation

GitHub Actions / Vale style check

write-good.E-Prime

Try to avoid using 'is'.

#### tabs-wrapper

`{{< tabs-wrapper >}}`
This shortcode creates a wrapper or container for the tabbed content. All UI interactions are limited to the scope of each container. If you have more than one "group" of tabbed content in a page, each needs its own `tabs-wrapper`. This shortcode must be closed with `{{< /tabs-wrapper >}}`.

Check notice on line 173 in DOCS-SHORTCODES.md

View workflow job for this annotation

GitHub Actions / Vale style check

write-good.E-Prime

Try to avoid using 'be'.

Check notice on line 173 in DOCS-SHORTCODES.md

View workflow job for this annotation

GitHub Actions / Vale style check

write-good.E-Prime

Try to avoid using 'are'.

**Note**: The `<` and `>` characters used in this shortcode indicate that the contents should be processed as HTML.

Check notice on line 175 in DOCS-SHORTCODES.md

View workflow job for this annotation

GitHub Actions / Vale style check

write-good.E-Prime

Try to avoid using 'be'.

#### tabs

Expand Down Expand Up @@ -737,16 +737,32 @@

### Code callouts

Use the `{{< code-callout >}}` shortcode to highlight and emphasize a specific piece of code (for example, a variable, placeholder, or value) in a code block. Provide the string to highlight in the code block. Include a syntax for the codeblock to properly style the called out code.
Use the `callout` code fence attribute to highlight and emphasize specific code (for example, a variable, placeholder, or value) in a code block.
Provide a regular expression pattern to match the text to highlight.
Use the optional `callout-color` attribute to specify the highlight color (defaults to `green`).

````md
{{< code-callout "03a2bbf46249a000" >}}
**Available colors:** `green` (default), `magenta`, `orange`, `delete`/`strike`

```sh
````md
```sh { callout="03a2bbf46249a000" }
http://localhost:8086/orgs/03a2bbf46249a000/...
```
````

With an explicit color:

````md
```sh { callout="--host" callout-color="orange" }
influx query --host http://localhost:8086
```
````

{{< /code-callout >}}
You can use both `callout` and `placeholders` attributes on the same code block:

````md
```sh { placeholders="DATABASE_NAME" callout="--host" callout-color="magenta" }
influx query --host http://localhost:8086 --database DATABASE_NAME
```
````

### Placeholders in code samples
Expand Down
4 changes: 1 addition & 3 deletions content/influxdb/cloud/admin/organizations/view-orgs.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,11 +35,9 @@ Use the InfluxDB UI or `influx` CLI to view your organization ID.

After logging in to the InfluxDB UI, your organization ID appears in the URL.

{{< code-callout "03a2bbf46249a000" >}}
```sh
```sh { callout="03a2bbf46249a000" }
https://cloud2.influxdata.com/orgs/03a2bbf46249a000/...
```
{{< /code-callout >}}

### Organization ID in the CLI

Expand Down
26 changes: 11 additions & 15 deletions content/influxdb/cloud/reference/regions.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,20 +20,16 @@ Use the URLs below to interact with your InfluxDB Cloud instances with the

<a href="https://www.influxdata.com/influxdb-cloud-2-0-provider-region/" target="_blank" class="btn">Request a cloud region</a>

{{% note %}}
#### Regions with multiple clusters

Some InfluxDB Cloud regions have multiple Cloud clusters, each with a unique URL.
To find your cluster URL, [log in to your InfluxDB Cloud organization](https://cloud2.influxdata.com)
and review your organization URL. The first subdomain identifies your
InfluxDB Cloud cluster. For example:

{{< code-callout "us-west-2-1" >}}
```sh
https://us-west-2-1.aws.cloud2.influxdata.com/orgs/03a2bbf46249a000/...
```
{{< /code-callout >}}

{{% /note %}}
> [!Note]
> #### Regions with multiple clusters
>
> Some InfluxDB Cloud regions have multiple Cloud clusters, each with a unique URL.
> To find your cluster URL, [log in to your InfluxDB Cloud organization](https://cloud2.influxdata.> com)
> and review your organization URL. The first subdomain identifies your
> InfluxDB Cloud cluster. For example:
>
> ```sh { callout="us-west-2-1" }
> https://us-west-2-1.aws.cloud2.influxdata.com/orgs/03a2bbf46249a000/...
> ```

{{< cloud_regions >}}
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,9 @@ Use the InfluxDB UI or `influx` CLI to view your dashboard ID.

When viewing a dashboard in the InfluxDB UI, your dashboard ID appears in the URL.

{{< code-callout "04b6b15034cc000" >}}
```sh
```sh { callout="04b6b15034cc000" }
https://cloud2.influxdata.com/orgs/03a2bbf46249a000/dashboards/04b6b15034cc000/...
```
{{< /code-callout >}}

### Dashboard ID in the CLI
Use [`influx dashboards`](/influxdb/cloud/reference/cli/influx/dashboards/) to view a list of dashboards and IDs.
Expand Down
4 changes: 1 addition & 3 deletions content/influxdb/v1/administration/backup_and_restore.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,15 +100,13 @@ the legacy format.
To create or restore from a backup or in the portable format, include the
`-portable` flag with your backup command.

{{< code-callout "-portable" >}}
```sh
```sh { callout="-portable" }
# Create a backup in the portable format
influxd backup -portable /path/to/backup-destination

# Restore from a portable backup
influxd restore -portable /path/to/backup-destination
```
{{< /code-callout >}}

### Determine your backup's format
Use the directory structure of the backup directory to determine the format of the backup.
Expand Down
6 changes: 1 addition & 5 deletions content/influxdb/v2/admin/organizations/view-orgs.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,13 +46,9 @@ Use the InfluxDB UI or `influx` CLI to view your organization ID.
### Organization ID in the UI

After logging in to the InfluxDB UI, your organization ID appears in the URL.

{{< code-callout "03a2bbf46249a000" >}}
```sh
```sh { callout="03a2bbf46249a000" }
http://localhost:8086/orgs/03a2bbf46249a000/...
```
{{< /code-callout >}}


### Organization ID in the CLI

Expand Down
5 changes: 1 addition & 4 deletions content/influxdb/v2/visualize-data/dashboards/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,9 @@ Use the InfluxDB UI or `influx` CLI to view your dashboard ID.
### Dashboard ID in the UI

When viewing a dashboard in the InfluxDB UI, your dashboard ID appears in the URL.

{{< code-callout "04b6b15034cc000" >}}
```sh
```sh { callout="04b6b15034cc000" }
http://localhost:8086/orgs/03a2bbf46249a000/dashboards/04b6b15034cc000/...
```
{{< /code-callout >}}

### Dashboard ID in the CLI
Use [`influx dashboards`](/influxdb/v2/reference/cli/influx/dashboards/) to view a list of dashboards and IDs.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -226,17 +226,13 @@ With Superset running, you're ready to [log in](#log-in-to-superset) and set up
- **`?database`**: URL-encoded InfluxDB [database name](/influxdb3/cloud-dedicated/admin/databases/list/)
- **`?token`**: InfluxDB [API token](/influxdb3/cloud-dedicated/get-started/setup/) with `READ` access to the specified database

{{< code-callout "&lt;(domain|port|database-name|token)&gt;" >}}
{{< code-callout "cluster-id\.influxdb\.io|443|example-database|example-token" >}}
```sh
# Syntax
datafusion+flightsql://<domain>:<port>?database=<database-name>&token=<token>
```sh { callout = "(&lt;(domain|port|database-name|token)&gt;)|cluster-id\.influxdb\.io|443|example-database|example-token"}
# Syntax
datafusion+flightsql://<domain>:<port>?database=<database-name>&token=<token>

# Example
datafusion+flightsql://{{< influxdb/host >}}:443?database=example-database&token=example-token
```
{{< /code-callout >}}
{{< /code-callout >}}
# Example
datafusion+flightsql://{{< influxdb/host >}}:443?database=example-database&token=example-token
```

6. Click **Test Connection** to ensure the connection works.
7. Click **Connect** to save the database connection.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@

# Execute the query and return an Arrow table
table = client.query(
query="SELECT * FROM home",

Check warning on line 44 in content/influxdb3/cloud-dedicated/query-data/execute-queries/client-libraries/python.md

View workflow job for this annotation

GitHub Actions / Vale style check

Google.Quotes

Commas and periods go inside quotation marks.
language="sql"
)

Expand Down Expand Up @@ -188,12 +188,9 @@
{{< /tabs-wrapper >}}

When a virtual environment is activated, the name displays at the beginning of your terminal command line--for example:

{{% code-callout "(virtualenv-1)"%}}
```sh
```sh { callout="(virtualenv-1)" }
(virtualenv-1) $ PROJECT_DIRECTORY
```
{{% /code-callout %}}

## Query InfluxDB

Expand Down Expand Up @@ -263,9 +260,7 @@

The following example shows how to use the Python `certifi` package and client library options to pass the certificate path:

{{% code-placeholders "DATABASE_(NAME|TOKEN)" %}}
{{< code-callout "flight_client_options|tls_root_certs|(cert\b)" >}}
```py
```py { placeholders="DATABASE_(NAME|TOKEN)" callout="flight_client_options|tls_root_certs|(cert\b)" }
from influxdb_client_3 import InfluxDBClient3, flight_client_options
import certifi

Expand All @@ -282,8 +277,6 @@
tls_root_certs=cert))
...
```
{{< /code-callout >}}
{{% /code-placeholders %}}

For more information, see [`influxdb_client_3` query exceptions](/influxdb3/cloud-dedicated/reference/client-libraries/v3/python/#query-exceptions).

Expand Down Expand Up @@ -332,7 +325,7 @@
database='DATABASE_NAME'
)

# Execute the query and return an Arrow table

Check failure on line 328 in content/influxdb3/cloud-dedicated/query-data/execute-queries/client-libraries/python.md

View workflow job for this annotation

GitHub Actions / Vale style check

Vale.Repetition

'table' is repeated!
table = client.query(
query="SELECT * FROM home",
language="sql",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -200,16 +200,12 @@ The following steps summarize the [physical plan execution and data flow](#physi

If your table doesn't contain data for the time range in your query, the physical plan starts with an `EmptyExec` leaf node--for example:

{{% code-callout "EmptyExec"%}}

```sql
```sql { callout="EmptyExec" }
ProjectionExec: expr=[temp@0 as temp]
SortExec: expr=[time@1 ASC NULLS LAST]
EmptyExec: produce_one_row=false
```

{{% /code-callout %}}

## Analyze a query plan for leading edge data

The following sections guide you through analyzing a physical query plan for a typical time series use case--aggregating recently written (_leading edge_) data.
Expand Down Expand Up @@ -621,14 +617,10 @@ The remaining ParquetExec_B expressions are similar to those in [ParquetExec_A](

If you compare [`file_group`](#file_groups) paths in [ParquetExec_A](#parquetexec_a) to those in [ParquetExec_B](#parquetexec_b), you'll notice that both contain files from the same partition:

{{% code-callout "b862a7e9b329ee6a4..." %}}

```text
```text { callout="b862a7e9b329ee6a4..." }
1/1/b862a7e9b329ee6a4.../...
```

{{% /code-callout %}}

The planner may distribute files from the same partition to different scan nodes for several reasons, including optimizations for handling [overlaps](#how-a-query-plan-distributes-data-for-scanning)--for example:

- to separate non-overlapped files from overlapped files to minimize work required for deduplication (which is the case in this example)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -112,9 +112,7 @@ When using the InfluxDB API `/api/v2/write` endpoint to write data,
compress the data with `gzip` and set the `Content-Encoding` header to `gzip`--for example:

{{% influxdb/custom-timestamps %}}
{{% code-placeholders "(DATABASE)_(TOKEN|NAME)" %}}
{{% code-callout "Content-Encoding: gzip" "orange" %}}
```bash
```bash { placeholders="(DATABASE)_(TOKEN|NAME)" callout="Content-Encoding: gzip" callout-color="orange" }
echo "mem,host=host1 used_percent=23.43234543 1641024000
mem,host=host2 used_percent=26.81522361 1641027600
mem,host=host1 used_percent=22.52984738 1641031200
Expand All @@ -126,9 +124,6 @@ curl --request POST "https://{{< influxdb/host >}}/api/v2/write?org=ignored&buck
--header "Content-Encoding: gzip" \
--data-binary @system.gzip
```

{{% /code-callout %}}
{{% /code-placeholders %}}
{{% /influxdb/custom-timestamps %}}

Replace the following:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,6 @@ If you belong to more than one organization with the same email address, you can

After logging in to the InfluxDB UI, your organization ID appears in the URL--for example:

{{< code-callout "03a2bbf46249a000" >}}
```sh
```sh { callout="03a2bbf46249a000" }
https://{{< influxdb/host >}}/orgs/03a2bbf46249a000/...
```
{{< /code-callout >}}
Original file line number Diff line number Diff line change
Expand Up @@ -223,17 +223,13 @@ With Superset running, you're ready to [log in](#log-in-to-superset) and set up
- **`?database`**: URL-encoded InfluxDB [bucket name](/influxdb3/cloud-serverless/admin/buckets/view-buckets/)
- **`?token`**: InfluxDB [API token](/influxdb3/cloud-serverless/get-started/setup/) with `READ` access to the specified bucket

{{< code-callout "&lt;(domain|port|database|token)&gt;" >}}
{{< code-callout "us-east-1-1\.aws\.cloud2\.influxdata\.com|443|example-bucket|example-token" >}}
```sh
# Syntax
datafusion+flightsql://<domain>:<port>?database=<database>&token=<token>
```sh { callout="(&lt;(domain|port|database|token)&gt;)|us-east-1-1\.aws\.cloud2\.influxdata\.com|443|example-bucket|example-token"}
# Syntax
datafusion+flightsql://<domain>:<port>?database=<database>&token=<token>

# Example
datafusion+flightsql://us-east-1-1.aws.cloud2.influxdata.com:443?database=example-bucket&token=example-token
```
{{< /code-callout >}}
{{< /code-callout >}}
# Example
datafusion+flightsql://us-east-1-1.aws.cloud2.influxdata.com:443?database=example-bucket&token=example-token
```

6. Click **Test Connection** to ensure the connection works.
7. Click **Connect** to save the database connection.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,17 +37,17 @@
client = InfluxDBClient3(
host='{{< influxdb/host >}}',
token='DATABASE_TOKEN',
database='DATABASE_NAME'

Check warning on line 40 in content/influxdb3/cloud-serverless/query-data/execute-queries/client-libraries/python.md

View workflow job for this annotation

GitHub Actions / Vale style check

Cloud-Serverless.Branding

Did you mean 'bucket' instead of 'database'
)

# Execute the query and return an Arrow table

Check warning on line 43 in content/influxdb3/cloud-serverless/query-data/execute-queries/client-libraries/python.md

View workflow job for this annotation

GitHub Actions / Vale style check

Cloud-Serverless.Branding

Did you mean 'measurement' instead of 'table'
table = client.query(

Check warning on line 44 in content/influxdb3/cloud-serverless/query-data/execute-queries/client-libraries/python.md

View workflow job for this annotation

GitHub Actions / Vale style check

Cloud-Serverless.Branding

Did you mean 'measurement' instead of 'table'
query="SELECT * FROM home",

Check warning on line 45 in content/influxdb3/cloud-serverless/query-data/execute-queries/client-libraries/python.md

View workflow job for this annotation

GitHub Actions / Vale style check

Google.Quotes

Commas and periods go inside quotation marks.
language="sql"
)

# Return query results as a markdown table

Check warning on line 49 in content/influxdb3/cloud-serverless/query-data/execute-queries/client-libraries/python.md

View workflow job for this annotation

GitHub Actions / Vale style check

Cloud-Serverless.Branding

Did you mean 'measurement' instead of 'table'
print(table.to_pandas().to_markdown())

Check warning on line 50 in content/influxdb3/cloud-serverless/query-data/execute-queries/client-libraries/python.md

View workflow job for this annotation

GitHub Actions / Vale style check

Cloud-Serverless.Branding

Did you mean 'measurement' instead of 'table'
```
---

Expand Down Expand Up @@ -189,12 +189,10 @@
{{< /tabs-wrapper >}}

When a virtual environment is activated, the name displays at the beginning of your terminal command line--for example:

{{% code-callout "(virtualenv-1)"%}}
```sh

```sh { callout="(virtualenv-1)" }
(virtualenv-1) $ PROJECT_DIRECTORY
```
{{% /code-callout %}}

## Query InfluxDB

Expand Down Expand Up @@ -264,9 +262,7 @@

The following code sample shows how to use the Python `certifi` package and client library options to pass the certificate path:

{{% code-placeholders "BUCKET_NAME|API_TOKEN" %}}
{{< code-callout "flight_client_options|tls_root_certs|(cert\b)" >}}
```py
```py { placeholders="BUCKET_NAME|API_TOKEN" callout="flight_client_options|tls_root_certs|(cert\b)" }
from influxdb_client_3 import InfluxDBClient3, flight_client_options
import certifi

Expand All @@ -275,15 +271,15 @@
fh.close()

client = InfluxDBClient3(
host="{{< influxdb/host >}}",
token='API_TOKEN',
database='BUCKET_NAME',
flight_client_options=flight_client_options(
tls_root_certs=cert))
host="{{< influxdb/host >}}",
token='API_TOKEN',
database='BUCKET_NAME',
flight_client_options=flight_client_options(
tls_root_certs=cert
)
)
...
```
{{< /code-callout >}}
{{% /code-placeholders %}}

For more information, see [`influxdb_client_3` query exceptions](/influxdb3/cloud-serverless/reference/client-libraries/v3/python/#query-exceptions).

Expand Down Expand Up @@ -331,7 +327,7 @@
database='BUCKET_NAME'
)

# Execute the query and return an Arrow table

Check failure on line 330 in content/influxdb3/cloud-serverless/query-data/execute-queries/client-libraries/python.md

View workflow job for this annotation

GitHub Actions / Vale style check

Vale.Repetition

'table' is repeated!

Check warning on line 330 in content/influxdb3/cloud-serverless/query-data/execute-queries/client-libraries/python.md

View workflow job for this annotation

GitHub Actions / Vale style check

write-good.Illusions

'table' is repeated!
table = client.query(
query="SELECT * FROM home",
language="sql",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -196,16 +196,12 @@ The following steps summarize the [physical plan execution and data flow](#physi

If your table doesn't contain data for the time range in your query, the physical plan starts with an `EmptyExec` leaf node--for example:

{{% code-callout "EmptyExec"%}}

```sql
```sql { callout="EmptyExec" }
ProjectionExec: expr=[temp@0 as temp]
SortExec: expr=[time@1 ASC NULLS LAST]
EmptyExec: produce_one_row=false
```

{{% /code-callout %}}

## Analyze a query plan for leading edge data

The following sections guide you through analyzing a physical query plan for a typical time series use case--aggregating recently written (_leading edge_) data.
Expand Down Expand Up @@ -617,14 +613,10 @@ The remaining ParquetExec_B expressions are similar to those in [ParquetExec_A](

If you compare [`file_group`](#file_groups) paths in [ParquetExec_A](#parquetexec_a) to those in [ParquetExec_B](#parquetexec_b), you'll notice that both contain files from the same partition:

{{% code-callout "b862a7e9b329ee6a4..." %}}

```text
```text { callout="b862a7e9b329ee6a4..." }
1/1/b862a7e9b329ee6a4.../...
```

{{% /code-callout %}}

The planner may distribute files from the same partition to different scan nodes for several reasons, including optimizations for handling [overlaps](#how-a-query-plan-distributes-data-for-scanning)--for example:

- to separate non-overlapped files from overlapped files to minimize work required for deduplication (which is the case in this example)
Expand Down
8 changes: 3 additions & 5 deletions content/influxdb3/cloud-serverless/reference/regions.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,11 +38,9 @@ Use the URLs below to interact with your InfluxDB Cloud Serverless instances wit
> and review your organization URL. The first subdomain identifies your
> InfluxDB Cloud Serverless cluster. For example:
>
> {{< code-callout "us-west-2-1" >}}
```sh
https://us-west-2-1.aws.cloud2.influxdata.com/orgs/03a2bbf46249a000/...
```
{{< /code-callout >}}
> ```sh { callout="us-west-2-1" }
> https://us-west-2-1.aws.cloud2.influxdata.com/orgs/03a2bbf46249a000/...
> ```
-->

{{< cloud_regions type="iox-table" >}}
Loading
Loading