[ci skip] Deployed dc3864f with MkDocs version: 1.5.3

mozilla · Nov 20, 2023 · 2d16509 · 2d16509
1 parent 6644fae
commit 2d16509
Show file tree

Hide file tree

Showing 10 changed files with 1,239 additions and 959 deletions.
diff --git a/mozfun/bits28/index.html b/mozfun/bits28/index.html
diff --git a/mozfun/event_analysis/index.html b/mozfun/event_analysis/index.html
@@ -2899,26 +2899,6 @@
     </label>
     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
 
-        <li class="md-nav__item">
-  <a href="#aggregate_match_strings-udf" class="md-nav__link">
-    aggregate_match_strings (UDF)
-  </a>
-
-    <nav class="md-nav" aria-label="aggregate_match_strings (UDF)">
-      <ul class="md-nav__list">
-
-          <li class="md-nav__item">
-  <a href="#parameters" class="md-nav__link">
-    Parameters
-  </a>
-
-</li>
-
-      </ul>
-    </nav>
-
-</li>
-
         <li class="md-nav__item">
   <a href="#escape_metachars-udf" class="md-nav__link">
     escape_metachars (UDF)
@@ -2928,7 +2908,7 @@
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
-  <a href="#parameters_1" class="md-nav__link">
+  <a href="#parameters" class="md-nav__link">
     Parameters
   </a>
 
@@ -2948,7 +2928,7 @@
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
-  <a href="#parameters_2" class="md-nav__link">
+  <a href="#parameters_1" class="md-nav__link">
     Parameters
   </a>
 
@@ -2968,7 +2948,7 @@
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
-  <a href="#parameters_3" class="md-nav__link">
+  <a href="#parameters_2" class="md-nav__link">
     Parameters
   </a>
 
@@ -2988,7 +2968,7 @@
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
-  <a href="#parameters_4" class="md-nav__link">
+  <a href="#parameters_3" class="md-nav__link">
     Parameters
   </a>
 
@@ -3008,7 +2988,7 @@
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
-  <a href="#parameters_5" class="md-nav__link">
+  <a href="#parameters_4" class="md-nav__link">
     Parameters
   </a>
 
@@ -3049,7 +3029,7 @@
 </li>
 
           <li class="md-nav__item">
-  <a href="#parameters_6" class="md-nav__link">
+  <a href="#parameters_5" class="md-nav__link">
     Parameters
   </a>
 
@@ -3123,7 +3103,7 @@
 </li>
 
           <li class="md-nav__item">
-  <a href="#parameters_7" class="md-nav__link">
+  <a href="#parameters_6" class="md-nav__link">
     Parameters
   </a>
 
@@ -3157,7 +3137,7 @@
 </li>
 
           <li class="md-nav__item">
-  <a href="#parameters_8" class="md-nav__link">
+  <a href="#parameters_7" class="md-nav__link">
     Parameters
   </a>
 
@@ -3177,7 +3157,7 @@
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
-  <a href="#parameters_9" class="md-nav__link">
+  <a href="#parameters_8" class="md-nav__link">
     Parameters
   </a>
 
@@ -3197,6 +3177,26 @@
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
+  <a href="#parameters_9" class="md-nav__link">
+    Parameters
+  </a>
+
+</li>
+
+      </ul>
+    </nav>
+
+</li>
+
+        <li class="md-nav__item">
+  <a href="#aggregate_match_strings-udf" class="md-nav__link">
+    aggregate_match_strings (UDF)
+  </a>
+
+    <nav class="md-nav" aria-label="aggregate_match_strings (UDF)">
+      <ul class="md-nav__list">
+
+          <li class="md-nav__item">
   <a href="#parameters_10" class="md-nav__link">
     Parameters
   </a>
@@ -3750,26 +3750,6 @@
     </label>
     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
 
-        <li class="md-nav__item">
-  <a href="#aggregate_match_strings-udf" class="md-nav__link">
-    aggregate_match_strings (UDF)
-  </a>
-
-    <nav class="md-nav" aria-label="aggregate_match_strings (UDF)">
-      <ul class="md-nav__list">
-
-          <li class="md-nav__item">
-  <a href="#parameters" class="md-nav__link">
-    Parameters
-  </a>
-
-</li>
-
-      </ul>
-    </nav>
-
-</li>
-
         <li class="md-nav__item">
   <a href="#escape_metachars-udf" class="md-nav__link">
     escape_metachars (UDF)
