conventions.html

<!DOCTYPE html>
<html>
<head>
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
    <meta http-equiv="x-ua-compatible" content="ie=edge">
    <title>Starburst | Conventions</title>
    <meta name="viewport" content="width=device-width">
    <meta property="og:type" content="website">
    <meta property="og:title" content="Starburst - Conventions">
    <meta property="og:description" content="Your hub to all knowledge about Starburst products.">
    <meta property="og:image" content="/assets/img/starburst-og-image.png">

    <link rel="stylesheet" href="https://fonts.googleapis.com/css2?family=Material+Symbols+Rounded">
    <!-- <link rel="stylesheet" href="/assets/fontawesome/css/all.css"> -->
    <link rel="stylesheet" href="/assets/css/bootstrap.min.css">
    <link rel="stylesheet" href="/assets/css/mdb.min.css">
    <link rel="stylesheet" href="/assets/css/highlight.css">
    <link rel="stylesheet" href="/assets/css/fonts.css">
    <link rel="stylesheet" href="/assets/css/style.css">
<script async src="https://www.googletagmanager.com/gtag/js?id=G-CY10FQPGJS"></script>
<script>
    window.dataLayer = window.dataLayer || [];
    function gtag(){dataLayer.push(arguments);}
    gtag('js', new Date());
    gtag('config', 'G-CY10FQPGJS');
</script>

<script type="text/javascript">
    window.heap=window.heap||[],heap.load=function(e,t){window.heap.appid=e,window.heap.config=t=t||{};var r=document.createElement("script");r.type="text/javascript",r.async=!0,r.src="https://cdn.heapanalytics.com/js/heap-"+e+".js";var a=document.getElementsByTagName("script")[0];a.parentNode.insertBefore(r,a);for(var n=function(e){return function(){heap.push([e].concat(Array.prototype.slice.call(arguments,0)))}},p=["addEventProperties","addUserProperties","clearEventProperties","identify","resetIdentity","removeEventProperty","setEventProperties","track","unsetEventProperty"],o=0;o<p.length;o++)heap[p[o]]=n(p[o])};
    heap.load("588835629");
</script>
<script>
  var ALGOLIA_INSIGHTS_SRC = "https://cdn.jsdelivr.net/npm/search-insights@2.2.1";

  !function(e,a,t,n,s,i,c){e.AlgoliaAnalyticsObject=s,e[s]=e[s]||function(){
  (e[s].queue=e[s].queue||[]).push(arguments)},i=a.createElement(t),c=a.getElementsByTagName(t)[0],
  i.async=1,i.src=n,c.parentNode.insertBefore(i,c)
  }(window,document,"script",ALGOLIA_INSIGHTS_SRC,"aa");
