324/functions/binary.html


<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <title>7.11. Binary Functions and Operators &#8212; Presto 324 Documentation</title>
    <link rel="stylesheet" href="../_static/presto.css" type="text/css" />
    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    '../',
        VERSION:     '324',
        COLLAPSE_INDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true,
        SOURCELINK_SUFFIX: '.txt'
      };
    </script>
    <script type="text/javascript" src="../_static/jquery.js"></script>
    <script type="text/javascript" src="../_static/underscore.js"></script>
    <script type="text/javascript" src="../_static/doctools.js"></script>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="7.12. JSON Functions and Operators" href="json.html" />
    <link rel="prev" title="7.10. Regular Expression Functions" href="regexp.html" /> 
    <script async src="https://www.googletagmanager.com/gtag/js?id=UA-133457846-1"></script>
    <script>
      window.dataLayer = window.dataLayer || [];
      function gtag(){dataLayer.push(arguments);}
      gtag('js', new Date());
      gtag('config', 'UA-133457846-1');
    </script>
  </head>
  <body>
<div class="header">
    <h1 class="heading"><a href="../index.html">
        <span>Presto 324 Documentation</span></a></h1>
    <h2 class="heading"><span>7.11. Binary Functions and Operators</span></h2>
</div>
<div class="topnav">
    
<p class="nav">
    <span class="left">
        &laquo; <a href="regexp.html">7.10. Regular Expression Functions</a>
    </span>
    <span class="right">
        <a href="json.html">7.12. JSON Functions and Operators</a> &raquo;
    </span>
</p>

</div>
<div class="content">
    
  <div class="section" id="binary-functions-and-operators">
<h1>7.11. Binary Functions and Operators</h1>
<div class="section" id="binary-operators">
<h2>Binary Operators</h2>
<p>The <code class="docutils literal"><span class="pre">||</span></code> operator performs concatenation.</p>
</div>
<div class="section" id="binary-functions">
<h2>Binary Functions</h2>
<dl class="function">
<dt>
<code class="descname">length</code><span class="sig-paren">(</span><em>binary</em><span class="sig-paren">)</span> &#x2192; bigint</dt>
<dd><p>Returns the length of <code class="docutils literal"><span class="pre">binary</span></code> in bytes.</p>
</dd></dl>

<dl class="function">
<dt>
<code class="descname">concat</code><span class="sig-paren">(</span><em>binary1</em>, <em>...</em>, <em>binaryN</em><span class="sig-paren">)</span> &#x2192; varbinary</dt>
<dd><p>Returns the concatenation of <code class="docutils literal"><span class="pre">binary1</span></code>, <code class="docutils literal"><span class="pre">binary2</span></code>, <code class="docutils literal"><span class="pre">...</span></code>, <code class="docutils literal"><span class="pre">binaryN</span></code>.
This function provides the same functionality as the
SQL-standard concatenation operator (<code class="docutils literal"><span class="pre">||</span></code>).</p>
</dd></dl>

<dl class="function">
<dt>
<code class="descname">substr</code><span class="sig-paren">(</span><em>binary</em>, <em>start</em><span class="sig-paren">)</span> &#x2192; varbinary</dt>
<dd><p>Returns the rest of <code class="docutils literal"><span class="pre">binary</span></code> from the starting position <code class="docutils literal"><span class="pre">start</span></code>,
measured in bytes. Positions start with <code class="docutils literal"><span class="pre">1</span></code>. A negative starting position
is interpreted as being relative to the end of the string.</p>
</dd></dl>

<dl class="function">
<dt>
<code class="descname">substr</code><span class="sig-paren">(</span><em>binary</em>, <em>start</em>, <em>length</em><span class="sig-paren">)</span> &#x2192; varbinary</dt>
<dd><p>Returns a substring from <code class="docutils literal"><span class="pre">binary</span></code> of length <code class="docutils literal"><span class="pre">length</span></code> from the starting
position <code class="docutils literal"><span class="pre">start</span></code>, measured in bytes. Positions start with <code class="docutils literal"><span class="pre">1</span></code>. A
negative starting position is interpreted as being relative to the end of
the string.</p>
</dd></dl>

