Adding support for Postgres Extensions (#1443)

Author: infomiho

waspc/ChangeLog.md

@@ -2,6 +2,30 @@
 
 ## 0.11.4
 
+### 🎉 [New Feature] Support for PostgreSQL Extensions
+
+Wasp now supports PostgreSQL extensions! You can enable them in your `main.wasp` file:
+
+```wasp
+app todoApp {
+  // ...
+  db: {
+    system: PostgreSQL,
+    prisma: {
+      clientPreviewFeatures: ["postgresqlExtensions"],
+      dbExtensions: [{
+        name: "pgvector",
+        // map: "vector", (optional)
+        // schema: "public", (optional)
+        // version: "0.1.0", (optiona)
+      }]
+    }
+  }
+}
+```
+
+This will add the necessary Prisma configuration to your `schema.prisma` file. Keep in mind that your database needs to support the extension you want to use. For example, if you want to use the `pgvector` extension, you need to install it in your database first.
+
 ### 🎉 [New Feature] Added Typescript support for Jobs
 
 Now you can type your async jobs better and receive all the benefits of Typescript. When you define a job, Wasp will generate a generic type which you can use to type your job function:

waspc/data/Generator/templates/db/schema.prisma

@@ -3,6 +3,9 @@
 datasource db {
   provider = "{= datasourceProvider =}"
   url      = {=& datasourceUrl =}
+  {=# dbExtensions =}
+  extensions = {=& . =}
+  {=/ dbExtensions =}
 }
 
 generator client {

waspc/examples/pg-vector-example/.gitignore

@@ -0,0 +1,11 @@
+/.wasp/
+
+# We ignore env files recognized and used by Wasp.
+.env.server
+.env.client
+
+# To be extra safe, we by default ignore any files with `.env` extension in them.
+# If this is too agressive for you, consider allowing specific files with `!` operator,
+# or modify/delete these two lines.
+*.env
+*.env.*

waspc/examples/pg-vector-example/.wasproot

@@ -0,0 +1 @@
+File marking the root of Wasp project.

waspc/examples/pg-vector-example/env.server.example

@@ -0,0 +1,3 @@
+OPENAI_API_KEY=
+# If ran run_db.sh:
+DATABASE_URL=postgresql://postgres:devpass@localhost:5432/postgres

waspc/examples/pg-vector-example/main.wasp

@@ -0,0 +1,74 @@
+app pgVectorExample {
+  wasp: {
+    version: "^0.11.3"
+  },
+  title: "PG Vector Example",
+  dependencies: [
+    ("openai", "^4.5.0"),
+    ("react-hook-form", "^7.43.1"),
+    ("@nextui-org/react", "^2.1.10"),
+    ("framer-motion", "^10.16.4"),
+    ("pgvector", "0.1.5"),
+    ("cheerio", "1.0.0-rc.12"),
+    ("axios", "^1.4.0"),
+    ("react-markdown", "^8.0.7")
+  ],
+  client: {
+    rootComponent: import { Layout } from "@client/Layout.tsx",
+  },
+  db: {
+    system: PostgreSQL,
+    prisma: {
+      clientPreviewFeatures: ["postgresqlExtensions"],
+      dbExtensions: [{
+        name: "pgvector",
+        map: "vector"
+      }]
+    }
+  }
+}
+
+route RootRoute { path: "/", to: MainPage }
+page MainPage {
+  component: import { Main } from "@client/pages/MainPage.tsx"
+}
+
+action embedDocument {
+  fn: import { embedDocument } from "@server/documents.js",
+  entities: [Document],
+}
+
+action getScrapeCandidates {
+  fn: import { getScrapeCandidates } from "@server/documents.js",
+  entities: [Document],
+}
+
+query getDocuments {
+  fn: import { getDocuments } from "@server/documents.js",
+  entities: [Document]
+}
+
+action searchDocuments {
+  fn: import { searchDocuments } from "@server/documents.js",
+  entities: [Document]
+}
+
+action askDocuments {
+  fn: import { askDocuments } from "@server/documents.js",
+  entities: [Document]
+}
+
+action deleteDocument {
+  fn: import { deleteDocument } from "@server/documents.js",
+  entities: [Document]
+}
+
+entity Document {=psl
+  id String @id @default(uuid())
+  title String
+  url String @unique
+  content String
+  embedding Unsupported("vector(1536)")
+  createdAt DateTime @default(now())
+  updatedAt DateTime @updatedAt
+psl=}

waspc/examples/pg-vector-example/migrations/20230907154352_add_extension/migration.sql

@@ -0,0 +1,12 @@
+-- CreateExtension
+CREATE EXTENSION IF NOT EXISTS "vector";
+
+-- CreateTable
+CREATE TABLE "Document" (
+    "id" TEXT NOT NULL,
+    "title" TEXT NOT NULL,
+    "content" TEXT NOT NULL,
+    "embedding" vector(1536) NOT NULL,
+
+    CONSTRAINT "Document_pkey" PRIMARY KEY ("id")
+);

waspc/examples/pg-vector-example/migrations/20230911093209_add_url/migration.sql

@@ -0,0 +1,15 @@
+/*
+  Warnings:
+
+  - A unique constraint covering the columns `[url]` on the table `Document` will be added. If there are existing duplicate values, this will fail.
+  - Added the required column `updatedAt` to the `Document` table without a default value. This is not possible if the table is not empty.
+  - Added the required column `url` to the `Document` table without a default value. This is not possible if the table is not empty.
+
+*/
+-- AlterTable
+ALTER TABLE "Document" ADD COLUMN     "createdAt" TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP,
+ADD COLUMN     "updatedAt" TIMESTAMP(3) NOT NULL,
+ADD COLUMN     "url" TEXT NOT NULL;
+
+-- CreateIndex
+CREATE UNIQUE INDEX "Document_url_key" ON "Document"("url");

waspc/examples/pg-vector-example/migrations/migration_lock.toml

@@ -0,0 +1,3 @@
+# Please do not edit this file manually
+# It should be added in your version-control system (i.e. Git)
+provider = "postgresql"

waspc/examples/pg-vector-example/postcss.config.cjs

@@ -0,0 +1,6 @@
+module.exports = {
+  plugins: {
+    tailwindcss: {},
+    autoprefixer: {},
+  },
+}