[ci skip] Deployed c982921 with MkDocs version: 1.5.3

mozilla · Nov 20, 2023 · ea24211 · ea24211
1 parent ef57cc3
commit ea24211
Show file tree

Hide file tree

Showing 13 changed files with 1,059 additions and 979 deletions.
diff --git a/mozfun/bits28/index.html b/mozfun/bits28/index.html
@@ -2860,11 +2860,11 @@
 </li>
 
         <li class="md-nav__item">
-  <a href="#retention-udf" class="md-nav__link">
-    retention (UDF)
+  <a href="#days_since_seen-udf" class="md-nav__link">
+    days_since_seen (UDF)
   </a>
 
-    <nav class="md-nav" aria-label="retention (UDF)">
+    <nav class="md-nav" aria-label="days_since_seen (UDF)">
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
@@ -2900,11 +2900,11 @@
 </li>
 
         <li class="md-nav__item">
-  <a href="#days_since_seen-udf" class="md-nav__link">
-    days_since_seen (UDF)
+  <a href="#retention-udf" class="md-nav__link">
+    retention (UDF)
   </a>
 
-    <nav class="md-nav" aria-label="days_since_seen (UDF)">
+    <nav class="md-nav" aria-label="retention (UDF)">
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
@@ -2920,11 +2920,11 @@
 </li>
 
         <li class="md-nav__item">
-  <a href="#to_dates-udf" class="md-nav__link">
-    to_dates (UDF)
+  <a href="#active_in_range-udf" class="md-nav__link">
+    active_in_range (UDF)
   </a>
 
-    <nav class="md-nav" aria-label="to_dates (UDF)">
+    <nav class="md-nav" aria-label="active_in_range (UDF)">
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
@@ -2940,11 +2940,11 @@
 </li>
 
         <li class="md-nav__item">
-  <a href="#active_in_range-udf" class="md-nav__link">
-    active_in_range (UDF)
+  <a href="#to_dates-udf" class="md-nav__link">
+    to_dates (UDF)
   </a>
 
-    <nav class="md-nav" aria-label="active_in_range (UDF)">
+    <nav class="md-nav" aria-label="to_dates (UDF)">
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
@@ -3602,11 +3602,11 @@
 </li>
 
         <li class="md-nav__item">
-  <a href="#retention-udf" class="md-nav__link">
-    retention (UDF)
+  <a href="#days_since_seen-udf" class="md-nav__link">
+    days_since_seen (UDF)
   </a>
 
-    <nav class="md-nav" aria-label="retention (UDF)">
+    <nav class="md-nav" aria-label="days_since_seen (UDF)">
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
@@ -3642,11 +3642,11 @@
 </li>
 
         <li class="md-nav__item">
-  <a href="#days_since_seen-udf" class="md-nav__link">
-    days_since_seen (UDF)
+  <a href="#retention-udf" class="md-nav__link">
+    retention (UDF)
   </a>
 
-    <nav class="md-nav" aria-label="days_since_seen (UDF)">
+    <nav class="md-nav" aria-label="retention (UDF)">
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
@@ -3662,11 +3662,11 @@
 </li>
 
         <li class="md-nav__item">
-  <a href="#to_dates-udf" class="md-nav__link">
-    to_dates (UDF)
+  <a href="#active_in_range-udf" class="md-nav__link">
+    active_in_range (UDF)
   </a>
 
-    <nav class="md-nav" aria-label="to_dates (UDF)">
+    <nav class="md-nav" aria-label="active_in_range (UDF)">
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
@@ -3682,11 +3682,11 @@
 </li>
 
         <li class="md-nav__item">
-  <a href="#active_in_range-udf" class="md-nav__link">
-    active_in_range (UDF)
+  <a href="#to_dates-udf" class="md-nav__link">
+    to_dates (UDF)
   </a>
 
