Tutorials and Examples | Geode Database

<h2 id="tutorials-and-examples" class="position-relative d-flex align-items-center group"> Tutorials and Examples <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="tutorials-and-examples" aria-haspopup="dialog" aria-label="Share link: Tutorials and Examples"> Share link </button> </h2><div id="headingShareModal" class="heading-share-modal" role="dialog" aria-modal="true" aria-labelledby="headingShareTitle" hidden> <div class="hsm-dialog" role="document"> <div class="hsm-header"> <h2 id="headingShareTitle" class="h6 mb-0 fw-bold">Share this section</h2> <button type="button" class="hsm-close" aria-label="Close"> </button> </div> <div class="hsm-body"> <label for="headingShareInput" class="form-label small text-muted mb-1 text-uppercase fw-bold" style="font-size: 0.7rem; letter-spacing: 0.5px;">Permalink</label> <div class="input-group mb-4 hsm-url-group"> <input id="headingShareInput" type="text" class="form-control font-monospace" readonly aria-readonly="true" style="font-size: 0.85rem;" /> <button class="btn btn-primary hsm-copy" type="button" aria-label="Copy" title="Copy"> </button> </div> <div class="small fw-bold mb-2 text-muted text-uppercase" style="font-size: 0.7rem; letter-spacing: 0.5px;">Share via</div> <div class="hsm-share-grid"> <a id="share-twitter" class="btn btn-outline-secondary w-100" target="_blank" rel="noopener noreferrer"> Twitter </a> <a id="share-linkedin" class="btn btn-outline-secondary w-100" target="_blank" rel="noopener noreferrer"> LinkedIn </a> <a id="share-facebook" class="btn btn-outline-secondary w-100" target="_blank" rel="noopener noreferrer"> Facebook </a> </div> </div> </div> </div> <style> .heading-share-modal { position: fixed; inset: 0; display: flex; justify-content: center; align-items: center; background: rgba(0, 0, 0, 0.6); z-index: 1050; padding: 1rem; backdrop-filter: blur(4px); -webkit-backdrop-filter: blur(4px); } .heading-share-modal[hidden] { display: none !important; } .hsm-dialog { max-width: 420px; width: 100%; background: var(--bs-body-bg, #fff); color: var(--bs-body-color, #212529); border: 1px solid var(--bs-border-color, rgba(0,0,0,0.1)); border-radius: 1rem; box-shadow: 0 25px 50px -12px rgba(0, 0, 0, 0.25); overflow: hidden; animation: hsm-fade-in 0.2s ease-out; } @keyframes hsm-fade-in { from { opacity: 0; transform: scale(0.95); } to { opacity: 1; transform: scale(1); } } [data-bs-theme="dark"] .hsm-dialog { background: #1e293b; border-color: rgba(255,255,255,0.1); color: #f8f9fa; } .hsm-header { display: flex; justify-content: space-between; align-items: center; padding: 1rem 1.5rem; border-bottom: 1px solid var(--bs-border-color, rgba(0,0,0,0.1)); background: rgba(0,0,0,0.02); } [data-bs-theme="dark"] .hsm-header { background: rgba(255,255,255,0.02); border-color: rgba(255,255,255,0.1); } .hsm-close { background: transparent; border: none; color: inherit; opacity: 0.5; padding: 0.25rem 0.5rem; border-radius: 0.25rem; font-size: 1.2rem; line-height: 1; transition: opacity 0.2s; } .hsm-close:hover { opacity: 1; } .hsm-body { padding: 1.5rem; } .hsm-url-group { display: flex !important; align-items: stretch; } .hsm-url-group .form-control { flex: 1; min-width: 0; margin: 0; background: var(--bs-secondary-bg, #f8f9fa); border-color: var(--bs-border-color, #dee2e6); border-top-right-radius: 0; border-bottom-right-radius: 0; height: 42px; } .hsm-url-group .btn { flex: 0 0 auto; margin: 0; margin-left: -1px; border-top-left-radius: 0; border-bottom-left-radius: 0; height: 42px; display: flex; align-items: center; justify-content: center; padding: 0 1.25rem; z-index: 2; } [data-bs-theme="dark"] .hsm-url-group .form-control { background: #0f172a; border-color: #334155; color: #e2e8f0; } .hsm-share-grid { display: flex; flex-direction: column; gap: 0.5rem; } .hsm-share-grid .btn { display: flex; align-items: center; justify-content: center; font-size: 0.9rem; padding: 0.6rem; border-color: var(--bs-border-color); width: 100%; } [data-bs-theme="dark"] .hsm-share-grid .btn { color: #e2e8f0; border-color: #475569; } [data-bs-theme="dark"] .hsm-share-grid .btn:hover { background: #334155; border-color: #cbd5e1; } </style> <script> (function(){ const modal = document.getElementById('headingShareModal'); if(!modal) return; const input = modal.querySelector('#headingShareInput'); const copyBtn = modal.querySelector('.hsm-copy'); const twitter = modal.querySelector('#share-twitter'); const linkedin = modal.querySelector('#share-linkedin'); const facebook = modal.querySelector('#share-facebook'); const closeBtn = modal.querySelector('.hsm-close'); let lastFocus=null; let trapBound=false; function buildUrl(id){ return window.location.origin + window.location.pathname + '#' + id; } function isOpen(){ return !modal.hasAttribute('hidden'); } function hydrate(id){ const url=buildUrl(id); input.value=url; const enc=encodeURIComponent(url); const text=encodeURIComponent(document.title); if(twitter) twitter.href=`https://twitter.com/intent/tweet?url=${enc}&text=${text}`; if(linkedin) linkedin.href=`https://www.linkedin.com/sharing/share-offsite/?url=${enc}`; if(facebook) facebook.href=`https://www.facebook.com/sharer/sharer.php?u=${enc}`; } function openModal(id){ lastFocus=document.activeElement; hydrate(id); if(!isOpen()){ modal.removeAttribute('hidden'); } requestAnimationFrame(()=>{ input.focus(); }); trapFocus(); } function closeModal(){ if(!isOpen()) return; modal.setAttribute('hidden',''); if(lastFocus && typeof lastFocus.focus==='function') lastFocus.focus(); } function copyCurrent(){ try{ navigator.clipboard.writeText(input.value).then(()=>feedback(true),()=>fallback()); } catch(e){ fallback(); } } function fallback(){ input.select(); try{ document.execCommand('copy'); feedback(true);}catch(e){ feedback(false);} } function feedback(ok){ if(!copyBtn) return; const icon=copyBtn.querySelector('i'); if(!icon) return; const prev=copyBtn.getAttribute('data-prev')||icon.className; if(!copyBtn.getAttribute('data-prev')) copyBtn.setAttribute('data-prev',prev); icon.className= ok ? 'fa-duotone fa-clipboard-check':'fa-duotone fa-circle-exclamation'; setTimeout(()=>{ icon.className=prev; },1800); } function handleShareClick(e){ e.preventDefault(); const btn=e.currentTarget; const id=btn.getAttribute('data-share-target'); if(id) openModal(id); } function bindShareButtons(){ document.querySelectorAll('.h-share').forEach(btn=>{ if(!btn.dataset.hShareBound){ btn.addEventListener('click', handleShareClick); btn.dataset.hShareBound='1'; } }); } bindShareButtons(); if(document.readyState==='loading'){ document.addEventListener('DOMContentLoaded', bindShareButtons); } else { requestAnimationFrame(bindShareButtons); } document.addEventListener('click', function(e){ const shareBtn=e.target.closest && e.target.closest('.h-share'); if(shareBtn && !shareBtn.dataset.hShareBound){ handleShareClick.call(shareBtn, e); } }, true); document.addEventListener('click', e=>{ if(e.target===modal) closeModal(); if(e.target.closest && e.target.closest('.hsm-close')){ e.preventDefault(); closeModal(); } if(copyBtn && (e.target===copyBtn || (e.target.closest && e.target.closest('.hsm-copy')))) { e.preventDefault(); copyCurrent(); } }); document.addEventListener('keydown', e=>{ if(e.key==='Escape' && isOpen()) closeModal(); }); function trapFocus(){ if(trapBound) return; trapBound=true; modal.addEventListener('keydown', f=>{ if(f.key==='Tab' && isOpen()){ const focusable=[...modal.querySelectorAll('a[href],button,input,textarea,select,[tabindex]:not([tabindex="-1"])')].filter(el=>!el.hasAttribute('disabled')); if(!focusable.length) return; const first=focusable[0]; const last=focusable[focusable.length-1]; if(f.shiftKey && document.activeElement===first){ f.preventDefault(); last.focus(); } else if(!f.shiftKey && document.activeElement===last){ f.preventDefault(); first.focus(); } } }); } if(closeBtn) closeBtn.addEventListener('click', e=>{ e.preventDefault(); closeModal(); }); })(); </script>Hands-on learning paths with executable examples and expected outputs. <h3 id="getting-started-tutorials" class="position-relative d-flex align-items-center group"> Getting Started Tutorials <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="getting-started-tutorials" aria-haspopup="dialog" aria-label="Share link: Getting Started Tutorials"> Share link </button> </h3> <h4 id="1-match-basics-10-minutes" class="position-relative d-flex align-items-center group"> 1. MATCH Basics (10 minutes) <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="1-match-basics-10-minutes" aria-haspopup="dialog" aria-label="Share link: 1. MATCH Basics (10 minutes)"> Share link </button> </h4>Learn fundamental pattern matching: Create sample data: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">CREATE GRAPH SocialNetwork; USE SocialNetwork; CREATE (:Person {name: "Alice", age: 30}), (:Person {name: "Bob", age: 25}), (:Person {name: "Charlie", age: 35}); MATCH (a:Person {name: "Alice"}), (b:Person {name: "Bob"}) CREATE (a)-[:KNOWS {since: 2020}]->(b); </code></pre></div>Basic queries: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Match all people MATCH (p:Person) RETURN p.name, p.age; -- Match with predicate MATCH (p:Person) WHERE p.age > 26 RETURN p.name; -- Match relationship MATCH (a:Person)-[k:KNOWS]->(b:Person) RETURN a.name, b.name, k.since; </code></pre></div>Expected output: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-fallback" data-lang="fallback">name | age ---------|---- Alice | 30 Bob | 25 Charlie | 35 </code></pre></div>See <a href="/docs/gql/guide" >GQL Guide</a> for complete syntax. <h4 id="2-indexing-and-query-optimization-15-minutes" class="position-relative d-flex align-items-center group"> 2. Indexing and Query Optimization (15 minutes) <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="2-indexing-and-query-optimization-15-minutes" aria-haspopup="dialog" aria-label="Share link: 2. Indexing and Query Optimization (15 minutes)"> Share link </button> </h4>Learn to create indexes and use EXPLAIN/PROFILE: Step 1: Identify slow query <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">PROFILE MATCH (p:Person) WHERE p.age > 25 RETURN p.name; </code></pre></div>Output shows <code>SeqScan</code> (sequential scan) → slow for large datasets. Step 2: Create index <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">CREATE INDEX person_age_idx ON Person(age) USING btree; </code></pre></div>Step 3: Verify index usage <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">EXPLAIN MATCH (p:Person) WHERE p.age > 25 RETURN p.name; </code></pre></div>Now shows <code>IndexScan [person_age_idx]</code> → fast! Step 4: Compare performance <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">PROFILE MATCH (p:Person) WHERE p.age > 25 RETURN p.name; </code></pre></div>See execution time improvement with indexes. See <a href="/docs/query/indexing-and-optimization" >Indexing and Optimization</a> for details. <h4 id="3-graph-algorithms-quickstart-20-minutes" class="position-relative d-flex align-items-center group"> 3. Graph Algorithms Quickstart (20 minutes) <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="3-graph-algorithms-quickstart-20-minutes" aria-haspopup="dialog" aria-label="Share link: 3. Graph Algorithms Quickstart (20 minutes)"> Share link </button> </h4>Run PageRank on social network: Setup: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Use social network from Tutorial 1 USE SocialNetwork; -- Add more connections MATCH (b:Person {name: "Bob"}), (c:Person {name: "Charlie"}) CREATE (b)-[:KNOWS]->(c); </code></pre></div>Run PageRank: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">CALL graph.pageRank('SocialNetwork', { relationship_type: 'KNOWS', iterations: 20 }) YIELD node, score RETURN node.name AS person, score ORDER BY score DESC; </code></pre></div>Expected output: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-fallback" data-lang="fallback">person | score ---------|------- Bob | 0.385 Charlie | 0.315 Alice | 0.300 </code></pre></div>Bob has highest PageRank (receives 2 connections). See <a href="/docs/analytics/graph-algorithms" >Graph Algorithms</a> for more algorithms. <h4 id="4-vector-similarity-search-25-minutes" class="position-relative d-flex align-items-center group"> 4. Vector Similarity Search (25 minutes) <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="4-vector-similarity-search-25-minutes" aria-haspopup="dialog" aria-label="Share link: 4. Vector Similarity Search (25 minutes)"> Share link </button> </h4>Generate embeddings and find similar items: Create item graph: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">CREATE GRAPH ProductCatalog; USE ProductCatalog; CREATE (:Product {id: 1, name: "Laptop"}), (:Product {id: 2, name: "Mouse"}), (:Product {id: 3, name: "Keyboard"}), (:Product {id: 4, name: "Monitor"}); -- Co-purchase relationships MATCH (laptop:Product {name: "Laptop"}), (mouse:Product {name: "Mouse"}) CREATE (laptop)-[:CO_PURCHASED]->(mouse); MATCH (laptop:Product {name: "Laptop"}), (monitor:Product {name: "Monitor"}) CREATE (laptop)-[:CO_PURCHASED]->(monitor); </code></pre></div>Generate embeddings: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">CALL graph.node2vec('ProductCatalog', { relationship_type: 'CO_PURCHASED', dimensions: 128, walk_length: 80, num_walks: 10 }) YIELD node, embedding WITH node, embedding MATCH (p:Product) WHERE p.id = node.id SET p.embedding = embedding; </code></pre></div>Create vector index: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">CREATE INDEX product_embedding_idx ON Product(embedding) USING vector; </code></pre></div>Find similar products: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">MATCH (laptop:Product {name: "Laptop"}) MATCH (similar:Product) WHERE similar.id <> laptop.id AND vector_distance_cosine(similar.embedding, laptop.embedding) < 0.5 RETURN similar.name, vector_distance_cosine(similar.embedding, laptop.embedding) AS similarity ORDER BY similarity ASC; </code></pre></div>Expected output: Mouse and Monitor (co-purchased with Laptop) have low distance. See <a href="/docs/model/data-model-and-types" >Data Model and Types</a> for vector types. <h4 id="5-backup-and-restore-workflow-10-minutes" class="position-relative d-flex align-items-center group"> 5. Backup and Restore Workflow (10 minutes) <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="5-backup-and-restore-workflow-10-minutes" aria-haspopup="dialog" aria-label="Share link: 5. Backup and Restore Workflow (10 minutes)"> Share link </button> </h4>Protect your data with backups: Local backup: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Create backup ./geode backup --output /backups/social-network-$(date +%Y%m%d).tar.gz # Verify backup ls -lh /backups/ </code></pre></div>S3 backup (requires AWS credentials): <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash">export AWS_ACCESS_KEY_ID="..." export AWS_SECRET_ACCESS_KEY="..." # Backup to S3 ./geode backup --dest s3://my-bucket/geode-backups/backup-$(date +%Y%m%d).tar.gz </code></pre></div>Restore: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Restore from local backup ./geode restore \ --input /backups/social-network-20240115.tar.gz \ --data-dir /var/lib/geode # Restore from S3 ./geode restore \ --source s3://my-bucket/geode-backups/backup-20240115.tar.gz \ --data-dir /var/lib/geode </code></pre></div>See <a href="/docs/ops/deployment#backups" >Deployment Guide</a> for automation. <h3 id="advanced-tutorials" class="position-relative d-flex align-items-center group"> Advanced Tutorials <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="advanced-tutorials" aria-haspopup="dialog" aria-label="Share link: Advanced Tutorials"> Share link </button> </h3> <h4 id="transaction-isolation-with-savepoints" class="position-relative d-flex align-items-center group"> Transaction Isolation with Savepoints <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="transaction-isolation-with-savepoints" aria-haspopup="dialog" aria-label="Share link: Transaction Isolation with Savepoints"> Share link </button> </h4>Learn MVCC and SSI with practical examples: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">START TRANSACTION; CREATE (:Account {id: 1, balance: 1000}); SAVEPOINT sp1; CREATE (:Account {id: 2, balance: 500}); SAVEPOINT sp2; -- Transfer $100 MATCH (a1:Account {id: 1}) SET a1.balance = a1.balance - 100; MATCH (a2:Account {id: 2}) SET a2.balance = a2.balance + 100; -- Verify MATCH (a:Account) RETURN a.id, a.balance; COMMIT; </code></pre></div>See <a href="/docs/transactions/overview" >Transactions Overview</a> for ACID semantics. <h4 id="full-text-search-with-bm25-ranking" class="position-relative d-flex align-items-center group"> Full-Text Search with BM25 Ranking <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="full-text-search-with-bm25-ranking" aria-haspopup="dialog" aria-label="Share link: Full-Text Search with BM25 Ranking"> Share link </button> </h4>Build a document search engine: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">CREATE GRAPH DocumentSearch; USE DocumentSearch; CREATE (:Document {id: 1, title: "Graph Databases Explained", content: "Graph databases store data as nodes and relationships..."}), (:Document {id: 2, title: "Introduction to GQL", content: "GQL is the ISO standard query language for graph databases..."}); -- Create full-text index CREATE INDEX doc_content_idx ON Document(content) USING fulltext; -- Search with BM25 ranking MATCH (d:Document) WHERE fulltext_match(d.content, "graph database") RETURN d.title, bm25_score(d.content, "graph database") AS relevance ORDER BY relevance DESC; </code></pre></div>See <a href="/docs/query/indexing-and-optimization" >Indexing and Optimization</a> for BM25 details. <h3 id="next-steps" class="position-relative d-flex align-items-center group"> Next Steps <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="next-steps" aria-haspopup="dialog" aria-label="Share link: Next Steps"> Share link </button> </h3><ul> <li><a href="/docs/gql/guide" >GQL Guide</a> - Complete language reference</li> <li><a href="/docs/analytics/graph-algorithms" >Graph Algorithms</a> - Algorithm catalog</li> <li><a href="/docs/use-cases/overview" >Use Case Guides</a> - Domain-specific patterns</li> <li><a href="/docs/reference/cli-and-api" >API Reference</a> - CLI and functions</li> </ul>