| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| <meta http-equiv="X-UA-Compatible" content="IE=9"/> |
| <meta name="generator" content="Doxygen 1.8.6"/> |
| <title>Impala: impala::FileSystemUtil Class Reference</title> |
| <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="jquery.js"></script> |
| <script type="text/javascript" src="dynsections.js"></script> |
| <link href="navtree.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="resize.js"></script> |
| <script type="text/javascript" src="navtree.js"></script> |
| <script type="text/javascript"> |
| $(document).ready(initResizable); |
| $(window).load(resizeHeight); |
| </script> |
| <link href="search/search.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="search/search.js"></script> |
| <script type="text/javascript"> |
| $(document).ready(function() { searchBox.OnSelectItem(0); }); |
| </script> |
| <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| </head> |
| <body> |
| <div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| <div id="titlearea"> |
| <table cellspacing="0" cellpadding="0"> |
| <tbody> |
| <tr style="height: 56px;"> |
| <td style="padding-left: 0.5em;"> |
| <div id="projectname">Impala |
| </div> |
| <div id="projectbrief">Impalaistheopensource,nativeanalyticdatabaseforApacheHadoop.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.6 --> |
| <script type="text/javascript"> |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| </script> |
| <div id="navrow1" class="tabs"> |
| <ul class="tablist"> |
| <li><a href="index.html"><span>Main Page</span></a></li> |
| <li><a href="namespaces.html"><span>Namespaces</span></a></li> |
| <li class="current"><a href="annotated.html"><span>Classes</span></a></li> |
| <li><a href="files.html"><span>Files</span></a></li> |
| <li> |
| <div id="MSearchBox" class="MSearchBoxInactive"> |
| <span class="left"> |
| <img id="MSearchSelect" src="search/mag_sel.png" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| alt=""/> |
| <input type="text" id="MSearchField" value="Search" accesskey="S" |
| onfocus="searchBox.OnSearchFieldFocus(true)" |
| onblur="searchBox.OnSearchFieldFocus(false)" |
| onkeyup="searchBox.OnSearchFieldChange(event)"/> |
| </span><span class="right"> |
| <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> |
| </span> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div id="navrow2" class="tabs2"> |
| <ul class="tablist"> |
| <li><a href="annotated.html"><span>Class List</span></a></li> |
| <li><a href="classes.html"><span>Class Index</span></a></li> |
| <li><a href="inherits.html"><span>Class Hierarchy</span></a></li> |
| <li><a href="functions.html"><span>Class Members</span></a></li> |
| </ul> |
| </div> |
| </div><!-- top --> |
| <div id="side-nav" class="ui-resizable side-nav-resizable"> |
| <div id="nav-tree"> |
| <div id="nav-tree-contents"> |
| <div id="nav-sync" class="sync"></div> |
| </div> |
| </div> |
| <div id="splitbar" style="-moz-user-select:none;" |
| class="ui-resizable-handle"> |
| </div> |
| </div> |
| <script type="text/javascript"> |
| $(document).ready(function(){initNavTree('classimpala_1_1FileSystemUtil.html','');}); |
| </script> |
| <div id="doc-content"> |
| <!-- window showing the filter options --> |
| <div id="MSearchSelectWindow" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Macros</a></div> |
| |
| <!-- iframe showing the search results (closed by default) --> |
| <div id="MSearchResultsWindow"> |
| <iframe src="javascript:void(0)" frameborder="0" |
| name="MSearchResults" id="MSearchResults"> |
| </iframe> |
| </div> |
| |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-static-methods">Static Public Member Functions</a> | |
| <a href="classimpala_1_1FileSystemUtil-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">impala::FileSystemUtil Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p><code>#include <<a class="el" href="filesystem-util_8h_source.html">filesystem-util.h</a>></code></p> |
| <div class="dynheader"> |
| Collaboration diagram for impala::FileSystemUtil:</div> |
| <div class="dyncontent"> |
| <div class="center"><iframe scrolling="no" frameborder="0" src="classimpala_1_1FileSystemUtil__coll__graph.svg" width="163" height="163"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div> |
| </div> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a> |
| Static Public Member Functions</h2></td></tr> |
| <tr class="memitem:a6065567b7bb28e1325172b0b0aac0991"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classimpala_1_1Status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1FileSystemUtil.html#a6065567b7bb28e1325172b0b0aac0991">CreateDirectories</a> (const std::vector< std::string > &directories)</td></tr> |
| <tr class="separator:a6065567b7bb28e1325172b0b0aac0991"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a771310d2976c80472079b9fe0c918a66"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classimpala_1_1Status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1FileSystemUtil.html#a771310d2976c80472079b9fe0c918a66">CreateFile</a> (const std::string &file_path)</td></tr> |
| <tr class="memdesc:a771310d2976c80472079b9fe0c918a66"><td class="mdescLeft"> </td><td class="mdescRight">Create a file at the specified path. <a href="#a771310d2976c80472079b9fe0c918a66">More...</a><br/></td></tr> |
| <tr class="separator:a771310d2976c80472079b9fe0c918a66"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a851f73dacbc7a0d343e5c53718c17474"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classimpala_1_1Status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1FileSystemUtil.html#a851f73dacbc7a0d343e5c53718c17474">ResizeFile</a> (const std::string &file_path, int64_t trunc_len)</td></tr> |
| <tr class="memdesc:a851f73dacbc7a0d343e5c53718c17474"><td class="mdescLeft"> </td><td class="mdescRight">Resize a file to a specified length - uses unistd truncate(). <a href="#a851f73dacbc7a0d343e5c53718c17474">More...</a><br/></td></tr> |
| <tr class="separator:a851f73dacbc7a0d343e5c53718c17474"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a8bca8d57e72bf2b881b585dd17143af4"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classimpala_1_1Status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1FileSystemUtil.html#a8bca8d57e72bf2b881b585dd17143af4">RemovePaths</a> (const std::vector< std::string > &directories)</td></tr> |
| <tr class="memdesc:a8bca8d57e72bf2b881b585dd17143af4"><td class="mdescLeft"> </td><td class="mdescRight">Remove the specified paths and their enclosing files/directories. <a href="#a8bca8d57e72bf2b881b585dd17143af4">More...</a><br/></td></tr> |
| <tr class="separator:a8bca8d57e72bf2b881b585dd17143af4"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:acfd4221191ae225cb044dffa01cd1ed0"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classimpala_1_1Status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1FileSystemUtil.html#acfd4221191ae225cb044dffa01cd1ed0">VerifyIsDirectory</a> (const std::string &directory_path)</td></tr> |
| <tr class="separator:acfd4221191ae225cb044dffa01cd1ed0"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4ab790b902b4a05266791f9a7874832b"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classimpala_1_1Status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1FileSystemUtil.html#a4ab790b902b4a05266791f9a7874832b">GetSpaceAvailable</a> (const std::string &directory_path, <a class="el" href="classuint64__t.html">uint64_t</a> *available_bytes)</td></tr> |
| <tr class="separator:a4ab790b902b4a05266791f9a7874832b"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Utility class for common local file system operations such as file creation and deletion. This class should NOT be used to read or write data (<a class="el" href="classimpala_1_1DiskIoMgr.html">DiskIoMgr</a> is used for that). Errors are indicated by the status code RUNTIME_ERROR, and are not handled via exceptions. </p> |
| |
| <p>Definition at line <a class="el" href="filesystem-util_8h_source.html#l00026">26</a> of file <a class="el" href="filesystem-util_8h_source.html">filesystem-util.h</a>.</p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a class="anchor" id="a6065567b7bb28e1325172b0b0aac0991"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classimpala_1_1Status.html">Status</a> impala::FileSystemUtil::CreateDirectories </td> |
| <td>(</td> |
| <td class="paramtype">const std::vector< std::string > & </td> |
| <td class="paramname"><em>directories</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Create the specified directories. The directories and their contents are destroyed if they already exist. </p> |
| |
| <p>Definition at line <a class="el" href="filesystem-util_8cc_source.html#l00033">33</a> of file <a class="el" href="filesystem-util_8cc_source.html">filesystem-util.cc</a>.</p> |
| |
| <p>References <a class="el" href="webserver_8cc_source.html#l00115">impala::OK</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a771310d2976c80472079b9fe0c918a66"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classimpala_1_1Status.html">Status</a> impala::FileSystemUtil::CreateFile </td> |
| <td>(</td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>file_path</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Create a file at the specified path. </p> |
| |
| <p>Definition at line <a class="el" href="filesystem-util_8cc_source.html#l00066">66</a> of file <a class="el" href="filesystem-util_8cc_source.html">filesystem-util.cc</a>.</p> |
| |
| <p>References <a class="el" href="error-util_8cc_source.html#l00030">impala::GetStrErrMsg()</a>, and <a class="el" href="webserver_8cc_source.html#l00115">impala::OK</a>.</p> |
| |
| <p>Referenced by <a class="el" href="tmp-file-mgr_8cc_source.html#l00110">impala::TmpFileMgr::File::AllocateSpace()</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a4ab790b902b4a05266791f9a7874832b"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classimpala_1_1Status.html">Status</a> impala::FileSystemUtil::GetSpaceAvailable </td> |
| <td>(</td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>directory_path</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="classuint64__t.html">uint64_t</a> * </td> |
| <td class="paramname"><em>available_bytes</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Returns the space available on the file system containing 'directory_path' in 'available_bytes' </p> |
| |
| <p>Definition at line <a class="el" href="filesystem-util_8cc_source.html#l00114">114</a> of file <a class="el" href="filesystem-util_8cc_source.html">filesystem-util.cc</a>.</p> |
| |
| <p>References <a class="el" href="webserver_8cc_source.html#l00115">impala::OK</a>, and <a class="el" href="string-parser-test_8cc_source.html#l00031">impala::space</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a8bca8d57e72bf2b881b585dd17143af4"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classimpala_1_1Status.html">Status</a> impala::FileSystemUtil::RemovePaths </td> |
| <td>(</td> |
| <td class="paramtype">const std::vector< std::string > & </td> |
| <td class="paramname"><em>directories</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Remove the specified paths and their enclosing files/directories. </p> |
| |
| <p>Definition at line <a class="el" href="filesystem-util_8cc_source.html#l00053">53</a> of file <a class="el" href="filesystem-util_8cc_source.html">filesystem-util.cc</a>.</p> |
| |
| <p>References <a class="el" href="webserver_8cc_source.html#l00115">impala::OK</a>.</p> |
| |
| <p>Referenced by <a class="el" href="tmp-file-mgr_8cc_source.html#l00132">impala::TmpFileMgr::File::Remove()</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a851f73dacbc7a0d343e5c53718c17474"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classimpala_1_1Status.html">Status</a> impala::FileSystemUtil::ResizeFile </td> |
| <td>(</td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>file_path</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int64_t </td> |
| <td class="paramname"><em>trunc_len</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Resize a file to a specified length - uses unistd truncate(). </p> |
| |
| <p>Definition at line <a class="el" href="filesystem-util_8cc_source.html#l00085">85</a> of file <a class="el" href="filesystem-util_8cc_source.html">filesystem-util.cc</a>.</p> |
| |
| <p>References <a class="el" href="error-util_8cc_source.html#l00030">impala::GetStrErrMsg()</a>, and <a class="el" href="webserver_8cc_source.html#l00115">impala::OK</a>.</p> |
| |
| <p>Referenced by <a class="el" href="tmp-file-mgr_8cc_source.html#l00110">impala::TmpFileMgr::File::AllocateSpace()</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="acfd4221191ae225cb044dffa01cd1ed0"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classimpala_1_1Status.html">Status</a> impala::FileSystemUtil::VerifyIsDirectory </td> |
| <td>(</td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>directory_path</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Verify that the specified path is an existing directory. Returns <a class="el" href="classimpala_1_1Status.html#a580565665ea944eb64f3f495b1bee1e0">Status::OK</a> if it is, or a runtime error with a message otherwise. </p> |
| |
| <p>Definition at line <a class="el" href="filesystem-util_8cc_source.html#l00096">96</a> of file <a class="el" href="filesystem-util_8cc_source.html">filesystem-util.cc</a>.</p> |
| |
| <p>References <a class="el" href="webserver_8cc_source.html#l00115">impala::OK</a>.</p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following files:<ul> |
| <li>be/src/util/<a class="el" href="filesystem-util_8h_source.html">filesystem-util.h</a></li> |
| <li>be/src/util/<a class="el" href="filesystem-util_8cc_source.html">filesystem-util.cc</a></li> |
| </ul> |
| </div><!-- contents --> |
| </div><!-- doc-content --> |
| <!-- start footer part --> |
| <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> |
| <ul> |
| <li class="navelem"><a class="el" href="namespaceimpala.html">impala</a></li><li class="navelem"><a class="el" href="classimpala_1_1FileSystemUtil.html">FileSystemUtil</a></li> |
| <li class="footer">Generated on Thu May 7 2015 16:10:50 for Impala by |
| <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li> |
| </ul> |
| </div> |
| </body> |
| </html> |
