| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <meta charset="UTF-8" /> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> |
| <meta name="description" content="Apache Druid"> |
| <meta name="keywords" content="druid,kafka,database,analytics,streaming,real-time,real time,apache,open source"> |
| <meta name="author" content="Apache Software Foundation"> |
| |
| <title>Druid | Metadata Migration</title> |
| |
| <link rel="alternate" type="application/atom+xml" href="/feed"> |
| <link rel="shortcut icon" href="/img/favicon.png"> |
| |
| <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.7.2/css/all.css" integrity="sha384-fnmOCqbTlWIlj8LyTjo7mOUStjsKC4pOpQbqyi7RrhN7udi9RwhKkMHpvLbHG9Sr" crossorigin="anonymous"> |
| |
| <link href='//fonts.googleapis.com/css?family=Open+Sans+Condensed:300,700,300italic|Open+Sans:300italic,400italic,600italic,400,300,600,700' rel='stylesheet' type='text/css'> |
| |
| <link rel="stylesheet" href="/css/bootstrap-pure.css?v=1.1"> |
| <link rel="stylesheet" href="/css/base.css?v=1.1"> |
| <link rel="stylesheet" href="/css/header.css?v=1.1"> |
| <link rel="stylesheet" href="/css/footer.css?v=1.1"> |
| <link rel="stylesheet" href="/css/syntax.css?v=1.1"> |
| <link rel="stylesheet" href="/css/docs.css?v=1.1"> |
| |
| <script> |
| (function() { |
| var cx = '000162378814775985090:molvbm0vggm'; |
| var gcse = document.createElement('script'); |
| gcse.type = 'text/javascript'; |
| gcse.async = true; |
| gcse.src = (document.location.protocol == 'https:' ? 'https:' : 'http:') + |
| '//cse.google.com/cse.js?cx=' + cx; |
| var s = document.getElementsByTagName('script')[0]; |
| s.parentNode.insertBefore(gcse, s); |
| })(); |
| </script> |
| |
| |
| </head> |
| |
| <body> |
| <!-- Start page_header include --> |
| <script src="//ajax.googleapis.com/ajax/libs/jquery/2.2.4/jquery.min.js"></script> |
| |
| <div class="top-navigator"> |
| <div class="container"> |
| <div class="left-cont"> |
| <a class="logo" href="/"><span class="druid-logo"></span></a> |
| </div> |
| <div class="right-cont"> |
| <ul class="links"> |
| <li class=""><a href="/technology">Technology</a></li> |
| <li class=""><a href="/use-cases">Use Cases</a></li> |
| <li class=""><a href="/druid-powered">Powered By</a></li> |
| <li class=""><a href="/docs/latest/design/">Docs</a></li> |
| <li class=""><a href="/community/">Community</a></li> |
| <li class="header-dropdown"> |
| <a>Apache</a> |
| <div class="header-dropdown-menu"> |
| <a href="https://www.apache.org/" target="_blank">Foundation</a> |
| <a href="https://www.apache.org/events/current-event" target="_blank">Events</a> |
| <a href="https://www.apache.org/licenses/" target="_blank">License</a> |
| <a href="https://www.apache.org/foundation/thanks.html" target="_blank">Thanks</a> |
| <a href="https://www.apache.org/security/" target="_blank">Security</a> |
| <a href="https://www.apache.org/foundation/sponsorship.html" target="_blank">Sponsorship</a> |
| </div> |
| </li> |
| <li class=" button-link"><a href="/downloads.html">Download</a></li> |
| </ul> |
| </div> |
| </div> |
| <div class="action-button menu-icon"> |
| <span class="fa fa-bars"></span> MENU |
| </div> |
| <div class="action-button menu-icon-close"> |
| <span class="fa fa-times"></span> MENU |
| </div> |
| </div> |
| |
| <script type="text/javascript"> |
| var $menu = $('.right-cont'); |
| var $menuIcon = $('.menu-icon'); |
| var $menuIconClose = $('.menu-icon-close'); |
| |
| function showMenu() { |
| $menu.fadeIn(100); |
| $menuIcon.fadeOut(100); |
| $menuIconClose.fadeIn(100); |
| } |
| |
| $menuIcon.click(showMenu); |
| |
| function hideMenu() { |
| $menu.fadeOut(100); |
| $menuIconClose.fadeOut(100); |
| $menuIcon.fadeIn(100); |
| } |
| |
| $menuIconClose.click(hideMenu); |
| |
| $(window).resize(function() { |
| if ($(window).width() >= 840) { |
| $menu.fadeIn(100); |
| $menuIcon.fadeOut(100); |
| $menuIconClose.fadeOut(100); |
| } |
| else { |
| $menu.fadeOut(100); |
| $menuIcon.fadeIn(100); |
| $menuIconClose.fadeOut(100); |
| } |
| }); |
| </script> |
| |
| <!-- Stop page_header include --> |
| |
| |
| <div class="container doc-container"> |
| |
| |
| |
| |
| <p> Looking for the <a href="/docs/0.23.0/">latest stable documentation</a>?</p> |
| |
| |
| <div class="row"> |
| <div class="col-md-9 doc-content"> |
| <p> |
| <a class="btn btn-default btn-xs visible-xs-inline-block visible-sm-inline-block" href="#toc">Table of Contents</a> |
| </p> |
| <!-- |
| ~ 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. |
| --> |
| |
| <h1 id="metadata-migration">Metadata Migration</h1> |
| |
| <p>If you have been running an evaluation Druid cluster using the built-in Derby metadata storage and wish to migrate to a |
| more production-capable metadata store such as MySQL or PostgreSQL, this document describes the necessary steps.</p> |
| |
| <h2 id="shut-down-cluster-services">Shut down cluster services</h2> |
| |
| <p>To ensure a clean migration, shut down the non-coordinator services to ensure that metadata state will not |
| change as you do the migration.</p> |
| |
| <p>When migrating from Derby, the coordinator processes will still need to be up initially, as they host the Derby database.</p> |
| |
| <h2 id="exporting-metadata">Exporting metadata</h2> |
| |
| <p>Druid provides an <a href="../operations/export-metadata.html">Export Metadata Tool</a> for exporting metadata from Derby into CSV files |
| which can then be imported into your new metadata store.</p> |
| |
| <p>The tool also provides options for rewriting the deep storage locations of segments; this is useful |
| for <a href="../operations/deep-storage-migration.html">deep storage migration</a>.</p> |
| |
| <p>Run the <code>export-metadata</code> tool on your existing cluster, and save the CSV files it generates. After a successful export, you can shut down the coordinator.</p> |
| |
| <h2 id="initializing-the-new-metadata-store">Initializing the new metadata store</h2> |
| |
| <h3 id="create-database">Create database</h3> |
| |
| <p>Before importing the existing cluster metadata, you will need to set up the new metadata store.</p> |
| |
| <p>The <a href="../development/extensions-core/mysql.html">MySQL extension</a> and <a href="../development/extensions-core/postgresql.html">PostgreSQL extension</a> docs have instructions for initial database setup.</p> |
| |
| <h3 id="update-configuration">Update configuration</h3> |
| |
| <p>Update your Druid runtime properties with the new metadata configuration.</p> |
| |
| <h3 id="create-druid-tables">Create Druid tables</h3> |
| |
| <p>Druid provides a <code>metadata-init</code> tool for creating Druid's metadata tables. After initializing the Druid database, you can run the commands shown below from the root of the Druid package to initialize the tables.</p> |
| |
| <p>In the example commands below: |
| - <code>lib</code> is the the Druid lib directory |
| - <code>extensions</code> is the Druid extensions directory |
| - <code>base</code> corresponds to the value of <code>druid.metadata.storage.tables.base</code> in the configuration, <code>druid</code> by default. |
| - The <code>--connectURI</code> parameter corresponds to the value of <code>druid.metadata.storage.connector.connectURI</code>. |
| - The <code>--user</code> parameter corresponds to the value of <code>druid.metadata.storage.connector.user</code>. |
| - The <code>--password</code> parameter corresponds to the value of <code>druid.metadata.storage.connector.password</code>.</p> |
| |
| <h4 id="mysql">MySQL</h4> |
| <div class="highlight"><pre><code class="language-bash" data-lang="bash"><span></span><span class="nb">cd</span> <span class="si">${</span><span class="nv">DRUID_ROOT</span><span class="si">}</span> |
| java -classpath <span class="s2">"lib/*"</span> -Dlog4j.configurationFile<span class="o">=</span>conf/druid/cluster/_common/log4j2.xml -Ddruid.extensions.directory<span class="o">=</span><span class="s2">"extensions"</span> -Ddruid.extensions.loadList<span class="o">=[</span><span class="se">\"</span>mysql-metadata-storage<span class="se">\"</span><span class="o">]</span> -Ddruid.metadata.storage.type<span class="o">=</span>mysql org.apache.druid.cli.Main tools metadata-init --connectURI<span class="o">=</span><span class="s2">"<mysql-uri>"</span> --user <user> --password <pass> --base druid |
| </code></pre></div> |
| <h4 id="postgresql">PostgreSQL</h4> |
| <div class="highlight"><pre><code class="language-bash" data-lang="bash"><span></span><span class="nb">cd</span> <span class="si">${</span><span class="nv">DRUID_ROOT</span><span class="si">}</span> |
| java -classpath <span class="s2">"lib/*"</span> -Dlog4j.configurationFile<span class="o">=</span>conf/druid/cluster/_common/log4j2.xml -Ddruid.extensions.directory<span class="o">=</span><span class="s2">"extensions"</span> -Ddruid.extensions.loadList<span class="o">=[</span><span class="se">\"</span>postgresql-metadata-storage<span class="se">\"</span><span class="o">]</span> -Ddruid.metadata.storage.type<span class="o">=</span>postgresql org.apache.druid.cli.Main tools metadata-init --connectURI<span class="o">=</span><span class="s2">"<postgresql-uri>"</span> --user <user> --password <pass> --base druid |
| </code></pre></div> |
| <h3 id="import-metadata">Import metadata</h3> |
| |
| <p>After initializing the tables, please refer to the <a href="../operations/export-metadata.html#importing-metadata">import commands</a> for your target database. </p> |
| |
| <h3 id="restart-cluster">Restart cluster</h3> |
| |
| <p>After importing the metadata successfully, you can now restart your cluster.</p> |
| |
| </div> |
| <div class="col-md-3"> |
| <div class="searchbox"> |
| <gcse:searchbox-only></gcse:searchbox-only> |
| </div> |
| <div id="toc" class="nav toc hidden-print"> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <!-- Start page_footer include --> |
| <footer class="druid-footer"> |
| <div class="container"> |
| <div class="text-center"> |
| <p> |
| <a href="/technology">Technology</a> ·  |
| <a href="/use-cases">Use Cases</a> ·  |
| <a href="/druid-powered">Powered by Druid</a> ·  |
| <a href="/docs/latest/">Docs</a> ·  |
| <a href="/community/">Community</a> ·  |
| <a href="/downloads.html">Download</a> ·  |
| <a href="/faq">FAQ</a> |
| </p> |
| </div> |
| <div class="text-center"> |
| <a title="Join the user group" href="https://groups.google.com/forum/#!forum/druid-user" target="_blank"><span class="fa fa-comments"></span></a> ·  |
| <a title="Follow Druid" href="https://twitter.com/druidio" target="_blank"><span class="fab fa-twitter"></span></a> ·  |
| <a title="GitHub" href="https://github.com/apache/druid" target="_blank"><span class="fab fa-github"></span></a> |
| </div> |
| <div class="text-center license"> |
| Copyright © 2020 <a href="https://www.apache.org/" target="_blank">Apache Software Foundation</a>.<br> |
| Except where otherwise noted, licensed under <a rel="license" href="http://creativecommons.org/licenses/by-sa/4.0/">CC BY-SA 4.0</a>.<br> |
| Apache Druid, Druid, and the Druid logo are either registered trademarks or trademarks of The Apache Software Foundation in the United States and other countries. |
| </div> |
| </div> |
| </footer> |
| |
| <script async src="https://www.googletagmanager.com/gtag/js?id=UA-131010415-1"></script> |
| <script> |
| window.dataLayer = window.dataLayer || []; |
| function gtag(){dataLayer.push(arguments);} |
| gtag('js', new Date()); |
| gtag('config', 'UA-131010415-1'); |
| </script> |
| <script> |
| function trackDownload(type, url) { |
| ga('send', 'event', 'download', type, url); |
| } |
| </script> |
| <script src="//code.jquery.com/jquery.min.js"></script> |
| <script src="//maxcdn.bootstrapcdn.com/bootstrap/3.2.0/js/bootstrap.min.js"></script> |
| <script src="/assets/js/druid.js"></script> |
| <!-- stop page_footer include --> |
| |
| |
| <script> |
| $(function() { |
| $(".toc").load("/docs/0.15.1-incubating/toc.html"); |
| |
| // There is no way to tell when .gsc-input will be async loaded into the page so just try to set a placeholder until it works |
| var tries = 0; |
| var timer = setInterval(function() { |
| tries++; |
| if (tries > 300) clearInterval(timer); |
| var searchInput = $('input.gsc-input'); |
| if (searchInput.length) { |
| searchInput.attr('placeholder', 'Search'); |
| clearInterval(timer); |
| } |
| }, 100); |
| }); |
| </script> |
| </body> |
| </html> |
