Skip to content

Fix docs generation in CI #16103

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Fix docs generation in CI #16103

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
201 changes: 0 additions & 201 deletions docs/source/user-guide/sql/window_functions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -193,29 +193,6 @@ Returns the rank of the current row without gaps. This function ranks rows in a
dense_rank()
```

#### Example

```sql
--Example usage of the dense_rank window function:
SELECT department,
salary,
dense_rank() OVER (PARTITION BY department ORDER BY salary DESC) AS dense_rank
FROM employees;
```

```sql
+-------------+--------+------------+
| department | salary | dense_rank |
+-------------+--------+------------+
| Sales | 70000 | 1 |
| Sales | 50000 | 2 |
| Sales | 50000 | 2 |
| Sales | 30000 | 3 |
| Engineering | 90000 | 1 |
| Engineering | 80000 | 2 |
+-------------+--------+------------+
```

### `ntile`

Integer ranging from 1 to the argument value, dividing the partition as equally as possible
Expand All @@ -228,31 +205,6 @@ ntile(expression)

- **expression**: An integer describing the number groups the partition should be split into

#### Exmaple

```sql
--Example usage of the ntile window function:
SELECT employee_id,
salary,
ntile(4) OVER (ORDER BY salary DESC) AS quartile
FROM employees;
```

```sql
+-------------+--------+----------+
| employee_id | salary | quartile |
+-------------+--------+----------+
| 1 | 90000 | 1 |
| 2 | 85000 | 1 |
| 3 | 80000 | 2 |
| 4 | 70000 | 2 |
| 5 | 60000 | 3 |
| 6 | 50000 | 3 |
| 7 | 40000 | 4 |
| 8 | 30000 | 4 |
+-------------+--------+----------+
```

### `percent_rank`

Returns the percentage rank of the current row within its partition. The value ranges from 0 to 1 and is computed as `(rank - 1) / (total_rows - 1)`.
Expand All @@ -261,26 +213,6 @@ Returns the percentage rank of the current row within its partition. The value r
percent_rank()
```

#### Example

```sql
--Example usage of the percent_rank window function:
SELECT employee_id,
salary,
percent_rank() OVER (ORDER BY salary) AS percent_rank
FROM employees;
```

```sql
+-------------+--------+---------------+
| employee_id | salary | percent_rank |
+-------------+--------+---------------+
| 1 | 30000 | 0.00 |
| 2 | 50000 | 0.50 |
| 3 | 70000 | 1.00 |
+-------------+--------+---------------+
```

### `rank`

Returns the rank of the current row within its partition, allowing gaps between ranks. This function provides a ranking similar to `row_number`, but skips ranks for identical values.
Expand All @@ -289,29 +221,6 @@ Returns the rank of the current row within its partition, allowing gaps between
rank()
```

#### Example

```sql
--Example usage of the rank window function:
SELECT department,
salary,
rank() OVER (PARTITION BY department ORDER BY salary DESC) AS rank
FROM employees;
```

```sql
+-------------+--------+------+
| department | salary | rank |
+-------------+--------+------+
| Sales | 70000 | 1 |
| Sales | 50000 | 2 |
| Sales | 50000 | 2 |
| Sales | 30000 | 4 |
| Engineering | 90000 | 1 |
| Engineering | 80000 | 2 |
+-------------+--------+------+
```

### `row_number`

Number of the current row within its partition, counting from 1.
Expand All @@ -320,29 +229,6 @@ Number of the current row within its partition, counting from 1.
row_number()
```

#### Example

```sql
--Example usage of the row_number window function:
SELECT department,
salary,
row_number() OVER (PARTITION BY department ORDER BY salary DESC) AS row_num
FROM employees;
```

```sql
+-------------+--------+---------+
| department | salary | row_num |
+-------------+--------+---------+
| Sales | 70000 | 1 |
| Sales | 50000 | 2 |
| Sales | 50000 | 3 |
| Sales | 30000 | 4 |
| Engineering | 90000 | 1 |
| Engineering | 80000 | 2 |
+-------------+--------+---------+
```

