Skip to content
This repository was archived by the owner on Jul 21, 2019. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion content/_index.html
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ <h2> REFERENCE </h2>
<a class="section-link icon-offset" href="/latest/admin/">
<div class="head">
<img class="icon" src="/images/section_icons/index/admin.png" aria-hidden="true" />
<div class="articles">5 articles</div>
<div class="articles">6 articles</div>
<div class="title">CLIs</div>
</div>
<div class="body">
Expand Down
71 changes: 49 additions & 22 deletions content/latest/_index.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,26 +8,26 @@
---
<div class="row">
<div class="col-12 col-md-6">
<a class="section-link icon-offset" href="introduction/">
<a class="section-link icon-offset" href="quick-start/">
<div class="head">
<img class="icon" src="/images/section_icons/index/introduction.png" aria-hidden="true" />
<div class="title">Introduction</div>
<img class="icon" src="/images/section_icons/index/quick_start.png" aria-hidden="true" />
<div class="articles">4 chapters</div>
<div class="title">Quick Start</div>
</div>
<div class="body">
Learn more about YugaByte DB's unique value proposition.
Get started in < 5 minutes on macOS, Linux, Docker and Kubernetes.
</div>
</a>
</div>

<div class="col-12 col-md-6">
<a class="section-link icon-offset" href="quick-start/">
<a class="section-link icon-offset" href="introduction/">
<div class="head">
<img class="icon" src="/images/section_icons/index/quick_start.png" aria-hidden="true" />
<div class="articles">4 chapters</div>
<div class="title">Quick Start</div>
<img class="icon" src="/images/section_icons/index/introduction.png" aria-hidden="true" />
<div class="title">Introduction</div>
</div>
<div class="body">
Get started in < 5 minutes on macOS, Linux, Docker and Kubernetes.
Learn more about YugaByte DB's unique value proposition.
</div>
</a>
</div>
Expand Down Expand Up @@ -137,27 +137,27 @@
</div>

<div class="col-12 col-md-6">
<a class="section-link icon-offset" href="comparisons/">
<a class="section-link icon-offset" href="api/">
<div class="head">
<img class="icon" src="/images/section_icons/index/comparisons.png" aria-hidden="true" />
<div class="articles">8 chapters</div>
<div class="title">Comparisons</div>
<img class="icon" src="/images/section_icons/index/api.png" aria-hidden="true" />
<div class="articles">2 chapters</div>
<div class="title">API Reference</div>
</div>
<div class="body">
Comparisons with common operational databases.
Reference for the YSQL and YCQL APIs.
</div>
</a>
</div>

<div class="col-12 col-md-6">
<a class="section-link icon-offset" href="api/">
<a class="section-link icon-offset" href="admin/">
<div class="head">
<img class="icon" src="/images/section_icons/index/api.png" aria-hidden="true" />
<div class="articles">2 chapters</div>
<div class="title">API Reference</div>
<img class="icon" src="/images/section_icons/index/admin.png" aria-hidden="true" />
<div class="articles">6 chapters</div>
<div class="title">CLI Reference</div>
</div>
<div class="body">
Reference for the YSQL and YCQL APIs.
Admin commands and utilities reference.
</div>
</a>
</div>
Expand All @@ -166,11 +166,38 @@
<a class="section-link icon-offset" href="admin/">
<div class="head">
<img class="icon" src="/images/section_icons/index/admin.png" aria-hidden="true" />
<div class="articles">5 chapters</div>
<div class="title">Admin Reference</div>
<div class="articles">1 chapters</div>
<div class="title">Tools Reference</div>
</div>
<div class="body">
Admin commands and utilities reference.
Reference for 3rd party tools such as TablePlus.
</div>
</a>
</div>


<div class="col-12 col-md-6">
<a class="section-link icon-offset" href="releases/">
<div class="head">
<img class="icon" src="/images/section_icons/quick_start/install.png" aria-hidden="true" />
<div class="title">Release History</div>
</div>
<div class="body">
History of important YugaByte DB releases.
</div>
</a>
</div>


