Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
pmenglund committed Oct 24, 2023
1 parent 675ed48 commit 7b04006
Show file tree
Hide file tree
Showing 5 changed files with 20 additions and 21 deletions.
37 changes: 18 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
# Rockset CLI
[![Build status](https://github.com/rockset/cli/actions/workflows/build.yaml/badge.svg)](https://github.com/rockset/cli/actions/workflows/build.yaml)
[![CircleCI](https://circleci.com/gh/rockset/cli.svg?style=shield)](https://circleci.com/gh/rockset/cli)
[![Documentation](https://godoc.org/github.com/rockset/rockset-go-cli?status.svg)](http://godoc.org/github.com/rockset/rockset-go-cli)
[![License](https://img.shields.io/github/license/rockset/cli.svg?maxAge=2592000)](https://github.com/rockset/rockset-go-cli/LICENSE)
[![GitHub issues](https://img.shields.io/github/issues/rockset/cli.svg)](https://github.com/rockset/rockset-go-cli/issues)
Expand All @@ -11,7 +10,7 @@
The Rockset cli can be used as an alternative to the [console](https://console.rockset.com/),
and is built as a UNIX tool to allow it to be used in pipes.

![screen recording](vhs/demo.gif)
![screen recording](vhs/quickstart.gif)

### Query

Expand All @@ -21,12 +20,12 @@ There are three ways to query a collection, either using the first argument as t

```shell
$ rockset query 'SELECT COUNT(*) FROM _events'
+--------+
| ?COUNT |
+--------+
| 1016 |
+--------+
Elapsed time: 26 ms
┌────────┐
?COUNT
├────────┤
│ 2488 │
└────────┘
Elapsed time: 22 ms
```

Or using interactive mode
Expand All @@ -35,11 +34,11 @@ Or using interactive mode
$ rockset query
[R]> SELECT COUNT(*)
>>> FROM _events;
+--------+
| ?COUNT |
+--------+
| 1016 |
+--------+
┌────────┐
?COUNT
├────────┤
│ 2488 │
└────────┘
Elapsed time: 26 ms
^D
```
Expand All @@ -48,12 +47,12 @@ And reading the SQL from stdin

```shell
$ rockset query < query.sql
+--------+
| ?COUNT |
+--------+
| 1016 |
+--------+
Elapsed time: 26 ms
┌────────┐
?COUNT
├────────┤
│ 2488 │
└────────┘
Elapsed time: 24 ms
```

### Cloning a collection
Expand Down
Binary file modified vhs/clone.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified vhs/query.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions vhs/query.tape
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Type "rockset query 'SELECT COUNT(*) FROM demo.movies'"
Sleep 500ms
Enter

Sleep 2s
Sleep 3s

Type "rockset query"
Sleep 500ms
Expand All @@ -30,7 +30,7 @@ Sleep 500ms
Enter
Ctrl+D

Sleep 2s
Sleep 3s

Type "echo 'SELECT COUNT(*) FROM demo.movies;' | rockset query"
Sleep 500ms
Expand Down
Binary file modified vhs/quickstart.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 7b04006

Please sign in to comment.