## Analytical Functions

- [first_value](#first_value)
Expand All @@ -363,29 +249,6 @@ first_value(expression)

- **expression**: Expression to operate on

#### Example

```sql
--Example usage of the first_value window function:
SELECT department,
employee_id,
salary,
first_value(salary) OVER (PARTITION BY department ORDER BY salary DESC) AS top_salary
FROM employees;
```

```sql
+-------------+-------------+--------+------------+
| department | employee_id | salary | top_salary |
+-------------+-------------+--------+------------+
| Sales | 1 | 70000 | 70000 |
| Sales | 2 | 50000 | 70000 |
| Sales | 3 | 30000 | 70000 |
| Engineering | 4 | 90000 | 90000 |
| Engineering | 5 | 80000 | 90000 |
+-------------+-------------+--------+------------+
```

### `lag`

Returns value evaluated at the row that is offset rows before the current row within the partition; if there is no such row, instead return default (which must be of the same type as value).
Expand All @@ -400,27 +263,6 @@ lag(expression, offset, default)
- **offset**: Integer. Specifies how many rows back the value of expression should be retrieved. Defaults to 1.
- **default**: The default value if the offset is not within the partition. Must be of the same type as expression.

#### Example

```sql
--Example usage of the lag window function:
SELECT employee_id,
salary,
lag(salary, 1, 0) OVER (ORDER BY employee_id) AS prev_salary
FROM employees;
```

```sql
+-------------+--------+-------------+
| employee_id | salary | prev_salary |
+-------------+--------+-------------+
| 1 | 30000 | 0 |
| 2 | 50000 | 30000 |
| 3 | 70000 | 50000 |
| 4 | 60000 | 70000 |
+-------------+--------+-------------+
```

### `last_value`

Returns value evaluated at the row that is the last row of the window frame.
Expand All @@ -433,27 +275,6 @@ last_value(expression)

- **expression**: Expression to operate on

```sql
-- SQL example of last_value:
SELECT department,
employee_id,
salary,
last_value(salary) OVER (PARTITION BY department ORDER BY salary) AS running_last_salary
FROM employees;
```

```sql
+-------------+-------------+--------+---------------------+
| department | employee_id | salary | running_last_salary |
+-------------+-------------+--------+---------------------+
| Sales | 1 | 30000 | 30000 |
| Sales | 2 | 50000 | 50000 |
| Sales | 3 | 70000 | 70000 |
| Engineering | 4 | 40000 | 40000 |
| Engineering | 5 | 60000 | 60000 |
+-------------+-------------+--------+---------------------+
```

### `lead`

Returns value evaluated at the row that is offset rows after the current row within the partition; if there is no such row, instead return default (which must be of the same type as value).
Expand All @@ -468,28 +289,6 @@ lead(expression, offset, default)
- **offset**: Integer. Specifies how many rows forward the value of expression should be retrieved. Defaults to 1.
- **default**: The default value if the offset is not within the partition. Must be of the same type as expression.

```sql
-- Example usage of lead() :
SELECT
employee_id,
department,
salary,
lead(salary, 1, 0) OVER (PARTITION BY department ORDER BY salary) AS next_salary
FROM employees;
```

```sql
+-------------+-------------+--------+--------------+
| employee_id | department | salary | next_salary |
+-------------+-------------+--------+--------------+
| 1 | Sales | 30000 | 50000 |
| 2 | Sales | 50000 | 70000 |
| 3 | Sales | 70000 | 0 |
| 4 | Engineering | 40000 | 60000 |
| 5 | Engineering | 60000 | 0 |
+-------------+-------------+--------+--------------+
```

### `nth_value`

Returns the value evaluated at the nth row of the window frame (counting from 1). Returns NULL if no such row exists.
Expand Down