-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathindex.html
More file actions
41 lines (38 loc) · 18.5 KB
/
Copy pathindex.html
File metadata and controls
41 lines (38 loc) · 18.5 KB
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":"Usage"}</script><meta property="og:url" content="https://psqlpy-python.github.io/usage/"><meta property="og:site_name" content="PSQLPy"><meta property="og:title" content="Usage"><meta property="og:type" content="website"><meta property="og:locale" content="en-US"><title>Usage | PSQLPy</title><meta name="description" content="PSQLPy Documentation">
<link rel="preload" href="/assets/style-hpmdeGFM.css" as="style"><link rel="stylesheet" href="/assets/style-hpmdeGFM.css">
<link rel="modulepreload" href="/assets/app-CfZZDGa8.js"><link rel="modulepreload" href="/assets/index.html-DvV9qJQ7.js"><link rel="modulepreload" href="/assets/plugin-vue_export-helper-DlAUqK2U.js">
<link rel="prefetch" href="/assets/index.html-C8gb1D6Z.js" as="script"><link rel="prefetch" href="/assets/benchmarks.html-CLOJxJDU.js" as="script"><link rel="prefetch" href="/assets/contribute.html-CTEPkL-k.js" as="script"><link rel="prefetch" href="/assets/external_connection_pools.html-BErpcgU-.js" as="script"><link rel="prefetch" href="/assets/faq.html-k0Wp9Bd4.js" as="script"><link rel="prefetch" href="/assets/components_overview.html-BHC70q59.js" as="script"><link rel="prefetch" href="/assets/connection.html-DKG_4mIb.js" as="script"><link rel="prefetch" href="/assets/connection_pool.html-B8R7MRRE.js" as="script"><link rel="prefetch" href="/assets/connection_pool_builder.html-BReP_Dk5.js" as="script"><link rel="prefetch" href="/assets/copy.html-CvhIt9vN.js" as="script"><link rel="prefetch" href="/assets/cursor.html-Jhsh29S2.js" as="script"><link rel="prefetch" href="/assets/exceptions.html-o6WQvDRv.js" as="script"><link rel="prefetch" href="/assets/listener.html-CVlBeIzP.js" as="script"><link rel="prefetch" href="/assets/prepared_statement.html-B9QaV2al.js" as="script"><link rel="prefetch" href="/assets/results.html-NABtQVAG.js" as="script"><link rel="prefetch" href="/assets/transaction.html-ClwRBays.js" as="script"><link rel="prefetch" href="/assets/opentelemetry.html-ChbUPxXT.js" as="script"><link rel="prefetch" href="/assets/sqlalchemy.html-DMYgKm2X.js" as="script"><link rel="prefetch" href="/assets/taskiq.html-ZXxdT_ib.js" as="script"><link rel="prefetch" href="/assets/components_overview.html-P0hmPr_g.js" as="script"><link rel="prefetch" href="/assets/introduction.html-CDNnLPX7.js" as="script"><link rel="prefetch" href="/assets/lets_start.html-BrAtQ444.js" as="script"><link rel="prefetch" href="/assets/parameters.html-Cy6o1wEj.js" as="script"><link rel="prefetch" href="/assets/usage.html-D-3f57mg.js" as="script"><link rel="prefetch" href="/assets/predefined_row_factories.html-D9TD6_gt.js" as="script"><link rel="prefetch" href="/assets/row_factories.html-CxGUzmzn.js" as="script"><link rel="prefetch" href="/assets/advanced_type_usage.html-Cx1drllN.js" as="script"><link rel="prefetch" href="/assets/array_types.html-PWpnQg1O.js" as="script"><link rel="prefetch" href="/assets/extra_types.html-BHXnmVLk.js" as="script"><link rel="prefetch" href="/assets/supported_types.html-CWY3Cmof.js" as="script"><link rel="prefetch" href="/assets/types.html-C9WnPRnM.js" as="script"><link rel="prefetch" href="/assets/aiohttp.html-4A4u0vJz.js" as="script"><link rel="prefetch" href="/assets/blacksheep.html-_qq__GhQ.js" as="script"><link rel="prefetch" href="/assets/fastapi.html-BHn38J0M.js" as="script"><link rel="prefetch" href="/assets/frameworks.html-DEFf6orD.js" as="script"><link rel="prefetch" href="/assets/litestar.html-B2Na4q-F.js" as="script"><link rel="prefetch" href="/assets/panther.html-Dw9-8CAe.js" as="script"><link rel="prefetch" href="/assets/robyn.html-C9GGOWyV.js" as="script"><link rel="prefetch" href="/assets/404.html-CEncPzTT.js" as="script"><link rel="prefetch" href="/assets/index.html-B5kYgYaQ.js" as="script"><link rel="prefetch" href="/assets/index.html-CoUUVbxy.js" as="script"><link rel="prefetch" href="/assets/index.html-CMuhmfR7.js" as="script"><link rel="prefetch" href="/assets/index.html-HGIxOLw2.js" as="script"><link rel="prefetch" href="/assets/index.html-B8TKE_uK.js" as="script"><link rel="prefetch" href="/assets/index.html-BvC6Ff0h.js" as="script"><link rel="prefetch" href="/assets/auto-BUYG9-ss.js" as="script"><link rel="prefetch" href="/assets/mermaid.esm.min-CsY1VEJK.js" as="script"><link rel="prefetch" href="/assets/photoswipe.esm-CKV1Bsxh.js" as="script"><link rel="prefetch" href="/assets/SearchResult-CXx6b_MY.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 external-link-icon has-toc" 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><aside id="sidebar" class="vp-sidebar" vp-sidebar><!----><ul class="vp-sidebar-links"><li><a class="route-link auto-link vp-sidebar-link" href="/" aria-label="PSQLPy documentation"><!--[--><iconify-icon class="vp-icon" icon="home" sizing="both" width="1em" height="1em"></iconify-icon><!--]-->PSQLPy documentation<!----></a></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><!----><span class="vp-sidebar-title">The PSQLPy</span><span class="vp-arrow end"></span></button><!----></section></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><!----><span class="vp-sidebar-title">Components Overview</span><span class="vp-arrow end"></span></button><!----></section></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable active" type="button"><!----><span class="vp-sidebar-title">Usage</span><span class="vp-arrow down"></span></button><ul class="vp-sidebar-links"><li><a class="route-link auto-link vp-sidebar-link" href="/usage/parameters.html" aria-label="Passing parameters to SQL queries"><!---->Passing parameters to SQL queries<!----></a></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><!----><span class="vp-sidebar-title">Types</span><span class="vp-arrow end"></span></button><!----></section></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><!----><span class="vp-sidebar-title">Row Factories Usage</span><span class="vp-arrow end"></span></button><!----></section></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><!----><span class="vp-sidebar-title">Frameworks Usage</span><span class="vp-arrow end"></span></button><!----></section></li></ul></section></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><!----><span class="vp-sidebar-title">Integrations</span><span class="vp-arrow end"></span></button><!----></section></li><li><a class="route-link auto-link vp-sidebar-link" href="/external_connection_pools.html" aria-label="External connection pools"><!---->External connection pools<!----></a></li><li><a class="route-link auto-link vp-sidebar-link" href="/contribute.html" aria-label="Contribution guide"><!---->Contribution guide<!----></a></li><li><a class="route-link auto-link vp-sidebar-link" href="/benchmarks.html" aria-label="Benchmarks"><!---->Benchmarks<!----></a></li><li><a class="route-link auto-link vp-sidebar-link" href="/faq.html" aria-label="FAQ"><!---->FAQ<!----></a></li></ul><!----></aside><!--[--><main id="main-content" class="vp-page"><!--[--><!----><!----><nav class="vp-breadcrumb disable"></nav><div class="vp-page-title"><h1><!---->Usage</h1><div class="page-info"><!----><!----><!----><!----><!----><!----><!----></div><hr></div><!----><div class="" vp-content><!----><div id="markdown-content"><div class="vp-catalog"><h2 class="vp-catalog-main-title">Catalog</h2><ul class="vp-catalog-list deep"><li class="vp-catalog-item"><h3 id="Frameworks" class="vp-catalog-child-title has-children"><a href="#Frameworks" class="vp-catalog-header-anchor" aria-hidden="true"></a><a class="route-link vp-catalog-title" href="/usage/frameworks/">Frameworks</a></h3><ul class="vp-child-catalogs"><li class="vp-child-catalog"><div class="vp-catalog-sub-title"><a href="#AioHTTP" class="vp-catalog-header-anchor"></a><a class="route-link vp-catalog-title" href="/usage/frameworks/aiohttp.html">AioHTTP</a></div><!----></li><li class="vp-child-catalog"><div class="vp-catalog-sub-title"><a href="#Blacksheep" class="vp-catalog-header-anchor"></a><a class="route-link vp-catalog-title" href="/usage/frameworks/blacksheep.html">Blacksheep</a></div><!----></li><li class="vp-child-catalog"><div class="vp-catalog-sub-title"><a href="#FastAPI" class="vp-catalog-header-anchor"></a><a class="route-link vp-catalog-title" href="/usage/frameworks/fastapi.html">FastAPI</a></div><!----></li><li class="vp-child-catalog"><div class="vp-catalog-sub-title"><a href="#Framework Usage" class="vp-catalog-header-anchor"></a><a class="route-link vp-catalog-title" href="/usage/frameworks/frameworks.html">Framework Usage</a></div><!----></li><li class="vp-child-catalog"><div class="vp-catalog-sub-title"><a href="#Litestar" class="vp-catalog-header-anchor"></a><a class="route-link vp-catalog-title" href="/usage/frameworks/litestar.html">Litestar</a></div><!----></li><li class="vp-child-catalog"><div class="vp-catalog-sub-title"><a href="#Panther" class="vp-catalog-header-anchor"></a><a class="route-link vp-catalog-title" href="/usage/frameworks/panther.html">Panther</a></div><!----></li><li class="vp-child-catalog"><div class="vp-catalog-sub-title"><a href="#Robyn" class="vp-catalog-header-anchor"></a><a class="route-link vp-catalog-title" href="/usage/frameworks/robyn.html">Robyn</a></div><!----></li></ul></li><li class="vp-catalog-item"><h3 id="Passing parameters to SQL queries" class="vp-catalog-child-title"><a href="#Passing parameters to SQL queries" class="vp-catalog-header-anchor" aria-hidden="true"></a><a class="route-link vp-catalog-title" href="/usage/parameters.html">Passing parameters to SQL queries</a></h3><!----></li><li class="vp-catalog-item"><h3 id="Row Factories" class="vp-catalog-child-title has-children"><a href="#Row Factories" class="vp-catalog-header-anchor" aria-hidden="true"></a><a class="route-link vp-catalog-title" href="/usage/row_factories/">Row Factories</a></h3><ul class="vp-child-catalogs"><li class="vp-child-catalog"><div class="vp-catalog-sub-title"><a href="#Predefined row factories" class="vp-catalog-header-anchor"></a><a class="route-link vp-catalog-title" href="/usage/row_factories/predefined_row_factories.html">Predefined row factories</a></div><!----></li><li class="vp-child-catalog"><div class="vp-catalog-sub-title"><a href="#Row Factories Usage" class="vp-catalog-header-anchor"></a><a class="route-link vp-catalog-title" href="/usage/row_factories/row_factories.html">Row Factories Usage</a></div><!----></li></ul></li><li class="vp-catalog-item"><h3 id="Types" class="vp-catalog-child-title has-children"><a href="#Types" class="vp-catalog-header-anchor" aria-hidden="true"></a><a class="route-link vp-catalog-title" href="/usage/types/">Types</a></h3><ul class="vp-child-catalogs"><li class="vp-child-catalog"><div class="vp-catalog-sub-title"><a href="#Advanced Type Usage" class="vp-catalog-header-anchor"></a><a class="route-link vp-catalog-title" href="/usage/types/advanced_type_usage.html">Advanced Type Usage</a></div><!----></li><li class="vp-child-catalog"><div class="vp-catalog-sub-title"><a href="#Array Types (Deprecated)" class="vp-catalog-header-anchor"></a><a class="route-link vp-catalog-title" href="/usage/types/array_types.html">Array Types (Deprecated)</a></div><!----></li><li class="vp-child-catalog"><div class="vp-catalog-sub-title"><a href="#Extra Types" class="vp-catalog-header-anchor"></a><a class="route-link vp-catalog-title" href="/usage/types/extra_types.html">Extra Types</a></div><!----></li><li class="vp-child-catalog"><div class="vp-catalog-sub-title"><a href="#Supported Types" class="vp-catalog-header-anchor"></a><a class="route-link vp-catalog-title" href="/usage/types/supported_types.html">Supported Types</a></div><!----></li><li class="vp-child-catalog"><div class="vp-catalog-sub-title"><a href="#Types Description" class="vp-catalog-header-anchor"></a><a class="route-link vp-catalog-title" href="/usage/types/types.html">Types Description</a></div><!----></li></ul></li><li class="vp-catalog-item"><h3 id="Usage" class="vp-catalog-child-title"><a href="#Usage" class="vp-catalog-header-anchor" aria-hidden="true"></a><a class="route-link vp-catalog-title" href="/usage/usage.html">Usage</a></h3><!----></li></ul></div></div><!----><!----><!----></div><footer class="vp-page-meta"><!----><div class="vp-meta-item git-info"><!----><!----></div></footer><nav class="vp-page-nav"><a class="route-link auto-link prev" href="/components/" aria-label="Components Overview"><div class="hint"><span class="arrow start"></span>Prev</div><div class="link"><!---->Components Overview</div></a><!----></nav><!----><!----><!--]--></main><!--]--><!----></div><!--]--><!--]--><!--[--><!----><!----><!--[--><!--]--><!--]--><!--]--></div>
<script type="module" src="/assets/app-CfZZDGa8.js" defer></script>
</body>
</html>