Prisma Plugin for Godspeed
Overview
Prisma-as-datasource plugin provides functionality to access most popular databases like, PostgreSQL, MySQL, SQL Server, SQLite, MongoDB, CockroachDB, Planetscale and MariaDB through Prisma ORM.
"Prisma: Bridging Databases for Seamless Development. One Toolkit, Any Database."
Prisma is a modern and open-source database toolkit that simplifies database access for developers. It offers a strongly typed query builder, schema migrations, support for various databases, real-time data synchronization, and enhanced security, making it a powerful tool for efficient and secure database interactions in web applications.
How to Add plugin
Create a godspeed project from the CLI, open the created project in vscode and then add the plugin:
godspeed plugin add @godspeedsystems/plugins-prisma-as-datastore
Related files
You will find a file in your project related to the Prisma plugin at src/datasources/types/prisma.ts.
import { DataSource } from '@godspeedsystems/plugins-prisma-as-datastore';
export default DataSource;
How to use
1. Write a prisma schema
1.1 You can start using this plugin by writing a prisma schema. For this you need to create a file with .prisma extension inside src/datasources/.
1.2 Set the url field of the datasource block in your schema to your database connection URL as shown below:
src/datasources/schema.prisma
datasource db {
provider = "mysql" // name of database provider
url = env("DB_URL") // DB_URL string will be added in .env file
}
generator client {
provider = "prisma-client-js"
output = "./prisma-clients/dbName"
previewFeatures = ["metrics"]
}
Set provider to the type of database you are using. In this case it’s mysql. The url property will take the value of the connection url which is defined in the .env file.
2. Set your Database Connection URL
Set your Database Connection URL as environment variable in .env file as per the format. The format of the connection URL for your database depends on the database you use. For PostgreSQL, it looks as below
DB_URL = postgresql://USER:PASSWORD@HOST:PORT/DATABASE
The parts spelled all-uppercased are placeholders for your specific connection details
Example Connection String
DB_URL = "postgresql://johndoe:password@localhost:5432/mydb?schema=public"
3. Generate data models
The next step is to generate or define the data models. Prisma uses the connection url you provided to connect to the database.
3.1 If you have an existing database
To connect with your existing database, first install prisma and run prisma db pull command by giving path of your schema.prisma file.
npm install prisma --save-dev
prisma db pull --schema = src/datasources/schema.prisma
If the command has run successfully Prisma will generate models from your database server and save in schema.prisma file. If the Prisma schema is new to you, have a look at their documentation.
3.2 If you don't have an existing database,
Then add the data models to your Prisma schema in datasources/schema.prisma as:
Sample prisma schema
datasource db {
provider = "PostgreSQL" // database provider name which you are using
url = env("DB_URL") // DB_URL is the name of env variable
}
generator client {
provider = "prisma-client-js"
output = "./prisma-clients/schema" // dbName should be same as prisma schema file name
previewFeatures = ["metrics"]
}
model User {
id Int @id @default(autoincrement())
email String @unique
name String?
posts Post[]
}
model Post {
id Int @id @default(autoincrement())
title String
content String?
published Boolean @default(false)
author User @relation(fields: [authorId], references: [id])
authorId Int
}
By default, only single prisma schema can be created in a project that can use only one database. To support multiple prisma schemas for different databases, you need to add output key in generator client block as given in the above sample prisma schema.
4. Generate prisma client
Run godspeed prisma prepare. It will generate your prisma client for given schema and will place the generated client in the src/datasources/prisma-clients/ folder. This is achieved internally by prisma generate command.
It will also setup the provided schema on database. This is achieved internally by the command prisma db push
$ godspeed prisma prepare
Once you generated prisma client, multiple clients get generated in src/datasources/prisma-clients directory. Godspeed automatically loads all the clients present in this directory.
Generate CRUD APIs
You can generate the CRUD API'S by entering the below command:
godspeed gen-crud-api
This command will generate the crud apis based on the sample schema provided at ./src/datasources/schema.prisma
You can now view events and workflows generated under events and functions folder. They follow a structure similar to the APIs below.
Sample API
If your schema name is mysql.prisma and model name is 'post', then your event and workflow to fetch data from the database, will look like :
http.get./mysql/post/{id}:
summary: Fetch Post
description: Fetch Post from database
fn: com.biz.mysql.post.one
params:
- name: id
in: path
required: true
schema:
type: string
responses:
content:
application/json:
schema:
type: object
import { GSContext, GSStatus, PlainObject } from "@godspeedsystems/core";
import { PrismaClient } from "@prisma/client";
module.exports = async (ctx: GSContext, args: PlainObject) => {
const { inputs: { data: { params } }, logger, datasources } = ctx;
const client: PrismaClient = datasources.mysql.client;
const response = await client.Post.findUnique({
where: { id: params.id }
});
return new GSStatus(true, 200, "Post fetched", response, undefined );
}
More Examples
Check more typescript function examples to interact with prisma datasource
Database Encryption
Godspeed provides AES-256 GCM both way deterministic hashing encryption in Prisma plugin. You can apply encryption only on String type fields.
Annotate prisma schema
In your prisma schema, add /// @encrypted annotation to the fields you want to encrypt.
sample schema to encrypt email field
Add secret
You can specify secret in prisma_secret variable in config environment variables.