Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/unlight/prisma-query-log
Log prisma query event
https://github.com/unlight/prisma-query-log
prisma prisma-client
Last synced: 6 days ago
JSON representation
Log prisma query event
- Host: GitHub
- URL: https://github.com/unlight/prisma-query-log
- Owner: unlight
- License: mit
- Created: 2020-12-25T16:35:27.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2024-07-01T17:47:29.000Z (4 months ago)
- Last Synced: 2024-10-05T17:18:18.875Z (about 1 month ago)
- Topics: prisma, prisma-client
- Language: TypeScript
- Homepage:
- Size: 97.7 KB
- Stars: 24
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# prisma-query-log
Log prisma query event.
Currently works only for SQLite, MySQL.
Features:
- Substitute parameters
- Remove backticks and database prefix
## Install
```sh
npm install --save-dev prisma-query-log
```
## Usage
```typescript
import { createPrismaQueryEventHandler } from 'prisma-query-log';
import { PrismaClient } from '@prisma/client';
const prisma = new PrismaClient({
log: [
{
level: 'query',
emit: 'event',
},
],
});
const log = createPrismaQueryEventHandler();
prisma.$on('query', log);
```
## API
```ts
function createPrismaQueryEventHandler(
options?: CreatePrismaQueryEventHandlerArgs,
): (event: PrismaQueryEvent) => void;
const defaultOptions = {
/**
* Boolean of custom log function,
* if true `console.log` will be used,
* if false noop - logs nothing.
*/
logger: true as boolean | ((query: string) => unknown),
/**
* Remove backticks.
*/
unescape: true,
/**
* Color of query (ANSI escape code)
*/
colorQuery: undefined as undefined | string,
/**
* Color of parameters (ANSI escape code)
*/
colorParameter: undefined as undefined | string,
/**
* Format SQL query,
* colorQuery/colorParameter will be ignored.
*/
format: false,
/**
* Formatter options
* https://github.com/mtxr/vscode-sqltools/tree/master/packages/formatter#options
*/
/**
* Show Query Duration, default is false
*/
queryDuration: false as boolean,
/**
* Query language, default is Standard SQL
*/
language: undefined as 'sql' | 'n1ql' | 'db2' | 'pl/sql' | undefined,
/**
* Characters used for indentation
*/
indent: ' ',
/**
* How to change the case of reserved words
*/
// eslint-disable-next-line unicorn/no-null
reservedWordCase: null as 'upper' | 'lower' | null,
/**
* How many line breaks between queries
*/
linesBetweenQueries: 1 as number | 'preserve',
};
```
## Other projects
https://github.com/unlight/nestolog - Logger for NestJS, implements `LoggerService`
## Screenshots
#### Before
#### After
## Development
```sh
docker run -it -p 5432:5432 -e POSTGRES_PASSWORD=postgres -e POSTGRES_USER=user postgres
docker run -it -p 3306:3306 -e MYSQL_ROOT_PASSWORD=password -e MYSQL_DATABASE=query_log_example_db mysql
```