### Initialize SDK Getting Started Component
Source: https://neon.com/docs/community/component-specialized
Renders the getting started section for a specified SDK.
```mdx
```
--------------------------------
### Install and run the project
Source: https://neon.com/docs/guides/cloudflare-pages
Commands to navigate into the project directory, install dependencies, and start the development server.
```bash
cd my-neon-page
npm install
npm run dev
```
--------------------------------
### Install dependencies and start development server
Source: https://neon.com/docs/guides/wundergraph
Commands to install project dependencies and launch the local development environment.
```bash
npm install && npm run dev
```
--------------------------------
### Quick start with default template
Source: https://neon.com/docs/cli/bootstrap
Scaffolds the default template and runs setup without interactive prompts.
```bash
neon bootstrap my-app --default
```
--------------------------------
### Prompt Cursor for Neon setup
Source: https://neon.com/docs/ai/ai-cursor-plugin
Use this prompt after installation to begin the authentication and setup process.
```text
Get started with Neon
```
--------------------------------
### Neon CLI Initialization Output
Source: https://neon.com/docs/changelog
Example output showing the successful authentication and installation of the Neon MCP server.
```bash
npx neonctl@latest init
┌ Adding Neon to your project
│
◒ Authenticating.
┌────────┬──────────────────┬────────┬────────────────┐
│ Login │ Email │ Name │ Projects Limit │
├────────┼──────────────────┼────────┼────────────────┤
│ alex │ alex@domain.com │ Alex │ 20 │
└────────┴──────────────────┴────────┴────────────────┘
◇ Authentication successful ✓
│
◇ Installed Neon MCP server
│
◇ Success! Neon is now ready to use with Cursor.
│
│
◇ What's next? ────────────────────────────────────────────────────────────────────────────╮
│ │
│ Restart Cursor and ask Cursor to "Get started with Neon using MCP Resource" in the chat │
│ │
├───────────────────────────────────────────────────────────────────────────────────────────╯
│
└ Have feedback? Email us at feedback@neon.tech
```
--------------------------------
### Netlify CLI setup commands
Source: https://neon.com/docs/guides/netlify-functions
Commands to install the Netlify CLI and authenticate the session.
```bash
npm install netlify-cli -g
```
```bash
netlify login
```
--------------------------------
### Install Dependencies
Source: https://neon.com/docs/guides/auth-authjs
Installs Auth.js beta, the Postgres adapter, and the Neon serverless driver.
```bash
cd guide-neon-next-authjs
npm install next-auth@beta
npm install @auth/pg-adapter @neondatabase/serverless
```
--------------------------------
### Deployment output example
Source: https://neon.com/docs/cli/functions
Example output returned after a successful function deployment.
```text
INFO: Function deployment triggered for function hello.
┌────┬───────────┬──────────┬────────────┬─────────────────────────────┐
│ Id │ Status │ Runtime │ Memory Mib │ Created At │
├────┼───────────┼──────────┼────────────┼─────────────────────────────┤
│ 1 │ completed │ nodejs24 │ 2048 │ 2026-06-12T00:14:58.044690Z │
└────┴───────────┴──────────┴────────────┴─────────────────────────────┘
INFO: Function deployment hello/1 completed.
```
--------------------------------
### Install Prisma Read Replicas Extension
Source: https://neon.com/docs/guides/read-replica-integrations
Install the required extension package for Prisma.
```bash
npm install @prisma/extension-read-replicas
```
--------------------------------
### Clone and install dependencies
Source: https://neon.com/docs/data-api/demo
Download the repository and install the required packages using Bun.
```bash
git clone https://github.com/neondatabase-labs/neon-data-api-neon-auth.git
cd neon-data-api-neon-auth
bun install
```
--------------------------------
### Setup Database Schema and Data
Source: https://neon.com/docs/functions/jsonb_array_elements
Creates the organizations and users tables and populates them with sample data for demonstration.
```sql
CREATE TABLE organizations (
id SERIAL PRIMARY KEY,
members JSONB
);
CREATE TABLE users (
id INTEGER PRIMARY KEY,
name TEXT,
email TEXT
);
INSERT INTO organizations (members) VALUES
('[{ "id": 23, "role": "admin" }, { "id": 24, "role": "default" }]'),
('[{ "id": 23, "role": "user" }]'),
('[{ "id": 24, "role": "admin" }, { "id": 25, "role": "default" }]'),
('[{ "id": 25, "role": "user" }]');
INSERT INTO users (id, name, email) VALUES
(23, 'Max', 'max@gmail.com'),
(24, 'Joe', 'joe@gmail.com'),
(25, 'Alice', 'alice@gmail.com');
```
--------------------------------
### Setup inventory table and sample data
Source: https://neon.com/docs/extensions/wal2json
Create a sample table and populate it with initial data for testing change capture.
```sql
CREATE TABLE inventory (
id SERIAL PRIMARY KEY,
product_name VARCHAR(100),
quantity INTEGER,
last_updated TIMESTAMP DEFAULT CURRENT_TIMESTAMP
);
INSERT INTO inventory (product_name, quantity) VALUES
('Widget A', 100),
('Gadget B', 50),
('Gizmo C', 75);
```
--------------------------------
### Medusa CLI Setup Output
Source: https://neon.com/docs/guides/medusajs
Example terminal output after successfully running the Medusa setup command with a Neon database.
```bash
$ npx create-medusa-app@latest --db-url "YOUR_NEON_CONNECTION_STRING"
? What's the name of your project? my-medusa-store
? Would you like to install the Next.js Starter Storefront? You can also install it later. Yes
🚀 Starting project setup, this may take a few minutes.
✔ Created project directory
✔ Installed Next.js Starter Storefront successfully in the my-medusa-store-storefront directory.
✔ Installed Dependencies
✔ Ran Migrations
✔ Seeded database with demo data
✔ Finished Preparation
✔ Project Prepared
Starting Medusa...
> my-medusa-store@0.0.1 dev
> medusa develop
- Creating server
✔ Server is ready on port: 9000 – 11ms
```
--------------------------------
### CLI Output Display
Source: https://neon.com/docs/changelog
Example of CLI output showing authentication and installation status.
```text
│ alex │ alex@domain.com │ Alex │ 20 │
└────────┴──────────────────┴────────┴────────────────┘
◇ Authentication successful ✓
│
◇ Installed Neon MCP
```
--------------------------------
### Initialize Go project directory
Source: https://neon.com/docs/guides/go
Create a new directory for the project and navigate into it.
```bash
mkdir neon-go-quickstart
cd neon-go-quickstart
```
--------------------------------
### Start development server
Source: https://neon.com/docs/data-api/demo
Launch the local development server to view the application.
```bash
bun dev
```
--------------------------------
### Wrangler local server output
Source: https://neon.com/docs/guides/cloudflare-workers
Example output when starting the local development server.
```text
❯ npm run dev
⛅️ wrangler 3.28.1
-------------------
Using vars defined in .dev.vars
Your worker has access to the following bindings:
- Vars:
- DATABASE_URL: "(hidden)"
⎔ Starting local server...
[wrangler:inf] Ready on http://localhost:8787
```
--------------------------------
### Create cart_items table and insert data
Source: https://neon.com/docs/functions/array_to_json
Setup script for the cart_items table used in the array_to_json examples.
```sql
CREATE TABLE cart_items (
id SERIAL PRIMARY KEY,
user_id INTEGER NOT NULL,
product_id INTEGER NOT NULL,
quantity INTEGER NOT NULL
);
INSERT INTO cart_items (user_id, product_id, quantity)
VALUES (1, 123, 1), (1, 456, 2), (1, 789, 3);
INSERT INTO cart_items (user_id, product_id, quantity)
VALUES (2, 123, 2), (2, 456, 3), (2, 789, 4);
```
--------------------------------
### Create and populate the initial table
Source: https://neon.com/docs/extensions/pg_partman
Sets up a non-partitioned table and inserts sample data for demonstration purposes.
```sql
CREATE TABLE public.test_user_activities (
activity_id serial,
activity_time TIMESTAMPTZ NOT NULL,
activity_type TEXT NOT NULL,
content_id INT NOT NULL,
user_id INT NOT NULL
);
INSERT INTO test_user_activities (activity_time, activity_type, content_id, user_id)
VALUES
('2024-03-15 10:00:00', 'like', 1001, 101),
('2024-03-16 15:30:00', 'comment', 1002, 102),
('2024-03-17 09:45:00', 'share', 1003, 103),
('2024-03-18 18:20:00', 'like', 1004, 104),
('2024-03-19 12:10:00', 'comment', 1005, 105),
('2024-03-20 08:00:00', 'like', 1006, 106),
('2024-03-21 14:15:00', 'share', 1007, 107),
('2024-03-22 11:30:00', 'like', 1008, 108),
('2024-03-23 16:45:00', 'comment', 1009, 109),
('2024-03-24 20:00:00', 'share', 1010, 110),
('2024-03-25 09:30:00', 'like', 1011, 111),
('2024-03-26 13:45:00', 'comment', 1012, 112),
('2024-03-27 17:00:00', 'share', 1013, 113),
('2024-03-28 11:15:00', 'like', 1014, 114),
('2024-03-29 15:30:00', 'comment', 1015, 115);
```
--------------------------------
### Create Sample Databases
Source: https://neon.com/docs/import/import-sample-data
SQL commands to initialize the required databases for each sample dataset.
```sql
CREATE DATABASE titanic;
```
```sql
CREATE DATABASE netflix;
```
```sql
CREATE DATABASE pagila;
```
```sql
CREATE DATABASE chinook;
```
--------------------------------
### Start Anonymization Response Example
Source: https://neon.com/docs/workflows/data-anonymization-api
A sample JSON response confirming the successful completion of an anonymization request.
```json
{
"branch_id": "br-shiny-butterfly-w4393738",
"project_id": "wild-sky-00366102",
"state": "anonymized",
"status_message": "Anonymization completed successfully (2 tables, 3 masking rules applied)",
"created_at": "2025-11-01T14:01:39Z",
"updated_at": "2025-11-01T14:01:41Z"
}
```
--------------------------------
### Initialize Neon configuration
Source: https://neon.com/docs/cli/config
Scaffolds a starter policy file and installs required packages in the current project.
```bash
neon config init [options]
```
```bash
neon config init
```
--------------------------------
### Request Start Anonymization via cURL
Source: https://neon.com/docs/workflows/data-anonymization-api
Example request to trigger the anonymization process for a specific branch.
```bash
curl -X POST \
'https://console.neon.tech/api/v2/projects/{project_id}/branches/{branch_id}/anonymize' \
-H 'Authorization: Bearer $NEON_API_KEY' \
-H 'Accept: application/json'
```
--------------------------------
### Configure project settings
Source: https://neon.com/docs/guides/cloudflare-hyperdrive
Example settings for the interactive CLI prompt during project creation.
```text
├ In which directory do you want to create your application?
│ dir ./neon-hyperdrive-guide
│
├ What type of application do you want to create?
│ type "Hello World" Worker
│
├ Do you want to use TypeScript?
│ Yes typescript
```
--------------------------------
### Initialize .NET project
Source: https://neon.com/docs/guides/dotnet-npgsql
Create a new console application directory and navigate into it.
```bash
dotnet new console -o NeonLibraryExample
cd NeonLibraryExample
```
--------------------------------
### Implement a CheckList component
Source: https://neon.com/docs/community/component-guide
Creates an interactive checklist for setup guides. Requires CheckItem components as children.
```mdx
Sign up for a free Neon account at console.neon.tech
Install the required packages for your project
Set up your database connection string
Verify your application can connect to Neon
```
--------------------------------
### Install dependencies
Source: https://neon.com/docs/guides/bun
Commands to prepare the environment for either the built-in SQL client or the Neon serverless driver.
```shell
# No dependencies needed for Bun's built-in SQL client
```
```shell
bun add @neondatabase/serverless
```
--------------------------------
### Initialize Sample Table and Data
Source: https://neon.com/docs/extensions/dict_int
Create a documents table and populate it with sample version codes for testing text search.
```sql
CREATE TABLE documents (
id SERIAL PRIMARY KEY,
title TEXT,
content TEXT,
version_code TEXT
);
INSERT INTO documents (title, content, version_code) VALUES
('Intro Guide', 'Content of version 1...', '1'),
('Advanced Manual', 'More content...', '0042'),
('Internal Spec', 'Spec details...', '7654321'),
('Internal Spec v2', 'Updated spec...', '+7654321'),
('Draft Notes', 'Preliminary ideas...', 'ver003');
```
--------------------------------
### Initialize a new Vite project
Source: https://neon.com/docs/guides/cloudflare-pages
Run this command in your terminal to start the interactive setup process for a new Vite project.
```bash
npm create vite@latest
```
--------------------------------
### Consume Data in TanStack Start Routes
Source: https://neon.com/docs/guides/tanstack-start
Example of using a server function loader within a TanStack Router route component.
```typescript
import { createFileRoute } from "@tanstack/react-router";
import { getData } from "../data/get-neon-data.ts";
export const Route = createFileRoute("/")({
loader: async () => {
return getData();
},
component: RouteComponent,
});
export default function RouteComponent() {
const data = Route.useLoaderData();
return <>{data};
}
```
--------------------------------
### Install Go dependencies
Source: https://neon.com/docs/guides/go
Download pgx for database connectivity and godotenv for environment variable management.
```bash
go get github.com/jackc/pgx/v5 github.com/joho/godotenv
```
--------------------------------
### Traverse a hierarchy with connectby
Source: https://neon.com/docs/extensions/tablefunc
This example demonstrates creating a sample table, inserting hierarchical data, and using the connectby function to retrieve the tree structure starting from a specific node.
```sql
CREATE TABLE product_categories (
category_id INT PRIMARY KEY,
category_name TEXT,
parent_category_id INT
);
INSERT INTO product_categories (category_id, category_name, parent_category_id) VALUES
(1, 'Electronics', NULL),
(2, 'Computers', 1),
(3, 'Laptops', 2),
(4, 'Desktops', 2),
(5, 'Phones', 1),
(6, 'Smartphones', 5),
(7, 'Books', NULL),
(8, 'Fiction', 7);
-- Using connectby to traverse the product category hierarchy
SELECT *
FROM connectby(
'product_categories', -- 1. Table name
'category_id', -- 2. Key field column name
'parent_key_field', -- 3. Parent key field column name
'1', -- 4. Start row's key value (for example, 'Electronics' category_id)
0, -- 5. Maximum depth (0 for all levels)
'>' -- 6. Branch delimiter string for the branch_path
) AS t(
current_category_id INT, -- Output: Current item's key field
parent_id INT, -- Output: Parent item's key field
level INT, -- Output: Depth in the hierarchy (0 for start_with row)
branch_path TEXT -- Output: Text path from root to current item
);
```
--------------------------------
### Initialize an Exograph project
Source: https://neon.com/docs/guides/exograph
Create a new Exograph project and navigate into the directory.
```bash
exo new todo
cd todo
```
--------------------------------
### Example connection string with realistic values
Source: https://neon.com/docs/community/contribution-guide
A sample connection string using placeholder credentials and database details.
```text
postgresql://alex:AbC123dEf@ep-cool-darkness-123456.us-east-2.aws.neon.tech/dbname?sslmode=require&channel_binding=require
```
--------------------------------
### Install Entity Framework Dependencies
Source: https://neon.com/docs/guides/dotnet-entity-framework
Install the required EF Core and Npgsql packages. Ensure versions match your installed .NET version.
```bash
dotnet tool install --global dotnet-ef --version YOUR_DOTNET_VERSION
dotnet add package Microsoft.EntityFrameworkCore.Design --version YOUR_DOTNET_VERSION
dotnet add package Npgsql.EntityFrameworkCore.PostgreSQL --version YOUR_DOTNET_VERSION
```
--------------------------------
### Bootstrap a new project
Source: https://neon.com/docs/cli/bootstrap
Initializes a new project directory using an interactively selected template.
```bash
neon bootstrap my-app
```
--------------------------------
### Install dependencies
Source: https://neon.com/docs/guides/reflex
Install Reflex, python-dotenv, and psycopg2-binary.
```bash
pip install reflex python-dotenv psycopg2-binary
```
--------------------------------
### Launch the Exograph development server
Source: https://neon.com/docs/guides/exograph
Start the development server by providing the Neon database connection string.
```bash
EXO_POSTGRES_URL= exo dev
```
--------------------------------
### Install pg_roaringbitmap
Source: https://neon.com/docs/extensions/pg-extensions
Standard installation command for the roaringbitmap extension.
```sql
CREATE EXTENSION roaringbitmap;
```
--------------------------------
### Install h3_postgis extension
Source: https://neon.com/docs/extensions/pg-extensions
Install the h3_postgis extension with its dependencies.
```sql
CREATE EXTENSION h3_postgis CASCADE;
```
--------------------------------
### Serverless project creation output
Source: https://neon.com/docs/guides/aws-lambda
Example output showing the interactive prompts and deployment process for a Serverless project.
```bash
? What do you want to make? AWS - Node.js - Starter
? What do you want to call this project? aws-node-project
✔ Project successfully created in aws-node-project folder
? Do you want to login/register to Serverless Dashboard? Yes
Logging into the Serverless Dashboard via the browser
If your browser does not open automatically, please open this URL:
https://app.serverless.com?client=cli&transactionId=jP-Zz5A9xu67PPYqzIhOe
✔ You are now logged into the Serverless Dashboard
? What application do you want to add this to? [create a new app]
? What do you want to name this application? aws-node-project
✔ Your project is ready to be deployed to Serverless Dashboard (org: "myorg", app: "aws-node-project")
? No AWS credentials found, what credentials do you want to use? AWS Access Role
(most secure)
If your browser does not open automatically, please open this URL: https://app.serverless.com/myorg/settings/providers?source=cli&providerId=new&provider=aws
To learn more about providers, visit: http://slss.io/add-providers-dashboard
?
[If you encountered an issue when setting up a provider, you may press Enter to
skip this step]
✔ AWS Access Role provider was successfully created
? Do you want to deploy now? Yes
Deploying aws-node-project to stage dev (us-east-1, "default" provider)
✔ Service deployed to stack aws-node-project-dev (71s)
dashboard: https://app.serverless.com/myorg/apps/my-aws-node-project/aws-node-project/dev/us-east-1
functions:
hello: aws-node-project-dev-hello (225 kB)
What next?
Run these commands in the project directory:
serverless deploy Deploy changes
serverless info View deployed endpoints and resources
serverless invoke Invoke deployed functions
serverless --help Discover more commands
```
--------------------------------
### Install pg_mooncake
Source: https://neon.com/docs/extensions/pg_mooncake
Installs the pg_mooncake extension into the current database.
```sql
CREATE EXTENSION pg_mooncake;
```
--------------------------------
### Create native Postgres partitions
Source: https://neon.com/docs/extensions/pg_partman
Demonstrates manual creation of a range-partitioned table and management of individual partitions using standard SQL commands.
```sql
CREATE TABLE measurement (
city_id int not null,
logdate date not null,
peaktemp int
) PARTITION BY RANGE (logdate);
-- Create a partition for each month of logged data.
-- Records with `logdate` in this range are automatically routed to this partition table
CREATE TABLE measurement_y2006m02 PARTITION OF measurement
FOR VALUES FROM ('2006-02-01') TO ('2006-03-01');
-- Moving older data to a different table.
-- Queries against the main table will not include the data in the detached partition
ALTER TABLE measurement DETACH PARTITION measurement_y2005m10;
```
--------------------------------
### Time_bucket() output example
Source: https://neon.com/docs/extensions/timescaledb
Example output for the time_bucket() query.
```text
| bucket_time | avg_temperature |
|------------------------|---------------------|
| 2016-11-15 12:00:00+00 | 32.76 |
| 2016-11-15 13:00:00+00 | 33.60 |
| 2016-11-15 14:00:00+00 | 34.83 |
| 2016-11-15 15:00:00+00 | 36.26 |
| 2016-11-15 16:00:00+00 | 37.19 |
| 2016-11-15 17:00:00+00 | 38.12 |
| 2016-11-15 18:00:00+00 | 39.02 |
| 2016-11-15 19:00:00+00 | 40.03 |
| 2016-11-15 20:00:00+00 | 40.87 |
| 2016-11-15 21:00:00+00 | 41.93 |
```
--------------------------------
### Create a project and connect with psql
Source: https://neon.com/docs/cli/projects
Creates a project and immediately opens a psql session. Arguments after the -- separator are passed directly to psql.
```bash
neon projects create --psql
neon projects create --psql -- -f dump.sql
neon projects create --psql -- -c "SELECT version()"
```
--------------------------------
### Create Netlify project
Source: https://neon.com/docs/guides/netlify-functions
Commands to initialize a new directory and create a Netlify site.
```bash
mkdir neon-netlify-example && cd neon-netlify-example
netlify sites:create
```
--------------------------------
### Last() output example
Source: https://neon.com/docs/extensions/timescaledb
Example output for the last() query.
```text
| device_id | first_temperature |
|--------------------|-------------------|
| weather-pro-000000 | 42 |
| weather-pro-000001 | 42 |
| weather-pro-000002 | 72.0 |
| weather-pro-000003 | 71.5 |
| weather-pro-000004 | 73.0 |
| weather-pro-000005 | 70.3 |
| weather-pro-000006 | 42 |
| weather-pro-000007 | 69.9 |
| weather-pro-000008 | 42 |
| weather-pro-000009 | 91 |
```
--------------------------------
### Run Development Server
Source: https://neon.com/docs/auth/migrate/from-supabase
Command to start the application for testing the migration.
```bash
npm run dev
```
--------------------------------
### First() output example
Source: https://neon.com/docs/extensions/timescaledb
Example output for the first() query.
```text
| device_id | first_temperature |
|--------------------|--------------------|
| weather-pro-000000 | 39.9 |
| weather-pro-000001 | 32.4 |
| weather-pro-000002 | 39.8 |
| weather-pro-000003 | 36.8 |
| weather-pro-000004 | 71.8 |
| weather-pro-000005 | 71.8 |
| weather-pro-000006 | 37 |
| weather-pro-000007 | 72 |
| weather-pro-000008 | 31.3 |
| weather-pro-000009 | 84.4 |
```
--------------------------------
### Initialize .NET Project
Source: https://neon.com/docs/guides/dotnet-entity-framework
Create a new ASP.NET Core Web API project and navigate to the directory.
```bash
dotnet new webapi -n NeonEfExample
cd NeonEfExample
```
--------------------------------
### Install Neon API SDK
Source: https://neon.com/docs/reference/python-sdk
Install the package using pip.
```shell
$ pip install neon-api
```
--------------------------------
### Install pgloader
Source: https://neon.com/docs/import/migrate-sqlite
Commands to install the pgloader utility on various platforms.
```bash
brew install pgloader
```
```bash
sudo apt-get install pgloader
```
```bash
docker pull dimitri/pgloader:latest
```
--------------------------------
### Create a project with specific parameters
Source: https://neon.com/docs/cli/projects
Example of creating a project with a custom name and region.
```bash
neon projects create --name mynewproject --region-id aws-us-west-2
```
--------------------------------
### Install Python dependencies
Source: https://neon.com/docs/guides/uploadcare
Install the required packages for the Python implementation.
```bash
pip install Flask pyuploadcare psycopg2-binary python-dotenv
```
--------------------------------
### Install Node.js dependencies
Source: https://neon.com/docs/guides/uploadcare
Install the required packages for the Node.js implementation.
```bash
npm install @uploadcare/upload-client @neondatabase/serverless @hono/node-server hono
```
--------------------------------
### Deployment examples
Source: https://neon.com/docs/compute/functions/deploy
Common usage patterns for deploying functions with different source and environment configurations.
```bash
neon functions deploy hello --src functions/hello.ts
```
```bash
neon functions deploy hello --src . --env RESEND_API_KEY=re_...
```
```bash
neon functions deploy hello --src functions/hello.ts --branch feat/my-feature
```
--------------------------------
### Install dependencies
Source: https://neon.com/docs/guides/tortoise-orm
Install Tortoise ORM with asyncpg support and python-dotenv.
```shell
pip install "tortoise-orm[asyncpg]" python-dotenv
```
--------------------------------
### Initialize a Bun project
Source: https://neon.com/docs/guides/bun
Create a new directory and initialize a Bun project.
```shell
mkdir bun-neon-example
cd bun-neon-example
bun init -y
```
--------------------------------
### Initialize .NET Project
Source: https://neon.com/docs/guides/entity-migrations
Create a new .NET console application directory.
```bash
dotnet new console -o guide-neon-entityframework
cd guide-neon-entityframework
```
--------------------------------
### Install Rails
Source: https://neon.com/docs/guides/rails-migrations
Command to install the Rails gem on your local machine.
```bash
gem install rails
```
--------------------------------
### Deployment Output Example
Source: https://neon.com/docs/guides/aws-lambda
Sample output showing the generated API endpoint after a successful deployment.
```bash
Deploying aws-node-project to stage dev (us-east-1, "default" provider)
✔ Service deployed to stack aws-node-project-dev (60s)
dashboard: https://app.serverless.com/myorg/apps/aws-node-project/aws-node-project/dev/us-east-1
endpoint: GET - https://ge3onb0klj.execute-api.us-east-1.amazonaws.com/users
functions:
getAllUsers: aws-node-project-dev-getAllUsers (225 kB)
```
--------------------------------
### Verify Liquibase Installation
Source: https://neon.com/docs/guides/liquibase
Command to check the installed version of Liquibase.
```bash
liquibase --version
...
Liquibase Version: x.yy.z
Liquibase Open Source x.yy.z by Liquibase
```
--------------------------------
### Install Dependencies for postgres.js
Source: https://neon.com/docs/guides/drizzle
Install Drizzle ORM and the postgres.js driver.
```bash
npm install drizzle-orm postgres dotenv
npm install -D drizzle-kit
```
--------------------------------
### Install node-postgres driver
Source: https://neon.com/docs/guides/cloudflare-workers
Install the PostgreSQL driver and its TypeScript definitions.
```bash
npm install pg
npm install -D @types/pg
```
--------------------------------
### Create and populate customers table
Source: https://neon.com/docs/functions/array_to_json
Setup script to create a table with an array column and insert sample data.
```sql
CREATE TABLE customers (
id SERIAL PRIMARY KEY,
name TEXT NOT NULL,
preferences TEXT[]
);
INSERT INTO customers (name, preferences)
VALUES ('John Doe', '{clothing, electronics}');
INSERT INTO customers (name, preferences)
VALUES ('Jane Doe', '{books, music, travel}');
```
--------------------------------
### Install the anon extension
Source: https://neon.com/docs/extensions/postgresql-anonymizer
Installs the anonymization extension into the current database.
```sql
CREATE EXTENSION IF NOT EXISTS anon;
```
--------------------------------
### Create Environment File
Source: https://neon.com/docs/guides/auth-clerk
Initializes the .env file for storing database and authentication credentials.
```bash
touch .env
```
--------------------------------
### Install dependencies
Source: https://neon.com/docs/compute/functions/get-started
Install necessary packages for Hono and Postgres integration.
```bash
npm install @neon/config hono pg
npm install --save-dev @types/pg
```
--------------------------------
### Initialize project directory
Source: https://neon.com/docs/guides/aws-lambda
Commands to create and enter a new project directory.
```bash
mkdir neon-lambda
cd neon-lambda
```
--------------------------------
### Initialize Neon Project
Source: https://neon.com/docs/ai/agent-skills
Run the neon init command to authenticate, configure the MCP server, and install agent skills.
```bash
npx neon@latest init
```
```bash
npx neon@latest init --preview
```
--------------------------------
### Install Node.js Dependencies
Source: https://neon.com/docs/auth/guides/plugins/jwt
Install the jose library for JWT verification.
```bash
npm install jose
```