-    <nav class="md-nav" aria-label="active_in_range (UDF)">
+    <nav class="md-nav" aria-label="to_dates (UDF)">
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
@@ -3763,14 +3763,25 @@ <h3 id="parameters">Parameters</h3>
 <div class="highlight"><pre><span></span><code>INT64
 </code></pre></div>
 <p><a href="https://github.com/mozilla/bigquery-etl/blob/generated-sql/sql//mozfun/bits28/from_string">Source</a>  |  <a href="https://github.com/mozilla/bigquery-etl/edit/generated-sql/sql//mozfun/bits28/from_string/metadata.yaml">Edit</a></p>
-<h2 id="retention-udf">retention (UDF)</h2>
-<p>Return a nested struct providing booleans indicating whether a given client
-was active various time periods based on the passed bit pattern.</p>
+<h2 id="days_since_seen-udf">days_since_seen (UDF)</h2>
+<p>Return the position of the rightmost set bit in an INT64 bit pattern.</p>
+<p>To determine this position, we take a bitwise AND of the bit pattern and
+its complement, then we determine the position of the bit via base-2
+logarithm; see <a href="https://stackoverflow.com/a/42747608/1260237">https://stackoverflow.com/a/42747608/1260237</a></p>
+<p>See detailed docs for the bits28 suite of functions:
+<a href="https://docs.telemetry.mozilla.org/cookbooks/clients_last_seen_bits.html#udf-reference">https://docs.telemetry.mozilla.org/cookbooks/clients_last_seen_bits.html#udf-reference</a></p>
+<div class="highlight"><pre><span></span><code><span class="k">SELECT</span>
+<span class="w">  </span><span class="n">mozfun</span><span class="p">.</span><span class="n">bits28</span><span class="p">.</span><span class="n">days_since_seen</span><span class="p">(</span><span class="mi">18</span><span class="p">)</span>
+<span class="c1">-- &gt;&gt; 1</span>
+</code></pre></div>
 <h3 id="parameters_1">Parameters</h3>
 <p><strong>INPUTS</strong></p>
-<div class="highlight"><pre><span></span><code>bits INT64, submission_date DATE
+<div class="highlight"><pre><span></span><code>bits INT64
 </code></pre></div>
-<p><a href="https://github.com/mozilla/bigquery-etl/blob/generated-sql/sql//mozfun/bits28/retention">Source</a>  |  <a href="https://github.com/mozilla/bigquery-etl/edit/generated-sql/sql//mozfun/bits28/retention/metadata.yaml">Edit</a></p>
+<p><strong>OUTPUTS</strong></p>
+<div class="highlight"><pre><span></span><code>INT64
+</code></pre></div>
+<p><a href="https://github.com/mozilla/bigquery-etl/blob/generated-sql/sql//mozfun/bits28/days_since_seen">Source</a>  |  <a href="https://github.com/mozilla/bigquery-etl/edit/generated-sql/sql//mozfun/bits28/days_since_seen/metadata.yaml">Edit</a></p>
 <h2 id="to_string-udf">to_string (UDF)</h2>
 <p>Convert an INT64 field into a 28-character string representing
 the individual bits.</p>
@@ -3791,37 +3802,14 @@ <h3 id="parameters_2">Parameters</h3>
 <div class="highlight"><pre><span></span><code>STRING
 </code></pre></div>
 <p><a href="https://github.com/mozilla/bigquery-etl/blob/generated-sql/sql//mozfun/bits28/to_string">Source</a>  |  <a href="https://github.com/mozilla/bigquery-etl/edit/generated-sql/sql//mozfun/bits28/to_string/metadata.yaml">Edit</a></p>
