Skip to content
This repository was archived by the owner on Jul 21, 2019. It is now read-only.

Commit 0cfe730

Browse files
schoudhuryschoudhury
authored
updated psql to ysqlsh and other misc fixes (#92)
1 parent 8138c36 commit 0cfe730

File tree

34 files changed

+4609
-1548
lines changed

34 files changed

+4609
-1548
lines changed

‎content/_index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,7 @@ <h2> REFERENCE </h2>
162162
<a class="section-link icon-offset" href="/latest/admin/">
163163
<div class="head">
164164
<img class="icon" src="/images/section_icons/index/admin.png" aria-hidden="true" />
165-
<div class="articles">5 articles</div>
165+
<div class="articles">6 articles</div>
166166
<div class="title">CLIs</div>
167167
</div>
168168
<div class="body">

‎content/latest/_index.html‎

Lines changed: 49 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -8,26 +8,26 @@
88
---
99
<div class="row">
1010
<div class="col-12 col-md-6">
11-
<a class="section-link icon-offset" href="introduction/">
11+
<a class="section-link icon-offset" href="quick-start/">
1212
<div class="head">
13-
<img class="icon" src="/images/section_icons/index/introduction.png" aria-hidden="true" />
14-
<div class="title">Introduction</div>
13+
<img class="icon" src="/images/section_icons/index/quick_start.png" aria-hidden="true" />
14+
<div class="articles">4 chapters</div>
15+
<div class="title">Quick Start</div>
1516
</div>
1617
<div class="body">
17-
Learn more about YugaByte DB's unique value proposition.
18+
Get started in < 5 minutes on macOS, Linux, Docker and Kubernetes.
1819
</div>
1920
</a>
2021
</div>
2122

2223
<div class="col-12 col-md-6">
23-
<a class="section-link icon-offset" href="quick-start/">
24+
<a class="section-link icon-offset" href="introduction/">
2425
<div class="head">
25-
<img class="icon" src="/images/section_icons/index/quick_start.png" aria-hidden="true" />
26-
<div class="articles">4 chapters</div>
27-
<div class="title">Quick Start</div>
26+
<img class="icon" src="/images/section_icons/index/introduction.png" aria-hidden="true" />
27+
<div class="title">Introduction</div>
2828
</div>
2929
<div class="body">
30-
Get started in < 5 minutes on macOS, Linux, Docker and Kubernetes.
30+
Learn more about YugaByte DB's unique value proposition.
3131
</div>
3232
</a>
3333
</div>
@@ -137,27 +137,27 @@
137137
</div>
138138

139139
<div class="col-12 col-md-6">
140-
<a class="section-link icon-offset" href="comparisons/">
140+
<a class="section-link icon-offset" href="api/">
141141
<div class="head">
142-
<img class="icon" src="/images/section_icons/index/comparisons.png" aria-hidden="true" />
143-
<div class="articles">8 chapters</div>
144-
<div class="title">Comparisons</div>
142+
<img class="icon" src="/images/section_icons/index/api.png" aria-hidden="true" />
143+
<div class="articles">2 chapters</div>
144+
<div class="title">API Reference</div>
145145
</div>
146146
<div class="body">
147-
Comparisons with common operational databases.
147+
Reference for the YSQL and YCQL APIs.
148148
</div>
149149
</a>
150150
</div>
151151

152152
<div class="col-12 col-md-6">
153-
<a class="section-link icon-offset" href="api/">
153+
<a class="section-link icon-offset" href="admin/">
154154
<div class="head">
155-
<img class="icon" src="/images/section_icons/index/api.png" aria-hidden="true" />
156-
<div class="articles">2 chapters</div>
157-
<div class="title">API Reference</div>
155+
<img class="icon" src="/images/section_icons/index/admin.png" aria-hidden="true" />
156+
<div class="articles">6 chapters</div>
157+
<div class="title">CLI Reference</div>
158158
</div>
159159
<div class="body">
160-
Reference for the YSQL and YCQL APIs.
160+
Admin commands and utilities reference.
161161
</div>
162162
</a>
163163
</div>
@@ -166,11 +166,38 @@
166166
<a class="section-link icon-offset" href="admin/">
167167
<div class="head">
168168
<img class="icon" src="/images/section_icons/index/admin.png" aria-hidden="true" />
169-
<div class="articles">5 chapters</div>
170-
<div class="title">Admin Reference</div>
169+
<div class="articles">1 chapters</div>
170+
<div class="title">Tools Reference</div>
171171
</div>
172172
<div class="body">
173-
Admin commands and utilities reference.
173+
Reference for 3rd party tools such as TablePlus.
174+
</div>
175+
</a>
176+
</div>
177+
178+
179+
<div class="col-12 col-md-6">
180+
<a class="section-link icon-offset" href="releases/">
181+
<div class="head">
182+
<img class="icon" src="/images/section_icons/quick_start/install.png" aria-hidden="true" />
183+
<div class="title">Release History</div>
184+
</div>
185+
<div class="body">
186+
History of important YugaByte DB releases.
187+
</div>
188+
</a>
189+
</div>
190+
191+
192+
<div class="col-12 col-md-6">
193+
<a class="section-link icon-offset" href="comparisons/">
194+
<div class="head">
195+
<img class="icon" src="/images/section_icons/index/comparisons.png" aria-hidden="true" />
196+
<div class="articles">8 chapters</div>
197+
<div class="title">Comparisons</div>
198+
</div>
199+
<div class="body">
200+
Comparisons with common operational databases.
174201
</div>
175202
</a>
176203
</div>

‎content/latest/admin/_index.html‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,18 @@
7777
</a>
7878
</div>
7979

80+
<div class="col-12 col-md-6 col-lg-12 col-xl-6">
81+
<a class="section-link icon-offset" href="ysqlsh/">
82+
<div class="head">
83+
<img class="icon" src="/images/section_icons/api/ysql.png" aria-hidden="true" />
84+
<div class="title">ysqlsh</div>
85+
</div>
86+
<div class="body">
87+
Command line shell for connecting to YugaByte DB with YSQL.
88+
</div>
89+
</a>
90+
</div>
91+
8092
<div class="col-12 col-md-6 col-lg-12 col-xl-6">
8193
<a class="section-link icon-offset" href="cqlsh/">
8294
<div class="head">

‎content/latest/admin/cqlsh.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ showAsideToc: true
1616

1717
## Overview
1818

19-
`cqlsh` is a command-line shell for interacting with YugaByte DB through [YCQL](../../api/ycql/).
19+
`cqlsh` is a command line shell for interacting with YugaByte DB through [YCQL](../../api/ycql/).
2020

2121
## Download
2222

@@ -36,7 +36,7 @@ $ ./bin/cqlsh --execute "select cluster_name, data_center, rack from system.loca
3636

3737
## Command Line Options
3838

39-
Use the **-\-help** option to see all the command-line options supported.
39+
Use the **-\-help** option to see all the command line options supported.
4040

4141
```
4242
cqlsh [options] [host [port]]

‎content/latest/admin/ysqlsh.md‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
title: ysqlsh
3+
linkTitle: ysqlsh
4+
description: ysqlsh
5+
aliases:
6+
- /develop/tools/ysqlsh/
7+
- /latest/develop/tools/ysqlsh/
8+
menu:
9+
latest:
10+
identifier: ysqlsh
11+
parent: admin
12+
weight: 2459
13+
isTocNested: true
14+
showAsideToc: true
15+
---
16+
17+
## Overview
18+
19+
`ysqlsh` is a command line shell for interacting with YugaByte DB through [YSQL](../../api/ysql/). It is derived from [`psql`](https://www.postgresql.org/docs/11/app-psql.html), the PostgreSQL shell.
20+
21+
## Download
22+
23+
ysqlsh is installed as part of YugaByte DB and is located in the bin directory of YugaByte home.
24+
25+
## Example
26+
27+
```sh
28+
$ ./bin/ysqlsh --echo-queries
29+
```
30+
31+
```
32+
ysqlsh (11.2)
33+
Type "help" for help.
34+
35+
postgres=#
36+
```
37+
38+
## Defaults
39+
40+
ysqlsh defaults the following flags so that the user does not have to specify them.
41+
42+
```
43+
-h 127.0.0.1
44+
-p 5433
45+
-U postgres
46+
```

‎content/latest/api/ysql/commands/txn_abort.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ postgres=# BEGIN TRANSACTION; SET TRANSACTION ISOLATION LEVEL REPEATABLE READ;
5151
postgres=# INSERT INTO sample(k1, k2, v1, v2) VALUES (1, 2.0, 3, 'a'), (1, 3.0, 4, 'b');
5252
```
5353

54-
Start a new shell with `psql` and begin another transaction to insert some more rows.
54+
Start a new shell with `ysqlsh` and begin another transaction to insert some more rows.
5555

5656
```sql
5757
postgres=# BEGIN TRANSACTION; SET TRANSACTION ISOLATION LEVEL REPEATABLE READ;

‎content/latest/api/ysql/commands/txn_begin.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ postgres=# BEGIN TRANSACTION; SET TRANSACTION ISOLATION LEVEL REPEATABLE READ;
5050
postgres=# INSERT INTO sample(k1, k2, v1, v2) VALUES (1, 2.0, 3, 'a'), (1, 3.0, 4, 'b');
5151
```
5252

53-
Start a new shell with `psql` and begin another transaction to insert some more rows.
53+
Start a new shell with `ysqlsh` and begin another transaction to insert some more rows.
5454

5555
```sql
5656
postgres=# BEGIN TRANSACTION; SET TRANSACTION ISOLATION LEVEL REPEATABLE READ;

‎content/latest/api/ysql/commands/txn_commit.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ postgres=# BEGIN TRANSACTION; SET TRANSACTION ISOLATION LEVEL REPEATABLE READ;
5252
postgres=# INSERT INTO sample(k1, k2, v1, v2) VALUES (1, 2.0, 3, 'a'), (1, 3.0, 4, 'b');
5353
```
5454

55-
Start a new shell with `psql` and begin another transaction to insert some more rows.
55+
Start a new shell with `ysqlsh` and begin another transaction to insert some more rows.
5656

5757
```sql
5858
postgres=# BEGIN TRANSACTION; SET TRANSACTION ISOLATION LEVEL REPEATABLE READ;

‎content/latest/api/ysql/commands/txn_end.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ postgres=# BEGIN TRANSACTION; SET TRANSACTION ISOLATION LEVEL REPEATABLE READ;
5050
postgres=# INSERT INTO sample(k1, k2, v1, v2) VALUES (1, 2.0, 3, 'a'), (1, 3.0, 4, 'b');
5151
```
5252

53-
Start a new shell with `psql` and begin another transaction to insert some more rows.
53+
Start a new shell with `ysqlsh` and begin another transaction to insert some more rows.
5454

5555
```sql
5656
postgres=# BEGIN TRANSACTION; SET TRANSACTION ISOLATION LEVEL REPEATABLE READ;

‎content/latest/api/ysql/commands/txn_rollback.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ postgres=# BEGIN TRANSACTION; SET TRANSACTION ISOLATION LEVEL REPEATABLE READ;
5252
postgres=# INSERT INTO sample(k1, k2, v1, v2) VALUES (1, 2.0, 3, 'a'), (1, 3.0, 4, 'b');
5353
```
5454

55-
Start a new shell with `psql` and begin another transaction to insert some more rows.
55+
Start a new shell with `ysqlsh` and begin another transaction to insert some more rows.
5656

5757
```sql
5858
postgres=# BEGIN TRANSACTION; SET TRANSACTION ISOLATION LEVEL REPEATABLE READ;

0 commit comments

Comments
 (0)