Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/s1owjke/prisma-query-formatter
Small utility for Prisma query formatting and param substitution
https://github.com/s1owjke/prisma-query-formatter
database logging prisma prisma-client prisma-extension query
Last synced: 30 days ago
JSON representation
Small utility for Prisma query formatting and param substitution
- Host: GitHub
- URL: https://github.com/s1owjke/prisma-query-formatter
- Owner: s1owjke
- License: mit
- Created: 2024-05-17T14:24:57.000Z (7 months ago)
- Default Branch: master
- Last Pushed: 2024-10-04T13:18:30.000Z (2 months ago)
- Last Synced: 2024-11-10T02:42:55.083Z (about 1 month ago)
- Topics: database, logging, prisma, prisma-client, prisma-extension, query
- Language: TypeScript
- Homepage:
- Size: 95.7 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-prisma - prisma-query-formatter - Substitute params and format queries for logging
README
# Prisma Query Formatter
[](https://www.npmjs.com/package/prisma-query-formatter) [](https://opensource.org/licenses/MIT)
This small zero-dependency utility correctly formats Prisma queries by substituting placeholders with their corresponding values, support all databases including PostgreSQL.
Internally, Prisma uses its [own](https://github.com/prisma/prisma-engines/blob/5.13.0/quaint/src/ast/values.rs#L547) Rust implementation for stringifying params, so you couldn't just use `JSON.parse` to convert them back to an array (sometimes it's not valid json, like double quotes are not escaped in strings).
Note that this utility is designed for logging purposes only, because Prisma irreversibly converts some types of parameters, such as [blobs](https://github.com/prisma/prisma-engines/blob/5.13.0/quaint/src/ast/values.rs#L571).
## How to use it
Just register a query event handler and use the `formatQuery` util to substitute the query params (don't forget to enable [event-based](https://www.prisma.io/docs/orm/reference/prisma-client-reference#log) logging in your Prisma client configuration).
```typescript
import { PrismaClient } from "@prisma/client";
import { formatQuery } from "prisma-query-formatter";
const prisma = new PrismaClient({
log: [
{ emit: "event", level: "query" },
],
});
prisma.$on("query", (e) => {
console.log(formatQuery(e.query, e.params));
});
```
For example, this query:
```typescript
await db.user.findUnique({
select: { id: true },
where: { email: "[email protected]" },
});
```
Will be logged to the console as:
```text
SELECT `User`.`id` FROM `User` WHERE `User`.`email` = "[email protected]"
```
## Error handling
The library now performs a validation to ensure that the number of placeholders in a query matches the number of params, as a mismatch may indicate an error.
- If there is a mismatch and the option `throwOnError` is set to true, it will throw an error
- If `throwOnError` is set to false (default value), it will return the concatenated query and parameters as is
Here is an example with error handler:
```typescript
prisma.$on("query", (e) => {
try {
console.log(formatQuery(e.query, e.params, { throwOnError: true }));
} catch {
console.log(`${e.query} ${e.params}`);
}
});
```
## Query formatting
All whitespace symbols in multiline queries (usually raw queries written manually) will be replaced with single space, for example:
```typescript
await db.$queryRaw`
SELECT
DISTINCT role
FROM User
WHERE
status = ${Status.Active}
`;
```
Will be logged with params as:
```text
SELECT DISTINCT role FROM User WHERE status = "Active"
```
To escape whitespace symbols such as `\f\n\r\t\v` in params, use the `escapeParams` option (false by default), this will allow you to output multiline strings more concisely (all your logs will be on one line).
```typescript
prisma.$on("query", (e) => {
console.log(formatQuery(e.query, e.params, { escapeParams: true }));
});
```
And then, they will be displayed like this:
```text
SELECT `Post`.`id` FROM `Post` WHERE `Post`.`title` = "first\nsecond"
```