Files
supabase/apps/studio/components/interfaces/Settings/Database/PoolingModesModal.tsx
Alaister Young 5f533247e1 Update docs url to env var (#38772)
* Update Supabase docs URLs to use env variable

Co-authored-by: a <a@alaisteryoung.com>

* Refactor: Use DOCS_URL constant for documentation links

This change centralizes documentation links using a new DOCS_URL constant, improving maintainability and consistency.

Co-authored-by: a <a@alaisteryoung.com>

* Refactor: Use DOCS_URL constant for all documentation links

This change replaces hardcoded documentation URLs with a centralized constant, improving maintainability and consistency.

Co-authored-by: a <a@alaisteryoung.com>

* replace more instances

* ci: Autofix updates from GitHub workflow

* remaining instances

* fix duplicate useRouter

---------

Co-authored-by: Cursor Agent <cursoragent@cursor.com>
Co-authored-by: alaister <10985857+alaister@users.noreply.github.com>
2025-09-26 10:16:33 +00:00

113 lines
4.7 KiB
TypeScript

import { AlertTriangleIcon } from 'lucide-react'
import { useParams } from 'common'
import { Markdown } from 'components/interfaces/Markdown'
import { DocsButton } from 'components/ui/DocsButton'
import { useSupavisorConfigurationQuery } from 'data/database/supavisor-configuration-query'
import { DOCS_URL } from 'lib/constants'
import { useDatabaseSelectorStateSnapshot } from 'state/database-selector'
import { useDatabaseSettingsStateSnapshot } from 'state/database-settings'
import {
AlertDescription_Shadcn_,
AlertTitle_Shadcn_,
Alert_Shadcn_,
Button,
Dialog,
DialogClose,
DialogContent,
DialogDescription,
DialogFooter,
DialogHeader,
DialogSection,
DialogSectionSeparator,
DialogTitle,
} from 'ui'
export const PoolingModesModal = () => {
const { ref: projectRef } = useParams()
const snap = useDatabaseSettingsStateSnapshot()
const state = useDatabaseSelectorStateSnapshot()
const { data } = useSupavisorConfigurationQuery({ projectRef: projectRef })
const primaryConfig = data?.find((x) => x.identifier === state.selectedDatabaseId)
const navigateToPoolerSettings = () => {
const el = document.getElementById('connection-pooler')
if (el) el.scrollIntoView({ behavior: 'smooth', block: 'center' })
}
return (
<Dialog open={snap.showPoolingModeHelper} onOpenChange={snap.setShowPoolingModeHelper}>
<DialogContent hideClose className="sm:max-w-4xl">
<DialogHeader>
<DialogTitle>
<div className="w-full flex items-center justify-between">
<p className="max-w-2xl">Which pooling mode should I use?</p>
<DocsButton
href={`${DOCS_URL}/guides/database/connecting-to-postgres#how-connection-pooling-works`}
/>
</div>
</DialogTitle>
<DialogDescription className="max-w-2xl">
A connection pooler is a system (external to Postgres) which manages Postgres
connections by allocating connections whenever clients make requests.
</DialogDescription>
</DialogHeader>
<DialogSectionSeparator />
<DialogSection>
<Markdown
className="max-w-full [&>h3]:text-sm"
content={`
Each pooling mode handles connections differently.
### Transaction mode
This mode is recommended if you are connecting from *serverless environments*. A connection is assigned to the client for the duration of a transaction. Two consecutive transactions from the same client could be executed over two different connections. Some session-based Postgres features such as prepared statements are *not available* with this option.
### Session mode
This mode is similar to connecting to your database directly. There is full support for prepared statements in this mode. When a new client connects, a connection is assigned to the client until it disconnects. You *might run into pooler connection limits* since the connection is held till the client disconnects.
### Using session and transaction modes at the same time
${
primaryConfig?.pool_mode === 'transaction'
? 'You can use the session mode connection string (port 5432) and transaction mode connection string (port 6543) in your application.'
: 'To get the best of both worlds, as a starting point, we recommend using session mode just when you need support for prepared statements and transaction mode in other cases.'
}
`}
/>
</DialogSection>
{primaryConfig?.pool_mode === 'session' && (
<div className="px-6">
<Alert_Shadcn_ variant="warning">
<AlertTriangleIcon strokeWidth={2} />
<AlertTitle_Shadcn_>
Pooling mode is currently configured to use session mode
</AlertTitle_Shadcn_>
<AlertDescription_Shadcn_>
To use transaction mode concurrently with session mode, change the pooling mode to
transaction first in the{' '}
<span
tabIndex={0}
className="text-foreground cursor-pointer underline underline-offset-2"
onClick={() => {
snap.setShowPoolingModeHelper(false)
navigateToPoolerSettings()
}}
>
connection pooling settings
</span>
. After this, you can use transaction mode on port 6543 and session mode on port
5432.
</AlertDescription_Shadcn_>
</Alert_Shadcn_>
</div>
)}
<DialogFooter>
<DialogClose onClick={() => snap.setShowPoolingModeHelper(false)}>
<Button type="default">Close</Button>
</DialogClose>
</DialogFooter>
</DialogContent>
</Dialog>
)
}