| <!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.4"/> |
| <title>MADlib: summary.sql_in Source File</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> |
| <script type="text/x-mathjax-config"> |
| MathJax.Hub.Config({ |
| extensions: ["tex2jax.js", "TeX/AMSmath.js", "TeX/AMSsymbols.js"], |
| jax: ["input/TeX","output/HTML-CSS"], |
| }); |
| </script><script src="../mathjax/MathJax.js"></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">MADlib |
|  <span id="projectnumber">1.1</span> <span style="font-size:10pt; font-style:italic"><a href="../latest/./summary_8sql__in_source.html"> A newer version is available</a></span> |
| </div> |
| <div id="projectbrief">User Documentation</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.4 --> |
| <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="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><!-- 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('summary_8sql__in_source.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>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Groups</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="headertitle"> |
| <div class="title">summary.sql_in</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <a href="summary_8sql__in.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/* ----------------------------------------------------------------------- */</span><span class="comment">/**</span></div> |
| <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> *</span></div> |
| <div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * @file summary.sql_in</span></div> |
| <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> *</span></div> |
| <div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * @brief Summary function for descriptive statistics</span></div> |
| <div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * @date Mar 2013</span></div> |
| <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> *</span></div> |
| <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> */</span><span class="comment">/* ------------------------------------------------------------------------*/</span></div> |
| <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> </div> |
| <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> m4_include(`SQLCommon.m4<span class="stringliteral">')</span></div> |
| <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="stringliteral"></span><span class="comment"></span></div> |
| <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">/**</span></div> |
| <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"></span></div> |
| <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">@addtogroup grp_summary</span></div> |
| <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"></span></div> |
| <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">@about</span></div> |
| <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"></span></div> |
| <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">'summary' is a generic function used to produce summary statistics of any data </span></div> |
| <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment">table. The function invokes particular 'methods' from the MADlib library to </span></div> |
| <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment">provide an overview of the data. </span></div> |
| <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"></span></div> |
| <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment">@usage</span></div> |
| <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment">The summary function can be invoked in the following way:</span></div> |
| <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment">@verbatim</span></div> |
| <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment">SELECT MADLIB_SCHEMA.summary</span></div> |
| <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment">(</span></div> |
| <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> source_table TEXT, -- Source table name (Required)</span></div> |
| <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> output_table TEXT, -- Output table name (Required)</span></div> |
| <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> target_cols TEXT, -- Comma separated columns for which summary is desired</span></div> |
| <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"> -- (Default: NULL - produces result for all columns)</span></div> |
| <div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"> grouping_cols TEXT, -- Comma separated columns on which to group results</span></div> |
| <div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"> -- (Default: NULL - provides summary on complete table)</span></div> |
| <div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"> get_distinct BOOLEAN, -- Are distinct values required?</span></div> |
| <div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"> -- (Default: True)</span></div> |
| <div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment"> get_quartiles BOOLEAN, -- Are quartiles required?</span></div> |
| <div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment"> -- (Default: True)</span></div> |
| <div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"> ntile_array FLOAT8[], -- Array of quantile values to compute</span></div> |
| <div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"> -- (Default: NULL - Quantile array not included)</span></div> |
| <div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"> how_many_mfv INTEGER, -- How many most-frequent-values to compute?</span></div> |
| <div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"> -- (Default: 10)</span></div> |
| <div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"> get_estimates BOOLEAN -- Should we produce exact or estimated values?</span></div> |
| <div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment">) -- (Default: True)</span></div> |
| <div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment">@endverbatim</span></div> |
| <div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"></span></div> |
| <div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment">Note:</span></div> |
| <div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment">- Currently, estimated values are only implemented for the distinct values </span></div> |
| <div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment">computation. </span></div> |
| <div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment">- The '<em>get_estimates</em>' parameter controls computation for two statistics</span></div> |
| <div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"> - If '<em>get_estimates</em>' is True then the distinct value computation is</span></div> |
| <div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"> estimated. Further, the most frequent values computation is computed using </span></div> |
| <div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"> a "quick and dirty" method that does parallel aggregation in GPDB</span></div> |
| <div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment"> at the expense of missing some of the most frequent values.</span></div> |
| <div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment"> - If '<em>get_estimates</em>' is False then the distinct values are computed</span></div> |
| <div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"> in a slow but exact method. The most frequent values are computed using a</span></div> |
| <div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment"> faithful implementation that preserves the approximation guarantees of </span></div> |
| <div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"> the Cormode/Muthukrishnan method (more information in \ref grp_mfvsketch) </span></div> |
| <div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment"></span></div> |
| <div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment"></span></div> |
| <div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment">The output of the function is a composite type containing: </span></div> |
| <div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment"> ouput_table TEXT, -- Name of the output table</span></div> |
| <div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"> row_count INT4, -- Number of rows in the output table</span></div> |
| <div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment"> duration FLOAT8 -- Time taken (in seconds) to compute the summary </span></div> |
| <div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment"></span></div> |
| <div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment">The summary stastics are stored in the 'output_table' relation provided in the</span></div> |
| <div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment">arguments. The relation 'output_table' can contain the following table</span></div> |
| <div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment">(presence of some columns depends on the argument values)</span></div> |
| <div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment">@verbatim</span></div> |
| <div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment"> - group_by_column : Group-by column names (NULL if none provided)</span></div> |
| <div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment"> - group_by_value : Values of the Group-by column (NULL if no grouping)</span></div> |
| <div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment"> - target_column : Targeted column values for which summary is requested</span></div> |
| <div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment"> - column_number : Physical column number for the target column, as described in pg_attribute</span></div> |
| <div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment"> - data_type : Data type of target column. Standard GPDB descriptors will be displayed</span></div> |
| <div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment"> - row_count : Number of rows for the target column</span></div> |
| <div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment"> - distinct_values : Number of distinct values in the target column</span></div> |
| <div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment"> - missing_values : Number of missing values in the target column</span></div> |
| <div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment"> - blank_values : Number of blank values (blanks are defined by the regular expression '^\w*$')</span></div> |
| <div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment"> - fraction_missing : Percentage of total rows that are missing. Will be expressed as a decimal (e.g. 0.3)</span></div> |
| <div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment"> - fraction_blank : Percentage of total rows that are blank. Will be expressed as a decimal (e.g. 0.3)</span></div> |
| <div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment"> - mean : Mean value of target column (if target is numeric, else NULL)</span></div> |
| <div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment"> - variance : Variance of target columns (if target is numeric, else NULL for strings)</span></div> |
| <div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment"> - min : Min value of target column (for strings this is the length of the shortest string)</span></div> |
| <div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment"> - max : Max value of target column (for strings this is the length of the longest string)</span></div> |
| <div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="comment"> - first_quartile : First quartile (25th percentile, only for numeric columns)</span></div> |
| <div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="comment"> - median : Median value of target column (if target is numeric, else NULL)</span></div> |
| <div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="comment"> - third_quartile : Third quartile (25th percentile, only for numeric columns)</span></div> |
| <div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment"> - quantile_array : Percentile values corresponding to ntile_array</span></div> |
| <div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment"> - most_frequent_values : Most frequent values</span></div> |
| <div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="comment"> - mfv_frequencies : Frequency of the most frequent values </span></div> |
| <div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment">@endverbatim</span></div> |
| <div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="comment"></span></div> |
| <div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="comment">The output can be obtained as</span></div> |
| <div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="comment">@verbatim</span></div> |
| <div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="comment">sql> SELECT * FROM 'output_table';</span></div> |
| <div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="comment">@endverbatim</span></div> |
| <div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="comment"></span></div> |
| <div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="comment">The usage information can be obtained at any time directly from the</span></div> |
| <div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="comment">function using</span></div> |
| <div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="comment">@verbatim</span></div> |
| <div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="comment">sql> SELECT summary('usage');</span></div> |
| <div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="comment">@endverbatim</span></div> |
| <div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="comment"></span></div> |
| <div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="comment">*/</span></div> |
| <div class="line"><a name="l00103"></a><span class="lineno"> 103</span> </div> |
| <div class="line"><a name="l00104"></a><span class="lineno"> 104</span> DROP TYPE IF EXISTS MADLIB_SCHEMA.summary_result;</div> |
| <div class="line"><a name="l00105"></a><span class="lineno"> 105</span> CREATE TYPE MADLIB_SCHEMA.summary_result AS</div> |
| <div class="line"><a name="l00106"></a><span class="lineno"> 106</span> (</div> |
| <div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  ouputtable TEXT,</div> |
| <div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  row_count INT4,</div> |
| <div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  duration FLOAT8</div> |
| <div class="line"><a name="l00110"></a><span class="lineno"> 110</span> );</div> |
| <div class="line"><a name="l00111"></a><span class="lineno"> 111</span> </div> |
| <div class="line"><a name="l00112"></a><span class="lineno"> 112</span> </div> |
| <div class="line"><a name="l00113"></a><span class="lineno"> 113</span> -----------------------------------------------------------------------</div> |
| <div class="line"><a name="l00114"></a><span class="lineno"> 114</span> -- Main function for summary</div> |
| <div class="line"><a name="l00115"></a><span class="lineno"> 115</span> -----------------------------------------------------------------------</div> |
| <div class="line"><a name="l00116"></a><span class="lineno"> 116</span> /*</div> |
| <div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  * @brief Compute a summary statistics on a table with optional grouping support</div> |
| <div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  * </div> |
| <div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  * @param source_table Name of source relation containing the data</div> |
| <div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  * @param output_table Name of output table name to store the summary</div> |
| <div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  * @param target_cols String with comma separated list of columns on which summary is desired</div> |
| <div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  * @param grouping_cols String with comma separated list of columns on which to group the data by</div> |
| <div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  * @param get_distinct Should distinct values count be included in result</div> |
| <div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  * @param get_quartiles Should first, second (median), and third quartiles be included in result</div> |
| <div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  * @param ntile_array Array of percentiles to compute</div> |
| <div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  * @param how_many_mfv How many most frequent values to compute?</div> |
| <div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  * @param get_estimates Should distinct counts be an estimated (faster) or exact count?</div> |
| <div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  *</div> |
| <div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  * @usage</div> |
| <div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  * </div> |
| <div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  * <pre> SELECT MADLIB_SCHEMA.summary (</div> |
| <div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  * '<em>source_table</em><span class="stringliteral">', '</span><em>output_table</em><span class="stringliteral">', </span></div> |
| <div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <span class="stringliteral"> * '</span><em>target_cols</em><span class="stringliteral">', '</span><em>grouping_cols</em><span class="stringliteral">', </span></div> |
| <div class="line"><a name="l00134"></a><span class="lineno"> 134</span> <span class="stringliteral"> * '</span><em>get_distinct</em><span class="stringliteral">', '</span><em>get_quartiles</em><span class="stringliteral">',</span></div> |
| <div class="line"><a name="l00135"></a><span class="lineno"> 135</span> <span class="stringliteral"> * '</span><em>ntile_array</em><span class="stringliteral">', '</span><em>how_many_mfv</em><span class="stringliteral">',</span></div> |
| <div class="line"><a name="l00136"></a><span class="lineno"> 136</span> <span class="stringliteral"> * '</span><em>get_estimates</em><span class="stringliteral">' </span></div> |
| <div class="line"><a name="l00137"></a><span class="lineno"> 137</span> <span class="stringliteral"> * );</span></div> |
| <div class="line"><a name="l00138"></a><span class="lineno"> 138</span> <span class="stringliteral"> * SELECT * FROM '</span><em>output_table</em><span class="stringliteral">'</span></div> |
| <div class="line"><a name="l00139"></a><span class="lineno"> 139</span> <span class="stringliteral"> * </pre> </span></div> |
| <div class="line"><a name="l00140"></a><span class="lineno"> 140</span> <span class="stringliteral"> */</span></div> |
| <div class="line"><a name="l00141"></a><span class="lineno"> 141</span> <span class="stringliteral">CREATE OR REPLACE FUNCTION</span></div> |
| <div class="line"><a name="l00142"></a><span class="lineno"> 142</span> <span class="stringliteral">MADLIB_SCHEMA.summary</span></div> |
| <div class="line"><a name="l00143"></a><span class="lineno"> 143</span> <span class="stringliteral">(</span></div> |
| <div class="line"><a name="l00144"></a><span class="lineno"> 144</span> <span class="stringliteral"> source_table TEXT, -- source table name</span></div> |
| <div class="line"><a name="l00145"></a><span class="lineno"> 145</span> <span class="stringliteral"> output_table TEXT, -- output table name</span></div> |
| <div class="line"><a name="l00146"></a><span class="lineno"> 146</span> <span class="stringliteral"> target_cols TEXT, -- comma separated list of output cols</span></div> |
| <div class="line"><a name="l00147"></a><span class="lineno"> 147</span> <span class="stringliteral"> grouping_cols TEXT, -- comma separated names of grouping cols</span></div> |
| <div class="line"><a name="l00148"></a><span class="lineno"> 148</span> <span class="stringliteral"> get_distinct BOOLEAN, -- Are distinct values required</span></div> |
| <div class="line"><a name="l00149"></a><span class="lineno"> 149</span> <span class="stringliteral"> get_quartiles BOOLEAN, -- Are quartiles required</span></div> |
| <div class="line"><a name="l00150"></a><span class="lineno"> 150</span> <span class="stringliteral"> ntile_array FLOAT8[], -- Array of quantiles to compute</span></div> |
| <div class="line"><a name="l00151"></a><span class="lineno"> 151</span> <span class="stringliteral"> how_many_mfv INTEGER, -- How many most frequent values to compute?</span></div> |
| <div class="line"><a name="l00152"></a><span class="lineno"> 152</span> <span class="stringliteral"> get_estimates BOOLEAN -- Should we produce exact or estimated</span></div> |
| <div class="line"><a name="l00153"></a><span class="lineno"> 153</span> <span class="stringliteral"> -- values for distinct computation</span></div> |
| <div class="line"><a name="l00154"></a><span class="lineno"> 154</span> <span class="stringliteral">)</span></div> |
| <div class="line"><a name="l00155"></a><span class="lineno"> 155</span> <span class="stringliteral">RETURNS MADLIB_SCHEMA.summary_result AS $$</span></div> |
| <div class="line"><a name="l00156"></a><span class="lineno"> 156</span> <span class="stringliteral"> PythonFunctionBodyOnly(`summary'</span>, `summary<span class="stringliteral">')</span></div> |
| <div class="line"><a name="l00157"></a><span class="lineno"> 157</span> <span class="stringliteral"> return summary.summary(</span></div> |
| <div class="line"><a name="l00158"></a><span class="lineno"> 158</span> <span class="stringliteral"> schema_madlib, source_table, output_table, target_cols, grouping_cols,</span></div> |
| <div class="line"><a name="l00159"></a><span class="lineno"> 159</span> <span class="stringliteral"> get_distinct, get_quartiles, ntile_array, how_many_mfv, get_estimates)</span></div> |
| <div class="line"><a name="l00160"></a><span class="lineno"> 160</span> <span class="stringliteral">$$ LANGUAGE plpythonu;</span></div> |
| <div class="line"><a name="l00161"></a><span class="lineno"> 161</span> <span class="stringliteral"></span></div> |
| <div class="line"><a name="l00162"></a><span class="lineno"> 162</span> <span class="stringliteral">-----------------------------------------------------------------------</span></div> |
| <div class="line"><a name="l00163"></a><span class="lineno"> 163</span> <span class="stringliteral">--- Overloaded functions to support optional parameters</span></div> |
| <div class="line"><a name="l00164"></a><span class="lineno"> 164</span> <span class="stringliteral">-----------------------------------------------------------------------</span></div> |
| <div class="line"><a name="l00165"></a><span class="lineno"> 165</span> <span class="stringliteral">CREATE OR REPLACE FUNCTION</span></div> |
| <div class="line"><a name="l00166"></a><span class="lineno"> 166</span> <span class="stringliteral">MADLIB_SCHEMA.summary</span></div> |
| <div class="line"><a name="l00167"></a><span class="lineno"> 167</span> <span class="stringliteral">(</span></div> |
| <div class="line"><a name="l00168"></a><span class="lineno"> 168</span> <span class="stringliteral"> source_table TEXT,</span></div> |
| <div class="line"><a name="l00169"></a><span class="lineno"> 169</span> <span class="stringliteral"> output_table TEXT,</span></div> |
| <div class="line"><a name="l00170"></a><span class="lineno"> 170</span> <span class="stringliteral"> target_cols TEXT,</span></div> |
| <div class="line"><a name="l00171"></a><span class="lineno"> 171</span> <span class="stringliteral"> grouping_cols TEXT,</span></div> |
| <div class="line"><a name="l00172"></a><span class="lineno"> 172</span> <span class="stringliteral"> get_distinct BOOLEAN,</span></div> |
| <div class="line"><a name="l00173"></a><span class="lineno"> 173</span> <span class="stringliteral"> get_quartiles BOOLEAN,</span></div> |
| <div class="line"><a name="l00174"></a><span class="lineno"> 174</span> <span class="stringliteral"> ntile_array FLOAT8[],</span></div> |
| <div class="line"><a name="l00175"></a><span class="lineno"> 175</span> <span class="stringliteral"> how_many_mfv INTEGER</span></div> |
| <div class="line"><a name="l00176"></a><span class="lineno"> 176</span> <span class="stringliteral">)</span></div> |
| <div class="line"><a name="l00177"></a><span class="lineno"> 177</span> <span class="stringliteral">RETURNS MADLIB_SCHEMA.summary_result AS $$</span></div> |
| <div class="line"><a name="l00178"></a><span class="lineno"> 178</span> <span class="stringliteral"> SELECT MADLIB_SCHEMA.summary(</span></div> |
| <div class="line"><a name="l00179"></a><span class="lineno"> 179</span> <span class="stringliteral"> $1, $2, $3, $4, $5, $6, $7, $8, True)</span></div> |
| <div class="line"><a name="l00180"></a><span class="lineno"> 180</span> <span class="stringliteral">$$ LANGUAGE sql;</span></div> |
| <div class="line"><a name="l00181"></a><span class="lineno"> 181</span> <span class="stringliteral"></span></div> |
| <div class="line"><a name="l00182"></a><span class="lineno"> 182</span> <span class="stringliteral">CREATE OR REPLACE FUNCTION</span></div> |
| <div class="line"><a name="l00183"></a><span class="lineno"> 183</span> <span class="stringliteral">MADLIB_SCHEMA.summary</span></div> |
| <div class="line"><a name="l00184"></a><span class="lineno"> 184</span> <span class="stringliteral">(</span></div> |
| <div class="line"><a name="l00185"></a><span class="lineno"> 185</span> <span class="stringliteral"> source_table TEXT,</span></div> |
| <div class="line"><a name="l00186"></a><span class="lineno"> 186</span> <span class="stringliteral"> output_table TEXT,</span></div> |
| <div class="line"><a name="l00187"></a><span class="lineno"> 187</span> <span class="stringliteral"> target_cols TEXT,</span></div> |
| <div class="line"><a name="l00188"></a><span class="lineno"> 188</span> <span class="stringliteral"> grouping_cols TEXT,</span></div> |
| <div class="line"><a name="l00189"></a><span class="lineno"> 189</span> <span class="stringliteral"> get_distinct BOOLEAN,</span></div> |
| <div class="line"><a name="l00190"></a><span class="lineno"> 190</span> <span class="stringliteral"> get_quartiles BOOLEAN,</span></div> |
| <div class="line"><a name="l00191"></a><span class="lineno"> 191</span> <span class="stringliteral"> ntile_array FLOAT8[]</span></div> |
| <div class="line"><a name="l00192"></a><span class="lineno"> 192</span> <span class="stringliteral">)</span></div> |
| <div class="line"><a name="l00193"></a><span class="lineno"> 193</span> <span class="stringliteral">RETURNS MADLIB_SCHEMA.summary_result AS $$</span></div> |
| <div class="line"><a name="l00194"></a><span class="lineno"> 194</span> <span class="stringliteral"> SELECT MADLIB_SCHEMA.summary(</span></div> |
| <div class="line"><a name="l00195"></a><span class="lineno"> 195</span> <span class="stringliteral"> $1, $2, $3, $4, $5, $6, $7, 10, True)</span></div> |
| <div class="line"><a name="l00196"></a><span class="lineno"> 196</span> <span class="stringliteral">$$ LANGUAGE sql;</span></div> |
| <div class="line"><a name="l00197"></a><span class="lineno"> 197</span> <span class="stringliteral"></span></div> |
| <div class="line"><a name="l00198"></a><span class="lineno"> 198</span> <span class="stringliteral">CREATE OR REPLACE FUNCTION</span></div> |
| <div class="line"><a name="l00199"></a><span class="lineno"> 199</span> <span class="stringliteral">MADLIB_SCHEMA.summary</span></div> |
| <div class="line"><a name="l00200"></a><span class="lineno"> 200</span> <span class="stringliteral">(</span></div> |
| <div class="line"><a name="l00201"></a><span class="lineno"> 201</span> <span class="stringliteral"> source_table TEXT,</span></div> |
| <div class="line"><a name="l00202"></a><span class="lineno"> 202</span> <span class="stringliteral"> output_table TEXT,</span></div> |
| <div class="line"><a name="l00203"></a><span class="lineno"> 203</span> <span class="stringliteral"> target_cols TEXT,</span></div> |
| <div class="line"><a name="l00204"></a><span class="lineno"> 204</span> <span class="stringliteral"> grouping_cols TEXT,</span></div> |
| <div class="line"><a name="l00205"></a><span class="lineno"> 205</span> <span class="stringliteral"> get_distinct BOOLEAN,</span></div> |
| <div class="line"><a name="l00206"></a><span class="lineno"> 206</span> <span class="stringliteral"> get_quartiles BOOLEAN</span></div> |
| <div class="line"><a name="l00207"></a><span class="lineno"> 207</span> <span class="stringliteral">)</span></div> |
| <div class="line"><a name="l00208"></a><span class="lineno"> 208</span> <span class="stringliteral">RETURNS MADLIB_SCHEMA.summary_result AS $$</span></div> |
| <div class="line"><a name="l00209"></a><span class="lineno"> 209</span> <span class="stringliteral"> SELECT MADLIB_SCHEMA.summary(</span></div> |
| <div class="line"><a name="l00210"></a><span class="lineno"> 210</span> <span class="stringliteral"> $1, $2, $3, $4, $5, $6, NULL, 10, True)</span></div> |
| <div class="line"><a name="l00211"></a><span class="lineno"> 211</span> <span class="stringliteral">$$ LANGUAGE sql;</span></div> |
| <div class="line"><a name="l00212"></a><span class="lineno"> 212</span> <span class="stringliteral"></span></div> |
| <div class="line"><a name="l00213"></a><span class="lineno"> 213</span> <span class="stringliteral">CREATE OR REPLACE FUNCTION</span></div> |
| <div class="line"><a name="l00214"></a><span class="lineno"> 214</span> <span class="stringliteral">MADLIB_SCHEMA.summary</span></div> |
| <div class="line"><a name="l00215"></a><span class="lineno"> 215</span> <span class="stringliteral">(</span></div> |
| <div class="line"><a name="l00216"></a><span class="lineno"> 216</span> <span class="stringliteral"> source_table TEXT,</span></div> |
| <div class="line"><a name="l00217"></a><span class="lineno"> 217</span> <span class="stringliteral"> output_table TEXT,</span></div> |
| <div class="line"><a name="l00218"></a><span class="lineno"> 218</span> <span class="stringliteral"> target_cols TEXT,</span></div> |
| <div class="line"><a name="l00219"></a><span class="lineno"> 219</span> <span class="stringliteral"> grouping_cols TEXT,</span></div> |
| <div class="line"><a name="l00220"></a><span class="lineno"> 220</span> <span class="stringliteral"> get_distinct BOOLEAN</span></div> |
| <div class="line"><a name="l00221"></a><span class="lineno"> 221</span> <span class="stringliteral">)</span></div> |
| <div class="line"><a name="l00222"></a><span class="lineno"> 222</span> <span class="stringliteral">RETURNS MADLIB_SCHEMA.summary_result AS $$</span></div> |
| <div class="line"><a name="l00223"></a><span class="lineno"> 223</span> <span class="stringliteral"> SELECT MADLIB_SCHEMA.summary(</span></div> |
| <div class="line"><a name="l00224"></a><span class="lineno"> 224</span> <span class="stringliteral"> $1, $2, $3, $4, $5, True, NULL, 10, True)</span></div> |
| <div class="line"><a name="l00225"></a><span class="lineno"> 225</span> <span class="stringliteral">$$ LANGUAGE sql;</span></div> |
| <div class="line"><a name="l00226"></a><span class="lineno"> 226</span> <span class="stringliteral"></span></div> |
| <div class="line"><a name="l00227"></a><span class="lineno"> 227</span> <span class="stringliteral">CREATE OR REPLACE FUNCTION</span></div> |
| <div class="line"><a name="l00228"></a><span class="lineno"> 228</span> <span class="stringliteral">MADLIB_SCHEMA.summary</span></div> |
| <div class="line"><a name="l00229"></a><span class="lineno"> 229</span> <span class="stringliteral">(</span></div> |
| <div class="line"><a name="l00230"></a><span class="lineno"> 230</span> <span class="stringliteral"> source_table TEXT,</span></div> |
| <div class="line"><a name="l00231"></a><span class="lineno"> 231</span> <span class="stringliteral"> output_table TEXT,</span></div> |
| <div class="line"><a name="l00232"></a><span class="lineno"> 232</span> <span class="stringliteral"> target_cols TEXT,</span></div> |
| <div class="line"><a name="l00233"></a><span class="lineno"> 233</span> <span class="stringliteral"> grouping_cols TEXT</span></div> |
| <div class="line"><a name="l00234"></a><span class="lineno"> 234</span> <span class="stringliteral">)</span></div> |
| <div class="line"><a name="l00235"></a><span class="lineno"> 235</span> <span class="stringliteral">RETURNS MADLIB_SCHEMA.summary_result AS $$</span></div> |
| <div class="line"><a name="l00236"></a><span class="lineno"> 236</span> <span class="stringliteral"> SELECT MADLIB_SCHEMA.summary(</span></div> |
| <div class="line"><a name="l00237"></a><span class="lineno"> 237</span> <span class="stringliteral"> $1, $2, $3, $4, True, True, NULL, 10, True)</span></div> |
| <div class="line"><a name="l00238"></a><span class="lineno"> 238</span> <span class="stringliteral">$$ LANGUAGE sql;</span></div> |
| <div class="line"><a name="l00239"></a><span class="lineno"> 239</span> <span class="stringliteral"></span></div> |
| <div class="line"><a name="l00240"></a><span class="lineno"> 240</span> <span class="stringliteral">CREATE OR REPLACE FUNCTION</span></div> |
| <div class="line"><a name="l00241"></a><span class="lineno"> 241</span> <span class="stringliteral">MADLIB_SCHEMA.summary</span></div> |
| <div class="line"><a name="l00242"></a><span class="lineno"> 242</span> <span class="stringliteral">(</span></div> |
| <div class="line"><a name="l00243"></a><span class="lineno"> 243</span> <span class="stringliteral"> source_table TEXT,</span></div> |
| <div class="line"><a name="l00244"></a><span class="lineno"> 244</span> <span class="stringliteral"> output_table TEXT,</span></div> |
| <div class="line"><a name="l00245"></a><span class="lineno"> 245</span> <span class="stringliteral"> target_cols TEXT</span></div> |
| <div class="line"><a name="l00246"></a><span class="lineno"> 246</span> <span class="stringliteral">)</span></div> |
| <div class="line"><a name="l00247"></a><span class="lineno"> 247</span> <span class="stringliteral">RETURNS MADLIB_SCHEMA.summary_result AS $$</span></div> |
| <div class="line"><a name="l00248"></a><span class="lineno"> 248</span> <span class="stringliteral"> SELECT MADLIB_SCHEMA.summary(</span></div> |
| <div class="line"><a name="l00249"></a><span class="lineno"> 249</span> <span class="stringliteral"> $1, $2, $3, NULL, True, True, NULL, 10, True)</span></div> |
| <div class="line"><a name="l00250"></a><span class="lineno"> 250</span> <span class="stringliteral">$$ LANGUAGE sql;</span></div> |
| <div class="line"><a name="l00251"></a><span class="lineno"> 251</span> <span class="stringliteral"></span></div> |
| <div class="line"><a name="l00252"></a><span class="lineno"> 252</span> <span class="stringliteral">CREATE OR REPLACE FUNCTION</span></div> |
| <div class="line"><a name="l00253"></a><span class="lineno"> 253</span> <span class="stringliteral">MADLIB_SCHEMA.summary</span></div> |
| <div class="line"><a name="l00254"></a><span class="lineno"> 254</span> <span class="stringliteral">(</span></div> |
| <div class="line"><a name="l00255"></a><span class="lineno"> 255</span> <span class="stringliteral"> source_table TEXT,</span></div> |
| <div class="line"><a name="l00256"></a><span class="lineno"> 256</span> <span class="stringliteral"> output_table TEXT</span></div> |
| <div class="line"><a name="l00257"></a><span class="lineno"> 257</span> <span class="stringliteral">)</span></div> |
| <div class="line"><a name="l00258"></a><span class="lineno"> 258</span> <span class="stringliteral">RETURNS MADLIB_SCHEMA.summary_result AS $$</span></div> |
| <div class="line"><a name="l00259"></a><span class="lineno"> 259</span> <span class="stringliteral"> SELECT MADLIB_SCHEMA.summary(</span></div> |
| <div class="line"><a name="l00260"></a><span class="lineno"> 260</span> <span class="stringliteral"> $1, $2, NULL, NULL, True, True, NULL, 10, True)</span></div> |
| <div class="line"><a name="l00261"></a><span class="lineno"> 261</span> <span class="stringliteral">$$ LANGUAGE sql;</span></div> |
| <div class="line"><a name="l00262"></a><span class="lineno"> 262</span> <span class="stringliteral"></span></div> |
| <div class="line"><a name="l00263"></a><span class="lineno"> 263</span> <span class="stringliteral">-----------------------------------------------------------------------</span></div> |
| <div class="line"><a name="l00264"></a><span class="lineno"> 264</span> <span class="stringliteral">-- Help functions</span></div> |
| <div class="line"><a name="l00265"></a><span class="lineno"> 265</span> <span class="stringliteral">-----------------------------------------------------------------------</span></div> |
| <div class="line"><a name="l00266"></a><span class="lineno"> 266</span> <span class="stringliteral">CREATE OR REPLACE FUNCTION MADLIB_SCHEMA.summary(</span></div> |
| <div class="line"><a name="l00267"></a><span class="lineno"> 267</span> <span class="stringliteral"> input_message TEXT</span></div> |
| <div class="line"><a name="l00268"></a><span class="lineno"> 268</span> <span class="stringliteral">)</span></div> |
| <div class="line"><a name="l00269"></a><span class="lineno"> 269</span> <span class="stringliteral">RETURNS TEXT AS $$</span></div> |
| <div class="line"><a name="l00270"></a><span class="lineno"> 270</span> <span class="stringliteral">PythonFunctionBodyOnly(`summary'</span>, `summary<span class="stringliteral">')</span></div> |
| <div class="line"><a name="l00271"></a><span class="lineno"> 271</span> <span class="stringliteral"> return summary.summary_help_message(schema_madlib, input_message)</span></div> |
| <div class="line"><a name="l00272"></a><span class="lineno"> 272</span> <span class="stringliteral">$$ LANGUAGE plpythonu;</span></div> |
| <div class="line"><a name="l00273"></a><span class="lineno"> 273</span> <span class="stringliteral"></span></div> |
| <div class="line"><a name="l00274"></a><span class="lineno"> 274</span> <span class="stringliteral"></span></div> |
| <div class="line"><a name="l00275"></a><span class="lineno"> 275</span> <span class="stringliteral">CREATE OR REPLACE FUNCTION MADLIB_SCHEMA.summary()</span></div> |
| <div class="line"><a name="l00276"></a><span class="lineno"> 276</span> <span class="stringliteral">RETURNS TEXT AS $$</span></div> |
| <div class="line"><a name="l00277"></a><span class="lineno"> 277</span> <span class="stringliteral">PythonFunctionBodyOnly(`summary'</span>, `summary<span class="stringliteral">')</span></div> |
| <div class="line"><a name="l00278"></a><span class="lineno"> 278</span> <span class="stringliteral"> return summary.summary_help_message(schema_madlib, None)</span></div> |
| <div class="line"><a name="l00279"></a><span class="lineno"> 279</span> <span class="stringliteral">$$ LANGUAGE plpythonu;</span></div> |
| </div><!-- fragment --></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="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_efbcf68973d247bbf15f9eecae7f24e3.html">ports</a></li><li class="navelem"><a class="el" href="dir_a4a48839224ef8488facbffa8a397967.html">postgres</a></li><li class="navelem"><a class="el" href="dir_dc596537ad427a4d866006d1a3e1fe29.html">modules</a></li><li class="navelem"><a class="el" href="dir_5ff04c1d4b766f0a4dd68c6f19ed2092.html">summary</a></li><li class="navelem"><a class="el" href="summary_8sql__in.html">summary.sql_in</a></li> |
| <li class="footer">Generated on Wed Aug 21 2013 16:09:52 for MADlib by |
| <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.4 </li> |
| </ul> |
| </div> |
| </body> |
| </html> |
