| |
| |
| |
| <!DOCTYPE html> |
| <html class="writer-html5" lang="en" > |
| <head> |
| <meta charset="utf-8"> |
| |
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> |
| |
| <title>Developing on Windows — Apache Arrow v2.0.0</title> |
| |
| |
| |
| <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" /> |
| <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" /> |
| |
| |
| |
| |
| |
| |
| |
| <!--[if lt IE 9]> |
| <script src="../../_static/js/html5shiv.min.js"></script> |
| <![endif]--> |
| |
| |
| <script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script> |
| <script src="../../_static/jquery.js"></script> |
| <script src="../../_static/underscore.js"></script> |
| <script src="../../_static/doctools.js"></script> |
| <script src="../../_static/language_data.js"></script> |
| |
| <script type="text/javascript" src="../../_static/js/theme.js"></script> |
| |
| |
| <link rel="canonical" href="https://arrow.apache.org/docs/developers/cpp/windows.html" /> |
| <link rel="index" title="Index" href="../../genindex.html" /> |
| <link rel="search" title="Search" href="../../search.html" /> |
| <link rel="next" title="Conventions" href="conventions.html" /> |
| <link rel="prev" title="Development Guidelines" href="development.html" /> |
|
|
|
|
| <!-- Matomo -->
|
| <script>
|
| var _paq = window._paq = window._paq || [];
|
| /* tracker methods like "setCustomDimension" should be called before "trackPageView" */
|
| _paq.push(["setDoNotTrack", true]);
|
| _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 class="wy-body-for-nav"> |
| |
| |
| <div class="wy-grid-for-nav"> |
| |
| <nav data-toggle="wy-nav-shift" class="wy-nav-side"> |
| <div class="wy-side-scroll"> |
| <div class="wy-side-nav-search" > |
| |
| |
| |
| <a href="../../index.html" class="icon icon-home" alt="Documentation Home"> Apache Arrow |
| |
| |
| |
| </a> |
| |
| |
| |
| |
| <div class="version"> |
| 2.0.0 |
| </div> |
| |
| |
| |
| |
| <div role="search"> |
| <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get"> |
| <input type="text" name="q" placeholder="Search docs" /> |
| <input type="hidden" name="check_keywords" value="yes" /> |
| <input type="hidden" name="area" value="default" /> |
| </form> |
| </div> |
| |
| |
| </div> |
| |
| |
| <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> |
| |
| |
| |
| |
| |
| |
| <p class="caption"><span class="caption-text">Specifications and Protocols</span></p> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="../../format/Versioning.html">Format Versioning and Stability</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../format/Columnar.html">Arrow Columnar Format</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../format/Flight.html">Arrow Flight RPC</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../format/Integration.html">Integration Testing</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../format/CDataInterface.html">The Arrow C data interface</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../format/CStreamInterface.html">The Arrow C stream interface</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../format/Other.html">Other Data Structures</a></li> |
| </ul> |
| <p class="caption"><span class="caption-text">Libraries</span></p> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="../../status.html">Implementation Status</a></li> |
| <li class="toctree-l1"><a class="reference external" href="https://arrow.apache.org/docs/c_glib/">C/GLib</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../cpp/index.html">C++</a></li> |
| <li class="toctree-l1"><a class="reference external" href="https://github.com/apache/arrow/blob/master/csharp/README.md">C#</a></li> |
| <li class="toctree-l1"><a class="reference external" href="https://godoc.org/github.com/apache/arrow/go/arrow">Go</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../java/index.html">Java</a></li> |
| <li class="toctree-l1"><a class="reference external" href="https://arrow.apache.org/docs/js/">JavaScript</a></li> |
| <li class="toctree-l1"><a class="reference external" href="https://github.com/apache/arrow/blob/master/matlab/README.md">MATLAB</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../python/index.html">Python</a></li> |
| <li class="toctree-l1"><a class="reference external" href="https://arrow.apache.org/docs/r/">R</a></li> |
| <li class="toctree-l1"><a class="reference external" href="https://github.com/apache/arrow/blob/master/ruby/README.md">Ruby</a></li> |
| <li class="toctree-l1"><a class="reference external" href="https://docs.rs/crate/arrow/">Rust</a></li> |
| </ul> |
| <p class="caption"><span class="caption-text">Development</span></p> |
| <ul class="current"> |
| <li class="toctree-l1"><a class="reference internal" href="../contributing.html">Contributing to Apache Arrow</a></li> |
| <li class="toctree-l1 current"><a class="reference internal" href="index.html">C++ Development</a><ul class="current"> |
| <li class="toctree-l2"><a class="reference internal" href="building.html">Building Arrow C++</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="development.html">Development Guidelines</a></li> |
| <li class="toctree-l2 current"><a class="current reference internal" href="#">Developing on Windows</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="#system-setup">System Setup</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="#using-conda-forge-for-build-dependencies">Using conda-forge for build dependencies</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="#building-using-visual-studio-msvc-solution-files">Building using Visual Studio (MSVC) Solution Files</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="#building-with-ninja-and-clcache">Building with Ninja and clcache</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="#building-with-nmake">Building with NMake</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="#building-on-msys2">Building on MSYS2</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="#debug-builds">Debug builds</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="#windows-dependency-resolution-issues">Windows dependency resolution issues</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="#statically-linking-to-arrow-on-windows">Statically linking to Arrow on Windows</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="#replicating-appveyor-builds">Replicating Appveyor Builds</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="conventions.html">Conventions</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="fuzzing.html">Fuzzing Arrow C++</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="../python.html">Python Development</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../archery.html">Daily Development using Archery</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../crossbow.html">Packaging and Testing with Crossbow</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../docker.html">Running Docker Builds</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../benchmarks.html">Benchmarks</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../documentation.html">Building the Documentation</a></li> |
| </ul> |
| |
| |
| |
| </div> |
| |
| </div> |
| </nav> |
| |
| <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> |
| |
| |
| <nav class="wy-nav-top" aria-label="top navigation"> |
| |
| <i data-toggle="wy-nav-top" class="fa fa-bars"></i> |
| <a href="../../index.html">Apache Arrow</a> |
| |
| </nav> |
| |
| |
| <div class="wy-nav-content"> |
| |
| <div class="rst-content"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div role="navigation" aria-label="breadcrumbs navigation"> |
| |
| <ul class="wy-breadcrumbs"> |
| |
| <li><a href="../../index.html" class="icon icon-home"></a> »</li> |
| |
| <li><a href="index.html">C++ Development</a> »</li> |
| |
| <li>Developing on Windows</li> |
| |
| |
| <li class="wy-breadcrumbs-aside"> |
| |
| |
| <a href="../../_sources/developers/cpp/windows.rst.txt" rel="nofollow"> View page source</a> |
| |
| |
| </li> |
| |
| </ul> |
| |
| |
| <hr/> |
| </div> |
| <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> |
| <div itemprop="articleBody"> |
| |
| <div class="section" id="developing-on-windows"> |
| <span id="developers-cpp-windows"></span><h1>Developing on Windows<a class="headerlink" href="#developing-on-windows" title="Permalink to this headline">¶</a></h1> |
| <p>Like Linux and macOS, we have worked to enable builds to work “out of the box” |
| with CMake for a reasonably large subset of the project.</p> |
| <div class="section" id="system-setup"> |
| <h2>System Setup<a class="headerlink" href="#system-setup" title="Permalink to this headline">¶</a></h2> |
| <p>Microsoft provides the free Visual Studio Community edition. When doing |
| development in the shell, you must initialize the development |
| environment.</p> |
| <p>For Visual Studio 2015, execute the following batch script:</p> |
| <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span><span class="s2">"C:\Program Files (x86)\Microsoft Visual Studio 14.0\VC\vcvarsall.bat"</span> amd64 |
| </pre></div> |
| </div> |
| <p>For Visual Studio 2017, the script is:</p> |
| <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span><span class="s2">"C:\Program Files (x86)\Microsoft Visual Studio\2017\Community\Common7\Tools\VsDevCmd.bat"</span> -arch<span class="o">=</span>amd64 |
| </pre></div> |
| </div> |
| <p>One can configure a console emulator like <a class="reference external" href="https://cmder.net/">cmder</a> to |
| automatically launch this when starting a new development console.</p> |
| </div> |
| <div class="section" id="using-conda-forge-for-build-dependencies"> |
| <h2>Using conda-forge for build dependencies<a class="headerlink" href="#using-conda-forge-for-build-dependencies" title="Permalink to this headline">¶</a></h2> |
| <p><a class="reference external" href="https://conda.io/miniconda.html">Miniconda</a> is a minimal Python distribution |
| including the <a class="reference external" href="https://conda.io">conda</a> package manager. Some memers of the |
| Apache Arrow community participate in the maintenance of <a class="reference external" href="https://conda-forge.org/">conda-forge</a>, a community-maintained cross-platform package |
| repository for conda.</p> |
| <p>To use <code class="docutils literal notranslate"><span class="pre">conda-forge</span></code> for your C++ build dependencies on Windows, first |
| download and install a 64-bit distribution from the <a class="reference external" href="https://conda.io/miniconda.html">Miniconda homepage</a></p> |
| <p>To configure <code class="docutils literal notranslate"><span class="pre">conda</span></code> to use the <code class="docutils literal notranslate"><span class="pre">conda-forge</span></code> channel by default, launch a |
| command prompt (<code class="docutils literal notranslate"><span class="pre">cmd.exe</span></code>) and run the command:</p> |
| <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>conda config --add channels conda-forge |
| </pre></div> |
| </div> |
| <p>Now, you can bootstrap a build environment (call from the root directory of the |
| Arrow codebase):</p> |
| <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>conda create -y -n arrow-dev --file<span class="o">=</span>ci<span class="se">\c</span>onda_env_cpp.yml |
| </pre></div> |
| </div> |
| <p>Then “activate” this conda environment with:</p> |
| <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>activate arrow-dev |
| </pre></div> |
| </div> |
| <p>If the environment has been activated, the Arrow build system will |
| automatically see the <code class="docutils literal notranslate"><span class="pre">%CONDA_PREFIX%</span></code> environment variable and use that for |
| resolving the build dependencies. This is equivalent to setting</p> |
| <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>-DARROW_DEPENDENCY_SOURCE<span class="o">=</span>SYSTEM ^ |
| -DARROW_PACKAGE_PREFIX<span class="o">=</span>%CONDA_PREFIX%<span class="se">\L</span>ibrary |
| </pre></div> |
| </div> |
| <p>Note that these packages are only supported for release builds. If you intend |
| to use <code class="docutils literal notranslate"><span class="pre">-DCMAKE_BUILD_TYPE=debug</span></code> then you must build the packages from |
| source.</p> |
| <div class="admonition note"> |
| <p class="admonition-title">Note</p> |
| <p>If you run into any problems using conda packages for dependencies, a very |
| common problem is mixing packages from the <code class="docutils literal notranslate"><span class="pre">defaults</span></code> channel with those |
| from <code class="docutils literal notranslate"><span class="pre">conda-forge</span></code>. You can examine the installed packages in your |
| environment (and their origin) with <code class="docutils literal notranslate"><span class="pre">conda</span> <span class="pre">list</span></code></p> |
| </div> |
| </div> |
| <div class="section" id="building-using-visual-studio-msvc-solution-files"> |
| <h2>Building using Visual Studio (MSVC) Solution Files<a class="headerlink" href="#building-using-visual-studio-msvc-solution-files" title="Permalink to this headline">¶</a></h2> |
| <p>Change working directory in <code class="docutils literal notranslate"><span class="pre">cmd.exe</span></code> to the root directory of Arrow and do |
| an out of source build by generating a MSVC solution:</p> |
| <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span><span class="nb">cd</span> cpp |
| mkdir build |
| <span class="nb">cd</span> build |
| cmake .. -G <span class="s2">"Visual Studio 14 2015 Win64"</span> ^ |
| -DARROW_BUILD_TESTS<span class="o">=</span>ON |
| cmake --build . --config Release |
| </pre></div> |
| </div> |
| </div> |
| <div class="section" id="building-with-ninja-and-clcache"> |
| <h2>Building with Ninja and clcache<a class="headerlink" href="#building-with-ninja-and-clcache" title="Permalink to this headline">¶</a></h2> |
| <p>The <a class="reference external" href="https://ninja-build.org/">Ninja</a> build system offsets better build |
| parallelization, and the optional <a class="reference external" href="https://github.com/frerich/clcache/">clcache</a> compiler cache which keeps track of |
| past compilations to avoid running them over and over again (in a way similar |
| to the Unix-specific <code class="docutils literal notranslate"><span class="pre">ccache</span></code>).</p> |
| <p>Activate your conda build environment to first install those utilities:</p> |
| <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>activate arrow-dev |
| conda install -c conda-forge ninja |
| pip install git+https://github.com/frerich/clcache.git |
| </pre></div> |
| </div> |
| <p>Change working directory in <code class="docutils literal notranslate"><span class="pre">cmd.exe</span></code> to the root directory of Arrow and |
| do an out of source build by generating Ninja files:</p> |
| <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span><span class="nb">cd</span> cpp |
| mkdir build |
| <span class="nb">cd</span> build |
| cmake -G <span class="s2">"Ninja"</span> ^ |
| -DCMAKE_C_COMPILER<span class="o">=</span>clcache ^ |
| -DCMAKE_CXX_COMPILER<span class="o">=</span>clcache ^ |
| -DARROW_BUILD_TESTS<span class="o">=</span>ON ^ |
| -DGTest_SOURCE<span class="o">=</span>BUNDLED .. |
| cmake --build . --config Release |
| </pre></div> |
| </div> |
| <p>Setting <code class="docutils literal notranslate"><span class="pre">CMAKE_C_COMPILER</span></code> and <code class="docutils literal notranslate"><span class="pre">CMAKE_CXX_COMPILER</span></code> in the command line |
| of <code class="docutils literal notranslate"><span class="pre">cmake</span></code> is the preferred method of using <code class="docutils literal notranslate"><span class="pre">clcache</span></code>. Alternatively, you |
| can set <code class="docutils literal notranslate"><span class="pre">CC</span></code> and <code class="docutils literal notranslate"><span class="pre">CXX</span></code> environment variables before calling <code class="docutils literal notranslate"><span class="pre">cmake</span></code>:</p> |
| <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>... |
| <span class="nb">set</span> <span class="nv">CC</span><span class="o">=</span>clcache |
| <span class="nb">set</span> <span class="nv">CXX</span><span class="o">=</span>clcache |
| cmake -G <span class="s2">"Ninja"</span> ^ |
| ... |
| </pre></div> |
| </div> |
| </div> |
| <div class="section" id="building-with-nmake"> |
| <h2>Building with NMake<a class="headerlink" href="#building-with-nmake" title="Permalink to this headline">¶</a></h2> |
| <p>Change working directory in <code class="docutils literal notranslate"><span class="pre">cmd.exe</span></code> to the root directory of Arrow and |
| do an out of source build using <code class="docutils literal notranslate"><span class="pre">nmake</span></code>:</p> |
| <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span><span class="nb">cd</span> cpp |
| mkdir build |
| <span class="nb">cd</span> build |
| cmake -G <span class="s2">"NMake Makefiles"</span> .. |
| nmake |
| </pre></div> |
| </div> |
| </div> |
| <div class="section" id="building-on-msys2"> |
| <h2>Building on MSYS2<a class="headerlink" href="#building-on-msys2" title="Permalink to this headline">¶</a></h2> |
| <p>You can build on MSYS2 terminal, <code class="docutils literal notranslate"><span class="pre">cmd.exe</span></code> or PowerShell terminal.</p> |
| <p>On MSYS2 terminal:</p> |
| <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span><span class="nb">cd</span> cpp |
| mkdir build |
| <span class="nb">cd</span> build |
| cmake -G <span class="s2">"MSYS Makefiles"</span> .. |
| make |
| </pre></div> |
| </div> |
| <p>On <code class="docutils literal notranslate"><span class="pre">cmd.exe</span></code> or PowerShell terminal, you can use the following batch |
| file:</p> |
| <div class="highlight-batch notranslate"><div class="highlight"><pre><span></span><span class="k">setlocal</span> |
| |
| <span class="c1">REM For 64bit</span> |
| <span class="k">set</span> <span class="nv">MINGW_PACKAGE_PREFIX</span><span class="p">=</span>mingw-w64-x86_64 |
| <span class="k">set</span> <span class="nv">MINGW_PREFIX</span><span class="p">=</span>c:\msys64\mingw64 |
| <span class="k">set</span> <span class="nv">MSYSTEM</span><span class="p">=</span>MINGW64 |
| |
| <span class="k">set</span> <span class="nv">PATH</span><span class="p">=</span><span class="nv">%MINGW_PREFIX%</span>\bin;c:\msys64\usr\bin;<span class="nv">%PATH%</span> |
| |
| <span class="k">rmdir</span> /S /Q cpp\build |
| <span class="k">mkdir</span> cpp\build |
| <span class="k">pushd</span> cpp\build |
| cmake -G <span class="s2">"MSYS Makefiles"</span> .. <span class="p">||</span> <span class="k">exit</span> /B |
| make <span class="p">||</span> <span class="k">exit</span> /B |
| <span class="k">popd</span> |
| </pre></div> |
| </div> |
| </div> |
| <div class="section" id="debug-builds"> |
| <h2>Debug builds<a class="headerlink" href="#debug-builds" title="Permalink to this headline">¶</a></h2> |
| <p>To build a Debug version of Arrow, you should have pre-installed a Debug |
| version of Boost. It’s recommended to configure cmake build with the |
| following variables for Debug build:</p> |
| <ul class="simple"> |
| <li><p><code class="docutils literal notranslate"><span class="pre">-DARROW_BOOST_USE_SHARED=OFF</span></code>: enables static linking with boost debug |
| libs and simplifies run-time loading of 3rd parties</p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">-DBOOST_ROOT</span></code>: sets the root directory of boost libs. (Optional)</p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">-DBOOST_LIBRARYDIR</span></code>: sets the directory with boost lib files. (Optional)</p></li> |
| </ul> |
| <p>The command line to build Arrow in Debug mode will look something like this:</p> |
| <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span><span class="nb">cd</span> cpp |
| mkdir build |
| <span class="nb">cd</span> build |
| cmake .. -G <span class="s2">"Visual Studio 14 2015 Win64"</span> ^ |
| -DARROW_BOOST_USE_SHARED<span class="o">=</span>OFF ^ |
| -DCMAKE_BUILD_TYPE<span class="o">=</span>Debug ^ |
| -DBOOST_ROOT<span class="o">=</span>C:/local/boost_1_63_0 ^ |
| -DBOOST_LIBRARYDIR<span class="o">=</span>C:/local/boost_1_63_0/lib64-msvc-14.0 |
| cmake --build . --config Debug |
| </pre></div> |
| </div> |
| </div> |
| <div class="section" id="windows-dependency-resolution-issues"> |
| <h2>Windows dependency resolution issues<a class="headerlink" href="#windows-dependency-resolution-issues" title="Permalink to this headline">¶</a></h2> |
| <p>Because Windows uses <code class="docutils literal notranslate"><span class="pre">.lib</span></code> files for both static and dynamic linking of |
| dependencies, the static library sometimes may be named something different |
| like <code class="docutils literal notranslate"><span class="pre">%PACKAGE%_static.lib</span></code> to distinguish itself. If you are statically |
| linking some dependencies, we provide some options</p> |
| <ul class="simple"> |
| <li><p><code class="docutils literal notranslate"><span class="pre">-DBROTLI_MSVC_STATIC_LIB_SUFFIX=%BROTLI_SUFFIX%</span></code></p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">-DSNAPPY_MSVC_STATIC_LIB_SUFFIX=%SNAPPY_SUFFIX%</span></code></p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">-LZ4_MSVC_STATIC_LIB_SUFFIX=%LZ4_SUFFIX%</span></code></p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">-ZSTD_MSVC_STATIC_LIB_SUFFIX=%ZSTD_SUFFIX%</span></code></p></li> |
| </ul> |
| <p>To get the latest build instructions, you can reference <a class="reference external" href="https://github.com/apache/arrow/blob/master/ci/appveyor-cpp-build.bat">ci/appveyor-built.bat</a>, |
| which is used by automated Appveyor builds.</p> |
| </div> |
| <div class="section" id="statically-linking-to-arrow-on-windows"> |
| <h2>Statically linking to Arrow on Windows<a class="headerlink" href="#statically-linking-to-arrow-on-windows" title="Permalink to this headline">¶</a></h2> |
| <p>The Arrow headers on Windows static library builds (enabled by the CMake |
| option <code class="docutils literal notranslate"><span class="pre">ARROW_BUILD_STATIC</span></code>) use the preprocessor macro <code class="docutils literal notranslate"><span class="pre">ARROW_STATIC</span></code> to |
| suppress dllimport/dllexport marking of symbols. Projects that statically link |
| against Arrow on Windows additionally need this definition. The Unix builds do |
| not use the macro.</p> |
| </div> |
| <div class="section" id="replicating-appveyor-builds"> |
| <h2>Replicating Appveyor Builds<a class="headerlink" href="#replicating-appveyor-builds" title="Permalink to this headline">¶</a></h2> |
| <p>For people more familiar with linux development but need to replicate a failing |
| appveyor build, here are some rough notes from replicating the |
| <code class="docutils literal notranslate"><span class="pre">Static_Crt_Build</span></code> (make unittest will probably still fail but many unit |
| tests can be made with there individual make targets).</p> |
| <ol class="arabic simple"> |
| <li><p>Microsoft offers trial VMs for <a class="reference external" href="https://developer.microsoft.com/en-us/windows/downloads/virtual-machines">Windows with Microsoft Visual Studio</a>. |
| Download and install a version.</p></li> |
| <li><p>Run the VM and install CMake and Miniconda or Anaconda (these instructions |
| assume Anaconda).</p></li> |
| <li><p>Download <a class="reference external" href="https://sourceforge.net/projects/boost/files/boost-binaries/">pre-built Boost debug binaries</a> and install |
| it (run from command prompt opened by “Developer Command Prompt for MSVC |
| 2017”):</p></li> |
| </ol> |
| <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span><span class="nb">cd</span> <span class="nv">$EXTRACT_BOOST_DIRECTORY</span> |
| .<span class="se">\b</span>ootstrap.bat |
| @rem This is <span class="k">for</span> static libraries needed <span class="k">for</span> static_crt_build in appveyor |
| .<span class="se">\b</span><span class="m">2</span> <span class="nv">link</span><span class="o">=</span>static -with-filesystem -with-regex -with-system install |
| @rem this should put libraries and headers in c:<span class="se">\B</span>oost |
| </pre></div> |
| </div> |
| <ol class="arabic simple" start="4"> |
| <li><p>Activate anaconda/miniconda:</p></li> |
| </ol> |
| <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>@rem this might differ <span class="k">for</span> miniconda |
| C:<span class="se">\U</span>sers<span class="se">\U</span>ser<span class="se">\A</span>naconda3<span class="se">\S</span>cripts<span class="se">\a</span>ctivate |
| </pre></div> |
| </div> |
| <ol class="arabic simple" start="5"> |
| <li><p>Clone and change directories to the arrow source code (you might need to |
| install git).</p></li> |
| <li><p>Setup environment variables:</p></li> |
| </ol> |
| <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>@rem Change the build <span class="nb">type</span> based on which appveyor job you want. |
| SET <span class="nv">JOB</span><span class="o">=</span>Static_Crt_Build |
| SET <span class="nv">GENERATOR</span><span class="o">=</span>Ninja |
| SET <span class="nv">APPVEYOR_BUILD_WORKER_IMAGE</span><span class="o">=</span>Visual Studio <span class="m">2017</span> |
| SET <span class="nv">USE_CLCACHE</span><span class="o">=</span><span class="nb">false</span> |
| SET <span class="nv">ARROW_BUILD_GANDIVA</span><span class="o">=</span>OFF |
| SET <span class="nv">ARROW_LLVM_VERSION</span><span class="o">=</span><span class="m">8</span>.0.* |
| SET <span class="nv">PYTHON</span><span class="o">=</span><span class="m">3</span>.6 |
| SET <span class="nv">ARCH</span><span class="o">=</span><span class="m">64</span> |
| SET <span class="nv">PATH</span><span class="o">=</span>C:<span class="se">\U</span>sers<span class="se">\U</span>ser<span class="se">\A</span>naconda3<span class="p">;</span>C:<span class="se">\U</span>sers<span class="se">\U</span>ser<span class="se">\A</span>naconda3<span class="se">\S</span>cripts<span class="p">;</span>C:<span class="se">\U</span>sers<span class="se">\U</span>ser<span class="se">\A</span>naconda3<span class="se">\L</span>ibrary<span class="se">\b</span>in<span class="p">;</span>%PATH% |
| SET <span class="nv">BOOST_LIBRARYDIR</span><span class="o">=</span>C:<span class="se">\B</span>oost<span class="se">\l</span>ib |
| SET <span class="nv">BOOST_ROOT</span><span class="o">=</span>C:<span class="se">\B</span>oost |
| </pre></div> |
| </div> |
| <ol class="arabic simple" start="7"> |
| <li><p>Run appveyor scripts:</p></li> |
| </ol> |
| <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>.<span class="se">\c</span>i<span class="se">\a</span>ppveyor-install.bat |
| @rem this might fail but at this point most unit tests should be buildable by there individual targets |
| @rem see next line <span class="k">for</span> example. |
| .<span class="se">\c</span>i<span class="se">\a</span>ppveyor-build.bat |
| cmake --build . --config Release --target arrow-compute-hash-test |
| </pre></div> |
| </div> |
| </div> |
| </div> |
| |
| |
| </div> |
| |
| </div> |
| <footer> |
| |
| <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |
| |
| <a href="conventions.html" class="btn btn-neutral float-right" title="Conventions" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> |
| |
| |
| <a href="development.html" class="btn btn-neutral float-left" title="Development Guidelines" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> |
| |
| </div> |
| |
| |
| <hr/> |
| |
| <div role="contentinfo"> |
| <p> |
| |
| © Copyright 2016-2019 Apache Software Foundation |
| |
| </p> |
| </div> |
| |
| |
| |
| Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a |
| |
| <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> |
| |
| provided by <a href="https://readthedocs.org">Read the Docs</a>. |
| |
| </footer> |
| |
| </div> |
| </div> |
| |
| </section> |
| |
| </div> |
| |
| |
| <script type="text/javascript"> |
| jQuery(function () { |
| SphinxRtdTheme.Navigation.enable(true); |
| }); |
| </script> |
| |
| |
| |
| |
| |
| |
| |
| <script type="text/javascript" src="/docs/_static/versionwarning.js"></script></body> |
| </html> |
