This is a library to alternate and self-host the Prisma Data Proxy (cloud.prisma.io).
In order to deploy your project to edge runtimes (such as Cloudflare Workers or Vercel Edge Functions) and use Prisma, you will need to use the Prisma Data Proxy.
However, at present, instances can only be built in limited areas, and there are also delays caused by cold standby. This is a very stressful problem.
Therefore, we have created a server library to replace Prisma Data Proxy. With it, you are free from stressful limitations. You can deploy it on any platform in any region you like and use any data source you like, such as Supabase or Planetscale.
No changes are required to your prisma client code, just set the DATABASE_URL to the URL you self-hosted with this library.
This is not an official library, but it works the same as Prisma Data Proxy.
Using the Alternative Prisma Data Proxy, a significant reduction in clause latency can be expected regardless of the region of the instance. See here for details.
If you are using @prsima/client v3, install prisma-data-proxy-alt@^1.
The latest library (v2) suports only @prima/client v4.
yarn add prisma-data-proxy-altInclude prisma schema in your project. The same schema as the client.
cp your_client_project_path/prisma/schema.prisma ./prisma/schema.prismaInstall prisma and @prisma/client.
yarn add -D prisma
yarn add @prisma/clientGive environment variables by creating .env, etc.
PRISMA_SCHEMA_PATH=/absolute/path/for/your/schema.prisma
DATABASE_URL={database URL scheme e.g. postgresql://postgres:pass@db:5432/postgres?schema=public}
DATA_PROXY_API_KEY={random string for authentication}
PORT={server port e.g. 3000}
yarn pdpThis will bring up the proxy server, but it must be SSL-enabled to connect from @prisma/client.
So here are the steps to establish a local connection with SSL using docker-compose and https-portal with a self certificate.
Create entrypoint.sh.
#!/bin/sh
yarn install
exec "$@"Create docker-compose.yml.
version: '3'
services:
data-proxy:
image: node:18-bullseye-slim
working_dir: /app
ports:
- "3000:3000"
entrypoint: /app/entrypoint.sh
command: yarn pdp
environment:
PRISMA_SCHEMA_PATH: /app/for/your/schema.prisma
DATABASE_URL: your DATABASE_URL
DATA_PROXY_API_KEY: your DATA_PROXY_API_KEY
PORT: "3000"
volumes:
- ./:/app:cached
- node_modules:/app/node_modules
https-portal:
image: steveltn/https-portal:1
ports:
- "443:443"
environment:
STAGE: local
DOMAINS: 'localhost -> http://data-proxy:3000'
volumes:
- ./ssl-certs:/var/lib/https-portal
volumes:
node_modules:docker-compose upNow you can connect with data proxy with DATABASE_URL=prisma://localhost?api_key={DATA_PROXY_API_KEY}.
Create Dockerfile
FROM node:16.15-bullseye-slim as base
RUN apt-get update && apt-get install -y tini ca-certificates \
&& apt-get clean \
&& rm -rf /var/lib/apt/lists/*
WORKDIR /app
FROM base as builder
COPY package.json .
COPY yarn.lock .
COPY prisma/schema.prisma ./prisma/schema.prisma
RUN yarn install
RUN yarn prisma generate
FROM base
COPY --from=builder /app/node_modules ./node_modules
COPY --from=builder /app/package.json ./package.json
ENV PRISMA_SCHEMA_PATH=/app/node_modules/.prisma/client/schema.prisma
USER node
ENTRYPOINT ["/usr/bin/tini", "--"]
CMD ["yarn", "pdp"]Create cloudbuild.yml
steps:
- name: 'gcr.io/kaniko-project/executor:latest'
args:
- --destination=gcr.io/$PROJECT_ID/prisma-data-proxy-alt:$SHORT_SHA
- --destination=gcr.io/$PROJECT_ID/prisma-data-proxy-alt:latest
- --cache=true
- name: 'gcr.io/google.com/cloudsdktool/cloud-sdk'
entrypoint: gcloud
args:
- run
- deploy
- prisma-data-proxy-alt
- --image
- gcr.io/$PROJECT_ID/prisma-data-proxy-alt:latest
- --region
- $_REGION
- --allow-unauthenticated
- --set-env-vars
- DATABASE_URL=$_DATABASE_URL
- --set-env-vars
- DATA_PROXY_API_KEY=$_DATA_PROXY_API_KEY
substitutions:
_REGION: asia-northeast1
_DATABASE_URL: your_database_url
_DATA_PROXY_API_KEY: your_api_keyCreate a new trigger from the GCP Cloud Build web console and link it to your repository.
Set _REGION, _DATABASE_URL, and _DATA_PROXY_API_KEY in the substitution values.
_REGION: The region of deploy target for Cloud Run_DATABASE_URL: Connection URL to your data source (mysql, postgres, etc...)_DATA_PROXY_API_KEY: Arbitrary string to be used when connecting data proxy. e.g.prisma://your.deployed.domain?api_key={DATA_PROXY_API_KEY}
(do not divulge it to outside parties)
On the client side, generate the Prisma client in data proxy mode --data-proxy. official document
yarn prisma generate --data-proxySet the DATABSE_URL from the domain of the server you deployed and the api key (DATA_PROXY_API_KEY) you set for it.
DATABSE_URL=prisma://${YOUR_DEPLOYED_PROJECT_DOMAIN}?api_key=${DATA_PROXY_API_KEY}
Now you can connect to the (alternative) Data Proxy from your application. 🎉
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
This project is licensed under the MIT License - see the LICENSE file for details
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent