Add schema support (#17)

Author: atilafassina

.changeset/quick-loops-jump.md

@@ -0,0 +1,5 @@
+---
+"@neondatabase/vite-plugin-postgres": minor
+---
+
+Add `seed` option to seed database with SQL script on initialization. This option accepts a path to a SQL file that will be executed after the database is created.

.changeset/sweet-rabbits-shake.md

@@ -0,0 +1,9 @@
+---
+"neondb": minor
+---
+
+Add support for seeding a SQL script during database initialization. You can now provide a path to a SQL file that will be executed right after the database is created. Either via the prompt or with a command flag.
+
+| Option       | Description                                         |
+| ------------ | --------------------------------------------------- |
+| `-s, --seed` | Path to SQL file to execute after database creation |

.github/workflows/release.yml

@@ -77,21 +77,10 @@ jobs:
                       CHANGELOG_ENTRY=$(awk "/## $VERSION/,/## [0-9]/" "$CHANGELOG_PATH" | sed '1d;$d')
                       git tag -a "$TAG" "$COMMIT" -m "Release $pkg@$VERSION"
                       
-                      # Add schema.json as asset for neondb package
-                      if [ "$pkg" = "neondb" ] && [ -f "$PKG_DIR/dist/schema.json" ]; then
-                        gh release create "$TAG" --notes "$CHANGELOG_ENTRY" --title "$pkg@$VERSION" "$PKG_DIR/dist/schema.json"
-                      else
-                        gh release create "$TAG" --notes "$CHANGELOG_ENTRY" --title "$pkg@$VERSION"
-                      fi
+                      gh release create "$TAG" --notes "$CHANGELOG_ENTRY" --title "$pkg@$VERSION"
                     else
                       git tag "$TAG" "$COMMIT"
-                      
-                      # Add schema.json as asset for neondb package
-                      if [ "$pkg" = "neondb" ] && [ -f "$PKG_DIR/dist/schema.json" ]; then
-                        gh release create "$TAG" --notes "Release $pkg@$VERSION" --title "$pkg@$VERSION" "$PKG_DIR/dist/schema.json"
-                      else
-                        gh release create "$TAG" --notes "Release $pkg@$VERSION" --title "$pkg@$VERSION"
-                      fi
+                      gh release create "$TAG" --notes "Release $pkg@$VERSION" --title "$pkg@$VERSION"
                     fi
                   done
               env:

examples/react-spa/vite.config.ts

@@ -3,5 +3,19 @@ import react from "@vitejs/plugin-react";
 import { defineConfig } from "vite";
 
 export default defineConfig({
-	plugins: [postgresPlugin(), react()],
+	plugins: [
+		postgresPlugin({
+			/**
+			 * @todo
+			 * [IMPORTANT] This helps us understand where DB creations on Neon come from.
+			 * Please change this as soon as you can, to add your project name:
+			 *
+			 * @example
+			 * ""github:org/your-repo"
+			 * "npm:your-package"
+			 */
+			referrer: "github:neondatabase/neondb/react-spa",
+		}),
+		react(),
+	],
 });

examples/tanstack-start/app.config.ts

@@ -4,7 +4,22 @@ import tsConfigPaths from "vite-tsconfig-paths";
 export default defineConfig({
 	vite: {
 		plugins: [
-			postgresPlugin(),
+			postgresPlugin({
+				seed: {
+					type: "sql-script",
+					path: "./schema.sql",
+				},
+				/**
+				 * @todo
+				 * [IMPORTANT] This helps us understand where DB creations on Neon come from.
+				 * Please change this as soon as you can, to add your project name:
+				 *
+				 * @example
+				 * ""github:org/your-repo"
+				 * "npm:your-package"
+				 */
+				referrer: "github:neondatabase/neondb/tanstack-start",
+			}),
 			tsConfigPaths({
 				projects: ["./tsconfig.json"],
 			}),

examples/tanstack-start/package.json

@@ -4,6 +4,7 @@
 	"description": "",
 	"main": "index.js",
 	"type": "module",
+	"private": true,
 	"scripts": {
 		"dev": "vinxi dev",
 		"build": "vinxi build",
@@ -25,6 +26,7 @@
 		"@types/react": "^19.0.10",
 		"@types/react-dom": "^19.0.4",
 		"@vitejs/plugin-react": "^4.3.4",
+		"neondb": "workspace:*",
 		"typescript": "^5.8.2",
 		"vite-tsconfig-paths": "^5.1.4"
 	}

examples/tanstack-start/schema.sql

@@ -0,0 +1,11 @@
+CREATE TABLE IF NOT EXISTS users (
+    id SERIAL PRIMARY KEY,
+    name text
+);
+
+INSERT INTO users (name) VALUES
+    ('John Lennon'),
+    ('Paul McCartney'), 
+    ('George Harrison'),
+    ('Ringo Starr'),
+    ('George Martin');

package.json

@@ -8,10 +8,10 @@
 		"build": "pnpm --filter neondb build && pnpm --filter vite-plugin-postgres build",
 		"format": "biome check --error-on-warnings --fix",
 		"lint:ci": "biome ci --error-on-warnings",
-		"test:ci": "pnpm --recursive vitest --passWithNoTests",
+		"test:ci": "pnpm --recursive test:ci",
 		"prepare": "husky"
 	},
-"lint-staged": {
+	"lint-staged": {
 		"*": "biome check --write --no-errors-on-unmatched --files-ignore-unknown=true"
 	},
 	"devDependencies": {

packages/neondb/CHANGELOG.md

@@ -4,80 +4,80 @@
 
 ### Patch Changes
 
-- ce1c182: Add better referer values for each package
+-   ce1c182: Add better referrer values for each package
 
 ## 0.6.2
 
 ### Patch Changes
 
-- 9e8a5a4: Fix Unclaimed project Time-to-Live (TTL)
+-   9e8a5a4: Fix Unclaimed project Time-to-Live (TTL)
 
-  The actual TTL of an unclaimed branch is 72 hours
+    The actual TTL of an unclaimed branch is 72 hours
 
 ## 0.6.1
 
 ### Patch Changes
 
-- 995ad06: Fix Neon domain and add keywords to `package.json`
+-   995ad06: Fix Neon domain and add keywords to `package.json`
 
 ## 0.6.0
 
 ### Minor Changes
 
-- b807e80: Adds validation to user input on file name and environment variable key.
+-   b807e80: Adds validation to user input on file name and environment variable key.
 
-  | Option     | Default        | Description               | Validation            |
-  | ---------- | -------------- | ------------------------- | --------------------- |
-  | dotEnvFile | ".env"         | Path to env file          | letters and `.`       |
-  | dotEnvKey  | "DATABASE_URL" | Environment variable name | `SCREAMING_SNAKE_CASE |
+    | Option     | Default        | Description               | Validation            |
+    | ---------- | -------------- | ------------------------- | --------------------- |
+    | dotEnvFile | ".env"         | Path to env file          | letters and `.`       |
+    | dotEnvKey  | "DATABASE_URL" | Environment variable name | `SCREAMING_SNAKE_CASE |
 
-- b807e80: Prevents creating a DB if flow is cancelled
+-   b807e80: Prevents creating a DB if flow is cancelled
 
-  if the user aborts (CTRL+C), the CLI will not use the defaults and the process will be interrupted immediately.
+    if the user aborts (CTRL+C), the CLI will not use the defaults and the process will be interrupted immediately.
 
 ### Patch Changes
 
-- 31cb6f4: Remove `refferer`, `provider`, and `region` from possible CLI arguments
-- adbfcc9: Fix: prevent flags from being ignored
+-   31cb6f4: Remove `refferer`, `provider`, and `region` from possible CLI arguments
+-   adbfcc9: Fix: prevent flags from being ignored
 
-  This release fixes a regression where `--env` and `--key` flags were being ignored and defaults would be used regardless.
+    This release fixes a regression where `--env` and `--key` flags were being ignored and defaults would be used regardless.
 
 ## 0.5.0
 
 ### Minor Changes
 
-- e3482a6: Fixed new lines being added in the .env file
+-   e3482a6: Fixed new lines being added in the .env file
 
 ## 0.4.1
 
 ### Patch Changes
 
-- 91c6b5f: Remove trailing whitespace from `.env`
+-   91c6b5f: Remove trailing whitespace from `.env`
 
 ## 0.4.0
 
 ### Minor Changes
 
-- e09a8c8: Improve logs
+-   e09a8c8: Improve logs
 
-  - Generate better logs for the CLI.
-  - Add proper Claim URL to the `.env`.
-  - Remove excess tabs from the `.env` output.
+    -   Generate better logs for the CLI.
+    -   Add proper Claim URL to the `.env`.
+    -   Remove excess tabs from the `.env` output.
 
 ## 0.3.1
 
 ### Patch Changes
 
-- 11e28a5: Update endpoints
+-   11e28a5: Update endpoints
 
 ## 0.3.0
 
 ### Minor Changes
 
-- 05de2a7: Add `/sdk` export for `instantNeon`
+-   05de2a7: Add `/sdk` export for `instantNeon`
 
 ## 0.2.1
 
 ### Patch Changes
 
-- a0817d9: Append the defaults to the prompt messages.
+-   a0817d9: Append the defaults to the prompt messages.

packages/neondb/README.md

@@ -21,6 +21,7 @@ Options:
 -   `-y, --yes` Use defaults, skip prompts
 -   `-e, --env` Path to .env file (default: ./.env)
 -   `-k, --key` Env key for connection string (default: DATABASE_URL)
+-   `-s, --seed` Path to SQL file to execute after database creation
 -   `-h, --help` Show help
 
 ---