<dl class="function">
<dt id="to_base64">
<code class="descname">to_base64</code><span class="sig-paren">(</span><em>binary</em><span class="sig-paren">)</span> &#x2192; varchar</dt>
<dd><p>Encodes <code class="docutils literal"><span class="pre">binary</span></code> into a base64 string representation.</p>
</dd></dl>

<dl class="function">
<dt id="from_base64">
<code class="descname">from_base64</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span> &#x2192; varbinary</dt>
<dd><p>Decodes binary data from the base64 encoded <code class="docutils literal"><span class="pre">string</span></code>.</p>
</dd></dl>

<dl class="function">
<dt id="to_base64url">
<code class="descname">to_base64url</code><span class="sig-paren">(</span><em>binary</em><span class="sig-paren">)</span> &#x2192; varchar</dt>
<dd><p>Encodes <code class="docutils literal"><span class="pre">binary</span></code> into a base64 string representation using the URL safe alphabet.</p>
</dd></dl>

<dl class="function">
<dt id="from_base64url">
<code class="descname">from_base64url</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span> &#x2192; varbinary</dt>
<dd><p>Decodes binary data from the base64 encoded <code class="docutils literal"><span class="pre">string</span></code> using the URL safe alphabet.</p>
</dd></dl>

<dl class="function">
<dt id="to_hex">
<code class="descname">to_hex</code><span class="sig-paren">(</span><em>binary</em><span class="sig-paren">)</span> &#x2192; varchar</dt>
<dd><p>Encodes <code class="docutils literal"><span class="pre">binary</span></code> into a hex string representation.</p>
</dd></dl>

<dl class="function">
<dt id="from_hex">
<code class="descname">from_hex</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span> &#x2192; varbinary</dt>
<dd><p>Decodes binary data from the hex encoded <code class="docutils literal"><span class="pre">string</span></code>.</p>
</dd></dl>

<dl class="function">
<dt id="to_big_endian_64">
<code class="descname">to_big_endian_64</code><span class="sig-paren">(</span><em>bigint</em><span class="sig-paren">)</span> &#x2192; varbinary</dt>
<dd><p>Encodes <code class="docutils literal"><span class="pre">bigint</span></code> in a 64-bit 2’s complement big endian format.</p>
</dd></dl>

<dl class="function">
<dt id="from_big_endian_64">
<code class="descname">from_big_endian_64</code><span class="sig-paren">(</span><em>binary</em><span class="sig-paren">)</span> &#x2192; bigint</dt>
<dd><p>Decodes <code class="docutils literal"><span class="pre">bigint</span></code> value from a 64-bit 2’s complement big endian <code class="docutils literal"><span class="pre">binary</span></code>.</p>
</dd></dl>

<dl class="function">
<dt id="to_big_endian_32">
<code class="descname">to_big_endian_32</code><span class="sig-paren">(</span><em>integer</em><span class="sig-paren">)</span> &#x2192; varbinary</dt>
<dd><p>Encodes <code class="docutils literal"><span class="pre">integer</span></code> in a 32-bit 2’s complement big endian format.</p>
</dd></dl>

<dl class="function">
<dt id="from_big_endian_32">
<code class="descname">from_big_endian_32</code><span class="sig-paren">(</span><em>binary</em><span class="sig-paren">)</span> &#x2192; integer</dt>
<dd><p>Decodes <code class="docutils literal"><span class="pre">integer</span></code> value from a 32-bit 2’s complement big endian <code class="docutils literal"><span class="pre">binary</span></code>.</p>
</dd></dl>

<dl class="function">
<dt id="to_ieee754_32">
<code class="descname">to_ieee754_32</code><span class="sig-paren">(</span><em>real</em><span class="sig-paren">)</span> &#x2192; varbinary</dt>
<dd><p>Encodes <code class="docutils literal"><span class="pre">real</span></code> in a 32-bit big-endian binary according to IEEE 754 single-precision floating-point format.</p>
</dd></dl>

