Files
supabase/apps/studio/components/interfaces/Settings/Database/PoolingModesModal.tsx
T
Joshen Lim 4e039c9bf5 Remove config cat flag for read replicas (#21587)
* Remove config cat flag for read replicas

* Remove
2024-02-27 13:14:21 +08:00

117 lines
5.2 KiB
TypeScript

import { useParams } from 'common'
import { AlertTriangleIcon } from 'lucide-react'
import {
AlertDescription_Shadcn_,
AlertTitle_Shadcn_,
Alert_Shadcn_,
Button,
DialogClose_Shadcn_,
DialogContent_Shadcn_,
DialogDescription_Shadcn_,
DialogFooter_Shadcn_,
DialogHeader_Shadcn_,
DialogTitle_Shadcn_,
Dialog_Shadcn_,
IconExternalLink,
} from 'ui'
import { Markdown } from 'components/interfaces/Markdown'
import { useProjectContext } from 'components/layouts/ProjectLayout/ProjectContext'
import { usePoolingConfigurationQuery } from 'data/database/pooling-configuration-query'
import { useDatabaseSelectorStateSnapshot } from 'state/database-selector'
import { useDatabaseSettingsStateSnapshot } from 'state/database-settings'
export const PoolingModesModal = () => {
const { ref: projectRef } = useParams()
const { project } = useProjectContext()
const snap = useDatabaseSettingsStateSnapshot()
const state = useDatabaseSelectorStateSnapshot()
const readReplicasEnabled = project?.is_read_replicas_enabled
const { data } = usePoolingConfigurationQuery({ projectRef: projectRef })
const primaryConfig = readReplicasEnabled
? data?.find((x) => x.identifier === state.selectedDatabaseId)
: data?.find((x) => x.database_type === 'PRIMARY')
const navigateToPoolerSettings = () => {
const el = document.getElementById('connection-pooler')
if (el) el.scrollIntoView({ behavior: 'smooth', block: 'center' })
}
return (
<Dialog_Shadcn_ open={snap.showPoolingModeHelper} onOpenChange={snap.setShowPoolingModeHelper}>
<DialogContent_Shadcn_ className="sm:max-w-4xl">
<DialogHeader_Shadcn_ className="pr-8">
<DialogTitle_Shadcn_ className="mb-4">
<div className="w-full flex items-center justify-between">
<p className="text-lg max-w-2xl">Which pooling mode should I use?</p>
<Button asChild type="default" icon={<IconExternalLink strokeWidth={1.5} />}>
<a
href="https://supabase.com/docs/guides/database/connecting-to-postgres#how-connection-pooling-works"
target="_blank"
rel="noreferrer"
>
Documentation
</a>
</Button>
</div>
</DialogTitle_Shadcn_>
<DialogDescription_Shadcn_ className="border-b pb-4 ">
<p className="text-lg max-w-2xl">
A connection pooler is a system (external to Postgres) which manages Postgres
connections by allocating connections whenever clients make requests.
</p>
</DialogDescription_Shadcn_>
</DialogHeader_Shadcn_>
<Markdown
className="px-6 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.'
}
`}
/>
{primaryConfig?.pool_mode === 'session' && (
<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_>
)}
<DialogFooter_Shadcn_>
<DialogClose_Shadcn_ onClick={() => snap.setShowPoolingModeHelper(false)}>
<Button type="secondary">Close</Button>
</DialogClose_Shadcn_>
</DialogFooter_Shadcn_>
</DialogContent_Shadcn_>
</Dialog_Shadcn_>
)
}