feathers-prisma
Installation
npm install feathers-prisma --save
Documentation
This adapter supports all methods (create
, delete
, update
, patch
, find
, get
) and the common way for querying (equality
, $limit
, $skip
, $sort
, $select
, $in
, $nin
, $lt
, $lte
, $gt
, $gte
, $ne
, $or
). Also supports eager loading ($eager
) and full-text search ($search
).
Setup
import feathers from "@feathersjs/feathers";
import { service } from "feathers-prisma";
import { PrismaClient } from "@prisma/client";
// Initialize the application
const app = feathers();
// Initialize the plugin
const prismaClient = new PrismaClient();
prismaClient.$connect();
app.set("prisma", prismaClient);
const paginate = {
default: 10,
max: 50,
};
app.use(
"/messages",
service(
{
model: "messages",
paginate,
multi: ["create", "patch", "remove"],
whitelist: ["$eager"],
},
prismaClient
)
);
Eager Loading / Relation Queries
Relations can be resolved via $eager
property in your query. It supports also deep relations. The $eager
property has to be set in the whitelist
option parameter. Otherwise the service will throw an error.
app.use(
"/messages",
service(
{
model: "message",
whitelist: ["$eager"],
},
prismaClient
)
);
// will load the recipients with the related user
// as well as all attachments of the messages
app.service("messages").find({
query: {
$eager: [["recipients", ["user"]], "attachments"],
},
});
Batch requests
This adapter supports batch requests. This is possible by allowing this in the multi
property in the service options. Supported methods are create
, patch
and delete
.
app.use(
"/messages",
service(
{
model: "messages",
multi: ["create", "patch", "delete"],
},
prismaClient
)
);
app.service("messages").create([{ body: "Lorem" }, { body: "Ipsum" }]);
Full-Text Search
Prisma supports a full-text search which is currently in preview mode. Find out more how to activate it here. If you activated it through your schema you have to allow it in the whitelist
property:
app.use(
"/messages",
service(
{
model: "messages",
whitelist: ["$search"],
},
prismaClient
)
);
app.service("messages").find({
query: {
body: {
$search: "hello | hola",
},
},
});
Complete Example
Here's an example of a Feathers server that uses feathers-prisma
.
import feathers from "@feathersjs/feathers";
import { service } from "feathers-prisma";
// Initialize the application
const app = feathers();
// Initialize the plugin
const prismaClient = new PrismaClient();
prismaClient.$connect();
app.set("prisma", prismaClient);
const paginate = {
default: 10,
max: 50,
};
app.use(
"/messages",
service(
{
model: "messages",
paginate,
multi: ["create", "patch", "remove"],
whitelist: ["$eager"],
},
prismaClient
)
);
// Or if you want to extend the service class
import { PrismaService } from "feathers-prisma";
License
Copyright (c) 2021.
Licensed under the MIT license.