Skip to content

Commit 21cfede

Browse files
Move the SQL and PPL directory to top level (#11621)
* Move the SQL and PPL directory to top level Signed-off-by: Fanit Kolchina <[email protected]> * Format blank lines after copy buttons Signed-off-by: Fanit Kolchina <[email protected]> * Update _sql-and-ppl/index.md Signed-off-by: Nathan Bower <[email protected]> --------- Signed-off-by: Fanit Kolchina <[email protected]> Signed-off-by: Nathan Bower <[email protected]> Co-authored-by: Nathan Bower <[email protected]>
1 parent e1e4e24 commit 21cfede

28 files changed

+443
-100
lines changed

_config.yml

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,10 @@ collections:
7070
output: true
7171
query-dsl:
7272
permalink: /:collection/:path/
73-
output: true
73+
output: true
74+
sql-and-ppl:
75+
permalink: /:collection/:path/
76+
output: true
7477
aggregations:
7578
permalink: /:collection/:path/
7679
output: true
@@ -174,6 +177,9 @@ opensearch_collection:
174177
query-dsl:
175178
name: Query DSL
176179
nav_fold: true
180+
sql-and-ppl:
181+
name: SQL and PPL
182+
nav_fold: true
177183
aggregations:
178184
name: Aggregations
179185
nav_fold: true

_search-plugins/sql/index.md

Lines changed: 0 additions & 21 deletions
This file was deleted.

_search-plugins/sql/cli.md renamed to _sql-and-ppl/cli.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
layout: default
33
title: SQL and PPL CLI
4-
parent: SQL and PPL
54
nav_order: 3
65
redirect_from:
76
- /search-plugins/sql/cli/
@@ -40,6 +39,8 @@ Launch your local OpenSearch instance and make sure you have the SQL plugin inst
4039
```console
4140
pip3 install opensearchsql
4241
```
42+
{% include copy.html %}
43+
4344

4445
The SQL CLI only works with Python 3.
4546
{: .note }
@@ -48,6 +49,8 @@ The SQL CLI only works with Python 3.
4849
```console
4950
opensearchsql https://localhost:9200 --username admin --password admin
5051
```
52+
{% include copy.html %}
53+
5154
By default, the `opensearchsql` command connects to http://localhost:9200.
5255

5356
## Configure
@@ -68,15 +71,21 @@ For a list of all available configurations, see [clirc](https://github.com/opens
6871
```console
6972
opensearchsql --username admin --password admin https://localhost:9200
7073
```
74+
{% include copy.html %}
75+
7176
If your cluster runs without security, run:
7277
```console
7378
opensearchsql
7479
```
80+
{% include copy.html %}
81+
7582

7683
2. Run a sample SQL command:
7784
```sql
7885
SELECT * FROM accounts;
7986
```
87+
{% include copy.html %}
88+
8089

8190
By default, you see a maximum output of 200 rows. To show more results, add a `LIMIT` clause with the desired value.
8291

@@ -89,11 +98,15 @@ To exit the CLI tool, select **Ctrl+D**.
8998
```console
9099
opensearchsql -l ppl <params>
91100
```
101+
{% include copy.html %}
102+
92103

93104
2. Execute a PPL query:
94105
```sql
95106
source=accounts | fields firstname, lastname
96107
```
108+
{% include copy.html %}
109+
97110

98111
## Query options
99112

_search-plugins/sql/datatypes.md renamed to _sql-and-ppl/datatypes.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
---
22
layout: default
33
title: Data types
4-
parent: SQL and PPL
54
nav_order: 7
5+
redirect_from:
6+
- /search-plugins/sql/datatypes/
67
---
78

89
# Data types

0 commit comments

Comments
 (0)