@@ -3779,7 +3759,7 @@
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
-  <a href="#parameters_1" class="md-nav__link">
+  <a href="#parameters" class="md-nav__link">
     Parameters
   </a>
 
@@ -3799,7 +3779,7 @@
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
-  <a href="#parameters_2" class="md-nav__link">
+  <a href="#parameters_1" class="md-nav__link">
     Parameters
   </a>
 
@@ -3819,7 +3799,7 @@
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
-  <a href="#parameters_3" class="md-nav__link">
+  <a href="#parameters_2" class="md-nav__link">
     Parameters
   </a>
 
@@ -3839,7 +3819,7 @@
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
-  <a href="#parameters_4" class="md-nav__link">
+  <a href="#parameters_3" class="md-nav__link">
     Parameters
   </a>
 
@@ -3859,7 +3839,7 @@
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
-  <a href="#parameters_5" class="md-nav__link">
+  <a href="#parameters_4" class="md-nav__link">
     Parameters
   </a>
 
@@ -3900,7 +3880,7 @@
 </li>
 
           <li class="md-nav__item">
-  <a href="#parameters_6" class="md-nav__link">
+  <a href="#parameters_5" class="md-nav__link">
     Parameters
   </a>
 
@@ -3974,7 +3954,7 @@
 </li>
 
           <li class="md-nav__item">
-  <a href="#parameters_7" class="md-nav__link">
+  <a href="#parameters_6" class="md-nav__link">
     Parameters
   </a>
 
@@ -4008,7 +3988,7 @@
 </li>
 
           <li class="md-nav__item">
-  <a href="#parameters_8" class="md-nav__link">
+  <a href="#parameters_7" class="md-nav__link">
     Parameters
   </a>
 
@@ -4028,7 +4008,7 @@
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
-  <a href="#parameters_9" class="md-nav__link">
+  <a href="#parameters_8" class="md-nav__link">
     Parameters
   </a>
 
@@ -4048,6 +4028,26 @@
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
+  <a href="#parameters_9" class="md-nav__link">
+    Parameters
+  </a>
+
+</li>
+
+      </ul>
+    </nav>
+
+</li>
+
+        <li class="md-nav__item">
+  <a href="#aggregate_match_strings-udf" class="md-nav__link">
+    aggregate_match_strings (UDF)
+  </a>
+
+    <nav class="md-nav" aria-label="aggregate_match_strings (UDF)">
+      <ul class="md-nav__list">
+
+          <li class="md-nav__item">
   <a href="#parameters_10" class="md-nav__link">
     Parameters
   </a>
@@ -4090,19 +4090,9 @@ <h1 id="event_analysis">event_analysis</h1>
 create a regex string that checks for the presence of that event. The view makes this
 transparent, and allows users to simply query a boolean field representing the presence
 of that event on that day.</p>
-<h2 id="aggregate_match_strings-udf">aggregate_match_strings (UDF)</h2>
-<p>Given an array of strings that each match a single event, aggregate those into a single regex string that will match any of the events.</p>
-<h3 id="parameters">Parameters</h3>
-<p><strong>INPUTS</strong></p>
-<div class="highlight"><pre><span></span><code>match_strings ARRAY&lt;STRING&gt;
-</code></pre></div>
-<p><strong>OUTPUTS</strong></p>
-<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/event_analysis/aggregate_match_strings">Source</a>  |  <a href="https://github.com/mozilla/bigquery-etl/edit/generated-sql/sql//mozfun/event_analysis/aggregate_match_strings/metadata.yaml">Edit</a></p>
 <h2 id="escape_metachars-udf">escape_metachars (UDF)</h2>
 <p>Escape all metachars from a regex string. This will make the string an exact match, no matter what it contains.</p>
-<h3 id="parameters_1">Parameters</h3>
+<h3 id="parameters">Parameters</h3>
 <p><strong>INPUTS</strong></p>
 <div class="highlight"><pre><span></span><code>s STRING
 </code></pre></div>
