psqlpy-python.github.io/index.html at gh-pages · psqlpy-python/psqlpy-python.github.io · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
<!doctype html>
<html lang="en-US" data-theme="light">
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width,initial-scale=1" />
    <meta name="generator" content="VuePress 2.0.0-rc.24" />
    <meta name="theme" content="VuePress Theme Hope 2.0.0-rc.94" />
    <style>
      :root {
        --vp-c-bg: #fff;
      }

      [data-theme="dark"] {
        --vp-c-bg: #1b1b1f;
      }

      html,
      body {
        background: var(--vp-c-bg);
      }
    </style>
    <script>
      const userMode = localStorage.getItem("vuepress-theme-hope-scheme");
      const systemDarkMode =
        window.matchMedia &&
        window.matchMedia("(prefers-color-scheme: dark)").matches;

      if (userMode === "dark" || (userMode !== "light" && systemDarkMode)) {
        document.documentElement.setAttribute("data-theme", "dark");
      }
    </script>
    <script type="application/ld+json">{"@context":"https://schema.org","@type":"WebPage","name":"PSQLPy documentation","description":"What is PSQLPy PSQLPy is a Python driver for PostgreSQL fully written in Rust. It was inspired by Psycopg3 and AsyncPG. This project has two main goals: We found that communicat..."}</script><meta property="og:url" content="https://psqlpy-python.github.io/"><meta property="og:site_name" content="PSQLPy"><meta property="og:title" content="PSQLPy documentation"><meta property="og:description" content="What is PSQLPy PSQLPy is a Python driver for PostgreSQL fully written in Rust. It was inspired by Psycopg3 and AsyncPG. This project has two main goals: We found that communicat..."><meta property="og:type" content="website"><meta property="og:locale" content="en-US"><meta property="og:updated_time" content="2025-11-15T15:32:15.000Z"><meta property="article:modified_time" content="2025-11-15T15:32:15.000Z"><title>PSQLPy documentation | PSQLPy</title><meta name="description" content="What is PSQLPy PSQLPy is a Python driver for PostgreSQL fully written in Rust. It was inspired by Psycopg3 and AsyncPG. This project has two main goals: We found that communicat...">
    <link rel="preload" href="/assets/style-hpmdeGFM.css" as="style"><link rel="stylesheet" href="/assets/style-hpmdeGFM.css">
    <link rel="modulepreload" href="/assets/app-BJBVPPAe.js"><link rel="modulepreload" href="/assets/index.html-B7xfPA6C.js"><link rel="modulepreload" href="/assets/plugin-vue_export-helper-DlAUqK2U.js">
    <link rel="prefetch" href="/assets/benchmarks.html-XvT7GCrc.js" as="script"><link rel="prefetch" href="/assets/contribute.html-BXJ-9LQ1.js" as="script"><link rel="prefetch" href="/assets/external_connection_pools.html-CqsYHnZG.js" as="script"><link rel="prefetch" href="/assets/faq.html-Cy903nbL.js" as="script"><link rel="prefetch" href="/assets/components_overview.html-Cqfjfrqt.js" as="script"><link rel="prefetch" href="/assets/connection.html-DV68IEcs.js" as="script"><link rel="prefetch" href="/assets/connection_pool.html-B5IU0d9-.js" as="script"><link rel="prefetch" href="/assets/connection_pool_builder.html-DJMTA1VL.js" as="script"><link rel="prefetch" href="/assets/cursor.html-DC8_sf9r.js" as="script"><link rel="prefetch" href="/assets/exceptions.html-BKwNZa3D.js" as="script"><link rel="prefetch" href="/assets/listener.html-i2epqj4y.js" as="script"><link rel="prefetch" href="/assets/prepared_statement.html-jgLcjdNo.js" as="script"><link rel="prefetch" href="/assets/results.html-DXVE80j4.js" as="script"><link rel="prefetch" href="/assets/transaction.html-Dyx4frez.js" as="script"><link rel="prefetch" href="/assets/opentelemetry.html-B5bMl5aB.js" as="script"><link rel="prefetch" href="/assets/sqlalchemy.html-nbcuweLJ.js" as="script"><link rel="prefetch" href="/assets/taskiq.html-BQ5k1d44.js" as="script"><link rel="prefetch" href="/assets/components_overview.html-BqPZvmN7.js" as="script"><link rel="prefetch" href="/assets/introduction.html-g0P9iHVH.js" as="script"><link rel="prefetch" href="/assets/lets_start.html-D7fZCsVZ.js" as="script"><link rel="prefetch" href="/assets/parameters.html-DhO-Vnmi.js" as="script"><link rel="prefetch" href="/assets/usage.html-D4OHk65q.js" as="script"><link rel="prefetch" href="/assets/aiohttp.html-CeBGFP5E.js" as="script"><link rel="prefetch" href="/assets/blacksheep.html-ByIPXX6L.js" as="script"><link rel="prefetch" href="/assets/fastapi.html-WV8w1RLJ.js" as="script"><link rel="prefetch" href="/assets/frameworks.html-DAVJRyYE.js" as="script"><link rel="prefetch" href="/assets/litestar.html-BtHBFUek.js" as="script"><link rel="prefetch" href="/assets/panther.html-D0UwE2BT.js" as="script"><link rel="prefetch" href="/assets/robyn.html-C1vjm3C9.js" as="script"><link rel="prefetch" href="/assets/predefined_row_factories.html-DSXzG7VG.js" as="script"><link rel="prefetch" href="/assets/row_factories.html-cTz2Fq5W.js" as="script"><link rel="prefetch" href="/assets/advanced_type_usage.html-CN7LzzNh.js" as="script"><link rel="prefetch" href="/assets/array_types.html-BJtenIdP.js" as="script"><link rel="prefetch" href="/assets/extra_types.html-DErVZ3s4.js" as="script"><link rel="prefetch" href="/assets/supported_types.html-DE1zseKt.js" as="script"><link rel="prefetch" href="/assets/types.html-CyvN6qBW.js" as="script"><link rel="prefetch" href="/assets/404.html-CPKW9PXY.js" as="script"><link rel="prefetch" href="/assets/index.html-C8J0gDJl.js" as="script"><link rel="prefetch" href="/assets/index.html-CE9Cnagz.js" as="script"><link rel="prefetch" href="/assets/index.html-DovmRe7b.js" as="script"><link rel="prefetch" href="/assets/index.html-B_u-_zRf.js" as="script"><link rel="prefetch" href="/assets/index.html-C01-ACbw.js" as="script"><link rel="prefetch" href="/assets/index.html-BEtZbfRk.js" as="script"><link rel="prefetch" href="/assets/index.html-DzpN7D2a.js" as="script"><link rel="prefetch" href="/assets/auto-BUYG9-ss.js" as="script"><link rel="prefetch" href="/assets/mermaid.esm.min-RDSSbasT.js" as="script"><link rel="prefetch" href="/assets/photoswipe.esm-CKV1Bsxh.js" as="script"><link rel="prefetch" href="/assets/SearchResult-BzZHaDk8.js" as="script">
  </head>
  <body>
    <div id="app"><!--[--><!--[--><!--[--><span tabindex="-1"></span><a href="#main-content" class="vp-skip-link sr-only">Skip to main content</a><!--]--><!--[--><div class="theme-container no-sidebar external-link-icon" vp-container><!--[--><header id="navbar" class="vp-navbar" vp-navbar><div class="vp-navbar-start"><button type="button" class="vp-toggle-sidebar-button" title="Toggle Sidebar"><span class="icon"></span></button><!--[--><a class="route-link vp-brand" href="/" aria-label="Take me home"><!----><!----><span class="vp-site-name">PSQLPy</span></a><!--]--></div><div class="vp-navbar-center"><!--[--><!----><!--]--></div><div class="vp-navbar-end"><!--[--><!----><div class="vp-nav-item vp-action"><a class="vp-action-link" href="https://github.com/psqlpy-python/psqlpy" target="_blank" rel="noopener noreferrer" aria-label="GitHub"><svg xmlns="http://www.w3.org/2000/svg" class="icon github-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="github icon" name="github" style="width:1.25rem;height:1.25rem;vertical-align:middle;"><path d="M511.957 21.333C241.024 21.333 21.333 240.981 21.333 512c0 216.832 140.544 400.725 335.574 465.664 24.49 4.395 32.256-10.07 32.256-23.083 0-11.69.256-44.245 0-85.205-136.448 29.61-164.736-64.64-164.736-64.64-22.315-56.704-54.4-71.765-54.4-71.765-44.587-30.464 3.285-29.824 3.285-29.824 49.195 3.413 75.179 50.517 75.179 50.517 43.776 75.008 114.816 53.333 142.762 40.79 4.523-31.66 17.152-53.377 31.19-65.537-108.971-12.458-223.488-54.485-223.488-242.602 0-53.547 19.114-97.323 50.517-131.67-5.035-12.33-21.93-62.293 4.779-129.834 0 0 41.258-13.184 134.912 50.346a469.803 469.803 0 0 1 122.88-16.554c41.642.213 83.626 5.632 122.88 16.554 93.653-63.488 134.784-50.346 134.784-50.346 26.752 67.541 9.898 117.504 4.864 129.834 31.402 34.347 50.474 78.123 50.474 131.67 0 188.586-114.73 230.016-224.042 242.09 17.578 15.232 33.578 44.672 33.578 90.454v135.85c0 13.142 7.936 27.606 32.854 22.87C862.25 912.597 1002.667 728.747 1002.667 512c0-271.019-219.648-490.667-490.71-490.667z"></path></svg></a></div><div class="vp-nav-item hide-in-mobile"><button type="button" class="vp-color-mode-switch" id="color-mode-switch"><svg xmlns="http://www.w3.org/2000/svg" class="icon auto-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="auto icon" name="auto" style="display:block;"><path d="M512 992C246.92 992 32 777.08 32 512S246.92 32 512 32s480 214.92 480 480-214.92 480-480 480zm0-840c-198.78 0-360 161.22-360 360 0 198.84 161.22 360 360 360s360-161.16 360-360c0-198.78-161.22-360-360-360zm0 660V212c165.72 0 300 134.34 300 300 0 165.72-134.28 300-300 300z"></path></svg><svg xmlns="http://www.w3.org/2000/svg" class="icon dark-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="dark icon" name="dark" style="display:none;"><path d="M524.8 938.667h-4.267a439.893 439.893 0 0 1-313.173-134.4 446.293 446.293 0 0 1-11.093-597.334A432.213 432.213 0 0 1 366.933 90.027a42.667 42.667 0 0 1 45.227 9.386 42.667 42.667 0 0 1 10.24 42.667 358.4 358.4 0 0 0 82.773 375.893 361.387 361.387 0 0 0 376.747 82.774 42.667 42.667 0 0 1 54.187 55.04 433.493 433.493 0 0 1-99.84 154.88 438.613 438.613 0 0 1-311.467 128z"></path></svg><svg xmlns="http://www.w3.org/2000/svg" class="icon light-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="light icon" name="light" style="display:none;"><path d="M952 552h-80a40 40 0 0 1 0-80h80a40 40 0 0 1 0 80zM801.88 280.08a41 41 0 0 1-57.96-57.96l57.96-58a41.04 41.04 0 0 1 58 58l-58 57.96zM512 752a240 240 0 1 1 0-480 240 240 0 0 1 0 480zm0-560a40 40 0 0 1-40-40V72a40 40 0 0 1 80 0v80a40 40 0 0 1-40 40zm-289.88 88.08-58-57.96a41.04 41.04 0 0 1 58-58l57.96 58a41 41 0 0 1-57.96 57.96zM192 512a40 40 0 0 1-40 40H72a40 40 0 0 1 0-80h80a40 40 0 0 1 40 40zm30.12 231.92a41 41 0 0 1 57.96 57.96l-57.96 58a41.04 41.04 0 0 1-58-58l58-57.96zM512 832a40 40 0 0 1 40 40v80a40 40 0 0 1-80 0v-80a40 40 0 0 1 40-40zm289.88-88.08 58 57.96a41.04 41.04 0 0 1-58 58l-57.96-58a41 41 0 0 1 57.96-57.96z"></path></svg></button></div><!--[--><button type="button" class="slimsearch-button" aria-label="Search"><svg xmlns="http://www.w3.org/2000/svg" class="icon search-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="search icon"><path d="M192 480a256 256 0 1 1 512 0 256 256 0 0 1-512 0m631.776 362.496-143.2-143.168A318.464 318.464 0 0 0 768 480c0-176.736-143.264-320-320-320S128 303.264 128 480s143.264 320 320 320a318.016 318.016 0 0 0 184.16-58.592l146.336 146.368c12.512 12.48 32.768 12.48 45.28 0 12.48-12.512 12.48-32.768 0-45.28"></path></svg><div class="slimsearch-placeholder">Search</div><div class="slimsearch-key-hints"><kbd class="slimsearch-key">Ctrl</kbd><kbd class="slimsearch-key">K</kbd></div></button><!--]--><!--]--><button type="button" class="vp-toggle-navbar-button" aria-label="Toggle Navbar" aria-expanded="false" aria-controls="nav-screen"><span><span class="vp-top"></span><span class="vp-middle"></span><span class="vp-bottom"></span></span></button></div></header><!----><!--]--><!----><div class="toggle-sidebar-wrapper"><span class="arrow start"></span></div><!----><!--[--><main id="main-content" class="vp-page vp-project-home" aria-labelledby="main-title"><!----><header class="vp-hero-info-wrapper" style=""><!--[--><!----><!----><!--]--><div class="vp-hero-info"><!--[--><img class="vp-hero-image" style="" src="/./logo.png" alt><!--]--><div class="vp-hero-infos"><h1 id="main-title" class="vp-hero-title">PSQLPy</h1><div id="main-description">Asynchronous Python PostgreSQL driver written in Rust</div><p class="vp-hero-actions"><a class="route-link auto-link vp-hero-action primary no-external-link-icon" href="/introduction/lets_start.html" aria-label="Let&#39;s start"><!---->Let&#39;s start<!----></a><a class="route-link auto-link vp-hero-action default no-external-link-icon" href="/introduction/introduction.html" aria-label="What is PSQLPy?"><!---->What is PSQLPy?<!----></a></p></div></div><!----></header><!----><!--[--><div class="vp-feature-wrapper"><!----><!----><div class="vp-feature" style=""><!--[--><!----><!----><!--]--><!--[--><!----><!----><!--]--><div class="vp-features"><div class="vp-feature-item"><h3 class="vp-feature-title"><!----><span>Fully Asynchronous</span></h3><div class="vp-feature-details">Support native rust/python asynchronous. It's easy as it seems.</div></div><div class="vp-feature-item"><h3 class="vp-feature-title"><!----><span>Fully Typed</span></h3><div class="vp-feature-details">PSQLPy has type for each class, function, method and etc.</div></div><div class="vp-feature-item"><h3 class="vp-feature-title"><!----><span>Blazingly Fast</span></h3><div class="vp-feature-details">PSQLPy beats others PostgreSQL drivers in different benchmarks.</div></div><div class="vp-feature-item"><h3 class="vp-feature-title"><!----><span>Under active development</span></h3><div class="vp-feature-details">PSQLPy is under active development.</div></div></div></div></div><!--]--><div class="" vp-content><!----><div id="markdown-content"><h2 id="what-is-psqlpy" tabindex="-1"><a class="header-anchor" href="#what-is-psqlpy"><span>What is PSQLPy</span></a></h2><p><code>PSQLPy</code> is a Python driver for <code>PostgreSQL</code> fully written in Rust. It was inspired by <code>Psycopg3</code> and <code>AsyncPG</code>. This project has two main goals: We found that communication with the database can be faster and safer, so we tried to implement a new PostgreSQL driver in Rust for Python.</p><p>It has all necessary components to create high-load and fault tolerance applications.</p><h2 id="how-to-install" tabindex="-1"><a class="header-anchor" href="#how-to-install"><span>How to install</span></a></h2><div class="vp-tabs"><div class="vp-tabs-nav" role="tablist"><button type="button" class="vp-tab-nav active" role="tab" aria-controls="v-0" aria-selected="true">pip</button><button type="button" class="vp-tab-nav" role="tab" aria-controls="v-1" aria-selected="false">poetry</button><button type="button" class="vp-tab-nav" role="tab" aria-controls="v-2" aria-selected="false">git</button></div><!--[--><div class="vp-tab active" id="v-0" role="tabpanel" aria-expanded="true"><div class="vp-tab-title">pip</div><!--[--><div class="language-bash line-numbers-mode" data-highlighter="shiki" data-ext="bash" style="--shiki-light:#383A42;--shiki-dark:#abb2bf;--shiki-light-bg:#FAFAFA;--shiki-dark-bg:#282c34;"><pre class="shiki shiki-themes one-light one-dark-pro vp-code"><code class="language-bash"><span class="line"><span style="--shiki-light:#4078F2;--shiki-dark:#61AFEF;">pip</span><span style="--shiki-light:#50A14F;--shiki-dark:#98C379;"> install</span><span style="--shiki-light:#50A14F;--shiki-dark:#98C379;"> psqlpy</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><!--]--></div><div class="vp-tab" id="v-1" role="tabpanel" aria-expanded="false"><div class="vp-tab-title">poetry</div><!--[--><div class="language-bash line-numbers-mode" data-highlighter="shiki" data-ext="bash" style="--shiki-light:#383A42;--shiki-dark:#abb2bf;--shiki-light-bg:#FAFAFA;--shiki-dark-bg:#282c34;"><pre class="shiki shiki-themes one-light one-dark-pro vp-code"><code class="language-bash"><span class="line"><span style="--shiki-light:#4078F2;--shiki-dark:#61AFEF;">poetry</span><span style="--shiki-light:#50A14F;--shiki-dark:#98C379;"> add</span><span style="--shiki-light:#50A14F;--shiki-dark:#98C379;"> psqlpy</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><!--]--></div><div class="vp-tab" id="v-2" role="tabpanel" aria-expanded="false"><div class="vp-tab-title">git</div><!--[--><div class="language-bash line-numbers-mode" data-highlighter="shiki" data-ext="bash" style="--shiki-light:#383A42;--shiki-dark:#abb2bf;--shiki-light-bg:#FAFAFA;--shiki-dark-bg:#282c34;"><pre class="shiki shiki-themes one-light one-dark-pro vp-code"><code class="language-bash"><span class="line"><span style="--shiki-light:#4078F2;--shiki-dark:#61AFEF;">pip</span><span style="--shiki-light:#50A14F;--shiki-dark:#98C379;"> install</span><span style="--shiki-light:#50A14F;--shiki-dark:#98C379;"> git+https://github.com/psqlpy-python/psqlpy</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><!--]--></div><!--]--></div><h2 id="join-community" tabindex="-1"><a class="header-anchor" href="#join-community"><span>Join community!</span></a></h2><p>You can get support from the creators and users of <code>PSQLPy</code> in some social media:</p><ul><li><a href="https://t.me/+f3Y8mYKgXxhmYThi" target="_blank" rel="noopener noreferrer">Telegram</a></li><li><a href="https://discord.gg/ugNhzmhZ" target="_blank" rel="noopener noreferrer">Discord</a></li></ul></div><!----><!----><!----></div></main><!--]--><!----></div><!--]--><!--]--><!--[--><!----><!----><!--[--><!--]--><!--]--><!--]--></div>
    <script type="module" src="/assets/app-BJBVPPAe.js" defer></script>
  </body>
</html>