Skip to content

Commit

Permalink
restructure quickstart to include wasm console option
Browse files Browse the repository at this point in the history
  • Loading branch information
deobald committed Feb 24, 2024
1 parent dd036c3 commit c16f064
Show file tree
Hide file tree
Showing 7 changed files with 45 additions and 48 deletions.
30 changes: 15 additions & 15 deletions docs/print.html
Original file line number Diff line number Diff line change
Expand Up @@ -188,13 +188,17 @@ <h2 id="elsewhere"><a class="header" href="#elsewhere">Elsewhere</a></h2>
</ul>
<div style="break-before: page; page-break-before: always;"></div><h1 id="tutorial"><a class="header" href="#tutorial">Tutorial</a></h1>
<p>This quick tutorial intends to walk you through the core aspects of Endb.
By the end, you will have <code>endb</code> installed and you will have used it to
learn some of what it can do.</p>
By the end, you will have <code>endb</code> installed (if you want) and you will have
used it to learn some of what it can do.</p>
<ul>
<li><a href="tutorial/quickstart.html">Quickstart</a></li>
<li><a href="tutorial/try_it.html">Try It!</a></li>
<li><a href="tutorial/sql_basics.html">Endb SQL Basics</a></li>
</ul>
<h2 id="warning-early-alpha"><a class="header" href="#warning-early-alpha">Warning: Early Alpha</a></h2>
<p>Endb is still in early alpha.</p>
<p>While in alpha, new versions are not guaranteed to have binary-compatible storage with previous versions.
We encourage you to experiment with Endb but please do not use it in production until a General Availability release.</p>
<div style="break-before: page; page-break-before: always;"></div><h1 id="quickstart"><a class="header" href="#quickstart">Quickstart</a></h1>
<h2 id="install-endb"><a class="header" href="#install-endb">Install Endb</a></h2>
<pre><code class="language-sh">mkdir -p endb_data
Expand All @@ -203,19 +207,15 @@ <h2 id="install-endb"><a class="header" href="#install-endb">Install Endb</a></h
</code></pre>
<p>See <a href="tutorial/../reference/installation.html">Installation</a> for more ways to install
and build <code>endb</code>.</p>
<h2 id="run-your-first-query"><a class="header" href="#run-your-first-query">Run your first query</a></h2>
<p>You can use the <a href="tutorial/../clients/console.html">Console</a>:</p>
<pre><code class="language-sh">$ pip install endb
$ endb_console
-&gt; SELECT 'Hello World';
</code></pre>
<p>...or you can send queries to the API directly:</p>
<pre><code class="language-sh">curl -d &quot;SELECT 'Hello World';&quot; -H &quot;Content-Type: application/sql&quot; -X POST http://localhost:3803/sql
</code></pre>
<h2 id="warning-early-alpha"><a class="header" href="#warning-early-alpha">Warning: Early Alpha</a></h2>
<p>Endb is still in early alpha.</p>
<p>While in alpha, new versions are not guaranteed to have binary-compatible storage with previous versions.
We encourage you to experiment with Endb but please do not use it in production until a General Availability release.</p>
<h2 id="try-online"><a class="header" href="#try-online">Try Online</a></h2>
<p>If you do not want to install a full Endb instance, you can try the
<a href="https://endatabas.com/console.html">Wasm Console</a> instead.</p>
<p>The Wasm Console runs Endb directly in your web browser,
so you can ignore the following steps and jump straight to
<a href="tutorial/sql_basics.html">Endb SQL Basics</a>.</p>
<p>NOTE: The Wasm Console is not a full Endb instance.
It does not provide APIs and has other performance
and infrastructure limitations.</p>
<div style="break-before: page; page-break-before: always;"></div><h1 id="try-it"><a class="header" href="#try-it">Try It!</a></h1>
<p>You can send SQL statements to <code>endb</code> over HTTP or WebSockets.
Any HTTP or WebSocket client will do, and Endb ships with a console
Expand Down
2 changes: 1 addition & 1 deletion docs/searchindex.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/searchindex.json

Large diffs are not rendered by default.