<div class="col-12 col-md-6">
<a class="section-link icon-offset" href="comparisons/">
<div class="head">
<img class="icon" src="/images/section_icons/index/comparisons.png" aria-hidden="true" />
<div class="articles">8 chapters</div>
<div class="title">Comparisons</div>
</div>
<div class="body">
Comparisons with common operational databases.
</div>
</a>
</div>
Expand Down
12 changes: 12 additions & 0 deletions content/latest/admin/_index.html
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,18 @@
</a>
</div>

<div class="col-12 col-md-6 col-lg-12 col-xl-6">
<a class="section-link icon-offset" href="ysqlsh/">
<div class="head">
<img class="icon" src="/images/section_icons/api/ysql.png" aria-hidden="true" />
<div class="title">ysqlsh</div>
</div>
<div class="body">
Command line shell for connecting to YugaByte DB with YSQL.
</div>
</a>
</div>

<div class="col-12 col-md-6 col-lg-12 col-xl-6">
<a class="section-link icon-offset" href="cqlsh/">
<div class="head">
Expand Down
4 changes: 2 additions & 2 deletions content/latest/admin/cqlsh.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ showAsideToc: true

## Overview

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

## Download

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

## Command Line Options

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

```
cqlsh [options] [host [port]]
Expand Down
46 changes: 46 additions & 0 deletions content/latest/admin/ysqlsh.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
title: ysqlsh
linkTitle: ysqlsh
description: ysqlsh
aliases:
- /develop/tools/ysqlsh/
- /latest/develop/tools/ysqlsh/
menu:
latest:
identifier: ysqlsh
parent: admin
weight: 2459
isTocNested: true
showAsideToc: true
---

## Overview

`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.

## Download

ysqlsh is installed as part of YugaByte DB and is located in the bin directory of YugaByte home.

## Example

```sh
$ ./bin/ysqlsh --echo-queries
```

```
ysqlsh (11.2)
Type "help" for help.

postgres=#
```

## Defaults

ysqlsh defaults the following flags so that the user does not have to specify them.

