Skip to content

The Postgres development platform. Supabase gives you a dedicated Postgres database to build your web, mobile, and AI applications.

Add cancel query action for database connections (#48922)

Joshen Limcdfb5b310faa
diff --git a/apps/studio/components/interfaces/Observability/DatabaseConnections/ActivityRow.tsx b/apps/studio/components/interfaces/Observability/DatabaseConnections/ActivityRow.tsx
index ee10aafd1d2..24822f519a2 100644
--- a/apps/studio/components/interfaces/Observability/DatabaseConnections/ActivityRow.tsx
+++ b/apps/studio/components/interfaces/Observability/DatabaseConnections/ActivityRow.tsx
@@ -1,4 +1,4 @@
-import { ChevronRight, Minus, MoreVertical, StopCircle } from 'lucide-react'
+import { ChevronRight, CircleX, Minus, MoreVertical, StopCircle } from 'lucide-react'
import { parseAsInteger, parseAsString, useQueryState } from 'nuqs'
import { Fragment, useState } from 'react'
import { toast } from 'sonner'
@@ -17,6 +17,7 @@ import {
copyToClipboard,
DropdownMenu,
DropdownMenuContent,
+ DropdownMenuSeparator,
DropdownMenuTrigger,
HoverCard,
HoverCardContent,
@@ -27,6 +28,7 @@ import {
TooltipContent,
TooltipTrigger,
} from 'ui'
+import { Admonition } from 'ui-patterns/Admonition'
import { CodeBlock } from 'ui-patterns/CodeBlock'
import {
@@ -45,7 +47,8 @@ import { DropdownMenuItemTooltip } from '@/components/ui/DropdownMenuItemTooltip
import { InlineLinkClassName } from '@/components/ui/InlineLink'
import { useDatabaseRolesQuery } from '@/data/database-roles/database-roles-query'
import { useDatabaseActivityQuery, type DatabaseActivity } from '@/data/database/activity-query'
-import { useQueryAbortMutation } from '@/data/sql/abort-query-mutation'
+import { useQueryCancelMutation } from '@/data/sql/cancel-query-mutation'
+import { useSessionTerminateMutation } from '@/data/sql/terminate-session-mutation'
import { useSelectedProjectQuery } from '@/hooks/misc/useSelectedProject'
import { formatSql } from '@/lib/formatSql'
import { useTrack } from '@/lib/telemetry/track'
@@ -120,9 +123,13 @@ export const ActivityRow = ({
})
const superuserRoles = roles?.filter((role) => role.isSuperuser).map((role) => role.name)
- const { mutateAsync: abortQuery } = useQueryAbortMutation({
+ const { mutateAsync: cancelQuery } = useQueryCancelMutation({
+ onError: () => {}, // [Joshen] Error handled at call site
+ })
+
+ const { mutateAsync: terminateSession } = useSessionTerminateMutation({
onSuccess: () => {
- toast.success(`Successfully aborted query (ID: ${activity.pid})`)
+ toast.success(`Successfully terminated session (ID: ${activity.pid})`)
},
})
@@ -140,11 +147,41 @@ export const ActivityRow = ({
activity.state === 'idle in transaction (aborted)') &&
durationSeconds >= WARN_DURATION_IDLE_TXN))
+ const onCancelQuery = async () => {
+ const isBlocking = (data ?? []).some((x) => x.blocked_by.includes(activity.pid))
+ track('query_cancel_button_clicked', {
+ activityState: activity.state,
+ isBlocking,
+ })
+
+ const toastId = toast.loading(`Cancelling query (ID: ${activity.pid})`)
+ try {
+ await cancelQuery({
+ pid: activity.pid,
+ projectRef: project?.ref,
+ connectionString: project?.connectionString,
+ })
+ toast.success(`Successfully cancelled query (ID: ${activity.pid})`, { id: toastId })
+ } catch (error) {
+ const errorMessage = error instanceof Error ? error.message : 'Unknown error'
+ toast.error(`Failed to cancel query: ${errorMessage}`, { id: toastId })
+ }
+ }
+
+ const onSelectTerminate = () => {
+ const isBlocking = (data ?? []).some((x) => x.blocked_by.includes(activity.pid))
+ track('session_terminate_button_clicked', {
+ activityState: activity.state,
+ isBlocking,
+ })
+ setShowTerminateConfirmDialog(true)
+ }
+
const onConfirmTerminate = async () => {
const isBlocking = (data ?? []).some((x) => x.blocked_by.includes(activity.pid))
track('session_terminate_submitted', { activityState: activity.state, isBlocking })
try {
- await abortQuery({
+ await terminateSession({
pid: activity.pid,
projectRef: project?.ref,
connectionString: project?.connectionString,
@@ -394,24 +431,39 @@ export const ActivityRow = ({
<DropdownMenuContent align="end" className="w-44">
<DropdownMenuItemTooltip
className="gap-x-2"
- disabled={superuserRoles?.includes(activity.role_name)}
- onClick={() => {
- const isBlocking = (data ?? []).some((x) => x.blocked_by.includes(activity.pid))
- track('session_terminate_button_clicked', {
- activityState: activity.state,
- isBlocking,
- })
- setShowTerminateConfirmDialog(true)
+ disabled={
+ activity.state !== 'active' || superuserRoles?.includes(activity.role_name)
+ }
+ onClick={onCancelQuery}
+ tooltip={{
+ content: {
+ side: 'left',
+ text:
+ activity.state !== 'active'
+ ? 'No running queries to cancel'
+ : 'Unable to terminate queries run by superuser roles',
+ },
}}
+ >
+ <CircleX size={12} />
+ <span>Cancel query</span>
+ </DropdownMenuItemTooltip>
+
+ <DropdownMenuSeparator />
+
+ <DropdownMenuItemTooltip
+ className="gap-x-2"
+ disabled={superuserRoles?.includes(activity.role_name)}
+ onClick={onSelectTerminate}
tooltip={{
content: {
side: 'left',
- text: 'Unable to terminate queries run by superuser roles',
+ text: 'Unable to terminate sessions owned by superuser roles',
},
}}
>
<StopCircle size={12} />
- <span>Terminate</span>
+ <span>Terminate session</span>
</DropdownMenuItemTooltip>
</DropdownMenuContent>
</DropdownMenu>
@@ -421,17 +473,33 @@ export const ActivityRow = ({
<AlertDialog open={showTerminateConfirmDialog} onOpenChange={setShowTerminateConfirmDialog}>
<AlertDialogContent>
<AlertDialogHeader>
- <AlertDialogTitle>Confirm to terminate this process?</AlertDialogTitle>
+ <AlertDialogTitle>Confirm to terminate this session?</AlertDialogTitle>
+ {activity.state === 'active' && (
+ <Admonition
+ type="warning"
+ className="border-x-0 rounded-none border-t-0"
+ title="This session is currently running a query"
+ description="Cancelling it may solve the problem without closing the connection."
+ />
+ )}
<AlertDialogDescription>
- This will force the query to stop running.
+ Ending this session will close its connection and roll back any open transaction. The
+ application will need to reconnect.
</AlertDialogDescription>
</AlertDialogHeader>
- <AlertDialogFooter>
- <AlertDialogCancel>Cancel</AlertDialogCancel>
- <AlertDialogAction variant="warning" onClick={onConfirmTerminate}>
- Terminate
- </AlertDialogAction>
+ <AlertDialogFooter className={cn(activity.state === 'active' && 'sm:justify-between')}>
+ <AlertDialogCancel>Back</AlertDialogCancel>
+ <div className="flex items-center gap-x-2">
+ {activity.state === 'active' && (
+ <AlertDialogAction variant="default" onClick={onCancelQuery}>
+ Cancel query
+ </AlertDialogAction>
+ )}
+ <AlertDialogAction variant="warning" onClick={onConfirmTerminate}>
+ Terminate
+ </AlertDialogAction>
+ </div>
</AlertDialogFooter>
</AlertDialogContent>
</AlertDialog>
diff --git a/apps/studio/components/interfaces/SQLEditor/OngoingQueriesPanel.tsx b/apps/studio/components/interfaces/SQLEditor/OngoingQueriesPanel.tsx
index 0dbb575183f..18a0ff6ce42 100644
--- a/apps/studio/components/interfaces/SQLEditor/OngoingQueriesPanel.tsx
+++ b/apps/studio/components/interfaces/SQLEditor/OngoingQueriesPanel.tsx
@@ -21,8 +21,8 @@ import ConfirmationModal from 'ui-patterns/Dialogs/ConfirmationModal'
import { AlertError } from '@/components/ui/AlertError'
import { useReadReplicasQuery } from '@/data/read-replicas/replicas-query'
-import { useQueryAbortMutation } from '@/data/sql/abort-query-mutation'
import { useOngoingQueriesQuery } from '@/data/sql/ongoing-queries-query'
+import { useSessionTerminateMutation } from '@/data/sql/terminate-session-mutation'
import { useSelectedProjectQuery } from '@/hooks/misc/useSelectedProject'
import { useUrlState } from '@/hooks/ui/useUrlState'
import { IS_PLATFORM } from '@/lib/constants'
@@ -67,9 +67,9 @@ export const OngoingQueriesPanel = () => {
}
}, [viewOngoingQueries])
- const { mutate: abortQuery, isPending } = useQueryAbortMutation({
+ const { mutate: terminateSession, isPending } = useSessionTerminateMutation({
onSuccess: () => {
- toast.success(`Successfully aborted query (ID: ${selectedId})`)
+ toast.success(`Successfully terminated session (ID: ${selectedId})`)
setSelectedId(undefined)
},
})
@@ -173,19 +173,22 @@ export const OngoingQueriesPanel = () => {
<ConfirmationModal
loading={isPending}
variant="warning"
- title={`Confirm to abort this query? (ID: ${selectedId})`}
+ title={`Confirm to terminate this session? (ID: ${selectedId})`}
visible={selectedId !== undefined}
onCancel={() => setSelectedId(undefined)}
onConfirm={() => {
if (selectedId !== undefined)
- abortQuery({
+ terminateSession({
pid: selectedId,
projectRef: project?.ref,
connectionString: database?.connectionString,
})
}}
>
- <p className="text-sm">This will force the query to stop running.</p>
+ <p className="text-sm">
+ Terminating this session will close its connection and roll back any open transaction. The
+ application will need to reconnect.
+ </p>
</ConfirmationModal>
</>
)
diff --git a/apps/studio/data/sql/abort-query-mutation.ts b/apps/studio/data/sql/cancel-query-mutation.ts
similarity index 55%
rename from apps/studio/data/sql/abort-query-mutation.ts
rename to apps/studio/data/sql/cancel-query-mutation.ts
index 3a1c3775812..e0fa00a9a16 100644
--- a/apps/studio/data/sql/abort-query-mutation.ts
+++ b/apps/studio/data/sql/cancel-query-mutation.ts
@@ -1,4 +1,4 @@
-import { getAbortQuerySQL } from '@supabase/pg-meta'
+import { getCancelQuerySQL } from '@supabase/pg-meta'
import { useMutation, useQueryClient } from '@tanstack/react-query'
import { toast } from 'sonner'
@@ -6,31 +6,36 @@ import { sqlKeys } from './keys'
import { executeSql } from '@/data/sql/execute-sql-mutation'
import type { ResponseError, UseCustomMutationOptions } from '@/types'
-export type QueryAbortVariables = {
+type QueryCancelVariables = {
pid: number
projectRef?: string
connectionString?: string | null
}
-export async function abortQuery({ pid, projectRef, connectionString }: QueryAbortVariables) {
- const sql = getAbortQuerySQL({ pid })
- const { result } = await executeSql({ projectRef, connectionString, sql })
+async function cancelQuery({ pid, projectRef, connectionString }: QueryCancelVariables) {
+ const sql = getCancelQuerySQL({ pid })
+ const { result } = await executeSql({
+ projectRef,
+ connectionString,
+ sql,
+ queryKey: ['cancel-query'],
+ })
return result
}
-type QueryAbortData = Awaited<ReturnType<typeof abortQuery>>
+type QueryCancelData = Awaited<ReturnType<typeof cancelQuery>>
-export const useQueryAbortMutation = ({
+export const useQueryCancelMutation = ({
onSuccess,
onError,
...options
}: Omit<
- UseCustomMutationOptions<QueryAbortData, ResponseError, QueryAbortVariables>,
+ UseCustomMutationOptions<QueryCancelData, ResponseError, QueryCancelVariables>,
'mutationFn'
> = {}) => {
const queryClient = useQueryClient()
- return useMutation<QueryAbortData, ResponseError, QueryAbortVariables>({
- mutationFn: (vars) => abortQuery(vars),
+ return useMutation<QueryCancelData, ResponseError, QueryCancelVariables>({
+ mutationFn: (vars) => cancelQuery(vars),
async onSuccess(data, variables, context) {
const { projectRef } = variables
await queryClient.invalidateQueries({ queryKey: sqlKeys.ongoingQueries(projectRef) })
@@ -38,7 +43,7 @@ export const useQueryAbortMutation = ({
},
async onError(data, variables, context) {
if (onError === undefined) {
- toast.error(`Failed to abort query: ${data.message}`)
+ toast.error(`Failed to cancel query: ${data.message}`)
} else {
onError(data, variables, context)
}
diff --git a/apps/studio/data/sql/terminate-session-mutation.ts b/apps/studio/data/sql/terminate-session-mutation.ts
new file mode 100644
index 00000000000..e90b35fad7a
--- /dev/null
+++ b/apps/studio/data/sql/terminate-session-mutation.ts
@@ -0,0 +1,57 @@
+import { getTerminateSessionSQL } from '@supabase/pg-meta'
+import { useMutation, useQueryClient } from '@tanstack/react-query'
+import { toast } from 'sonner'
+
+import { sqlKeys } from './keys'
+import { executeSql } from '@/data/sql/execute-sql-mutation'
+import type { ResponseError, UseCustomMutationOptions } from '@/types'
+
+type SessionTerminateVariables = {
+ pid: number
+ projectRef?: string
+ connectionString?: string | null
+}
+
+export async function terminateSession({
+ pid,
+ projectRef,
+ connectionString,
+}: SessionTerminateVariables) {
+ const sql = getTerminateSessionSQL({ pid })
+ const { result } = await executeSql({
+ projectRef,
+ connectionString,
+ sql,
+ queryKey: ['terminate-session'],
+ })
+ return result
+}
+
+type QueryAbortData = Awaited<ReturnType<typeof terminateSession>>
+
+export const useSessionTerminateMutation = ({
+ onSuccess,
+ onError,
+ ...options
+}: Omit<
+ UseCustomMutationOptions<QueryAbortData, ResponseError, SessionTerminateVariables>,
+ 'mutationFn'
+> = {}) => {
+ const queryClient = useQueryClient()
+ return useMutation<QueryAbortData, ResponseError, SessionTerminateVariables>({
+ mutationFn: (vars) => terminateSession(vars),
+ async onSuccess(data, variables, context) {
+ const { projectRef } = variables
+ await queryClient.invalidateQueries({ queryKey: sqlKeys.ongoingQueries(projectRef) })
+ await onSuccess?.(data, variables, context)
+ },
+ async onError(data, variables, context) {
+ if (onError === undefined) {
+ toast.error(`Failed to terminate session: ${data.message}`)
+ } else {
+ onError(data, variables, context)
+ }
+ },
+ ...options,
+ })
+}
diff --git a/packages/common/telemetry-constants.ts b/packages/common/telemetry-constants.ts
index c46f2bb96e3..7e97c3d26ef 100644
--- a/packages/common/telemetry-constants.ts
+++ b/packages/common/telemetry-constants.ts
@@ -1604,6 +1604,25 @@ export interface SessionTerminateSubmittedEvent {
groups: TelemetryGroups
}
+/**
+ * User clicked the Cancel query menu item for a database session in the Database Connections activity table.
+ *
+ * @group Events
+ * @source studio
+ * @page /dashboard/project/{ref}/observability/connections
+ */
+export interface QueryCancelButtonClickedEvent {
+ action: 'query_cancel_button_clicked'
+ properties: {
+ activityState: DatabaseActivityState
+ /**
+ * Whether the session whose query is being cancelled was itself blocking one or more other sessions.
+ */
+ isBlocking: boolean
+ }
+ groups: TelemetryGroups
+}
+
/**
* Index Advisor create indexes button clicked event.
*
@@ -3770,6 +3789,7 @@ export type TelemetryEvent =
| DatabaseConnectionsBannerCtaButtonClickedEvent
| SessionTerminateButtonClickedEvent
| SessionTerminateSubmittedEvent
+ | QueryCancelButtonClickedEvent
| IndexAdvisorCreateIndexesButtonClickedEvent
| EdgeFunctionDeployButtonClickedEvent
| EdgeFunctionDeployUpdatesConfirmClickedEvent
diff --git a/packages/pg-meta/src/sql/studio/sql-editor/abort-query.ts b/packages/pg-meta/src/sql/studio/sql-editor/abort-query.ts
index 483a74bc73a..0ff2dd93154 100644
--- a/packages/pg-meta/src/sql/studio/sql-editor/abort-query.ts
+++ b/packages/pg-meta/src/sql/studio/sql-editor/abort-query.ts
@@ -1,5 +1,9 @@
import { literal, safeSql, type SafeSqlFragment } from '../../../pg-format'
-export const getAbortQuerySQL = ({ pid }: { pid: number }): SafeSqlFragment => {
+export const getCancelQuerySQL = ({ pid }: { pid: number }): SafeSqlFragment => {
+ return safeSql`select pg_cancel_backend(${literal(pid)})`
+}
+
+export const getTerminateSessionSQL = ({ pid }: { pid: number }): SafeSqlFragment => {
return safeSql`select pg_terminate_backend(${literal(pid)})`
}