Files
supabase/apps/studio/components/interfaces/TableGridEditor/TableDefinition.tsx
Ivan Vasilov 98ca85156a chore: Use sql-formatter for formatting all SQL in the studio (#33071)
* Bump the sql-formatter dependency.

* Add a function formatQuery which is a wrapper around sql-formatter.

* Replace all formatSQL features to use the new function formatSql.

* Remove unneeded RQ for formatting.

* Small fix.
2025-01-27 13:04:31 +01:00

137 lines
3.6 KiB
TypeScript

import Editor from '@monaco-editor/react'
import { useTheme } from 'next-themes'
import Link from 'next/link'
import { useMemo, useRef } from 'react'
import { useParams } from 'common'
import Footer from 'components/grid/components/footer/Footer'
import { useProjectContext } from 'components/layouts/ProjectLayout/ProjectContext'
import { GenericSkeletonLoader } from 'components/ui/ShimmeringLoader'
import { useTableDefinitionQuery } from 'data/database/table-definition-query'
import { useViewDefinitionQuery } from 'data/database/view-definition-query'
import {
Entity,
isMaterializedView,
isTableLike,
isView,
isViewLike,
} from 'data/table-editor/table-editor-types'
import { formatSql } from 'lib/formatSql'
import { timeout } from 'lib/helpers'
import { Button } from 'ui'
export interface TableDefinitionProps {
entity?: Entity
}
const TableDefinition = ({ entity }: TableDefinitionProps) => {
const { ref } = useParams()
const editorRef = useRef(null)
const monacoRef = useRef(null)
const { resolvedTheme } = useTheme()
const { project } = useProjectContext()
const viewResult = useViewDefinitionQuery(
{
id: entity?.id,
projectRef: project?.ref,
connectionString: project?.connectionString,
},
{
enabled: isViewLike(entity),
}
)
const tableResult = useTableDefinitionQuery(
{
id: entity?.id,
projectRef: project?.ref,
connectionString: project?.connectionString,
},
{
enabled: isTableLike(entity),
}
)
const { data: definition, isLoading } = isViewLike(entity) ? viewResult : tableResult
const prepend = isView(entity)
? `create view ${entity.schema}.${entity.name} as\n`
: isMaterializedView(entity)
? `create materialized view ${entity.schema}.${entity.name} as\n`
: ''
const formattedDefinition = useMemo(
() => (definition ? formatSql(prepend + definition) : undefined),
[definition]
)
const handleEditorOnMount = async (editor: any, monaco: any) => {
editorRef.current = editor
monacoRef.current = monaco
// add margin above first line
editor.changeViewZones((accessor: any) => {
accessor.addZone({
afterLineNumber: 0,
heightInPx: 4,
domNode: document.createElement('div'),
})
})
// when editor did mount, it will need a delay before focus() works properly
await timeout(500)
editor?.focus()
}
if (isLoading) {
return (
<div className="h-full grid">
<div className="p-4">
<GenericSkeletonLoader />
</div>
<div className="mt-auto">
<Footer />
</div>
</div>
)
}
return (
<>
<div className="flex-grow overflow-y-auto border-t border-muted relative">
<Button asChild type="default" className="absolute top-2 right-5 z-10">
<Link
href={`/project/${ref}/sql/new?content=${encodeURIComponent(
formattedDefinition ?? ''
)}`}
>
Open in SQL Editor
</Link>
</Button>
<Editor
className="monaco-editor"
theme={resolvedTheme?.includes('dark') ? 'vs-dark' : 'vs'}
onMount={handleEditorOnMount}
defaultLanguage="pgsql"
value={formattedDefinition}
path={''}
options={{
domReadOnly: true,
readOnly: true,
tabSize: 2,
fontSize: 13,
minimap: { enabled: false },
wordWrap: 'on',
fixedOverflowWidgets: true,
}}
/>
</div>
<Footer />
</>
)
}
export default TableDefinition