docs/11.0/r/reference/write_feather.html - arrow-site - Git at Google

 <!DOCTYPE html>
 <!-- Generated by pkgdown: do not edit by hand --><html lang="en"><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"><meta name="description" content="Feather provides binary columnar serialization for data frames.
 It is designed to make reading and writing data frames efficient,
 and to make sharing data across data analysis languages easy.
 write_feather() can write both the Feather Version 1 (V1),
 a legacy version available starting in 2016, and the Version 2 (V2),
 which is the Apache Arrow IPC file format.
 The default version is V2.
 V1 files are distinct from Arrow IPC files and lack many feathures,
 such as the ability to store all Arrow data tyeps, and compression support.
 write_ipc_file() can only write V2 files."><title>Write a Feather file (an Arrow IPC file) — write_feather • Arrow R Package</title><!-- favicons --><link rel="icon" type="image/png" sizes="16x16" href="../favicon-16x16.png"><link rel="icon" type="image/png" sizes="32x32" href="../favicon-32x32.png"><link rel="apple-touch-icon" type="image/png" sizes="180x180" href="../apple-touch-icon.png"><link rel="apple-touch-icon" type="image/png" sizes="120x120" href="../apple-touch-icon-120x120.png"><link rel="apple-touch-icon" type="image/png" sizes="76x76" href="../apple-touch-icon-76x76.png"><link rel="apple-touch-icon" type="image/png" sizes="60x60" href="../apple-touch-icon-60x60.png"><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.2.2/bootstrap.min.css" rel="stylesheet"><script src="../deps/bootstrap-5.2.2/bootstrap.bundle.min.js"></script><!-- Font Awesome icons --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/all.min.css" integrity="sha256-mmgLkCYLUQbXn0B1SRqzHar6dCnv9oZFPEC1g1cwlkk=" crossorigin="anonymous"><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/v4-shims.min.css" integrity="sha256-wZjR52fzng1pJHwx4aV2AO3yyTOXrcDW7jBpJtTwVxw=" crossorigin="anonymous"><!-- bootstrap-toc --><script src="https://cdn.jsdelivr.net/gh/afeld/bootstrap-toc@v1.0.1/dist/bootstrap-toc.min.js" integrity="sha256-4veVQbu7//Lk5TSmc7YV48MxtMy98e26cf5MrgZYnwo=" crossorigin="anonymous"></script><!-- headroom.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/headroom.min.js" integrity="sha256-AsUX4SJE1+yuDu5+mAVzJbuYNPHj/WroHuZ8Ir/CkE0=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/jQuery.headroom.min.js" integrity="sha256-ZX/yNShbjqsohH1k95liqY9Gd8uOiE1S4vZc+9KQ1K4=" crossorigin="anonymous"></script><!-- clipboard.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.6/clipboard.min.js" integrity="sha256-inc5kl9MA1hkeYUt+EC3BhlIgyp/2jDIyBLS6k3UxPI=" crossorigin="anonymous"></script><!-- search --><script src="https://cdnjs.cloudflare.com/ajax/libs/fuse.js/6.4.6/fuse.js" integrity="sha512-zv6Ywkjyktsohkbp9bb45V6tEMoWhzFzXis+LrMehmJZZSys19Yxf1dopHx7WzIKxr5tK2dVcYmaCk2uqdjF4A==" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/autocomplete.js/0.38.0/autocomplete.jquery.min.js" integrity="sha512-GU9ayf+66Xx2TmpxqJpliWbT5PiGYxpaG8rfnBEk1LL8l1KGkRShhngwdXK1UgqhAzWpZHSiYPc09/NwDQIGyg==" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mark.js/8.11.1/mark.min.js" integrity="sha512-5CYOlHXGh6QpOFA/TeTylKLWfB3ftPsde7AnmhuitiTX4K5SqCLBeKro6sPS8ilsz1Q4NRx3v8Ko2IBiszzdww==" crossorigin="anonymous"></script><!-- pkgdown --><script src="../pkgdown.js"></script><script src="../extra.js"></script><meta property="og:title" content="Write a Feather file (an Arrow IPC file) — write_feather"><meta property="og:description" content="Feather provides binary columnar serialization for data frames.
 It is designed to make reading and writing data frames efficient,
 and to make sharing data across data analysis languages easy.
 write_feather() can write both the Feather Version 1 (V1),
 a legacy version available starting in 2016, and the Version 2 (V2),
 which is the Apache Arrow IPC file format.
 The default version is V2.
 V1 files are distinct from Arrow IPC files and lack many feathures,
 such as the ability to store all Arrow data tyeps, and compression support.
 write_ipc_file() can only write V2 files."><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"><meta name="twitter:card" content="summary_large_image"><meta name="twitter:creator" content="@apachearrow"><meta name="twitter:site" content="@apachearrow"><!-- mathjax --><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js" integrity="sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA=" crossorigin="anonymous"></script><!--[if lt IE 9]>
 <script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
 <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
 <![endif]--><!-- 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 --></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="">11.0.0</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">
   <a href="#" class="nav-link dropdown-toggle" data-bs-toggle="dropdown" role="button" aria-expanded="false" aria-haspopup="true" id="dropdown-articles">Articles</a>
   <div class="dropdown-menu" aria-labelledby="dropdown-articles">
     <h6 class="dropdown-header" data-toc-skip>Using the package</h6>
     <a class="dropdown-item" href="../articles/read_write.html">Reading and writing data files</a>
     <a class="dropdown-item" href="../articles/data_wrangling.html">Data analysis with dplyr syntax</a>
     <a class="dropdown-item" href="../articles/dataset.html">Working with multi-file data sets</a>
     <a class="dropdown-item" href="../articles/python.html">Integrating Arrow, Python, and R</a>
     <a class="dropdown-item" href="../articles/fs.html">Using cloud storage (S3, GCS)</a>
     <a class="dropdown-item" href="../articles/flight.html">Connecting to a Flight server</a>
     <div class="dropdown-divider"></div>
     <h6 class="dropdown-header" data-toc-skip>Arrow concepts</h6>
     <a class="dropdown-item" href="../articles/data_objects.html">Data objects</a>
     <a class="dropdown-item" href="../articles/data_types.html">Data types</a>
     <a class="dropdown-item" href="../articles/metadata.html">Metadata</a>
     <div class="dropdown-divider"></div>
     <h6 class="dropdown-header" data-toc-skip>Installation</h6>
     <a class="dropdown-item" href="../articles/install.html">Installing on Linux</a>
     <a class="dropdown-item" href="../articles/install_nightly.html">Installing development versions</a>
     <div class="dropdown-divider"></div>
     <a class="dropdown-item" href="../articles/index.html">More articles...</a>
   </div>
 </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="Search for" autocomplete="off"></form>

       <ul class="navbar-nav"></ul></div>


   </div>
 </nav><div class="container template-reference-topic">
 <div class="row">
   <main id="main" class="col-md-9"><div class="page-header">
       <img src="" class="logo" alt=""><h1>Write a Feather file (an Arrow IPC file)</h1>
       <small class="dont-index">Source: <a href="https://github.com/apache/arrow/blob/master/r/R/feather.R" class="external-link"><code>R/feather.R</code></a></small>
       <div class="d-none name"><code>write_feather.Rd</code></div>
     </div>

     <div class="ref-description section level2">
     <p>Feather provides binary columnar serialization for data frames.
 It is designed to make reading and writing data frames efficient,
 and to make sharing data across data analysis languages easy.
 <code>write_feather()</code> can write both the Feather Version 1 (V1),
 a legacy version available starting in 2016, and the Version 2 (V2),
 which is the Apache Arrow IPC file format.
 The default version is V2.
 V1 files are distinct from Arrow IPC files and lack many feathures,
 such as the ability to store all Arrow data tyeps, and compression support.
 <code>write_ipc_file()</code> can only write V2 files.</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">write_feather</span><span class="op">(</span></span>
 <span>  <span class="va">x</span>,</span>
 <span>  <span class="va">sink</span>,</span>
 <span>  version <span class="op">=</span> <span class="fl">2</span>,</span>
 <span>  chunk_size <span class="op">=</span> <span class="fl">65536L</span>,</span>
 <span>  compression <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"default"</span>, <span class="st">"lz4"</span>, <span class="st">"lz4_frame"</span>, <span class="st">"uncompressed"</span>, <span class="st">"zstd"</span><span class="op">)</span>,</span>
 <span>  compression_level <span class="op">=</span> <span class="cn">NULL</span></span>
 <span><span class="op">)</span></span>
 <span></span>
 <span><span class="fu">write_ipc_file</span><span class="op">(</span></span>
 <span>  <span class="va">x</span>,</span>
 <span>  <span class="va">sink</span>,</span>
 <span>  chunk_size <span class="op">=</span> <span class="fl">65536L</span>,</span>
 <span>  compression <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"default"</span>, <span class="st">"lz4"</span>, <span class="st">"lz4_frame"</span>, <span class="st">"uncompressed"</span>, <span class="st">"zstd"</span><span class="op">)</span>,</span>
 <span>  compression_level <span class="op">=</span> <span class="cn">NULL</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>x</dt>
 <dd><p><code>data.frame</code>, <a href="RecordBatch.html">RecordBatch</a>, or <a href="Table.html">Table</a></p></dd>


 <dt>sink</dt>
 <dd><p>A string file path, URI, or <a href="OutputStream.html">OutputStream</a>, or path in a file
 system (<code>SubTreeFileSystem</code>)</p></dd>


 <dt>version</dt>
 <dd><p>integer Feather file version, Version 1 or Version 2. Version 2 is the default.</p></dd>


 <dt>chunk_size</dt>
 <dd><p>For V2 files, the number of rows that each chunk of data
 should have in the file. Use a smaller <code>chunk_size</code> when you need faster
 random row access. Default is 64K. This option is not supported for V1.</p></dd>


 <dt>compression</dt>
 <dd><p>Name of compression codec to use, if any. Default is
 "lz4" if LZ4 is available in your build of the Arrow C++ library, otherwise
 "uncompressed". "zstd" is the other available codec and generally has better
 compression ratios in exchange for slower read and write performance.
 "lz4" is shorthand for the "lz4_frame" codec.
 See <code><a href="codec_is_available.html">codec_is_available()</a></code> for details.
 <code>TRUE</code> and <code>FALSE</code> can also be used in place of "default" and "uncompressed".
 This option is not supported for V1.</p></dd>


 <dt>compression_level</dt>
 <dd><p>If <code>compression</code> is "zstd", you may
 specify an integer compression level. If omitted, the compression codec's
 default compression level is used.</p></dd>

 </dl></div>
     <div class="section level2">
     <h2 id="value">Value<a class="anchor" aria-label="anchor" href="#value"></a></h2>


 <p>The input <code>x</code>, invisibly. Note that if <code>sink</code> is an <a href="OutputStream.html">OutputStream</a>,
 the stream will be left open.</p>
     </div>
     <div class="section level2">
     <h2 id="see-also">See also<a class="anchor" aria-label="anchor" href="#see-also"></a></h2>
     <div class="dont-index"><p><a href="RecordBatchWriter.html">RecordBatchWriter</a> for lower-level access to writing Arrow IPC data.</p>
 <p><a href="Schema.html">Schema</a> for information about schemas and metadata handling.</p></div>
     </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="co"># We recommend the ".arrow" extension for Arrow IPC files (Feather V2).</span></span></span>
 <span class="r-in"><span><span class="va">tf1</span> <span class="op">&lt;-</span> <span class="fu"><a href="https://rdrr.io/r/base/tempfile.html" class="external-link">tempfile</a></span><span class="op">(</span>fileext <span class="op">=</span> <span class="st">".feather"</span><span class="op">)</span></span></span>
 <span class="r-in"><span><span class="va">tf2</span> <span class="op">&lt;-</span> <span class="fu"><a href="https://rdrr.io/r/base/tempfile.html" class="external-link">tempfile</a></span><span class="op">(</span>fileext <span class="op">=</span> <span class="st">".arrow"</span><span class="op">)</span></span></span>
 <span class="r-in"><span><span class="va">tf3</span> <span class="op">&lt;-</span> <span class="fu"><a href="https://rdrr.io/r/base/tempfile.html" class="external-link">tempfile</a></span><span class="op">(</span>fileext <span class="op">=</span> <span class="st">".arrow"</span><span class="op">)</span></span></span>
 <span class="r-in"><span><span class="fu"><a href="https://rdrr.io/r/base/on.exit.html" class="external-link">on.exit</a></span><span class="op">(</span><span class="op">{</span></span></span>
 <span class="r-in"><span>  <span class="fu"><a href="https://rdrr.io/r/base/unlink.html" class="external-link">unlink</a></span><span class="op">(</span><span class="va">tf1</span><span class="op">)</span></span></span>
 <span class="r-in"><span>  <span class="fu"><a href="https://rdrr.io/r/base/unlink.html" class="external-link">unlink</a></span><span class="op">(</span><span class="va">tf2</span><span class="op">)</span></span></span>
 <span class="r-in"><span>  <span class="fu"><a href="https://rdrr.io/r/base/unlink.html" class="external-link">unlink</a></span><span class="op">(</span><span class="va">tf3</span><span class="op">)</span></span></span>
 <span class="r-in"><span><span class="op">}</span><span class="op">)</span></span></span>
 <span class="r-in"><span><span class="fu">write_feather</span><span class="op">(</span><span class="va">mtcars</span>, <span class="va">tf1</span>, version <span class="op">=</span> <span class="fl">1</span><span class="op">)</span></span></span>
 <span class="r-in"><span><span class="fu">write_feather</span><span class="op">(</span><span class="va">mtcars</span>, <span class="va">tf2</span><span class="op">)</span></span></span>
 <span class="r-in"><span><span class="fu">write_ipc_file</span><span class="op">(</span><span class="va">mtcars</span>, <span class="va">tf3</span><span class="op">)</span></span></span>
 </code></pre></div>
     </div>
   </main><aside class="col-md-3"><nav id="toc"><h2>On this page</h2>
     </nav></aside></div>


     <footer><div class="pkgdown-footer-left">
   <p></p><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></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p>
 </div>

     </footer></div>


   </body></html>
	<!DOCTYPE html>
	<!-- Generated by pkgdown: do not edit by hand --><html lang="en"><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"><meta name="description" content="Feather provides binary columnar serialization for data frames.
	It is designed to make reading and writing data frames efficient,
	and to make sharing data across data analysis languages easy.
	write_feather() can write both the Feather Version 1 (V1),
	a legacy version available starting in 2016, and the Version 2 (V2),
	which is the Apache Arrow IPC file format.
	The default version is V2.
	V1 files are distinct from Arrow IPC files and lack many feathures,
	such as the ability to store all Arrow data tyeps, and compression support.
	write_ipc_file() can only write V2 files."><title>Write a Feather file (an Arrow IPC file) — write_feather • Arrow R Package</title><!-- favicons --><link rel="icon" type="image/png" sizes="16x16" href="../favicon-16x16.png"><link rel="icon" type="image/png" sizes="32x32" href="../favicon-32x32.png"><link rel="apple-touch-icon" type="image/png" sizes="180x180" href="../apple-touch-icon.png"><link rel="apple-touch-icon" type="image/png" sizes="120x120" href="../apple-touch-icon-120x120.png"><link rel="apple-touch-icon" type="image/png" sizes="76x76" href="../apple-touch-icon-76x76.png"><link rel="apple-touch-icon" type="image/png" sizes="60x60" href="../apple-touch-icon-60x60.png"><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.2.2/bootstrap.min.css" rel="stylesheet"><script src="../deps/bootstrap-5.2.2/bootstrap.bundle.min.js"></script><!-- Font Awesome icons --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/all.min.css" integrity="sha256-mmgLkCYLUQbXn0B1SRqzHar6dCnv9oZFPEC1g1cwlkk=" crossorigin="anonymous"><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/v4-shims.min.css" integrity="sha256-wZjR52fzng1pJHwx4aV2AO3yyTOXrcDW7jBpJtTwVxw=" crossorigin="anonymous"><!-- bootstrap-toc --><script src="https://cdn.jsdelivr.net/gh/afeld/bootstrap-toc@v1.0.1/dist/bootstrap-toc.min.js" integrity="sha256-4veVQbu7//Lk5TSmc7YV48MxtMy98e26cf5MrgZYnwo=" crossorigin="anonymous"></script><!-- headroom.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/headroom.min.js" integrity="sha256-AsUX4SJE1+yuDu5+mAVzJbuYNPHj/WroHuZ8Ir/CkE0=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/jQuery.headroom.min.js" integrity="sha256-ZX/yNShbjqsohH1k95liqY9Gd8uOiE1S4vZc+9KQ1K4=" crossorigin="anonymous"></script><!-- clipboard.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.6/clipboard.min.js" integrity="sha256-inc5kl9MA1hkeYUt+EC3BhlIgyp/2jDIyBLS6k3UxPI=" crossorigin="anonymous"></script><!-- search --><script src="https://cdnjs.cloudflare.com/ajax/libs/fuse.js/6.4.6/fuse.js" integrity="sha512-zv6Ywkjyktsohkbp9bb45V6tEMoWhzFzXis+LrMehmJZZSys19Yxf1dopHx7WzIKxr5tK2dVcYmaCk2uqdjF4A==" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/autocomplete.js/0.38.0/autocomplete.jquery.min.js" integrity="sha512-GU9ayf+66Xx2TmpxqJpliWbT5PiGYxpaG8rfnBEk1LL8l1KGkRShhngwdXK1UgqhAzWpZHSiYPc09/NwDQIGyg==" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mark.js/8.11.1/mark.min.js" integrity="sha512-5CYOlHXGh6QpOFA/TeTylKLWfB3ftPsde7AnmhuitiTX4K5SqCLBeKro6sPS8ilsz1Q4NRx3v8Ko2IBiszzdww==" crossorigin="anonymous"></script><!-- pkgdown --><script src="../pkgdown.js"></script><script src="../extra.js"></script><meta property="og:title" content="Write a Feather file (an Arrow IPC file) — write_feather"><meta property="og:description" content="Feather provides binary columnar serialization for data frames.
	It is designed to make reading and writing data frames efficient,
	and to make sharing data across data analysis languages easy.
	write_feather() can write both the Feather Version 1 (V1),
	a legacy version available starting in 2016, and the Version 2 (V2),
	which is the Apache Arrow IPC file format.
	The default version is V2.
	V1 files are distinct from Arrow IPC files and lack many feathures,
	such as the ability to store all Arrow data tyeps, and compression support.
	write_ipc_file() can only write V2 files."><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"><meta name="twitter:card" content="summary_large_image"><meta name="twitter:creator" content="@apachearrow"><meta name="twitter:site" content="@apachearrow"><!-- mathjax --><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js" integrity="sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA=" crossorigin="anonymous"></script><!--[if lt IE 9]>
	<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
	<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
	<![endif]--><!-- 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 --></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="">11.0.0</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">
	<a href="#" class="nav-link dropdown-toggle" data-bs-toggle="dropdown" role="button" aria-expanded="false" aria-haspopup="true" id="dropdown-articles">Articles</a>
	<div class="dropdown-menu" aria-labelledby="dropdown-articles">
	<h6 class="dropdown-header" data-toc-skip>Using the package</h6>
	<a class="dropdown-item" href="../articles/read_write.html">Reading and writing data files</a>
	<a class="dropdown-item" href="../articles/data_wrangling.html">Data analysis with dplyr syntax</a>
	<a class="dropdown-item" href="../articles/dataset.html">Working with multi-file data sets</a>
	<a class="dropdown-item" href="../articles/python.html">Integrating Arrow, Python, and R</a>
	<a class="dropdown-item" href="../articles/fs.html">Using cloud storage (S3, GCS)</a>
	<a class="dropdown-item" href="../articles/flight.html">Connecting to a Flight server</a>
	<div class="dropdown-divider"></div>
	<h6 class="dropdown-header" data-toc-skip>Arrow concepts</h6>
	<a class="dropdown-item" href="../articles/data_objects.html">Data objects</a>
	<a class="dropdown-item" href="../articles/data_types.html">Data types</a>
	<a class="dropdown-item" href="../articles/metadata.html">Metadata</a>
	<div class="dropdown-divider"></div>
	<h6 class="dropdown-header" data-toc-skip>Installation</h6>
	<a class="dropdown-item" href="../articles/install.html">Installing on Linux</a>
	<a class="dropdown-item" href="../articles/install_nightly.html">Installing development versions</a>
	<div class="dropdown-divider"></div>
	<a class="dropdown-item" href="../articles/index.html">More articles...</a>
	</div>
	</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="Search for" autocomplete="off"></form>

	<ul class="navbar-nav"></ul></div>


	</div>
	</nav><div class="container template-reference-topic">
	<div class="row">
	<main id="main" class="col-md-9"><div class="page-header">
	<img src="" class="logo" alt=""><h1>Write a Feather file (an Arrow IPC file)</h1>
	<small class="dont-index">Source: <a href="https://github.com/apache/arrow/blob/master/r/R/feather.R" class="external-link"><code>R/feather.R</code></a></small>
	<div class="d-none name"><code>write_feather.Rd</code></div>
	</div>

	<div class="ref-description section level2">
	<p>Feather provides binary columnar serialization for data frames.
	It is designed to make reading and writing data frames efficient,
	and to make sharing data across data analysis languages easy.
	<code>write_feather()</code> can write both the Feather Version 1 (V1),
	a legacy version available starting in 2016, and the Version 2 (V2),
	which is the Apache Arrow IPC file format.
	The default version is V2.
	V1 files are distinct from Arrow IPC files and lack many feathures,
	such as the ability to store all Arrow data tyeps, and compression support.
	<code>write_ipc_file()</code> can only write V2 files.</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">write_feather</span><span class="op">(</span></span>
	<span> <span class="va">x</span>,</span>
	<span> <span class="va">sink</span>,</span>
	<span> version <span class="op">=</span> <span class="fl">2</span>,</span>
	<span> chunk_size <span class="op">=</span> <span class="fl">65536L</span>,</span>
	<span> compression <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"default"</span>, <span class="st">"lz4"</span>, <span class="st">"lz4_frame"</span>, <span class="st">"uncompressed"</span>, <span class="st">"zstd"</span><span class="op">)</span>,</span>
	<span> compression_level <span class="op">=</span> <span class="cn">NULL</span></span>
	<span><span class="op">)</span></span>
	<span></span>
	<span><span class="fu">write_ipc_file</span><span class="op">(</span></span>
	<span> <span class="va">x</span>,</span>
	<span> <span class="va">sink</span>,</span>
	<span> chunk_size <span class="op">=</span> <span class="fl">65536L</span>,</span>
	<span> compression <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"default"</span>, <span class="st">"lz4"</span>, <span class="st">"lz4_frame"</span>, <span class="st">"uncompressed"</span>, <span class="st">"zstd"</span><span class="op">)</span>,</span>
	<span> compression_level <span class="op">=</span> <span class="cn">NULL</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>x</dt>
	<dd><p><code>data.frame</code>, <a href="RecordBatch.html">RecordBatch</a>, or <a href="Table.html">Table</a></p></dd>


	<dt>sink</dt>
	<dd><p>A string file path, URI, or <a href="OutputStream.html">OutputStream</a>, or path in a file
	system (<code>SubTreeFileSystem</code>)</p></dd>


	<dt>version</dt>
	<dd><p>integer Feather file version, Version 1 or Version 2. Version 2 is the default.</p></dd>


	<dt>chunk_size</dt>
	<dd><p>For V2 files, the number of rows that each chunk of data
	should have in the file. Use a smaller <code>chunk_size</code> when you need faster
	random row access. Default is 64K. This option is not supported for V1.</p></dd>


	<dt>compression</dt>
	<dd><p>Name of compression codec to use, if any. Default is
	"lz4" if LZ4 is available in your build of the Arrow C++ library, otherwise
	"uncompressed". "zstd" is the other available codec and generally has better
	compression ratios in exchange for slower read and write performance.
	"lz4" is shorthand for the "lz4_frame" codec.
	See <code><a href="codec_is_available.html">codec_is_available()</a></code> for details.
	<code>TRUE</code> and <code>FALSE</code> can also be used in place of "default" and "uncompressed".
	This option is not supported for V1.</p></dd>


	<dt>compression_level</dt>
	<dd><p>If <code>compression</code> is "zstd", you may
	specify an integer compression level. If omitted, the compression codec's
	default compression level is used.</p></dd>

	</dl></div>
	<div class="section level2">
	<h2 id="value">Value<a class="anchor" aria-label="anchor" href="#value"></a></h2>


	<p>The input <code>x</code>, invisibly. Note that if <code>sink</code> is an <a href="OutputStream.html">OutputStream</a>,
	the stream will be left open.</p>
	</div>
	<div class="section level2">
	<h2 id="see-also">See also<a class="anchor" aria-label="anchor" href="#see-also"></a></h2>
	<div class="dont-index"><p><a href="RecordBatchWriter.html">RecordBatchWriter</a> for lower-level access to writing Arrow IPC data.</p>
	<p><a href="Schema.html">Schema</a> for information about schemas and metadata handling.</p></div>
	</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="co"># We recommend the ".arrow" extension for Arrow IPC files (Feather V2).</span></span></span>
	<span class="r-in"><span><span class="va">tf1</span> <span class="op"><-</span> <span class="fu"><a href="https://rdrr.io/r/base/tempfile.html" class="external-link">tempfile</a></span><span class="op">(</span>fileext <span class="op">=</span> <span class="st">".feather"</span><span class="op">)</span></span></span>
	<span class="r-in"><span><span class="va">tf2</span> <span class="op"><-</span> <span class="fu"><a href="https://rdrr.io/r/base/tempfile.html" class="external-link">tempfile</a></span><span class="op">(</span>fileext <span class="op">=</span> <span class="st">".arrow"</span><span class="op">)</span></span></span>
	<span class="r-in"><span><span class="va">tf3</span> <span class="op"><-</span> <span class="fu"><a href="https://rdrr.io/r/base/tempfile.html" class="external-link">tempfile</a></span><span class="op">(</span>fileext <span class="op">=</span> <span class="st">".arrow"</span><span class="op">)</span></span></span>
	<span class="r-in"><span><span class="fu"><a href="https://rdrr.io/r/base/on.exit.html" class="external-link">on.exit</a></span><span class="op">(</span><span class="op">{</span></span></span>
	<span class="r-in"><span> <span class="fu"><a href="https://rdrr.io/r/base/unlink.html" class="external-link">unlink</a></span><span class="op">(</span><span class="va">tf1</span><span class="op">)</span></span></span>
	<span class="r-in"><span> <span class="fu"><a href="https://rdrr.io/r/base/unlink.html" class="external-link">unlink</a></span><span class="op">(</span><span class="va">tf2</span><span class="op">)</span></span></span>
	<span class="r-in"><span> <span class="fu"><a href="https://rdrr.io/r/base/unlink.html" class="external-link">unlink</a></span><span class="op">(</span><span class="va">tf3</span><span class="op">)</span></span></span>
	<span class="r-in"><span><span class="op">}</span><span class="op">)</span></span></span>
	<span class="r-in"><span><span class="fu">write_feather</span><span class="op">(</span><span class="va">mtcars</span>, <span class="va">tf1</span>, version <span class="op">=</span> <span class="fl">1</span><span class="op">)</span></span></span>
	<span class="r-in"><span><span class="fu">write_feather</span><span class="op">(</span><span class="va">mtcars</span>, <span class="va">tf2</span><span class="op">)</span></span></span>
	<span class="r-in"><span><span class="fu">write_ipc_file</span><span class="op">(</span><span class="va">mtcars</span>, <span class="va">tf3</span><span class="op">)</span></span></span>
	</code></pre></div>
	</div>
	</main><aside class="col-md-3"><nav id="toc"><h2>On this page</h2>
	</nav></aside></div>


	<footer><div class="pkgdown-footer-left">
	<p></p><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></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p>
	</div>

	</footer></div>





	</body></html>