Deployed 1040ff3 with MkDocs version: 1.4.2

supabase · Dec 5, 2023 · cd3eb40 · cd3eb40
1 parent 130bc9c
commit cd3eb40
Show file tree

Hide file tree

Showing 10 changed files with 134 additions and 12 deletions.
diff --git a/airtable/index.html b/airtable/index.html
@@ -343,6 +343,13 @@
       </ul>
     </nav>
 
+</li>
+
+        <li class="md-nav__item">
+  <a href="#query-pushdown-support" class="md-nav__link">
+    Query Pushdown Support
+  </a>
+
 </li>
 
         <li class="md-nav__item">
@@ -548,6 +555,13 @@
       </ul>
     </nav>
 
+</li>
+
+        <li class="md-nav__item">
+  <a href="#query-pushdown-support" class="md-nav__link">
+    Query Pushdown Support
+  </a>
+
 </li>
 
         <li class="md-nav__item">
@@ -703,6 +717,8 @@ <h3 id="foreign-table-options">Foreign table options</h3>
 <li><code>table_id</code> - Airtable table ID, required.</li>
 <li><code>view_id</code> - Airtable view ID, optional.</li>
 </ul>
+<h2 id="query-pushdown-support">Query Pushdown Support</h2>
+<p>This FDW doesn't support query pushdown.</p>
 <h2 id="examples">Examples</h2>
 <p>Some examples on how to use Airtable foreign tables.</p>
 <h3 id="basic-example">Basic example</h3>

diff --git a/bigquery/index.html b/bigquery/index.html
@@ -364,6 +364,13 @@
       </ul>
     </nav>
 
+</li>
+
+        <li class="md-nav__item">
+  <a href="#query-pushdown-support" class="md-nav__link">
+    Query Pushdown Support
+  </a>
+
 </li>
 
         <li class="md-nav__item">
@@ -576,6 +583,13 @@
       </ul>
     </nav>
 
+</li>
+
+        <li class="md-nav__item">
+  <a href="#query-pushdown-support" class="md-nav__link">
+    Query Pushdown Support
+  </a>
+
 </li>
 
         <li class="md-nav__item">
@@ -835,6 +849,8 @@ <h3 id="foreign-table-options">Foreign table options</h3>
 <li><code>timeout</code> - Query request timeout in milliseconds, optional. Default is '30000' (30 seconds).</li>
 <li><code>rowid_column</code> - Primary key column name, optional for data scan, required for data modify</li>
 </ul>
+<h2 id="query-pushdown-support">Query Pushdown Support</h2>
+<p>This FDW supports <code>where</code>, <code>order by</code> and <code>limit</code> clause pushdown.</p>
 <h2 id="inserting-rows-the-streaming-buffer">Inserting Rows &amp; the Streaming Buffer</h2>
 <p>This foreign data wrapper uses BigQuery’s <code>insertAll</code> API method to create a <code>streamingBuffer</code> with an associated partition time. <strong>Within that partition time, the data cannot be updated, deleted, or fully exported</strong>. Only after the time has elapsed (up to 90 minutes according to <a href="https://cloud.google.com/bigquery/docs/streaming-data-into-bigquery">BigQuery’s documentation</a>); can you perform operations.</p>
 <p>If you attempt an <code>UPDATE</code> or <code>DELETE</code> statement on rows while in the streamingBuffer, you will get an error of <code>UPDATE</code> or <code>DELETE</code> statement over table datasetName - note that tableName would affect rows in the streaming buffer, which is not supported.</p>

diff --git a/clickhouse/index.html b/clickhouse/index.html
@@ -378,6 +378,13 @@
       </ul>
     </nav>
 
+</li>
+
+        <li class="md-nav__item">
+  <a href="#query-pushdown-support" class="md-nav__link">
+    Query Pushdown Support
+  </a>
+
 </li>
 
         <li class="md-nav__item">
@@ -562,6 +569,13 @@
       </ul>
     </nav>
 
+</li>
+
+        <li class="md-nav__item">
+  <a href="#query-pushdown-support" class="md-nav__link">
+    Query Pushdown Support
+  </a>
+
 </li>
 
         <li class="md-nav__item">
@@ -809,6 +823,8 @@ <h3 id="foreign-table-options">Foreign table options</h3>
 <ul>
 <li><code>rowid_column</code> - Primary key column name, optional for data scan, required for data modify</li>
 </ul>
