Python Client | Geode Database

<h2 id="python-client-library" class="position-relative d-flex align-items-center group"> Python 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="python-client-library" aria-haspopup="dialog" aria-label="Share link: Python 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 Python client for Geode provides an async/await API built on aioquic for QUIC + TLS 1.3 transport. Use the <code>Client</code> factory to create <code>Connection</code> instances, or use <code>ConnectionPool</code> for concurrent workloads. <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">pip install geode-client </code></pre></div>Requirements: Python 3.11+ <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-python" data-lang="python">import asyncio from geode_client import Client async def main(): client = Client(host="localhost", port=3141) async with client.connection() as conn: page, _ = await conn.query( "MATCH (p:Person) RETURN p.name AS name, p.age AS age" ) for row in page.rows: print(f"{row['name'].as_string}: {row['age'].as_int}") if __name__ == "__main__": asyncio.run(main()) </code></pre></div> <h3 id="connection-configuration" class="position-relative d-flex align-items-center group"> Connection 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="connection-configuration" aria-haspopup="dialog" aria-label="Share link: Connection Configuration"> Share link </button> </h3> <h4 id="client-and-connection" class="position-relative d-flex align-items-center group"> Client and Connection <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="client-and-connection" aria-haspopup="dialog" aria-label="Share link: Client and Connection"> Share link </button> </h4><code>Client</code> is a factory; <code>Connection</code> is the async context manager that runs queries. <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python">from geode_client import Client client = Client( host="localhost", port=3141, page_size=1000, hello_name="geode-python", hello_ver="0.1.0", conformance="min", ca_cert="/path/to/ca.pem", client_cert="/path/to/client.crt", client_key="/path/to/client.key", skip_verify=False, server_name="geode.internal", ) async with client.connection() as conn: page, _ = await conn.query("RETURN 1 AS ok") </code></pre></div> <h4 id="url-helper" class="position-relative d-flex align-items-center group"> URL Helper <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="url-helper" aria-haspopup="dialog" aria-label="Share link: URL Helper"> Share link </button> </h4>Use <code>open_database</code> with <code>quic://</code> URLs when you prefer a single string. <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python">from geode_client import open_database client = open_database("quic://localhost:3141?insecure_tls_skip_verify=true&page_size=500") async with client.connection() as conn: page, _ = await conn.query("RETURN 1 AS ok") </code></pre></div> <h4 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> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python">from geode_client import ConnectionPool pool = ConnectionPool( host="localhost", port=3141, min_size=2, max_size=10, timeout=30.0, page_size=1000, skip_verify=True, ) async with pool: async with pool.acquire() as conn: page, _ = await conn.query("MATCH (n) RETURN count(n) AS count") print(page.rows[0]["count"].as_int) </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="basic-queries" class="position-relative d-flex align-items-center group"> Basic 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="basic-queries" aria-haspopup="dialog" aria-label="Share link: Basic Queries"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python">page, _ = await conn.query("MATCH (n:Person) RETURN n LIMIT 10") page, _ = await conn.query( "MATCH (p:Person {name: $name}) RETURN p", params={"name": "Alice"}, ) </code></pre></div> <h4 id="pagination" class="position-relative d-flex align-items-center group"> Pagination <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="pagination" aria-haspopup="dialog" aria-label="Share link: Pagination"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python">page, pager = await conn.query("MATCH (p:Person) RETURN p", page_size=100) for row in page.rows: print(row["p"].as_object) async for next_page in pager(): for row in next_page.rows: print(row["p"].as_object) </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>The Python client exposes explicit transaction methods on <code>Connection</code>. <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python">await conn.begin() try: await conn.execute( "CREATE (:Person {name: $name, age: $age})", params={"name": "Alice", "age": 30}, ) await conn.execute( "CREATE (:Person {name: $name, age: $age})", params={"name": "Bob", "age": 25}, ) await conn.commit() except Exception: await conn.rollback() raise </code></pre></div> <h4 id="savepoints" class="position-relative d-flex align-items-center group"> Savepoints <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="savepoints" aria-haspopup="dialog" aria-label="Share link: Savepoints"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python">await conn.begin() try: await conn.execute("CREATE (:Person {name: 'Alice'})") sp = await conn.savepoint("before_risky_op") try: await conn.execute("CREATE (:Invalid)") except Exception: await conn.rollback_to(sp) await conn.commit() except Exception: await conn.rollback() raise </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-python" data-lang="python">stmt = await conn.prepare("MATCH (p:Person {name: $name}) RETURN p") async with stmt: page, _ = await stmt.execute({"name": "Alice"}) page2, _ = await stmt.execute({"name": "Bob"}) </code></pre></div> <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><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python">from geode_client import QueryBuilder query, params = ( QueryBuilder() .match("(p:Person)") .where("p.age >= $min_age") .return_("p.name AS name", "p.age AS age") .order_by("p.age DESC") .limit(10) .with_param("min_age", 21) .build() ) page, _ = await conn.query(query, params=params) </code></pre></div> <h3 id="explain-and-profile" class="position-relative d-flex align-items-center group"> EXPLAIN and PROFILE <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="explain-and-profile" aria-haspopup="dialog" aria-label="Share link: EXPLAIN and PROFILE"> Share link </button> </h3><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python">plan = await conn.explain("MATCH (p:Person) RETURN p") profile = await conn.profile("MATCH (p:Person) RETURN p") </code></pre></div> <h3 id="authentication-helpers" class="position-relative d-flex align-items-center group"> Authentication Helpers <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="authentication-helpers" aria-haspopup="dialog" aria-label="Share link: Authentication Helpers"> Share link </button> </h3>Use <code>AuthClient</code> for RBAC and RLS operations. <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python">from geode_client import AuthClient async with client.connection() as conn: auth = AuthClient(conn) session = await auth.login("admin", "secret") print(session.token) </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>Results are returned as <code>Value</code> objects with typed accessors. <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python">from geode_client import Value page, _ = await conn.query("RETURN 42 AS answer") value: Value = page.rows[0]["answer"] print(value.as_int) </code></pre></div><table> <thead> <tr> <th>GQL Type</th> <th>Python Value</th> <th>Notes</th> </tr> </thead> <tbody> <tr> <td>INT</td> <td><code>Value</code></td> <td><code>value.as_int</code></td> </tr> <tr> <td>DECIMAL / FLOAT</td> <td><code>Value</code></td> <td><code>value.as_decimal</code></td> </tr> <tr> <td>STRING</td> <td><code>Value</code></td> <td><code>value.as_string</code></td> </tr> <tr> <td>BOOL</td> <td><code>Value</code></td> <td><code>value.as_bool</code></td> </tr> <tr> <td>LIST</td> <td><code>Value</code></td> <td><code>value.as_array</code></td> </tr> <tr> <td>MAP</td> <td><code>Value</code></td> <td><code>value.as_object</code></td> </tr> <tr> <td>NODE</td> <td><code>Value</code></td> <td>Returned as object map</td> </tr> <tr> <td>EDGE</td> <td><code>Value</code></td> <td>Returned as object map</td> </tr> <tr> <td>PATH</td> <td><code>Value</code></td> <td>Returned as object map</td> </tr> </tbody> </table> <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-python" aria-label="devnw/codepros/geode/geode-client-python – opens in new window" target="_blank" rel="noopener noreferrer" >devnw/codepros/geode/geode-client-python ↗ </a> </li> <li>PyPI: <a href="https://pypi.org/project/geode-client/" aria-label="geode-client – opens in new window" target="_blank" rel="noopener noreferrer" >geode-client ↗ </a> </li> </ul>