Skip to content
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
6 changes: 2 additions & 4 deletions docs/advanced/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1">

<!-- Webfont -->
<link href='http://fonts.googleapis.com/css?family=Roboto:400,100,100italic,300,300italic,400italic,500,500italic,700,700italic,900,900italic' rel='stylesheet' type='text/css'>
<link href='https://fonts.googleapis.com/css?family=Roboto:400,100,100italic,300,300italic,400italic,500,500italic,700,700italic,900,900italic' rel='stylesheet' type='text/css'>

<!--<link rel="shortcut icon" type="image/png" href="/favicon.png">-->

Expand All @@ -23,9 +23,7 @@
<!-- Styles -->
<link rel="stylesheet" type="text/css" href="/css/site.css" />
<!-- Font Awesome icons -->
<link href="/libs/font-awesome-4.4.0/css/font-awesome.min.css"
rel="stylesheet"
type="text/css">
<script src="https://use.fontawesome.com/44456bc286.js"></script>

<!-- jQuery (necessary for Bootstrap's JavaScript plugins) -->
<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script>
Expand Down
16 changes: 7 additions & 9 deletions docs/advanced/messaging/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1">

<!-- Webfont -->
<link href='http://fonts.googleapis.com/css?family=Roboto:400,100,100italic,300,300italic,400italic,500,500italic,700,700italic,900,900italic' rel='stylesheet' type='text/css'>
<link href='https://fonts.googleapis.com/css?family=Roboto:400,100,100italic,300,300italic,400italic,500,500italic,700,700italic,900,900italic' rel='stylesheet' type='text/css'>

<!--<link rel="shortcut icon" type="image/png" href="/favicon.png">-->

Expand All @@ -23,9 +23,7 @@
<!-- Styles -->
<link rel="stylesheet" type="text/css" href="/css/site.css" />
<!-- Font Awesome icons -->
<link href="/libs/font-awesome-4.4.0/css/font-awesome.min.css"
rel="stylesheet"
type="text/css">
<script src="https://use.fontawesome.com/44456bc286.js"></script>

<!-- jQuery (necessary for Bootstrap's JavaScript plugins) -->
<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script>
Expand Down Expand Up @@ -385,7 +383,7 @@ <h2 id="creating-a-message-table">Creating a message table</h2>
<p>The current implementation requires a fixed schema. This will be made more
flexible in the future. There will also be a custom DDL syntax. For now, a
message table must be created like this:</p>
<div class="highlight"><pre><code class="language-text" data-lang="text">create table my_message(
<div class="highlight"><pre><code class="language-text" data-lang="text"><span></span>create table my_message(
time_scheduled bigint,
id bigint,
time_next bigint,
Expand Down Expand Up @@ -431,15 +429,15 @@ <h2 id="creating-a-message-table">Creating a message table</h2>
<h2 id="enqueuing-messages">Enqueuing messages</h2>

<p>The application can enqueue messages using an insert statement:</p>
<div class="highlight"><pre><code class="language-text" data-lang="text">insert into my_message(id, message) values(1, &#39;hello world&#39;)
<div class="highlight"><pre><code class="language-text" data-lang="text"><span></span>insert into my_message(id, message) values(1, &#39;hello world&#39;)
</code></pre></div>
<p>These inserts can be part of a regular transaction. Multiple messages can be
inserted to different tables. Avoid accumulating too many big messages within a
transaction as it consumes memory on the VTTablet side. At the time of commit,
memory permitting, all messages are instantly enqueued to be sent.</p>

<p>Messages can also be created to be sent in the future:</p>
<div class="highlight"><pre><code class="language-text" data-lang="text">insert into my_message(id, message, time_scheduled) values(1, &#39;hello world&#39;, :future_time)
<div class="highlight"><pre><code class="language-text" data-lang="text"><span></span>insert into my_message(id, message, time_scheduled) values(1, &#39;hello world&#39;, :future_time)
</code></pre></div>
<p><code class="prettyprint">future_time</code> must be the unix time expressed in nanoseconds.</p>

Expand Down Expand Up @@ -502,11 +500,11 @@ <h2 id="advanced-usage">Advanced usage</h2>
<p>The <code class="prettyprint">MessageAck</code> functionality is currently an API call and cannot be used
inside a transaction. However, you can ack messages using a regular DML. It
should look like this:</p>
<div class="highlight"><pre><code class="language-text" data-lang="text">update my_message set time_acked = :time_acked, time_next = null where id in ::ids and time_acked is null
<div class="highlight"><pre><code class="language-text" data-lang="text"><span></span>update my_message set time_acked = :time_acked, time_next = null where id in ::ids and time_acked is null
</code></pre></div>
<p>You can manually change the schedule of existing messages with a statement like
this:</p>
<div class="highlight"><pre><code class="language-text" data-lang="text">update my_message set time_next = :time_next, epoch = :epoch where id in ::ids and time_acked is null
<div class="highlight"><pre><code class="language-text" data-lang="text"><span></span>update my_message set time_next = :time_next, epoch = :epoch where id in ::ids and time_acked is null
</code></pre></div>
<p>This comes in handy if a bunch of messages had chronic failures and got
postponed to the distant future. If the root cause of the problem was fixed,
Expand Down
8 changes: 3 additions & 5 deletions docs/contributing/code-reviews/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1">

<!-- Webfont -->
<link href='http://fonts.googleapis.com/css?family=Roboto:400,100,100italic,300,300italic,400italic,500,500italic,700,700italic,900,900italic' rel='stylesheet' type='text/css'>
<link href='https://fonts.googleapis.com/css?family=Roboto:400,100,100italic,300,300italic,400italic,500,500italic,700,700italic,900,900italic' rel='stylesheet' type='text/css'>

<!--<link rel="shortcut icon" type="image/png" href="/favicon.png">-->

Expand All @@ -23,9 +23,7 @@
<!-- Styles -->
<link rel="stylesheet" type="text/css" href="/css/site.css" />
<!-- Font Awesome icons -->
<link href="/libs/font-awesome-4.4.0/css/font-awesome.min.css"
rel="stylesheet"
type="text/css">
<script src="https://use.fontawesome.com/44456bc286.js"></script>

<!-- jQuery (necessary for Bootstrap's JavaScript plugins) -->
<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script>
Expand Down Expand Up @@ -377,7 +375,7 @@ <h2 id="what-to-look-for-in-a-review">What to look for in a Review</h2>
<li><p>Commit message format:</p>

<ul>
<li><div class="highlight"><pre><code class="language-text" data-lang="text">&lt;component&gt;: This is a short description of the change.
<li><div class="highlight"><pre><code class="language-text" data-lang="text"><span></span>&lt;component&gt;: This is a short description of the change.

If necessary, more sentences follow e.g. to explain the intent of the change, how it fits into the bigger picture or which implications it has (e.g. other parts in the system have to be adapted.)

Expand Down
26 changes: 12 additions & 14 deletions docs/contributing/github-workflow/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1">

<!-- Webfont -->
<link href='http://fonts.googleapis.com/css?family=Roboto:400,100,100italic,300,300italic,400italic,500,500italic,700,700italic,900,900italic' rel='stylesheet' type='text/css'>
<link href='https://fonts.googleapis.com/css?family=Roboto:400,100,100italic,300,300italic,400italic,500,500italic,700,700italic,900,900italic' rel='stylesheet' type='text/css'>

<!--<link rel="shortcut icon" type="image/png" href="/favicon.png">-->

Expand All @@ -23,9 +23,7 @@
<!-- Styles -->
<link rel="stylesheet" type="text/css" href="/css/site.css" />
<!-- Font Awesome icons -->
<link href="/libs/font-awesome-4.4.0/css/font-awesome.min.css"
rel="stylesheet"
type="text/css">
<script src="https://use.fontawesome.com/44456bc286.js"></script>

<!-- jQuery (necessary for Bootstrap's JavaScript plugins) -->
<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script>
Expand Down Expand Up @@ -351,20 +349,20 @@ <h2 id="remotes">Remotes</h2>

<p>Since you should have cloned the repository from your fork, the <code class="prettyprint">origin</code> remote
should look like this:</p>
<div class="highlight"><pre><code class="language-text" data-lang="text">$ git remote -v
<div class="highlight"><pre><code class="language-text" data-lang="text"><span></span>$ git remote -v
origin git@github.com:&lt;yourname&gt;/vitess.git (fetch)
origin git@github.com:&lt;yourname&gt;/vitess.git (push)
</code></pre></div>
<p>To help you keep your fork in sync with the main repo, add an <code class="prettyprint">upstream</code> remote:</p>
<div class="highlight"><pre><code class="language-text" data-lang="text">$ git remote add upstream git@github.com:youtube/vitess.git
<div class="highlight"><pre><code class="language-text" data-lang="text"><span></span>$ git remote add upstream git@github.com:youtube/vitess.git
$ git remote -v
origin git@github.com:&lt;yourname&gt;/vitess.git (fetch)
origin git@github.com:&lt;yourname&gt;/vitess.git (push)
upstream git@github.com:youtube/vitess.git (fetch)
upstream git@github.com:youtube/vitess.git (push)
</code></pre></div>
<p>Now to sync your local <code class="prettyprint">master</code> branch, do this:</p>
<div class="highlight"><pre><code class="language-text" data-lang="text">$ git checkout master
<div class="highlight"><pre><code class="language-text" data-lang="text"><span></span>$ git checkout master
(master) $ git pull upstream master
</code></pre></div>
<p>Note: In the example output above we prefixed the prompt with <code class="prettyprint">(master)</code> to
Expand All @@ -373,15 +371,15 @@ <h2 id="remotes">Remotes</h2>
<p>You can omit the <code class="prettyprint">upstream master</code> from the <code class="prettyprint">git pull</code> command when you let your
<code class="prettyprint">master</code> branch always track the main <code class="prettyprint">youtube/vitess</code> repository. To achieve
this, run this command once:</p>
<div class="highlight"><pre><code class="language-text" data-lang="text">(master) $ git branch --set-upstream-to=upstream/master
<div class="highlight"><pre><code class="language-text" data-lang="text"><span></span>(master) $ git branch --set-upstream-to=upstream/master
</code></pre></div>
<p>Now the following command syncs your local <code class="prettyprint">master</code> branch as well:</p>
<div class="highlight"><pre><code class="language-text" data-lang="text">(master) $ git pull
<div class="highlight"><pre><code class="language-text" data-lang="text"><span></span>(master) $ git pull
</code></pre></div>
<h2 id="topic-branches">Topic Branches</h2>

<p>Before you start working on changes, create a topic branch:</p>
<div class="highlight"><pre><code class="language-text" data-lang="text">$ git checkout master
<div class="highlight"><pre><code class="language-text" data-lang="text"><span></span>$ git checkout master
(master) $ git pull
(master) $ git checkout -b new-feature
(new-feature) $ # You are now in the new-feature branch.
Expand All @@ -401,19 +399,19 @@ <h2 id="topic-branches">Topic Branches</h2>
<h2 id="sending-pull-requests">Sending Pull Requests</h2>

<p>Push your branch to the repository (and set it to track with <code class="prettyprint">-u</code>):</p>
<div class="highlight"><pre><code class="language-text" data-lang="text">(new-feature) $ git push -u origin new-feature
<div class="highlight"><pre><code class="language-text" data-lang="text"><span></span>(new-feature) $ git push -u origin new-feature
</code></pre></div>
<p>You can omit <code class="prettyprint">origin</code> and <code class="prettyprint">-u new-feature</code> parameters from the <code class="prettyprint">git push</code>
command with the following two Git configuration changes:</p>
<div class="highlight"><pre><code class="language-text" data-lang="text">$ git config remote.pushdefault origin
<div class="highlight"><pre><code class="language-text" data-lang="text"><span></span>$ git config remote.pushdefault origin
$ git config push.default current
</code></pre></div>
<p>The first setting saves you from typing <code class="prettyprint">origin</code> every time. And with the second
setting, Git assumes that the remote branch on the GitHub side will have the
same name as your local branch.</p>

<p>After this change, you can run <code class="prettyprint">git push</code> without arguments:</p>
<div class="highlight"><pre><code class="language-text" data-lang="text">(new-feature) $ git push
<div class="highlight"><pre><code class="language-text" data-lang="text"><span></span>(new-feature) $ git push
</code></pre></div>
<p>Then go to the <a href="https://github.com/youtube/vitess">repository page</a> and it
should prompt you to create a Pull Request from a branch you recently pushed.
Expand All @@ -423,7 +421,7 @@ <h2 id="addressing-changes">Addressing Changes</h2>

<p>If you need to make changes in response to the reviewer&#39;s comments, just make
another commit on your branch and then push it again:</p>
<div class="highlight"><pre><code class="language-text" data-lang="text">$ git checkout new-feature
<div class="highlight"><pre><code class="language-text" data-lang="text"><span></span>$ git checkout new-feature
(new-feature) $ git commit
(new-feature) $ git push
</code></pre></div>
Expand Down
6 changes: 2 additions & 4 deletions docs/contributing/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1">

<!-- Webfont -->
<link href='http://fonts.googleapis.com/css?family=Roboto:400,100,100italic,300,300italic,400italic,500,500italic,700,700italic,900,900italic' rel='stylesheet' type='text/css'>
<link href='https://fonts.googleapis.com/css?family=Roboto:400,100,100italic,300,300italic,400italic,500,500italic,700,700italic,900,900italic' rel='stylesheet' type='text/css'>

<!--<link rel="shortcut icon" type="image/png" href="/favicon.png">-->

Expand All @@ -23,9 +23,7 @@
<!-- Styles -->
<link rel="stylesheet" type="text/css" href="/css/site.css" />
<!-- Font Awesome icons -->
<link href="/libs/font-awesome-4.4.0/css/font-awesome.min.css"
rel="stylesheet"
type="text/css">
<script src="https://use.fontawesome.com/44456bc286.js"></script>

<!-- jQuery (necessary for Bootstrap's JavaScript plugins) -->
<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script>
Expand Down
5 changes: 1 addition & 4 deletions docs/css/main.css

Large diffs are not rendered by default.

Binary file removed docs/fonts/FontAwesome.otf
Binary file not shown.
Binary file removed docs/fonts/fontawesome-webfont.eot
Binary file not shown.
Loading