The Postgres development platform. Supabase gives you a dedicated Postgres database to build your web, mobile, and AI applications.
TypeScript aialternativeauthdatabasedenoembeddingsexamplefirebasenextjsoauth2pgvectorpostgispostgrespostgresqlpostgrestrealtimesupabasevectorswebsockets
import { zodResolver } from '@hookform/resolvers/zod'
import { useParams } from 'common'
import { useEffect, useState } from 'react'
import { SubmitHandler, useForm } from 'react-hook-form'
import { toast } from 'sonner'
import {
Button,
Dialog,
DialogContent,
DialogFooter,
DialogHeader,
DialogSection,
DialogSectionSeparator,
DialogTitle,
Form,
FormControl,
FormField,
Input,
} from 'ui'
import { Admonition } from 'ui-patterns/Admonition'
import { FormItemLayout } from 'ui-patterns/form/FormItemLayout/FormItemLayout'
import z from 'zod'
import { validVectorBucketName } from './CreateVectorBucketDialog.utils'
import { useS3VectorsWrapperExtension } from './useS3VectorsWrapper'
import { InlineLink } from '@/components/ui/InlineLink'
import { useDatabaseExtensionEnableMutation } from '@/data/database-extensions/database-extension-enable-mutation'
import { useS3VectorsWrapperCreateMutation } from '@/data/storage/s3-vectors-wrapper-create-mutation'
import { useVectorBucketCreateMutation } from '@/data/storage/vector-bucket-create-mutation'
import { useVectorBucketsQuery } from '@/data/storage/vector-buckets-query'
import { useSelectedProjectQuery } from '@/hooks/misc/useSelectedProject'
import { DOCS_URL } from '@/lib/constants'
import { useTrack } from '@/lib/telemetry/track'
const FormSchema = z.object({
name: z
.string()
.trim()
.min(3, 'Bucket name should be at least 3 characters')
.max(63, 'Bucket name should be up to 63 characters')
.superRefine((name, ctx) => {
if (!validVectorBucketName.test(name)) {
if (/[A-Z]/.test(name)) {
return ctx.addIssue({
path: [],
code: z.ZodIssueCode.custom,
message: 'Bucket name can only be lowercase characters',
})
}
if (!/^[a-z0-9]/.test(name)) {
return ctx.addIssue({
path: [],
code: z.ZodIssueCode.custom,
message: 'Bucket name must start with a lowercase letter or number.',
})
}
if (!/[a-z0-9]$/.test(name)) {
return ctx.addIssue({
path: [],
code: z.ZodIssueCode.custom,
message: 'Bucket name must end with a lowercase letter or number.',
})
}
const [match] = name.match(/[^a-z0-9-]/) ?? []
return ctx.addIssue({
path: [],
code: z.ZodIssueCode.custom,
message: !!match
? `Bucket name cannot contain the "${match}" character`
: 'Bucket name contains an invalid special character',
})
}
}),
})
const formId = 'create-storage-bucket-form'
export type CreateBucketForm = z.infer<typeof FormSchema>
export const CreateVectorBucketDialog = ({
visible,
setVisible,
}: {
visible: boolean
setVisible: (visible: boolean) => void
}) => {
const { ref } = useParams()
const { data: project } = useSelectedProjectQuery()
const [isLoading, setIsLoading] = useState(false)
const { data } = useVectorBucketsQuery({ projectRef: ref })
const form = useForm<CreateBucketForm>({
resolver: zodResolver(FormSchema),
defaultValues: { name: '' },
})
const track = useTrack()
const { mutateAsync: createVectorBucket } = useVectorBucketCreateMutation({
onError: () => {},
})
const { extension: wrappersExtension, state: wrappersExtensionState } =
useS3VectorsWrapperExtension()
const { mutateAsync: createS3VectorsWrapper } = useS3VectorsWrapperCreateMutation()
const { mutateAsync: enableExtension } = useDatabaseExtensionEnableMutation()
const onSubmit: SubmitHandler<CreateBucketForm> = async (values) => {
if (!ref) return console.error('Project ref is required')
const hasExistingBucket = (data?.vectorBuckets ?? []).some(
(x) => x.vectorBucketName === values.name
)
if (hasExistingBucket) return toast.error('Bucket name already exists')
setIsLoading(true)
try {
await createVectorBucket({ projectRef: ref, bucketName: values.name })
} catch (error: any) {
toast.error(`Failed to create vector bucket: ${error.message}`)
setIsLoading(false)
return
}
try {
if (!wrappersExtension) throw new Error('Unable to find wrappers extension.')
if (wrappersExtensionState === 'not-installed') {
// when it's not installed, we need to enable the extension and create the wrapper
await enableExtension({
projectRef: project?.ref!,
connectionString: project?.connectionString,
name: wrappersExtension.name,
schema: wrappersExtension.schema ?? 'extensions',
version: wrappersExtension.default_version,
})
}
await createS3VectorsWrapper({ bucketName: values.name })
toast.success(`Successfully created vector bucket ${values.name}`)
} catch (error: any) {
toast.success(
<div>
<p>Successfully created vector bucket {values.name}</p>
<p className="text-foreground-light text-xs">
However, bucket integration will need to be manually installed as we ran into an error:
</p>
<p className="text-foreground-light text-xs">{error.message}</p>
</div>,
{ duration: 8000 }
)
}
setIsLoading(false)
track('storage_bucket_created', { bucketType: 'vector' })
form.reset()
setVisible(false)
}
useEffect(() => {
if (!visible) form.reset()
}, [visible, form])
return (
<Dialog open={visible} onOpenChange={setVisible}>
<DialogContent>
<DialogHeader>
<DialogTitle>Create vector bucket</DialogTitle>
</DialogHeader>
<DialogSectionSeparator />
<Form {...form}>
<form id={formId} onSubmit={form.handleSubmit(onSubmit)}>
<DialogSection className="flex flex-col p-0!">
<FormField
key="name"
name="name"
control={form.control}
render={({ field }) => (
<FormItemLayout
name="name"
label="Bucket name"
className="px-5 py-5"
labelOptional="Cannot be changed after creation"
description="Must be between 3–63 characters. Only lowercase letters, numbers, and hyphens are allowed"
>
<FormControl>
<Input
id="name"
data-1p-ignore
data-lpignore="true"
data-form-type="other"
data-bwignore
{...field}
placeholder="Enter bucket name"
/>
</FormControl>
</FormItemLayout>
)}
/>
<Admonition type="default" className="border-x-0 border-b-0 rounded-none">
<p>
Supabase will install the{' '}
{wrappersExtensionState !== 'installed' ? 'Wrappers extension and ' : ''}
S3 Vectors Wrapper integration on your behalf.{' '}
<InlineLink href={`${DOCS_URL}/guides/database/extensions/wrappers/s3_vectors`}>
Learn more
</InlineLink>
.
</p>
</Admonition>
</DialogSection>
</form>
</Form>
<DialogFooter>
<Button disabled={isLoading} onClick={() => setVisible(false)}>
Cancel
</Button>
<Button variant="primary" form={formId} type="submit" loading={isLoading}>
Create
</Button>
</DialogFooter>
</DialogContent>
</Dialog>
)
}