Files
greptimedb/substrait/variation_const/index.html
2026-03-13 04:38:03 +00:00

13 lines
11 KiB
HTML

<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Type variation constants"><title>substrait::variation_const - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-e56847b5.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="substrait" data-themes="" data-resource-suffix="" data-rustdoc-version="1.92.0-nightly (fa3155a64 2025-09-30)" data-channel="nightly" data-search-js="search-e256b49e.js" data-stringdex-js="stringdex-828709d0.js" data-settings-js="settings-c38705f0.js" ><script src="../../static.files/storage-e2aeef58.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-ce535bd0.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><rustdoc-topbar><h2><a href="#">Module variation_const</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../substrait/index.html">substrait</a><span class="version">1.0.0-rc.2</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module variation_<wbr>const</a></h2><h3><a href="#constants">Module Items</a></h3><ul class="block"><li><a href="#constants" title="Constants">Constants</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="../index.html">In crate substrait</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../index.html">substrait</a></div><h1>Module <span>variation_<wbr>const</span>&nbsp;<button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Type variation constants</p>
<p>To add support for types not in the <a href="https://substrait.io/types/type_classes/">core specification</a>,
we make use of the <a href="(https://substrait.io/extensions/#simple-extensions)">simple extensions</a> of substrait type. This module contains the constants used
to identify the type variation.</p>
<p>The rules of type variations here are:</p>
<ul>
<li>Default type reference is 0. It is used when the actual type is the same with the original type.</li>
<li>Extended variant type references start from 1, and usually increase by 1.</li>
</ul>
<p>TODO: Definitions here are not the final form. All the non-system-preferred variations will be defined
using <a href="(https://substrait.io/extensions/#simple-extensions)">simple extensions</a> as per the <a href="https://substrait.io/types/type_variations/">spec of type_variations</a>
<a href="https://github.com/apache/datafusion/issues/11545">https://github.com/apache/datafusion/issues/11545</a></p>
</div></details><h2 id="constants" class="section-header">Constants<a href="#constants" class="anchor">§</a></h2><dl class="item-table"><dt><a class="constant" href="constant.DATE_32_TYPE_VARIATION_REF.html" title="constant substrait::variation_const::DATE_32_TYPE_VARIATION_REF">DATE_<wbr>32_<wbr>TYPE_<wbr>VARIATION_<wbr>REF</a></dt><dt><a class="constant" href="constant.DATE_64_TYPE_VARIATION_REF.html" title="constant substrait::variation_const::DATE_64_TYPE_VARIATION_REF">DATE_<wbr>64_<wbr>TYPE_<wbr>VARIATION_<wbr>REF</a></dt><dt><a class="constant" href="constant.DECIMAL_128_TYPE_VARIATION_REF.html" title="constant substrait::variation_const::DECIMAL_128_TYPE_VARIATION_REF">DECIMAL_<wbr>128_<wbr>TYPE_<wbr>VARIATION_<wbr>REF</a></dt><dt><a class="constant" href="constant.DECIMAL_256_TYPE_VARIATION_REF.html" title="constant substrait::variation_const::DECIMAL_256_TYPE_VARIATION_REF">DECIMAL_<wbr>256_<wbr>TYPE_<wbr>VARIATION_<wbr>REF</a></dt><dt><a class="constant" href="constant.DEFAULT_CONTAINER_TYPE_VARIATION_REF.html" title="constant substrait::variation_const::DEFAULT_CONTAINER_TYPE_VARIATION_REF">DEFAULT_<wbr>CONTAINER_<wbr>TYPE_<wbr>VARIATION_<wbr>REF</a></dt><dt><a class="constant" href="constant.DEFAULT_INTERVAL_DAY_TYPE_VARIATION_REF.html" title="constant substrait::variation_const::DEFAULT_INTERVAL_DAY_TYPE_VARIATION_REF">DEFAULT_<wbr>INTERVAL_<wbr>DAY_<wbr>TYPE_<wbr>VARIATION_<wbr>REF</a></dt><dd>Used for the arrow type <a href="datafusion::arrow::datatypes::DataType::Interval"><code>DataType::Interval</code></a> with <a href="datafusion::arrow::datatypes::IntervalUnit::DayTime"><code>IntervalUnit::DayTime</code></a>.</dd><dt><a class="constant" href="constant.DEFAULT_MAP_TYPE_VARIATION_REF.html" title="constant substrait::variation_const::DEFAULT_MAP_TYPE_VARIATION_REF">DEFAULT_<wbr>MAP_<wbr>TYPE_<wbr>VARIATION_<wbr>REF</a></dt><dt><a class="constant" href="constant.DEFAULT_TYPE_VARIATION_REF.html" title="constant substrait::variation_const::DEFAULT_TYPE_VARIATION_REF">DEFAULT_<wbr>TYPE_<wbr>VARIATION_<wbr>REF</a></dt><dd>The “system-preferred” variation (i.e., no variation).</dd><dt><a class="constant" href="constant.DICTIONARY_MAP_TYPE_VARIATION_REF.html" title="constant substrait::variation_const::DICTIONARY_MAP_TYPE_VARIATION_REF">DICTIONARY_<wbr>MAP_<wbr>TYPE_<wbr>VARIATION_<wbr>REF</a></dt><dt><a class="constant" href="constant.DURATION_INTERVAL_DAY_TYPE_VARIATION_REF.html" title="constant substrait::variation_const::DURATION_INTERVAL_DAY_TYPE_VARIATION_REF">DURATION_<wbr>INTERVAL_<wbr>DAY_<wbr>TYPE_<wbr>VARIATION_<wbr>REF</a></dt><dd>Used for the arrow type <a href="datafusion::arrow::datatypes::DataType::Duration"><code>DataType::Duration</code></a>.</dd><dt><a class="constant" href="constant.FLOAT_16_TYPE_NAME.html" title="constant substrait::variation_const::FLOAT_16_TYPE_NAME">FLOAT_<wbr>16_<wbr>TYPE_<wbr>NAME</a></dt><dd>Defined in <a href="https://github.com/apache/arrow/blame/main/format/substrait/extension_types.yaml">https://github.com/apache/arrow/blame/main/format/substrait/extension_types.yaml</a></dd><dt><a class="constant" href="constant.INTERVAL_DAY_TIME_TYPE_REF.html" title="constant substrait::variation_const::INTERVAL_DAY_TIME_TYPE_REF">INTERVAL_<wbr>DAY_<wbr>TIME_<wbr>TYPE_<wbr>REF</a><wbr><span class="stab deprecated" title="">Deprecated</span></dt><dd>For <a href="datafusion::arrow::datatypes::DataType::Interval"><code>DataType::Interval</code></a> with <a href="datafusion::arrow::datatypes::IntervalUnit::DayTime"><code>IntervalUnit::DayTime</code></a>.</dd><dt><a class="constant" href="constant.INTERVAL_MONTH_DAY_NANO_TYPE_NAME.html" title="constant substrait::variation_const::INTERVAL_MONTH_DAY_NANO_TYPE_NAME">INTERVAL_<wbr>MONTH_<wbr>DAY_<wbr>NANO_<wbr>TYPE_<wbr>NAME</a><wbr><span class="stab deprecated" title="">Deprecated</span></dt><dd>For <a href="datafusion::arrow::datatypes::DataType::Interval"><code>DataType::Interval</code></a> with <a href="datafusion::arrow::datatypes::IntervalUnit::MonthDayNano"><code>IntervalUnit::MonthDayNano</code></a>.</dd><dt><a class="constant" href="constant.INTERVAL_MONTH_DAY_NANO_TYPE_REF.html" title="constant substrait::variation_const::INTERVAL_MONTH_DAY_NANO_TYPE_REF">INTERVAL_<wbr>MONTH_<wbr>DAY_<wbr>NANO_<wbr>TYPE_<wbr>REF</a><wbr><span class="stab deprecated" title="">Deprecated</span></dt><dd>For <a href="datafusion::arrow::datatypes::DataType::Interval"><code>DataType::Interval</code></a> with <a href="datafusion::arrow::datatypes::IntervalUnit::MonthDayNano"><code>IntervalUnit::MonthDayNano</code></a>.</dd><dt><a class="constant" href="constant.INTERVAL_YEAR_MONTH_TYPE_REF.html" title="constant substrait::variation_const::INTERVAL_YEAR_MONTH_TYPE_REF">INTERVAL_<wbr>YEAR_<wbr>MONTH_<wbr>TYPE_<wbr>REF</a><wbr><span class="stab deprecated" title="">Deprecated</span></dt><dd>For <a href="datafusion::arrow::datatypes::DataType::Interval"><code>DataType::Interval</code></a> with <a href="datafusion::arrow::datatypes::IntervalUnit::YearMonth"><code>IntervalUnit::YearMonth</code></a>.</dd><dt><a class="constant" href="constant.LARGE_CONTAINER_TYPE_VARIATION_REF.html" title="constant substrait::variation_const::LARGE_CONTAINER_TYPE_VARIATION_REF">LARGE_<wbr>CONTAINER_<wbr>TYPE_<wbr>VARIATION_<wbr>REF</a></dt><dt><a class="constant" href="constant.NULL_TYPE_NAME.html" title="constant substrait::variation_const::NULL_TYPE_NAME">NULL_<wbr>TYPE_<wbr>NAME</a></dt><dd>For <a href="datafusion::arrow::datatypes::DataType::Null"><code>DataType::Null</code></a></dd><dt><a class="constant" href="constant.TIMESTAMP_MICRO_TYPE_VARIATION_REF.html" title="constant substrait::variation_const::TIMESTAMP_MICRO_TYPE_VARIATION_REF">TIMESTAMP_<wbr>MICRO_<wbr>TYPE_<wbr>VARIATION_<wbr>REF</a><wbr><span class="stab deprecated" title="">Deprecated</span></dt><dt><a class="constant" href="constant.TIMESTAMP_MILLI_TYPE_VARIATION_REF.html" title="constant substrait::variation_const::TIMESTAMP_MILLI_TYPE_VARIATION_REF">TIMESTAMP_<wbr>MILLI_<wbr>TYPE_<wbr>VARIATION_<wbr>REF</a><wbr><span class="stab deprecated" title="">Deprecated</span></dt><dt><a class="constant" href="constant.TIMESTAMP_NANO_TYPE_VARIATION_REF.html" title="constant substrait::variation_const::TIMESTAMP_NANO_TYPE_VARIATION_REF">TIMESTAMP_<wbr>NANO_<wbr>TYPE_<wbr>VARIATION_<wbr>REF</a><wbr><span class="stab deprecated" title="">Deprecated</span></dt><dt><a class="constant" href="constant.TIMESTAMP_SECOND_TYPE_VARIATION_REF.html" title="constant substrait::variation_const::TIMESTAMP_SECOND_TYPE_VARIATION_REF">TIMESTAMP_<wbr>SECOND_<wbr>TYPE_<wbr>VARIATION_<wbr>REF</a><wbr><span class="stab deprecated" title="">Deprecated</span></dt><dt><a class="constant" href="constant.TIME_32_TYPE_VARIATION_REF.html" title="constant substrait::variation_const::TIME_32_TYPE_VARIATION_REF">TIME_<wbr>32_<wbr>TYPE_<wbr>VARIATION_<wbr>REF</a></dt><dt><a class="constant" href="constant.TIME_64_TYPE_VARIATION_REF.html" title="constant substrait::variation_const::TIME_64_TYPE_VARIATION_REF">TIME_<wbr>64_<wbr>TYPE_<wbr>VARIATION_<wbr>REF</a></dt><dt><a class="constant" href="constant.UNSIGNED_INTEGER_TYPE_VARIATION_REF.html" title="constant substrait::variation_const::UNSIGNED_INTEGER_TYPE_VARIATION_REF">UNSIGNED_<wbr>INTEGER_<wbr>TYPE_<wbr>VARIATION_<wbr>REF</a></dt><dt><a class="constant" href="constant.VIEW_CONTAINER_TYPE_VARIATION_REF.html" title="constant substrait::variation_const::VIEW_CONTAINER_TYPE_VARIATION_REF">VIEW_<wbr>CONTAINER_<wbr>TYPE_<wbr>VARIATION_<wbr>REF</a></dt></dl></section></div></main></body></html>