blob: 26fffdb6eca0bd95432373377436060fc52dbae5 [file]
<!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/sort_field.h File 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&amp;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&amp;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="dir_f51fe74ea6bc2b1b900619895eaa63be.html">iceberg</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">sort_field.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;cstdint&gt;</code><br />
<code>#include &lt;memory&gt;</code><br />
<code>#include &lt;string&gt;</code><br />
<code>#include &lt;string_view&gt;</code><br />
<code>#include &quot;iceberg/iceberg_export.h&quot;</code><br />
<code>#include &quot;iceberg/result.h&quot;</code><br />
<code>#include &quot;<a class="el" href="type__fwd_8h_source.html">iceberg/type_fwd.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="formattable_8h_source.html">iceberg/util/formattable.h</a>&quot;</code><br />
</div>
<p><a href="sort__field_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1SortField.html">iceberg::SortField</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">a field with its transform. <a href="classiceberg_1_1SortField.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a4f6d1460e9650c271d2f5f70766361e1" id="r_a4f6d1460e9650c271d2f5f70766361e1"><td class="memItemLeft" align="right" valign="top">enum class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="sort__field_8h.html#a4f6d1460e9650c271d2f5f70766361e1">iceberg::SortDirection</a> { <a class="el" href="sort__field_8h.html#a4f6d1460e9650c271d2f5f70766361e1a0d68e3b64f62d7fb0b0d23a05f09b624">kAscending</a>
, <a class="el" href="sort__field_8h.html#a4f6d1460e9650c271d2f5f70766361e1a163fcd817692b23b6b3a308c8ace797c">kDescending</a>
}</td></tr>
<tr class="memdesc:a4f6d1460e9650c271d2f5f70766361e1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sort direction in a partition, either ascending or descending. <a href="sort__field_8h.html#a4f6d1460e9650c271d2f5f70766361e1">More...</a><br /></td></tr>
<tr class="separator:a4f6d1460e9650c271d2f5f70766361e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7d2f6c79654ba49df0d36c1724041283" id="r_a7d2f6c79654ba49df0d36c1724041283"><td class="memItemLeft" align="right" valign="top">enum class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="sort__field_8h.html#a7d2f6c79654ba49df0d36c1724041283">iceberg::NullOrder</a> { <a class="el" href="sort__field_8h.html#a7d2f6c79654ba49df0d36c1724041283a9fda60ba14f0809e152bc08409aa2737">kFirst</a>
, <a class="el" href="sort__field_8h.html#a7d2f6c79654ba49df0d36c1724041283aa9243c3d6084397b601cf95f073384a6">kLast</a>
}</td></tr>
<tr class="separator:a7d2f6c79654ba49df0d36c1724041283"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:af76315532529539fe49b0681574ec3a7" id="r_af76315532529539fe49b0681574ec3a7"><td class="memItemLeft" align="right" valign="top"><a id="af76315532529539fe49b0681574ec3a7" name="af76315532529539fe49b0681574ec3a7"></a>
ICEBERG_EXPORT constexpr std::string_view&#160;</td><td class="memItemRight" valign="bottom"><b>iceberg::ToString</b> (<a class="el" href="sort__field_8h.html#a4f6d1460e9650c271d2f5f70766361e1">SortDirection</a> direction)</td></tr>
<tr class="memdesc:af76315532529539fe49b0681574ec3a7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the relative sort direction name. <br /></td></tr>
<tr class="separator:af76315532529539fe49b0681574ec3a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a77d79b68cd09ee3cf76595297d52df69" id="r_a77d79b68cd09ee3cf76595297d52df69"><td class="memItemLeft" align="right" valign="top"><a id="a77d79b68cd09ee3cf76595297d52df69" name="a77d79b68cd09ee3cf76595297d52df69"></a>
ICEBERG_EXPORT constexpr Result&lt; <a class="el" href="sort__field_8h.html#a4f6d1460e9650c271d2f5f70766361e1">SortDirection</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>iceberg::SortDirectionFromString</b> (std::string_view str)</td></tr>
<tr class="memdesc:a77d79b68cd09ee3cf76595297d52df69"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the relative sort direction from name. <br /></td></tr>
<tr class="separator:a77d79b68cd09ee3cf76595297d52df69"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a247477b8b0fb4a05bbd67146ebe702c2" id="r_a247477b8b0fb4a05bbd67146ebe702c2"><td class="memItemLeft" align="right" valign="top"><a id="a247477b8b0fb4a05bbd67146ebe702c2" name="a247477b8b0fb4a05bbd67146ebe702c2"></a>
ICEBERG_EXPORT constexpr std::string_view&#160;</td><td class="memItemRight" valign="bottom"><b>iceberg::ToString</b> (<a class="el" href="sort__field_8h.html#a7d2f6c79654ba49df0d36c1724041283">NullOrder</a> null_order)</td></tr>
<tr class="memdesc:a247477b8b0fb4a05bbd67146ebe702c2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the relative null order name. <br /></td></tr>
<tr class="separator:a247477b8b0fb4a05bbd67146ebe702c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a155ab590aceb8d431e32957a2ba4799e" id="r_a155ab590aceb8d431e32957a2ba4799e"><td class="memItemLeft" align="right" valign="top"><a id="a155ab590aceb8d431e32957a2ba4799e" name="a155ab590aceb8d431e32957a2ba4799e"></a>
ICEBERG_EXPORT constexpr Result&lt; <a class="el" href="sort__field_8h.html#a7d2f6c79654ba49df0d36c1724041283">NullOrder</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>iceberg::NullOrderFromString</b> (std::string_view str)</td></tr>
<tr class="memdesc:a155ab590aceb8d431e32957a2ba4799e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the relative null order from name. <br /></td></tr>
<tr class="separator:a155ab590aceb8d431e32957a2ba4799e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A sort field in a sort order </p>
</div><h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="a7d2f6c79654ba49df0d36c1724041283" name="a7d2f6c79654ba49df0d36c1724041283"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7d2f6c79654ba49df0d36c1724041283">&#9670;&#160;</a></span>NullOrder</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">enum class <a class="el" href="sort__field_8h.html#a7d2f6c79654ba49df0d36c1724041283">iceberg::NullOrder</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">strong</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a7d2f6c79654ba49df0d36c1724041283a9fda60ba14f0809e152bc08409aa2737" name="a7d2f6c79654ba49df0d36c1724041283a9fda60ba14f0809e152bc08409aa2737"></a>kFirst&#160;</td><td class="fielddoc"><p>Nulls are sorted first. </p>
</td></tr>
<tr><td class="fieldname"><a id="a7d2f6c79654ba49df0d36c1724041283aa9243c3d6084397b601cf95f073384a6" name="a7d2f6c79654ba49df0d36c1724041283aa9243c3d6084397b601cf95f073384a6"></a>kLast&#160;</td><td class="fielddoc"><p>Nulls are sorted last. </p>
</td></tr>
</table>
</div>
</div>
<a id="a4f6d1460e9650c271d2f5f70766361e1" name="a4f6d1460e9650c271d2f5f70766361e1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4f6d1460e9650c271d2f5f70766361e1">&#9670;&#160;</a></span>SortDirection</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">enum class <a class="el" href="sort__field_8h.html#a4f6d1460e9650c271d2f5f70766361e1">iceberg::SortDirection</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">strong</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sort direction in a partition, either ascending or descending. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a4f6d1460e9650c271d2f5f70766361e1a0d68e3b64f62d7fb0b0d23a05f09b624" name="a4f6d1460e9650c271d2f5f70766361e1a0d68e3b64f62d7fb0b0d23a05f09b624"></a>kAscending&#160;</td><td class="fielddoc"><p>Ascending. </p>
</td></tr>
<tr><td class="fieldname"><a id="a4f6d1460e9650c271d2f5f70766361e1a163fcd817692b23b6b3a308c8ace797c" name="a4f6d1460e9650c271d2f5f70766361e1a163fcd817692b23b6b3a308c8ace797c"></a>kDescending&#160;</td><td class="fielddoc"><p>Descending. </p>
</td></tr>
</table>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<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>