CrateDB Documentation - CrateDB: Guide

<!doctype html> <html class="no-js" lang="en" data-content_root=""> <head><meta charset="utf-8"/> <meta name="viewport" content="width=device-width,initial-scale=1"/> <meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" /> <meta property="og:title" content="CrateDB Documentation" /> <meta property="og:type" content="website" /> <meta property="og:url" content="https://cratedb.com/docs/guide/home/index.html" /> <meta property="og:site_name" content="CrateDB Documentation" /> <meta property="og:description" content="Welcome to the official CrateDB Documentation. Whether you are a developer, database administrator, or just starting your journey with CrateDB, our documentation provides the information and knowledge needed to build real-time analytics and hybrid search applications that leverage CrateDB’s uniqu..." /> <meta property="og:image" content="https://crate-docs-theme.readthedocs.io/en/latest/_static/images/cratedb-logo-h630.png" /> <meta name="description" content="Welcome to the official CrateDB Documentation. Whether you are a developer, database administrator, or just starting your journey with CrateDB, our documentation provides the information and knowledge needed to build real-time analytics and hybrid search applications that leverage CrateDB’s uniqu..." /> <link rel="search" title="Search" href="../search.html" /> <link rel="shortcut icon" type="image/png" href="../_static/images/favicon.png"/>  <link rel="preconnect" href="https://az1nev7cg0-dsn.algolia.net" crossorigin />  <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@docsearch/css@3" />  <script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start': new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0], j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src= 'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f); })(window,document,'script','dataLayer','GTM-WHMDSK');</script>  <noscript> <style> .cr-nojs-hide { display: none; } </style> </noscript>  <link rel="canonical" href="https://cratedb.com/docs/guide/home/index.html" /> <title>CrateDB Documentation - CrateDB: Guide</title> <link rel="stylesheet" href="../_static/skeleton.css" type="text/css" /><link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=20074c1a" /> <link rel="stylesheet" type="text/css" href="../_static/css/components.css?v=c502da3f" /> <link rel="stylesheet" type="text/css" href="../_static/mystnb.4510f1fc1dee50b3e5859aac5469c37c29e427902b24a333a5f9fcb2f0b3ac41.css" /> <link rel="stylesheet" type="text/css" href="../_static/copybutton.css?v=76b2166b" /> <link rel="stylesheet" type="text/css" href="../_static/tabs.css?v=4c969af8" /> <link rel="stylesheet" type="text/css" href="../_static/togglebutton.css?v=13237357" /> <link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" /> <link rel="stylesheet" type="text/css" href="../_static/sphinx-design.min.css?v=87e54e7c" /> <link rel="stylesheet" type="text/css" href="../_static/design-elements.e5416f61bae5d36adc6d722a2b6f8cff.css?v=452a8e97" /> <link rel="stylesheet" type="text/css" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.1.1/css/all.min.css" /> <style> html { --color-code-background: #f8f8f8; --color-code-foreground: black; } @media not print { html[data-theme="dark"] { --color-code-background: #202020; --color-code-foreground: #d0d0d0; } @media (prefers-color-scheme: dark) { html:not([data-theme="light"]) { --color-code-background: #202020; --color-code-foreground: #d0d0d0; } } } </style><script src="../_static/bundle/main.js?ver=0.38.3"></script><script async type="text/javascript" src="/_/static/javascript/readthedocs-addons.js"></script><meta name="readthedocs-project-slug" content="cratedb-guide" /><meta name="readthedocs-version-slug" content="latest" /><meta name="readthedocs-resolver-filename" content="/home/" /><meta name="readthedocs-http-status" content="200" /></head> <body> <script> document.documentElement.dataset.theme = localStorage.getItem("theme") || "auto"; </script> <svg xmlns="http://www.w3.org/2000/svg" style="display: none;"> <symbol id="svg-toc" viewBox="0 0 24 24"> <title>Contents</title> <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024"> <path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/> </svg> </symbol> <symbol id="svg-menu" viewBox="0 0 24 24"> <title>Menu</title> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu"> <line x1="3" y1="12" x2="21" y2="12"></line> <line x1="3" y1="6" x2="21" y2="6"></line> <line x1="3" y1="18" x2="21" y2="18"></line> </svg> </symbol> <symbol id="svg-arrow-right" viewBox="0 0 24 24"> <title>Expand</title> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right"> <polyline points="9 18 15 12 9 6"></polyline> </svg> </symbol> <symbol id="svg-sun" viewBox="0 0 24 24"> <title>Light mode</title> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="feather-sun"> <circle cx="12" cy="12" r="5"></circle> <line x1="12" y1="1" x2="12" y2="3"></line> <line x1="12" y1="21" x2="12" y2="23"></line> <line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line> <line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line> <line x1="1" y1="12" x2="3" y2="12"></line> <line x1="21" y1="12" x2="23" y2="12"></line> <line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line> <line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line> </svg> </symbol> <symbol id="svg-moon" viewBox="0 0 24 24"> <title>Dark mode</title> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon"> <path stroke="none" d="M0 0h24v24H0z" fill="none" /> <path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" /> </svg> </symbol> </svg> <a class="skip-to-content muted-link" href="#main-content">Skip to content</a> <div class="sb-announcement"> </div> <header class="sb-header header-nav" id="top"> <div class="sb-header__inner sb-page-width"> <div class="container-fluid"> <div class="navbar w-nav" data-animation="default" data-collapse="small" data-contain="1" data-duration="400"> <a class="brand w-nav-brand" href="/" title="cratedb.com"> <svg version="1.2" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 218 36" width="218" height="36" alt="CrateDB Logo" loading="lazy" class="cr-cratedb-logo"> <defs> <clipPath clipPathUnits="userSpaceOnUse" id="crp1"> <path d="m1.49 3.63h7.31v7.31h-7.31z" /> </clipPath> <clipPath clipPathUnits="userSpaceOnUse" id="crp2"> <path d="m1.49 14.6h18.28v7.31h-18.28z" /> </clipPath> <clipPath clipPathUnits="userSpaceOnUse" id="crp3"> <path d="m12.46 3.63h7.31v7.31h-7.31z" /> </clipPath> <clipPath clipPathUnits="userSpaceOnUse" id="crp4"> <path d="m1.49 25.57h29.25v7.31h-29.25z" /> </clipPath> <clipPath clipPathUnits="userSpaceOnUse" id="crp5"> <path d="m23.43 3.63h7.31v18.28h-7.31z" /> </clipPath> <clipPath clipPathUnits="userSpaceOnUse" id="crp6"> <path d="m45.37 6.07h24.45v24.46h-24.45z" /> </clipPath> <clipPath clipPathUnits="userSpaceOnUse" id="crp7"> <path d="m45.37 12.16v12.19c0 1.62 0.64 3.17 1.78 4.31 1.15 1.14 2.7 1.78 4.31 1.78h18.29v-4.87h-19.5v-14.63h19.5v-4.87h-18.29c-1.61 0-3.16 0.64-4.31 1.78-1.14 1.14-1.78 2.69-1.78 4.31z" /> </clipPath> <clipPath clipPathUnits="userSpaceOnUse" id="crp8"> <path d="m75.23 12.15h14.06v18.38h-14.06z" /> </clipPath> <clipPath clipPathUnits="userSpaceOnUse" id="crp9"> <path d="m80.08 15.21h-0.58l-0.61-3.05h-3.66v18.28h4.88v-11.58c0-0.64 0.26-1.26 0.71-1.72 0.46-0.46 1.08-0.71 1.73-0.71h6.7v-4.27h-6.09q-0.61-0.01-1.18 0.22-0.57 0.23-1 0.66-0.43 0.43-0.67 0.99-0.23 0.57-0.23 1.18z" /> </clipPath> <clipPath clipPathUnits="userSpaceOnUse" id="crp10"> <path d="m91.51 12.15h20.15v18.38h-20.15z" /> </clipPath> <clipPath clipPathUnits="userSpaceOnUse" id="crp11"> <path d="m108.58 12.52q0.9 0.36 1.6 1.05 0.69 0.69 1.07 1.59 0.38 0.9 0.38 1.88v13.4h-3.66l-0.61-2.43h-0.61c0 0.64-0.25 1.26-0.71 1.72-0.46 0.46-1.08 0.71-1.73 0.71h-7.02q-1.11 0.05-2.16-0.34-1.05-0.39-1.87-1.15-0.81-0.77-1.27-1.79-0.46-1.02-0.48-2.14c0.03-1.42 0.62-2.76 1.64-3.74 1.02-0.99 2.39-1.53 3.8-1.5h9.75v-3.66h-12.79v-3.96h12.78q0.98-0.01 1.89 0.36zm-3.72 14.27c0.49 0 0.96-0.2 1.3-0.54 0.34-0.34 0.54-0.81 0.54-1.29v-1.83h-8.83c-0.49 0-0.95 0.19-1.3 0.54-0.34 0.34-0.53 0.8-0.53 1.29 0 0.48 0.19 0.94 0.53 1.29 0.34 0.34 0.8 0.53 1.29 0.54h7z" /> </clipPath> <clipPath clipPathUnits="userSpaceOnUse" id="crp12"> <path d="m115.46 6.07h15.93v24.46h-15.93z" /> </clipPath> <clipPath clipPathUnits="userSpaceOnUse" id="crp13"> <path d="m125.21 6.07h-4.88v6.09h-4.87v4.27h4.87v8.53c0.05 1.48 0.67 2.88 1.75 3.91 1.07 1.02 2.5 1.58 3.98 1.55h5.24v-4.24h-6.09v-9.75h6.09v-4.27h-6.09z" /> </clipPath> <clipPath clipPathUnits="userSpaceOnUse" id="crp14"> <path d="m134.96 12.16h20.15v18.37h-20.15z" /> </clipPath> <clipPath clipPathUnits="userSpaceOnUse" id="crp15"> <path d="m153.29 13.95c1.14 1.14 1.78 2.69 1.78 4.3v4.88h-15.23v3.35h14.01v3.96h-12.8c-1.61 0-3.16-0.64-4.31-1.78-1.14-1.14-1.78-2.69-1.78-4.31v-6.1c0-1.61 0.64-3.16 1.78-4.3 1.15-1.15 2.7-1.79 4.31-1.79h7.93c1.61 0 3.16 0.64 4.31 1.79zm-2.47 5.83v-1.84c-0.01-0.48-0.2-0.95-0.54-1.29-0.35-0.34-0.81-0.53-1.29-0.53h-7.32c-0.48 0-0.94 0.2-1.29 0.54-0.34 0.34-0.53 0.81-0.53 1.29v1.83z" /> </clipPath> <clipPath clipPathUnits="userSpaceOnUse" id="crp16"> <path d="m159.95 6.07h25.58v24.46h-25.58z" /> </clipPath> <clipPath clipPathUnits="userSpaceOnUse" id="crp17"> <path d="m183.04 8.56c1.61 1.61 2.5 3.78 2.5 6.04v7.31c0 2.26-0.9 4.43-2.5 6.03-1.59 1.61-3.77 2.5-6.03 2.5h-17.06v-24.37h17.06c2.26 0 4.43 0.89 6.03 2.49zm-2.37 6.04c0-0.97-0.38-1.9-1.07-2.59-0.69-0.68-1.62-1.07-2.59-1.07h-12.19v14.63h12.19c0.97 0 1.9-0.39 2.59-1.07 0.68-0.69 1.07-1.62 1.07-2.59v-7.31z" /> </clipPath> <clipPath clipPathUnits="userSpaceOnUse" id="crp18"> <path d="m190.42 6.13h26.82v24.4h-26.82z" /> </clipPath> <clipPath clipPathUnits="userSpaceOnUse" id="crp19"> <path d="m216.99 21.36c0.37 1.44 0.29 2.97-0.22 4.37-0.52 1.4-1.45 2.6-2.68 3.46-1.22 0.85-2.68 1.31-4.17 1.32h-19.5v-24.38h18.28c1.34 0 2.65 0.37 3.8 1.06 1.14 0.7 2.07 1.7 2.69 2.88 0.61 1.19 0.89 2.53 0.8 3.86-0.09 1.34-0.55 2.62-1.31 3.72 1.13 0.97 1.93 2.26 2.31 3.71zm-21.69-5.54h13.4c0.65 0 1.27-0.26 1.73-0.72 0.46-0.45 0.71-1.07 0.71-1.72 0-0.65-0.26-1.27-0.71-1.72-0.46-0.46-1.08-0.72-1.73-0.72h-13.4zm16.34 8.83c0.44-0.5 0.68-1.15 0.68-1.82 0-0.67-0.24-1.32-0.68-1.82-0.44-0.51-1.05-0.83-1.72-0.92h-14.62v5.48h14.62c0.67-0.09 1.28-0.41 1.72-0.92z" /> </clipPath> </defs> <style> .a { fill: #19c0ea } </style> <g clip-path="url(#crp1)"> <path class="a" d="m1.5 3.6h7.3v7.3h-7.3z" /> </g> <g clip-path="url(#crp2)"> <path class="a" d="m1.5 14.6h18.3v7.3h-18.3z" /> </g> <g clip-path="url(#crp3)"> <path class="a" d="m12.5 3.6h7.2v7.3h-7.2z" /> </g> <g clip-path="url(#crp4)"> <path class="a" d="m1.5 25.6h29.3v7.2h-29.3z" /> </g> <g clip-path="url(#crp5)"> <path class="a" d="m23.4 3.6h7.3v18.3h-7.3z" /> </g> <g class="cratedb"> <g clip-path="url(#crp6)"> <g clip-path="url(#crp7)"> <path d="m45.4 6.1h24.3v24.3h-24.3z" /> </g> </g> <g clip-path="url(#crp8)"> <g clip-path="url(#crp9)"> <path d="m75.2 12.2h14.1v18.2h-14.1z" /> </g> </g> <g clip-path="url(#crp10)"> <g clip-path="url(#crp11)"> <path d="m91.5 12.2h20.2v18.2h-20.2z" /> </g> </g> <g clip-path="url(#crp12)"> <g clip-path="url(#crp13)"> <path d="m115.5 6.1h15.8v24.3h-15.8z" /> </g> </g> <g clip-path="url(#crp14)"> <g clip-path="url(#crp15)"> <path d="m135 12.2h20.1v18.2h-20.1z" /> </g> </g> <g clip-path="url(#crp16)"> <g clip-path="url(#crp17)"> <path d="m159.9 6.1h25.6v24.3h-25.6z" /> </g> </g> <g clip-path="url(#crp18)"> <g clip-path="url(#crp19)"> <path d="m190.4 6.1h27v24.4h-27z" /> </g> </g> </g> </svg> </a> <nav class="w-nav-menu main-nav" role="navigation"> <noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-WHMDSK" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript> <ul id="menu-main-navigation" class="menu"> <li class="menu-item menu-item-type-post_type menu-item-object-page menu-item-has-children navlink w-nav-link"> <a class="menu-link" href="javascript:;">Product</a> <ul class="sub-menu"> <li class="menu-item menu-item-type-post_type menu-item-object-page menu-item-has-children navlink w-nav-link"> <a class="menu-link" href="javascript:;">Database</a> <ul class="sub-menu"> <li class="menu-item menu-item-type-post_type menu-item-object-page navlink w-nav-link"> <a class="menu-link" href="https://cratedb.com/database">Overview</a> </li> <li class="menu-item menu-item-type-post_type menu-item-object-page navlink w-nav-link"> <a class="menu-link" href="https://cratedb.com/database/sql-examples">SQL examples</a> </li> <li class="menu-item menu-item-type-post_type menu-item-object-page navlink w-nav-link"> <a class="menu-link" href="https://cratedb.com/database/integrations">Integrations</a> </li> <li class="menu-item menu-item-type-post_type menu-item-object-page navlink w-nav-link"> <a class="menu-link" href="https://cratedb.com/database/security">Security</a> </li> </ul> </li> <li class="menu-item menu-item-type-post_type menu-item-object-page menu-item-has-children navlink w-nav-link"> <a class="menu-link" href="javascript:;">Data models</a> <ul class="sub-menu"> <li class="menu-item menu-item-type-post_type menu-item-object-page navlink w-nav-link"> <a class="menu-link" href="https://cratedb.com/data-model/time-series">Time-series</a> </li> <li class="menu-item menu-item-type-post_type menu-item-object-page navlink w-nav-link"> <a class="menu-link" href="https://cratedb.com/data-model/json">Document/JSON</a> </li> <li class="menu-item menu-item-type-post_type menu-item-object-page navlink w-nav-link"> <a class="menu-link" href="https://cratedb.com/data-model/vector">Vector</a> </li> <li class="menu-item menu-item-type-post_type menu-item-object-page navlink w-nav-link"> <a class="menu-link" href="https://cratedb.com/data-model/full-text">Full-text</a> </li> <li class="menu-item menu-item-type-post_type menu-item-object-page navlink w-nav-link"> <a class="menu-link" href="https://cratedb.com/data-model/geospatial">Spatial</a> </li> <li class="menu-item menu-item-type-post_type menu-item-object-page navlink w-nav-link"> <a class="menu-link" href="https://cratedb.com/data-model/relational">Relational</a> </li> </ul> </li> </ul> </li> <li class="menu-item menu-item-type-post_type menu-item-object-page menu-item-has-children navlink w-nav-link"> <a class="menu-link" href="javascript:;">Use cases</a> <ul class="sub-menu"> <li class="menu-item menu-item-type-post_type menu-item-object-page navlink w-nav-link"> <a class="menu-link" href="https://cratedb.com/use-cases/real-time-analytics-database">Real-time analytics</a> </li> <li class="menu-item menu-item-type-post_type menu-item-object-page navlink w-nav-link"> <a class="menu-link" href="https://cratedb.com/use-cases/hybrid-search">Hybrid search</a> </li> <li class="menu-item menu-item-type-post_type menu-item-object-page navlink w-nav-link"> <a class="menu-link" href="https://cratedb.com/use-cases/ai-ml-database">AI/ML integration</a> </li> <li class="menu-item menu-item-type-post_type menu-item-object-page navlink w-nav-link"> <a class="menu-link" href="https://cratedb.com/use-cases/chatbots">AI chatbots</a> </li> <li class="menu-item menu-item-type-post_type menu-item-object-page navlink w-nav-link"> <a class="menu-link" href="https://cratedb.com/use-cases/iot-database">Internet of Things</a> </li> <li class="menu-item menu-item-type-post_type menu-item-object-page navlink w-nav-link"> <a class="menu-link" href="https://cratedb.com/use-cases/geospatial-analytics">Geospatial analytics</a> </li> <li class="menu-item menu-item-type-post_type menu-item-object-page navlink w-nav-link"> <a class="menu-link" href="https://cratedb.com/use-cases/log-database">Log & event analysis</a> </li> </ul> </li> <li class="menu-item menu-item-type-post_type menu-item-object-page menu-item-has-children navlink w-nav-link"> <a class="menu-link" href="javascript:;">Industries</a> <ul class="sub-menu"> <li class="menu-item menu-item-type-post_type menu-item-object-page navlink w-nav-link"> <a class="menu-link" href="https://cratedb.com/industries/energy">Energy</a> </li> <li class="menu-item menu-item-type-post_type menu-item-object-page navlink w-nav-link"> <a class="menu-link" href="https://cratedb.com/industries/financial-services">Financial Services</a> </li> <li class="menu-item menu-item-type-post_type menu-item-object-page navlink w-nav-link"> <a class="menu-link" href="https://cratedb.com/industries/fmcg">FMCG</a> </li> <li class="menu-item menu-item-type-post_type menu-item-object-page navlink w-nav-link"> <a class="menu-link" href="https://cratedb.com/industries/logistics">Logistics</a> </li> <li class="menu-item menu-item-type-post_type menu-item-object-page navlink w-nav-link"> <a class="menu-link" href="https://cratedb.com/industries/manufacturing">Manufacturing</a> </li> <li class="menu-item menu-item-type-post_type menu-item-object-page navlink w-nav-link"> <a class="menu-link" href="https://cratedb.com/industries/oil-gas-mining">Oil, gas & mining</a> </li> <li class="menu-item menu-item-type-post_type menu-item-object-page navlink w-nav-link"> <a class="menu-link" href="https://cratedb.com/industries/smart-cities">Smart city solutions</a> </li> <li class="menu-item menu-item-type-post_type menu-item-object-page navlink w-nav-link"> <a class="menu-link" href="https://cratedb.com/industries/tech-platforms">Technology platforms</a> </li> <li class="menu-item menu-item-type-post_type menu-item-object-page navlink w-nav-link"> <a class="menu-link" href="https://cratedb.com/industries/telco">Telco</a> </li> <li class="menu-item menu-item-type-post_type menu-item-object-page navlink w-nav-link"> <a class="menu-link" href="https://cratedb.com/industries/transportation">Transportation</a> </li> </ul> </li> <li class="menu-item menu-item-type-post_type menu-item-object-page menu-item-has-children navlink w-nav-link"> <a class="menu-link" href="javascript:;">Resources</a> <ul class="sub-menu"> <li class="menu-item menu-item-type-post_type menu-item-object-page navlink w-nav-link"> <a class="menu-link" href="https://cratedb.com/stories">Customer stories</a> </li> <li class="menu-item menu-item-type-post_type menu-item-object-page navlink w-nav-link"> <a class="menu-link" href="https://cratedb.com/academy">Academy</a> </li> <li class="menu-item menu-item-type-post_type menu-item-object-page navlink w-nav-link"> <a class="menu-link" href="https://cratedb.com/library">Asset library</a> </li> <li class="menu-item menu-item-type-post_type menu-item-object-page navlink w-nav-link"> <a class="menu-link" href="https://cratedb.com/blog">Blog</a> </li> <li class="menu-item menu-item-type-post_type menu-item-object-page navlink w-nav-link"> <a class="menu-link" href="https://cratedb.com/event">Events</a> </li> </ul> </li> <li class="menu-item menu-item-type-post_type menu-item-object-page menu-item-has-children navlink w-nav-link"> <a class="menu-link" href="javascript:;">Developer</a> <ul class="sub-menu"> <li class="menu-item menu-item-type-post_type menu-item-object-page navlink w-nav-link"> <a class="menu-link" href="/docs/guide/home/">Documentation</a> </li> <li class="menu-item menu-item-type-post_type menu-item-object-page navlink w-nav-link"> <a class="menu-link" href="https://cratedb.com/database/drivers-tools">Drivers and tools</a> </li> <li class="menu-item menu-item-type-post_type menu-item-object-page navlink w-nav-link"> <a class="menu-link" href="https://cratedb.com/community">Community</a> </li> <li class="menu-item menu-item-type-post_type menu-item-object-page navlink w-nav-link"> <a class="menu-link" href="https://github.com/crate/crate/" target="_blank" rel="noopener">GitHub</a> </li> <li class="menu-item menu-item-type-post_type menu-item-object-page navlink w-nav-link"> <a class="menu-link" href="https://cratedb.com/support">Support</a> </li> </ul> </li> <li class="menu-item menu-item-type-post_type menu-item-object-page navlink w-nav-link"> <a class="menu-link" href="https://cratedb.com/pricing">Pricing</a> </li> <li class="menu-item menu-item-type-post_type menu-item-object-page navlink w-nav-link"> <a class="menu-link" target="_blank" rel="noreferrer" href="https://console.cratedb.cloud/?utm_source=website&utm_medium=mainnav&utm_campaign=cratedbcloud">Login</a> </li> <li class="nav-highlight cr-menu-btn menu-item navlink w-nav-link"> <a class="menu-link" href="https://cratedb.com/product/get-started/">Get Started</a> </li> </ul> </nav> </div> </div> </div> </header> <input type="checkbox" class="sb-sidebar-toggle" name="sb-sidebar-toggle--primary" id="sb-sidebar-toggle--primary"> <input type="checkbox" class="sb-sidebar-toggle" name="sb-sidebar-toggle--secondary" id="sb-sidebar-toggle--secondary"> <label class="sb-sidebar-overlay" for="sb-sidebar-toggle--primary"></label> <label class="sb-sidebar-overlay" for="sb-sidebar-toggle--secondary"></label> <div class="sb-container"> <div class="sb-container__inner sb-page-width"> <aside class="sb-sidebar-primary"> <div class="sidebar-drawer"> <div class="sidebar-container"> <div class="sidebar-sticky">   <div role="complementary" class="bs-docs-sidebar hidden-print"> <nav class="bs-docs-sidenav bs-sidenav nav" role="complementary"> <ul class="toctree nav nav-list">  <li> <div class="search-link"> <div id="docsearch" style="min-height: 36px; margin-bottom: 20px;"></div> </div> </li>  <li class="navleft-item current"><a class="current-active" href="/docs/guide/home/">Docs Home</a></li>  <li class="navleft-item"><a href="/docs/cloud/">CrateDB Cloud</a></li> <li class="navleft-item"><a href="/docs/guide/">Guides and Tutorials</a></li> <li class="navleft-item"><a href="/docs/crate/reference/">Reference Manual</a></li>  <li class="navleft-item border-top"><a href="/docs/crate/admin-ui/">Admin UI</a></li> <li class="navleft-item"><a href="/docs/crate/crash/">CrateDB CLI</a></li> <li class="navleft-item"><a href="/docs/cloud/cli/">Cloud CLI</a></li> <li class="navleft-item"> <a href="/docs/crate/clients-tools/">Drivers and Integrations</a> </li>  <li class="navleft-item border-top"><a target="_blank" href="/support/">Support</a></li> <li class="navleft-item"><a target="_blank" href="https://community.cratedb.com/">Community</a></li> <li class="navleft-item"><a target="_blank" href="https://community.cratedb.com/t/overview-of-cratedb-integration-tutorials/1015">Integration Tutorials</a></li> <li class="navleft-item"><a target="_blank" href="https://github.com/crate/crate-sample-apps">Sample Applications</a></li> <li class="navleft-item"><a target="_blank" href="https://learn.cratedb.com">Academy</a></li>  </ul> <ul class="toctree"> <li></li> </ul> </nav> </div> </div> </div> </div> </aside> <main class="sb-main"> <header class="sb-header-content"> <div class="sb-header-content__inner"> <div class="container-header"> <header class="mobile-header"> <div class="header-center"> <a class="brand w-nav-brand" href="/" title="cratedb.com"> <svg version="1.2" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 218 36" width="218" height="36" alt="CrateDB Logo" class="cr-cratedb-logo"> <defs> <clipPath clipPathUnits="userSpaceOnUse" id="cp1"> <path d="m1.49 3.63h7.31v7.31h-7.31z" /> </clipPath> <clipPath clipPathUnits="userSpaceOnUse" id="cp2"> <path d="m1.49 14.6h18.28v7.31h-18.28z" /> </clipPath> <clipPath clipPathUnits="userSpaceOnUse" id="cp3"> <path d="m12.46 3.63h7.31v7.31h-7.31z" /> </clipPath> <clipPath clipPathUnits="userSpaceOnUse" id="cp4"> <path d="m1.49 25.57h29.25v7.31h-29.25z" /> </clipPath> <clipPath clipPathUnits="userSpaceOnUse" id="cp5"> <path d="m23.43 3.63h7.31v18.28h-7.31z" /> </clipPath> <clipPath clipPathUnits="userSpaceOnUse" id="cp6"> <path d="m45.37 6.07h24.45v24.46h-24.45z" /> </clipPath> <clipPath clipPathUnits="userSpaceOnUse" id="cp7"> <path d="m45.37 12.16v12.19c0 1.62 0.64 3.17 1.78 4.31 1.15 1.14 2.7 1.78 4.31 1.78h18.29v-4.87h-19.5v-14.63h19.5v-4.87h-18.29c-1.61 0-3.16 0.64-4.31 1.78-1.14 1.14-1.78 2.69-1.78 4.31z" /> </clipPath> <clipPath clipPathUnits="userSpaceOnUse" id="cp8"> <path d="m75.23 12.15h14.06v18.38h-14.06z" /> </clipPath> <clipPath clipPathUnits="userSpaceOnUse" id="cp9"> <path d="m80.08 15.21h-0.58l-0.61-3.05h-3.66v18.28h4.88v-11.58c0-0.64 0.26-1.26 0.71-1.72 0.46-0.46 1.08-0.71 1.73-0.71h6.7v-4.27h-6.09q-0.61-0.01-1.18 0.22-0.57 0.23-1 0.66-0.43 0.43-0.67 0.99-0.23 0.57-0.23 1.18z" /> </clipPath> <clipPath clipPathUnits="userSpaceOnUse" id="cp10"> <path d="m91.51 12.15h20.15v18.38h-20.15z" /> </clipPath> <clipPath clipPathUnits="userSpaceOnUse" id="cp11"> <path d="m108.58 12.52q0.9 0.36 1.6 1.05 0.69 0.69 1.07 1.59 0.38 0.9 0.38 1.88v13.4h-3.66l-0.61-2.43h-0.61c0 0.64-0.25 1.26-0.71 1.72-0.46 0.46-1.08 0.71-1.73 0.71h-7.02q-1.11 0.05-2.16-0.34-1.05-0.39-1.87-1.15-0.81-0.77-1.27-1.79-0.46-1.02-0.48-2.14c0.03-1.42 0.62-2.76 1.64-3.74 1.02-0.99 2.39-1.53 3.8-1.5h9.75v-3.66h-12.79v-3.96h12.78q0.98-0.01 1.89 0.36zm-3.72 14.27c0.49 0 0.96-0.2 1.3-0.54 0.34-0.34 0.54-0.81 0.54-1.29v-1.83h-8.83c-0.49 0-0.95 0.19-1.3 0.54-0.34 0.34-0.53 0.8-0.53 1.29 0 0.48 0.19 0.94 0.53 1.29 0.34 0.34 0.8 0.53 1.29 0.54h7z" /> </clipPath> <clipPath clipPathUnits="userSpaceOnUse" id="cp12"> <path d="m115.46 6.07h15.93v24.46h-15.93z" /> </clipPath> <clipPath clipPathUnits="userSpaceOnUse" id="cp13"> <path d="m125.21 6.07h-4.88v6.09h-4.87v4.27h4.87v8.53c0.05 1.48 0.67 2.88 1.75 3.91 1.07 1.02 2.5 1.58 3.98 1.55h5.24v-4.24h-6.09v-9.75h6.09v-4.27h-6.09z" /> </clipPath> <clipPath clipPathUnits="userSpaceOnUse" id="cp14"> <path d="m134.96 12.16h20.15v18.37h-20.15z" /> </clipPath> <clipPath clipPathUnits="userSpaceOnUse" id="cp15"> <path d="m153.29 13.95c1.14 1.14 1.78 2.69 1.78 4.3v4.88h-15.23v3.35h14.01v3.96h-12.8c-1.61 0-3.16-0.64-4.31-1.78-1.14-1.14-1.78-2.69-1.78-4.31v-6.1c0-1.61 0.64-3.16 1.78-4.3 1.15-1.15 2.7-1.79 4.31-1.79h7.93c1.61 0 3.16 0.64 4.31 1.79zm-2.47 5.83v-1.84c-0.01-0.48-0.2-0.95-0.54-1.29-0.35-0.34-0.81-0.53-1.29-0.53h-7.32c-0.48 0-0.94 0.2-1.29 0.54-0.34 0.34-0.53 0.81-0.53 1.29v1.83z" /> </clipPath> <clipPath clipPathUnits="userSpaceOnUse" id="cp16"> <path d="m159.95 6.07h25.58v24.46h-25.58z" /> </clipPath> <clipPath clipPathUnits="userSpaceOnUse" id="cp17"> <path d="m183.04 8.56c1.61 1.61 2.5 3.78 2.5 6.04v7.31c0 2.26-0.9 4.43-2.5 6.03-1.59 1.61-3.77 2.5-6.03 2.5h-17.06v-24.37h17.06c2.26 0 4.43 0.89 6.03 2.49zm-2.37 6.04c0-0.97-0.38-1.9-1.07-2.59-0.69-0.68-1.62-1.07-2.59-1.07h-12.19v14.63h12.19c0.97 0 1.9-0.39 2.59-1.07 0.68-0.69 1.07-1.62 1.07-2.59v-7.31z" /> </clipPath> <clipPath clipPathUnits="userSpaceOnUse" id="cp18"> <path d="m190.42 6.13h26.82v24.4h-26.82z" /> </clipPath> <clipPath clipPathUnits="userSpaceOnUse" id="cp19"> <path d="m216.99 21.36c0.37 1.44 0.29 2.97-0.22 4.37-0.52 1.4-1.45 2.6-2.68 3.46-1.22 0.85-2.68 1.31-4.17 1.32h-19.5v-24.38h18.28c1.34 0 2.65 0.37 3.8 1.06 1.14 0.7 2.07 1.7 2.69 2.88 0.61 1.19 0.89 2.53 0.8 3.86-0.09 1.34-0.55 2.62-1.31 3.72 1.13 0.97 1.93 2.26 2.31 3.71zm-21.69-5.54h13.4c0.65 0 1.27-0.26 1.73-0.72 0.46-0.45 0.71-1.07 0.71-1.72 0-0.65-0.26-1.27-0.71-1.72-0.46-0.46-1.08-0.72-1.73-0.72h-13.4zm16.34 8.83c0.44-0.5 0.68-1.15 0.68-1.82 0-0.67-0.24-1.32-0.68-1.82-0.44-0.51-1.05-0.83-1.72-0.92h-14.62v5.48h14.62c0.67-0.09 1.28-0.41 1.72-0.92z" /> </clipPath> </defs> <style> .a { fill: #19c0ea } </style> <g clip-path="url(#cp1)"> <path class="a" d="m1.5 3.6h7.3v7.3h-7.3z" /> </g> <g clip-path="url(#cp2)"> <path class="a" d="m1.5 14.6h18.3v7.3h-18.3z" /> </g> <g clip-path="url(#cp3)"> <path class="a" d="m12.5 3.6h7.2v7.3h-7.2z" /> </g> <g clip-path="url(#cp4)"> <path class="a" d="m1.5 25.6h29.3v7.2h-29.3z" /> </g> <g clip-path="url(#cp5)"> <path class="a" d="m23.4 3.6h7.3v18.3h-7.3z" /> </g> <g class="cratedb"> <g clip-path="url(#cp6)"> <g clip-path="url(#cp7)"> <path d="m45.4 6.1h24.3v24.3h-24.3z" /> </g> </g> <g clip-path="url(#cp8)"> <g clip-path="url(#cp9)"> <path d="m75.2 12.2h14.1v18.2h-14.1z" /> </g> </g> <g clip-path="url(#cp10)"> <g clip-path="url(#cp11)"> <path d="m91.5 12.2h20.2v18.2h-20.2z" /> </g> </g> <g clip-path="url(#cp12)"> <g clip-path="url(#cp13)"> <path d="m115.5 6.1h15.8v24.3h-15.8z" /> </g> </g> <g clip-path="url(#cp14)"> <g clip-path="url(#cp15)"> <path d="m135 12.2h20.1v18.2h-20.1z" /> </g> </g> <g clip-path="url(#cp16)"> <g clip-path="url(#cp17)"> <path d="m159.9 6.1h25.6v24.3h-25.6z" /> </g> </g> <g clip-path="url(#cp18)"> <g clip-path="url(#cp19)"> <path d="m190.4 6.1h27v24.4h-27z" /> </g> </g> </g> </svg> </a> </div> </header> </div> </div> </header> <div class="sb-content"> <div class="sb-article-container container-fluid"> <header class="sb-header-article"> <div class="sidebar-container-primary"> <label for="sb-sidebar-toggle--primary" class="hide-when-primary-sidebar-shown" role="button"> <i class="icon" title="Toggle site navigation sidebar"><svg><use href="#svg-menu"></use></svg></i> </label> </div> <div class="sidebar-container-secondary"> <label for="sb-sidebar-toggle--secondary" class="hide-when-secondary-sidebar-shown" role="button"> <i class="icon" title="Toggle table of contents sidebar"><svg><use href="#svg-toc"></use></svg></i> </label> </div> </header> <article class="sb-article" role="main" id="main-content"> <style> /* Cards with links */ .sd-hide-link-text { height: 0; } </style> <section id="cratedb-documentation"> <h1>CrateDB Documentation<a class="headerlink" href="#cratedb-documentation" title="Permalink to this heading">¶</a></h1> <p>Welcome to the official CrateDB Documentation. Whether you are a developer, database administrator, or just starting your journey with CrateDB, our documentation provides the information and knowledge needed to build real-time analytics and hybrid search applications that leverage CrateDB’s unique features.</p> <p class="rubric">Benefits</p> <ul class="simple"> <li><p>In a unified data platform approach, CrateDB includes analyzing relational, JSON, time-series, geospatial, full-text, and vector data within a single system, eliminating the need for multiple databases.</p></li> <li><p>The fully distributed SQL query engine, built on top of Apache Lucene, and inheriting technologies from Elasticsearch/OpenSearch, provides performant aggregations and advanced SQL features like JOINs and CTEs on large datasets of semi-structured data.</p></li> <li><p>Real-time indexing automatically indexes all columns, including nested structures, as data is ingested, eliminating the need to worry about indexing strategy.</p></li> <li><p>The flexible data schema dynamically adapts based on the data you ingest, offering seamless integration and instant readiness for analysis.</p></li> <li><p>Columnar storage enables fast search query and aggregation performance.</p></li> <li><p>PostgreSQL wire protocol compatibility and a HTTP interface provide versatile integration capabilities.</p></li> <li><p>AI-ready: The vector store subsystem integrates well with an extensive 3rd party ecosystem of AI/ML frameworks for advanced data analysis and data-driven decisions.</p></li> </ul> <div class="sd-container-fluid sd-sphinx-override sd-m-1 sd-p-2 docutils"> <div class="sd-row sd-row-cols-1 sd-row-cols-xs-1 sd-row-cols-sm-1 sd-row-cols-md-1 sd-row-cols-lg-1 docutils"> <div class="sd-col sd-d-flex-row sd-p-2 docutils"> <div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm sd-card-hover docutils"> <div class="sd-card-body docutils"> <div class="sd-card-title sd-font-weight-bold sd-fs-5 docutils"> <svg version="4.0.0.63c5cb3" width="1.7em" height="1.7em" class="sd-material-icon sd-material-icon-rocket_launch" viewBox="0 0 24 24" aria-hidden="true"><g><rect fill="none" height="24" width="24"></rect></g><g><g><path d="M6,15c-0.83,0-1.58,0.34-2.12,0.88C2.7,17.06,2,22,2,22s4.94-0.7,6.12-1.88C8.66,19.58,9,18.83,9,18C9,16.34,7.66,15,6,15 z M6.71,18.71c-0.28,0.28-2.17,0.76-2.17,0.76s0.47-1.88,0.76-2.17C5.47,17.11,5.72,17,6,17c0.55,0,1,0.45,1,1 C7,18.28,6.89,18.53,6.71,18.71z M17.42,13.65L17.42,13.65c6.36-6.36,4.24-11.31,4.24-11.31s-4.95-2.12-11.31,4.24l-2.49-0.5 C7.21,5.95,6.53,6.16,6.05,6.63L2,10.69l5,2.14L11.17,17l2.14,5l4.05-4.05c0.47-0.47,0.68-1.15,0.55-1.81L17.42,13.65z M7.41,10.83L5.5,10.01l1.97-1.97l1.44,0.29C8.34,9.16,7.83,10.03,7.41,10.83z M13.99,18.5l-0.82-1.91 c0.8-0.42,1.67-0.93,2.49-1.5l0.29,1.44L13.99,18.5z M16,12.24c-1.32,1.32-3.38,2.4-4.04,2.73l-2.93-2.93 c0.32-0.65,1.4-2.71,2.73-4.04c4.68-4.68,8.23-3.99,8.23-3.99S20.68,7.56,16,12.24z M15,11c1.1,0,2-0.9,2-2s-0.9-2-2-2s-2,0.9-2,2 S13.9,11,15,11z"></path></g></g></svg> CrateDB Cloud</div> <p class="sd-card-text">Start with a fully managed CrateDB instance to accelerate and simplify working with analytical data. CrateDB Cloud enables seamless deployment, monitoring, backups, and scaling of CrateDB clusters on AWS, Azure or GCPs, eliminating the need for direct database management.</p> <p class="sd-card-text">With CrateDB Cloud, you can skip infrastructure setup and focus on delivering value for your business with a query console, SQL Scheduler, table policies and various connectors to import data.</p> </div> <div class="sd-card-footer docutils"> <p class="sd-card-text"><span class="sd-d-grid"><a class="sd-sphinx-override sd-btn sd-text-wrap sd-btn-primary reference external" href="https://cratedb.com/docs/cloud/tutorials/quick-start.html"><span><strong>Start forever free cluster with 8 GB of storage</strong></span></a></span></p> </div> <a class="sd-stretched-link sd-hide-link-text reference external" href="https://cratedb.com/docs/cloud/en/latest/index.html#cloud-docs-index" title="(in CrateDB Cloud vlatest)"><span>CrateDB Cloud</span></a></div> </div> <div class="sd-col sd-d-flex-column sd-m-0 sd-p-2 docutils"> <div class="sd-container-fluid sd-sphinx-override sd-m-0 sd-p-0 docutils"> <div class="sd-row sd-row-cols-2 sd-row-cols-xs-2 sd-row-cols-sm-2 sd-row-cols-md-2 sd-row-cols-lg-2 docutils"> <div class="sd-col sd-d-flex-row docutils"> <div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm sd-card-hover docutils"> <div class="sd-card-body docutils"> <div class="sd-card-title sd-font-weight-bold sd-fs-5 docutils"> <svg version="4.0.0.63c5cb3" width="1.7em" height="1.7em" class="sd-material-icon sd-material-icon-lightbulb" viewBox="0 0 24 24" aria-hidden="true"><path d="M0 0h24v24H0z" fill="none"></path><path d="M9 21c0 .55.45 1 1 1h4c.55 0 1-.45 1-1v-1H9v1zm3-19C8.14 2 5 5.14 5 9c0 2.38 1.19 4.47 3 5.74V17c0 .55.45 1 1 1h6c.55 0 1-.45 1-1v-2.26c1.81-1.27 3-3.36 3-5.74 0-3.86-3.14-7-7-7zm2.85 11.1l-.85.6V16h-4v-2.3l-.85-.6C7.8 12.16 7 10.63 7 9c0-2.76 2.24-5 5-5s5 2.24 5 5c0 1.63-.8 3.16-2.15 4.1z"></path></svg> Database Features</div> <p class="sd-card-text">Explore all functional, operational and advanced features of CrateDB at a glance.</p> </div> <a class="sd-stretched-link sd-hide-link-text reference external" href="https://cratedb.com/docs/guide/feature/"><span>Database Features</span></a></div> </div> <div class="sd-col sd-d-flex-row docutils"> <div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm sd-card-hover docutils"> <div class="sd-card-body docutils"> <div class="sd-card-title sd-font-weight-bold sd-fs-5 docutils"> <svg version="4.0.0.63c5cb3" width="1.7em" height="1.7em" class="sd-material-icon sd-material-icon-auto_stories" viewBox="0 0 24 24" aria-hidden="true"><g><rect fill="none" height="24" width="24" x="0"></rect></g><g><path d="M22.47,5.2C22,4.96,21.51,4.76,21,4.59v12.03C19.86,16.21,18.69,16,17.5,16c-1.9,0-3.78,0.54-5.5,1.58V5.48 C10.38,4.55,8.51,4,6.5,4C4.71,4,3.02,4.44,1.53,5.2C1.2,5.36,1,5.71,1,6.08v12.08c0,0.58,0.47,0.99,1,0.99 c0.16,0,0.32-0.04,0.48-0.12C3.69,18.4,5.05,18,6.5,18c2.07,0,3.98,0.82,5.5,2c1.52-1.18,3.43-2,5.5-2c1.45,0,2.81,0.4,4.02,1.04 c0.16,0.08,0.32,0.12,0.48,0.12c0.52,0,1-0.41,1-0.99V6.08C23,5.71,22.8,5.36,22.47,5.2z M10,16.62C8.86,16.21,7.69,16,6.5,16 c-1.19,0-2.36,0.21-3.5,0.62V6.71C4.11,6.24,5.28,6,6.5,6C7.7,6,8.89,6.25,10,6.72V16.62z M19,0.5l-5,5V15l5-4.5V0.5z"></path></g></svg> Database Manual</div> <p class="sd-card-text">Learn core CrateDB concepts, including data modeling, querying data, aggregations, sharding, and more.</p> </div> <a class="sd-stretched-link sd-hide-link-text reference external" href="https://cratedb.com/docs/reference/"><span>Database Manual</span></a></div> </div> </div> </div> </div> <div class="sd-col sd-d-flex-row sd-p-2 docutils"> <div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm sd-card-hover docutils"> <div class="sd-card-body docutils"> <div class="sd-card-title sd-font-weight-bold sd-fs-5 docutils"> <svg version="4.0.0.63c5cb3" width="1.7em" height="1.7em" class="sd-material-icon sd-material-icon-link" viewBox="0 0 24 24" aria-hidden="true"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M17 7h-4v2h4c1.65 0 3 1.35 3 3s-1.35 3-3 3h-4v2h4c2.76 0 5-2.24 5-5s-2.24-5-5-5zm-6 8H7c-1.65 0-3-1.35-3-3s1.35-3 3-3h4V7H7c-2.76 0-5 2.24-5 5s2.24 5 5 5h4v-2zm-3-4h8v2H8z"></path></svg> Client Libraries</div> <p class="sd-card-text">Learn how to connect your applications using database drivers, libraries, adapters, and connectors.</p> <p class="sd-card-text">CrateDB supports both the <a class="reference external" href="https://en.wikipedia.org/wiki/HTTP">HTTP protocol</a> and the <a class="reference external" href="https://www.postgresql.org/docs/current/protocol.html">PostgreSQL wire protocol</a>, ensuring compatibility with many PostgreSQL clients.</p> <p class="sd-card-text">Through corresponding drivers and adapters, CrateDB is compatible with <a class="reference external" href="https://en.wikipedia.org/wiki/Open_Database_Connectivity">ODBC</a>, <a class="reference external" href="https://en.wikipedia.org/wiki/Java_Database_Connectivity">JDBC</a>, and other database API specifications.</p> </div> <a class="sd-stretched-link sd-hide-link-text reference external" href="https://cratedb.com/docs/crate/clients-tools/en/latest/connect/"><span>CrateDB: Client Drivers and Libraries</span></a></div> </div> </div> </div> <section id="learn"> <h2>Learn<a class="headerlink" href="#learn" title="Permalink to this heading">¶</a></h2> <p class="rubric">Videos</p> <div class="sd-card sd-sphinx-override sd-mb-3 sd-shadow-sm docutils"> <div class="sd-card-body sd-text-center docutils"> <div class="sd-card-title sd-font-weight-bold sd-fs-4 docutils"> Today’s data challenges and a high level overview of CrateDB</div> <div class="video_wrapper" style=""> <iframe allowfullscreen="true" src="https://www.youtube.com/embed/cByAOsaYddQ" style="border: 0; height: 345px; width: 560px"> </iframe></div></div> <div class="sd-card-footer sd-fs-6 docutils"> <p class="sd-card-text"><em>Webinar: Turbocharge your aggregations, search & AI models & get real-time insights.</em></p> <div class="text-smaller docutils"> <p class="sd-card-text">Discover CrateDB, the leading real-time analytics database. It provides the flexibility, speed, and scalability necessary to master today’s data challenges. Watch this video to learn how CrateDB empowers you with real-time insights into your data to fuel advanced analytics, search, and AI models—enabling informed decisions that drive meaningful impact.</p> </div> </div> </div> <div class="sd-card sd-sphinx-override sd-mb-3 sd-shadow-sm docutils"> <div class="sd-card-body docutils"> <div class="sd-card-title sd-font-weight-bold docutils"> CrateDB Videos curated by Simon Prickett</div> <p class="sd-card-text">Simon leads Developer Relations at CrateDB. Here, he is <a class="reference external" href="https://www.youtube.com/playlist?list=PL3cZtICBssphXl5rHgsgG9vTNAVTw_Veq">sharing a playlist of videos</a> he has been part of that will show you what CrateDB is and how you can use it for a variety of projects. Make sure you also do not miss relevant <a class="reference external" href="https://www.youtube.com/playlist?list=PLDZqzXOGoWUJrAF_lVx9U6BzAGG9xYz_v">CrateDB customer stories</a>.</p> </div> </div> <p class="rubric">Introduction</p> <p>Learn about the fundamentals of CrateDB, guided and self-guided.</p> <div class="sd-container-fluid sd-sphinx-override sd-mb-4 sd-p-0 docutils"> <div class="sd-row sd-row-cols-2 sd-row-cols-xs-2 sd-row-cols-sm-2 sd-row-cols-md-4 sd-row-cols-lg-4 docutils"> <div class="sd-col sd-d-flex-row sd-p-3 docutils"> <div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm sd-card-hover docutils"> <div class="sd-card-header sd-text-center sd-fs-5 sd-align-minor-center sd-font-weight-bold sd-text-capitalize docutils"> <p class="sd-card-text">Getting Started</p> </div> <div class="sd-card-body sd-text-center sd-fs-5 docutils"> <p class="sd-card-text"><svg version="4.0.0.63c5cb3" width="3.5em" height="3.5em" class="sd-material-icon sd-material-icon-not_started" viewBox="0 0 24 24" aria-hidden="true"><g><rect fill="none" height="24" width="24"></rect><path d="M12,4c4.41,0,8,3.59,8,8s-3.59,8-8,8s-8-3.59-8-8S7.59,4,12,4 M12,2C6.48,2,2,6.48,2,12c0,5.52,4.48,10,10,10 s10-4.48,10-10C22,6.48,17.52,2,12,2L12,2z M11,8H9v8h2V8z M17,12l-5-4v8L17,12z"></path></g></svg></p> </div> <div class="sd-card-footer text-smaller docutils"> <p class="sd-card-text">Learn how to interact with the database for the first time.</p> </div> <a class="sd-stretched-link sd-hide-link-text reference external" href="https://cratedb.com/docs/guide/getting-started.html"><span>Getting started with CrateDB</span></a></div> </div> <div class="sd-col sd-d-flex-row sd-p-3 docutils"> <div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm sd-card-hover docutils"> <div class="sd-card-header sd-text-center sd-fs-5 sd-align-minor-center sd-font-weight-bold sd-text-capitalize docutils"> <p class="sd-card-text">The CrateDB Guide</p> </div> <div class="sd-card-body sd-text-center sd-fs-5 docutils"> <p class="sd-card-text"><svg version="4.0.0.63c5cb3" width="3.5em" height="3.5em" class="sd-material-icon sd-material-icon-hiking" viewBox="0 0 24 24" aria-hidden="true"><rect fill="none" height="24" width="24"></rect><path d="M13.5,5.5c1.1,0,2-0.9,2-2s-0.9-2-2-2s-2,0.9-2,2S12.4,5.5,13.5,5.5z M17.5,10.78c-1.23-0.37-2.22-1.17-2.8-2.18l-1-1.6 c-0.41-0.65-1.11-1-1.84-1c-0.78,0-1.59,0.5-1.78,1.44S7,23,7,23h2.1l1.8-8l2.1,2v6h2v-7.5l-2.1-2l0.6-3c1,1.15,2.41,2.01,4,2.34V23 H19V9h-1.5L17.5,10.78z M7.43,13.13l-2.12-0.41c-0.54-0.11-0.9-0.63-0.79-1.17l0.76-3.93c0.21-1.08,1.26-1.79,2.34-1.58l1.16,0.23 L7.43,13.13z"></path></svg></p> </div> <div class="sd-card-footer text-smaller docutils"> <p class="sd-card-text">Guides and tutorials about how to use CrateDB in practice.</p> </div> <a class="sd-stretched-link sd-hide-link-text reference external" href="https://cratedb.com/docs/guide/"><span>The CrateDB Guide</span></a></div> </div> <div class="sd-col sd-d-flex-row sd-p-3 docutils"> <div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm sd-card-hover docutils"> <div class="sd-card-header sd-text-center sd-fs-5 sd-align-minor-center sd-font-weight-bold sd-text-capitalize docutils"> <p class="sd-card-text">Academy Courses</p> </div> <div class="sd-card-body sd-text-center sd-fs-5 docutils"> <p class="sd-card-text"><svg version="4.0.0.63c5cb3" width="3.5em" height="3.5em" class="sd-material-icon sd-material-icon-school" viewBox="0 0 24 24" aria-hidden="true"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M12 3L1 9l4 2.18v6L12 21l7-3.82v-6l2-1.09V17h2V9L12 3zm6.82 6L12 12.72 5.18 9 12 5.28 18.82 9zM17 15.99l-5 2.73-5-2.73v-3.72L12 15l5-2.73v3.72z"></path></svg></p> </div> <div class="sd-card-footer text-smaller docutils"> <p class="sd-card-text">A learning hub dedicated to data enthusiasts.</p> </div> <a class="sd-stretched-link sd-hide-link-text reference external" href="https://learn.cratedb.com/"><span>The CrateDB Academy</span></a></div> </div> <div class="sd-col sd-d-flex-row sd-p-3 docutils"> <div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm sd-card-hover docutils"> <div class="sd-card-header sd-text-center sd-fs-5 sd-align-minor-center sd-font-weight-bold sd-text-capitalize docutils"> <p class="sd-card-text">Community Portal</p> </div> <div class="sd-card-body sd-text-center sd-fs-5 docutils"> <p class="sd-card-text"><svg version="4.0.0.63c5cb3" width="3.5em" height="3.5em" class="sd-material-icon sd-material-icon-groups" viewBox="0 0 24 24" aria-hidden="true"><rect fill="none" height="24" width="24"></rect><g><path d="M4,13c1.1,0,2-0.9,2-2c0-1.1-0.9-2-2-2s-2,0.9-2,2C2,12.1,2.9,13,4,13z M5.13,14.1C4.76,14.04,4.39,14,4,14 c-0.99,0-1.93,0.21-2.78,0.58C0.48,14.9,0,15.62,0,16.43V18l4.5,0v-1.61C4.5,15.56,4.73,14.78,5.13,14.1z M20,13c1.1,0,2-0.9,2-2 c0-1.1-0.9-2-2-2s-2,0.9-2,2C18,12.1,18.9,13,20,13z M24,16.43c0-0.81-0.48-1.53-1.22-1.85C21.93,14.21,20.99,14,20,14 c-0.39,0-0.76,0.04-1.13,0.1c0.4,0.68,0.63,1.46,0.63,2.29V18l4.5,0V16.43z M16.24,13.65c-1.17-0.52-2.61-0.9-4.24-0.9 c-1.63,0-3.07,0.39-4.24,0.9C6.68,14.13,6,15.21,6,16.39V18h12v-1.61C18,15.21,17.32,14.13,16.24,13.65z M8.07,16 c0.09-0.23,0.13-0.39,0.91-0.69c0.97-0.38,1.99-0.56,3.02-0.56s2.05,0.18,3.02,0.56c0.77,0.3,0.81,0.46,0.91,0.69H8.07z M12,8 c0.55,0,1,0.45,1,1s-0.45,1-1,1s-1-0.45-1-1S11.45,8,12,8 M12,6c-1.66,0-3,1.34-3,3c0,1.66,1.34,3,3,3s3-1.34,3-3 C15,7.34,13.66,6,12,6L12,6z"></path></g></svg></p> </div> <div class="sd-card-footer text-smaller docutils"> <p class="sd-card-text">A hangout place for members of the CrateDB community.</p> </div> <a class="sd-stretched-link sd-hide-link-text reference external" href="https://community.cratedb.com/"><span>The CrateDB Community Portal</span></a></div> </div> </div> </div> <p class="rubric">Admin Tools</p> <p>Learn about the fundamental tools that support working directly with CrateDB.</p> <div class="sd-container-fluid sd-sphinx-override sd-mb-4 sd-p-0 docutils"> <div class="sd-row sd-row-cols-2 sd-row-cols-xs-2 sd-row-cols-sm-3 sd-row-cols-md-3 sd-row-cols-lg-3 docutils"> <div class="sd-col sd-d-flex-row sd-p-3 docutils"> <div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm sd-card-hover sd-pt-3 docutils"> <div class="sd-card-body sd-text-center docutils"> <div class="sd-card-title sd-font-weight-bold sd-fs-5 docutils"> Admin UI</div> <p class="sd-card-text"><svg version="4.0.0.63c5cb3" width="3.5em" height="3.5em" class="sd-material-icon sd-material-icon-admin_panel_settings" viewBox="0 0 24 24" aria-hidden="true"><g><rect fill="none" height="24" width="24"></rect></g><g><g><circle cx="17" cy="15.5" fill-rule="evenodd" r="1.12"></circle><path d="M17,17.5c-0.73,0-2.19,0.36-2.24,1.08c0.5,0.71,1.32,1.17,2.24,1.17 s1.74-0.46,2.24-1.17C19.19,17.86,17.73,17.5,17,17.5z" fill-rule="evenodd"></path><path d="M18,11.09V6.27L10.5,3L3,6.27v4.91c0,4.54,3.2,8.79,7.5,9.82 c0.55-0.13,1.08-0.32,1.6-0.55C13.18,21.99,14.97,23,17,23c3.31,0,6-2.69,6-6C23,14.03,20.84,11.57,18,11.09z M11,17 c0,0.56,0.08,1.11,0.23,1.62c-0.24,0.11-0.48,0.22-0.73,0.3c-3.17-1-5.5-4.24-5.5-7.74v-3.6l5.5-2.4l5.5,2.4v3.51 C13.16,11.57,11,14.03,11,17z M17,21c-2.21,0-4-1.79-4-4c0-2.21,1.79-4,4-4s4,1.79,4,4C21,19.21,19.21,21,17,21z" fill-rule="evenodd"></path></g></g></svg></p> </div> <div class="sd-card-footer text-smaller docutils"> <p class="sd-card-text">Learn about CrateDB’s included web administration interface.</p> </div> <a class="sd-stretched-link sd-hide-link-text reference external" href="https://cratedb.com/docs/crate/admin-ui/"><span>The CrateDB Admin UI</span></a></div> </div> <div class="sd-col sd-d-flex-row sd-p-3 docutils"> <div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm sd-card-hover sd-pt-3 docutils"> <div class="sd-card-body sd-text-center docutils"> <div class="sd-card-title sd-font-weight-bold sd-fs-5 docutils"> Crash CLI</div> <p class="sd-card-text"><svg version="4.0.0.63c5cb3" width="3.5em" height="3.5em" class="sd-material-icon sd-material-icon-terminal" viewBox="0 0 24 24" aria-hidden="true"><g><rect fill="none" height="24" width="24"></rect></g><g><path d="M20,4H4C2.89,4,2,4.9,2,6v12c0,1.1,0.89,2,2,2h16c1.1,0,2-0.9,2-2V6C22,4.9,21.11,4,20,4z M20,18H4V8h16V18z M18,17h-6v-2 h6V17z M7.5,17l-1.41-1.41L8.67,13l-2.59-2.59L7.5,9l4,4L7.5,17z"></path></g></svg></p> </div> <div class="sd-card-footer text-smaller docutils"> <p class="sd-card-text">A command-line interface (CLI) tool for working with CrateDB.</p> </div> <a class="sd-stretched-link sd-hide-link-text reference external" href="https://cratedb.com/docs/crate/crash/"><span>The Crash CLI</span></a></div> </div> </div> </div> <p class="rubric">Drivers and Integrations</p> <p>Learn about database client libraries, drivers, adapters, connectors, and integrations with 3rd-party applications and frameworks.</p> <div class="sd-container-fluid sd-sphinx-override sd-mb-4 sd-p-0 docutils"> <div class="sd-row sd-row-cols-2 sd-row-cols-xs-2 sd-row-cols-sm-3 sd-row-cols-md-3 sd-row-cols-lg-3 docutils"> <div class="sd-col sd-d-flex-row sd-p-3 docutils"> <div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm sd-card-hover sd-pt-3 docutils"> <div class="sd-card-body sd-text-center docutils"> <div class="sd-card-title sd-font-weight-bold sd-fs-5 docutils"> Ecosystem Catalog</div> <p class="sd-card-text"><svg version="4.0.0.63c5cb3" width="3.5em" height="3.5em" class="sd-material-icon sd-material-icon-category" viewBox="0 0 24 24" aria-hidden="true"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M12 2l-5.5 9h11L12 2zm0 3.84L13.93 9h-3.87L12 5.84zM17.5 13c-2.49 0-4.5 2.01-4.5 4.5s2.01 4.5 4.5 4.5 4.5-2.01 4.5-4.5-2.01-4.5-4.5-4.5zm0 7c-1.38 0-2.5-1.12-2.5-2.5s1.12-2.5 2.5-2.5 2.5 1.12 2.5 2.5-1.12 2.5-2.5 2.5zM3 21.5h8v-8H3v8zm2-6h4v4H5v-4z"></path></svg></p> </div> <div class="sd-card-footer text-smaller docutils"> <p class="sd-card-text">Discover integrations and solutions from the open-source community and CrateDB partners.</p> </div> <a class="sd-stretched-link sd-hide-link-text reference external" href="https://cratedb.com/docs/crate/clients-tools/en/latest/index.html#catalog" title="(in CrateDB: Clients and Tools vlatest)"><span>Ecosystem Catalog</span></a></div> </div> <div class="sd-col sd-d-flex-row sd-p-3 docutils"> <div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm sd-card-hover sd-pt-3 docutils"> <div class="sd-card-body sd-text-center docutils"> <div class="sd-card-title sd-font-weight-bold sd-fs-5 docutils"> Integration Tutorials I</div> <p class="sd-card-text"><svg version="4.0.0.63c5cb3" width="3.5em" height="3.5em" class="sd-material-icon sd-material-icon-integration_instructions" viewBox="0 0 24 24" aria-hidden="true"><g><rect fill="none" height="24" width="24"></rect><circle cx="12" cy="3.5" fill="none" r=".75"></circle><circle cx="12" cy="3.5" fill="none" r=".75"></circle><polygon fill="none" points="5,15 5,16 5,19 19,19 19,16 19,15 19,5 5,5"></polygon><g><polygon points="11,14.17 8.83,12 11,9.83 9.59,8.41 6,12 9.59,15.59"></polygon><polygon points="14.41,15.59 18,12 14.41,8.41 13,9.83 15.17,12 13,14.17"></polygon><path d="M19,3h-4.18C14.4,1.84,13.3,1,12,1S9.6,1.84,9.18,3H5C4.86,3,4.73,3.01,4.6,3.04C4.21,3.12,3.86,3.32,3.59,3.59 c-0.18,0.18-0.33,0.4-0.43,0.64C3.06,4.46,3,4.72,3,5v10v1v3c0,0.27,0.06,0.54,0.16,0.78c0.1,0.24,0.25,0.45,0.43,0.64 c0.27,0.27,0.62,0.47,1.01,0.55C4.73,20.99,4.86,21,5,21h14c1.1,0,2-0.9,2-2v-3v-1V5C21,3.9,20.1,3,19,3z M12,2.75 c0.41,0,0.75,0.34,0.75,0.75S12.41,4.25,12,4.25s-0.75-0.34-0.75-0.75S11.59,2.75,12,2.75z M19,15v1v3H5v-3v-1V5h14V15z"></path></g></g></svg></p> </div> <div class="sd-card-footer text-smaller docutils"> <p class="sd-card-text">Learn about the variety of options to connect and integrate with 3rd-party applications.</p> </div> <a class="sd-stretched-link sd-hide-link-text reference internal" href="../integrate/index.html#integrate"><span class="std std-ref">Integration Tutorials I</span></a></div> </div> <div class="sd-col sd-d-flex-row sd-p-3 docutils"> <div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm sd-card-hover sd-pt-3 docutils"> <div class="sd-card-body sd-text-center docutils"> <div class="sd-card-title sd-font-weight-bold sd-fs-5 docutils"> Integration Tutorials II</div> <p class="sd-card-text"><svg version="4.0.0.63c5cb3" width="3.5em" height="3.5em" class="sd-material-icon sd-material-icon-local_library" viewBox="0 0 24 24" aria-hidden="true"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M12 9c2.21 0 4-1.79 4-4s-1.79-4-4-4-4 1.79-4 4 1.79 4 4 4zm0-6c1.1 0 2 .9 2 2s-.9 2-2 2-2-.9-2-2 .9-2 2-2zm0 8.55C9.64 9.35 6.48 8 3 8v11c3.48 0 6.64 1.35 9 3.55 2.36-2.19 5.52-3.55 9-3.55V8c-3.48 0-6.64 1.35-9 3.55zm7 5.58c-2.53.34-4.93 1.3-7 2.82-2.06-1.52-4.47-2.49-7-2.83v-6.95c2.1.38 4.05 1.35 5.64 2.83L12 14.28l1.36-1.27c1.59-1.48 3.54-2.45 5.64-2.83v6.95z"></path></svg></p> </div> <div class="sd-card-footer text-smaller docutils"> <p class="sd-card-text">Integration-focused tutorials to help you use CrateDB together with other tools and libraries.</p> </div> <a class="sd-stretched-link sd-hide-link-text reference external" href="https://community.cratedb.com/t/overview-of-cratedb-integration-tutorials/1015"><span>Integration Tutorials II</span></a></div> </div> </div> </div> </section> <section id="examples"> <h2>Examples<a class="headerlink" href="#examples" title="Permalink to this heading">¶</a></h2> <p>Learn how to use CrateDB by digesting concise examples.</p> <div class="sd-container-fluid sd-sphinx-override sd-mb-4 sd-p-0 docutils"> <div class="sd-row sd-row-cols-2 sd-row-cols-xs-2 sd-row-cols-sm-3 sd-row-cols-md-3 sd-row-cols-lg-3 docutils"> <div class="sd-col sd-d-flex-row sd-p-3 docutils"> <div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm sd-card-hover sd-pt-3 docutils"> <div class="sd-card-body sd-text-center docutils"> <div class="sd-card-title sd-font-weight-bold sd-fs-5 docutils"> CrateDB Examples</div> <p class="sd-card-text"><svg version="4.0.0.63c5cb3" width="3.5em" height="3.5em" class="sd-material-icon sd-material-icon-play_circle" viewBox="0 0 24 24" aria-hidden="true"><g><rect fill="none" height="24" width="24"></rect></g><g><path d="M12,2C6.48,2,2,6.48,2,12s4.48,10,10,10s10-4.48,10-10S17.52,2,12,2z M12,20c-4.41,0-8-3.59-8-8s3.59-8,8-8s8,3.59,8,8 S16.41,20,12,20z M9.5,16.5l7-4.5l-7-4.5V16.5z"></path></g></svg></p> </div> <div class="sd-card-footer text-smaller docutils"> <p class="sd-card-text">A collection of clear and concise examples how to work with CrateDB.</p> </div> <a class="sd-stretched-link sd-hide-link-text reference external" href="https://github.com/crate/cratedb-examples"><span>CrateDB Examples</span></a></div> </div> <div class="sd-col sd-d-flex-row sd-p-3 docutils"> <div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm sd-card-hover sd-pt-3 docutils"> <div class="sd-card-body sd-text-center docutils"> <div class="sd-card-title sd-font-weight-bold sd-fs-5 docutils"> Sample Apps</div> <p class="sd-card-text"><svg version="4.0.0.63c5cb3" width="3.5em" height="3.5em" class="sd-material-icon sd-material-icon-apps" viewBox="0 0 24 24" aria-hidden="true"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M4 8h4V4H4v4zm6 12h4v-4h-4v4zm-6 0h4v-4H4v4zm0-6h4v-4H4v4zm6 0h4v-4h-4v4zm6-10v4h4V4h-4zm-6 4h4V4h-4v4zm6 6h4v-4h-4v4zm0 6h4v-4h-4v4z"></path></svg></p> </div> <div class="sd-card-footer text-smaller docutils"> <p class="sd-card-text">Different client libraries used by canonical guestbook demo web applications.</p> </div> <a class="sd-stretched-link sd-hide-link-text reference external" href="https://github.com/crate/crate-sample-apps/"><span>CrateDB Sample Apps</span></a></div> </div> </div> </div> <br> <hr class="docutils" /> <p><strong>Resources:</strong> <a class="reference external" href="https://learn.cratedb.com/">Academy</a> • <a class="reference external" href="https://cratedb.com/blog">Blog</a> • <a class="reference external" href="https://community.cratedb.com/">Community</a> • <a class="reference external" href="https://cratedb.com/customers">Customers</a> • <a class="reference external" href="https://github.com/crate/cratedb-examples">Examples</a> • <a class="reference external" href="https://github.com/crate">GitHub</a> • <a class="reference external" href="https://cratedb.com/docs/guide/">Guide</a> • <a class="reference external" href="https://cratedb.com/support/">Support</a></p> </section> </section> </article> <footer class="sb-footer-article"> <div class="related-pages"> </div> </footer> </div> <aside class="sb-sidebar-secondary"> <div class="toc-drawer"> <div class="toc-sticky toc-scroll"> <div class="page-tools dropdown-group">  <div class="feedback-compact-container"> <details class="sd-sphinx-override sd-dropdown sd-card sd-mb-0 sd-fade-in feedback-compact-content">  <summary class="sd-summary-title sd-card-header"> <span class="fa fa-gear fa-fw"></span> <span class="feedback-compact-title">  Feedback</span> <span class="sd-summary-state-marker sd-summary-chevron-right"> <svg version="1.1" width="1.5em" height="1.5em" class="sd-octicon sd-octicon-chevron-right" viewBox="0 0 24 24" aria-hidden="true"> <path d="M8.72 18.78a.75.75 0 0 1 0-1.06L14.44 12 8.72 6.28a.751.751 0 0 1 .018-1.042.751.751 0 0 1 1.042-.018l6.25 6.25a.75.75 0 0 1 0 1.06l-6.25 6.25a.75.75 0 0 1-1.06 0Z"></path> </svg> </span> </summary> <div class="sd-summary-content sd-card-body docutils"> <p class="sd-card-text"> <span class="fab fa-github fa-fw"></span>   <a id="docs-feedback-open-issue" rel="noopener" class="feedback-compact-link" href="https://github.com/crate/cratedb-guide/issues/new?title=Documentation%20feedback%20on%20/docs/home/index.md&labels=team:%20tech%20writing,triage&body=%23%23%23%20Documentation%20feedback%0A%0A%3C%21--%20Please%20do%20not%20edit%20or%20remove%20the%20following%20information%20--%3E%0A %0A- Page title: CrateDB%20Documentation%0A- Page URL: https%3A//cratedb.com/docs/guide/home/index.html%0A-%20Source%3A%20https%3A//github.com/crate/cratedb-guide/blob/main/docs/home/index.md%0A%0A---%0A%0A%3C%21--%20Please%20add%20your%20comments%20here%20--%3E%0A%0A" target="_blank" title="Suggest improvement">Suggest improvement</a> </p> <p class="sd-card-text"> <span class="fa fa-edit fa-fw"></span>   <a id="docs-feedback-edit-document" class="feedback-compact-link" href="https://github.com/crate/cratedb-guide/edit/main/docs/home/index.md" rel="noopener" target="_blank" title="Edit on GitHub">Edit page</a> </p> <p class="sd-card-text"> <span class="fa fa-code fa-fw"></span>   <a id="docs-feedback-open-github" class="feedback-compact-link" href="https://github.com/crate/cratedb-guide/blob/main/docs/home/index.md?plain=1" rel="noopener" target="_blank" title="View page source on GitHub">View page source</a> </p> </div> </details> </div> <script> /** * Keyboard navigation for GitHub. CTRL+G will navigate to * the edit page on GitHub for the corresponding document. **/ document.addEventListener('keydown', (event) => { if (event.key === 'g' && event.ctrlKey) { location.href = "https://github.com/crate/cratedb-guide/edit/main/docs/home/index.md"; } }); </script> <div class="theme-toggle-container theme-toggle-header"> <button class="theme-toggle"> <div class="visually-hidden">Toggle Light / Dark color theme</div> <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg> <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg> </button> </div> </div> <div class="toc-title-container"> <span class="toc-title"> On this page </span> </div> <div class="toc-tree-container"> <div class="toc-tree"> <ul> <li><a class="reference internal" href="#">CrateDB Documentation</a><ul> <li><a class="reference internal" href="#learn">Learn</a></li> <li><a class="reference internal" href="#examples">Examples</a></li> </ul> </li> </ul> </div> </div> </div> </div> </aside> </div> </main> </div> </div> <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=b3ba4146"></script> <script src="../_static/doctools.js?v=888ff710"></script> <script src="../_static/sphinx_highlight.js?v=4825356b"></script> <script src="../_static/clipboard.min.js?v=a7894cd8"></script> <script src="../_static/copybutton.js?v=54a48adb"></script> <script> </script> <script src="../_static/tabs.js?v=3ee01567"></script> <script>let toggleHintShow = 'Click to show';</script> <script>let toggleHintHide = 'Click to hide';</script> <script>let toggleOpenOnPrint = 'true';</script> <script src="../_static/togglebutton.js?v=4a39c7ea"></script> <script src="../_static/design-tabs.js?v=f930bc37"></script> <script src="../_static/design-elements.bbdccc18c4abea9397628f9fea3d48c2.js?v=03c7770e"></script> <script>var togglebuttonSelector = '.toggle, .admonition.dropdown';</script> <footer class="sb-footer"> <div class="footer-subscription cr-nojs-hide"> <div class="content-wrapper container"> <div class="row"> <div class="col-md-3"> <h4>Subscribe to the CrateDB Newsletter now</h4> </div> <div class="col-md-9"> <div class="footer-subs-form">  <script charset="utf-8" type="text/javascript" src="//js.hsforms.net/forms/v2.js"></script> <script> hbspt.forms.create({ region: "na1", portalId: "19927462", formId: "76d1441f-eef8-4e8e-950d-9b66bf24bd8e" }); </script> </div> </div> </div> </div> </div> <div class="sb-footer__inner sb-page-width"> <div class="footer"> <div class="container-fluid"> <div class="w-clearfix"> <div class="w-row mobileAlign"> <div class="row"> <div class="col-md-4 text-md-center"> <a class="w-inline-block" href="/" title="cratedb.com"> <svg version="1.2" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 218 36" width="218" height="36" alt="CrateDB Logo" loading="lazy" class="cr-cratedb-logo"> <defs> <clipPath clipPathUnits="userSpaceOnUse" id="cfp1"> <path d="m1.49 3.63h7.31v7.31h-7.31z" /> </clipPath> <clipPath clipPathUnits="userSpaceOnUse" id="cfp2"> <path d="m1.49 14.6h18.28v7.31h-18.28z" /> </clipPath> <clipPath clipPathUnits="userSpaceOnUse" id="cfp3"> <path d="m12.46 3.63h7.31v7.31h-7.31z" /> </clipPath> <clipPath clipPathUnits="userSpaceOnUse" id="cfp4"> <path d="m1.49 25.57h29.25v7.31h-29.25z" /> </clipPath> <clipPath clipPathUnits="userSpaceOnUse" id="cfp5"> <path d="m23.43 3.63h7.31v18.28h-7.31z" /> </clipPath> <clipPath clipPathUnits="userSpaceOnUse" id="cfp6"> <path d="m45.37 6.07h24.45v24.46h-24.45z" /> </clipPath> <clipPath clipPathUnits="userSpaceOnUse" id="cfp7"> <path d="m45.37 12.16v12.19c0 1.62 0.64 3.17 1.78 4.31 1.15 1.14 2.7 1.78 4.31 1.78h18.29v-4.87h-19.5v-14.63h19.5v-4.87h-18.29c-1.61 0-3.16 0.64-4.31 1.78-1.14 1.14-1.78 2.69-1.78 4.31z" /> </clipPath> <clipPath clipPathUnits="userSpaceOnUse" id="cfp8"> <path d="m75.23 12.15h14.06v18.38h-14.06z" /> </clipPath> <clipPath clipPathUnits="userSpaceOnUse" id="cfp9"> <path d="m80.08 15.21h-0.58l-0.61-3.05h-3.66v18.28h4.88v-11.58c0-0.64 0.26-1.26 0.71-1.72 0.46-0.46 1.08-0.71 1.73-0.71h6.7v-4.27h-6.09q-0.61-0.01-1.18 0.22-0.57 0.23-1 0.66-0.43 0.43-0.67 0.99-0.23 0.57-0.23 1.18z" /> </clipPath> <clipPath clipPathUnits="userSpaceOnUse" id="cfp10"> <path d="m91.51 12.15h20.15v18.38h-20.15z" /> </clipPath> <clipPath clipPathUnits="userSpaceOnUse" id="cfp11"> <path d="m108.58 12.52q0.9 0.36 1.6 1.05 0.69 0.69 1.07 1.59 0.38 0.9 0.38 1.88v13.4h-3.66l-0.61-2.43h-0.61c0 0.64-0.25 1.26-0.71 1.72-0.46 0.46-1.08 0.71-1.73 0.71h-7.02q-1.11 0.05-2.16-0.34-1.05-0.39-1.87-1.15-0.81-0.77-1.27-1.79-0.46-1.02-0.48-2.14c0.03-1.42 0.62-2.76 1.64-3.74 1.02-0.99 2.39-1.53 3.8-1.5h9.75v-3.66h-12.79v-3.96h12.78q0.98-0.01 1.89 0.36zm-3.72 14.27c0.49 0 0.96-0.2 1.3-0.54 0.34-0.34 0.54-0.81 0.54-1.29v-1.83h-8.83c-0.49 0-0.95 0.19-1.3 0.54-0.34 0.34-0.53 0.8-0.53 1.29 0 0.48 0.19 0.94 0.53 1.29 0.34 0.34 0.8 0.53 1.29 0.54h7z" /> </clipPath> <clipPath clipPathUnits="userSpaceOnUse" id="cfp12"> <path d="m115.46 6.07h15.93v24.46h-15.93z" /> </clipPath> <clipPath clipPathUnits="userSpaceOnUse" id="cfp13"> <path d="m125.21 6.07h-4.88v6.09h-4.87v4.27h4.87v8.53c0.05 1.48 0.67 2.88 1.75 3.91 1.07 1.02 2.5 1.58 3.98 1.55h5.24v-4.24h-6.09v-9.75h6.09v-4.27h-6.09z" /> </clipPath> <clipPath clipPathUnits="userSpaceOnUse" id="cfp14"> <path d="m134.96 12.16h20.15v18.37h-20.15z" /> </clipPath> <clipPath clipPathUnits="userSpaceOnUse" id="cfp15"> <path d="m153.29 13.95c1.14 1.14 1.78 2.69 1.78 4.3v4.88h-15.23v3.35h14.01v3.96h-12.8c-1.61 0-3.16-0.64-4.31-1.78-1.14-1.14-1.78-2.69-1.78-4.31v-6.1c0-1.61 0.64-3.16 1.78-4.3 1.15-1.15 2.7-1.79 4.31-1.79h7.93c1.61 0 3.16 0.64 4.31 1.79zm-2.47 5.83v-1.84c-0.01-0.48-0.2-0.95-0.54-1.29-0.35-0.34-0.81-0.53-1.29-0.53h-7.32c-0.48 0-0.94 0.2-1.29 0.54-0.34 0.34-0.53 0.81-0.53 1.29v1.83z" /> </clipPath> <clipPath clipPathUnits="userSpaceOnUse" id="cfp16"> <path d="m159.95 6.07h25.58v24.46h-25.58z" /> </clipPath> <clipPath clipPathUnits="userSpaceOnUse" id="cfp17"> <path d="m183.04 8.56c1.61 1.61 2.5 3.78 2.5 6.04v7.31c0 2.26-0.9 4.43-2.5 6.03-1.59 1.61-3.77 2.5-6.03 2.5h-17.06v-24.37h17.06c2.26 0 4.43 0.89 6.03 2.49zm-2.37 6.04c0-0.97-0.38-1.9-1.07-2.59-0.69-0.68-1.62-1.07-2.59-1.07h-12.19v14.63h12.19c0.97 0 1.9-0.39 2.59-1.07 0.68-0.69 1.07-1.62 1.07-2.59v-7.31z" /> </clipPath> <clipPath clipPathUnits="userSpaceOnUse" id="cfp18"> <path d="m190.42 6.13h26.82v24.4h-26.82z" /> </clipPath> <clipPath clipPathUnits="userSpaceOnUse" id="cfp19"> <path d="m216.99 21.36c0.37 1.44 0.29 2.97-0.22 4.37-0.52 1.4-1.45 2.6-2.68 3.46-1.22 0.85-2.68 1.31-4.17 1.32h-19.5v-24.38h18.28c1.34 0 2.65 0.37 3.8 1.06 1.14 0.7 2.07 1.7 2.69 2.88 0.61 1.19 0.89 2.53 0.8 3.86-0.09 1.34-0.55 2.62-1.31 3.72 1.13 0.97 1.93 2.26 2.31 3.71zm-21.69-5.54h13.4c0.65 0 1.27-0.26 1.73-0.72 0.46-0.45 0.71-1.07 0.71-1.72 0-0.65-0.26-1.27-0.71-1.72-0.46-0.46-1.08-0.72-1.73-0.72h-13.4zm16.34 8.83c0.44-0.5 0.68-1.15 0.68-1.82 0-0.67-0.24-1.32-0.68-1.82-0.44-0.51-1.05-0.83-1.72-0.92h-14.62v5.48h14.62c0.67-0.09 1.28-0.41 1.72-0.92z" /> </clipPath> </defs> <style> .a { fill: #19c0ea } </style> <g clip-path="url(#cfp1)"> <path class="a" d="m1.5 3.6h7.3v7.3h-7.3z" /> </g> <g clip-path="url(#cfp2)"> <path class="a" d="m1.5 14.6h18.3v7.3h-18.3z" /> </g> <g clip-path="url(#cfp3)"> <path class="a" d="m12.5 3.6h7.2v7.3h-7.2z" /> </g> <g clip-path="url(#cfp4)"> <path class="a" d="m1.5 25.6h29.3v7.2h-29.3z" /> </g> <g clip-path="url(#cfp5)"> <path class="a" d="m23.4 3.6h7.3v18.3h-7.3z" /> </g> <g class="cratedb"> <g clip-path="url(#cfp6)"> <g clip-path="url(#cfp7)"> <path d="m45.4 6.1h24.3v24.3h-24.3z" /> </g> </g> <g clip-path="url(#cfp8)"> <g clip-path="url(#cfp9)"> <path d="m75.2 12.2h14.1v18.2h-14.1z" /> </g> </g> <g clip-path="url(#cfp10)"> <g clip-path="url(#cfp11)"> <path d="m91.5 12.2h20.2v18.2h-20.2z" /> </g> </g> <g clip-path="url(#cfp12)"> <g clip-path="url(#cfp13)"> <path d="m115.5 6.1h15.8v24.3h-15.8z" /> </g> </g> <g clip-path="url(#cfp14)"> <g clip-path="url(#cfp15)"> <path d="m135 12.2h20.1v18.2h-20.1z" /> </g> </g> <g clip-path="url(#cfp16)"> <g clip-path="url(#cfp17)"> <path d="m159.9 6.1h25.6v24.3h-25.6z" /> </g> </g> <g clip-path="url(#cfp18)"> <g clip-path="url(#cfp19)"> <path d="m190.4 6.1h27v24.4h-27z" /> </g> </g> </g> </svg> </a> </div> <div class="col-md-4 text-md-center"> <div class="cr-docs-footer-menu"> <ul> <li> <a href="/legal/imprint">Imprint</a> </li> <li> <a href="/contact">Contact</a> </li> <li> <a href="/legal/">Legal</a> </li> </ul> </div> </div> <div class="col-md-4 text-md-center cr-docs-align-right"> <div class="cr-docs-footer-social"> <div class="social-label">Follow us</div> <div class="cr-docs-social-icons"> <a class="social-links__link" href="https://twitter.com/cratedb" target="_blank" rel="noopener"> <span id="hs_cos_wrapper_footer_social_" class="hs_cos_wrapper hs_cos_wrapper_widget hs_cos_wrapper_type_icon social-links__icon"><svg version="1.0" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512" aria-labelledby="twitter1" role="img"><title id="twitter1">Follow us on X</title><g id="X Twitter1_layer"><path d="M389.2 48h70.6L305.6 224.2 487 464H345L233.7 318.6 106.5 464H35.8L200.7 275.5 26.8 48H172.4L272.9 180.9 389.2 48zM364.4 421.8h39.1L151.1 88h-42L364.4 421.8z"></path></g></svg></span> </a> <a class="social-links__link" href="https://www.linkedin.com/company/crateio/" target="_blank" rel="noopener"> <span id="hs_cos_wrapper_footer_social__2" class="hs_cos_wrapper hs_cos_wrapper_widget hs_cos_wrapper_type_icon social-links__icon"><svg version="1.0" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512" aria-labelledby="linkedin-in2" role="img"><title id="linkedin-in2">Follow us on LinkedIn</title><g id="linkedin-in2_layer"><path d="M100.3 480H7.4V180.9h92.9V480zM53.8 140.1C24.1 140.1 0 115.5 0 85.8 0 56.1 24.1 32 53.8 32c29.7 0 53.8 24.1 53.8 53.8 0 29.7-24.1 54.3-53.8 54.3zM448 480h-92.7V334.4c0-34.7-.7-79.2-48.3-79.2-48.3 0-55.7 37.7-55.7 76.7V480h-92.8V180.9h89.1v40.8h1.3c12.4-23.5 42.7-48.3 87.9-48.3 94 0 111.3 61.9 111.3 142.3V480z"></path></g></svg></span> </a> <a class="social-links__link" href="https://www.facebook.com/crate.io/" target="_blank" rel="noopener"> <span id="hs_cos_wrapper_footer_social__3" class="hs_cos_wrapper hs_cos_wrapper_widget hs_cos_wrapper_type_icon social-links__icon"><svg version="1.0" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 264 512" aria-labelledby="facebook-f3" role="img"><title id="facebook-f3">Follow us on Facebook</title><g id="facebook-f3_layer"><path d="M76.7 512V283H0v-91h76.7v-71.7C76.7 42.4 124.3 0 193.8 0c33.3 0 61.9 2.5 70.2 3.6V85h-48.2c-37.8 0-45.1 18-45.1 44.3V192H256l-11.7 91h-73.6v229"></path></g></svg></span> </a> <a class="social-links__link" href="https://www.youtube.com/user/CrateIO" target="_blank" rel="noopener"> <span id="hs_cos_wrapper_footer_social__4" class="hs_cos_wrapper hs_cos_wrapper_widget hs_cos_wrapper_type_icon social-links__icon"><svg version="1.0" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 576 512" aria-labelledby="youtube4" role="img"><title id="youtube4">Follow us on Instagram</title><g id="youtube4_layer"><path d="M549.655 124.083c-6.281-23.65-24.787-42.276-48.284-48.597C458.781 64 288 64 288 64S117.22 64 74.629 75.486c-23.497 6.322-42.003 24.947-48.284 48.597-11.412 42.867-11.412 132.305-11.412 132.305s0 89.438 11.412 132.305c6.281 23.65 24.787 41.5 48.284 47.821C117.22 448 288 448 288 448s170.78 0 213.371-11.486c23.497-6.321 42.003-24.171 48.284-47.821 11.412-42.867 11.412-132.305 11.412-132.305s0-89.438-11.412-132.305zm-317.51 213.508V175.185l142.739 81.205-142.739 81.201z"></path></g></svg></span> </a> <a class="social-links__link" href="https://github.com/crate/crate" target="_blank" rel="noopener"> <span id="hs_cos_wrapper_footer_social__5" class="hs_cos_wrapper hs_cos_wrapper_widget hs_cos_wrapper_type_icon social-links__icon"><svg version="1.0" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 496 512" aria-labelledby="github5" role="img"><title id="github5">Follow us on Facebook</title><g id="github5_layer"><path d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6zm-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3zm44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9zM244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8zM97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1zm-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7zm32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1zm-11.4-14.7c-1.6 1-1.6 3.6 0 5.9 1.6 2.3 4.3 3.3 5.6 2.3 1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2z"></path></g></svg></span> </a> </div> </div> </div> </div> </div> </div> </div> </div>  <script src="https://cdn.jsdelivr.net/npm/@docsearch/js@3"></script> <script type="text/javascript"> // Init DocSearch (from https://github.com/algolia/docsearch/issues/1368#issuecomment-1428085393) const appId = "AZ1NEV7CG0"; const apiKey = "84b128d95218b1eddb2d4b82d25291fe"; docsearch({ container: "#docsearch", appId, indexName: "cratedb", apiKey, resultsFooterComponent({ state }) { return { type: "a", ref: undefined, constructor: undefined, key: state.query, props: { href: `../search.html?q=${state.query}`, children: `See all ${state.context.nbHits} results` }, __v: null }; } }); // Also init Algolia InstantSearch, if available (for search results page) if (typeof algoliasearch != "undefined" && typeof instantsearch != "undefined") { const { algoliasearch, instantsearch } = window; const searchClient = algoliasearch(appId, apiKey); const indexName = "cratedb"; const search = instantsearch({ searchClient, indexName, routing: { stateMapping: { stateToRoute(uiState) { const indexUiState = uiState[indexName]; return { q: indexUiState.query, } }, routeToState({q}) { return { [indexName]: { query: q, }, }; }, }, } }); search.addWidgets([ instantsearch.widgets.searchBox({ container: '#searchbox', }), instantsearch.widgets.hits({ container: '#hits', templates: { item(hit, { html, components, sendEvent }) { return html` <div> <p class="ais-Heading"><a href="${hit.url}">${hit.hierarchy.lvl2 ? hit.hierarchy.lvl2 : hit.hierarchy.lvl1}</a></p> <p>${components.Highlight({ hit, attribute: 'content' })}</p> <p class="ais-Breadcrumbs">${hit.hierarchy.lvl0}: ${hit.hierarchy.lvl1} ${hit.hierarchy.lvl2 ? "> " + hit.hierarchy.lvl2 : ""}</p> </div> `; }, }, }), instantsearch.widgets.configure({ hitsPerPage: 8 }), instantsearch.widgets.pagination({ container: '#pagination', }), ]); search.start(); } </script>  <script type="text/javascript" id="hs-script-loader" async defer src="//js.hs-scripts.com/19927462.js"></script>  </div> </footer> </body> </html>

CINXE.COM

CrateDB Documentation - CrateDB: Guide