| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| <meta http-equiv="X-UA-Compatible" content="IE=11"/> |
| <meta name="generator" content="Doxygen 1.9.8"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>iceberg-cpp: iceberg::SortOrder 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="search/search.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="search/searchdata.js"></script> |
| <script type="text/javascript" src="search/search.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 id="projectrow"> |
| <td id="projectalign"> |
| <div id="projectname">iceberg-cpp |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.9.8 --> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| var searchBox = new SearchBox("searchBox", "search/",'.html'); |
| /* @license-end */ |
| </script> |
| <script type="text/javascript" src="menudata.js"></script> |
| <script type="text/javascript" src="menu.js"></script> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| /* @license-end */ |
| </script> |
| <div id="main-nav"></div> |
| <!-- window showing the filter options --> |
| <div id="MSearchSelectWindow" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| </div> |
| |
| <!-- iframe showing the search results (closed by default) --> |
| <div id="MSearchResultsWindow"> |
| <div id="MSearchResults"> |
| <div class="SRPage"> |
| <div id="SRIndex"> |
| <div id="SRResults"></div> |
| <div class="SRStatus" id="Loading">Loading...</div> |
| <div class="SRStatus" id="Searching">Searching...</div> |
| <div class="SRStatus" id="NoMatches">No Matches</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="nav-path" class="navpath"> |
| <ul> |
| <li class="navelem"><a class="el" href="namespaceiceberg.html">iceberg</a></li><li class="navelem"><a class="el" href="classiceberg_1_1SortOrder.html">SortOrder</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#pub-static-methods">Static Public Member Functions</a> | |
| <a href="#pub-static-attribs">Static Public Attributes</a> | |
| <a href="#friends">Friends</a> | |
| <a href="classiceberg_1_1SortOrder-members.html">List of all members</a> </div> |
| <div class="headertitle"><div class="title">iceberg::SortOrder Class Reference</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>A sort order for a table. |
| <a href="classiceberg_1_1SortOrder.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="sort__order_8h_source.html">sort_order.h</a>></code></p> |
| <div class="dynheader"> |
| Inheritance diagram for iceberg::SortOrder:</div> |
| <div class="dyncontent"> |
| <div class="center"> |
| <img src="classiceberg_1_1SortOrder.png" usemap="#iceberg::SortOrder_map" alt=""/> |
| <map id="iceberg::SortOrder_map" name="iceberg::SortOrder_map"> |
| <area href="classiceberg_1_1util_1_1Formattable.html" title="Interface for objects that can be formatted via std::format." alt="iceberg::util::Formattable" shape="rect" coords="0,0,149,24"/> |
| </map> |
| </div></div> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a> |
| Public Member Functions</h2></td></tr> |
| <tr class="memitem:a435ae990ea0403f3ed72a4ca4eb16826" id="r_a435ae990ea0403f3ed72a4ca4eb16826"><td class="memItemLeft" align="right" valign="top"><a id="a435ae990ea0403f3ed72a4ca4eb16826" name="a435ae990ea0403f3ed72a4ca4eb16826"></a> |
| int32_t </td><td class="memItemRight" valign="bottom"><b>order_id</b> () const</td></tr> |
| <tr class="memdesc:a435ae990ea0403f3ed72a4ca4eb16826"><td class="mdescLeft"> </td><td class="mdescRight">Get the sort order id. <br /></td></tr> |
| <tr class="separator:a435ae990ea0403f3ed72a4ca4eb16826"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3d76e6d1e25bf0dbb71abafceb137460" id="r_a3d76e6d1e25bf0dbb71abafceb137460"><td class="memItemLeft" align="right" valign="top"><a id="a3d76e6d1e25bf0dbb71abafceb137460" name="a3d76e6d1e25bf0dbb71abafceb137460"></a> |
| std::span< const <a class="el" href="classiceberg_1_1SortField.html">SortField</a> > </td><td class="memItemRight" valign="bottom"><b>fields</b> () const</td></tr> |
| <tr class="memdesc:a3d76e6d1e25bf0dbb71abafceb137460"><td class="mdescLeft"> </td><td class="mdescRight">Get the list of sort fields. <br /></td></tr> |
| <tr class="separator:a3d76e6d1e25bf0dbb71abafceb137460"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a8977284c54414a42de765b62f6ffa8be" id="r_a8977284c54414a42de765b62f6ffa8be"><td class="memItemLeft" align="right" valign="top"><a id="a8977284c54414a42de765b62f6ffa8be" name="a8977284c54414a42de765b62f6ffa8be"></a> |
| bool </td><td class="memItemRight" valign="bottom"><b>is_sorted</b> () const</td></tr> |
| <tr class="memdesc:a8977284c54414a42de765b62f6ffa8be"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the sort order is sorted. <br /></td></tr> |
| <tr class="separator:a8977284c54414a42de765b62f6ffa8be"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aefd7a817beb22614afdf38c47972402b" id="r_aefd7a817beb22614afdf38c47972402b"><td class="memItemLeft" align="right" valign="top"><a id="aefd7a817beb22614afdf38c47972402b" name="aefd7a817beb22614afdf38c47972402b"></a> |
| bool </td><td class="memItemRight" valign="bottom"><b>is_unsorted</b> () const</td></tr> |
| <tr class="memdesc:aefd7a817beb22614afdf38c47972402b"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the sort order is unsorted A <a class="el" href="classiceberg_1_1SortOrder.html" title="A sort order for a table.">SortOrder</a> is unsorted if it has no sort fields. <br /></td></tr> |
| <tr class="separator:aefd7a817beb22614afdf38c47972402b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a96ae7a3606da995281c3596b8a8f3f0a" id="r_a96ae7a3606da995281c3596b8a8f3f0a"><td class="memItemLeft" align="right" valign="top"><a id="a96ae7a3606da995281c3596b8a8f3f0a" name="a96ae7a3606da995281c3596b8a8f3f0a"></a> |
| bool </td><td class="memItemRight" valign="bottom"><b>Satisfies</b> (const <a class="el" href="classiceberg_1_1SortOrder.html">SortOrder</a> &other) const</td></tr> |
| <tr class="memdesc:a96ae7a3606da995281c3596b8a8f3f0a"><td class="mdescLeft"> </td><td class="mdescRight">Checks whether this order satisfies another order. <br /></td></tr> |
| <tr class="separator:a96ae7a3606da995281c3596b8a8f3f0a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a215e9af82ede865fa8dddbe41ad161d0" id="r_a215e9af82ede865fa8dddbe41ad161d0"><td class="memItemLeft" align="right" valign="top"><a id="a215e9af82ede865fa8dddbe41ad161d0" name="a215e9af82ede865fa8dddbe41ad161d0"></a> |
| bool </td><td class="memItemRight" valign="bottom"><b>SameOrder</b> (const <a class="el" href="classiceberg_1_1SortOrder.html">SortOrder</a> &other) const</td></tr> |
| <tr class="memdesc:a215e9af82ede865fa8dddbe41ad161d0"><td class="mdescLeft"> </td><td class="mdescRight">Checks whether this order is equivalent to another order while ignoring the order id. <br /></td></tr> |
| <tr class="separator:a215e9af82ede865fa8dddbe41ad161d0"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a7d626fad1d95f50267685adaf32c4603" id="r_a7d626fad1d95f50267685adaf32c4603"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1SortOrder.html#a7d626fad1d95f50267685adaf32c4603">ToString</a> () const override</td></tr> |
| <tr class="memdesc:a7d626fad1d95f50267685adaf32c4603"><td class="mdescLeft"> </td><td class="mdescRight">Get a user-readable string representation. <br /></td></tr> |
| <tr class="separator:a7d626fad1d95f50267685adaf32c4603"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa71cfc0be980a16c5e883d896f5cc392" id="r_aa71cfc0be980a16c5e883d896f5cc392"><td class="memItemLeft" align="right" valign="top">Status </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1SortOrder.html#aa71cfc0be980a16c5e883d896f5cc392">Validate</a> (const <a class="el" href="classiceberg_1_1Schema.html">Schema</a> &schema) const</td></tr> |
| <tr class="memdesc:aa71cfc0be980a16c5e883d896f5cc392"><td class="mdescLeft"> </td><td class="mdescRight">Validates the sort order against a schema. <br /></td></tr> |
| <tr class="separator:aa71cfc0be980a16c5e883d896f5cc392"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a> |
| Static Public Member Functions</h2></td></tr> |
| <tr class="memitem:aabdf79223b16bcf0f52838eddf15d85b" id="r_aabdf79223b16bcf0f52838eddf15d85b"><td class="memItemLeft" align="right" valign="top"><a id="aabdf79223b16bcf0f52838eddf15d85b" name="aabdf79223b16bcf0f52838eddf15d85b"></a> |
| static const std::shared_ptr< <a class="el" href="classiceberg_1_1SortOrder.html">SortOrder</a> > & </td><td class="memItemRight" valign="bottom"><b>Unsorted</b> ()</td></tr> |
| <tr class="memdesc:aabdf79223b16bcf0f52838eddf15d85b"><td class="mdescLeft"> </td><td class="mdescRight">Get an unsorted sort order singleton. <br /></td></tr> |
| <tr class="separator:aabdf79223b16bcf0f52838eddf15d85b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ada02ec1d02015f380e6038e36e862b14" id="r_ada02ec1d02015f380e6038e36e862b14"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result</a>< std::unique_ptr< <a class="el" href="classiceberg_1_1SortOrder.html">SortOrder</a> > > </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1SortOrder.html#ada02ec1d02015f380e6038e36e862b14">Make</a> (const <a class="el" href="classiceberg_1_1Schema.html">Schema</a> &schema, int32_t sort_id, std::vector< <a class="el" href="classiceberg_1_1SortField.html">SortField</a> > <a class="el" href="classiceberg_1_1SortOrder.html#a3d76e6d1e25bf0dbb71abafceb137460">fields</a>)</td></tr> |
| <tr class="memdesc:ada02ec1d02015f380e6038e36e862b14"><td class="mdescLeft"> </td><td class="mdescRight">Create a <a class="el" href="classiceberg_1_1SortOrder.html" title="A sort order for a table.">SortOrder</a>. <br /></td></tr> |
| <tr class="separator:ada02ec1d02015f380e6038e36e862b14"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a285b57b4642f6f4af59abc40d428b893" id="r_a285b57b4642f6f4af59abc40d428b893"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result</a>< std::unique_ptr< <a class="el" href="classiceberg_1_1SortOrder.html">SortOrder</a> > > </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1SortOrder.html#a285b57b4642f6f4af59abc40d428b893">Make</a> (int32_t sort_id, std::vector< <a class="el" href="classiceberg_1_1SortField.html">SortField</a> > <a class="el" href="classiceberg_1_1SortOrder.html#a3d76e6d1e25bf0dbb71abafceb137460">fields</a>)</td></tr> |
| <tr class="memdesc:a285b57b4642f6f4af59abc40d428b893"><td class="mdescLeft"> </td><td class="mdescRight">Create a <a class="el" href="classiceberg_1_1SortOrder.html" title="A sort order for a table.">SortOrder</a> without binding to a schema. <br /></td></tr> |
| <tr class="separator:a285b57b4642f6f4af59abc40d428b893"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6970d2876b7e498ee316727c0a6f3f96" id="r_a6970d2876b7e498ee316727c0a6f3f96"><td class="memItemLeft" align="right" valign="top"><a id="a6970d2876b7e498ee316727c0a6f3f96" name="a6970d2876b7e498ee316727c0a6f3f96"></a> |
| static std::unordered_set< std::string_view > </td><td class="memItemRight" valign="bottom"><b>OrderPreservingSortedColumns</b> (const <a class="el" href="classiceberg_1_1Schema.html">Schema</a> &schema, const <a class="el" href="classiceberg_1_1SortOrder.html">SortOrder</a> &order)</td></tr> |
| <tr class="separator:a6970d2876b7e498ee316727c0a6f3f96"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-attribs" name="pub-static-attribs"></a> |
| Static Public Attributes</h2></td></tr> |
| <tr class="memitem:a2e21a230401acb06b7fd1f8a6f5012e9" id="r_a2e21a230401acb06b7fd1f8a6f5012e9"><td class="memItemLeft" align="right" valign="top"><a id="a2e21a230401acb06b7fd1f8a6f5012e9" name="a2e21a230401acb06b7fd1f8a6f5012e9"></a> |
| static constexpr int32_t </td><td class="memItemRight" valign="bottom"><b>kUnsortedOrderId</b> = 0</td></tr> |
| <tr class="separator:a2e21a230401acb06b7fd1f8a6f5012e9"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a8ee262f0eda7b2b206cdf49ab2194cfd" id="r_a8ee262f0eda7b2b206cdf49ab2194cfd"><td class="memItemLeft" align="right" valign="top"><a id="a8ee262f0eda7b2b206cdf49ab2194cfd" name="a8ee262f0eda7b2b206cdf49ab2194cfd"></a> |
| static constexpr int32_t </td><td class="memItemRight" valign="bottom"><b>kInitialSortOrderId</b> = 1</td></tr> |
| <tr class="separator:a8ee262f0eda7b2b206cdf49ab2194cfd"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="friends" name="friends"></a> |
| Friends</h2></td></tr> |
| <tr class="memitem:a574b3ab78e704dfb9b528e60632c08fe" id="r_a574b3ab78e704dfb9b528e60632c08fe"><td class="memItemLeft" align="right" valign="top"><a id="a574b3ab78e704dfb9b528e60632c08fe" name="a574b3ab78e704dfb9b528e60632c08fe"></a> |
| bool </td><td class="memItemRight" valign="bottom"><b>operator==</b> (const <a class="el" href="classiceberg_1_1SortOrder.html">SortOrder</a> &lhs, const <a class="el" href="classiceberg_1_1SortOrder.html">SortOrder</a> &rhs)</td></tr> |
| <tr class="separator:a574b3ab78e704dfb9b528e60632c08fe"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>A sort order for a table. </p> |
| <p>A sort order is defined by a sort order id and a list of sort fields. The order of the sort fields within the list defines the order in which the sort is applied to the data. </p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a id="ada02ec1d02015f380e6038e36e862b14" name="ada02ec1d02015f380e6038e36e862b14"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ada02ec1d02015f380e6038e36e862b14">◆ </a></span>Make() <span class="overload">[1/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static <a class="el" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result</a>< std::unique_ptr< <a class="el" href="classiceberg_1_1SortOrder.html">SortOrder</a> > > iceberg::SortOrder::Make </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="classiceberg_1_1Schema.html">Schema</a> & </td> |
| <td class="paramname"><em>schema</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int32_t </td> |
| <td class="paramname"><em>sort_id</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">std::vector< <a class="el" href="classiceberg_1_1SortField.html">SortField</a> > </td> |
| <td class="paramname"><em>fields</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>Create a <a class="el" href="classiceberg_1_1SortOrder.html" title="A sort order for a table.">SortOrder</a>. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">schema</td><td>The schema to bind the sort order to. </td></tr> |
| <tr><td class="paramname">sort_id</td><td>The sort order id. </td></tr> |
| <tr><td class="paramname">fields</td><td>The sort fields. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>A Result containing the <a class="el" href="classiceberg_1_1SortOrder.html" title="A sort order for a table.">SortOrder</a> or an error. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a285b57b4642f6f4af59abc40d428b893" name="a285b57b4642f6f4af59abc40d428b893"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a285b57b4642f6f4af59abc40d428b893">◆ </a></span>Make() <span class="overload">[2/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static <a class="el" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result</a>< std::unique_ptr< <a class="el" href="classiceberg_1_1SortOrder.html">SortOrder</a> > > iceberg::SortOrder::Make </td> |
| <td>(</td> |
| <td class="paramtype">int32_t </td> |
| <td class="paramname"><em>sort_id</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">std::vector< <a class="el" href="classiceberg_1_1SortField.html">SortField</a> > </td> |
| <td class="paramname"><em>fields</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>Create a <a class="el" href="classiceberg_1_1SortOrder.html" title="A sort order for a table.">SortOrder</a> without binding to a schema. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">sort_id</td><td>The sort order id. </td></tr> |
| <tr><td class="paramname">fields</td><td>The sort fields. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>A Result containing the <a class="el" href="classiceberg_1_1SortOrder.html" title="A sort order for a table.">SortOrder</a> or an error. </dd></dl> |
| <dl class="section note"><dt>Note</dt><dd>This method does not check whether the sort fields are valid for any schema. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a7d626fad1d95f50267685adaf32c4603" name="a7d626fad1d95f50267685adaf32c4603"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a7d626fad1d95f50267685adaf32c4603">◆ </a></span>ToString()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::string iceberg::SortOrder::ToString </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get a user-readable string representation. </p> |
| |
| <p>Implements <a class="el" href="classiceberg_1_1util_1_1Formattable.html#a79618aca5b3bf63610d9c87ac5ae0386">iceberg::util::Formattable</a>.</p> |
| |
| </div> |
| </div> |
| <a id="aa71cfc0be980a16c5e883d896f5cc392" name="aa71cfc0be980a16c5e883d896f5cc392"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aa71cfc0be980a16c5e883d896f5cc392">◆ </a></span>Validate()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Status iceberg::SortOrder::Validate </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="classiceberg_1_1Schema.html">Schema</a> & </td> |
| <td class="paramname"><em>schema</em></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Validates the sort order against a schema. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">schema</td><td>The schema to validate against. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd><a class="el" href="structiceberg_1_1Error.html" title="Error with a kind and a message.">Error</a> status if the sort order has any invalid transform. </dd></dl> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>iceberg/<a class="el" href="sort__order_8h_source.html">sort_order.h</a></li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8 |
| </small></address> |
| </body> |
| </html> |
