You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Add code callouts attribute and replace code-callout shortcodes (#7069)
* feat(layouts): add callout and callout-color code fence attributes
Support highlighting code in code blocks via fence attributes instead of
the code-callout shortcode. Defaults to green when callout-color is omitted.
Works alongside placeholders on the same code block.
* docs: update code callouts docs with fence attribute syntax
Document the new callout and callout-color code fence attributes as the
preferred approach. Move the shortcode syntax to a backward-compatibility
note.
* feat(callouts): add new callout attribute, replace and remove code-callout shortcode
Copy file name to clipboardExpand all lines: DOCS-SHORTCODES.md
+22-6Lines changed: 22 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -146,7 +146,7 @@ Use the `{{< api-endpoint >}}` shortcode to generate a code block that contains
146
146
-**method**: HTTP request method (get, post, patch, put, or delete)
147
147
-**endpoint**: API endpoint
148
148
-**api-ref**: Link the endpoint to a specific place in the API documentation
149
-
-**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:
149
+
-**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:
150
150
- oss
151
151
- cloud
152
152
- serverless
@@ -737,16 +737,32 @@ InfluxDB 3 Enterprise and InfluxDB 3 Core support different kinds of tokens. The
737
737
738
738
### Code callouts
739
739
740
-
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.
740
+
Use the `callout` code fence attribute to highlight and emphasize specific code (for example, a variable, placeholder, or value) in a code block.
741
+
Provide a regular expression pattern to match the text to highlight.
742
+
Use the optional `callout-color` attribute to specify the highlight color (defaults to `green`).
Copy file name to clipboardExpand all lines: content/influxdb3/cloud-dedicated/query-data/troubleshoot-and-optimize/analyze-query-plan.md
+2-10Lines changed: 2 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -200,16 +200,12 @@ The following steps summarize the [physical plan execution and data flow](#physi
200
200
201
201
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:
202
202
203
-
{{% code-callout "EmptyExec"%}}
204
-
205
-
```sql
203
+
```sql { callout="EmptyExec" }
206
204
ProjectionExec: expr=[temp@0as temp]
207
205
SortExec: expr=[time@1ASC NULLS LAST]
208
206
EmptyExec: produce_one_row=false
209
207
```
210
208
211
-
{{% /code-callout %}}
212
-
213
209
## Analyze a query plan for leading edge data
214
210
215
211
The following sections guide you through analyzing a physical query plan for a typical time series use case--aggregating recently written (_leading edge_) data.
@@ -621,14 +617,10 @@ The remaining ParquetExec_B expressions are similar to those in [ParquetExec_A](
621
617
622
618
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:
623
619
624
-
{{% code-callout "b862a7e9b329ee6a4..." %}}
625
-
626
-
```text
620
+
```text { callout="b862a7e9b329ee6a4..." }
627
621
1/1/b862a7e9b329ee6a4.../...
628
622
```
629
623
630
-
{{% /code-callout %}}
631
-
632
624
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:
633
625
634
626
- to separate non-overlapped files from overlapped files to minimize work required for deduplication (which is the case in this example)
0 commit comments