-<h2 id="days_since_seen-udf">days_since_seen (UDF)</h2>
-<p>Return the position of the rightmost set bit in an INT64 bit pattern.</p>
-<p>To determine this position, we take a bitwise AND of the bit pattern and
-its complement, then we determine the position of the bit via base-2
-logarithm; see <a href="https://stackoverflow.com/a/42747608/1260237">https://stackoverflow.com/a/42747608/1260237</a></p>
-<p>See detailed docs for the bits28 suite of functions:
-<a href="https://docs.telemetry.mozilla.org/cookbooks/clients_last_seen_bits.html#udf-reference">https://docs.telemetry.mozilla.org/cookbooks/clients_last_seen_bits.html#udf-reference</a></p>
-<div class="highlight"><pre><span></span><code><span class="k">SELECT</span>
-<span class="w">  </span><span class="n">mozfun</span><span class="p">.</span><span class="n">bits28</span><span class="p">.</span><span class="n">days_since_seen</span><span class="p">(</span><span class="mi">18</span><span class="p">)</span>
-<span class="c1">-- &gt;&gt; 1</span>
-</code></pre></div>
+<h2 id="retention-udf">retention (UDF)</h2>
+<p>Return a nested struct providing booleans indicating whether a given client
+was active various time periods based on the passed bit pattern.</p>
 <h3 id="parameters_3">Parameters</h3>
 <p><strong>INPUTS</strong></p>
-<div class="highlight"><pre><span></span><code>bits INT64
-</code></pre></div>
-<p><strong>OUTPUTS</strong></p>
-<div class="highlight"><pre><span></span><code>INT64
-</code></pre></div>
-<p><a href="https://github.com/mozilla/bigquery-etl/blob/generated-sql/sql//mozfun/bits28/days_since_seen">Source</a>  |  <a href="https://github.com/mozilla/bigquery-etl/edit/generated-sql/sql//mozfun/bits28/days_since_seen/metadata.yaml">Edit</a></p>
-<h2 id="to_dates-udf">to_dates (UDF)</h2>
-<p>Convert a bit pattern into an array of the dates is represents.</p>
-<p>See detailed docs for the bits28 suite of functions:
-<a href="https://docs.telemetry.mozilla.org/cookbooks/clients_last_seen_bits.html#udf-reference">https://docs.telemetry.mozilla.org/cookbooks/clients_last_seen_bits.html#udf-reference</a></p>
-<h3 id="parameters_4">Parameters</h3>
-<p><strong>INPUTS</strong></p>
 <div class="highlight"><pre><span></span><code>bits INT64, submission_date DATE
 </code></pre></div>
-<p><strong>OUTPUTS</strong></p>
-<div class="highlight"><pre><span></span><code>ARRAY&lt;DATE&gt;
-</code></pre></div>
-<p><a href="https://github.com/mozilla/bigquery-etl/blob/generated-sql/sql//mozfun/bits28/to_dates">Source</a>  |  <a href="https://github.com/mozilla/bigquery-etl/edit/generated-sql/sql//mozfun/bits28/to_dates/metadata.yaml">Edit</a></p>
+<p><a href="https://github.com/mozilla/bigquery-etl/blob/generated-sql/sql//mozfun/bits28/retention">Source</a>  |  <a href="https://github.com/mozilla/bigquery-etl/edit/generated-sql/sql//mozfun/bits28/retention/metadata.yaml">Edit</a></p>
 <h2 id="active_in_range-udf">active_in_range (UDF)</h2>
 <p>Return a boolean indicating if any bits are set in the specified range
 of a bit pattern. The <code>start_offset</code> must be zero or a negative number
@@ -3830,14 +3818,26 @@ <h2 id="active_in_range-udf">active_in_range (UDF)</h2>
 <code>start_offset</code>.</p>
 <p>See detailed docs for the bits28 suite of functions:
 <a href="https://docs.telemetry.mozilla.org/cookbooks/clients_last_seen_bits.html#udf-reference">https://docs.telemetry.mozilla.org/cookbooks/clients_last_seen_bits.html#udf-reference</a></p>
