Go Client | Geode Database

<h2 id="go-client-library" class="position-relative d-flex align-items-center group"> Go Client Library <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="go-client-library" aria-haspopup="dialog" aria-label="Share link: Go Client Library"> 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>The official Go client for Geode provides a <code>database/sql</code> driver implementation with full support for prepared statements, transactions, and connection pooling. <h3 id="installation" class="position-relative d-flex align-items-center group"> Installation <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="installation" aria-haspopup="dialog" aria-label="Share link: Installation"> Share link </button> </h3><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash">go get geodedb.com/geode </code></pre></div>Requirements: Go 1.24.0+ <h3 id="quick-start" class="position-relative d-flex align-items-center group"> Quick Start <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="quick-start" aria-haspopup="dialog" aria-label="Share link: Quick Start"> Share link </button> </h3><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go">package main import ( "database/sql" "fmt" "log" _ "geodedb.com/geode" ) func main() { // Open connection db, err := sql.Open("geode", "localhost:3141") if err != nil { log.Fatal(err) } defer db.Close() // Test connection if err := db.Ping(); err != nil { log.Fatal(err) } // Execute query rows, err := db.Query("MATCH (p:Person) RETURN p.name, p.age") if err != nil { log.Fatal(err) } defer rows.Close() // Process results for rows.Next() { var name string var age int if err := rows.Scan(&name, &age); err != nil { log.Fatal(err) } fmt.Printf("Name: %s, Age: %d\n", name, age) } } </code></pre></div> <h3 id="connection-string" class="position-relative d-flex align-items-center group"> Connection String <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="connection-string" aria-haspopup="dialog" aria-label="Share link: Connection String"> Share link </button> </h3><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-fallback" data-lang="fallback">quic://host:port?options host:port?options host:port host </code></pre></div>Options: <ul> <li><code>page_size</code> - Results page size (default: 1000)</li> <li><code>hello_name</code> - Client name sent in HELLO (default: <code>geode-go</code>)</li> <li><code>hello_ver</code> - Client version sent in HELLO (default: <code>0.1</code>)</li> <li><code>conformance</code> - GQL conformance level (default: <code>min</code>)</li> <li><code>ca</code> - Path to CA certificate</li> <li><code>cert</code> - Path to client certificate (mTLS)</li> <li><code>key</code> - Path to client key (mTLS)</li> <li><code>insecure_tls_skip_verify</code> - Skip TLS verification (testing only)</li> </ul> Environment Variables: <ul> <li><code>GEODE_HOST</code> - Default host if DSN is empty</li> <li><code>GEODE_PORT</code> - Default port if not specified</li> <li><code>GEODE_TLS_CA</code> - Default CA certificate path</li> </ul> Examples: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go">// Basic connection db, err := sql.Open("geode", "quic://localhost:3141") // With TLS verification db, err := sql.Open("geode", "localhost:3141?ca=/path/to/ca.crt") // With mTLS db, err := sql.Open("geode", "localhost:3141?ca=/path/to/ca.crt&cert=/path/to/client.crt&key=/path/to/client.key") // With paging options db, err := sql.Open("geode", "localhost:3141?page_size=5000&conformance=full") </code></pre></div> <h3 id="prepared-statements" class="position-relative d-flex align-items-center group"> Prepared Statements <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="prepared-statements" aria-haspopup="dialog" aria-label="Share link: Prepared Statements"> Share link </button> </h3><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go">// Prepare statement stmt, err := db.Prepare("MATCH (p:Person {name: ?}) RETURN p") if err != nil { log.Fatal(err) } defer stmt.Close() // Execute with parameters rows, err := stmt.Query("Alice") if err != nil { log.Fatal(err) } defer rows.Close() // Or use QueryRow for single result var age int err = stmt.QueryRow("Bob").Scan(&age) </code></pre></div> <h3 id="transactions" class="position-relative d-flex align-items-center group"> Transactions <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="transactions" aria-haspopup="dialog" aria-label="Share link: Transactions"> Share link </button> </h3><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go">// Begin transaction tx, err := db.Begin() if err != nil { log.Fatal(err) } // Execute statements _, err = tx.Exec("CREATE (:Person {name: ?, age: ?})", "Alice", 30) if err != nil { tx.Rollback() log.Fatal(err) } _, err = tx.Exec("CREATE (:Person {name: ?, age: ?})", "Bob", 25) if err != nil { tx.Rollback() log.Fatal(err) } // Commit if err := tx.Commit(); err != nil { log.Fatal(err) } </code></pre></div> <h3 id="connection-pooling" class="position-relative d-flex align-items-center group"> Connection Pooling <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="connection-pooling" aria-haspopup="dialog" aria-label="Share link: Connection Pooling"> Share link </button> </h3><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go">// Configure connection pool db.SetMaxOpenConns(25) db.SetMaxIdleConns(5) db.SetConnMaxLifetime(5 * time.Minute) db.SetConnMaxIdleTime(1 * time.Minute) </code></pre></div> <h3 id="error-handling" class="position-relative d-flex align-items-center group"> Error Handling <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="error-handling" aria-haspopup="dialog" aria-label="Share link: Error Handling"> Share link </button> </h3>The Go client provides rich error types with ISO GQL status codes: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go">import "errors" rows, err := db.Query("MATCH (p:Invalid) RETURN p") if err != nil { var geodeErr *geode.DriverError if errors.As(err, &geodeErr) { fmt.Printf("Code: %s\n", geodeErr.Code) fmt.Printf("Message: %s\n", geodeErr.Message) fmt.Printf("Status Class: %s\n", geodeErr.StatusClass()) } log.Fatal(err) } </code></pre></div> <h3 id="type-mapping" class="position-relative d-flex align-items-center group"> Type Mapping <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="type-mapping" aria-haspopup="dialog" aria-label="Share link: Type Mapping"> Share link </button> </h3><table> <thead> <tr> <th>GQL Type</th> <th>Go Type</th> </tr> </thead> <tbody> <tr> <td>INTEGER</td> <td>int64</td> </tr> <tr> <td>FLOAT</td> <td>float64</td> </tr> <tr> <td>STRING</td> <td>string</td> </tr> <tr> <td>BOOLEAN</td> <td>bool</td> </tr> <tr> <td>NULL</td> <td>nil</td> </tr> <tr> <td>LIST</td> <td>[]interface{}</td> </tr> <tr> <td>MAP</td> <td>map[string]interface{}</td> </tr> <tr> <td>NODE</td> <td>map[string]any</td> </tr> <tr> <td>EDGE</td> <td>map[string]any</td> </tr> <tr> <td>PATH</td> <td>map[string]any</td> </tr> </tbody> </table> <h3 id="unicode-utilities" class="position-relative d-flex align-items-center group"> Unicode Utilities <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="unicode-utilities" aria-haspopup="dialog" aria-label="Share link: Unicode Utilities"> Share link </button> </h3>The Go driver includes Unicode helpers used by the protocol framing layer: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go">utf16 := geode.Utf8ToUtf16("Hello 🌍") utf8 := geode.Utf16ToUtf8(utf16) safe := geode.Wtf8Lossy([]byte{0x61, 0x80, 0x62}) </code></pre></div>   <h3 id="testing" class="position-relative d-flex align-items-center group"> Testing <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="testing" aria-haspopup="dialog" aria-label="Share link: Testing"> Share link </button> </h3>The client includes support for testcontainers-go: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go">func TestWithGeode(t *testing.T) { // Start Geode container ctx := context.Background() container, err := testcontainers.GenericContainer(ctx, testcontainers.GenericContainerRequest{ ContainerRequest: testcontainers.ContainerRequest{ Image: "geode:latest", ExposedPorts: []string{"3141/udp"}, WaitingFor: wait.ForLog("Server started"), }, Started: true, }) if err != nil { t.Fatal(err) } defer container.Terminate(ctx) // Get connection string host, _ := container.Host(ctx) port, _ := container.MappedPort(ctx, "3141") db, err := sql.Open("geode", fmt.Sprintf("quic://%s:%s", host, port.Port())) if err != nil { t.Fatal(err) } defer db.Close() // Run tests... } </code></pre></div> <h3 id="performance-tips" class="position-relative d-flex align-items-center group"> Performance Tips <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="performance-tips" aria-haspopup="dialog" aria-label="Share link: Performance Tips"> Share link </button> </h3><ol> <li>Use connection pooling - Configure <code>SetMaxOpenConns</code> appropriately</li> <li>Prepared statements - Reuse prepared statements for repeated queries</li> <li>Batch operations - Use transactions for multiple operations</li> <li>Context timeouts - Use <code>QueryContext</code> with timeouts</li> <li>Close resources - Always defer <code>Close()</code> on rows, statements, and connections</li> </ol> <h3 id="examples" class="position-relative d-flex align-items-center group"> 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="examples" aria-haspopup="dialog" aria-label="Share link: Examples"> Share link </button> </h3>See the <a href="https://gitlab.com/devnw/codepros/geode/geode-client-go/tree/main/examples" aria-label="examples directory – opens in new window" target="_blank" rel="noopener noreferrer" >examples directory ↗ </a> for complete examples: <ul> <li>Basic CRUD operations</li> <li>Transaction management</li> <li>Connection pooling</li> <li>Error handling</li> <li>Type conversions</li> </ul> <h3 id="repository" class="position-relative d-flex align-items-center group"> Repository <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="repository" aria-haspopup="dialog" aria-label="Share link: Repository"> Share link </button> </h3><ul> <li>GitLab: <a href="https://gitlab.com/devnw/codepros/geode/geode-client-go" aria-label="devnw/codepros/geode/geode-client-go – opens in new window" target="_blank" rel="noopener noreferrer" >devnw/codepros/geode/geode-client-go ↗ </a> </li> <li>Module: <code>geodedb.com/geode</code></li> </ul>