+<h2 id="query-pushdown-support">Query Pushdown Support</h2>
+<p>This FDW supports <code>where</code>, <code>order by</code> and <code>limit</code> clause pushdown, as well as parametrized view (see above).</p>
 <h2 id="examples">Examples</h2>
 <p>Some examples on how to use ClickHouse foreign tables.</p>
 <h3 id="basic-example">Basic example</h3>

diff --git a/firebase/index.html b/firebase/index.html
@@ -385,6 +385,13 @@
       </ul>
     </nav>
 
+</li>
+
+        <li class="md-nav__item">
+  <a href="#query-pushdown-support" class="md-nav__link">
+    Query Pushdown Support
+  </a>
+
 </li>
 
         <li class="md-nav__item">
@@ -555,6 +562,13 @@
       </ul>
     </nav>
 
+</li>
+
+        <li class="md-nav__item">
+  <a href="#query-pushdown-support" class="md-nav__link">
+    Query Pushdown Support
+  </a>
+
 </li>
 
         <li class="md-nav__item">
@@ -751,6 +765,13 @@ <h3 id="foreign-table-options">Foreign table options</h3>
 <ul>
 <li><code>object</code> - Object name in Firebase, required.</li>
 </ul>
+<p>For Authenciation users, the object name is fixed to <code>auth/users</code>. For Firestore documents, its format is <code>firestore/&lt;collection_id&gt;</code>, note that collection id must be a full path id. For example,</p>
+<ul>
+<li><code>firestore/my-collection</code></li>
+<li><code>firestore/my-collection/my-document/another-collection</code></li>
+</ul>
+<h2 id="query-pushdown-support">Query Pushdown Support</h2>
+<p>This FDW doesn't support query pushdown.</p>
 <h2 id="examples">Examples</h2>
 <p>Some examples on how to use Firebase foreign tables.</p>
 <h3 id="firestore">firestore</h3>
@@ -772,7 +793,7 @@ <h3 id="firestore">firestore</h3>
 <span class="p">)</span><span class="w"></span>
 <span class="w">  </span><span class="n">server</span><span class="w"> </span><span class="n">firebase_server</span><span class="w"></span>
 <span class="w">  </span><span class="k">options</span><span class="w"> </span><span class="p">(</span><span class="w"></span>
-<span class="w">    </span><span class="k">object</span><span class="w"> </span><span class="s1">&#39;firestore/user-profiles&#39;</span><span class="w">  </span><span class="c1">-- format: &#39;firestore/[collection_id]&#39;</span>
+<span class="w">    </span><span class="k">object</span><span class="w"> </span><span class="s1">&#39;firestore/user-profiles&#39;</span><span class="w"></span>
 <span class="w">  </span><span class="p">);</span><span class="w"></span>
 </code></pre></div></td></tr></table></div>
 <p>Note that <code>name</code>, <code>created_at</code>, and <code>updated_at</code>, are automatic metadata fields on all Firestore collections.</p>

diff --git a/logflare/index.html b/logflare/index.html
@@ -413,6 +413,13 @@
       </ul>
     </nav>
 
+</li>
+
+        <li class="md-nav__item">
+  <a href="#query-pushdown-support" class="md-nav__link">
+    Query Pushdown Support
+  </a>
+
 </li>
 
         <li class="md-nav__item">
@@ -583,6 +590,13 @@
       </ul>
     </nav>
 
+</li>
+
+        <li class="md-nav__item">
+  <a href="#query-pushdown-support" class="md-nav__link">
+    Query Pushdown Support
+  </a>
+
 </li>
 
         <li class="md-nav__item">
@@ -745,6 +759,8 @@ <h3 id="foreign-table-options">Foreign table options</h3>
 <ul>
 <li><code>endpoint</code> - Logflare endpoint UUID or name, required.</li>
 </ul>
+<h2 id="query-pushdown-support">Query Pushdown Support</h2>
+<p>This FDW doesn't support query pushdown.</p>
 <h2 id="examples">Examples</h2>
 <p>Some examples on how to use Logflare foreign tables.</p>
 <h3 id="basic-example">Basic example</h3>

diff --git a/s3/index.html b/s3/index.html
@@ -420,6 +420,13 @@
       </ul>
     </nav>
 
+</li>
+
+        <li class="md-nav__item">
+  <a href="#query-pushdown-support" class="md-nav__link">
+    Query Pushdown Support
+  </a>
+
 </li>
 
         <li class="md-nav__item">
@@ -562,6 +569,13 @@
       </ul>
     </nav>
 
+</li>
+
+        <li class="md-nav__item">
+  <a href="#query-pushdown-support" class="md-nav__link">
+    Query Pushdown Support
+  </a>
+
 </li>
 
         <li class="md-nav__item">
