doc-exports/docs/dli/sqlreference/dli_spark_dateadd.html
Su, Xiaomeng 76a5b1ee83 dli_sqlreference_20240227
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>
2024-03-27 22:02:33 +00:00

80 lines
12 KiB
HTML

<a name="dli_spark_dateadd"></a><a name="dli_spark_dateadd"></a>
<h1 class="topictitle1">dateadd</h1>
<div id="body8662426"><p id="dli_spark_dateadd__en-us_topic_0000001694195245_p990811211817">This function is used to change a date based on <strong id="dli_spark_dateadd__en-us_topic_0000001694195245_b195517499469">datepart</strong> and <strong id="dli_spark_dateadd__en-us_topic_0000001694195245_b14955549164616">delta</strong>.</p>
<p id="dli_spark_dateadd__en-us_topic_0000001694195245_p18471163815215">To obtain the date with a specified change range based on the current date, use this function together with the <a href="dli_spark_current_date.html#dli_spark_current_date">current_date</a> or <a href="dli_spark_getdate.html#dli_spark_getdate">getdate</a> function.</p>
<div class="section" id="dli_spark_dateadd__en-us_topic_0000001694195245_section45291954203217"><h4 class="sectiontitle">Syntax</h4><pre class="screen" id="dli_spark_dateadd__en-us_topic_0000001694195245_screen2121185651218">dateadd(string date, bigint delta, string datepart)</pre>
</div>
<div class="section" id="dli_spark_dateadd__en-us_topic_0000001694195245_section992014913317"><h4 class="sectiontitle">Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_spark_dateadd__en-us_topic_0000001694195245_table1829154762513" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameters</caption><thead align="left"><tr id="dli_spark_dateadd__en-us_topic_0000001694195245_row8830104792517"><th align="left" class="cellrowborder" valign="top" width="19.220000000000002%" id="mcps1.3.4.2.2.5.1.1"><p id="dli_spark_dateadd__en-us_topic_0000001694195245_p983074711252">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13.44%" id="mcps1.3.4.2.2.5.1.2"><p id="dli_spark_dateadd__en-us_topic_0000001694195245_p6830124732517">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20.61%" id="mcps1.3.4.2.2.5.1.3"><p id="dli_spark_dateadd__en-us_topic_0000001694195245_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_dateadd__en-us_topic_0000001694195245_p08301547132513">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dli_spark_dateadd__en-us_topic_0000001694195245_row15830184792511"><td class="cellrowborder" valign="top" width="19.220000000000002%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_spark_dateadd__en-us_topic_0000001694195245_p683034714250">date</p>
</td>
<td class="cellrowborder" valign="top" width="13.44%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_spark_dateadd__en-us_topic_0000001694195245_p12830184752518">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20.61%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_spark_dateadd__en-us_topic_0000001694195245_p2098843181320">DATE</p>
<p id="dli_spark_dateadd__en-us_topic_0000001694195245_p158591444191319">or</p>
<p id="dli_spark_dateadd__en-us_topic_0000001694195245_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_dateadd__en-us_topic_0000001694195245_p986157103711">Start date</p>
<p id="dli_spark_dateadd__en-us_topic_0000001694195245_p2858733111417">The following formats are supported:</p>
<ul id="dli_spark_dateadd__en-us_topic_0000001694195245_ul1627951121412"><li id="dli_spark_dateadd__en-us_topic_0000001694195245_li9627051161410">yyyy-mm-dd</li><li id="dli_spark_dateadd__en-us_topic_0000001694195245_li1462715513141">yyyy-mm-dd hh:mi:ss</li><li id="dli_spark_dateadd__en-us_topic_0000001694195245_li6628751121411">yyyy-mm-dd hh:mi:ss.ff3</li></ul>
</td>
</tr>
<tr id="dli_spark_dateadd__en-us_topic_0000001694195245_row52033239362"><td class="cellrowborder" valign="top" width="19.220000000000002%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_spark_dateadd__en-us_topic_0000001694195245_p34501243193613">delta</p>
</td>
<td class="cellrowborder" valign="top" width="13.44%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_spark_dateadd__en-us_topic_0000001694195245_p132041223183617">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20.61%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_spark_dateadd__en-us_topic_0000001694195245_p10204122313619">BIGINT</p>
</td>
<td class="cellrowborder" valign="top" width="46.73%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_spark_dateadd__en-us_topic_0000001694195245_p720417232361">Amplitude, based on which the date is modified</p>
</td>
</tr>
<tr id="dli_spark_dateadd__en-us_topic_0000001694195245_row68301347152516"><td class="cellrowborder" valign="top" width="19.220000000000002%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_spark_dateadd__en-us_topic_0000001694195245_p35294713363">datepart</p>
</td>
<td class="cellrowborder" valign="top" width="13.44%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_spark_dateadd__en-us_topic_0000001694195245_p12830747122519">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20.61%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_spark_dateadd__en-us_topic_0000001694195245_p1731894542616">BIGINT</p>
</td>
<td class="cellrowborder" valign="top" width="46.73%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_spark_dateadd__en-us_topic_0000001694195245_p15063314374">Unit, based on which the date is modified</p>
<p id="dli_spark_dateadd__en-us_topic_0000001694195245_p1995034510202">This parameter supports the following extended date formats: year, month or mon, day, and hour.</p>
<ul id="dli_spark_dateadd__en-us_topic_0000001694195245_ul5326124018213"><li id="dli_spark_dateadd__en-us_topic_0000001694195245_li1332634082113"><strong id="dli_spark_dateadd__en-us_topic_0000001694195245_b756182317551">YYYY</strong> or <strong id="dli_spark_dateadd__en-us_topic_0000001694195245_b16618172611552">yyyy</strong> indicates the year.</li><li id="dli_spark_dateadd__en-us_topic_0000001694195245_li18326134020211"><strong id="dli_spark_dateadd__en-us_topic_0000001694195245_b991193712559">MM</strong> indicates the month.</li><li id="dli_spark_dateadd__en-us_topic_0000001694195245_li83267401213"><strong id="dli_spark_dateadd__en-us_topic_0000001694195245_b1595104619554">mm</strong> indicates the minute.</li><li id="dli_spark_dateadd__en-us_topic_0000001694195245_li19326040152117"><strong id="dli_spark_dateadd__en-us_topic_0000001694195245_b6786155265510">dd</strong> indicates the day.</li><li id="dli_spark_dateadd__en-us_topic_0000001694195245_li3326154018212"><strong id="dli_spark_dateadd__en-us_topic_0000001694195245_b1425316588556">HH</strong> indicates the 24-hour clock.</li><li id="dli_spark_dateadd__en-us_topic_0000001694195245_li3326104016218"><strong id="dli_spark_dateadd__en-us_topic_0000001694195245_b5760201895611">hh</strong> indicates the 12-hour clock.</li><li id="dli_spark_dateadd__en-us_topic_0000001694195245_li13261640132117"><strong id="dli_spark_dateadd__en-us_topic_0000001694195245_b289753015615">mi</strong> indicates the minute.</li><li id="dli_spark_dateadd__en-us_topic_0000001694195245_li532619407218"><strong id="dli_spark_dateadd__en-us_topic_0000001694195245_b10870745115616">ss</strong> indicates the second.</li><li id="dli_spark_dateadd__en-us_topic_0000001694195245_li153266409211"><strong id="dli_spark_dateadd__en-us_topic_0000001694195245_b62561853145618">SSS</strong> indicates the millisecond.</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="dli_spark_dateadd__en-us_topic_0000001694195245_section210162513312"><h4 class="sectiontitle">Return Values</h4><p id="dli_spark_dateadd__en-us_topic_0000001694195245_p136202119551">The return value is of the STRING type.</p>
<div class="note" id="dli_spark_dateadd__en-us_topic_0000001694195245_note61422099395"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><ul id="dli_spark_dateadd__en-us_topic_0000001694195245_ul1419951023915"><li id="dli_spark_dateadd__en-us_topic_0000001694195245_li16100145218157">If the value of <strong id="dli_spark_dateadd__en-us_topic_0000001694195245_b159681722105711">date</strong> is not of the DATE or STRING type, the error message "data type mismatch" is displayed.</li><li id="dli_spark_dateadd__en-us_topic_0000001694195245_li0169125053512">If the value of <strong id="dli_spark_dateadd__en-us_topic_0000001694195245_b129198482578">date</strong> is of the DATE or STRING type but is not in one of the supported formats, <strong id="dli_spark_dateadd__en-us_topic_0000001694195245_b19919184814579">NULL</strong> is returned.</li><li id="dli_spark_dateadd__en-us_topic_0000001694195245_li68431541131218">If the value of <strong id="dli_spark_dateadd__en-us_topic_0000001694195245_b147216593574">date</strong> is <strong id="dli_spark_dateadd__en-us_topic_0000001694195245_b20472125935715">NULL</strong>, <strong id="dli_spark_dateadd__en-us_topic_0000001694195245_b3473175915719">NULL</strong> is returned.</li><li id="dli_spark_dateadd__en-us_topic_0000001694195245_li1184311414129">If the value of <strong id="dli_spark_dateadd__en-us_topic_0000001694195245_b1218510166589">delta</strong> or <strong id="dli_spark_dateadd__en-us_topic_0000001694195245_b131861816115817">datepart</strong> is <strong id="dli_spark_dateadd__en-us_topic_0000001694195245_b14186151612584">NULL</strong>, <strong id="dli_spark_dateadd__en-us_topic_0000001694195245_b2187151613581">NULL</strong> is returned.</li></ul>
</div></div>
</div>
<div class="section" id="dli_spark_dateadd__en-us_topic_0000001694195245_section13277192233920"><h4 class="sectiontitle">Example Code</h4><p id="dli_spark_dateadd__en-us_topic_0000001694195245_p833110416496">The value <strong id="dli_spark_dateadd__en-us_topic_0000001694195245_b625675418596">2023-08-15 17:00:00</strong> is returned after one day is added.</p>
<pre class="screen" id="dli_spark_dateadd__en-us_topic_0000001694195245_screen1058410509518">select dateadd( '2023-08-14 17:00:00', 1, 'dd');</pre>
<p id="dli_spark_dateadd__en-us_topic_0000001694195245_p15331104134911">The value <strong id="dli_spark_dateadd__en-us_topic_0000001694195245_b177179284017">2025-04-14 17:00:00</strong> is returned after 20 months are added.</p>
<pre class="screen" id="dli_spark_dateadd__en-us_topic_0000001694195245_screen174851355135110">select dateadd('2023-08-14 17:00:00', 20, 'mm');</pre>
<p id="dli_spark_dateadd__en-us_topic_0000001694195245_p833116414499">The value <strong id="dli_spark_dateadd__en-us_topic_0000001694195245_b19899581316">2023-09-14 17:00:00</strong> is returned.</p>
<pre class="screen" id="dli_spark_dateadd__en-us_topic_0000001694195245_screen263113017526">select dateadd('2023-08-14 17:00:00', 1, 'mm');</pre>
<p id="dli_spark_dateadd__en-us_topic_0000001694195245_p433111418492">The value <strong id="dli_spark_dateadd__en-us_topic_0000001694195245_b102415241118">2023-09-14</strong> is returned.</p>
<pre class="screen" id="dli_spark_dateadd__en-us_topic_0000001694195245_screen196635805215">select dateadd('2023-08-14', 1, 'mm');</pre>
<p id="dli_spark_dateadd__en-us_topic_0000001694195245_p1333174118491">If the current time is <strong id="dli_spark_dateadd__en-us_topic_0000001694195245_b11914429122117">2023-08-14 17:00:00</strong>, <strong id="dli_spark_dateadd__en-us_topic_0000001694195245_b209141729182114">2023-08-13 17:00:00</strong> is returned.</p>
<pre class="screen" id="dli_spark_dateadd__en-us_topic_0000001694195245_screen358071445210">select dateadd(getdate(),-1,'dd');</pre>
<p id="dli_spark_dateadd__en-us_topic_0000001694195245_p14331144184915">The value <strong id="dli_spark_dateadd__en-us_topic_0000001694195245_b37082376116">NULL</strong> is returned.</p>
<pre class="screen" id="dli_spark_dateadd__en-us_topic_0000001694195245_screen736122205211">select dateadd(date '2023-08-14', 1, 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>