| <!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"/> |
| <title>MADlib: utilities.sql_in File Reference</title> |
| |
| <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| <link href="navtree.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="jquery.js"></script> |
| <script type="text/javascript" src="resize.js"></script> |
| <script type="text/javascript" src="navtree.js"></script> |
| <script type="text/javascript"> |
| $(document).ready(initResizable); |
| </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> |
| <script src="../mathjax/MathJax.js"> |
| MathJax.Hub.Config({ |
| extensions: ["tex2jax.js", "TeX/AMSmath.js", "TeX/AMSsymbols.js"], |
| jax: ["input/TeX","output/HTML-CSS"], |
| }); |
| </script> |
| </head> |
| <body> |
| <div id="top"><!-- do not remove this div! --> |
| |
| |
| <div id="titlearea"> |
| <table cellspacing="0" cellpadding="0"> |
| <tbody> |
| <tr style="height: 56px;"> |
| |
| |
| <td style="padding-left: 0.5em;"> |
| <div id="projectname">MADlib |
|  <span id="projectnumber">0.7</span> <span style="font-size:10pt; font-style:italic"><a href="../latest/./utilities_8sql__in.html"> A newer version is available</a></span> |
| </div> |
| <div id="projectbrief">User Documentation</div> |
| </td> |
| |
| |
| |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| |
| <!-- Generated by Doxygen 1.7.5.1 --> |
| <script type="text/javascript"> |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| </script> |
| <script type="text/javascript" src="dynsections.js"></script> |
| <div id="navrow1" class="tabs"> |
| <ul class="tablist"> |
| <li><a href="index.html"><span>Main Page</span></a></li> |
| <li><a href="modules.html"><span>Modules</span></a></li> |
| <li class="current"><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="files.html"><span>File List</span></a></li> |
| <li><a href="globals.html"><span>File Members</span></a></li> |
| </ul> |
| </div> |
| </div> |
| <div id="side-nav" class="ui-resizable side-nav-resizable"> |
| <div id="nav-tree"> |
| <div id="nav-tree-contents"> |
| </div> |
| </div> |
| <div id="splitbar" style="-moz-user-select:none;" |
| class="ui-resizable-handle"> |
| </div> |
| </div> |
| <script type="text/javascript"> |
| initNavTree('utilities_8sql__in.html',''); |
| </script> |
| <div id="doc-content"> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#func-members">Functions</a> </div> |
| <div class="headertitle"> |
| <div class="title">utilities.sql_in File Reference</div> </div> |
| </div> |
| <div class="contents"> |
| |
| <p>SQL functions for carrying out routine tasks. |
| <a href="#details">More...</a></p> |
| |
| <p><a href="utilities_8sql__in_source.html">Go to the source code of this file.</a></p> |
| <table class="memberdecls"> |
| <tr><td colspan="2"><h2><a name="func-members"></a> |
| Functions</h2></td></tr> |
| <tr><td class="memItemLeft" align="right" valign="top">text </td><td class="memItemRight" valign="bottom"><a class="el" href="utilities_8sql__in.html#a9ce7ffa76acc8a0638e9bc48be99f36a">version</a> ()</td></tr> |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Return MADlib build information. <a href="#a9ce7ffa76acc8a0638e9bc48be99f36a"></a><br/></td></tr> |
| <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a76cfdbed8a6782f37f50710d855434bd"></a><!-- doxytag: member="utilities.sql_in::assert" ref="a76cfdbed8a6782f37f50710d855434bd" args="(boolean condition, varchar msg)" --> |
| void </td><td class="memItemRight" valign="bottom"><a class="el" href="utilities_8sql__in.html#a76cfdbed8a6782f37f50710d855434bd">assert</a> (boolean condition, varchar msg)</td></tr> |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Raise an exception if the given condition is not satisfied. <br/></td></tr> |
| <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4d49e00b4dd6059f61ffb9fdc0a696f7"></a><!-- doxytag: member="utilities.sql_in::relative_error" ref="a4d49e00b4dd6059f61ffb9fdc0a696f7" args="(float8 approx, float8 value)" --> |
| float8 </td><td class="memItemRight" valign="bottom"><a class="el" href="utilities_8sql__in.html#a4d49e00b4dd6059f61ffb9fdc0a696f7">relative_error</a> (float8 approx, float8 value)</td></tr> |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Compute the relative error of an approximate value. <br/></td></tr> |
| <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a26a54368fbf2460323cacf95db76fd2f"></a><!-- doxytag: member="utilities.sql_in::relative_error" ref="a26a54368fbf2460323cacf95db76fd2f" args="(float8[] approx, float8[] value)" --> |
| float8 </td><td class="memItemRight" valign="bottom"><a class="el" href="utilities_8sql__in.html#a26a54368fbf2460323cacf95db76fd2f">relative_error</a> (float8[] approx, float8[] value)</td></tr> |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Compute the relative error (w.r.t. the 2-norm) of an apprixmate vector. <br/></td></tr> |
| <tr><td class="memItemLeft" align="right" valign="top">boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="utilities_8sql__in.html#aa90ffaebb43a5cbcb5c48281cbadd3b0">check_if_raises_error</a> (text sql)</td></tr> |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Check if a SQL statement raises an error. <a href="#aa90ffaebb43a5cbcb5c48281cbadd3b0"></a><br/></td></tr> |
| <tr><td class="memItemLeft" align="right" valign="top">boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="utilities_8sql__in.html#a48bed63cab78a5446fa4c122eaae3a40">isnan</a> (float8 number)</td></tr> |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Check if a floating-point number is NaN (not a number) <a href="#a48bed63cab78a5446fa4c122eaae3a40"></a><br/></td></tr> |
| <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a56501b6f9fabe65d7a6a6beb70a0e000"></a><!-- doxytag: member="utilities.sql_in::create_schema_pg_temp" ref="a56501b6f9fabe65d7a6a6beb70a0e000" args="()" --> |
| void </td><td class="memItemRight" valign="bottom"><a class="el" href="utilities_8sql__in.html#a56501b6f9fabe65d7a6a6beb70a0e000">create_schema_pg_temp</a> ()</td></tr> |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Create the temporary schema if it does not exist yet. <br/></td></tr> |
| <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="utilities_8sql__in.html#ab194d6a1222672c314ea39b78aad8fd0">noop</a> ()</td></tr> |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Create volatile noop function. <a href="#ab194d6a1222672c314ea39b78aad8fd0"></a><br/></td></tr> |
| <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5b0156044142673183205154f9e63ddc"></a><!-- doxytag: member="utilities.sql_in::__unique_string" ref="a5b0156044142673183205154f9e63ddc" args="()" --> |
| varchar </td><td class="memItemRight" valign="bottom"><a class="el" href="utilities_8sql__in.html#a5b0156044142673183205154f9e63ddc">__unique_string</a> ()</td></tr> |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Generate random remporary names for temp table and other names. <br/></td></tr> |
| <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abc867482053e6692047d051b679953a5"></a><!-- doxytag: member="utilities.sql_in::bool_to_text" ref="abc867482053e6692047d051b679953a5" args="(boolean)" --> |
| text </td><td class="memItemRight" valign="bottom"><a class="el" href="utilities_8sql__in.html#abc867482053e6692047d051b679953a5">bool_to_text</a> (boolean)</td></tr> |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Cast boolean into text. <br/></td></tr> |
| </table> |
| <hr/><a name="details" id="details"></a><h2>Detailed Description</h2> |
| <div class="textblock"><dl class="see"><dt><b>See also:</b></dt><dd>For a brief overview of utility functions, see the module description <a class="el" href="group__grp__utilities.html">DB Administrator Utilities</a>. </dd></dl> |
| |
| <p>Definition in file <a class="el" href="utilities_8sql__in_source.html">utilities.sql_in</a>.</p> |
| </div><hr/><h2>Function Documentation</h2> |
| <a class="anchor" id="aa90ffaebb43a5cbcb5c48281cbadd3b0"></a><!-- doxytag: member="utilities.sql_in::check_if_raises_error" ref="aa90ffaebb43a5cbcb5c48281cbadd3b0" args="(text sql)" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">boolean check_if_raises_error </td> |
| <td>(</td> |
| <td class="paramtype">text </td> |
| <td class="paramname"><em>sql</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| <dl><dt><b>Parameters:</b></dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">sql</td><td>The SQL statement </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="return"><dt><b>Returns:</b></dt><dd><code>TRUE</code> if an exception is raised while executing <code>sql</code>, <code>FALSE</code> otherwise. </dd></dl> |
| |
| <p>Definition at line <a class="el" href="utilities_8sql__in_source.html#l00123">123</a> of file <a class="el" href="utilities_8sql__in_source.html">utilities.sql_in</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a48bed63cab78a5446fa4c122eaae3a40"></a><!-- doxytag: member="utilities.sql_in::isnan" ref="a48bed63cab78a5446fa4c122eaae3a40" args="(float8 number)" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">boolean isnan </td> |
| <td>(</td> |
| <td class="paramtype">float8 </td> |
| <td class="paramname"><em>number</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| <p>This function exists for portability. Some DBMSs like PostgreSQL treat floating-point numbers as fully ordered -- contrary to IEEE 754. (See, e.g., the <a href="http://www.postgresql.org/docs/current/static/datatype-numeric.html#DATATYPE-FLOAT">PostgreSQL documentation</a>. For portability, MADlib code should not make use of such "features" directly, but only use <a class="el" href="utilities_8sql__in.html#a48bed63cab78a5446fa4c122eaae3a40" title="Check if a floating-point number is NaN (not a number)">isnan()</a> instead.</p> |
| <dl><dt><b>Parameters:</b></dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">number</td><td></td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="return"><dt><b>Returns:</b></dt><dd><code>TRUE</code> if <code>number</code> is <code>NaN</code>, <code>FALSE</code> otherwise </dd></dl> |
| |
| <p>Definition at line <a class="el" href="utilities_8sql__in_source.html#l00152">152</a> of file <a class="el" href="utilities_8sql__in_source.html">utilities.sql_in</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ab194d6a1222672c314ea39b78aad8fd0"></a><!-- doxytag: member="utilities.sql_in::noop" ref="ab194d6a1222672c314ea39b78aad8fd0" args="()" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void noop </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| <p>The only use of this function is as an optimization fence when used in the SELECT list of a query. See, e.g., <a href="http://archives.postgresql.org/pgsql-sql/2012-07/msg00030.php">http://archives.postgresql.org/pgsql-sql/2012-07/msg00030.php</a> </p> |
| |
| <p>Definition at line <a class="el" href="utilities_8sql__in_source.html#l00191">191</a> of file <a class="el" href="utilities_8sql__in_source.html">utilities.sql_in</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a9ce7ffa76acc8a0638e9bc48be99f36a"></a><!-- doxytag: member="utilities.sql_in::version" ref="a9ce7ffa76acc8a0638e9bc48be99f36a" args="()" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">text version </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| <dl class="return"><dt><b>Returns:</b></dt><dd>Summary of MADlib build information, consisting of MADlib version, git revision, cmake configuration time, build type, build system, C compiler, and C++ compiler </dd></dl> |
| |
| <p>Definition at line <a class="el" href="utilities_8sql__in_source.html#l00055">55</a> of file <a class="el" href="utilities_8sql__in_source.html">utilities.sql_in</a>.</p> |
| |
| </div> |
| </div> |
| </div> |
| </div> |
| <div id="nav-path" class="navpath"> |
| <ul> |
| <li class="navelem"><a class="el" href="utilities_8sql__in.html">utilities.sql_in</a> </li> |
| <!-- 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>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Functions</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> |
| |
| |
| <li class="footer">Generated on Fri May 10 2013 01:37:13 for MADlib by |
| <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.5.1 </li> |
| </ul> |
| </div> |
| |
| |
| </body> |
| </html> |
