prisma-accelerate-local
TypeScript icon, indicating that this package has built-in type declarations

1.1.4 • Public • Published

prisma-accelerate-local

Prisma Accelerate functionality can be self-hosted locally.

Samples

usage

CLI Options

Category Option Description
USAGE [option] <url>
ARGUMENTS <url> Datasource url
OPTIONS -t, --http Accepted at http
-p, --port <port> Port to listen on (default:4000)
-h, --host <host> Host to listen on (default:localhost)
-c, --cert <path> Path to ssl cert file
-k, --key <path> Path to ssl key file
-w, --wasm Use wasm as the run-time engine(early-access)
-s, --secret <secret> Secret used with API key
-m, --make make api key
-b, --bodyLimit <size(MB)> body limit size(default: 16MB)

CLI

Start without setting an API key for local use.

# Startup by specifying the Datasource url
npx prisma-accelerate-local postgresql://postgres:password@localhost:5432/postgres

# Startup by specifying Port
npx prisma-accelerate-local postgresql://postgres:password@localhost:5432/postgres -p 8000

When setting the API key

  • Create an API key
npx prisma-accelerate-local -s secret -m postgresql://postgres:password@localhost:5432/postgres

# Output
eyJhbGciOiJIUzI1NiJ9.eyJkYXRhc291cmNlVXJsIjoiYSIsImlhdCI6MTcwMzY2NDg1NywiaXNzIjoicHJpc21hLWFjY2VsZXJhdGUifQ.4ruaA1RAT9cD3PACSEVIdUs3i2exKkMpNYGks3hyos4
  • Activate with API key enabled.

If secret is used, the DB address is embedded in the API key

npx prisma-accelerate-local -s secret

Client Environment Variables

With regard to the Node.js configuration.

Please set the environment variable NODE_TLS_REJECT_UNAUTHORIZED because you are using an unauthenticated certificate.

With regard to api_key

  • If you are not using secret, the api_key can be any string.
  • If you are using secret, put --secret and the api_key created with --make in api_key

Example

  • .env
DATABASE_URL="prisma://localhost:4000/?api_key=API_KEY"
NODE_TLS_REJECT_UNAUTHORIZED="0"
# To remove the NODE_TLS_REJECT_UNAUTHORIZED warning
NODE_NO_WARNINGS="1"

library

If you call this package as a library, it will look like this.

import { createServer } from 'prisma-accelerate-local';

const server = createServer({
  datasourceUrl: 'postgresql://postgres:password@localhost:5432/postgres',
})
  .listen({ port: 4000 })
  .then((url) => console.log(`🚀  Server ready at ${url} `));

Readme

Keywords

none

Package Sidebar

Install

npm i prisma-accelerate-local

Weekly Downloads

449

Version

1.1.4

License

MIT

Unpacked Size

60.7 kB

Total Files

16

Last publish

Collaborators

  • sora_kumo