@@ -4112,7 +4102,7 @@ <h3 id="parameters_1">Parameters</h3>
 <p><a href="https://github.com/mozilla/bigquery-etl/blob/generated-sql/sql//mozfun/event_analysis/escape_metachars">Source</a>  |  <a href="https://github.com/mozilla/bigquery-etl/edit/generated-sql/sql//mozfun/event_analysis/escape_metachars/metadata.yaml">Edit</a></p>
 <h2 id="get_funnel_steps_sql-stored-procedure">get_funnel_steps_sql (Stored Procedure)</h2>
 <p>For a given funnel, get a SQL statement that can be used to determine if an events string contains that funnel.</p>
-<h3 id="parameters_2">Parameters</h3>
+<h3 id="parameters_1">Parameters</h3>
 <p><strong>INPUTS</strong></p>
 <div class="highlight"><pre><span></span><code>project STRING, dataset STRING, funnel_name STRING, funnel ARRAY&lt;STRUCT&lt;step_name STRING, list ARRAY&lt;STRUCT&lt;category STRING, event_name STRING&gt;&gt;&gt;&gt;
 </code></pre></div>
@@ -4122,7 +4112,7 @@ <h3 id="parameters_2">Parameters</h3>
 <p><a href="https://github.com/mozilla/bigquery-etl/blob/generated-sql/sql//mozfun/event_analysis/get_funnel_steps_sql">Source</a>  |  <a href="https://github.com/mozilla/bigquery-etl/edit/generated-sql/sql//mozfun/event_analysis/get_funnel_steps_sql/metadata.yaml">Edit</a></p>
 <h2 id="create_funnel_steps_query-stored-procedure">create_funnel_steps_query (Stored Procedure)</h2>
 <p>Generate the SQL statement that can be used to create an easily queryable view on events data.</p>
-<h3 id="parameters_3">Parameters</h3>
+<h3 id="parameters_2">Parameters</h3>
 <p><strong>INPUTS</strong></p>
 <div class="highlight"><pre><span></span><code>project STRING, dataset STRING, funnel ARRAY&lt;STRUCT&lt;list ARRAY&lt;STRUCT&lt;category STRING, event_name STRING&gt;&gt;&gt;&gt;
 </code></pre></div>
@@ -4132,7 +4122,7 @@ <h3 id="parameters_3">Parameters</h3>
 <p><a href="https://github.com/mozilla/bigquery-etl/blob/generated-sql/sql//mozfun/event_analysis/create_funnel_steps_query">Source</a>  |  <a href="https://github.com/mozilla/bigquery-etl/edit/generated-sql/sql//mozfun/event_analysis/create_funnel_steps_query/metadata.yaml">Edit</a></p>
 <h2 id="get_count_sql-stored-procedure">get_count_sql (Stored Procedure)</h2>
 <p>For a given funnel, get a SQL statement that can be used to determine if an events string contains that funnel.</p>
-<h3 id="parameters_4">Parameters</h3>
+<h3 id="parameters_3">Parameters</h3>
 <p><strong>INPUTS</strong></p>
 <div class="highlight"><pre><span></span><code>project STRING, dataset STRING, count_name STRING, events ARRAY&lt;STRUCT&lt;category STRING, event_name STRING&gt;&gt;
 </code></pre></div>
@@ -4142,7 +4132,7 @@ <h3 id="parameters_4">Parameters</h3>
 <p><a href="https://github.com/mozilla/bigquery-etl/blob/generated-sql/sql//mozfun/event_analysis/get_count_sql">Source</a>  |  <a href="https://github.com/mozilla/bigquery-etl/edit/generated-sql/sql//mozfun/event_analysis/get_count_sql/metadata.yaml">Edit</a></p>
 <h2 id="create_funnel_regex-udf">create_funnel_regex (UDF)</h2>
 <p>Given an array of match strings, each representing a single funnel step, aggregate them into a regex string that will match only against the entire funnel. If intermediate_steps is TRUE, this allows for there to be events that occur between the funnel steps.</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>step_regexes ARRAY&lt;STRING&gt;, intermediate_steps BOOLEAN
 </code></pre></div>
@@ -4169,7 +4159,7 @@ <h3 id="caveats">Caveats</h3>
 and for all events without their properties.</p>
 <p>This allows us to include both total counts for an event (with any
 property value), and events that don't have properties.</p>
-<h3 id="parameters_6">Parameters</h3>
+<h3 id="parameters_5">Parameters</h3>
 <p><strong>INPUTS</strong></p>
 <div class="highlight"><pre><span></span><code>events STRING
 </code></pre></div>