```
-h 127.0.0.1
-p 5433
-U postgres
```
2 changes: 1 addition & 1 deletion content/latest/api/ysql/commands/txn_abort.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ postgres=# BEGIN TRANSACTION; SET TRANSACTION ISOLATION LEVEL REPEATABLE READ;
postgres=# INSERT INTO sample(k1, k2, v1, v2) VALUES (1, 2.0, 3, 'a'), (1, 3.0, 4, 'b');
```

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

```sql
postgres=# BEGIN TRANSACTION; SET TRANSACTION ISOLATION LEVEL REPEATABLE READ;
Expand Down
2 changes: 1 addition & 1 deletion content/latest/api/ysql/commands/txn_begin.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ postgres=# BEGIN TRANSACTION; SET TRANSACTION ISOLATION LEVEL REPEATABLE READ;
postgres=# INSERT INTO sample(k1, k2, v1, v2) VALUES (1, 2.0, 3, 'a'), (1, 3.0, 4, 'b');
```

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

```sql
postgres=# BEGIN TRANSACTION; SET TRANSACTION ISOLATION LEVEL REPEATABLE READ;
Expand Down
2 changes: 1 addition & 1 deletion content/latest/api/ysql/commands/txn_commit.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ postgres=# BEGIN TRANSACTION; SET TRANSACTION ISOLATION LEVEL REPEATABLE READ;
postgres=# INSERT INTO sample(k1, k2, v1, v2) VALUES (1, 2.0, 3, 'a'), (1, 3.0, 4, 'b');
```

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

```sql
postgres=# BEGIN TRANSACTION; SET TRANSACTION ISOLATION LEVEL REPEATABLE READ;
Expand Down
2 changes: 1 addition & 1 deletion content/latest/api/ysql/commands/txn_end.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ postgres=# BEGIN TRANSACTION; SET TRANSACTION ISOLATION LEVEL REPEATABLE READ;
postgres=# INSERT INTO sample(k1, k2, v1, v2) VALUES (1, 2.0, 3, 'a'), (1, 3.0, 4, 'b');
```

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

```sql
postgres=# BEGIN TRANSACTION; SET TRANSACTION ISOLATION LEVEL REPEATABLE READ;
Expand Down
2 changes: 1 addition & 1 deletion content/latest/api/ysql/commands/txn_rollback.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ postgres=# BEGIN TRANSACTION; SET TRANSACTION ISOLATION LEVEL REPEATABLE READ;
postgres=# INSERT INTO sample(k1, k2, v1, v2) VALUES (1, 2.0, 3, 'a'), (1, 3.0, 4, 'b');
```

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

```sql
postgres=# BEGIN TRANSACTION; SET TRANSACTION ISOLATION LEVEL REPEATABLE READ;
Expand Down
4 changes: 2 additions & 2 deletions content/latest/api/ysql/commands/txn_set.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ set ::= SET TRANSACTION { ISOLATION LEVEL { READ UNCOMMITTED
## Semantics

- The `SERIALIZABLE` isolation level not yet supported. (This is currently in progress).
- Currently YugaByte will always use the snapshot isolation level internally. See more [here](../../../architecture/transactions/isolation-levels/).
- Currently YugaByte DB will always use the snapshot isolation level internally. See more [here](../../../architecture/transactions/isolation-levels/).

## Examples

Expand All @@ -57,7 +57,7 @@ postgres=# BEGIN TRANSACTION; SET TRANSACTION ISOLATION LEVEL REPEATABLE READ;
postgres=# INSERT INTO sample(k1, k2, v1, v2) VALUES (1, 2.0, 3, 'a'), (1, 3.0, 4, 'b');
```

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

```sql
postgres=# BEGIN TRANSACTION; SET TRANSACTION ISOLATION LEVEL REPEATABLE READ;
Expand Down
2 changes: 1 addition & 1 deletion content/latest/api/ysql/commands/txn_show.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ postgres=# BEGIN TRANSACTION; SET TRANSACTION ISOLATION LEVEL REPEATABLE READ;
postgres=# INSERT INTO sample(k1, k2, v1, v2) VALUES (1, 2.0, 3, 'a'), (1, 3.0, 4, 'b');
```

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

```sql
postgres=# BEGIN TRANSACTION; SET TRANSACTION ISOLATION LEVEL REPEATABLE READ;
Expand Down
10 changes: 4 additions & 6 deletions content/latest/deploy/docker/docker-swarm.md
Original file line number Diff line number Diff line change
Expand Up @@ -300,20 +300,18 @@ I0515 19:54:48.953572 39 yb-admin_client.cc:440] Table 'system_redis.redis' c
$ docker exec -it <ybtserver_container_id> yum install postgresql
```

- Connect to the psql client in yb-tserver.
- Connect to the ysqlsh client in yb-tserver.

```sh
$ docker exec -it <ybtserver_container_id> psql -h localhost --port 5433
$ docker exec -it <ybtserver_container_id> ysqlsh
```

```
...
psql (9.2.23, server 0.0.0)
WARNING: psql version 9.2, server version 0.0.
Some psql features might not work.
ysqlsh (11.2)
Type "help" for help.

root=>
postgres=#
```

- Follow the test instructions as noted in [Quick Start](../quick-start/test-postgresql/).
Expand Down
4 changes: 2 additions & 2 deletions content/latest/deploy/kubernetes/helm-chart.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,10 +111,10 @@ Initialize the YSQL API (after ensuring that cluster is running - see "Check Clu
$ kubectl exec -it -n yb-demo yb-tserver-0 bash -- -c "YB_ENABLED_IN_POSTGRES=1 FLAGS_pggate_master_addresses=yb-master-0.yb-masters.yb-demo.svc.cluster.local:7100,yb-master-1.yb-masters.yb-demo.svc.cluster.local:7100,yb-master-2.yb-masters.yb-demo.svc.cluster.local:7100 /home/yugabyte/postgres/bin/initdb -D /tmp/yb_pg_initdb_tmp_data_dir -U postgres"
```

Connect using psql client as shown below.
Connect using ysqlsh client as shown below.

```sh
$ kubectl exec -n yb-demo -it yb-tserver-0 /home/yugabyte/bin/psql -- -U postgres -d postgres -h yb-tserver-0.yb-tservers.yb-demo -p 5433
$ kubectl exec -n yb-demo -it yb-tserver-0 /home/yugabyte/bin/ysqlsh -- -h yb-tserver-0.yb-tservers.yb-demo
```

## Check Cluster Status
Expand Down
2 changes: 1 addition & 1 deletion content/latest/deploy/public-clouds/gcp/gke.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

- Install `kubectl`

After installing Cloud SDK, install the kubectl command-line tool by running the following command:
After installing Cloud SDK, install the kubectl command line tool by running the following command:

```sh
$ gcloud components install kubectl
Expand Down
4 changes: 0 additions & 4 deletions content/latest/develop/build-apps/java/ycql.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,6 @@
title: Build a Java App
linkTitle: Build a Java App
description: Build a Java App
aliases:
- /develop/client-drivers/java/
- /latest/develop/client-drivers/java/
- /latest/develop/build-apps/java/
menu:
latest:
parent: build-apps
Expand Down
4 changes: 0 additions & 4 deletions content/latest/develop/build-apps/java/ysql-spring-data.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,6 @@
title: Build a Java App
linkTitle: Build a Java App
description: Build a Java App
aliases:
- /develop/client-drivers/java/
- /latest/develop/client-drivers/java/
- /latest/develop/build-apps/java/
menu:
latest:
parent: build-apps
Expand Down
4 changes: 2 additions & 2 deletions content/latest/develop/ecosystem-integrations/apache-kafka.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ isTocNested: true
showAsideToc: true
---

In this tutorial, we are going to use the [Kafka Connect-based Sink Connector for YugaByte DB](https://github.com/YugaByte/yb-kafka-connector) to store events from Apache Kafka into YugaByte DB using YugaByte DB's Cassandra-compatible [YCQL](../../../api/ycql) API.
In this tutorial, we are going to use the [Kafka Connect-based Sink Connector for YugaByte DB](https://github.com/YugaByte/yb-kafka-connector) to store events from Apache Kafka into YugaByte DB using YugaByte DB's [YCQL](../../../api/ycql) API.

## 1. Start Local Cluster

Expand Down Expand Up @@ -69,7 +69,7 @@ The connector jar `yb-kafka-connnector-1.0.0.jar` is now placed in the `./target
$ cp ./target/yb-kafka-connnector-1.0.0.jar ~/yb-kafka/kafka_2.11-2.0.0/libs/
```

Go to the Kafka libs directory and get the additional jars that the connector depends on (including the driver for the Cassandra-compatible YCQL API)
Go to the Kafka libs directory and get the additional jars that the connector depends on (including the driver for the YCQL API)

```sh
$ cd ~/yb-kafka/kafka_2.11-2.0.0/libs/
Expand Down
8 changes: 4 additions & 4 deletions content/latest/develop/ecosystem-integrations/metabase.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,16 +45,16 @@ $ ls data/
orders.sql products.sql reviews.sql users.sql
```

### Connect to YugaByte DB using psql
### Connect to YugaByte DB using ysqlsh

You can do this as shown below.

```sh
$ ./bin/psql -p 5433 -U postgres
$ ./bin/ysqlsh
```

```
psql (10.3, server 10.4)
ysqlsh (11.2)
Type "help" for help.

postgres=#
Expand Down Expand Up @@ -112,7 +112,7 @@ $ wget http://downloads.metabase.com/v0.30.4/metabase.jar
$ java -jar metabase.jar
```

Go to http://localhost:3000 to configure your Metabase server and point it to the YugaByte DB PostgreSQL API endpoint at `localhost:5433`.
Go to http://localhost:3000 to configure your Metabase server and point it to the YSQL API endpoint at `localhost:5433`.

## 4. Run Complex Queries with Metabase

Expand Down
Loading