contributor-guide/updating-datafusion-version.html - datafusion-java - Git at Google


 <!DOCTYPE html>


 <html lang="en" data-content_root="../" >

   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />

     <title>Updating the DataFusion / protobuf schema version &#8212; Apache DataFusion Java  documentation</title>


   <script data-cfasync="false">
     document.documentElement.dataset.mode = localStorage.getItem("mode") || "";
     document.documentElement.dataset.theme = localStorage.getItem("theme") || "";
   </script>
   <!--
     this give us a css class that will be invisible only if js is disabled
   -->
   <noscript>
     <style>
       .pst-js-only { display: none !important; }

     </style>
   </noscript>

   <!-- Loaded before other Sphinx assets -->
   <link href="../_static/styles/theme.css?digest=8878045cc6db502f8baf" rel="stylesheet" />
 <link href="../_static/styles/pydata-sphinx-theme.css?digest=8878045cc6db502f8baf" rel="stylesheet" />

     <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=8f2a1f02" />

   <!-- So that users can add custom icons -->
   <script src="../_static/scripts/fontawesome.js?digest=8878045cc6db502f8baf"></script>
   <!-- Pre-loaded scripts that we'll load fully later -->
   <link rel="preload" as="script" href="../_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf" />
 <link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf" />

     <script src="../_static/documentation_options.js?v=5929fcd5"></script>
     <script src="../_static/doctools.js?v=9a2dae69"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script>DOCUMENTATION_OPTIONS.pagename = 'contributor-guide/updating-datafusion-version';</script>
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" />
     <link rel="prev" title="Releasing" href="releasing.html" />
   <meta name="viewport" content="width=device-width, initial-scale=1"/>
   <meta name="docsearch:language" content="en"/>
   <meta name="docsearch:version" content="" />
   </head>


   <body data-bs-spy="scroll" data-bs-target=".bd-toc-nav" data-offset="180" data-bs-root-margin="0px 0px -60%" data-default-mode="">


   <div id="pst-skip-link" class="skip-link d-print-none"><a href="#main-content">Skip to main content</a></div>

   <div id="pst-scroll-pixel-helper"></div>

   <button type="button" class="btn rounded-pill" id="pst-back-to-top">
     <i class="fa-solid fa-arrow-up"></i>Back to top</button>


   <dialog id="pst-search-dialog">

 <form class="bd-search d-flex align-items-center"
       action="../search.html"
       method="get">
   <i class="fa-solid fa-magnifying-glass"></i>
   <input type="search"
          class="form-control"
          name="q"
          placeholder="Search the docs ..."
          aria-label="Search the docs ..."
          autocomplete="off"
          autocorrect="off"
          autocapitalize="off"
          spellcheck="false"/>
   <span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd>K</kbd></span>
 </form>
   </dialog>

   <div class="pst-async-banner-revealer d-none">
   <aside id="bd-header-version-warning" class="d-none d-print-none" aria-label="Version warning"></aside>
 </div>


     <header class="bd-header navbar navbar-expand-lg bd-navbar d-print-none">
 <div class="bd-header__inner bd-page-width">
   <button class="pst-navbar-icon sidebar-toggle primary-toggle" aria-label="Site navigation">
     <span class="fa-solid fa-bars"></span>
   </button>


   <div class="col-lg-3 navbar-header-items__start">

       <div class="navbar-item">


 <a class="navbar-brand logo" href="../index.html">


     <p class="title logo__title">Apache DataFusion Java  documentation</p>

 </a></div>

   </div>

   <div class="col-lg-9 navbar-header-items">

     <div class="me-auto navbar-header-items__center">

         <div class="navbar-item">
 <nav>
   <ul class="bd-navbar-elements navbar-nav">

 <li class="nav-item ">
   <a class="nav-link nav-external" href="https://github.com/apache/datafusion-java">
     GitHub Repository
   </a>
 </li>


 <li class="nav-item ">
   <a class="nav-link nav-external" href="https://github.com/apache/datafusion-java/issues">
     Issue Tracker
   </a>
 </li>


 <li class="nav-item ">
   <a class="nav-link nav-external" href="https://datafusion.apache.org/">
     Apache DataFusion
   </a>
 </li>


 <li class="nav-item ">
   <a class="nav-link nav-external" href="https://github.com/apache/datafusion/blob/main/CODE_OF_CONDUCT.md">
     Code of Conduct
   </a>
 </li>


 <li class="nav-item ">
   <a class="nav-link nav-internal" href="../user-guide/index.html">
     User Guide
   </a>
 </li>

             <li class="nav-item dropdown">
                 <button class="btn dropdown-toggle nav-item" type="button"
                 data-bs-toggle="dropdown" aria-expanded="false"
                 aria-controls="pst-nav-more-links">
                     More
                 </button>
                 <ul id="pst-nav-more-links" class="dropdown-menu">

 <li class=" current active">
   <a class="nav-link dropdown-item nav-internal" href="index.html">
     Contributor Guide
   </a>
 </li>

                 </ul>
             </li>

   </ul>
 </nav></div>

     </div>


     <div class="navbar-header-items__end">

         <div class="navbar-item navbar-persistent--container">


 <button class="btn search-button-field search-button__button pst-js-only" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
  <i class="fa-solid fa-magnifying-glass"></i>
  <span class="search-button__default-text">Search</span>
  <span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span>
 </button>
         </div>


         <div class="navbar-item">

 <button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button pst-js-only" aria-label="Color mode" data-bs-title="Color mode"  data-bs-placement="bottom" data-bs-toggle="tooltip">
   <i class="theme-switch fa-solid fa-sun                fa-lg" data-mode="light" title="Light"></i>
   <i class="theme-switch fa-solid fa-moon               fa-lg" data-mode="dark"  title="Dark"></i>
   <i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto"  title="System Settings"></i>
 </button></div>

     </div>

   </div>


     <div class="navbar-persistent--mobile">

 <button class="btn search-button-field search-button__button pst-js-only" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
  <i class="fa-solid fa-magnifying-glass"></i>
  <span class="search-button__default-text">Search</span>
  <span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span>
 </button>
     </div>


     <button class="pst-navbar-icon sidebar-toggle secondary-toggle" aria-label="On this page">
       <span class="fa-solid fa-outdent"></span>
     </button>

 </div>

     </header>


   <div class="bd-container">
     <div class="bd-container__inner bd-page-width">


       <dialog id="pst-primary-sidebar-modal"></dialog>
       <div id="pst-primary-sidebar" class="bd-sidebar-primary bd-sidebar">


   <div class="sidebar-header-items sidebar-primary__section">


       <div class="sidebar-header-items__center">


             <div class="navbar-item">
 <nav>
   <ul class="bd-navbar-elements navbar-nav">

 <li class="nav-item ">
   <a class="nav-link nav-external" href="https://github.com/apache/datafusion-java">
     GitHub Repository
   </a>
 </li>


 <li class="nav-item ">
   <a class="nav-link nav-external" href="https://github.com/apache/datafusion-java/issues">
     Issue Tracker
   </a>
 </li>


 <li class="nav-item ">
   <a class="nav-link nav-external" href="https://datafusion.apache.org/">
     Apache DataFusion
   </a>
 </li>


 <li class="nav-item ">
   <a class="nav-link nav-external" href="https://github.com/apache/datafusion/blob/main/CODE_OF_CONDUCT.md">
     Code of Conduct
   </a>
 </li>


 <li class="nav-item ">
   <a class="nav-link nav-internal" href="../user-guide/index.html">
     User Guide
   </a>
 </li>


 <li class="nav-item current active">
   <a class="nav-link nav-internal" href="index.html">
     Contributor Guide
   </a>
 </li>

   </ul>
 </nav></div>


       </div>


       <div class="sidebar-header-items__end">

           <div class="navbar-item">

 <button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button pst-js-only" aria-label="Color mode" data-bs-title="Color mode"  data-bs-placement="bottom" data-bs-toggle="tooltip">
   <i class="theme-switch fa-solid fa-sun                fa-lg" data-mode="light" title="Light"></i>
   <i class="theme-switch fa-solid fa-moon               fa-lg" data-mode="dark"  title="Dark"></i>
   <i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto"  title="System Settings"></i>
 </button></div>

       </div>

   </div>

     <div class="sidebar-primary-items__start sidebar-primary__section">
         <div class="sidebar-primary-item">
 <nav class="bd-docs-nav bd-links"
      aria-label="Section Navigation">
   <p class="bd-links__title" role="heading" aria-level="1">Section Navigation</p>
   <div class="bd-toc-item navbar-nav"><ul class="current nav bd-sidenav">
 <li class="toctree-l1"><a class="reference internal" href="development.html">Development</a></li>
 <li class="toctree-l1"><a class="reference internal" href="code-style.html">Code style</a></li>
 <li class="toctree-l1"><a class="reference internal" href="releasing.html">Releasing</a></li>
 <li class="toctree-l1 current active"><a class="current reference internal" href="#">Updating the DataFusion / protobuf schema version</a></li>
 </ul>
 </div>
 </nav></div>
     </div>


   <div class="sidebar-primary-items__end sidebar-primary__section">
       <div class="sidebar-primary-item">
 <div id="ethical-ad-placement"
       class="flat"
       data-ea-publisher="readthedocs"
       data-ea-type="readthedocs-sidebar"
       data-ea-manual="true">
 </div></div>
   </div>


       </div>

       <main id="main-content" class="bd-main" role="main">


           <div class="bd-content">
             <div class="bd-article-container">

               <div class="bd-header-article d-print-none">
 <div class="header-article-items header-article__inner">

     <div class="header-article-items__start">

         <div class="header-article-item">

 <nav aria-label="Breadcrumb" class="d-print-none">
   <ul class="bd-breadcrumbs">

     <li class="breadcrumb-item breadcrumb-home">
       <a href="../index.html" class="nav-link" aria-label="Home">
         <i class="fa-solid fa-home"></i>
       </a>
     </li>

     <li class="breadcrumb-item"><a href="index.html" class="nav-link">Contributor Guide</a></li>

     <li class="breadcrumb-item active" aria-current="page"><span class="ellipsis">Updating the DataFusion / protobuf schema version</span></li>
   </ul>
 </nav>
 </div>

     </div>


 </div>
 </div>


 <div id="searchbox"></div>
                 <article class="bd-article">

   <!--
 Licensed to the Apache Software Foundation (ASF) under one
 or more contributor license agreements.  See the NOTICE file
 distributed with this work for additional information
 regarding copyright ownership.  The ASF licenses this file
 to you under the Apache License, Version 2.0 (the
 "License"); you may not use this file except in compliance
 with the License.  You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

 Unless required by applicable law or agreed to in writing,
 software distributed under the License is distributed on an
 "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 KIND, either express or implied.  See the License for the
 specific language governing permissions and limitations
 under the License.
 -->
 <section id="updating-the-datafusion-protobuf-schema-version">
 <h1>Updating the DataFusion / protobuf schema version<a class="headerlink" href="#updating-the-datafusion-protobuf-schema-version" title="Link to this heading">#</a></h1>
 <p>Three things must move together when bumping DataFusion:</p>
 <ol class="arabic simple">
 <li><p><code class="docutils literal notranslate"><span class="pre">Cargo.toml</span></code> (workspace root) — the <code class="docutils literal notranslate"><span class="pre">datafusion</span></code>, <code class="docutils literal notranslate"><span class="pre">datafusion-proto</span></code>,
 <code class="docutils literal notranslate"><span class="pre">datafusion-spark</span></code>, and <code class="docutils literal notranslate"><span class="pre">datafusion-substrait</span></code> entries in
 <code class="docutils literal notranslate"><span class="pre">[workspace.dependencies]</span></code>. Members inherit from there.</p></li>
 <li><p><code class="docutils literal notranslate"><span class="pre">pom.xml</span></code> — the <code class="docutils literal notranslate"><span class="pre">&lt;datafusion.version&gt;</span></code> Maven property. <strong>Must equal
 the Cargo version</strong>; a mismatch means JVM-built protobuf plans won’t
 deserialize on the native side.</p></li>
 <li><p><code class="docutils literal notranslate"><span class="pre">pom.xml</span></code> — the <code class="docutils literal notranslate"><span class="pre">&lt;sha512&gt;</span></code> checksums on the two <code class="docutils literal notranslate"><span class="pre">download-maven-plugin</span></code>
 executions. These pin the downloaded <code class="docutils literal notranslate"><span class="pre">.proto</span></code> files; the build fails
 if upstream silently re-tags them, which is the desired behavior.</p></li>
 </ol>
 <section id="recipe">
 <h2>Recipe<a class="headerlink" href="#recipe" title="Link to this heading">#</a></h2>
 <div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="c1"># 1. Bump the workspace dep</span>
 <span class="nv">$EDITOR</span><span class="w"> </span>Cargo.toml<span class="w">                    </span><span class="c1"># set datafusion = &quot;&lt;new&gt;&quot; in [workspace.dependencies]</span>
 cargo<span class="w"> </span>update<span class="w"> </span>-p<span class="w"> </span>datafusion

 <span class="c1"># 2. Bump the Maven property to match</span>
 <span class="nv">$EDITOR</span><span class="w"> </span>pom.xml<span class="w">                       </span><span class="c1"># set &lt;datafusion.version&gt;</span>

 <span class="c1"># 3. Compute the new SHA-512 hashes for both `.proto` files from the</span>
 <span class="c1">#    upstream tag you just set in step 2, then paste them into the two</span>
 <span class="c1">#    &lt;sha512&gt; elements in pom.xml.</span>
 <span class="nv">NEW</span><span class="o">=</span><span class="k">$(</span>grep<span class="w"> </span>-m1<span class="w"> </span>-oE<span class="w"> </span><span class="s1">&#39;&lt;datafusion.version&gt;[^&lt;]+&#39;</span><span class="w"> </span>pom.xml<span class="w"> </span><span class="p">|</span><span class="w"> </span>cut<span class="w"> </span>-d<span class="s1">&#39;&gt;&#39;</span><span class="w"> </span>-f2<span class="k">)</span>
 curl<span class="w"> </span>-sL<span class="w"> </span><span class="s2">&quot;https://raw.githubusercontent.com/apache/datafusion/</span><span class="nv">$NEW</span><span class="s2">/datafusion/proto-common/proto/datafusion_common.proto&quot;</span><span class="w"> </span><span class="p">|</span><span class="w"> </span>shasum<span class="w"> </span>-a<span class="w"> </span><span class="m">512</span><span class="w"> </span><span class="p">|</span><span class="w"> </span>awk<span class="w"> </span><span class="s1">&#39;{print $1}&#39;</span>
 curl<span class="w"> </span>-sL<span class="w"> </span><span class="s2">&quot;https://raw.githubusercontent.com/apache/datafusion/</span><span class="nv">$NEW</span><span class="s2">/datafusion/proto/proto/datafusion.proto&quot;</span><span class="w"> </span><span class="p">|</span><span class="w"> </span>shasum<span class="w"> </span>-a<span class="w"> </span><span class="m">512</span><span class="w"> </span><span class="p">|</span><span class="w"> </span>awk<span class="w"> </span><span class="s1">&#39;{print $1}&#39;</span>
 <span class="nv">$EDITOR</span><span class="w"> </span>pom.xml<span class="w">                       </span><span class="c1"># paste the two hashes into the &lt;sha512&gt; elements</span>

 <span class="c1"># Drop the local download cache so the next build re-downloads against</span>
 <span class="c1"># the new hashes.</span>
 rm<span class="w"> </span>-rf<span class="w"> </span>~/.m2/repository/.cache/download-maven-plugin<span class="w"> </span>target/proto

 <span class="c1"># 4. Verify</span>
 make<span class="w"> </span><span class="o">&amp;&amp;</span><span class="w"> </span>make<span class="w"> </span><span class="nb">test</span>
 </pre></div>
 </div>
 </section>
 <section id="why-the-protobuf-runtime-version-is-separate">
 <h2>Why the protobuf runtime version is separate<a class="headerlink" href="#why-the-protobuf-runtime-version-is-separate" title="Link to this heading">#</a></h2>
 <p>The protobuf runtime version (<code class="docutils literal notranslate"><span class="pre">&lt;protobuf.version&gt;</span></code> in <code class="docutils literal notranslate"><span class="pre">pom.xml</span></code>) tracks
 the Java ecosystem (security and JDK compatibility), not DataFusion.
 Bump it independently when there is a reason.</p>
 </section>
 </section>


                 </article>


                 <footer class="prev-next-footer d-print-none">

 <div class="prev-next-area">
     <a class="left-prev"
        href="releasing.html"
        title="previous page">
       <i class="fa-solid fa-angle-left"></i>
       <div class="prev-next-info">
         <p class="prev-next-subtitle">previous</p>
         <p class="prev-next-title">Releasing</p>
       </div>
     </a>
 </div>
                 </footer>

             </div>


                 <dialog id="pst-secondary-sidebar-modal"></dialog>
                 <div id="pst-secondary-sidebar" class="bd-sidebar-secondary bd-toc"><div class="sidebar-secondary-items sidebar-secondary__inner">


   <div class="sidebar-secondary-item">
 <div
     id="pst-page-navigation-heading-2"
     class="page-toc tocsection onthispage">
     <i class="fa-solid fa-list"></i> On this page
   </div>
   <nav class="bd-toc-nav page-toc" aria-labelledby="pst-page-navigation-heading-2">
     <ul class="visible nav section-nav flex-column">
 <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#recipe">Recipe</a></li>
 <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#why-the-protobuf-runtime-version-is-separate">Why the protobuf runtime version is separate</a></li>
 </ul>
   </nav></div>

   <div class="sidebar-secondary-item">
   <div role="note" aria-label="source link">
     <h3>This Page</h3>
     <ul class="this-page-menu">
       <li><a href="../_sources/contributor-guide/updating-datafusion-version.md.txt"
             rel="nofollow">Show Source</a></li>
     </ul>
    </div></div>

 </div></div>


           </div>
           <footer class="bd-footer-content">

           </footer>

       </main>
     </div>
   </div>

   <!-- Scripts loaded after <body> so the DOM is not blocked -->
   <script defer src="../_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf"></script>
 <script defer src="../_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf"></script>

   <footer class="bd-footer">
 <div class="bd-footer__inner bd-page-width">

     <div class="footer-items__start">

         <div class="footer-item">

   <p class="copyright">

       © Copyright 2026, Apache Software Foundation.
       <br/>

   </p>
 </div>

         <div class="footer-item">

   <p class="sphinx-version">
     Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.4.7.
     <br/>
   </p>
 </div>

     </div>


     <div class="footer-items__end">

         <div class="footer-item">
 <p class="theme-version">
   <!-- # L10n: Setting the PST URL as an argument as this does not need to be localized -->
   Built with the <a href="https://pydata-sphinx-theme.readthedocs.io/en/stable/index.html">PyData Sphinx Theme</a> 0.16.1.
 </p></div>

     </div>

 </div>

   </footer>
   </body>
 </html>

	<!DOCTYPE html>


	<html lang="en" data-content_root="../" >

	<head>
	<meta charset="utf-8" />
	<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />

	<title>Updating the DataFusion / protobuf schema version — Apache DataFusion Java documentation</title>



	<script data-cfasync="false">
	document.documentElement.dataset.mode = localStorage.getItem("mode") \|\| "";
	document.documentElement.dataset.theme = localStorage.getItem("theme") \|\| "";
	</script>
	<!--
	this give us a css class that will be invisible only if js is disabled
	-->
	<noscript>
	<style>
	.pst-js-only { display: none !important; }

	</style>
	</noscript>

	<!-- Loaded before other Sphinx assets -->
	<link href="../_static/styles/theme.css?digest=8878045cc6db502f8baf" rel="stylesheet" />
	<link href="../_static/styles/pydata-sphinx-theme.css?digest=8878045cc6db502f8baf" rel="stylesheet" />

	<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=8f2a1f02" />

	<!-- So that users can add custom icons -->
	<script src="../_static/scripts/fontawesome.js?digest=8878045cc6db502f8baf"></script>
	<!-- Pre-loaded scripts that we'll load fully later -->
	<link rel="preload" as="script" href="../_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf" />
	<link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf" />

	<script src="../_static/documentation_options.js?v=5929fcd5"></script>
	<script src="../_static/doctools.js?v=9a2dae69"></script>
	<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
	<script>DOCUMENTATION_OPTIONS.pagename = 'contributor-guide/updating-datafusion-version';</script>
	<link rel="index" title="Index" href="../genindex.html" />
	<link rel="search" title="Search" href="../search.html" />
	<link rel="prev" title="Releasing" href="releasing.html" />
	<meta name="viewport" content="width=device-width, initial-scale=1"/>
	<meta name="docsearch:language" content="en"/>
	<meta name="docsearch:version" content="" />
	</head>


	<body data-bs-spy="scroll" data-bs-target=".bd-toc-nav" data-offset="180" data-bs-root-margin="0px 0px -60%" data-default-mode="">



	<div id="pst-skip-link" class="skip-link d-print-none"><a href="#main-content">Skip to main content</a></div>

	<div id="pst-scroll-pixel-helper"></div>

	<button type="button" class="btn rounded-pill" id="pst-back-to-top">
	<i class="fa-solid fa-arrow-up"></i>Back to top</button>


	<dialog id="pst-search-dialog">

	<form class="bd-search d-flex align-items-center"
	action="../search.html"
	method="get">
	<i class="fa-solid fa-magnifying-glass"></i>
	<input type="search"
	class="form-control"
	name="q"
	placeholder="Search the docs ..."
	aria-label="Search the docs ..."
	autocomplete="off"
	autocorrect="off"
	autocapitalize="off"
	spellcheck="false"/>
	<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd>K</kbd></span>
	</form>
	</dialog>

	<div class="pst-async-banner-revealer d-none">
	<aside id="bd-header-version-warning" class="d-none d-print-none" aria-label="Version warning"></aside>
	</div>


	<header class="bd-header navbar navbar-expand-lg bd-navbar d-print-none">
	<div class="bd-header__inner bd-page-width">
	<button class="pst-navbar-icon sidebar-toggle primary-toggle" aria-label="Site navigation">
	<span class="fa-solid fa-bars"></span>
	</button>


	<div class="col-lg-3 navbar-header-items__start">

	<div class="navbar-item">





	<a class="navbar-brand logo" href="../index.html">






	<p class="title logo__title">Apache DataFusion Java documentation</p>

	</a></div>

	</div>

	<div class="col-lg-9 navbar-header-items">

	<div class="me-auto navbar-header-items__center">

	<div class="navbar-item">
	<nav>
	<ul class="bd-navbar-elements navbar-nav">

	<li class="nav-item ">
	<a class="nav-link nav-external" href="https://github.com/apache/datafusion-java">
	GitHub Repository
	</a>
	</li>


	<li class="nav-item ">
	<a class="nav-link nav-external" href="https://github.com/apache/datafusion-java/issues">
	Issue Tracker
	</a>
	</li>


	<li class="nav-item ">
	<a class="nav-link nav-external" href="https://datafusion.apache.org/">
	Apache DataFusion
	</a>
	</li>


	<li class="nav-item ">
	<a class="nav-link nav-external" href="https://github.com/apache/datafusion/blob/main/CODE_OF_CONDUCT.md">
	Code of Conduct
	</a>
	</li>


	<li class="nav-item ">
	<a class="nav-link nav-internal" href="../user-guide/index.html">
	User Guide
	</a>
	</li>

	<li class="nav-item dropdown">
	<button class="btn dropdown-toggle nav-item" type="button"
	data-bs-toggle="dropdown" aria-expanded="false"
	aria-controls="pst-nav-more-links">
	More
	</button>
	<ul id="pst-nav-more-links" class="dropdown-menu">

	<li class=" current active">
	<a class="nav-link dropdown-item nav-internal" href="index.html">
	Contributor Guide
	</a>
	</li>

	</ul>
	</li>

	</ul>
	</nav></div>

	</div>


	<div class="navbar-header-items__end">

	<div class="navbar-item navbar-persistent--container">


	<button class="btn search-button-field search-button__button pst-js-only" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
	<i class="fa-solid fa-magnifying-glass"></i>
	<span class="search-button__default-text">Search</span>
	<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span>
	</button>
	</div>


	<div class="navbar-item">

	<button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button pst-js-only" aria-label="Color mode" data-bs-title="Color mode" data-bs-placement="bottom" data-bs-toggle="tooltip">
	<i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light" title="Light"></i>
	<i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark" title="Dark"></i>
	<i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto" title="System Settings"></i>
	</button></div>

	</div>

	</div>


	<div class="navbar-persistent--mobile">

	<button class="btn search-button-field search-button__button pst-js-only" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
	<i class="fa-solid fa-magnifying-glass"></i>
	<span class="search-button__default-text">Search</span>
	<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span>
	</button>
	</div>



	<button class="pst-navbar-icon sidebar-toggle secondary-toggle" aria-label="On this page">
	<span class="fa-solid fa-outdent"></span>
	</button>

	</div>

	</header>


	<div class="bd-container">
	<div class="bd-container__inner bd-page-width">



	<dialog id="pst-primary-sidebar-modal"></dialog>
	<div id="pst-primary-sidebar" class="bd-sidebar-primary bd-sidebar">



	<div class="sidebar-header-items sidebar-primary__section">


	<div class="sidebar-header-items__center">



	<div class="navbar-item">
	<nav>
	<ul class="bd-navbar-elements navbar-nav">

	<li class="nav-item ">
	<a class="nav-link nav-external" href="https://github.com/apache/datafusion-java">
	GitHub Repository
	</a>
	</li>


	<li class="nav-item ">
	<a class="nav-link nav-external" href="https://github.com/apache/datafusion-java/issues">
	Issue Tracker
	</a>
	</li>


	<li class="nav-item ">
	<a class="nav-link nav-external" href="https://datafusion.apache.org/">
	Apache DataFusion
	</a>
	</li>


	<li class="nav-item ">
	<a class="nav-link nav-external" href="https://github.com/apache/datafusion/blob/main/CODE_OF_CONDUCT.md">
	Code of Conduct
	</a>
	</li>


	<li class="nav-item ">
	<a class="nav-link nav-internal" href="../user-guide/index.html">
	User Guide
	</a>
	</li>


	<li class="nav-item current active">
	<a class="nav-link nav-internal" href="index.html">
	Contributor Guide
	</a>
	</li>

	</ul>
	</nav></div>


	</div>



	<div class="sidebar-header-items__end">

	<div class="navbar-item">

	<button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button pst-js-only" aria-label="Color mode" data-bs-title="Color mode" data-bs-placement="bottom" data-bs-toggle="tooltip">
	<i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light" title="Light"></i>
	<i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark" title="Dark"></i>
	<i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto" title="System Settings"></i>
	</button></div>

	</div>

	</div>

	<div class="sidebar-primary-items__start sidebar-primary__section">
	<div class="sidebar-primary-item">
	<nav class="bd-docs-nav bd-links"
	aria-label="Section Navigation">
	<p class="bd-links__title" role="heading" aria-level="1">Section Navigation</p>
	<div class="bd-toc-item navbar-nav"><ul class="current nav bd-sidenav">
	<li class="toctree-l1"><a class="reference internal" href="development.html">Development</a></li>
	<li class="toctree-l1"><a class="reference internal" href="code-style.html">Code style</a></li>
	<li class="toctree-l1"><a class="reference internal" href="releasing.html">Releasing</a></li>
	<li class="toctree-l1 current active"><a class="current reference internal" href="#">Updating the DataFusion / protobuf schema version</a></li>
	</ul>
	</div>
	</nav></div>
	</div>


	<div class="sidebar-primary-items__end sidebar-primary__section">
	<div class="sidebar-primary-item">
	<div id="ethical-ad-placement"
	class="flat"
	data-ea-publisher="readthedocs"
	data-ea-type="readthedocs-sidebar"
	data-ea-manual="true">
	</div></div>
	</div>


	</div>

	<main id="main-content" class="bd-main" role="main">


	<div class="bd-content">
	<div class="bd-article-container">

	<div class="bd-header-article d-print-none">
	<div class="header-article-items header-article__inner">

	<div class="header-article-items__start">

	<div class="header-article-item">

	<nav aria-label="Breadcrumb" class="d-print-none">
	<ul class="bd-breadcrumbs">

	<li class="breadcrumb-item breadcrumb-home">
	<a href="../index.html" class="nav-link" aria-label="Home">
	<i class="fa-solid fa-home"></i>
	</a>
	</li>

	<li class="breadcrumb-item"><a href="index.html" class="nav-link">Contributor Guide</a></li>

	<li class="breadcrumb-item active" aria-current="page"><span class="ellipsis">Updating the DataFusion / protobuf schema version</span></li>
	</ul>
	</nav>
	</div>

	</div>


	</div>
	</div>




	<div id="searchbox"></div>
	<article class="bd-article">

	<!--
	Licensed to the Apache Software Foundation (ASF) under one
	or more contributor license agreements. See the NOTICE file
	distributed with this work for additional information
	regarding copyright ownership. The ASF licenses this file
	to you under the Apache License, Version 2.0 (the
	"License"); you may not use this file except in compliance
	with the License. You may obtain a copy of the License at

	http://www.apache.org/licenses/LICENSE-2.0

	Unless required by applicable law or agreed to in writing,
	software distributed under the License is distributed on an
	"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
	KIND, either express or implied. See the License for the
	specific language governing permissions and limitations
	under the License.
	-->
	<section id="updating-the-datafusion-protobuf-schema-version">
	<h1>Updating the DataFusion / protobuf schema version<a class="headerlink" href="#updating-the-datafusion-protobuf-schema-version" title="Link to this heading">#</a></h1>
	<p>Three things must move together when bumping DataFusion:</p>
	<ol class="arabic simple">
	<li><p><code class="docutils literal notranslate"><span class="pre">Cargo.toml</span></code> (workspace root) — the <code class="docutils literal notranslate"><span class="pre">datafusion</span></code>, <code class="docutils literal notranslate"><span class="pre">datafusion-proto</span></code>,
	<code class="docutils literal notranslate"><span class="pre">datafusion-spark</span></code>, and <code class="docutils literal notranslate"><span class="pre">datafusion-substrait</span></code> entries in
	<code class="docutils literal notranslate"><span class="pre">[workspace.dependencies]</span></code>. Members inherit from there.</p></li>
	<li><p><code class="docutils literal notranslate"><span class="pre">pom.xml</span></code> — the <code class="docutils literal notranslate"><span class="pre"><datafusion.version></span></code> Maven property. <strong>Must equal
	the Cargo version</strong>; a mismatch means JVM-built protobuf plans won’t
	deserialize on the native side.</p></li>
	<li><p><code class="docutils literal notranslate"><span class="pre">pom.xml</span></code> — the <code class="docutils literal notranslate"><span class="pre"><sha512></span></code> checksums on the two <code class="docutils literal notranslate"><span class="pre">download-maven-plugin</span></code>
	executions. These pin the downloaded <code class="docutils literal notranslate"><span class="pre">.proto</span></code> files; the build fails
	if upstream silently re-tags them, which is the desired behavior.</p></li>
	</ol>
	<section id="recipe">
	<h2>Recipe<a class="headerlink" href="#recipe" title="Link to this heading">#</a></h2>
	<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="c1"># 1. Bump the workspace dep</span>
	<span class="nv">$EDITOR</span><span class="w"> </span>Cargo.toml<span class="w"> </span><span class="c1"># set datafusion = "<new>" in [workspace.dependencies]</span>
	cargo<span class="w"> </span>update<span class="w"> </span>-p<span class="w"> </span>datafusion

	<span class="c1"># 2. Bump the Maven property to match</span>
	<span class="nv">$EDITOR</span><span class="w"> </span>pom.xml<span class="w"> </span><span class="c1"># set <datafusion.version></span>

	<span class="c1"># 3. Compute the new SHA-512 hashes for both `.proto` files from the</span>
	<span class="c1"># upstream tag you just set in step 2, then paste them into the two</span>
	<span class="c1"># <sha512> elements in pom.xml.</span>
	<span class="nv">NEW</span><span class="o">=</span><span class="k">$(</span>grep<span class="w"> </span>-m1<span class="w"> </span>-oE<span class="w"> </span><span class="s1">'<datafusion.version>[^<]+'</span><span class="w"> </span>pom.xml<span class="w"> </span><span class="p">\|</span><span class="w"> </span>cut<span class="w"> </span>-d<span class="s1">'>'</span><span class="w"> </span>-f2<span class="k">)</span>
	curl<span class="w"> </span>-sL<span class="w"> </span><span class="s2">"https://raw.githubusercontent.com/apache/datafusion/</span><span class="nv">$NEW</span><span class="s2">/datafusion/proto-common/proto/datafusion_common.proto"</span><span class="w"> </span><span class="p">\|</span><span class="w"> </span>shasum<span class="w"> </span>-a<span class="w"> </span><span class="m">512</span><span class="w"> </span><span class="p">\|</span><span class="w"> </span>awk<span class="w"> </span><span class="s1">'{print $1}'</span>
	curl<span class="w"> </span>-sL<span class="w"> </span><span class="s2">"https://raw.githubusercontent.com/apache/datafusion/</span><span class="nv">$NEW</span><span class="s2">/datafusion/proto/proto/datafusion.proto"</span><span class="w"> </span><span class="p">\|</span><span class="w"> </span>shasum<span class="w"> </span>-a<span class="w"> </span><span class="m">512</span><span class="w"> </span><span class="p">\|</span><span class="w"> </span>awk<span class="w"> </span><span class="s1">'{print $1}'</span>
	<span class="nv">$EDITOR</span><span class="w"> </span>pom.xml<span class="w"> </span><span class="c1"># paste the two hashes into the <sha512> elements</span>

	<span class="c1"># Drop the local download cache so the next build re-downloads against</span>
	<span class="c1"># the new hashes.</span>
	rm<span class="w"> </span>-rf<span class="w"> </span>~/.m2/repository/.cache/download-maven-plugin<span class="w"> </span>target/proto

	<span class="c1"># 4. Verify</span>
	make<span class="w"> </span><span class="o">&&</span><span class="w"> </span>make<span class="w"> </span><span class="nb">test</span>
	</pre></div>
	</div>
	</section>
	<section id="why-the-protobuf-runtime-version-is-separate">
	<h2>Why the protobuf runtime version is separate<a class="headerlink" href="#why-the-protobuf-runtime-version-is-separate" title="Link to this heading">#</a></h2>
	<p>The protobuf runtime version (<code class="docutils literal notranslate"><span class="pre"><protobuf.version></span></code> in <code class="docutils literal notranslate"><span class="pre">pom.xml</span></code>) tracks
	the Java ecosystem (security and JDK compatibility), not DataFusion.
	Bump it independently when there is a reason.</p>
	</section>
	</section>


	</article>





	<footer class="prev-next-footer d-print-none">

	<div class="prev-next-area">
	<a class="left-prev"
	href="releasing.html"
	title="previous page">
	<i class="fa-solid fa-angle-left"></i>
	<div class="prev-next-info">
	<p class="prev-next-subtitle">previous</p>
	<p class="prev-next-title">Releasing</p>
	</div>
	</a>
	</div>
	</footer>

	</div>



	<dialog id="pst-secondary-sidebar-modal"></dialog>
	<div id="pst-secondary-sidebar" class="bd-sidebar-secondary bd-toc"><div class="sidebar-secondary-items sidebar-secondary__inner">


	<div class="sidebar-secondary-item">
	<div
	id="pst-page-navigation-heading-2"
	class="page-toc tocsection onthispage">
	<i class="fa-solid fa-list"></i> On this page
	</div>
	<nav class="bd-toc-nav page-toc" aria-labelledby="pst-page-navigation-heading-2">
	<ul class="visible nav section-nav flex-column">
	<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#recipe">Recipe</a></li>
	<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#why-the-protobuf-runtime-version-is-separate">Why the protobuf runtime version is separate</a></li>
	</ul>
	</nav></div>

	<div class="sidebar-secondary-item">
	<div role="note" aria-label="source link">
	<h3>This Page</h3>
	<ul class="this-page-menu">
	<li><a href="../_sources/contributor-guide/updating-datafusion-version.md.txt"
	rel="nofollow">Show Source</a></li>
	</ul>
	</div></div>

	</div></div>


	</div>
	<footer class="bd-footer-content">

	</footer>

	</main>
	</div>
	</div>

	<!-- Scripts loaded after <body> so the DOM is not blocked -->
	<script defer src="../_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf"></script>
	<script defer src="../_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf"></script>

	<footer class="bd-footer">
	<div class="bd-footer__inner bd-page-width">

	<div class="footer-items__start">

	<div class="footer-item">

	<p class="copyright">

	© Copyright 2026, Apache Software Foundation.
	<br/>

	</p>
	</div>

	<div class="footer-item">

	<p class="sphinx-version">
	Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.4.7.
	<br/>
	</p>
	</div>

	</div>



	<div class="footer-items__end">

	<div class="footer-item">
	<p class="theme-version">
	<!-- # L10n: Setting the PST URL as an argument as this does not need to be localized -->
	Built with the <a href="https://pydata-sphinx-theme.readthedocs.io/en/stable/index.html">PyData Sphinx Theme</a> 0.16.1.
	</p></div>

	</div>

	</div>

	</footer>
	</body>
	</html>