@@ -4367,7 +4357,7 @@ <h3 id="examples">Examples</h3>
 <span class="k">GROUP</span><span class="w"> </span><span class="k">BY</span>
 <span class="w">    </span><span class="n">submission_date</span>
 </code></pre></div></p>
-<h3 id="parameters_7">Parameters</h3>
+<h3 id="parameters_6">Parameters</h3>
 <p><strong>INPUTS</strong></p>
 <div class="highlight"><pre><span></span><code>view_name STRING, project STRING, dataset STRING, funnels ARRAY&lt;STRUCT&lt;funnel_name STRING, funnel ARRAY&lt;STRUCT&lt;step_name STRING, events ARRAY&lt;STRUCT&lt;category STRING, event_name STRING&gt;&gt;&gt;&gt;&gt;&gt;, counts ARRAY&lt;STRUCT&lt;count_name STRING, events ARRAY&lt;STRUCT&lt;category STRING, event_name STRING&gt;&gt;&gt;&gt;
 </code></pre></div>
@@ -4386,7 +4376,7 @@ <h3 id="usage_2">Usage</h3>
 <h3 id="example_1">Example</h3>
 <p>See <a href="https://sql.telemetry.mozilla.org/dashboard/fenix-events">this dashboard</a>
 for example usage.</p>
-<h3 id="parameters_8">Parameters</h3>
+<h3 id="parameters_7">Parameters</h3>
 <p><strong>INPUTS</strong></p>
 <div class="highlight"><pre><span></span><code>events STRING
 </code></pre></div>
@@ -4396,7 +4386,7 @@ <h3 id="parameters_8">Parameters</h3>
 <p><a href="https://github.com/mozilla/bigquery-etl/blob/generated-sql/sql//mozfun/event_analysis/extract_event_counts">Source</a>  |  <a href="https://github.com/mozilla/bigquery-etl/edit/generated-sql/sql//mozfun/event_analysis/extract_event_counts/metadata.yaml">Edit</a></p>
 <h2 id="create_count_steps_query-stored-procedure">create_count_steps_query (Stored Procedure)</h2>
 <p>Generate the SQL statement that can be used to create an easily queryable view on events data.</p>
-<h3 id="parameters_9">Parameters</h3>
+<h3 id="parameters_8">Parameters</h3>
 <p><strong>INPUTS</strong></p>
 <div class="highlight"><pre><span></span><code>project STRING, dataset STRING, events ARRAY&lt;STRUCT&lt;category STRING, event_name STRING&gt;&gt;
 </code></pre></div>
@@ -4406,14 +4396,24 @@ <h3 id="parameters_9">Parameters</h3>
 <p><a href="https://github.com/mozilla/bigquery-etl/blob/generated-sql/sql//mozfun/event_analysis/create_count_steps_query">Source</a>  |  <a href="https://github.com/mozilla/bigquery-etl/edit/generated-sql/sql//mozfun/event_analysis/create_count_steps_query/metadata.yaml">Edit</a></p>
 <h2 id="event_index_to_match_string-udf">event_index_to_match_string (UDF)</h2>
 <p>Given an event index string, create a match string that is an exact match in the events_daily table.</p>
-<h3 id="parameters_10">Parameters</h3>
+<h3 id="parameters_9">Parameters</h3>
 <p><strong>INPUTS</strong></p>
 <div class="highlight"><pre><span></span><code>index STRING
 </code></pre></div>
 <p><strong>OUTPUTS</strong></p>
 <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/event_analysis/event_index_to_match_string">Source</a>  |  <a href="https://github.com/mozilla/bigquery-etl/edit/generated-sql/sql//mozfun/event_analysis/event_index_to_match_string/metadata.yaml">Edit</a></p>
+<h2 id="aggregate_match_strings-udf">aggregate_match_strings (UDF)</h2>
+<p>Given an array of strings that each match a single event, aggregate those into a single regex string that will match any of the events.</p>
+<h3 id="parameters_10">Parameters</h3>
+<p><strong>INPUTS</strong></p>
+<div class="highlight"><pre><span></span><code>match_strings ARRAY&lt;STRING&gt;
+</code></pre></div>
+<p><strong>OUTPUTS</strong></p>
+<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/event_analysis/aggregate_match_strings">Source</a>  |  <a href="https://github.com/mozilla/bigquery-etl/edit/generated-sql/sql//mozfun/event_analysis/aggregate_match_strings/metadata.yaml">Edit</a></p>