@@ -818,6 +832,8 @@ <h3 id="foreign-table-options">Foreign table options</h3>
 <li><code>has_header</code> - If the CSV file has header, optional. <code>true</code> or <code>false</code>, default is <code>false</code></li>
 <li><code>compress</code> - Compression algorithm, optional. One of <code>gzip</code>, <code>bzip2</code>, <code>xz</code>, <code>zlib</code>, default is no compression</li>
 </ul>
+<h2 id="query-pushdown-support">Query Pushdown Support</h2>
+<p>This FDW doesn't support query pushdown.</p>
 <h2 id="examples">Examples</h2>
 <p>Some examples on how to use S3 foreign tables.</p>
 <h3 id="basic-example">Basic example</h3>

diff --git a/search/search_index.json b/search/search_index.json
diff --git a/sitemap.xml b/sitemap.xml
@@ -2,52 +2,52 @@
 <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
     <url>
          <loc>https://supabase.github.io/wrappers/</loc>
-         <lastmod>2023-11-23</lastmod>
+         <lastmod>2023-12-05</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://supabase.github.io/wrappers/airtable/</loc>
-         <lastmod>2023-11-23</lastmod>
+         <lastmod>2023-12-05</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://supabase.github.io/wrappers/bigquery/</loc>
-         <lastmod>2023-11-23</lastmod>
+         <lastmod>2023-12-05</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://supabase.github.io/wrappers/clickhouse/</loc>
-         <lastmod>2023-11-23</lastmod>
+         <lastmod>2023-12-05</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://supabase.github.io/wrappers/contributing/</loc>
-         <lastmod>2023-11-23</lastmod>
+         <lastmod>2023-12-05</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://supabase.github.io/wrappers/firebase/</loc>
-         <lastmod>2023-11-23</lastmod>
+         <lastmod>2023-12-05</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://supabase.github.io/wrappers/installation/</loc>
-         <lastmod>2023-11-23</lastmod>
+         <lastmod>2023-12-05</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://supabase.github.io/wrappers/logflare/</loc>
-         <lastmod>2023-11-23</lastmod>
+         <lastmod>2023-12-05</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://supabase.github.io/wrappers/s3/</loc>
-         <lastmod>2023-11-23</lastmod>
+         <lastmod>2023-12-05</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://supabase.github.io/wrappers/stripe/</loc>
-         <lastmod>2023-11-23</lastmod>
+         <lastmod>2023-12-05</lastmod>
          <changefreq>daily</changefreq>
     </url>
 </urlset>
diff --git a/sitemap.xml.gz b/sitemap.xml.gz
diff --git a/stripe/index.html b/stripe/index.html
@@ -581,6 +581,13 @@
       </ul>
     </nav>
 
+</li>
+
+        <li class="md-nav__item">
+  <a href="#query-pushdown-support" class="md-nav__link">
+    Query Pushdown Support
+  </a>
+
 </li>
 
         <li class="md-nav__item">
@@ -870,6 +877,13 @@
       </ul>
     </nav>
 
+</li>
+
+        <li class="md-nav__item">
+  <a href="#query-pushdown-support" class="md-nav__link">
+    Query Pushdown Support
+  </a>
+
 </li>
 
         <li class="md-nav__item">
@@ -2046,6 +2060,13 @@ <h3 id="transfers">Transfers</h3>
 <li>id</li>
 <li>destination</li>
 </ul>
+<h2 id="query-pushdown-support">Query Pushdown Support</h2>
+<p>This FDW supports <code>where</code> clause pushdown. You can specify a filter in <code>where</code> clause and it will be passed to Stripe API call.</p>
+<p>For example, this query</p>
+<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">select</span><span class="w"> </span><span class="o">*</span><span class="w"> </span><span class="k">from</span><span class="w"> </span><span class="n">stripe</span><span class="p">.</span><span class="n">customers</span><span class="w"> </span><span class="k">where</span><span class="w"> </span><span class="n">id</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s1">&#39;cus_xxx&#39;</span><span class="p">;</span><span class="w"></span>
+</code></pre></div></td></tr></table></div>
+<p>will be translated Stripe API call: <code>https://api.stripe.com/v1/customers/cus_xxx</code>.</p>
+<p>For supported filter columns for each object, please check out foreign table documents above.</p>
 <h2 id="examples">Examples</h2>
 <p>Some examples on how to use Stripe foreign tables.</p>
 <h3 id="basic-example">Basic example</h3>