<dl class="function">
<dt id="from_ieee754_32">
<code class="descname">from_ieee754_32</code><span class="sig-paren">(</span><em>binary</em><span class="sig-paren">)</span> &#x2192; real</dt>
<dd><p>Decodes the 32-bit big-endian <code class="docutils literal"><span class="pre">binary</span></code> in IEEE 754 single-precision floating-point format.</p>
</dd></dl>

<dl class="function">
<dt id="to_ieee754_64">
<code class="descname">to_ieee754_64</code><span class="sig-paren">(</span><em>double</em><span class="sig-paren">)</span> &#x2192; varbinary</dt>
<dd><p>Encodes <code class="docutils literal"><span class="pre">double</span></code> in a 64-bit big-endian binary according to IEEE 754 double-precision floating-point format.</p>
</dd></dl>

<dl class="function">
<dt id="from_ieee754_64">
<code class="descname">from_ieee754_64</code><span class="sig-paren">(</span><em>binary</em><span class="sig-paren">)</span> &#x2192; double</dt>
<dd><p>Decodes the 64-bit big-endian <code class="docutils literal"><span class="pre">binary</span></code> in IEEE 754 double-precision floating-point format.</p>
</dd></dl>

<dl class="function">
<dt>
<code class="descname">lpad</code><span class="sig-paren">(</span><em>binary</em>, <em>size</em>, <em>padbinary</em><span class="sig-paren">)</span> &#x2192; varbinary</dt>
<dd><p>Left pads <code class="docutils literal"><span class="pre">binary</span></code> to <code class="docutils literal"><span class="pre">size</span></code> bytes with <code class="docutils literal"><span class="pre">padbinary</span></code>.
If <code class="docutils literal"><span class="pre">size</span></code> is less than the length of <code class="docutils literal"><span class="pre">binary</span></code>, the result is
truncated to <code class="docutils literal"><span class="pre">size</span></code> characters. <code class="docutils literal"><span class="pre">size</span></code> must not be negative
and <code class="docutils literal"><span class="pre">padbinary</span></code> must be non-empty.</p>
</dd></dl>

<dl class="function">
<dt>
<code class="descname">rpad</code><span class="sig-paren">(</span><em>binary</em>, <em>size</em>, <em>padbinary</em><span class="sig-paren">)</span> &#x2192; varbinary</dt>
<dd><p>Right pads <code class="docutils literal"><span class="pre">binary</span></code> to <code class="docutils literal"><span class="pre">size</span></code> bytes with <code class="docutils literal"><span class="pre">padbinary</span></code>.
If <code class="docutils literal"><span class="pre">size</span></code> is less than the length of <code class="docutils literal"><span class="pre">binary</span></code>, the result is
truncated to <code class="docutils literal"><span class="pre">size</span></code> characters. <code class="docutils literal"><span class="pre">size</span></code> must not be negative
and <code class="docutils literal"><span class="pre">padbinary</span></code> must be non-empty.</p>
</dd></dl>

<dl class="function">
<dt id="crc32">
<code class="descname">crc32</code><span class="sig-paren">(</span><em>binary</em><span class="sig-paren">)</span> &#x2192; bigint</dt>
<dd><p>Computes the CRC-32 of <code class="docutils literal"><span class="pre">binary</span></code>. For general purpose hashing, use
<a class="reference internal" href="#xxhash64" title="xxhash64"><code class="xref py py-func docutils literal"><span class="pre">xxhash64()</span></code></a>, as it is much faster and produces a better quality hash.</p>
</dd></dl>

<dl class="function">
<dt id="md5">
<code class="descname">md5</code><span class="sig-paren">(</span><em>binary</em><span class="sig-paren">)</span> &#x2192; varbinary</dt>
<dd><p>Computes the md5 hash of <code class="docutils literal"><span class="pre">binary</span></code>.</p>
</dd></dl>

<dl class="function">
<dt id="sha1">
<code class="descname">sha1</code><span class="sig-paren">(</span><em>binary</em><span class="sig-paren">)</span> &#x2192; varbinary</dt>
<dd><p>Computes the sha1 hash of <code class="docutils literal"><span class="pre">binary</span></code>.</p>
</dd></dl>

