Skip to content

Commit e7cf15e

Browse files
authored
Docs sql commands landing page (#33996)
1 parent abc9e96 commit e7cf15e

File tree

15 files changed

+630
-40
lines changed

15 files changed

+630
-40
lines changed

doc/user/config.toml

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -69,13 +69,6 @@ identifier = "reference"
6969
name = "Reference"
7070
weight = 80
7171

72-
[[menu.main]]
73-
name = "SQL commands"
74-
identifier = "commands"
75-
parent = "reference"
76-
weight = 100
77-
78-
7972
#
8073
# Releases
8174
#

doc/user/content/get-started/install.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: "Install self-managed Materialize"
3-
description: "Install self-managed Materialize."
2+
title: "Install Self-Managed Materialize"
3+
description: "Install Self-Managed Materialize."
44
disable_list: true
55
menu:
66
main:

doc/user/content/installation/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: "Installation (Self-Managed)"
3-
description: "Installation guides for self-managed Materialize."
3+
description: "Installation guides for Self-Managed Materialize."
44
disable_list: true
55
menu:
66
main:

doc/user/content/integrations/mz-debug/self-managed.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: "mz-debug self-managed"
3-
description: Use mz-debug to debug Materialize self-managed Materialize Kubernetes environments.
3+
description: Use mz-debug to debug Self-Managed Materialize Kubernetes environments.
44
menu:
55
main:
66
parent: mz-debug

doc/user/content/security/self-managed/authentication.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ menu:
1111

1212
## Configuring Authentication Type
1313

14-
To configure the authentication type used by self-managed Materialize, use the
14+
To configure the authentication type used by Self-Managed Materialize, use the
1515
`spec.authenticatorKind` setting in conjunction with any specific configuration
1616
for the authentication method.
1717

@@ -26,7 +26,7 @@ used:
2626

2727
Password authentication requires users to log in with a password.
2828

29-
To configure self-managed Materialize for password authentication:
29+
To configure Self-Managed Materialize for password authentication:
3030

3131
Configuration | Description
3232
---------------| ------------

doc/user/content/self-managed/v25.2/installation/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: "Installation"
3-
description: "Installation guides for self-managed Materialize."
3+
description: "Installation guides for Self-Managed Materialize."
44
disable_list: true
55
aliases:
66
- /self-managed/installation/

doc/user/content/sql/_index.md

Lines changed: 37 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,47 @@
11
---
2-
title: "Reference"
3-
description: "A single page with every SQL command, function, type, and keyword."
2+
title: "SQL commands"
3+
description: "SQL commands reference."
44
disable_list: true
5+
menu:
6+
main:
7+
identifier: "commands"
8+
parent: "reference"
9+
weight: 100
10+
511
---
612

7-
[//]: # "TODO(morsapaes) Re-hash this page into something more useful, and add it as an Overview sub-menu under Reference"
13+
## Create/Alter/Drop Objects
14+
15+
{{< sql-commands-table-by-label label="object" group_by="object" >}}
16+
17+
## Create/Read/Update/Delete Data
18+
19+
The following commands perform CRUD operations on materialized views, views,
20+
sources, and tables:
21+
22+
{{< yaml-table data="sql_commands_crud" noHeader=true >}}
23+
24+
## RBAC
25+
26+
Commands to manage roles and privileges:
27+
28+
{{< yaml-table data="sql_commands_rbac" noHeader=true >}}
29+
30+
31+
## Query Introspection (`Explain`)
32+
33+
{{< yaml-list data="sql_commands_all" label="explain" numColumns="1" >}}
34+
35+
## Object Introspection (`SHOW`) { #show }
836

9-
We want Materialize to be easy to use, so we designed it to work with SQL. However, every database implements SQL a little differently, and none matches the full standard. In general, we model our implementation after PostgreSQL.
37+
{{< yaml-list data="sql_commands_all" label="show" numColumns="3" >}}
1038

11-
This section is a reference that details the SQL commands and features we support.
39+
## Session
1240

13-
## Architecture
41+
Commands related with session state and configurations:
1442

15-
- [Data types](./types)
16-
- [Functions + operators](./functions)
17-
- [Identifiers](./identifiers)
18-
- [Namespaces](./namespaces)
19-
- [System catalog](./system-catalog)
20-
- [Isolation level](./isolation-level)
43+
{{< yaml-list data="sql_commands_all" label="session" numColumns="1" >}}
2144

22-
## Statements
45+
## Validations
2346

24-
To see information about a statement, select it in the left nav bar.
47+
{{< yaml-list data="sql_commands_all" label="other" >}}

doc/user/content/sql/drop-user.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@ menu:
66
parent: commands
77
---
88

9-
`DROP USER` removes a role from Materialize.
9+
`DROP USER` removes a role from Materialize. `DROP USER` is an alias for [`DROP ROLE`](../drop-role).
10+
1011

1112
## Syntax
1213

@@ -17,10 +18,6 @@ Field | Use
1718
**IF EXISTS** | Do not return an error if the specified role does not exist.
1819
_role_name_ | The role you want to drop. For available roles, see [`mz_roles`](/sql/system-catalog/mz_catalog#mz_roles).
1920

20-
## Details
21-
22-
`DROP USER` is an alias for [`DROP ROLE`](../drop-role).
23-
2421
## Privileges
2522

2623
The privileges required to execute this statement are:

0 commit comments

Comments
 (0)