</script>
<!-- Begin Jekyll SEO tag v2.8.0 -->
<title>Conventions | Starburst</title>
<meta name="generator" content="Jekyll v4.2.2" />
<meta property="og:title" content="Conventions" />
<meta property="og:locale" content="en_US" />
<meta name="description" content="Your hub to all knowledge about Starburst products." />
<meta property="og:description" content="Your hub to all knowledge about Starburst products." />
<link rel="canonical" href="https://docs.starburst.io/conventions.html" />
<meta property="og:url" content="https://docs.starburst.io/conventions.html" />
<meta property="og:site_name" content="Starburst" />
<meta property="og:type" content="website" />
<meta name="twitter:card" content="summary" />
<meta property="twitter:title" content="Conventions" />
<script type="application/ld+json">
{"@context":"https://schema.org","@type":"WebPage","description":"Your hub to all knowledge about Starburst products.","headline":"Conventions","publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"https://docs.starburst.io/assets/img/logo/starburst-reverse.png"}},"url":"https://docs.starburst.io/conventions.html"}</script>
<!-- End Jekyll SEO tag -->

</head>
<body>


<div class="wrap">
  

<header class="main-header navbar-expand-md">
  <div class="navbar fixed-top navbar-dark">
    <div class="container">
      <div class="navbar-left-container">
        <a class="navbar-brand" href="https://www.starburst.io/">
          <img src="/assets/img/logo/Starburst_Logo_White+Blue.svg" height="25" alt="Starburst">
        </a>
        <span class="navbar-divider"></span>
        <a href="/" class="header-text">Documentation</a>
      </div>
      
      <div class="nav-item dropdown" id="site-search">
  <div id="dropdownSearchDisplay" aria-labelledby="dropdownSearch">
    <div id="algolia-search">
      <div id="searchbox"></div>
      <div
        class="refinement-list"
        id="versionsRefinementList"
        style="display: none"
      ></div>
      <div class="refinement-list" id="product-list">
        <h6>Product:</h6>
      </div>
      <div id="hits"></div>
      <div id="stats"></div>
    </div>
  </div>
</div>

      
      <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarSupportedContent" aria-controls="navbarSupportedContent" aria-expanded="false" aria-label="Toggle navigation">
        <span class="navbar-toggler-icon"></span>
      </button>
    </div>
  </div>
    <nav class="primary-nav">
      <div class="container collapse navbar-collapse" id="navbarSupportedContent">
        <ul class="navbar-layout navbar-nav mr-auto">
          <li class="nav-item dropdown">
            <a id="introduction"
               class="nav-link dropdown-toggle" 
              aria-haspopup="true" aria-label="Introduction" data-is-click="false"
              href="/introduction/index.html">Introduction</a>
            <div class="dropdown-menu dropdown-docs">
              <a class="dropdown-item" href="/introduction/concepts.html">Concepts</a>
              <a class="dropdown-item" href="/introduction/architecture.html">Architecture</a>
              <a class="dropdown-item" href="/introduction/choose-your-starburst-product.html">Choose your Starburst product</a>
              <a class="dropdown-item" href="/introduction/data-sources-catalogs.html">Data sources and catalogs</a>
              <a class="dropdown-item" href="/introduction/data-lake.html">Data lakes</a>
              <a class="dropdown-item" href="/introduction/object-storage.html">Using object storage systems</a>
              <a class="dropdown-item" href="/introduction/metastores.html">Metastore options</a>
              <a class="dropdown-item" href="/introduction/security.html">Security</a>
              <a class="dropdown-item" href="/introduction/querying-data.html">Querying data with Starburst products</a>
              <a class="dropdown-item" href="/introduction/starburst-sql.html">Using SQL</a>
              <a class="dropdown-item" href="/introduction/migration.html">Migrating queries to Starburst</a>
              <a class="dropdown-item" href="/introduction/query-performance.html">Query performance</a>
              <a class="dropdown-item" href="/introduction/performance-features.html">Performance features</a>
            </div>
          </li>
          <li class="nav-item dropdown">
            <a id="clients"
               class="nav-link dropdown-toggle" 
              aria-haspopup="true" aria-label="Clients" data-is-click="false"
              href="/clients/index.html">Clients</a>
            <div class="dropdown-menu dropdown-docs">
              <a class="dropdown-item" href="/clients/index.html">All clients</a>
              <a class="dropdown-item" href="/clients/gather-connection-information.html">Gather connection information</a>
              <a class="dropdown-item" href="/clients/cli.html">Trino CLI</a>
              <a class="dropdown-item" href="/clients/jdbc.html">JDBC driver</a>
              <a class="dropdown-item" href="/clients/odbc/index.html">ODBC driver</a>
              <a class="dropdown-item" href="/clients/machine-learning.html">Machine learning</a>
            </div>
          </li>
          <li class="nav-item dropdown">
            <a id="starburst-galaxy"
               class="nav-link dropdown-toggle" 
              aria-haspopup="true" aria-label="Starburst Galaxy" data-is-click="false"
              href="/starburst-galaxy/index.html">Starburst Galaxy</a>
            <div class="dropdown-menu dropdown-docs">
              <a class="dropdown-item" href="/starburst-galaxy/get-started/index.html">Get started</a>
              <a class="dropdown-item" href="/starburst-galaxy/get-started/get-support.html">Help center</a>
              <a class="dropdown-item" href="/starburst-galaxy/working-with-data/index.html">Working with data</a>
              <a class="dropdown-item" href="/starburst-galaxy/working-with-data/query-data/index.html"> Query data</a>
              <a class="dropdown-item" href="/starburst-galaxy/working-with-data/explore-data/index.html"> Explore data</a>
              <a class="dropdown-item" href="/starburst-galaxy/working-with-data/create-catalogs/index.html">Manage catalogs</a>
              <a class="dropdown-item" href="/starburst-galaxy/working-with-data/explore-data/browse-data-products.html">Data products</a>
              <a class="dropdown-item" href="/starburst-galaxy/data-engineering/index.html">Data engineering</a>
              <a class="dropdown-item" href="/starburst-galaxy/cluster-administration/index.html">Cluster administration</a>
              <a class="dropdown-item" href="/starburst-galaxy/security-and-compliance/index.html">Security and compliance</a>
              <a class="dropdown-item" href="/starburst-galaxy/troubleshooting/index.html">Troubleshooting</a>
              <a class="dropdown-item" href="/starburst-galaxy/developer-tools/python/index.html">Python</a>
              <a class="dropdown-item" href="/starburst-galaxy/reference/sql/index.html">SQL</a>
              <a class="dropdown-item" href="/starburst-galaxy/reference/index.html">Reference</a>
            </div>
          </li>
          <li class="nav-item dropdown">
            <a id="starburst-enterprise"
               class="nav-link dropdown-toggle" 
              aria-haspopup="true" aria-label="Get started" data-is-click="false"
              href="/starburst-enterprise/index.html">Starburst Enterprise</a>
            <div class="dropdown-menu dropdown-docs">
              <a class="dropdown-item" href="/latest/index.html">Latest documentation</a>
              <a class="dropdown-item" href="/latest/language.html">SQL reference</a>
              <a class="dropdown-item" href="/latest/connector.html">Connect to data sources</a>
              <a class="dropdown-item" href="/latest/admin-topics.html">Administration topics</a>
              <a class="dropdown-item" href="/latest/security.html">Security</a>
              <a class="dropdown-item" href="/latest/versions.html">Version information</a>
            </div>
          </li>
          <li class="nav-item dropdown">
            <a id="resources"
               class="nav-link dropdown-toggle active"
              
              aria-haspopup="true" aria-label="resources" data-is-click="false"
              href="/resources.html">Resources</a>
            <div class="dropdown-menu dropdown-docs">
              <a class="dropdown-item" href="/support.html">Support</a>
              <a class="dropdown-item" href="https://academy.starburst.io/">Starburst Academy</a>
              <a class="dropdown-item" href="https://www.starburst.io/blog/technical">Technical blog</a>
              <a class="dropdown-item" href="https://trust.starburst.io">Trust Center</a>
              <a class="dropdown-item" href="/security/index.html">Security</a>
              <a class="dropdown-item" href="/glossary.html">Glossary</a>
              <a class="dropdown-item" href="/conventions.html">Conventions</a>
              <a class="dropdown-item" href="/iconography.html">Iconography</a>
            </div>
          </li>
        </ul>
      </div>
    </nav>
</header>

  
  <div class="container content">
    <div class="row">
      <div class="col-md-3 side-navigation">
        <div class="spacer-60 toc-sticky left-nav">
          
          <div>
  <h6 class="overline product-nav-title">Resources</h6>
</div>
<hr />

  
      <li >
        <a href="/resources.html" >Overview</a>
      </li>
  

      <li >
        <a href="/support.html" >Support</a>
      </li>
  

      <li >
        <a href="https://academy.starburst.io/" >Starburst Academy</a>
      </li>
  

      <li >
        <a href="https://www.starburst.io/blog/technical" >Technical blog</a>
      </li>
  

      <li >
        <a href="https://trust.starburst.io/" >Trust Center</a>
      </li>
  

      <li >
        <a href="/security/index.html" >Security</a>
      </li>
  

      <li >
        <a href="/glossary.html" >Glossary</a>
      </li>
  

      <li class="active">
        <a href="/conventions.html" >Conventions</a>
      </li>
  

      <li >
        <a href="/iconography.html" >Iconography</a>
      </li>
  

        </div>
      </div>
      <div class="col-md-9 col-lg-6 spacer-30 docs-content">
        

<div class="breadcrumbs">
  <p>
  
  
      Conventions
    
  </p>
</div>

        <h1 id="conventions">
        
        
          Conventions <a href="#conventions" class="titleAnchor">#</a>
        
        
      </h1>
    

<p>This topic describes typographical and some other conventions used throughout
the documentation.</p>
      <h2 id="italic-text">
        
        
          Italic text <a href="#italic-text" class="titleAnchor">#</a>
        
        
      </h2>
    

<p>Introduces a new term.</p>

<p>Example: The data from the splits and associated metadata are managed as a <em>row
group</em>.</p>
      <h2 id="monotype-font">
        
        
          Monotype font <a href="#monotype-font" class="titleAnchor">#</a>
        
        
      </h2>
    

<p>Represents commands, code, file names, and response examples.</p>

<p>Example: <code class="language-plaintext highlighter-rouge">TRUNCATE TABLE table_name</code></p>
      <h2 id="bold-text">
        
        
          Bold text <a href="#bold-text" class="titleAnchor">#</a>
        
        
      </h2>
    

<p>Indicates a keyboard button or the label or title on a user interface element.</p>

<p>Examples:</p>

<ul>
  <li>Click <strong>Enter</strong>.</li>
  <li>The <strong>My saved queries</strong> tab …</li>
</ul>
      <h2 id="angle-brackets">
        
        
          Angle brackets <a href="#angle-brackets" class="titleAnchor">#</a>
        
        
      </h2>
    

<p>Encloses items you replace with your own values. Do not include the angle
brackets in your commands or code.</p>

<p>Example: <code class="language-plaintext highlighter-rouge">cd /home/&lt;username&gt;/Downloads</code></p>
      <h2 id="ellipsis">
        
        
          Ellipsis <a href="#ellipsis" class="titleAnchor">#</a>
        
        
      </h2>
    

<p>Indicates you can repeat a previous item, such as an <code class="language-plaintext highlighter-rouge">array</code> element, an
indefinite number of times. Also indicates an omission within lengthier
commands, configuration, or response examples.</p>

<p>Examples:</p>

<ul>
  <li><code class="language-plaintext highlighter-rouge">concat(array1, array2, ..., arrayN)</code></li>
  <li><code class="language-plaintext highlighter-rouge">curl ... -H 'Authorization: Basic dFHzdDp0ZXN0'</code></li>
</ul>

<p>Ellipsis can also be a placeholder for multiple lines of content that are
omitted.</p>

<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>  ...
  catalogs:
    test: |
      connector.name=tpch
    ...
    salesdb: |
      connector.name=postgresql
      connection-url=jdbc:postgresql://postgresql:5432/salesdb
      connection-password=${ENV:PSQL_PASSWORD}
      connection-user=${ENV:PSQL_USERNAME}
</code></pre></div></div>

<p>Ellipses can make the code example invalid and not suitable for direct cut and
paste usage.</p>
      <h2 id="pipe">
        
        
          Pipe <a href="#pipe" class="titleAnchor">#</a>
        
        
      </h2>
    

<p>Separates mutually exclusive options.</p>

<p>Examples:</p>

<ul>
  <li><code class="language-plaintext highlighter-rouge">ALL | DISTINCT</code></li>
</ul>
      <h2 id="notes-cautions-and-warnings">
        
        
          Notes, cautions, and warnings <a href="#notes-cautions-and-warnings" class="titleAnchor">#</a>
        
        
      </h2>
    

<p>The documentation uses the following message to highlight additional
information, in order from least to most critical.</p>

<div class="alert alert-info" role="alert">
  <i class="fa fa-info-circle"></i>
  <b>Note: </b>
  A note provides additional, non-critical
information and context for the reader.</div>

<div class="alert alert-warning" role="alert">
  <i class="fa fa-exclamation-triangle"></i> <b>Caution:</b>

  A caution message urges the reader to pay
special attention and proceed carefully, after understanding the content of the
message.

</div>

<div class="alert alert-danger" role="alert">
  <i class="fa fa-radiation"></i> <b>Warning:</b>

  A warning message commands attention from the
reader to avoid negative impacts, such as permanent data loss.

</div>

        <div class="feedback-container">
  <div class="feedback-thumbs">
    <p>Is the information on this page helpful?</p>
    <div class="thumb-wrapper">
      <p class="feedback-option" title="yes"><i class="fa fa-thumbs-up"></i>Yes</p>
      <p class="feedback-option" title="no"><i class="fa fa-thumbs-down"></i>No</p>
    </div>
  </div>
  <div class="feedback-message">
    <textarea class="feedback-body" placeholder="Additional feedback"></textarea>
    <button type="button" onclick="sendMessage()" class="btn btn-sm btn-primary">Email</button>
    <a onclick="skip()" class="feedback-skip">Cancel</a>
  </div>
</div>

<script>
function feedback() {
  var feedbackValue = "";
  var feedbackThumbs = document.querySelector(".feedback-thumbs");
  var feedbackMessage = document.querySelector(".feedback-message");
  var initialFeedbackMessageContents = feedbackMessage.innerHTML;
  var feedbackAnswer = localStorage.getItem('feedback-answer-' + window.location.pathname);
  var options = Array.from(document.querySelectorAll(".feedback-option"));

  if (feedbackAnswer) {
    Object.keys(options).map(i => options[i].getAttribute('title') == JSON.parse(feedbackAnswer)
      ? options[i].classList.add('active')
      : null
    );
  }

  var clickFunction = function(event){
    var page = window.location.pathname;
    var value = event.currentTarget.getAttribute('title');
    var eventValue = value == 'yes' ? 1 : 0;

    if(!event.currentTarget.classList.contains('active')) {
      localStorage.setItem('feedback-answer-' + page, JSON.stringify(value == 'yes' ? 'yes' : 'no'));
      feedbackValue = value;

      gtag('event', 'feedback', {
        'event_category': 'Docs Feedback',
        'event_label': page,
        'event_value': eventValue,
      });

      Object.keys(options).map(i => options[i].classList.remove('active'));
      event.currentTarget.classList.add('active');

      feedbackThumbs.style.display = "none";
      feedbackMessage.style.display = "flex";
    };
  };

  skip = function() {
    feedbackMessage.style.display = "none";
    feedbackThumbs.style.display = "flex";
    feedbackMessage.innerHTML = initialFeedbackMessageContents;
  }

  sendMessage = function(){
    var feedbackBody = document.querySelector(".feedback-body").value;

    if (feedbackBody) {
      var message = "Page url: " + window.location.pathname + "\n\n"
        + "Feedback positive?: " + feedbackValue + "\n\n" +  "Feedback Message: " + feedbackBody;
      var link = "mailto:docs-feedback@starburst.io?subject=" + encodeURIComponent("Feedback")+"&body="
        + encodeURIComponent(message);

      window.location.href = link;
      feedbackMessage.innerHTML = "<p>Thank you!</p>";

      setTimeout(function(){
          skip();
      }, 5000);
    } else {
      if(!document.querySelector("#feedback-skip")) {
        var alertMessage = document.createElement("p");
        alertMessage.id = "feedback-skip";
        alertMessage.style.color = "red";
        alertMessage.style.position = "absolute";
        alertMessage.style.bottom = "-0.5rem";
        alertMessage.innerHTML = "Please provide a message.";
        feedbackMessage.appendChild(alertMessage);

        setTimeout(function(){
          alertMessage.remove();
        }, 3000);
      }
    }
  }

  Object.keys(options).map(i => options[i].addEventListener('click', clickFunction , false));
}

feedback();
</script>

      </div>
      <div class="col-lg-3 toc-styles d-none d-lg-block">
        <div class="spacer-60 toc-sticky">
          <ul><li><a href="#conventions">Conventions</a><ul><li><a href="#italic-text">Italic text</a></li><li><a href="#monotype-font">Monotype font</a></li><li><a href="#bold-text">Bold text</a></li><li><a href="#angle-brackets">Angle brackets</a></li><li><a href="#ellipsis">Ellipsis</a></li><li><a href="#pipe">Pipe</a></li><li><a href="#notes-cautions-and-warnings">Notes, cautions, and warnings</a></li></ul></li></ul>

          <button type="button" class="btn btn-primary waves-effect waves-light print-button" onclick="window.print()">Print this page</button>
        </div>
      </div>
  </div>
  
</div>
<footer class="page-footer">
  <div class="container">
    <div class="row">
      <div class="col-md-6">
        <p style="font-weight:900">Resources</b></p>
        <ul>
          <li class="footer-item"><a href="/videos/index.html">Video library</a></li>
          <li class="footer-item"><a href="/glossary.html">Glossary</a></li>
          <li class="footer-item"><a href="https://www.starburst.io/info/oreilly-trino-guide/" target="_blank">Free O'Reilly book - Trino: The Definitive Guide</a></li>
          <li class="footer-item"><a href="https://trino.io/broadcast/" target="_blank">Trino Community Broadcast</a></li>
          <li class="footer-item"><a href="https://www.starburst.io/community/forum/" target="_blank">Starburst forum</a></li>
          <li class="footer-item"><a href="https://blog.starburstdata.com/" target="_blank">Starburst blog</a></li>
        </ul>
      </div>
      <div class="col-md-3">
        <p style="font-weight:900">Contact and more</p>
        <ul>
          <li class="footer-item"><a href="https://www.starburst.io" target="_blank">Starburst</a></li>
          <li class="footer-item"><a href="https://www.starburst.io/#download" target="_blank">Start a trial</a></li>
          <li class="footer-item"><a href="/support.html" target="_blank">Get support</a></li>
          <li class="footer-item"><a href="https://www.starburst.io/contact/" target="_blank">Contact us</a></li>
        </ul>
      </div>
      <div class="col-md-3" style="text-align:right;">
        <a href="https://www.starburst.io/" target="_blank"><img src="/assets/img/logo/Starburst_Logo_White+Blue.svg" height="34" alt=" Starburst" style="margin-bottom:20px;"></a>
        <li class="footer-item" style="padding-right:10px;">
          <a href="/disclaimers.html#copyright">Copyright © 2017-2025<br> Starburst Data</a>
        </li>
        <li class="footer-item" style="padding-right:10px;">
          <a href="/disclaimers.html#trademarks">Trademark information</a>
        </li>
      </div>
    </div>
    <div class="row">
      <div class="col-md-12 center spacer-30">
          <a href="https://twitter.com/starburstdata" target="_blank" class="footer-icon"><i class="fab fa-twitter"></i></a>
          <a href="https://linkedin.com/starburstdata" target="_blank" class="footer-icon"><i class="fab fa-linkedin"></i></a>
          <a href="https://www.youtube.com/channel/UCXjkuWSO9CV_cSI3Mvo4a4w" target="_blank" class="footer-icon"><i class="fab fa-youtube"></i></a>
          <a href="https://github.com/starburstdata" target="_blank" class="footer-icon"><i class="fab fa-github"></i></a>
      </div>
    </div>
  </div>
</footer>

  <script type="text/javascript" src="/assets/js/jquery.min.js"></script>
  <script type="text/javascript" src="/assets/js/popper.min.js"></script>
  <script type="text/javascript" src="/assets/js/bootstrap.min.js"></script>
  <script type="text/javascript" src="/assets/js/mdb.min.js"></script>
  <script type="text/javascript" src="/assets/js/custom.js"></script>
  <script type="text/javascript" src="/assets/js/algolia.js"></script>
  <script type="text/javascript" src="/assets/js/search-box.js"></script>
  <script type="text/javascript" src="/assets/js/search-results.js"></script>
</body>
</html>