Tag: database/sql Driver Interface

The Geode Go client implements Go’s standard <code>database/sql</code> driver interface, providing a familiar and idiomatic way to interact with Geode graph databases. This standard interface enables seamless integration with existing Go applications, ORMs, migration tools, and database middleware. By implementing the <code>database/sql</code> interface, Geode becomes accessible to any Go application using standard database patterns, while still providing full access to GQL’s graph query capabilities. <h3 id="why-databasesql" class="position-relative d-flex align-items-center group"> Why database/sql? <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="why-databasesql" aria-haspopup="dialog" aria-label="Share link: Why database/sql?"> Share link </button> </h3><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 <code>database/sql</code> package is Go’s standard abstraction for SQL-like databases, providing: Standardized API: Applications can switch between databases with minimal code changes. Built-in Connection Pooling: Automatic connection lifecycle management, health checking, and pool sizing. Prepared Statement Caching: Efficient query execution with automatic statement preparation. Transaction Support: Standard BEGIN, COMMIT, ROLLBACK semantics. Context Integration: Full support for cancellation and timeouts via <code>context.Context</code>. Ecosystem Compatibility: Works with ORMs, migration tools, and monitoring solutions. <h3 id="installation-and-registration" class="position-relative d-flex align-items-center group"> Installation and Registration <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-and-registration" aria-haspopup="dialog" aria-label="Share link: Installation and Registration"> Share link </button> </h3><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go">import ( "database/sql" _ "geodedb.com/geode" // Register the driver ) func main() { // The driver is now registered as "geode" db, err := sql.Open("geode", "localhost:3141?ca=/path/to/ca.crt") if err != nil { log.Fatal(err) } defer db.Close() } </code></pre></div>The blank import (<code>_</code>) registers the Geode driver with the <code>database/sql</code> package under the name “geode”. <h3 id="connection-string-dsn-format" class="position-relative d-flex align-items-center group"> Connection String (DSN) Format <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-dsn-format" aria-haspopup="dialog" aria-label="Share link: Connection String (DSN) Format"> 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> <h4 id="dsn-options" class="position-relative d-flex align-items-center group"> DSN Options <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="dsn-options" aria-haspopup="dialog" aria-label="Share link: DSN Options"> Share link </button> </h4><table> <thead> <tr> <th>Option</th> <th>Description</th> <th>Default</th> </tr> </thead> <tbody> <tr> <td><code>page_size</code></td> <td>Results page size</td> <td>1000</td> </tr> <tr> <td><code>hello_name</code></td> <td>Client name for HELLO</td> <td>geode-go</td> </tr> <tr> <td><code>hello_ver</code></td> <td>Client version for HELLO</td> <td>0.1</td> </tr> <tr> <td><code>conformance</code></td> <td>GQL conformance level</td> <td>min</td> </tr> <tr> <td><code>ca</code></td> <td>Path to CA certificate</td> <td></td> </tr> <tr> <td><code>cert</code></td> <td>Path to client certificate (mTLS)</td> <td></td> </tr> <tr> <td><code>key</code></td> <td>Path to client key (mTLS)</td> <td></td> </tr> <tr> <td><code>insecure_tls_skip_verify</code></td> <td>Skip TLS verification</td> <td>false</td> </tr> </tbody> </table> <h4 id="connection-examples" class="position-relative d-flex align-items-center group"> Connection 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="connection-examples" aria-haspopup="dialog" aria-label="Share link: Connection Examples"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go">// Simple connection with TLS db, _ := sql.Open("geode", "geode.example.com:3141") // With custom CA certificate db, _ := sql.Open("geode", "geode.example.com:3141?ca=/etc/geode/ca.crt") // Mutual TLS (mTLS) db, _ := sql.Open("geode", "geode.example.com:3141?ca=/etc/geode/ca.crt&cert=/etc/geode/client.crt&key=/etc/geode/client.key") // Development mode (skip TLS verification) db, _ := sql.Open("geode", "localhost:3141?insecure_tls_skip_verify=true") // URL format db, _ := sql.Open("geode", "quic://localhost:3141?page_size=500") </code></pre></div> <h4 id="environment-variables" class="position-relative d-flex align-items-center group"> Environment Variables <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="environment-variables" aria-haspopup="dialog" aria-label="Share link: Environment Variables"> Share link </button> </h4><table> <thead> <tr> <th>Variable</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>GEODE_HOST</code></td> <td>Default host</td> </tr> <tr> <td><code>GEODE_PORT</code></td> <td>Default port</td> </tr> <tr> <td><code>GEODE_TLS_CA</code></td> <td>Default CA certificate path</td> </tr> </tbody> </table> <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>The <code>database/sql</code> package provides built-in connection pooling: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go">func configurePool(db *sql.DB) { // Maximum number of open connections to the database db.SetMaxOpenConns(25) // Maximum number of idle connections in the pool db.SetMaxIdleConns(10) // Maximum amount of time a connection may be reused db.SetConnMaxLifetime(5 * time.Minute) // Maximum amount of time a connection may be idle before being closed db.SetConnMaxIdleTime(1 * time.Minute) } </code></pre></div> <h4 id="pool-sizing-guidelines" class="position-relative d-flex align-items-center group"> Pool Sizing Guidelines <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="pool-sizing-guidelines" aria-haspopup="dialog" aria-label="Share link: Pool Sizing Guidelines"> Share link </button> </h4><table> <thead> <tr> <th>Workload</th> <th>MaxOpenConns</th> <th>MaxIdleConns</th> <th>ConnMaxLifetime</th> </tr> </thead> <tbody> <tr> <td>Light (< 100 req/s)</td> <td>10</td> <td>5</td> <td>10 minutes</td> </tr> <tr> <td>Medium (100-1000 req/s)</td> <td>25</td> <td>10</td> <td>5 minutes</td> </tr> <tr> <td>Heavy (> 1000 req/s)</td> <td>50</td> <td>25</td> <td>2 minutes</td> </tr> </tbody> </table> <h4 id="monitoring-pool-statistics" class="position-relative d-flex align-items-center group"> Monitoring Pool Statistics <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="monitoring-pool-statistics" aria-haspopup="dialog" aria-label="Share link: Monitoring Pool Statistics"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go">func monitorPool(db *sql.DB) { ticker := time.NewTicker(30 * time.Second) defer ticker.Stop() for range ticker.C { stats := db.Stats() log.Printf("Pool Stats:") log.Printf(" Open connections: %d", stats.OpenConnections) log.Printf(" In use: %d", stats.InUse) log.Printf(" Idle: %d", stats.Idle) log.Printf(" Wait count: %d", stats.WaitCount) log.Printf(" Wait duration: %v", stats.WaitDuration) log.Printf(" Max idle closed: %d", stats.MaxIdleClosed) log.Printf(" Max idle time closed: %d", stats.MaxIdleTimeClosed) log.Printf(" Max lifetime closed: %d", stats.MaxLifetimeClosed) } } </code></pre></div> <h3 id="query-execution" class="position-relative d-flex align-items-center group"> Query Execution <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="query-execution" aria-haspopup="dialog" aria-label="Share link: Query Execution"> Share link </button> </h3> <h4 id="querycontext-and-queryrowcontext" class="position-relative d-flex align-items-center group"> QueryContext and QueryRowContext <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="querycontext-and-queryrowcontext" aria-haspopup="dialog" aria-label="Share link: QueryContext and QueryRowContext"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go">// Multiple rows func queryPeople(ctx context.Context, db *sql.DB) error { rows, err := db.QueryContext(ctx, ` MATCH (p:Person) RETURN p.name AS name, p.age AS age ORDER BY p.name LIMIT 100 `) if err != nil { return err } defer rows.Close() for rows.Next() { var name string var age int if err := rows.Scan(&name, &age); err != nil { return err } fmt.Printf("Name: %s, Age: %d\n", name, age) } return rows.Err() } // Single row func findPerson(ctx context.Context, db *sql.DB, id int) (*Person, error) { row := db.QueryRowContext(ctx, ` MATCH (p:Person {id: ?}) RETURN p.name, p.age, p.email `, id) var p Person err := row.Scan(&p.Name, &p.Age, &p.Email) if err == sql.ErrNoRows { return nil, nil // Not found } if err != nil { return nil, err } return &p, nil } </code></pre></div> <h4 id="execcontext" class="position-relative d-flex align-items-center group"> ExecContext <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="execcontext" aria-haspopup="dialog" aria-label="Share link: ExecContext"> Share link </button> </h4>For queries that don’t return rows: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go">func createPerson(ctx context.Context, db *sql.DB, name string, age int) error { result, err := db.ExecContext(ctx, ` CREATE (p:Person {name: ?, age: ?, created_at: datetime()}) `, name, age) if err != nil { return err } // Note: RowsAffected may not be supported by all operations affected, err := result.RowsAffected() if err == nil { log.Printf("Created %d nodes", affected) } return nil } </code></pre></div> <h3 id="parameterized-queries" class="position-relative d-flex align-items-center group"> Parameterized Queries <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="parameterized-queries" aria-haspopup="dialog" aria-label="Share link: Parameterized Queries"> Share link </button> </h3> <h4 id="positional-parameters" class="position-relative d-flex align-items-center group"> Positional Parameters <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="positional-parameters" aria-haspopup="dialog" aria-label="Share link: Positional Parameters"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go">// Use ? for positional parameters rows, err := db.QueryContext(ctx, ` MATCH (p:Person {name: ?}) WHERE p.age >= ? RETURN p.name, p.age `, "Alice", 25) </code></pre></div> <h4 id="named-parameters" class="position-relative d-flex align-items-center group"> Named Parameters <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="named-parameters" aria-haspopup="dialog" aria-label="Share link: Named Parameters"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go">// Use sql.Named for named parameters rows, err := db.QueryContext(ctx, ` MATCH (p:Person {name: $name}) WHERE p.age >= $minAge RETURN p.name, p.age `, sql.Named("name", "Alice"), sql.Named("minAge", 25)) </code></pre></div> <h4 id="parameter-types" class="position-relative d-flex align-items-center group"> Parameter Types <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="parameter-types" aria-haspopup="dialog" aria-label="Share link: Parameter Types"> Share link </button> </h4>The driver automatically converts Go types to GQL types: <table> <thead> <tr> <th>Go Type</th> <th>GQL Type</th> </tr> </thead> <tbody> <tr> <td><code>bool</code></td> <td>BOOLEAN</td> </tr> <tr> <td><code>int</code>, <code>int64</code></td> <td>INTEGER</td> </tr> <tr> <td><code>float64</code></td> <td>FLOAT</td> </tr> <tr> <td><code>string</code></td> <td>STRING</td> </tr> <tr> <td><code>[]byte</code></td> <td>BYTES</td> </tr> <tr> <td><code>time.Time</code></td> <td>TIMESTAMP</td> </tr> <tr> <td><code>nil</code></td> <td>NULL</td> </tr> <tr> <td><code>[]interface{}</code></td> <td>LIST</td> </tr> <tr> <td><code>map[string]interface{}</code></td> <td>MAP</td> </tr> </tbody> </table> <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>Prepared statements improve performance for frequently executed queries: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go">func batchLookup(ctx context.Context, db *sql.DB, ids []int) error { // Prepare once stmt, err := db.PrepareContext(ctx, ` MATCH (p:Person {id: ?}) RETURN p.name, p.age, p.email `) if err != nil { return err } defer stmt.Close() // Execute many times for _, id := range ids { rows, err := stmt.QueryContext(ctx, id) if err != nil { return err } for rows.Next() { var name, email string var age int if err := rows.Scan(&name, &age, &email); err != nil { rows.Close() return err } fmt.Printf("%d: %s (%d) - %s\n", id, name, age, email) } rows.Close() } return nil } </code></pre></div> <h4 id="statement-lifetime" class="position-relative d-flex align-items-center group"> Statement Lifetime <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="statement-lifetime" aria-haspopup="dialog" aria-label="Share link: Statement Lifetime"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go">// Application-scoped prepared statements type PersonRepository struct { db *sql.DB findByID *sql.Stmt findByName *sql.Stmt } func NewPersonRepository(ctx context.Context, db *sql.DB) (*PersonRepository, error) { findByID, err := db.PrepareContext(ctx, ` MATCH (p:Person {id: ?}) RETURN p.name, p.age `) if err != nil { return nil, err } findByName, err := db.PrepareContext(ctx, ` MATCH (p:Person {name: ?}) RETURN p.id, p.age `) if err != nil { findByID.Close() return nil, err } return &PersonRepository{ db: db, findByID: findByID, findByName: findByName, }, nil } func (r *PersonRepository) Close() { r.findByID.Close() r.findByName.Close() } </code></pre></div> <h3 id="transaction-management" class="position-relative d-flex align-items-center group"> Transaction Management <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-management" aria-haspopup="dialog" aria-label="Share link: Transaction Management"> Share link </button> </h3> <h4 id="basic-transactions" class="position-relative d-flex align-items-center group"> Basic 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="basic-transactions" aria-haspopup="dialog" aria-label="Share link: Basic Transactions"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go">func transferFunds(ctx context.Context, db *sql.DB, from, to string, amount float64) error { tx, err := db.BeginTx(ctx, nil) if err != nil { return err } // Debit _, err = tx.ExecContext(ctx, ` MATCH (a:Account {id: ?}) WHERE a.balance >= ? SET a.balance = a.balance - ? `, from, amount, amount) if err != nil { tx.Rollback() return err } // Credit _, err = tx.ExecContext(ctx, ` MATCH (a:Account {id: ?}) SET a.balance = a.balance + ? `, to, amount) if err != nil { tx.Rollback() return err } return tx.Commit() } </code></pre></div> <h4 id="transaction-options" class="position-relative d-flex align-items-center group"> Transaction Options <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-options" aria-haspopup="dialog" aria-label="Share link: Transaction Options"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go">// Read-only transaction tx, err := db.BeginTx(ctx, &sql.TxOptions{ ReadOnly: true, }) // With isolation level tx, err := db.BeginTx(ctx, &sql.TxOptions{ Isolation: sql.LevelSerializable, }) </code></pre></div> <h4 id="transaction-helper-pattern" class="position-relative d-flex align-items-center group"> Transaction Helper Pattern <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-helper-pattern" aria-haspopup="dialog" aria-label="Share link: Transaction Helper Pattern"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go">func withTransaction(ctx context.Context, db *sql.DB, fn func(*sql.Tx) error) error { tx, err := db.BeginTx(ctx, nil) if err != nil { return err } defer func() { if p := recover(); p != nil { tx.Rollback() panic(p) } }() if err := fn(tx); err != nil { tx.Rollback() return err } return tx.Commit() } // Usage err := withTransaction(ctx, db, func(tx *sql.Tx) error { _, err := tx.ExecContext(ctx, "CREATE (n:Node {name: ?})", name) return err }) </code></pre></div> <h3 id="context-and-cancellation" class="position-relative d-flex align-items-center group"> Context and Cancellation <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="context-and-cancellation" aria-haspopup="dialog" aria-label="Share link: Context and Cancellation"> Share link </button> </h3> <h4 id="timeouts" class="position-relative d-flex align-items-center group"> Timeouts <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="timeouts" aria-haspopup="dialog" aria-label="Share link: Timeouts"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go">func queryWithTimeout(db *sql.DB) error { ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second) defer cancel() rows, err := db.QueryContext(ctx, "MATCH (n) RETURN n LIMIT 1000") if err != nil { if ctx.Err() == context.DeadlineExceeded { return fmt.Errorf("query timed out") } return err } defer rows.Close() // Process rows... return nil } </code></pre></div> <h4 id="cancellation" class="position-relative d-flex align-items-center group"> Cancellation <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="cancellation" aria-haspopup="dialog" aria-label="Share link: Cancellation"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go">func cancelableQuery(ctx context.Context, db *sql.DB) error { // Query will be cancelled if ctx is cancelled rows, err := db.QueryContext(ctx, "MATCH (n) RETURN n") if err != nil { if ctx.Err() == context.Canceled { return fmt.Errorf("query cancelled") } return err } defer rows.Close() // Process rows... return nil } </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> <h4 id="driver-specific-errors" class="position-relative d-flex align-items-center group"> Driver-Specific Errors <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="driver-specific-errors" aria-haspopup="dialog" aria-label="Share link: Driver-Specific Errors"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go">import "geodedb.com/geode" func handleError(err error) { if err == nil { return } var derr *geode.DriverError if errors.As(err, &derr) { log.Printf("Geode Error - Code: %s, Message: %s", derr.Code, derr.Message) // Check if retryable if derr.IsRetryable() { log.Println("This error is retryable") } // Handle specific error codes switch derr.Code { case "42000": // Syntax error log.Println("GQL syntax error") case "28000": // Authentication failure log.Println("Authentication failed") case "40001": // Serialization failure log.Println("Transaction conflict - retry recommended") case "08000": // Connection error log.Println("Connection error") } } else { log.Printf("Generic error: %v", err) } } </code></pre></div> <h4 id="retry-pattern" class="position-relative d-flex align-items-center group"> Retry Pattern <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="retry-pattern" aria-haspopup="dialog" aria-label="Share link: Retry Pattern"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go">func executeWithRetry(ctx context.Context, db *sql.DB, query string, args ...interface{}) error { maxRetries := 3 baseDelay := 100 * time.Millisecond for attempt := 0; attempt < maxRetries; attempt++ { _, err := db.ExecContext(ctx, query, args...) if err == nil { return nil } var derr *geode.DriverError if errors.As(err, &derr) && derr.IsRetryable() { delay := baseDelay * time.Duration(1<<attempt) select { case <-ctx.Done(): return ctx.Err() case <-time.After(delay): continue } } return err } return fmt.Errorf("max retries exceeded") } </code></pre></div> <h3 id="scanning-complex-types" class="position-relative d-flex align-items-center group"> Scanning Complex Types <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="scanning-complex-types" aria-haspopup="dialog" aria-label="Share link: Scanning Complex Types"> Share link </button> </h3> <h4 id="null-handling" class="position-relative d-flex align-items-center group"> Null 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="null-handling" aria-haspopup="dialog" aria-label="Share link: Null Handling"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go">func queryWithNulls(ctx context.Context, db *sql.DB) error { rows, err := db.QueryContext(ctx, ` MATCH (p:Person) RETURN p.name, p.nickname, p.age `) if err != nil { return err } defer rows.Close() for rows.Next() { var name string var nickname sql.NullString var age sql.NullInt64 if err := rows.Scan(&name, &nickname, &age); err != nil { return err } if nickname.Valid { fmt.Printf("%s (aka %s)", name, nickname.String) } else { fmt.Printf("%s", name) } if age.Valid { fmt.Printf(", age %d\n", age.Int64) } else { fmt.Printf(", age unknown\n") } } return rows.Err() } </code></pre></div> <h4 id="custom-scanner" class="position-relative d-flex align-items-center group"> Custom Scanner <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="custom-scanner" aria-haspopup="dialog" aria-label="Share link: Custom Scanner"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go">type JSONMap map[string]interface{} func (j *JSONMap) Scan(src interface{}) error { switch v := src.(type) { case []byte: return json.Unmarshal(v, j) case string: return json.Unmarshal([]byte(v), j) case nil: *j = nil return nil default: return fmt.Errorf("cannot scan %T into JSONMap", src) } } // Usage var metadata JSONMap err := row.Scan(&metadata) </code></pre></div> <h3 id="best-practices" class="position-relative d-flex align-items-center group"> Best Practices <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="best-practices" aria-haspopup="dialog" aria-label="Share link: Best Practices"> Share link </button> </h3> <h4 id="connection-lifecycle" class="position-relative d-flex align-items-center group"> Connection Lifecycle <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-lifecycle" aria-haspopup="dialog" aria-label="Share link: Connection Lifecycle"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go">// Good: Single *sql.DB for the application var db *sql.DB func init() { var err error db, err = sql.Open("geode", os.Getenv("GEODE_DSN")) if err != nil { log.Fatal(err) } configurePool(db) } // Bad: Creating new *sql.DB per request func badHandler(w http.ResponseWriter, r *http.Request) { db, _ := sql.Open("geode", "localhost:3141") // Don't do this! defer db.Close() // ... } </code></pre></div> <h4 id="row-iteration" class="position-relative d-flex align-items-center group"> Row Iteration <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="row-iteration" aria-haspopup="dialog" aria-label="Share link: Row Iteration"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go">// Good: Always close rows and check errors rows, err := db.QueryContext(ctx, query) if err != nil { return err } defer rows.Close() for rows.Next() { // ... } // Check for iteration errors if err := rows.Err(); err != nil { return err } </code></pre></div> <h4 id="context-usage" class="position-relative d-flex align-items-center group"> Context Usage <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="context-usage" aria-haspopup="dialog" aria-label="Share link: Context Usage"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go">// Good: Always use Context methods rows, err := db.QueryContext(ctx, query) result, err := db.ExecContext(ctx, query) stmt, err := db.PrepareContext(ctx, query) tx, err := db.BeginTx(ctx, opts) // Avoid: Non-context methods rows, err := db.Query(query) // No timeout/cancellation result, err := db.Exec(query) // No timeout/cancellation </code></pre></div> <h3 id="integration-examples" class="position-relative d-flex align-items-center group"> Integration 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="integration-examples" aria-haspopup="dialog" aria-label="Share link: Integration Examples"> Share link </button> </h3> <h4 id="http-handler" class="position-relative d-flex align-items-center group"> HTTP Handler <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="http-handler" aria-haspopup="dialog" aria-label="Share link: HTTP Handler"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go">func getPerson(db *sql.DB) http.HandlerFunc { return func(w http.ResponseWriter, r *http.Request) { ctx, cancel := context.WithTimeout(r.Context(), 5*time.Second) defer cancel() id := r.URL.Query().Get("id") row := db.QueryRowContext(ctx, ` MATCH (p:Person {id: ?}) RETURN p.name, p.age `, id) var name string var age int if err := row.Scan(&name, &age); err != nil { if err == sql.ErrNoRows { http.Error(w, "Not found", http.StatusNotFound) return } http.Error(w, err.Error(), http.StatusInternalServerError) return } json.NewEncoder(w).Encode(map[string]interface{}{ "name": name, "age": age, }) } } </code></pre></div> <h4 id="health-check" class="position-relative d-flex align-items-center group"> Health Check <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="health-check" aria-haspopup="dialog" aria-label="Share link: Health Check"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go">func healthCheck(db *sql.DB) http.HandlerFunc { return func(w http.ResponseWriter, r *http.Request) { ctx, cancel := context.WithTimeout(r.Context(), 1*time.Second) defer cancel() if err := db.PingContext(ctx); err != nil { w.WriteHeader(http.StatusServiceUnavailable) json.NewEncoder(w).Encode(map[string]string{ "status": "unhealthy", "error": err.Error(), }) return } stats := db.Stats() json.NewEncoder(w).Encode(map[string]interface{}{ "status": "healthy", "connections": stats.OpenConnections, "in_use": stats.InUse, "idle": stats.Idle, }) } } </code></pre></div> <h3 id="related-topics" class="position-relative d-flex align-items-center group"> Related Topics <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="related-topics" aria-haspopup="dialog" aria-label="Share link: Related Topics"> Share link </button> </h3><ul> <li><a href="/tags/go-client/" >Go Client</a> </li> <li><a href="/tags/client-libraries/" >Client Libraries</a> </li> <li><a href="/tags/connection-pooling/" >Connection Pooling</a> </li> <li><a href="/tags/transactions/" >Transactions</a> </li> <li><a href="/tags/prepared-statements/" >Prepared Statements</a> </li> <li><a href="/tags/protocol/" >Protocol</a> </li> <li><a href="/tags/tutorials/" >Tutorials</a> </li> </ul> <h3 id="further-reading" class="position-relative d-flex align-items-center group"> Further Reading <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="further-reading" aria-haspopup="dialog" aria-label="Share link: Further Reading"> Share link </button> </h3><ul> <li><a href="https://pkg.go.dev/database/sql" aria-label="Go database/sql Documentation – opens in new window" target="_blank" rel="noopener noreferrer" >Go database/sql Documentation ↗ </a> </li> <li><a href="https://go.dev/doc/tutorial/database-access" aria-label="Go database/sql Tutorial – opens in new window" target="_blank" rel="noopener noreferrer" >Go database/sql Tutorial ↗ </a> </li> <li><a href="https://github.com/golang/go/wiki/SQLDrivers" aria-label="SQL Drivers Wiki – opens in new window" target="_blank" rel="noopener noreferrer" >SQL Drivers Wiki ↗ </a> </li> <li><a href="https://gitlab.com/devnw/codepros/geode/geode-client-go" aria-label="Go Client Repository – opens in new window" target="_blank" rel="noopener noreferrer" >Go Client Repository ↗ </a> </li> <li><a href="/docs/" >Geode Documentation</a> </li> </ul>

Popular

Related Articles