-<h3 id="parameters_5">Parameters</h3>
+<h3 id="parameters_4">Parameters</h3>
 <p><strong>INPUTS</strong></p>
 <div class="highlight"><pre><span></span><code>bits INT64, start_offset INT64, n_bits INT64
 </code></pre></div>
 <p><strong>OUTPUTS</strong></p>
 <div class="highlight"><pre><span></span><code>BOOLEAN
 </code></pre></div>
 <p><a href="https://github.com/mozilla/bigquery-etl/blob/generated-sql/sql//mozfun/bits28/active_in_range">Source</a>  |  <a href="https://github.com/mozilla/bigquery-etl/edit/generated-sql/sql//mozfun/bits28/active_in_range/metadata.yaml">Edit</a></p>
+<h2 id="to_dates-udf">to_dates (UDF)</h2>
+<p>Convert a bit pattern into an array of the dates is represents.</p>
+<p>See detailed docs for the bits28 suite of functions:
+<a href="https://docs.telemetry.mozilla.org/cookbooks/clients_last_seen_bits.html#udf-reference">https://docs.telemetry.mozilla.org/cookbooks/clients_last_seen_bits.html#udf-reference</a></p>
+<h3 id="parameters_5">Parameters</h3>
+<p><strong>INPUTS</strong></p>
+<div class="highlight"><pre><span></span><code>bits INT64, submission_date DATE
+</code></pre></div>
+<p><strong>OUTPUTS</strong></p>
+<div class="highlight"><pre><span></span><code>ARRAY&lt;DATE&gt;
+</code></pre></div>
+<p><a href="https://github.com/mozilla/bigquery-etl/blob/generated-sql/sql//mozfun/bits28/to_dates">Source</a>  |  <a href="https://github.com/mozilla/bigquery-etl/edit/generated-sql/sql//mozfun/bits28/to_dates/metadata.yaml">Edit</a></p>
 <h2 id="range-udf">range (UDF)</h2>
 <p>Return an INT64 representing a range of bits from a source bit pattern.</p>
 <p>The start_offset must be zero or a negative number indicating an offset from

diff --git a/mozfun/bytes/index.html b/mozfun/bytes/index.html
@@ -2860,11 +2860,11 @@
     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
 
         <li class="md-nav__item">
-  <a href="#zero_right-udf" class="md-nav__link">
-    zero_right (UDF)
+  <a href="#bit_pos_to_byte_pos-udf" class="md-nav__link">
+    bit_pos_to_byte_pos (UDF)
   </a>
 
-    <nav class="md-nav" aria-label="zero_right (UDF)">
+    <nav class="md-nav" aria-label="bit_pos_to_byte_pos (UDF)">
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
@@ -2900,11 +2900,11 @@
 </li>
 
         <li class="md-nav__item">
-  <a href="#bit_pos_to_byte_pos-udf" class="md-nav__link">
-    bit_pos_to_byte_pos (UDF)
+  <a href="#zero_right-udf" class="md-nav__link">
+    zero_right (UDF)
   </a>
 
-    <nav class="md-nav" aria-label="bit_pos_to_byte_pos (UDF)">
+    <nav class="md-nav" aria-label="zero_right (UDF)">
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
@@ -3502,11 +3502,11 @@
     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
 
         <li class="md-nav__item">
-  <a href="#zero_right-udf" class="md-nav__link">
-    zero_right (UDF)
+  <a href="#bit_pos_to_byte_pos-udf" class="md-nav__link">
+    bit_pos_to_byte_pos (UDF)
   </a>
 
-    <nav class="md-nav" aria-label="zero_right (UDF)">
+    <nav class="md-nav" aria-label="bit_pos_to_byte_pos (UDF)">
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
@@ -3542,11 +3542,11 @@
 </li>
 
         <li class="md-nav__item">
-  <a href="#bit_pos_to_byte_pos-udf" class="md-nav__link">
-    bit_pos_to_byte_pos (UDF)
+  <a href="#zero_right-udf" class="md-nav__link">
+    zero_right (UDF)
   </a>
 
