forked from docs/doc-exports
Su, Xiaomeng
76a5b1ee83
Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com> Co-authored-by: Su, Xiaomeng <suxiaomeng1@huawei.com> Co-committed-by: Su, Xiaomeng <suxiaomeng1@huawei.com>
72 lines
11 KiB
HTML
72 lines
11 KiB
HTML
<a name="dli_spark_datetrunc"></a><a name="dli_spark_datetrunc"></a>
|
|
|
|
<h1 class="topictitle1">datetrunc</h1>
|
|
<div id="body8662426"><p id="dli_spark_datetrunc__en-us_topic_0000001694195249_p990811211817">This function is used to calculate the date otained through the truncation of a specified date based on a specified datepart.</p>
|
|
<p id="dli_spark_datetrunc__en-us_topic_0000001694195249_p2680202419533">It truncates the date before the specified datepart and automatically fills the remaining part with the default value. For details, see <a href="#dli_spark_datetrunc__en-us_topic_0000001694195249_section13277192233920">Example Code</a>.</p>
|
|
<div class="section" id="dli_spark_datetrunc__en-us_topic_0000001694195249_section45291954203217"><h4 class="sectiontitle">Syntax</h4><pre class="screen" id="dli_spark_datetrunc__en-us_topic_0000001694195249_screen2121185651218">datetrunc (string date, string datepart)</pre>
|
|
</div>
|
|
<div class="section" id="dli_spark_datetrunc__en-us_topic_0000001694195249_section992014913317"><h4 class="sectiontitle">Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_spark_datetrunc__en-us_topic_0000001694195249_table1829154762513" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameters</caption><thead align="left"><tr id="dli_spark_datetrunc__en-us_topic_0000001694195249_row8830104792517"><th align="left" class="cellrowborder" valign="top" width="19.220000000000002%" id="mcps1.3.4.2.2.5.1.1"><p id="dli_spark_datetrunc__en-us_topic_0000001694195249_p983074711252">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13.43%" id="mcps1.3.4.2.2.5.1.2"><p id="dli_spark_datetrunc__en-us_topic_0000001694195249_p6830124732517">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20.62%" id="mcps1.3.4.2.2.5.1.3"><p id="dli_spark_datetrunc__en-us_topic_0000001694195249_p13318164512614">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="46.73%" id="mcps1.3.4.2.2.5.1.4"><p id="dli_spark_datetrunc__en-us_topic_0000001694195249_p08301547132513">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_spark_datetrunc__en-us_topic_0000001694195249_row15830184792511"><td class="cellrowborder" valign="top" width="19.220000000000002%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_spark_datetrunc__en-us_topic_0000001694195249_p683034714250">date</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.43%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_spark_datetrunc__en-us_topic_0000001694195249_p12830184752518">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.62%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_spark_datetrunc__en-us_topic_0000001694195249_p2098843181320">DATE</p>
|
|
<p id="dli_spark_datetrunc__en-us_topic_0000001694195249_p158591444191319">or</p>
|
|
<p id="dli_spark_datetrunc__en-us_topic_0000001694195249_p0318545102615">STRING</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.73%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_spark_datetrunc__en-us_topic_0000001694195249_p189251333161511">Start date</p>
|
|
<p id="dli_spark_datetrunc__en-us_topic_0000001694195249_p262017013166">The following formats are supported:</p>
|
|
<ul id="dli_spark_datetrunc__en-us_topic_0000001694195249_ul18403171617"><li id="dli_spark_datetrunc__en-us_topic_0000001694195249_li20849331611">yyyy-mm-dd</li><li id="dli_spark_datetrunc__en-us_topic_0000001694195249_li9841137169">yyyy-mm-dd hh:mi:ss</li><li id="dli_spark_datetrunc__en-us_topic_0000001694195249_li784203121614">yyyy-mm-dd hh:mi:ss.ff3</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_spark_datetrunc__en-us_topic_0000001694195249_row295054517207"><td class="cellrowborder" valign="top" width="19.220000000000002%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_spark_datetrunc__en-us_topic_0000001694195249_p5950194582015">datepart</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.43%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_spark_datetrunc__en-us_topic_0000001694195249_p14950104515207">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.62%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_spark_datetrunc__en-us_topic_0000001694195249_p9950194582011">STRING</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.73%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_spark_datetrunc__en-us_topic_0000001694195249_p157541402116">Time unit of the value to be returned</p>
|
|
<p id="dli_spark_datetrunc__en-us_topic_0000001694195249_p1995034510202">This parameter supports the following extended date formats: year, month or mon, day, and hour.</p>
|
|
<ul id="dli_spark_datetrunc__en-us_topic_0000001694195249_ul5326124018213"><li id="dli_spark_datetrunc__en-us_topic_0000001694195249_li1332634082113"><strong id="dli_spark_datetrunc__en-us_topic_0000001694195249_b114838275435530">YYYY</strong> or <strong id="dli_spark_datetrunc__en-us_topic_0000001694195249_b175001663435530">yyyy</strong> indicates the year.</li><li id="dli_spark_datetrunc__en-us_topic_0000001694195249_li18326134020211"><strong id="dli_spark_datetrunc__en-us_topic_0000001694195249_b168445741935541">MM</strong> indicates the month.</li><li id="dli_spark_datetrunc__en-us_topic_0000001694195249_li83267401213"><strong id="dli_spark_datetrunc__en-us_topic_0000001694195249_b203539222835550">mm</strong> indicates the minute.</li><li id="dli_spark_datetrunc__en-us_topic_0000001694195249_li19326040152117"><strong id="dli_spark_datetrunc__en-us_topic_0000001694195249_b21381648035556">dd</strong> indicates the day.</li><li id="dli_spark_datetrunc__en-us_topic_0000001694195249_li3326154018212"><strong id="dli_spark_datetrunc__en-us_topic_0000001694195249_b33214932535620">HH</strong> indicates the 24-hour clock.</li><li id="dli_spark_datetrunc__en-us_topic_0000001694195249_li3326104016218"><strong id="dli_spark_datetrunc__en-us_topic_0000001694195249_b34573581335632">hh</strong> indicates the 12-hour clock.</li><li id="dli_spark_datetrunc__en-us_topic_0000001694195249_li13261640132117"><strong id="dli_spark_datetrunc__en-us_topic_0000001694195249_b125846724435640">mi</strong> indicates the minute.</li><li id="dli_spark_datetrunc__en-us_topic_0000001694195249_li532619407218"><strong id="dli_spark_datetrunc__en-us_topic_0000001694195249_b96232669835650">ss</strong> indicates the second.</li><li id="dli_spark_datetrunc__en-us_topic_0000001694195249_li153266409211"><strong id="dli_spark_datetrunc__en-us_topic_0000001694195249_b21644946535656">SSS</strong> indicates millisecond.</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dli_spark_datetrunc__en-us_topic_0000001694195249_section210162513312"><h4 class="sectiontitle">Return Values</h4><p id="dli_spark_datetrunc__en-us_topic_0000001694195249_p20472146193615">The return value is of the DATE or STRING type.</p>
|
|
<div class="note" id="dli_spark_datetrunc__en-us_topic_0000001694195249_note61422099395"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><ul id="dli_spark_datetrunc__en-us_topic_0000001694195249_ul1915412117372"><li id="dli_spark_datetrunc__en-us_topic_0000001694195249_li201546116375">If the value of <strong id="dli_spark_datetrunc__en-us_topic_0000001694195249_b103166862354536">date</strong> is not of the DATE or STRING type, the error message "data type mismatch" is displayed.</li><li id="dli_spark_datetrunc__en-us_topic_0000001694195249_li1175713253711">If the value of <strong id="dli_spark_datetrunc__en-us_topic_0000001694195249_b209161543954539">date</strong> is of the DATE or STRING type but is not in one of the supported formats, <strong id="dli_spark_datetrunc__en-us_topic_0000001694195249_b45657480654539">NULL</strong> is returned.</li><li id="dli_spark_datetrunc__en-us_topic_0000001694195249_li101541211372">If the value of <strong id="dli_spark_datetrunc__en-us_topic_0000001694195249_b161474567853340">datepart</strong> is <strong id="dli_spark_datetrunc__en-us_topic_0000001694195249_b59535613053340">NULL</strong>, <strong id="dli_spark_datetrunc__en-us_topic_0000001694195249_b179783700353340">NULL</strong> is returned.</li><li id="dli_spark_datetrunc__en-us_topic_0000001694195249_li171549117372">If the value of <strong id="dli_spark_datetrunc__en-us_topic_0000001694195249_b8761810135615">datepart</strong> is hour, minute, or second, the date is truncated to the day and returned.</li></ul>
|
|
</div></div>
|
|
</div>
|
|
<div class="section" id="dli_spark_datetrunc__en-us_topic_0000001694195249_section13277192233920"><a name="dli_spark_datetrunc__en-us_topic_0000001694195249_section13277192233920"></a><a name="en-us_topic_0000001694195249_section13277192233920"></a><h4 class="sectiontitle">Example Code</h4><p id="dli_spark_datetrunc__en-us_topic_0000001694195249_p478795541011">Example static data</p>
|
|
<p id="dli_spark_datetrunc__en-us_topic_0000001694195249_p14975141124720">The value <strong id="dli_spark_datetrunc__en-us_topic_0000001694195249_b82201157135620">2023-01-01 00:00:00</strong> is returned.</p>
|
|
<pre class="screen" id="dli_spark_datetrunc__en-us_topic_0000001694195249_screen1152684473">select datetrunc('2023-08-14 17:00:00', 'yyyy');</pre>
|
|
<p id="dli_spark_datetrunc__en-us_topic_0000001694195249_p1797441184716">The value <strong id="dli_spark_datetrunc__en-us_topic_0000001694195249_b10839102573">2023-08-01 00:00:00</strong> is returned.</p>
|
|
<pre class="screen" id="dli_spark_datetrunc__en-us_topic_0000001694195249_screen9426813164715">select datetrunc('2023-08-14 17:00:00', 'month');</pre>
|
|
<p id="dli_spark_datetrunc__en-us_topic_0000001694195249_p129741019477">The value <strong id="dli_spark_datetrunc__en-us_topic_0000001694195249_b14501171316577">2023-08-14</strong> is returned.</p>
|
|
<pre class="screen" id="dli_spark_datetrunc__en-us_topic_0000001694195249_screen1482521964715">select datetrunc('2023-08-14 17:00:00', 'DD');</pre>
|
|
<p id="dli_spark_datetrunc__en-us_topic_0000001694195249_p199748174714">The value <strong id="dli_spark_datetrunc__en-us_topic_0000001694195249_b824091710576">2023-01-01</strong> is returned.</p>
|
|
<pre class="screen" id="dli_spark_datetrunc__en-us_topic_0000001694195249_screen557762718474">select datetrunc('2023-08-14', 'yyyy');</pre>
|
|
<p id="dli_spark_datetrunc__en-us_topic_0000001694195249_p1297410174715">The value <strong id="dli_spark_datetrunc__en-us_topic_0000001694195249_b042892611577">2023-08-14</strong> is returned.</p>
|
|
<pre class="screen" id="dli_spark_datetrunc__en-us_topic_0000001694195249_screen345913524716">select datetrunc('2023-08-14 17:00:00', 'HH');</pre>
|
|
<p id="dli_spark_datetrunc__en-us_topic_0000001694195249_p13974514471">The value <strong id="dli_spark_datetrunc__en-us_topic_0000001694195249_b1592230155710">NULL</strong> is returned.</p>
|
|
<pre class="screen" id="dli_spark_datetrunc__en-us_topic_0000001694195249_screen882845814719">select datetrunc('2023-08-14', null);</pre>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="dli_08_0471.html">Date Functions</a></div>
|
|
</div>
|
|
</div>
|
|
|