<dl class="function">
<dt id="sha256">
<code class="descname">sha256</code><span class="sig-paren">(</span><em>binary</em><span class="sig-paren">)</span> &#x2192; varbinary</dt>
<dd><p>Computes the sha256 hash of <code class="docutils literal"><span class="pre">binary</span></code>.</p>
</dd></dl>

<dl class="function">
<dt id="sha512">
<code class="descname">sha512</code><span class="sig-paren">(</span><em>binary</em><span class="sig-paren">)</span> &#x2192; varbinary</dt>
<dd><p>Computes the sha512 hash of <code class="docutils literal"><span class="pre">binary</span></code>.</p>
</dd></dl>

<dl class="function">
<dt id="xxhash64">
<code class="descname">xxhash64</code><span class="sig-paren">(</span><em>binary</em><span class="sig-paren">)</span> &#x2192; varbinary</dt>
<dd><p>Computes the xxhash64 hash of <code class="docutils literal"><span class="pre">binary</span></code>.</p>
</dd></dl>

<dl class="function">
<dt id="spooky_hash_v2_32">
<code class="descname">spooky_hash_v2_32</code><span class="sig-paren">(</span><em>binary</em><span class="sig-paren">)</span> &#x2192; varbinary</dt>
<dd><p>Computes the 32-bit SpookyHashV2 hash of <code class="docutils literal"><span class="pre">binary</span></code>.</p>
</dd></dl>

<dl class="function">
<dt id="spooky_hash_v2_64">
<code class="descname">spooky_hash_v2_64</code><span class="sig-paren">(</span><em>binary</em><span class="sig-paren">)</span> &#x2192; varbinary</dt>
<dd><p>Computes the 64-bit SpookyHashV2 hash of <code class="docutils literal"><span class="pre">binary</span></code>.</p>
</dd></dl>

<dl class="function">
<dt id="hmac_md5">
<code class="descname">hmac_md5</code><span class="sig-paren">(</span><em>binary</em>, <em>key</em><span class="sig-paren">)</span> &#x2192; varbinary</dt>
<dd><p>Computes HMAC with md5 of <code class="docutils literal"><span class="pre">binary</span></code> with the given <code class="docutils literal"><span class="pre">key</span></code>.</p>
</dd></dl>

<dl class="function">
<dt id="hmac_sha1">
<code class="descname">hmac_sha1</code><span class="sig-paren">(</span><em>binary</em>, <em>key</em><span class="sig-paren">)</span> &#x2192; varbinary</dt>
<dd><p>Computes HMAC with sha1 of <code class="docutils literal"><span class="pre">binary</span></code> with the given <code class="docutils literal"><span class="pre">key</span></code>.</p>
</dd></dl>

<dl class="function">
<dt id="hmac_sha256">
<code class="descname">hmac_sha256</code><span class="sig-paren">(</span><em>binary</em>, <em>key</em><span class="sig-paren">)</span> &#x2192; varbinary</dt>
<dd><p>Computes HMAC with sha256 of <code class="docutils literal"><span class="pre">binary</span></code> with the given <code class="docutils literal"><span class="pre">key</span></code>.</p>
</dd></dl>

<dl class="function">
<dt id="hmac_sha512">
<code class="descname">hmac_sha512</code><span class="sig-paren">(</span><em>binary</em>, <em>key</em><span class="sig-paren">)</span> &#x2192; varbinary</dt>
<dd><p>Computes HMAC with sha512 of <code class="docutils literal"><span class="pre">binary</span></code> with the given <code class="docutils literal"><span class="pre">key</span></code>.</p>
</dd></dl>

</div>
</div>


</div>
<div class="bottomnav">
    
<p class="nav">
    <span class="left">
        &laquo; <a href="regexp.html">7.10. Regular Expression Functions</a>
    </span>
    <span class="right">
        <a href="json.html">7.12. JSON Functions and Operators</a> &raquo;
    </span>
</p>

</div>

    <div class="footer" role="contentinfo">
    </div>
  </body>
</html>