-    <nav class="md-nav" aria-label="bit_pos_to_byte_pos (UDF)">
+    <nav class="md-nav" aria-label="zero_right (UDF)">
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
@@ -3577,16 +3577,17 @@
 
 
 <h1 id="bytes">bytes</h1>
-<h2 id="zero_right-udf">zero_right (UDF)</h2>
-<p>Zero bits on the right of byte</p>
+<h2 id="bit_pos_to_byte_pos-udf">bit_pos_to_byte_pos (UDF)</h2>
+<p>Given a bit position, get the byte that bit appears in.
+1-indexed (to match substr), and accepts negative values.</p>
 <h3 id="parameters">Parameters</h3>
 <p><strong>INPUTS</strong></p>
-<div class="highlight"><pre><span></span><code>b BYTES, length INT64
+<div class="highlight"><pre><span></span><code>bit_pos INT64
 </code></pre></div>
 <p><strong>OUTPUTS</strong></p>
-<div class="highlight"><pre><span></span><code>BYTES
+<div class="highlight"><pre><span></span><code>INT64
 </code></pre></div>
-<p><a href="https://github.com/mozilla/bigquery-etl/blob/generated-sql/sql//mozfun/bytes/zero_right">Source</a>  |  <a href="https://github.com/mozilla/bigquery-etl/edit/generated-sql/sql//mozfun/bytes/zero_right/metadata.yaml">Edit</a></p>
+<p><a href="https://github.com/mozilla/bigquery-etl/blob/generated-sql/sql//mozfun/bytes/bit_pos_to_byte_pos">Source</a>  |  <a href="https://github.com/mozilla/bigquery-etl/edit/generated-sql/sql//mozfun/bytes/bit_pos_to_byte_pos/metadata.yaml">Edit</a></p>
 <h2 id="extract_bits-udf">extract_bits (UDF)</h2>
 <p>Extract bits from a byte array. Roughly matches substr
 with three arguments:
@@ -3609,17 +3610,16 @@ <h3 id="parameters_1">Parameters</h3>
 <div class="highlight"><pre><span></span><code>BYTES
 </code></pre></div>
 <p><a href="https://github.com/mozilla/bigquery-etl/blob/generated-sql/sql//mozfun/bytes/extract_bits">Source</a>  |  <a href="https://github.com/mozilla/bigquery-etl/edit/generated-sql/sql//mozfun/bytes/extract_bits/metadata.yaml">Edit</a></p>
-<h2 id="bit_pos_to_byte_pos-udf">bit_pos_to_byte_pos (UDF)</h2>
-<p>Given a bit position, get the byte that bit appears in.
-1-indexed (to match substr), and accepts negative values.</p>
+<h2 id="zero_right-udf">zero_right (UDF)</h2>
+<p>Zero bits on the right of byte</p>
 <h3 id="parameters_2">Parameters</h3>
 <p><strong>INPUTS</strong></p>
-<div class="highlight"><pre><span></span><code>bit_pos INT64
+<div class="highlight"><pre><span></span><code>b BYTES, length INT64
 </code></pre></div>
 <p><strong>OUTPUTS</strong></p>
-<div class="highlight"><pre><span></span><code>INT64
+<div class="highlight"><pre><span></span><code>BYTES
 </code></pre></div>
-<p><a href="https://github.com/mozilla/bigquery-etl/blob/generated-sql/sql//mozfun/bytes/bit_pos_to_byte_pos">Source</a>  |  <a href="https://github.com/mozilla/bigquery-etl/edit/generated-sql/sql//mozfun/bytes/bit_pos_to_byte_pos/metadata.yaml">Edit</a></p>
+<p><a href="https://github.com/mozilla/bigquery-etl/blob/generated-sql/sql//mozfun/bytes/zero_right">Source</a>  |  <a href="https://github.com/mozilla/bigquery-etl/edit/generated-sql/sql//mozfun/bytes/zero_right/metadata.yaml">Edit</a></p>