8 changes: 6 additions & 2 deletions docs/tutorial/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -174,13 +174,17 @@ <h1 class="menu-title">The Endatabas Book</h1>
<main>
<h1 id="tutorial"><a class="header" href="#tutorial">Tutorial</a></h1>
<p>This quick tutorial intends to walk you through the core aspects of Endb.
By the end, you will have <code>endb</code> installed and you will have used it to
learn some of what it can do.</p>
By the end, you will have <code>endb</code> installed (if you want) and you will have
used it to learn some of what it can do.</p>
<ul>
<li><a href="quickstart.html">Quickstart</a></li>
<li><a href="try_it.html">Try It!</a></li>
<li><a href="sql_basics.html">Endb SQL Basics</a></li>
</ul>
<h2 id="warning-early-alpha"><a class="header" href="#warning-early-alpha">Warning: Early Alpha</a></h2>
<p>Endb is still in early alpha.</p>
<p>While in alpha, new versions are not guaranteed to have binary-compatible storage with previous versions.
We encourage you to experiment with Endb but please do not use it in production until a General Availability release.</p>

</main>

Expand Down
22 changes: 9 additions & 13 deletions docs/tutorial/quickstart.html
Original file line number Diff line number Diff line change
Expand Up @@ -180,19 +180,15 @@ <h2 id="install-endb"><a class="header" href="#install-endb">Install Endb</a></h
</code></pre>
<p>See <a href="../reference/installation.html">Installation</a> for more ways to install
and build <code>endb</code>.</p>
<h2 id="run-your-first-query"><a class="header" href="#run-your-first-query">Run your first query</a></h2>
<p>You can use the <a href="../clients/console.html">Console</a>:</p>
<pre><code class="language-sh">$ pip install endb
$ endb_console
-&gt; SELECT 'Hello World';
</code></pre>
<p>...or you can send queries to the API directly:</p>
<pre><code class="language-sh">curl -d &quot;SELECT 'Hello World';&quot; -H &quot;Content-Type: application/sql&quot; -X POST http://localhost:3803/sql
</code></pre>
<h2 id="warning-early-alpha"><a class="header" href="#warning-early-alpha">Warning: Early Alpha</a></h2>
<p>Endb is still in early alpha.</p>
<p>While in alpha, new versions are not guaranteed to have binary-compatible storage with previous versions.
We encourage you to experiment with Endb but please do not use it in production until a General Availability release.</p>
<h2 id="try-online"><a class="header" href="#try-online">Try Online</a></h2>
<p>If you do not want to install a full Endb instance, you can try the
<a href="https://endatabas.com/console.html">Wasm Console</a> instead.</p>
<p>The Wasm Console runs Endb directly in your web browser,
so you can ignore the following steps and jump straight to
<a href="sql_basics.html">Endb SQL Basics</a>.</p>
<p>NOTE: The Wasm Console is not a full Endb instance.
It does not provide APIs and has other performance
and infrastructure limitations.</p>

</main>

Expand Down
6 changes: 4 additions & 2 deletions src/tutorial/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
# Tutorial

This quick tutorial intends to walk you through the core aspects of Endb.
By the end, you will have `endb` installed and you will have used it to
learn some of what it can do.
By the end, you will have `endb` installed (if you want) and you will have
used it to learn some of what it can do.

- [Quickstart](quickstart.md)
- [Try It!](try_it.md)
- [Endb SQL Basics](sql_basics.md)

{{#include ../alpha-warning.md}}
23 changes: 9 additions & 14 deletions src/tutorial/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,20 +11,15 @@ docker run --rm -p 3803:3803 -v endb_data:/app/endb_data docker.io/endatabas/end
See [Installation](../reference/installation.md) for more ways to install
and build `endb`.

## Run your first query
## Try Online

You can use the [Console](../clients/console.md):
If you do not want to install a full Endb instance, you can try the
[Wasm Console](https://endatabas.com/console.html) instead.

```sh
$ pip install endb
$ endb_console
-> SELECT 'Hello World';
```

...or you can send queries to the API directly:

```sh
curl -d "SELECT 'Hello World';" -H "Content-Type: application/sql" -X POST http://localhost:3803/sql
```
The Wasm Console runs Endb directly in your web browser,
so you can ignore the following steps and jump straight to
[Endb SQL Basics](sql_basics.md).

{{#include ../alpha-warning.md}}
NOTE: The Wasm Console is not a full Endb instance.
It does not provide APIs and has other performance
and infrastructure limitations.

0 comments on commit c16f064

Please sign in to comment.