You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@arrow.apache.org by al...@apache.org on 2024/02/09 21:01:32 UTC
(arrow-datafusion) branch main updated: Fix sphinx warnings (#9142)
This is an automated email from the ASF dual-hosted git repository.
alamb pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/arrow-datafusion.git
The following commit(s) were added to refs/heads/main by this push:
new ae88235617 Fix sphinx warnings (#9142)
ae88235617 is described below
commit ae882356171513c9d6c22b3bd966898fb4e8cac0
Author: Chih Wang <on...@users.noreply.github.com>
AuthorDate: Sat Feb 10 05:01:26 2024 +0800
Fix sphinx warnings (#9142)
* Fix 'Configuration Settings' link in write_options.md
* Fix multiple reference definition in scalar_functions.md
* Fix typo: 'contcat_ws' to 'concat_ws' in scalar_functions.md
* Add missing section 'array_contains' in scalar_functions.md
* Fix reference warnings in operators.md
* Remove unsupported syntax 'csv' from code blocks of adding-udfs.md
* Fix syntax tag in example-usage.md
* Change syntax tag of code blocks that contain multiple syntaxes of
cli.md
* Remove 'sql' syntax tags from code blocks
* Remove leading ❯ in sql code blocks
---
docs/source/library-user-guide/adding-udfs.md | 4 +-
docs/source/user-guide/cli.md | 9 +-
docs/source/user-guide/example-usage.md | 2 +-
docs/source/user-guide/expressions.md | 2 +-
docs/source/user-guide/sql/data_types.md | 4 +-
docs/source/user-guide/sql/ddl.md | 2 +-
docs/source/user-guide/sql/explain.md | 4 +-
docs/source/user-guide/sql/information_schema.md | 2 +-
docs/source/user-guide/sql/operators.md | 100 +++++++++++++++++------
docs/source/user-guide/sql/scalar_functions.md | 68 ++++++---------
docs/source/user-guide/sql/select.md | 12 +--
docs/source/user-guide/sql/subqueries.md | 12 +--
docs/source/user-guide/sql/window_functions.md | 4 +-
docs/source/user-guide/sql/write_options.md | 2 +-
14 files changed, 127 insertions(+), 100 deletions(-)
diff --git a/docs/source/library-user-guide/adding-udfs.md b/docs/source/library-user-guide/adding-udfs.md
index 1824b23f9f..037e99f87f 100644
--- a/docs/source/library-user-guide/adding-udfs.md
+++ b/docs/source/library-user-guide/adding-udfs.md
@@ -244,7 +244,7 @@ At this point, you can use the `smooth_it` function in your query:
For example, if we have a [`cars.csv`](https://github.com/apache/arrow-datafusion/blob/main/datafusion/core/tests/data/cars.csv) whose contents like
-```csv
+```
car,speed,time
red,20.0,1996-04-12T12:05:03.000000000
red,20.3,1996-04-12T12:05:04.000000000
@@ -279,7 +279,7 @@ df.show().await?;
the output will be like:
-```csv
+```
+-------+-------+--------------------+---------------------+
| car | speed | smooth_speed | time |
+-------+-------+--------------------+---------------------+
diff --git a/docs/source/user-guide/cli.md b/docs/source/user-guide/cli.md
index af61978a20..a8a9d6f212 100644
--- a/docs/source/user-guide/cli.md
+++ b/docs/source/user-guide/cli.md
@@ -198,7 +198,7 @@ You can also query directly from the remote location via HTTP(S) without
registering the location as a table
```sql
-❯ select count(*) from 'https://datasets.clickhouse.com/hits_compatible/athena_partitioned/hits_1.parquet'
+select count(*) from 'https://datasets.clickhouse.com/hits_compatible/athena_partitioned/hits_1.parquet'
+----------+
| COUNT(*) |
+----------+
@@ -285,7 +285,7 @@ LOCATION 'https://datasets.clickhouse.com/hits_compatible/athena_partitioned/hit
```
```sql
-❯ select count(*) from hits;
+select count(*) from hits;
+----------+
| COUNT(*) |
+----------+
@@ -583,7 +583,7 @@ For example, to set `datafusion.execution.batch_size` to `1024` you
would set the `DATAFUSION_EXECUTION_BATCH_SIZE` environment variable
appropriately:
-```SQL
+```shell
$ DATAFUSION_EXECUTION_BATCH_SIZE=1024 datafusion-cli
DataFusion CLI v12.0.0
❯ show all;
@@ -603,10 +603,9 @@ DataFusion CLI v12.0.0
You can change the configuration options using `SET` statement as well
-```SQL
+```shell
$ datafusion-cli
DataFusion CLI v13.0.0
-
❯ show datafusion.execution.batch_size;
+---------------------------------+---------+
| name | value |
diff --git a/docs/source/user-guide/example-usage.md b/docs/source/user-guide/example-usage.md
index fd525608d3..1c5c8f49a1 100644
--- a/docs/source/user-guide/example-usage.md
+++ b/docs/source/user-guide/example-usage.md
@@ -228,7 +228,7 @@ codegen-units = 1
Then, in `main.rs.` update the memory allocator with the below after your imports:
-```rust,ignore
+```rust ,ignore
use datafusion::prelude::*;
#[global_allocator]
diff --git a/docs/source/user-guide/expressions.md b/docs/source/user-guide/expressions.md
index f01750e56a..dcb599b9b3 100644
--- a/docs/source/user-guide/expressions.md
+++ b/docs/source/user-guide/expressions.md
@@ -152,7 +152,7 @@ but these operators always return a `bool` which makes them not work with the ex
Unlike to some databases the math functions in Datafusion works the same way as Rust math functions, avoiding failing on corner cases e.g
```sql
-❯ select log(-1), log(0), sqrt(-1);
+select log(-1), log(0), sqrt(-1);
+----------------+---------------+-----------------+
| log(Int64(-1)) | log(Int64(0)) | sqrt(Int64(-1)) |
+----------------+---------------+-----------------+
diff --git a/docs/source/user-guide/sql/data_types.md b/docs/source/user-guide/sql/data_types.md
index caa08b8bae..9f99d7bcb8 100644
--- a/docs/source/user-guide/sql/data_types.md
+++ b/docs/source/user-guide/sql/data_types.md
@@ -29,7 +29,7 @@ You can see the corresponding Arrow type for any SQL expression using
the `arrow_typeof` function. For example:
```sql
-❯ select arrow_typeof(interval '1 month');
+select arrow_typeof(interval '1 month');
+-------------------------------------+
| arrowtypeof(IntervalYearMonth("1")) |
+-------------------------------------+
@@ -41,7 +41,7 @@ You can cast a SQL expression to a specific Arrow type using the `arrow_cast` fu
For example, to cast the output of `now()` to a `Timestamp` with second precision:
```sql
-❯ select arrow_cast(now(), 'Timestamp(Second, None)');
+select arrow_cast(now(), 'Timestamp(Second, None)');
+---------------------+
| now() |
+---------------------+
diff --git a/docs/source/user-guide/sql/ddl.md b/docs/source/user-guide/sql/ddl.md
index 81e62efbeb..3d8b632f6e 100644
--- a/docs/source/user-guide/sql/ddl.md
+++ b/docs/source/user-guide/sql/ddl.md
@@ -188,7 +188,7 @@ LOCATION '/path/to/aggregate_test_100.csv';
Where `WITH ORDER` clause specifies the sort order:
-```sql
+```
WITH ORDER (sort_expression1 [ASC | DESC] [NULLS { FIRST | LAST }]
[, sort_expression2 [ASC | DESC] [NULLS { FIRST | LAST }] ...])
```
diff --git a/docs/source/user-guide/sql/explain.md b/docs/source/user-guide/sql/explain.md
index b240b14eb5..22f73e3d76 100644
--- a/docs/source/user-guide/sql/explain.md
+++ b/docs/source/user-guide/sql/explain.md
@@ -30,7 +30,7 @@ EXPLAIN [ANALYZE] [VERBOSE] statement
Shows the execution plan of a statement.
If you need more detailed output, use `EXPLAIN VERBOSE`.
-```sql
+```
EXPLAIN SELECT SUM(x) FROM table GROUP BY b;
+---------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| plan_type | plan |
@@ -54,7 +54,7 @@ EXPLAIN SELECT SUM(x) FROM table GROUP BY b;
Shows the execution plan and metrics of a statement.
If you need more information output, use `EXPLAIN ANALYZE VERBOSE`.
-```sql
+```
EXPLAIN ANALYZE SELECT SUM(x) FROM table GROUP BY b;
+-------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| plan_type | plan |
diff --git a/docs/source/user-guide/sql/information_schema.md b/docs/source/user-guide/sql/information_schema.md
index ced6117349..bf4aa00e1d 100644
--- a/docs/source/user-guide/sql/information_schema.md
+++ b/docs/source/user-guide/sql/information_schema.md
@@ -55,7 +55,7 @@ or
To show the current session configuration options, use the `SHOW ALL` command or the `information_schema.df_settings` view:
```sql
-❯ select * from information_schema.df_settings;
+select * from information_schema.df_settings;
+-------------------------------------------------+---------+
| name | setting |
diff --git a/docs/source/user-guide/sql/operators.md b/docs/source/user-guide/sql/operators.md
index 872ef55dd3..b0263ebe98 100644
--- a/docs/source/user-guide/sql/operators.md
+++ b/docs/source/user-guide/sql/operators.md
@@ -21,11 +21,13 @@
## Numerical Operators
-- [+ (plus)](#id1)
-- [- (minus)](#id2)
-- [\* (multiply)](#id3)
-- [/ (divide)](#id4)
-- [% (modulo)](#id5)
+- [+ (plus)](#op_plus)
+- [- (minus)](#op_minus)
+- [\* (multiply)](#op_multiply)
+- [/ (divide)](#op_divide)
+- [% (modulo)](#op_modulo)
+
+(op_plus)=
### `+`
@@ -40,6 +42,8 @@ Addition
+---------------------+
```
+(op_minus)=
+
### `-`
Subtraction
@@ -53,6 +57,8 @@ Subtraction
+---------------------+
```
+(op_multiply)=
+
### `*`
Multiplication
@@ -66,6 +72,8 @@ Multiplication
+---------------------+
```
+(op_divide)=
+
### `/`
Division (integer division truncates toward zero)
@@ -79,6 +87,8 @@ Division (integer division truncates toward zero)
+---------------------+
```
+(op_modulo)=
+
### `%`
Modulo (remainder)
@@ -94,18 +104,20 @@ Modulo (remainder)
## Comparison Operators
-- [= (equal)](#id6)
-- [!= (not equal)](#id7)
-- [< (less than)](#id8)
-- [<= (less than or equal to)](#id9)
-- [> (greater than)](#id10)
-- [>= (greater than or equal to)](#id11)
+- [= (equal)](#op_eq)
+- [!= (not equal)](#op_neq)
+- [< (less than)](#op_lt)
+- [<= (less than or equal to)](#op_le)
+- [> (greater than)](#op_gt)
+- [>= (greater than or equal to)](#op_ge)
- [IS DISTINCT FROM](#is-distinct-from)
- [IS NOT DISTINCT FROM](#is-not-distinct-from)
-- [~ (regex match)](#id12)
-- [~\* (regex case-insensitive match)](#id13)
-- [!~ (not regex match)](#id14)
-- [!~\* (not regex case-insensitive match)](#id15)
+- [~ (regex match)](#op_re_match)
+- [~\* (regex case-insensitive match)](#op_re_match_i)
+- [!~ (not regex match)](#op_re_not_match)
+- [!~\* (not regex case-insensitive match)](#op_re_not_match_i)
+
+(op_eq)=
### `=`
@@ -120,6 +132,8 @@ Equal
+---------------------+
```
+(op_neq)=
+
### `!=`
Not Equal
@@ -133,6 +147,8 @@ Not Equal
+----------------------+
```
+(op_lt)=
+
### `<`
Less Than
@@ -146,6 +162,8 @@ Less Than
+---------------------+
```
+(op_le)=
+
### `<=`
Less Than or Equal To
@@ -159,6 +177,8 @@ Less Than or Equal To
+----------------------+
```
+(op_gt)=
+
### `>`
Greater Than
@@ -172,6 +192,8 @@ Greater Than
+---------------------+
```
+(op_ge)=
+
### `>=`
Greater Than or Equal To
@@ -211,6 +233,8 @@ The negation of `IS DISTINCT FROM`
+--------------------------------+
```
+(op_re_match)=
+
### `~`
Regex Match
@@ -224,6 +248,8 @@ Regex Match
+-------------------------------------------------+
```
+(op_re_match_i)=
+
### `~*`
Regex Case-Insensitive Match
@@ -237,6 +263,8 @@ Regex Case-Insensitive Match
+--------------------------------------------------+
```
+(op_re_not_match)=
+
### `!~`
Not Regex Match
@@ -250,6 +278,8 @@ Not Regex Match
+--------------------------------------------------+
```
+(op_re_not_match_i)=
+
### `!~*`
Not Regex Case-Insensitive Match
@@ -268,7 +298,7 @@ Not Regex Case-Insensitive Match
Like Match
```sql
-❯ SELECT 'datafusion' ~~ 'dat_f%n';
+SELECT 'datafusion' ~~ 'dat_f%n';
+---------------------------------------+
| Utf8("datafusion") ~~ Utf8("dat_f%n") |
+---------------------------------------+
@@ -281,7 +311,7 @@ Like Match
Case-Insensitive Like Match
```sql
-❯ SELECT 'datafusion' ~~* 'Dat_F%n';
+SELECT 'datafusion' ~~* 'Dat_F%n';
+----------------------------------------+
| Utf8("datafusion") ~~* Utf8("Dat_F%n") |
+----------------------------------------+
@@ -294,7 +324,7 @@ Case-Insensitive Like Match
Not Like Match
```sql
-❯ SELECT 'datafusion' !~~ 'Dat_F%n';
+SELECT 'datafusion' !~~ 'Dat_F%n';
+----------------------------------------+
| Utf8("datafusion") !~~ Utf8("Dat_F%n") |
+----------------------------------------+
@@ -307,7 +337,7 @@ Not Like Match
Not Case-Insensitive Like Match
```sql
-❯ SELECT 'datafusion' !~~* 'Dat%F_n';
+SELECT 'datafusion' !~~* 'Dat%F_n';
+-----------------------------------------+
| Utf8("datafusion") !~~* Utf8("Dat%F_n") |
+-----------------------------------------+
@@ -348,11 +378,13 @@ Logical Or
## Bitwise Operators
-- [& (bitwise and)](#id16)
-- [| (bitwise or)](#id17)
-- [# (bitwise xor)](#id18)
-- [>> (bitwise shift right)](#id19)
-- [<< (bitwise shift left)](#id20)
+- [& (bitwise and)](#op_bit_and)
+- [| (bitwise or)](#op_bit_or)
+- [# (bitwise xor)](#op_bit_xor)
+- [>> (bitwise shift right)](#op_shift_r)
+- [<< (bitwise shift left)](#op_shift_l)
+
+(op_bit_and)=
### `&`
@@ -367,6 +399,8 @@ Bitwise And
+---------------------+
```
+(op_bit_or)=
+
### `|`
Bitwise Or
@@ -380,6 +414,8 @@ Bitwise Or
+---------------------+
```
+(op_bit_xor)=
+
### `#`
Bitwise Xor (interchangeable with `^`)
@@ -393,6 +429,8 @@ Bitwise Xor (interchangeable with `^`)
+---------------------+
```
+(op_shift_r)=
+
### `>>`
Bitwise Shift Right
@@ -406,6 +444,8 @@ Bitwise Shift Right
+----------------------+
```
+(op_shift_l)=
+
### `<<`
Bitwise Shift Left
@@ -421,9 +461,11 @@ Bitwise Shift Left
## Other Operators
-- [|| (string concatenation)](#id21)
-- [@> (array contains)](#id22)
-- [<@ (array is contained by)](#id23)
+- [|| (string concatenation)](#op_str_cat)
+- [@> (array contains)](#op_arr_contains)
+- [<@ (array is contained by)](#op_arr_contained_by)
+
+(op_str_cat)=
### `||`
@@ -438,6 +480,8 @@ String Concatenation
+----------------------------------------+
```
+(op_arr_contains)=
+
### `@>`
Array Contains
@@ -451,6 +495,8 @@ Array Contains
+-------------------------------------------------------------------------+
```
+(op_arr_contained_by)=
+
### `<@`
Array Is Contained By
diff --git a/docs/source/user-guide/sql/scalar_functions.md b/docs/source/user-guide/sql/scalar_functions.md
index 89405f29ac..c9c32a67ce 100644
--- a/docs/source/user-guide/sql/scalar_functions.md
+++ b/docs/source/user-guide/sql/scalar_functions.md
@@ -722,7 +722,7 @@ concat(str[, ..., str_n])
- **str_n**: Subsequent string column or literal string to concatenate.
**Related functions**:
-[contcat_ws](#contcat_ws)
+[concat_ws](#concat_ws)
### `concat_ws`
@@ -1298,13 +1298,13 @@ regexp_like(str, regexp[, flags])
#### Example
```sql
-❯ select regexp_like('Köln', '[a-zA-Z]ö[a-zA-Z]{2}');
+select regexp_like('Köln', '[a-zA-Z]ö[a-zA-Z]{2}');
+--------------------------------------------------------+
| regexp_like(Utf8("Köln"),Utf8("[a-zA-Z]ö[a-zA-Z]{2}")) |
+--------------------------------------------------------+
| true |
+--------------------------------------------------------+
-❯ SELECT regexp_like('aBc', '(b|d)', 'i');
+SELECT regexp_like('aBc', '(b|d)', 'i');
+--------------------------------------------------+
| regexp_like(Utf8("aBc"),Utf8("(b|d)"),Utf8("i")) |
+--------------------------------------------------+
@@ -1312,15 +1312,11 @@ regexp_like(str, regexp[, flags])
+--------------------------------------------------+
```
-Additional examples can be found [here]
-
-[here]: https://github.com/apache/arrow-datafusion/blob/main/datafusion-examples/examples/regexp.rs
+Additional examples can be found [here](https://github.com/apache/arrow-datafusion/blob/main/datafusion-examples/examples/regexp.rs)
### `regexp_match`
-Returns a list of [regular expression] matches in a string.
-
-[regular expression]: https://docs.rs/regex/latest/regex/#syntax
+Returns a list of [regular expression](https://docs.rs/regex/latest/regex/#syntax) matches in a string.
```
regexp_match(str, regexp[, flags])
@@ -1343,13 +1339,13 @@ regexp_match(str, regexp[, flags])
#### Example
```sql
-❯ select regexp_match('Köln', '[a-zA-Z]ö[a-zA-Z]{2}');
+select regexp_match('Köln', '[a-zA-Z]ö[a-zA-Z]{2}');
+---------------------------------------------------------+
| regexp_match(Utf8("Köln"),Utf8("[a-zA-Z]ö[a-zA-Z]{2}")) |
+---------------------------------------------------------+
| [Köln] |
+---------------------------------------------------------+
-❯ SELECT regexp_match('aBc', '(b|d)', 'i');
+SELECT regexp_match('aBc', '(b|d)', 'i');
+---------------------------------------------------+
| regexp_match(Utf8("aBc"),Utf8("(b|d)"),Utf8("i")) |
+---------------------------------------------------+
@@ -1357,15 +1353,11 @@ regexp_match(str, regexp[, flags])
+---------------------------------------------------+
```
-Additional examples can be found [here]
-
-[here]: https://github.com/apache/arrow-datafusion/blob/main/datafusion-examples/examples/regexp.rs
+Additional examples can be found [here](https://github.com/apache/arrow-datafusion/blob/main/datafusion-examples/examples/regexp.rs)
### `regexp_replace`
-Replaces substrings in a string that match a [regular expression].
-
-[regular expression]: https://docs.rs/regex/latest/regex/#syntax
+Replaces substrings in a string that match a [regular expression](https://docs.rs/regex/latest/regex/#syntax).
```
regexp_replace(str, regexp, replacement[, flags])
@@ -1391,13 +1383,13 @@ regexp_replace(str, regexp, replacement[, flags])
#### Example
```sql
-❯ SELECT regexp_replace('foobarbaz', 'b(..)', 'X\\1Y', 'g');
+SELECT regexp_replace('foobarbaz', 'b(..)', 'X\\1Y', 'g');
+------------------------------------------------------------------------+
| regexp_replace(Utf8("foobarbaz"),Utf8("b(..)"),Utf8("X\1Y"),Utf8("g")) |
+------------------------------------------------------------------------+
| fooXarYXazY |
+------------------------------------------------------------------------+
-❯ SELECT regexp_replace('aBc', '(b|d)', 'Ab\\1a', 'i');
+SELECT regexp_replace('aBc', '(b|d)', 'Ab\\1a', 'i');
+-------------------------------------------------------------------+
| regexp_replace(Utf8("aBc"),Utf8("(b|d)"),Utf8("Ab\1a"),Utf8("i")) |
+-------------------------------------------------------------------+
@@ -1405,9 +1397,7 @@ regexp_replace(str, regexp, replacement[, flags])
+-------------------------------------------------------------------+
```
-Additional examples can be found [here]
-
-[here]: https://github.com/apache/arrow-datafusion/blob/main/datafusion-examples/examples/regexp.rs
+Additional examples can be found [here](https://github.com/apache/arrow-datafusion/blob/main/datafusion-examples/examples/regexp.rs)
### `position`
@@ -1657,9 +1647,7 @@ make_date(year, month, day)
+-----------------------------------------------+
```
-Additional examples can be found [here]
-
-[here]: https://github.com/apache/arrow-datafusion/blob/main/datafusion-examples/examples/make_date.rs
+Additional examples can be found [here](https://github.com/apache/arrow-datafusion/blob/main/datafusion-examples/examples/make_date.rs)
### `to_timestamp`
@@ -1704,9 +1692,7 @@ to_timestamp(expression[, ..., format_n])
+--------------------------------------------------------------------------------------------------------+
```
-Additional examples can be found [here]
-
-[here]: https://github.com/apache/arrow-datafusion/blob/main/datafusion-examples/examples/to_timestamp.rs
+Additional examples can be found [here](https://github.com/apache/arrow-datafusion/blob/main/datafusion-examples/examples/to_timestamp.rs)
### `to_timestamp_millis`
@@ -1745,9 +1731,7 @@ to_timestamp_millis(expression[, ..., format_n])
+---------------------------------------------------------------------------------------------------------------+
```
-Additional examples can be found [here]
-
-[here]: https://github.com/apache/arrow-datafusion/blob/main/datafusion-examples/examples/to_timestamp.rs
+Additional examples can be found [here](https://github.com/apache/arrow-datafusion/blob/main/datafusion-examples/examples/to_timestamp.rs)
### `to_timestamp_micros`
@@ -1786,9 +1770,7 @@ to_timestamp_micros(expression[, ..., format_n])
+---------------------------------------------------------------------------------------------------------------+
```
-Additional examples can be found [here]
-
-[here]: https://github.com/apache/arrow-datafusion/blob/main/datafusion-examples/examples/to_timestamp.rs
+Additional examples can be found [here](https://github.com/apache/arrow-datafusion/blob/main/datafusion-examples/examples/to_timestamp.rs)
### `to_timestamp_nanos`
@@ -1827,9 +1809,7 @@ to_timestamp_nanos(expression[, ..., format_n])
+---------------------------------------------------------------------------------------------------------------+
```
-Additional examples can be found [here]
-
-[here]: https://github.com/apache/arrow-datafusion/blob/main/datafusion-examples/examples/to_timestamp.rs
+Additional examples can be found [here](https://github.com/apache/arrow-datafusion/blob/main/datafusion-examples/examples/to_timestamp.rs)
### `to_timestamp_seconds`
@@ -1868,9 +1848,7 @@ to_timestamp_seconds(expression[, ..., format_n])
+----------------------------------------------------------------------------------------------------------------+
```
-Additional examples can be found [here]
-
-[here]: https://github.com/apache/arrow-datafusion/blob/main/datafusion-examples/examples/to_timestamp.rs
+Additional examples can be found [here](https://github.com/apache/arrow-datafusion/blob/main/datafusion-examples/examples/to_timestamp.rs)
### `from_unixtime`
@@ -2053,6 +2031,10 @@ array_concat(array[, ..., array_n])
- list_cat
- list_concat
+### `array_contains`
+
+_Alias of [array_has](#array_has)._
+
### `array_has`
Returns true if the array contains the element
@@ -3088,8 +3070,8 @@ struct(expression1[, ..., expression_n])
For example, this query converts two columns `a` and `b` to a single column with
a struct type of fields `c0` and `c1`:
-```sql
-❯ select * from t;
+```
+select * from t;
+---+---+
| a | b |
+---+---+
@@ -3097,7 +3079,7 @@ a struct type of fields `c0` and `c1`:
| 3 | 4 |
+---+---+
-❯ select struct(a, b) from t;
+select struct(a, b) from t;
+-----------------+
| struct(t.a,t.b) |
+-----------------+
diff --git a/docs/source/user-guide/sql/select.md b/docs/source/user-guide/sql/select.md
index 4cffd4ce91..4463b0bb08 100644
--- a/docs/source/user-guide/sql/select.md
+++ b/docs/source/user-guide/sql/select.md
@@ -102,7 +102,7 @@ select * from x;
The keywords `JOIN` or `INNER JOIN` define a join that only shows rows where there is a match in both tables.
```sql
-❯ select * from x inner join x y ON x.column_1 = y.column_1;
+select * from x inner join x y ON x.column_1 = y.column_1;
+----------+----------+----------+----------+
| column_1 | column_2 | column_1 | column_2 |
+----------+----------+----------+----------+
@@ -116,7 +116,7 @@ The keywords `LEFT JOIN` or `LEFT OUTER JOIN` define a join that includes all ro
is not a match in the right table. When there is no match, null values are produced for the right side of the join.
```sql
-❯ select * from x left join x y ON x.column_1 = y.column_2;
+select * from x left join x y ON x.column_1 = y.column_2;
+----------+----------+----------+----------+
| column_1 | column_2 | column_1 | column_2 |
+----------+----------+----------+----------+
@@ -130,7 +130,7 @@ The keywords `RIGHT JOIN` or `RIGHT OUTER JOIN` define a join that includes all
is not a match in the left table. When there is no match, null values are produced for the left side of the join.
```sql
-❯ select * from x right join x y ON x.column_1 = y.column_2;
+select * from x right join x y ON x.column_1 = y.column_2;
+----------+----------+----------+----------+
| column_1 | column_2 | column_1 | column_2 |
+----------+----------+----------+----------+
@@ -145,7 +145,7 @@ The keywords `FULL JOIN` or `FULL OUTER JOIN` define a join that is effectively
either side of the join where there is not a match.
```sql
-❯ select * from x full outer join x y ON x.column_1 = y.column_2;
+select * from x full outer join x y ON x.column_1 = y.column_2;
+----------+----------+----------+----------+
| column_1 | column_2 | column_1 | column_2 |
+----------+----------+----------+----------+
@@ -160,7 +160,7 @@ A natural join defines an inner join based on common column names found between
column names are found, it behaves like a cross join.
```sql
-❯ select * from x natural join x y;
+select * from x natural join x y;
+----------+----------+
| column_1 | column_2 |
+----------+----------+
@@ -174,7 +174,7 @@ A cross join produces a cartesian product that matches every row in the left sid
right side of the join.
```sql
-❯ select * from x cross join x y;
+select * from x cross join x y;
+----------+----------+----------+----------+
| column_1 | column_2 | column_1 | column_2 |
+----------+----------+----------+----------+
diff --git a/docs/source/user-guide/sql/subqueries.md b/docs/source/user-guide/sql/subqueries.md
index 478fab7e7c..6055b0fc5b 100644
--- a/docs/source/user-guide/sql/subqueries.md
+++ b/docs/source/user-guide/sql/subqueries.md
@@ -24,7 +24,7 @@ DataFusion supports `EXISTS`, `NOT EXISTS`, `IN`, `NOT IN` and Scalar Subqueries
The examples below are based on the following table.
```sql
-❯ select * from x;
+select * from x;
+----------+----------+
| column_1 | column_2 |
+----------+----------+
@@ -38,7 +38,7 @@ The `EXISTS` syntax can be used to find all rows in a relation where a correlate
for that row. Only correlated subqueries are supported.
```sql
-❯ select * from x y where exists (select * from x where x.column_1 = y.column_1);
+select * from x y where exists (select * from x where x.column_1 = y.column_1);
+----------+----------+
| column_1 | column_2 |
+----------+----------+
@@ -53,7 +53,7 @@ The `NOT EXISTS` syntax can be used to find all rows in a relation where a corre
for that row. Only correlated subqueries are supported.
```sql
-❯ select * from x y where not exists (select * from x where x.column_1 = y.column_1);
+select * from x y where not exists (select * from x where x.column_1 = y.column_1);
0 rows in set.
```
@@ -63,7 +63,7 @@ The `IN` syntax can be used to find all rows in a relation where a given express
results of a correlated subquery.
```sql
-❯ select * from x where column_1 in (select column_1 from x);
+select * from x where column_1 in (select column_1 from x);
+----------+----------+
| column_1 | column_2 |
+----------+----------+
@@ -78,7 +78,7 @@ The `NOT IN` syntax can be used to find all rows in a relation where a given exp
results of a correlated subquery.
```sql
-❯ select * from x where column_1 not in (select column_1 from x);
+select * from x where column_1 not in (select column_1 from x);
0 rows in set.
```
@@ -88,7 +88,7 @@ A scalar subquery can be used to produce a single value that can be used in many
is an example of a filter using a scalar subquery. Only correlated subqueries are supported.
```sql
-❯ select * from x y where column_1 < (select sum(column_2) from x where x.column_1 = y.column_1);
+select * from x y where column_1 < (select sum(column_2) from x where x.column_1 = y.column_1);
+----------+----------+
| column_1 | column_2 |
+----------+----------+
diff --git a/docs/source/user-guide/sql/window_functions.md b/docs/source/user-guide/sql/window_functions.md
index b2ae66ba6c..4d9d255724 100644
--- a/docs/source/user-guide/sql/window_functions.md
+++ b/docs/source/user-guide/sql/window_functions.md
@@ -104,7 +104,7 @@ WINDOW w AS (PARTITION BY depname ORDER BY salary DESC);
The syntax for the OVER-clause is
-```sql
+```
function([expr])
OVER(
[PARTITION BY expr[, …]]
@@ -115,7 +115,7 @@ function([expr])
where **frame_clause** is one of:
-```sql
+```
{ RANGE | ROWS | GROUPS } frame_start
{ RANGE | ROWS | GROUPS } BETWEEN frame_start AND frame_end
```
diff --git a/docs/source/user-guide/sql/write_options.md b/docs/source/user-guide/sql/write_options.md
index 150da7c53d..09d51903f4 100644
--- a/docs/source/user-guide/sql/write_options.md
+++ b/docs/source/user-guide/sql/write_options.md
@@ -29,7 +29,7 @@ Write related options can be specified in the following ways:
- `CREATE EXTERNAL TABLE` options
- `COPY` option tuples
-For a list of supported session level config defaults see [Configuration Settings](configs). These defaults apply to all write operations but have the lowest level of precedence.
+For a list of supported session level config defaults see [Configuration Settings](../configs). These defaults apply to all write operations but have the lowest level of precedence.
If inserting to an external table, table specific write options can be specified when the table is created using the `OPTIONS` clause: