docs/dev/r/reference/to_duckdb.html - arrow-site - Git at Google

 <!DOCTYPE html>
 <!-- Generated by pkgdown: do not edit by hand --><html lang="en-US"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><title>Create a (virtual) DuckDB table from an Arrow object — to_duckdb • Arrow R Package</title><!-- favicons --><link rel="icon" type="image/png" sizes="96x96" href="../favicon-96x96.png"><link rel="icon" type="”image/svg+xml”" href="../favicon.svg"><link rel="apple-touch-icon" sizes="180x180" href="../apple-touch-icon.png"><link rel="icon" sizes="any" href="../favicon.ico"><link rel="manifest" href="../site.webmanifest"><script src="../deps/jquery-3.6.0/jquery-3.6.0.min.js"></script><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><link href="../deps/bootstrap-5.3.1/bootstrap.min.css" rel="stylesheet"><script src="../deps/bootstrap-5.3.1/bootstrap.bundle.min.js"></script><link href="../deps/font-awesome-6.5.2/css/all.min.css" rel="stylesheet"><link href="../deps/font-awesome-6.5.2/css/v4-shims.min.css" rel="stylesheet"><script src="../deps/headroom-0.11.0/headroom.min.js"></script><script src="../deps/headroom-0.11.0/jQuery.headroom.min.js"></script><script src="../deps/bootstrap-toc-1.0.1/bootstrap-toc.min.js"></script><script src="../deps/clipboard.js-2.0.11/clipboard.min.js"></script><script src="../deps/search-1.0.0/autocomplete.jquery.min.js"></script><script src="../deps/search-1.0.0/fuse.min.js"></script><script src="../deps/search-1.0.0/mark.min.js"></script><!-- pkgdown --><script src="../pkgdown.js"></script><link href="../extra.css" rel="stylesheet"><meta property="og:title" content="Create a (virtual) DuckDB table from an Arrow object — to_duckdb"><meta name="description" content="This will do the necessary configuration to create a (virtual) table in DuckDB
 that is backed by the Arrow object given. No data is copied or modified until
 collect() or compute() are called or a query is run against the table."><meta property="og:description" content="This will do the necessary configuration to create a (virtual) table in DuckDB
 that is backed by the Arrow object given. No data is copied or modified until
 collect() or compute() are called or a query is run against the table."><meta property="og:image" content="https://arrow.apache.org/img/arrow-logo_horizontal_black-txt_white-bg.png"><meta property="og:image:alt" content="Apache Arrow logo, displaying the triple chevron image adjacent to the text"><!-- Matomo --><script>
   var _paq = window._paq = window._paq || [];
   /* tracker methods like "setCustomDimension" should be called before "trackPageView" */
   /* We explicitly disable cookie tracking to avoid privacy issues */
   _paq.push(['disableCookies']);
   _paq.push(['trackPageView']);
   _paq.push(['enableLinkTracking']);
   (function() {
     var u="https://analytics.apache.org/";
     _paq.push(['setTrackerUrl', u+'matomo.php']);
     _paq.push(['setSiteId', '20']);
     var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0];
     g.async=true; g.src=u+'matomo.js'; s.parentNode.insertBefore(g,s);
   })();
 </script><!-- End Matomo Code --><!-- Kapa AI --><script async src="https://widget.kapa.ai/kapa-widget.bundle.js" data-website-id="9db461d5-ac77-4b3f-a5c5-75efa78339d2" data-project-name="Apache Arrow" data-project-color="#000000" data-project-logo="https://arrow.apache.org/img/arrow-logo_chevrons_white-txt_black-bg.png" data-modal-disclaimer="This is a custom LLM with access to all of [Arrow documentation](https://arrow.apache.org/docs/).  If you want an R-specific answer, please mention this in your question." data-consent-required="true" data-user-analytics-cookie-enabled="false" data-consent-screen-disclaimer="By clicking &quot;I agree, let's chat&quot;, you consent to the use of the AI assistant in accordance with kapa.ai's [Privacy Policy](https://www.kapa.ai/content/privacy-policy). This service uses reCAPTCHA, which requires your consent to Google's [Privacy Policy](https://policies.google.com/privacy) and [Terms of Service](https://policies.google.com/terms). By proceeding, you explicitly agree to both kapa.ai's and Google's privacy policies."></script><!-- End Kapa AI --></head><body>
     <a href="#main" class="visually-hidden-focusable">Skip to contents</a>


     <nav class="navbar fixed-top navbar-dark navbar-expand-lg bg-black"><div class="container">

     <a class="navbar-brand me-2" href="../index.html">Arrow R Package</a>

     <span class="version">
       <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">22.0.0.9000</small>
     </span>


     <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
       <span class="navbar-toggler-icon"></span>
     </button>

     <div id="navbar" class="collapse navbar-collapse ms-3">
       <ul class="navbar-nav me-auto"><li class="nav-item"><a class="nav-link" href="../articles/arrow.html">Get started</a></li>
 <li class="active nav-item"><a class="nav-link" href="../reference/index.html">Reference</a></li>
 <li class="nav-item dropdown">
   <button class="nav-link dropdown-toggle" type="button" id="dropdown-articles" data-bs-toggle="dropdown" aria-expanded="false" aria-haspopup="true">Articles</button>
   <ul class="dropdown-menu" aria-labelledby="dropdown-articles"><li><hr class="dropdown-divider"></li>
     <li><h6 class="dropdown-header" data-toc-skip>Using the package</h6></li>
     <li><a class="dropdown-item" href="../articles/read_write.html">Reading and writing data files</a></li>
     <li><a class="dropdown-item" href="../articles/data_wrangling.html">Data analysis with dplyr syntax</a></li>
     <li><a class="dropdown-item" href="../articles/dataset.html">Working with multi-file data sets</a></li>
     <li><a class="dropdown-item" href="../articles/python.html">Integrating Arrow, Python, and R</a></li>
     <li><a class="dropdown-item" href="../articles/fs.html">Using cloud storage (S3, GCS)</a></li>
     <li><a class="dropdown-item" href="../articles/flight.html">Connecting to a Flight server</a></li>
     <li><hr class="dropdown-divider"></li>
     <li><h6 class="dropdown-header" data-toc-skip>Arrow concepts</h6></li>
     <li><a class="dropdown-item" href="../articles/data_objects.html">Data objects</a></li>
     <li><a class="dropdown-item" href="../articles/data_types.html">Data types</a></li>
     <li><a class="dropdown-item" href="../articles/metadata.html">Metadata</a></li>
     <li><hr class="dropdown-divider"></li>
     <li><h6 class="dropdown-header" data-toc-skip>Installation</h6></li>
     <li><a class="dropdown-item" href="../articles/install.html">Installing on Linux</a></li>
     <li><a class="dropdown-item" href="../articles/install_nightly.html">Installing development versions</a></li>
     <li><hr class="dropdown-divider"></li>
     <li><a class="dropdown-item" href="../articles/index.html">More articles...</a></li>
   </ul></li>
 <li class="nav-item"><a class="nav-link" href="../news/index.html">Changelog</a></li>
       </ul><form class="form-inline my-2 my-lg-0" role="search">
         <input type="search" class="form-control me-sm-2" aria-label="Toggle navigation" name="search-input" data-search-index="../search.json" id="search-input" placeholder="" autocomplete="off"></form>

       <ul class="navbar-nav"><li class="nav-item"><a class="external-link nav-link" href="https://github.com/apache/arrow/" aria-label="GitHub"><span class="fa fab fa-github fa-lg"></span></a></li>
       </ul></div>


   </div>
 </nav><div class="container template-reference-topic">
 <div class="row">
   <main id="main" class="col-md-9"><div class="page-header">

       <h1>Create a (virtual) DuckDB table from an Arrow object</h1>
       <small class="dont-index">Source: <a href="https://github.com/apache/arrow/blob/main/r/R/duckdb.R" class="external-link"><code>R/duckdb.R</code></a></small>
       <div class="d-none name"><code>to_duckdb.Rd</code></div>
     </div>

     <div class="ref-description section level2">
     <p>This will do the necessary configuration to create a (virtual) table in DuckDB
 that is backed by the Arrow object given. No data is copied or modified until
 <code><a href="https://dplyr.tidyverse.org/reference/compute.html" class="external-link">collect()</a></code> or <code><a href="https://dplyr.tidyverse.org/reference/compute.html" class="external-link">compute()</a></code> are called or a query is run against the table.</p>
     </div>

     <div class="section level2">
     <h2 id="ref-usage">Usage<a class="anchor" aria-label="anchor" href="#ref-usage"></a></h2>
     <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">to_duckdb</span><span class="op">(</span></span>
 <span>  <span class="va">.data</span>,</span>
 <span>  con <span class="op">=</span> <span class="fu">arrow_duck_connection</span><span class="op">(</span><span class="op">)</span>,</span>
 <span>  table_name <span class="op">=</span> <span class="fu">unique_arrow_tablename</span><span class="op">(</span><span class="op">)</span>,</span>
 <span>  auto_disconnect <span class="op">=</span> <span class="cn">TRUE</span></span>
 <span><span class="op">)</span></span></code></pre></div>
     </div>

     <div class="section level2">
     <h2 id="arguments">Arguments<a class="anchor" aria-label="anchor" href="#arguments"></a></h2>


 <dl><dt id="arg--data">.data<a class="anchor" aria-label="anchor" href="#arg--data"></a></dt>
 <dd><p>the Arrow object (e.g. Dataset, Table) to use for the DuckDB table</p></dd>


 <dt id="arg-con">con<a class="anchor" aria-label="anchor" href="#arg-con"></a></dt>
 <dd><p>a DuckDB connection to use (default will create one and store it
 in <code>options("arrow_duck_con")</code>)</p></dd>


 <dt id="arg-table-name">table_name<a class="anchor" aria-label="anchor" href="#arg-table-name"></a></dt>
 <dd><p>a name to use in DuckDB for this object. The default is a
 unique string <code>"arrow_"</code> followed by numbers.</p></dd>


 <dt id="arg-auto-disconnect">auto_disconnect<a class="anchor" aria-label="anchor" href="#arg-auto-disconnect"></a></dt>
 <dd><p>should the table be automatically cleaned up when the
 resulting object is removed (and garbage collected)? Default: <code>TRUE</code></p></dd>

 </dl></div>
     <div class="section level2">
     <h2 id="value">Value<a class="anchor" aria-label="anchor" href="#value"></a></h2>
     <p>A <code>tbl</code> of the new table in DuckDB</p>
     </div>
     <div class="section level2">
     <h2 id="details">Details<a class="anchor" aria-label="anchor" href="#details"></a></h2>
     <p>The result is a dbplyr-compatible object that can be used in d(b)plyr pipelines.</p>
 <p>If <code>auto_disconnect = TRUE</code>, the DuckDB table that is created will be configured
 to be unregistered when the <code>tbl</code> object is garbage collected. This is helpful
 if you don't want to have extra table objects in DuckDB after you've finished
 using them.</p>
     </div>

     <div class="section level2">
     <h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-examples"></a></h2>
     <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span><span class="kw"><a href="https://rdrr.io/r/base/library.html" class="external-link">library</a></span><span class="op">(</span><span class="va"><a href="https://dplyr.tidyverse.org" class="external-link">dplyr</a></span><span class="op">)</span></span></span>
 <span class="r-in"><span></span></span>
 <span class="r-in"><span><span class="va">ds</span> <span class="op">&lt;-</span> <span class="va">InMemoryDataset</span><span class="op">$</span><span class="fu">create</span><span class="op">(</span><span class="va">mtcars</span><span class="op">)</span></span></span>
 <span class="r-in"><span></span></span>
 <span class="r-in"><span><span class="va">ds</span> <span class="op">|&gt;</span></span></span>
 <span class="r-in"><span>  <span class="fu"><a href="https://dplyr.tidyverse.org/reference/filter.html" class="external-link">filter</a></span><span class="op">(</span><span class="va">mpg</span> <span class="op">&lt;</span> <span class="fl">30</span><span class="op">)</span> <span class="op">|&gt;</span></span></span>
 <span class="r-in"><span>  <span class="fu"><a href="https://dplyr.tidyverse.org/reference/group_by.html" class="external-link">group_by</a></span><span class="op">(</span><span class="va">cyl</span><span class="op">)</span> <span class="op">|&gt;</span></span></span>
 <span class="r-in"><span>  <span class="fu">to_duckdb</span><span class="op">(</span><span class="op">)</span> <span class="op">|&gt;</span></span></span>
 <span class="r-in"><span>  <span class="fu"><a href="https://dplyr.tidyverse.org/reference/slice.html" class="external-link">slice_min</a></span><span class="op">(</span><span class="va">disp</span><span class="op">)</span></span></span>
 <span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #949494;"># Source:   SQL [?? x 11]</span></span>
 <span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #949494;"># Database: DuckDB 1.4.1 [unknown@Linux 6.11.0-1018-azure:R 4.5.2/:memory:]</span></span>
 <span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #949494;"># Groups:   cyl</span></span>
 <span class="r-out co"><span class="r-pr">#&gt;</span>     mpg   cyl  disp    hp  drat    wt  qsec    vs    am  gear  carb</span>
 <span class="r-out co"><span class="r-pr">#&gt;</span>   <span style="color: #949494; font-style: italic;">&lt;dbl&gt;</span> <span style="color: #949494; font-style: italic;">&lt;dbl&gt;</span> <span style="color: #949494; font-style: italic;">&lt;dbl&gt;</span> <span style="color: #949494; font-style: italic;">&lt;dbl&gt;</span> <span style="color: #949494; font-style: italic;">&lt;dbl&gt;</span> <span style="color: #949494; font-style: italic;">&lt;dbl&gt;</span> <span style="color: #949494; font-style: italic;">&lt;dbl&gt;</span> <span style="color: #949494; font-style: italic;">&lt;dbl&gt;</span> <span style="color: #949494; font-style: italic;">&lt;dbl&gt;</span> <span style="color: #949494; font-style: italic;">&lt;dbl&gt;</span> <span style="color: #949494; font-style: italic;">&lt;dbl&gt;</span></span>
 <span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #BCBCBC;">1</span>  16.4     8  276.   180  3.07  4.07  17.4     0     0     3     3</span>
 <span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #BCBCBC;">2</span>  17.3     8  276.   180  3.07  3.73  17.6     0     0     3     3</span>
 <span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #BCBCBC;">3</span>  15.2     8  276.   180  3.07  3.78  18       0     0     3     3</span>
 <span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #BCBCBC;">4</span>  27.3     4   79     66  4.08  1.94  18.9     1     1     4     1</span>
 <span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #BCBCBC;">5</span>  19.7     6  145    175  3.62  2.77  15.5     0     1     5     6</span>
 </code></pre></div>
     </div>
   </main><aside class="col-md-3"><nav id="toc" aria-label="Table of contents"><h2>On this page</h2>
     </nav></aside></div>


     <footer><div class="pkgdown-footer-left">
   <p><a href="https://arrow.apache.org/docs/r/versions.html">Older versions of these docs</a></p>
 </div>

 <div class="pkgdown-footer-right">
   <p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.1.3.</p>
 </div>

     </footer></div>


   </body></html>
	<!DOCTYPE html>
	<!-- Generated by pkgdown: do not edit by hand --><html lang="en-US"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><title>Create a (virtual) DuckDB table from an Arrow object — to_duckdb • Arrow R Package</title><!-- favicons --><link rel="icon" type="image/png" sizes="96x96" href="../favicon-96x96.png"><link rel="icon" type="”image/svg+xml”" href="../favicon.svg"><link rel="apple-touch-icon" sizes="180x180" href="../apple-touch-icon.png"><link rel="icon" sizes="any" href="../favicon.ico"><link rel="manifest" href="../site.webmanifest"><script src="../deps/jquery-3.6.0/jquery-3.6.0.min.js"></script><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><link href="../deps/bootstrap-5.3.1/bootstrap.min.css" rel="stylesheet"><script src="../deps/bootstrap-5.3.1/bootstrap.bundle.min.js"></script><link href="../deps/font-awesome-6.5.2/css/all.min.css" rel="stylesheet"><link href="../deps/font-awesome-6.5.2/css/v4-shims.min.css" rel="stylesheet"><script src="../deps/headroom-0.11.0/headroom.min.js"></script><script src="../deps/headroom-0.11.0/jQuery.headroom.min.js"></script><script src="../deps/bootstrap-toc-1.0.1/bootstrap-toc.min.js"></script><script src="../deps/clipboard.js-2.0.11/clipboard.min.js"></script><script src="../deps/search-1.0.0/autocomplete.jquery.min.js"></script><script src="../deps/search-1.0.0/fuse.min.js"></script><script src="../deps/search-1.0.0/mark.min.js"></script><!-- pkgdown --><script src="../pkgdown.js"></script><link href="../extra.css" rel="stylesheet"><meta property="og:title" content="Create a (virtual) DuckDB table from an Arrow object — to_duckdb"><meta name="description" content="This will do the necessary configuration to create a (virtual) table in DuckDB
	that is backed by the Arrow object given. No data is copied or modified until
	collect() or compute() are called or a query is run against the table."><meta property="og:description" content="This will do the necessary configuration to create a (virtual) table in DuckDB
	that is backed by the Arrow object given. No data is copied or modified until
	collect() or compute() are called or a query is run against the table."><meta property="og:image" content="https://arrow.apache.org/img/arrow-logo_horizontal_black-txt_white-bg.png"><meta property="og:image:alt" content="Apache Arrow logo, displaying the triple chevron image adjacent to the text"><!-- Matomo --><script>
	var _paq = window._paq = window._paq \|\| [];
	/* tracker methods like "setCustomDimension" should be called before "trackPageView" */
	/* We explicitly disable cookie tracking to avoid privacy issues */
	_paq.push(['disableCookies']);
	_paq.push(['trackPageView']);
	_paq.push(['enableLinkTracking']);
	(function() {
	var u="https://analytics.apache.org/";
	_paq.push(['setTrackerUrl', u+'matomo.php']);
	_paq.push(['setSiteId', '20']);
	var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0];
	g.async=true; g.src=u+'matomo.js'; s.parentNode.insertBefore(g,s);
	})();
	</script><!-- End Matomo Code --><!-- Kapa AI --><script async src="https://widget.kapa.ai/kapa-widget.bundle.js" data-website-id="9db461d5-ac77-4b3f-a5c5-75efa78339d2" data-project-name="Apache Arrow" data-project-color="#000000" data-project-logo="https://arrow.apache.org/img/arrow-logo_chevrons_white-txt_black-bg.png" data-modal-disclaimer="This is a custom LLM with access to all of [Arrow documentation](https://arrow.apache.org/docs/). If you want an R-specific answer, please mention this in your question." data-consent-required="true" data-user-analytics-cookie-enabled="false" data-consent-screen-disclaimer="By clicking "I agree, let's chat", you consent to the use of the AI assistant in accordance with kapa.ai's [Privacy Policy](https://www.kapa.ai/content/privacy-policy). This service uses reCAPTCHA, which requires your consent to Google's [Privacy Policy](https://policies.google.com/privacy) and [Terms of Service](https://policies.google.com/terms). By proceeding, you explicitly agree to both kapa.ai's and Google's privacy policies."></script><!-- End Kapa AI --></head><body>
	<a href="#main" class="visually-hidden-focusable">Skip to contents</a>


	<nav class="navbar fixed-top navbar-dark navbar-expand-lg bg-black"><div class="container">

	<a class="navbar-brand me-2" href="../index.html">Arrow R Package</a>

	<span class="version">
	<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">22.0.0.9000</small>
	</span>


	<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
	<span class="navbar-toggler-icon"></span>
	</button>

	<div id="navbar" class="collapse navbar-collapse ms-3">
	<ul class="navbar-nav me-auto"><li class="nav-item"><a class="nav-link" href="../articles/arrow.html">Get started</a></li>
	<li class="active nav-item"><a class="nav-link" href="../reference/index.html">Reference</a></li>
	<li class="nav-item dropdown">
	<button class="nav-link dropdown-toggle" type="button" id="dropdown-articles" data-bs-toggle="dropdown" aria-expanded="false" aria-haspopup="true">Articles</button>
	<ul class="dropdown-menu" aria-labelledby="dropdown-articles"><li><hr class="dropdown-divider"></li>
	<li><h6 class="dropdown-header" data-toc-skip>Using the package</h6></li>
	<li><a class="dropdown-item" href="../articles/read_write.html">Reading and writing data files</a></li>
	<li><a class="dropdown-item" href="../articles/data_wrangling.html">Data analysis with dplyr syntax</a></li>
	<li><a class="dropdown-item" href="../articles/dataset.html">Working with multi-file data sets</a></li>
	<li><a class="dropdown-item" href="../articles/python.html">Integrating Arrow, Python, and R</a></li>
	<li><a class="dropdown-item" href="../articles/fs.html">Using cloud storage (S3, GCS)</a></li>
	<li><a class="dropdown-item" href="../articles/flight.html">Connecting to a Flight server</a></li>
	<li><hr class="dropdown-divider"></li>
	<li><h6 class="dropdown-header" data-toc-skip>Arrow concepts</h6></li>
	<li><a class="dropdown-item" href="../articles/data_objects.html">Data objects</a></li>
	<li><a class="dropdown-item" href="../articles/data_types.html">Data types</a></li>
	<li><a class="dropdown-item" href="../articles/metadata.html">Metadata</a></li>
	<li><hr class="dropdown-divider"></li>
	<li><h6 class="dropdown-header" data-toc-skip>Installation</h6></li>
	<li><a class="dropdown-item" href="../articles/install.html">Installing on Linux</a></li>
	<li><a class="dropdown-item" href="../articles/install_nightly.html">Installing development versions</a></li>
	<li><hr class="dropdown-divider"></li>
	<li><a class="dropdown-item" href="../articles/index.html">More articles...</a></li>
	</ul></li>
	<li class="nav-item"><a class="nav-link" href="../news/index.html">Changelog</a></li>
	</ul><form class="form-inline my-2 my-lg-0" role="search">
	<input type="search" class="form-control me-sm-2" aria-label="Toggle navigation" name="search-input" data-search-index="../search.json" id="search-input" placeholder="" autocomplete="off"></form>

	<ul class="navbar-nav"><li class="nav-item"><a class="external-link nav-link" href="https://github.com/apache/arrow/" aria-label="GitHub"><span class="fa fab fa-github fa-lg"></span></a></li>
	</ul></div>


	</div>
	</nav><div class="container template-reference-topic">
	<div class="row">
	<main id="main" class="col-md-9"><div class="page-header">

	<h1>Create a (virtual) DuckDB table from an Arrow object</h1>
	<small class="dont-index">Source: <a href="https://github.com/apache/arrow/blob/main/r/R/duckdb.R" class="external-link"><code>R/duckdb.R</code></a></small>
	<div class="d-none name"><code>to_duckdb.Rd</code></div>
	</div>

	<div class="ref-description section level2">
	<p>This will do the necessary configuration to create a (virtual) table in DuckDB
	that is backed by the Arrow object given. No data is copied or modified until
	<code><a href="https://dplyr.tidyverse.org/reference/compute.html" class="external-link">collect()</a></code> or <code><a href="https://dplyr.tidyverse.org/reference/compute.html" class="external-link">compute()</a></code> are called or a query is run against the table.</p>
	</div>

	<div class="section level2">
	<h2 id="ref-usage">Usage<a class="anchor" aria-label="anchor" href="#ref-usage"></a></h2>
	<div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">to_duckdb</span><span class="op">(</span></span>
	<span> <span class="va">.data</span>,</span>
	<span> con <span class="op">=</span> <span class="fu">arrow_duck_connection</span><span class="op">(</span><span class="op">)</span>,</span>
	<span> table_name <span class="op">=</span> <span class="fu">unique_arrow_tablename</span><span class="op">(</span><span class="op">)</span>,</span>
	<span> auto_disconnect <span class="op">=</span> <span class="cn">TRUE</span></span>
	<span><span class="op">)</span></span></code></pre></div>
	</div>

	<div class="section level2">
	<h2 id="arguments">Arguments<a class="anchor" aria-label="anchor" href="#arguments"></a></h2>


	<dl><dt id="arg--data">.data<a class="anchor" aria-label="anchor" href="#arg--data"></a></dt>
	<dd><p>the Arrow object (e.g. Dataset, Table) to use for the DuckDB table</p></dd>


	<dt id="arg-con">con<a class="anchor" aria-label="anchor" href="#arg-con"></a></dt>
	<dd><p>a DuckDB connection to use (default will create one and store it
	in <code>options("arrow_duck_con")</code>)</p></dd>


	<dt id="arg-table-name">table_name<a class="anchor" aria-label="anchor" href="#arg-table-name"></a></dt>
	<dd><p>a name to use in DuckDB for this object. The default is a
	unique string <code>"arrow_"</code> followed by numbers.</p></dd>


	<dt id="arg-auto-disconnect">auto_disconnect<a class="anchor" aria-label="anchor" href="#arg-auto-disconnect"></a></dt>
	<dd><p>should the table be automatically cleaned up when the
	resulting object is removed (and garbage collected)? Default: <code>TRUE</code></p></dd>

	</dl></div>
	<div class="section level2">
	<h2 id="value">Value<a class="anchor" aria-label="anchor" href="#value"></a></h2>
	<p>A <code>tbl</code> of the new table in DuckDB</p>
	</div>
	<div class="section level2">
	<h2 id="details">Details<a class="anchor" aria-label="anchor" href="#details"></a></h2>
	<p>The result is a dbplyr-compatible object that can be used in d(b)plyr pipelines.</p>
	<p>If <code>auto_disconnect = TRUE</code>, the DuckDB table that is created will be configured
	to be unregistered when the <code>tbl</code> object is garbage collected. This is helpful
	if you don't want to have extra table objects in DuckDB after you've finished
	using them.</p>
	</div>

	<div class="section level2">
	<h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-examples"></a></h2>
	<div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span><span class="kw"><a href="https://rdrr.io/r/base/library.html" class="external-link">library</a></span><span class="op">(</span><span class="va"><a href="https://dplyr.tidyverse.org" class="external-link">dplyr</a></span><span class="op">)</span></span></span>
	<span class="r-in"><span></span></span>
	<span class="r-in"><span><span class="va">ds</span> <span class="op"><-</span> <span class="va">InMemoryDataset</span><span class="op">$</span><span class="fu">create</span><span class="op">(</span><span class="va">mtcars</span><span class="op">)</span></span></span>
	<span class="r-in"><span></span></span>
	<span class="r-in"><span><span class="va">ds</span> <span class="op">\|></span></span></span>
	<span class="r-in"><span> <span class="fu"><a href="https://dplyr.tidyverse.org/reference/filter.html" class="external-link">filter</a></span><span class="op">(</span><span class="va">mpg</span> <span class="op"><</span> <span class="fl">30</span><span class="op">)</span> <span class="op">\|></span></span></span>
	<span class="r-in"><span> <span class="fu"><a href="https://dplyr.tidyverse.org/reference/group_by.html" class="external-link">group_by</a></span><span class="op">(</span><span class="va">cyl</span><span class="op">)</span> <span class="op">\|></span></span></span>
	<span class="r-in"><span> <span class="fu">to_duckdb</span><span class="op">(</span><span class="op">)</span> <span class="op">\|></span></span></span>
	<span class="r-in"><span> <span class="fu"><a href="https://dplyr.tidyverse.org/reference/slice.html" class="external-link">slice_min</a></span><span class="op">(</span><span class="va">disp</span><span class="op">)</span></span></span>
	<span class="r-out co"><span class="r-pr">#></span> <span style="color: #949494;"># Source: SQL [?? x 11]</span></span>
	<span class="r-out co"><span class="r-pr">#></span> <span style="color: #949494;"># Database: DuckDB 1.4.1 [unknown@Linux 6.11.0-1018-azure:R 4.5.2/:memory:]</span></span>
	<span class="r-out co"><span class="r-pr">#></span> <span style="color: #949494;"># Groups: cyl</span></span>
	<span class="r-out co"><span class="r-pr">#></span> mpg cyl disp hp drat wt qsec vs am gear carb</span>
	<span class="r-out co"><span class="r-pr">#></span> <span style="color: #949494; font-style: italic;"><dbl></span> <span style="color: #949494; font-style: italic;"><dbl></span> <span style="color: #949494; font-style: italic;"><dbl></span> <span style="color: #949494; font-style: italic;"><dbl></span> <span style="color: #949494; font-style: italic;"><dbl></span> <span style="color: #949494; font-style: italic;"><dbl></span> <span style="color: #949494; font-style: italic;"><dbl></span> <span style="color: #949494; font-style: italic;"><dbl></span> <span style="color: #949494; font-style: italic;"><dbl></span> <span style="color: #949494; font-style: italic;"><dbl></span> <span style="color: #949494; font-style: italic;"><dbl></span></span>
	<span class="r-out co"><span class="r-pr">#></span> <span style="color: #BCBCBC;">1</span> 16.4 8 276. 180 3.07 4.07 17.4 0 0 3 3</span>
	<span class="r-out co"><span class="r-pr">#></span> <span style="color: #BCBCBC;">2</span> 17.3 8 276. 180 3.07 3.73 17.6 0 0 3 3</span>
	<span class="r-out co"><span class="r-pr">#></span> <span style="color: #BCBCBC;">3</span> 15.2 8 276. 180 3.07 3.78 18 0 0 3 3</span>
	<span class="r-out co"><span class="r-pr">#></span> <span style="color: #BCBCBC;">4</span> 27.3 4 79 66 4.08 1.94 18.9 1 1 4 1</span>
	<span class="r-out co"><span class="r-pr">#></span> <span style="color: #BCBCBC;">5</span> 19.7 6 145 175 3.62 2.77 15.5 0 1 5 6</span>
	</code></pre></div>
	</div>
	</main><aside class="col-md-3"><nav id="toc" aria-label="Table of contents"><h2>On this page</h2>
	</nav></aside></div>


	<footer><div class="pkgdown-footer-left">
	<p><a href="https://arrow.apache.org/docs/r/versions.html">Older versions of these docs</a></p>
	</div>

	<div class="pkgdown-footer-right">
	<p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.1.3.</p>
	</div>

	</footer></div>





	</body></html>