Tag: Zig Native Client

The Geode Zig client library (<code>geode-client-zig</code>) provides a production-ready, native Zig interface for connecting to Geode graph databases. Built with Zig’s focus on performance and correctness, it offers low-level QUIC protocol access while maintaining ergonomic APIs through fluent query builders and comprehensive type support. The Zig client is designed for systems programmers and performance-critical applications where memory safety, predictable performance, and minimal runtime overhead are essential. With native QUIC+TLS 1.3 transport and zero-copy optimizations where possible, it delivers sub-millisecond query latency. <h3 id="key-features" class="position-relative d-flex align-items-center group"> Key Features <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="key-features" aria-haspopup="dialog" aria-label="Share link: Key Features"> 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>QUIC + TLS 1.3: Native QUIC transport with mandatory TLS 1.3 for secure, high-performance connections. Full GQL Type System: 15+ value types including temporal and graph types with type-safe accessors. Fluent Query Builders: Type-safe query construction with <code>QueryBuilder</code>, <code>PatternBuilder</code>, and <code>PredicateBuilder</code>. Connection Pooling: Configurable pooling with health checks and automatic connection management. ISO GQL Status Codes: Standardized error handling with proper status code categorization. DSN Parsing: Flexible connection configuration through Data Source Name strings. Input Validation: Robust security with comprehensive input validation utilities. Memory Safety: Proper allocation/deallocation with <code>errdefer</code> and <code>defer</code> patterns. <h3 id="requirements" class="position-relative d-flex align-items-center group"> Requirements <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="requirements" aria-haspopup="dialog" aria-label="Share link: Requirements"> Share link </button> </h3><ul> <li>Zig 0.1.0 or later</li> <li>OpenSSL (for TLS support on Linux)</li> <li>Running Geode server</li> </ul> <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>Add to your <code>build.zig.zon</code>: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-zig" data-lang="zig">.dependencies = .{ .geode_client = .{ .url = "https://gitlab.com/devnw/geode/geode-client-zig/-/archive/main/geode-client-zig-main.tar.gz", // Add hash after first build attempt }, }, </code></pre></div>Then in <code>build.zig</code>: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-zig" data-lang="zig">const geode_client = b.dependency("geode_client", .{ .target = target, .optimize = optimize, }); exe.root_module.addImport("geode_client", geode_client.module("geode_client")); </code></pre></div> <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-zig" data-lang="zig">const std = @import("std"); const geode = @import("geode_client"); pub fn main() !void { var gpa = std.heap.GeneralPurposeAllocator(.{}){}; defer _ = gpa.deinit(); const allocator = gpa.allocator(); // Create client var client = geode.GeodeClient.init(allocator, "localhost", 3141, true); defer client.deinit(); // Connect try client.connect(); try client.openStream(); // Send handshake try client.sendHello("my-app", "1.0.0"); const response = try client.receiveMessage(30000); defer allocator.free(response); // Execute query try client.sendQuery("MATCH (n:Person) RETURN n.name, n.age"); const result = try client.receiveMessage(30000); defer allocator.free(result); std.debug.print("Result: {s}\n", .{result}); } </code></pre></div> <h3 id="configuration" class="position-relative d-flex align-items-center group"> Configuration <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="configuration" aria-haspopup="dialog" aria-label="Share link: Configuration"> Share link </button> </h3> <h4 id="config-structure" class="position-relative d-flex align-items-center group"> Config Structure <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="config-structure" aria-haspopup="dialog" aria-label="Share link: Config Structure"> Share link </button> </h4>Configuration for client connections: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-zig" data-lang="zig">const Config = @import("config").Config; var cfg = Config.init(); _ = cfg.withHost("localhost"); _ = cfg.withPort(3141); _ = cfg.withCredentials("admin", "secret"); _ = cfg.withInsecure(true); _ = cfg.withPageSize(500); _ = cfg.withTimeout(60000); </code></pre></div> <h4 id="configuration-options" class="position-relative d-flex align-items-center group"> Configuration 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="configuration-options" aria-haspopup="dialog" aria-label="Share link: Configuration Options"> Share link </button> </h4><table> <thead> <tr> <th>Option</th> <th>Type</th> <th>Default</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>host</code></td> <td><code>[]const u8</code></td> <td><code>"localhost"</code></td> <td>Server hostname</td> </tr> <tr> <td><code>port</code></td> <td><code>u16</code></td> <td><code>3141</code></td> <td>Server port</td> </tr> <tr> <td><code>username</code></td> <td><code>?[]const u8</code></td> <td><code>null</code></td> <td>Authentication username</td> </tr> <tr> <td><code>password</code></td> <td><code>?[]const u8</code></td> <td><code>null</code></td> <td>Authentication password</td> </tr> <tr> <td><code>insecure</code></td> <td><code>bool</code></td> <td><code>false</code></td> <td>Skip TLS verification</td> </tr> <tr> <td><code>page_size</code></td> <td><code>u32</code></td> <td><code>1000</code></td> <td>Result pagination size</td> </tr> <tr> <td><code>timeout_ms</code></td> <td><code>u32</code></td> <td><code>30000</code></td> <td>Connection timeout (ms)</td> </tr> </tbody> </table> <h4 id="dsn-parsing" class="position-relative d-flex align-items-center group"> DSN Parsing <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-parsing" aria-haspopup="dialog" aria-label="Share link: DSN Parsing"> Share link </button> </h4>Parse connection strings in various formats: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-zig" data-lang="zig">const parseDSN = @import("config").parseDSN; // URL format with credentials const cfg1 = try parseDSN(allocator, "quic://admin:secret@localhost:3141?insecure_tls_skip_verify=true"); defer cfg1.deinit(allocator); // Simple format const cfg2 = try parseDSN(allocator, "localhost:8443"); defer cfg2.deinit(allocator); // With query parameters const cfg3 = try parseDSN(allocator, "db.example.com:3141?page_size=500&timeout=60000"); defer cfg3.deinit(allocator); </code></pre></div> <h4 id="supported-query-parameters" class="position-relative d-flex align-items-center group"> Supported Query 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="supported-query-parameters" aria-haspopup="dialog" aria-label="Share link: Supported Query Parameters"> Share link </button> </h4><table> <thead> <tr> <th>Parameter</th> <th>Aliases</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>insecure_tls_skip_verify</code></td> <td>-</td> <td>Skip TLS verification</td> </tr> <tr> <td><code>page_size</code></td> <td><code>pageSize</code></td> <td>Result page size</td> </tr> <tr> <td><code>timeout</code></td> <td><code>timeout_ms</code></td> <td>Connection timeout</td> </tr> <tr> <td><code>username</code></td> <td><code>user</code></td> <td>Authentication username</td> </tr> <tr> <td><code>password</code></td> <td><code>pass</code></td> <td>Authentication password</td> </tr> </tbody> </table> <h3 id="value-types" class="position-relative d-flex align-items-center group"> Value 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="value-types" aria-haspopup="dialog" aria-label="Share link: Value Types"> Share link </button> </h3>The <code>Value</code> type supports all GQL value types: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-zig" data-lang="zig">const Value = @import("types").Value; // Primitive types const null_val = Value.initNull(); const bool_val = Value.initBool(true); const int_val = Value.initInt(42); const float_val = Value.initFloat(3.14159); const str_val = Value.initString("hello"); const bytes_val = Value.initBytes(&[_]u8{0x01, 0x02, 0x03}); // Temporal types const date = Value.initDate(2025, 1, 24); const time = Value.initTime(14, 30, 45); const timestamp = Value.initTimestamp(date.date, time.time); // Collections const arr = Value.initArray(&[_]Value{ int_val, str_val }); // Type checking if (int_val.isInt()) { const i = try int_val.asInt(); std.debug.print("Integer value: {}\n", .{i}); } // JSON conversion const json = try value.toJson(allocator); defer json.deinit(); const back = Value.fromJson(json.value); </code></pre></div> <h4 id="supported-types" class="position-relative d-flex align-items-center group"> Supported 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="supported-types" aria-haspopup="dialog" aria-label="Share link: Supported Types"> Share link </button> </h4><table> <thead> <tr> <th>Type</th> <th>Constructor</th> <th>Accessor</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>null</code></td> <td><code>initNull()</code></td> <td><code>isNull()</code></td> <td>Null value</td> </tr> <tr> <td><code>boolean</code></td> <td><code>initBool(bool)</code></td> <td><code>asBool()</code></td> <td>Boolean</td> </tr> <tr> <td><code>integer</code></td> <td><code>initInt(i64)</code></td> <td><code>asInt()</code></td> <td>64-bit integer</td> </tr> <tr> <td><code>float</code></td> <td><code>initFloat(f64)</code></td> <td><code>asFloat()</code></td> <td>64-bit float</td> </tr> <tr> <td><code>string</code></td> <td><code>initString([]const u8)</code></td> <td><code>asString()</code></td> <td>UTF-8 string</td> </tr> <tr> <td><code>bytes</code></td> <td><code>initBytes([]const u8)</code></td> <td><code>asBytes()</code></td> <td>Binary data</td> </tr> <tr> <td><code>array</code></td> <td><code>initArray([]Value)</code></td> <td><code>asArray()</code></td> <td>Array of values</td> </tr> <tr> <td><code>object</code></td> <td>-</td> <td><code>asObject()</code></td> <td>Key-value map</td> </tr> <tr> <td><code>date</code></td> <td><code>initDate(year, month, day)</code></td> <td><code>asDate()</code></td> <td>Date</td> </tr> <tr> <td><code>time</code></td> <td><code>initTime(hour, min, sec)</code></td> <td><code>asTime()</code></td> <td>Time</td> </tr> <tr> <td><code>timestamp</code></td> <td><code>initTimestamp(date, time)</code></td> <td><code>asTimestamp()</code></td> <td>Date + time</td> </tr> <tr> <td><code>duration</code></td> <td><code>initDuration(days, secs)</code></td> <td><code>asDuration()</code></td> <td>Duration</td> </tr> <tr> <td><code>node</code></td> <td>-</td> <td><code>asNode()</code></td> <td>Graph node</td> </tr> <tr> <td><code>relationship</code></td> <td>-</td> <td><code>asRelationship()</code></td> <td>Graph edge</td> </tr> <tr> <td><code>path</code></td> <td>-</td> <td><code>asPath()</code></td> <td>Graph path</td> </tr> </tbody> </table> <h3 id="query-builder" class="position-relative d-flex align-items-center group"> Query Builder <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-builder" aria-haspopup="dialog" aria-label="Share link: Query Builder"> Share link </button> </h3>Build GQL queries programmatically with type safety: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-zig" data-lang="zig">const QueryBuilder = @import("query_builder").QueryBuilder; var qb = QueryBuilder.init(allocator); defer qb.deinit(); _ = try qb.match("(p:Person)"); _ = try qb.where("p.age >= $minAge"); _ = try qb.ret("p.name, p.age"); _ = try qb.orderBy("p.name"); _ = try qb.limit(10); _ = try qb.param("minAge", Value.initInt(21)); const query = try qb.build(); defer allocator.free(query); // Result: "MATCH (p:Person) WHERE p.age >= $minAge RETURN p.name, p.age ORDER BY p.name LIMIT 10" </code></pre></div> <h4 id="available-clauses" class="position-relative d-flex align-items-center group"> Available Clauses <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="available-clauses" aria-haspopup="dialog" aria-label="Share link: Available Clauses"> Share link </button> </h4><table> <thead> <tr> <th>Method</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>match(pattern)</code></td> <td>MATCH clause</td> </tr> <tr> <td><code>optionalMatch(pattern)</code></td> <td>OPTIONAL MATCH clause</td> </tr> <tr> <td><code>where(condition)</code></td> <td>WHERE clause</td> </tr> <tr> <td><code>with(expressions)</code></td> <td>WITH clause</td> </tr> <tr> <td><code>ret(expressions)</code></td> <td>RETURN clause</td> </tr> <tr> <td><code>orderBy(expressions)</code></td> <td>ORDER BY clause</td> </tr> <tr> <td><code>skip(n)</code></td> <td>SKIP clause</td> </tr> <tr> <td><code>limit(n)</code></td> <td>LIMIT clause</td> </tr> <tr> <td><code>create(pattern)</code></td> <td>CREATE clause</td> </tr> <tr> <td><code>merge(pattern)</code></td> <td>MERGE clause</td> </tr> <tr> <td><code>delete(expressions)</code></td> <td>DELETE clause</td> </tr> <tr> <td><code>detachDelete(expressions)</code></td> <td>DETACH DELETE clause</td> </tr> <tr> <td><code>set(assignments)</code></td> <td>SET clause</td> </tr> <tr> <td><code>remove(items)</code></td> <td>REMOVE clause</td> </tr> <tr> <td><code>raw(clause)</code></td> <td>Raw GQL clause</td> </tr> <tr> <td><code>param(name, value)</code></td> <td>Add parameter</td> </tr> </tbody> </table> <h3 id="pattern-builder" class="position-relative d-flex align-items-center group"> Pattern Builder <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="pattern-builder" aria-haspopup="dialog" aria-label="Share link: Pattern Builder"> Share link </button> </h3>Build graph patterns for MATCH clauses: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-zig" data-lang="zig">const PatternBuilder = @import("query_builder").PatternBuilder; var pb = PatternBuilder.init(allocator); defer pb.deinit(); _ = try pb.nodeLabel("a", "Person"); _ = try pb.edgeRight("KNOWS"); _ = try pb.nodeLabel("b", "Person"); const pattern = try pb.build(); defer allocator.free(pattern); // Result: "(a:Person)-[:KNOWS]->(b:Person)" </code></pre></div> <h4 id="pattern-methods" class="position-relative d-flex align-items-center group"> Pattern Methods <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="pattern-methods" aria-haspopup="dialog" aria-label="Share link: Pattern Methods"> Share link </button> </h4><table> <thead> <tr> <th>Method</th> <th>Description</th> <th>Example</th> </tr> </thead> <tbody> <tr> <td><code>nodeVar(name)</code></td> <td>Node with variable</td> <td><code>(n)</code></td> </tr> <tr> <td><code>nodeLabel(var, label)</code></td> <td>Node with label</td> <td><code>(n:Person)</code></td> </tr> <tr> <td><code>edgeRight(type)</code></td> <td>Outgoing edge</td> <td><code>-[:KNOWS]-></code></td> </tr> <tr> <td><code>edgeLeft(type)</code></td> <td>Incoming edge</td> <td><code><-[:KNOWS]-</code></td> </tr> <tr> <td><code>relRight(var, type, props)</code></td> <td>Outgoing with var</td> <td><code>-[r:KNOWS]-></code></td> </tr> <tr> <td><code>relLeft(var, type, props)</code></td> <td>Incoming with var</td> <td><code><-[r:KNOWS]-</code></td> </tr> <tr> <td><code>relUndirected(var, type, props)</code></td> <td>Undirected edge</td> <td><code>-[:CONNECTED]-</code></td> </tr> </tbody> </table> <h3 id="predicate-builder" class="position-relative d-flex align-items-center group"> Predicate Builder <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="predicate-builder" aria-haspopup="dialog" aria-label="Share link: Predicate Builder"> Share link </button> </h3>Build WHERE conditions: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-zig" data-lang="zig">const PredicateBuilder = @import("query_builder").PredicateBuilder; var pb = PredicateBuilder.init(allocator); defer pb.deinit(); _ = try pb.gt("n.age", "minAge"); _ = try pb.andOp(); _ = try pb.isNotNull("n.email"); _ = try pb.orOp(); _ = try pb.contains("n.name", "searchTerm"); const predicate = try pb.build(); defer allocator.free(predicate); // Result: "n.age > $minAge AND n.email IS NOT NULL OR n.name CONTAINS $searchTerm" </code></pre></div> <h4 id="predicate-methods" class="position-relative d-flex align-items-center group"> Predicate Methods <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="predicate-methods" aria-haspopup="dialog" aria-label="Share link: Predicate Methods"> Share link </button> </h4><table> <thead> <tr> <th>Method</th> <th>Description</th> <th>Example</th> </tr> </thead> <tbody> <tr> <td><code>eq(prop, param)</code></td> <td>Equals</td> <td><code>n.x = $param</code></td> </tr> <tr> <td><code>neq(prop, param)</code></td> <td>Not equals</td> <td><code>n.x <> $param</code></td> </tr> <tr> <td><code>lt(prop, param)</code></td> <td>Less than</td> <td><code>n.x < $param</code></td> </tr> <tr> <td><code>lte(prop, param)</code></td> <td>Less or equal</td> <td><code>n.x <= $param</code></td> </tr> <tr> <td><code>gt(prop, param)</code></td> <td>Greater than</td> <td><code>n.x > $param</code></td> </tr> <tr> <td><code>gte(prop, param)</code></td> <td>Greater or equal</td> <td><code>n.x >= $param</code></td> </tr> <tr> <td><code>isNull(prop)</code></td> <td>Is null</td> <td><code>n.x IS NULL</code></td> </tr> <tr> <td><code>isNotNull(prop)</code></td> <td>Is not null</td> <td><code>n.x IS NOT NULL</code></td> </tr> <tr> <td><code>contains(prop, param)</code></td> <td>Contains string</td> <td><code>n.x CONTAINS $param</code></td> </tr> <tr> <td><code>startsWith(prop, param)</code></td> <td>Starts with</td> <td><code>n.x STARTS WITH $param</code></td> </tr> <tr> <td><code>endsWith(prop, param)</code></td> <td>Ends with</td> <td><code>n.x ENDS WITH $param</code></td> </tr> <tr> <td><code>in(prop, param)</code></td> <td>In list</td> <td><code>n.x IN $param</code></td> </tr> <tr> <td><code>andOp()</code></td> <td>AND operator</td> <td><code>AND</code></td> </tr> <tr> <td><code>orOp()</code></td> <td>OR operator</td> <td><code>OR</code></td> </tr> <tr> <td><code>raw(text)</code></td> <td>Raw predicate</td> <td>Custom text</td> </tr> </tbody> </table> <h3 id="connection-pool" class="position-relative d-flex align-items-center group"> Connection Pool <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-pool" aria-haspopup="dialog" aria-label="Share link: Connection Pool"> Share link </button> </h3>Manage connection pools for high-throughput workloads: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-zig" data-lang="zig">const Pool = @import("pool").Pool; const PoolConfig = @import("pool").PoolConfig; var pool_cfg = PoolConfig.init(); _ = pool_cfg.withMinSize(5); _ = pool_cfg.withMaxSize(20); _ = pool_cfg.withAcquireTimeout(30000); _ = pool_cfg.withIdleTimeout(300000); var pool = Pool(ConnectionType).init(allocator, client_config, pool_cfg); defer pool.deinit(); // Acquire connection const conn = try pool.acquire(); defer pool.release(conn); // Use connection... // Get statistics const stats = pool.getStats(); std.debug.print("Active: {}, Idle: {}\n", .{ stats.active_connections, stats.idle_connections, }); </code></pre></div> <h4 id="pool-configuration" class="position-relative d-flex align-items-center group"> Pool Configuration <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-configuration" aria-haspopup="dialog" aria-label="Share link: Pool Configuration"> Share link </button> </h4><table> <thead> <tr> <th>Option</th> <th>Type</th> <th>Default</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>min_size</code></td> <td><code>u32</code></td> <td><code>1</code></td> <td>Minimum pool size</td> </tr> <tr> <td><code>max_size</code></td> <td><code>u32</code></td> <td><code>10</code></td> <td>Maximum pool size</td> </tr> <tr> <td><code>acquire_timeout_ms</code></td> <td><code>u32</code></td> <td><code>30000</code></td> <td>Timeout for acquiring connection</td> </tr> <tr> <td><code>idle_timeout_ms</code></td> <td><code>u32</code></td> <td><code>300000</code></td> <td>Idle connection timeout</td> </tr> <tr> <td><code>health_check_interval_ms</code></td> <td><code>u32</code></td> <td><code>30000</code></td> <td>Health check interval</td> </tr> </tbody> </table> <h3 id="input-validation" class="position-relative d-flex align-items-center group"> Input Validation <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="input-validation" aria-haspopup="dialog" aria-label="Share link: Input Validation"> Share link </button> </h3>Validate user input for security: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-zig" data-lang="zig">const validate = @import("validate"); // Validate query string try validate.query("MATCH (n) RETURN n"); // Validate parameter name try validate.paramName("myParam"); // Validate hostname try validate.hostname("db.example.com"); // Validate port try validate.port(3141); // Validate page size (1-100,000) try validate.pageSize(500); // Check IP addresses const is_v4 = validate.ipv4("192.168.1.1"); const is_v6 = validate.isIpv6("::1"); // Sanitize input (removes control characters) const clean = try validate.sanitize(allocator, "input\x00with\x01control\x02chars"); defer allocator.free(clean); </code></pre></div> <h4 id="validation-errors" class="position-relative d-flex align-items-center group"> Validation 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="validation-errors" aria-haspopup="dialog" aria-label="Share link: Validation Errors"> Share link </button> </h4><table> <thead> <tr> <th>Error</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>QueryEmpty</code></td> <td>Query string is empty</td> </tr> <tr> <td><code>QueryTooLong</code></td> <td>Query exceeds 1MB limit</td> </tr> <tr> <td><code>QueryContainsNull</code></td> <td>Query contains null bytes</td> </tr> <tr> <td><code>ParamNameEmpty</code></td> <td>Parameter name is empty</td> </tr> <tr> <td><code>ParamNameInvalid</code></td> <td>Invalid parameter name format</td> </tr> <tr> <td><code>ParamNameTooLong</code></td> <td>Parameter name exceeds 256 chars</td> </tr> <tr> <td><code>HostnameEmpty</code></td> <td>Hostname is empty</td> </tr> <tr> <td><code>HostnameInvalid</code></td> <td>Invalid hostname characters</td> </tr> <tr> <td><code>HostnameTooLong</code></td> <td>Hostname exceeds 253 chars</td> </tr> <tr> <td><code>PortOutOfRange</code></td> <td>Port not in 1-65535 range</td> </tr> <tr> <td><code>PageSizeOutOfRange</code></td> <td>Page size not in 1-100,000 range</td> </tr> </tbody> </table> <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 client uses ISO GQL status codes: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-zig" data-lang="zig">const GeodeError = @import("error").GeodeError; // Create errors const conn_err = GeodeError.connection("connection refused"); const syntax_err = GeodeError.syntax("unexpected token at position 42"); const query_err = GeodeError.query("invalid property access", "22003"); // Check error properties if (err.isRetryable()) { // Retry the operation } // Get status category const category = err.statusCategory(); switch (category) { .connection => { // Handle connection error }, .syntax_error => { // Handle syntax error }, .data_exception => { // Handle data error }, .transaction => { // Handle transaction error }, else => { // Handle other errors }, } // Get formatted message std.debug.print("Error: {s}\n", .{err.message}); std.debug.print("Code: {s}\n", .{err.status_code}); </code></pre></div> <h4 id="status-code-categories" class="position-relative d-flex align-items-center group"> Status Code Categories <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="status-code-categories" aria-haspopup="dialog" aria-label="Share link: Status Code Categories"> Share link </button> </h4><table> <thead> <tr> <th>Code Range</th> <th>Category</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>00xxx</code></td> <td>Success</td> <td>Operation succeeded</td> </tr> <tr> <td><code>08xxx</code></td> <td>Connection</td> <td>Connection errors</td> </tr> <tr> <td><code>22xxx</code></td> <td>Data</td> <td>Data exceptions</td> </tr> <tr> <td><code>25xxx</code></td> <td>Transaction</td> <td>Transaction state errors</td> </tr> <tr> <td><code>28xxx</code></td> <td>Authorization</td> <td>Auth errors</td> </tr> <tr> <td><code>42xxx</code></td> <td>Syntax</td> <td>Query syntax errors</td> </tr> </tbody> </table> <h3 id="wire-protocol" class="position-relative d-flex align-items-center group"> Wire Protocol <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="wire-protocol" aria-haspopup="dialog" aria-label="Share link: Wire Protocol"> Share link </button> </h3>The client uses Protobuf wire protocol over QUIC: Client Messages: <ul> <li><code>HELLO</code> - Connection handshake</li> <li><code>RUN_GQL</code> - Execute GQL query</li> <li><code>PULL</code> - Fetch results</li> <li><code>BEGIN</code>/<code>COMMIT</code>/<code>ROLLBACK</code> - Transaction control</li> <li><code>PING</code> - Keep-alive</li> </ul> Server Responses: <ul> <li><code>HELLO_ACK</code> - Handshake acknowledgment</li> <li><code>SCHEMA</code> - Query schema</li> <li><code>BINDINGS</code> - Result rows</li> <li><code>ERROR</code> - Error details</li> <li><code>SUCCESS</code> - Operation success</li> </ul> <h3 id="performance" class="position-relative d-flex align-items-center group"> Performance <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" aria-haspopup="dialog" aria-label="Share link: Performance"> Share link </button> </h3>The client is optimized for high performance: <ul> <li>Connection establishment: ~2ms with connection pooling</li> <li>Query execution: <1ms for simple queries</li> <li>Value serialization: Nanosecond-level JSON conversion</li> <li>Memory efficiency: Zero-copy where possible</li> </ul> <h4 id="quic-system-optimizations" class="position-relative d-flex align-items-center group"> QUIC System Optimizations <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="quic-system-optimizations" aria-haspopup="dialog" aria-label="Share link: QUIC System Optimizations"> Share link </button> </h4>For optimal throughput, configure UDP buffer sizes at the OS level. Linux: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash">sudo sysctl -w net.core.rmem_max=7340032 sudo sysctl -w net.core.wmem_max=7340032 # Persist across reboots echo "net.core.rmem_max=7340032" | sudo tee -a /etc/sysctl.d/99-geode-quic.conf echo "net.core.wmem_max=7340032" | sudo tee -a /etc/sysctl.d/99-geode-quic.conf </code></pre></div>BSD/macOS: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash">sudo sysctl -w kern.ipc.maxsockbuf=8441037 </code></pre></div>GSO (Generic Segmentation Offload): Available on Linux 4.18+, batches UDP packets to reduce syscall overhead. Path MTU Discovery (DPLPMTUD): Enabled by default, probes for optimal packet sizes. <h3 id="building-and-testing" class="position-relative d-flex align-items-center group"> Building and 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="building-and-testing" aria-haspopup="dialog" aria-label="Share link: Building and Testing"> Share link </button> </h3><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Build debug version make build # Build release version make release # Clean build artifacts make clean # Run unit tests make test # Run integration tests (requires Geode server) make test-integration # Run integration tests with Docker make test-integration-docker # Run property-based/fuzz tests make test-fuzz # Run benchmarks make bench # Run full CI pipeline make ci # Format code make fmt </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="memory-management" class="position-relative d-flex align-items-center group"> Memory 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="memory-management" aria-haspopup="dialog" aria-label="Share link: Memory Management"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-zig" data-lang="zig">// Good: Use defer for cleanup var qb = QueryBuilder.init(allocator); defer qb.deinit(); // Good: Use errdefer for cleanup on error paths const result = allocator.alloc(u8, size) catch |err| { return err; }; errdefer allocator.free(result); </code></pre></div> <h4 id="error-handling-1" 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-1" aria-haspopup="dialog" aria-label="Share link: Error Handling"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-zig" data-lang="zig">// Good: Handle errors explicitly const value = try client.sendQuery(query); defer allocator.free(value); // Good: Check retryable errors if (err.isRetryable()) { // Implement retry logic with backoff } </code></pre></div> <h4 id="resource-cleanup" class="position-relative d-flex align-items-center group"> Resource Cleanup <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="resource-cleanup" aria-haspopup="dialog" aria-label="Share link: Resource Cleanup"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-zig" data-lang="zig">// Good: Always pair init with deinit var client = geode.GeodeClient.init(allocator, "localhost", 3141, true); defer client.deinit(); // Good: Free allocations const response = try client.receiveMessage(30000); defer allocator.free(response); </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/zig/" >Zig</a> </li> <li><a href="/tags/client-libraries/" >Client Libraries</a> </li> <li><a href="/tags/quic/" >QUIC Protocol</a> </li> <li><a href="/tags/systems/" >Systems Programming</a> </li> <li><a href="/tags/connection-pooling/" >Connection Pooling</a> </li> <li><a href="/tags/performance/" >Performance</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://ziglang.org/documentation/" aria-label="Zig Documentation – opens in new window" target="_blank" rel="noopener noreferrer" >Zig Documentation ↗ </a> </li> <li><a href="https://www.rfc-editor.org/rfc/rfc9000.html" aria-label="QUIC Protocol RFC 9000 – opens in new window" target="_blank" rel="noopener noreferrer" >QUIC Protocol RFC 9000 ↗ </a> </li> <li><a href="https://www.iso.org/standard/76120.html" aria-label="ISO/IEC 39075:2024 GQL Standard – opens in new window" target="_blank" rel="noopener noreferrer" >ISO/IEC 39075:2024 GQL Standard ↗ </a> </li> <li><a href="https://gitlab.com/devnw/geode/geode-client-zig" aria-label="Zig Client Repository – opens in new window" target="_blank" rel="noopener noreferrer" >Zig Client Repository ↗ </a> </li> <li><a href="/docs/" >Geode Documentation</a> </li> </ul>

Popular

Related Articles