| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>PersistentStoreProvider (Drill : 1.20.3 API)</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="PersistentStoreProvider (Drill : 1.20.3 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":18,"i2":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/PersistentStoreProvider.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../org/apache/drill/exec/store/sys/PersistentStoreMode.html" title="enum in org.apache.drill.exec.store.sys"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/drill/exec/store/sys/PersistentStoreRegistry.html" title="class in org.apache.drill.exec.store.sys"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/drill/exec/store/sys/PersistentStoreProvider.html" target="_top">Frames</a></li> |
| <li><a href="PersistentStoreProvider.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.drill.exec.store.sys</div> |
| <h2 title="Interface PersistentStoreProvider" class="title">Interface PersistentStoreProvider</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../../../org/apache/drill/exec/store/sys/store/provider/BasePersistentStoreProvider.html" title="class in org.apache.drill.exec.store.sys.store.provider">BasePersistentStoreProvider</a>, <a href="../../../../../../org/apache/drill/exec/store/sys/store/provider/CachingPersistentStoreProvider.html" title="class in org.apache.drill.exec.store.sys.store.provider">CachingPersistentStoreProvider</a>, <a href="../../../../../../org/apache/drill/exec/store/hbase/config/HBasePersistentStoreProvider.html" title="class in org.apache.drill.exec.store.hbase.config">HBasePersistentStoreProvider</a>, <a href="../../../../../../org/apache/drill/exec/store/hbase/config/HBasePStoreProvider.html" title="class in org.apache.drill.exec.store.hbase.config">HBasePStoreProvider</a>, <a href="../../../../../../org/apache/drill/exec/store/sys/store/provider/InMemoryStoreProvider.html" title="class in org.apache.drill.exec.store.sys.store.provider">InMemoryStoreProvider</a>, <a href="../../../../../../org/apache/drill/exec/store/sys/store/provider/LocalPersistentStoreProvider.html" title="class in org.apache.drill.exec.store.sys.store.provider">LocalPersistentStoreProvider</a>, <a href="../../../../../../org/apache/drill/exec/store/mongo/config/MongoPersistentStoreProvider.html" title="class in org.apache.drill.exec.store.mongo.config">MongoPersistentStoreProvider</a>, <a href="../../../../../../org/apache/drill/exec/store/sys/zk/ZkPStoreProvider.html" title="class in org.apache.drill.exec.store.sys.zk">ZkPStoreProvider</a>, <a href="../../../../../../org/apache/drill/exec/store/sys/store/provider/ZookeeperPersistentStoreProvider.html" title="class in org.apache.drill.exec.store.sys.store.provider">ZookeeperPersistentStoreProvider</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">PersistentStoreProvider</span> |
| extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></pre> |
| <div class="block">A factory used to create <a href="../../../../../../org/apache/drill/exec/store/sys/PersistentStore.html" title="interface in org.apache.drill.exec.store.sys"><code>store</code></a> instances.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><V> <a href="../../../../../../org/apache/drill/exec/store/sys/PersistentStore.html" title="interface in org.apache.drill.exec.store.sys">PersistentStore</a><V></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/store/sys/PersistentStoreProvider.html#getOrCreateStore-org.apache.drill.exec.store.sys.PersistentStoreConfig-">getOrCreateStore</a></span>(<a href="../../../../../../org/apache/drill/exec/store/sys/PersistentStoreConfig.html" title="class in org.apache.drill.exec.store.sys">PersistentStoreConfig</a><V> config)</code> |
| <div class="block">Gets or creates a <a href="../../../../../../org/apache/drill/exec/store/sys/PersistentStore.html" title="interface in org.apache.drill.exec.store.sys"><code>persistent store</code></a> for the given configuration.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>default <V> <a href="../../../../../../org/apache/drill/exec/store/sys/VersionedPersistentStore.html" title="interface in org.apache.drill.exec.store.sys">VersionedPersistentStore</a><V></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/store/sys/PersistentStoreProvider.html#getOrCreateVersionedStore-org.apache.drill.exec.store.sys.PersistentStoreConfig-">getOrCreateVersionedStore</a></span>(<a href="../../../../../../org/apache/drill/exec/store/sys/PersistentStoreConfig.html" title="class in org.apache.drill.exec.store.sys">PersistentStoreConfig</a><V> config)</code> |
| <div class="block">Override this method if store supports versioning and return versioning instance.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/store/sys/PersistentStoreProvider.html#start--">start</a></span>()</code> |
| <div class="block">Sets up the provider.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.AutoCloseable"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true#close--" title="class or interface in java.lang">close</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getOrCreateStore-org.apache.drill.exec.store.sys.PersistentStoreConfig-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOrCreateStore</h4> |
| <pre><V> <a href="../../../../../../org/apache/drill/exec/store/sys/PersistentStore.html" title="interface in org.apache.drill.exec.store.sys">PersistentStore</a><V> getOrCreateStore(<a href="../../../../../../org/apache/drill/exec/store/sys/PersistentStoreConfig.html" title="class in org.apache.drill.exec.store.sys">PersistentStoreConfig</a><V> config) |
| throws <a href="../../../../../../org/apache/drill/exec/exception/StoreException.html" title="class in org.apache.drill.exec.exception">StoreException</a></pre> |
| <div class="block">Gets or creates a <a href="../../../../../../org/apache/drill/exec/store/sys/PersistentStore.html" title="interface in org.apache.drill.exec.store.sys"><code>persistent store</code></a> for the given configuration. |
| |
| Note that implementors have liberty to cache previous <a href="../../../../../../org/apache/drill/exec/store/sys/PersistentStore.html" title="interface in org.apache.drill.exec.store.sys"><code>store</code></a> instances.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>V</code> - store value type</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>config</code> - store configuration</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>persistent store instance</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/drill/exec/exception/StoreException.html" title="class in org.apache.drill.exec.exception">StoreException</a></code> - in case when unable to create store</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getOrCreateVersionedStore-org.apache.drill.exec.store.sys.PersistentStoreConfig-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOrCreateVersionedStore</h4> |
| <pre>default <V> <a href="../../../../../../org/apache/drill/exec/store/sys/VersionedPersistentStore.html" title="interface in org.apache.drill.exec.store.sys">VersionedPersistentStore</a><V> getOrCreateVersionedStore(<a href="../../../../../../org/apache/drill/exec/store/sys/PersistentStoreConfig.html" title="class in org.apache.drill.exec.store.sys">PersistentStoreConfig</a><V> config) |
| throws <a href="../../../../../../org/apache/drill/exec/exception/StoreException.html" title="class in org.apache.drill.exec.exception">StoreException</a></pre> |
| <div class="block">Override this method if store supports versioning and return versioning instance. |
| By default, undefined version wrapper will be used.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>V</code> - store value type</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>config</code> - store configuration</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>versioned persistent store instance</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/drill/exec/exception/StoreException.html" title="class in org.apache.drill.exec.exception">StoreException</a></code> - in case when unable to create store</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="start--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>start</h4> |
| <pre>void start() |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> |
| <div class="block">Sets up the provider.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/PersistentStoreProvider.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../org/apache/drill/exec/store/sys/PersistentStoreMode.html" title="enum in org.apache.drill.exec.store.sys"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/drill/exec/store/sys/PersistentStoreRegistry.html" title="class in org.apache.drill.exec.store.sys"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/drill/exec/store/sys/PersistentStoreProvider.html" target="_top">Frames</a></li> |
| <li><a href="PersistentStoreProvider.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 1970 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
