knex.js - debug only SQL

Question

Is there any way to display only SQL queries on console when debugging mode is on? I want to reduce the amount of informations which is displayed.

Thanks for the help ;)

see https://stackoverflow.com/questions/50096957/how-can-i-view-the-query-knex-builds/70488259#70488259 — John Lobo, Dec 27 '21 at 03:31

score 51 · Answer 1 · answered Apr 27 '16 at 15:45

51

Set environment variables to configure the debug module:

DEBUG=knex:query for just queries
DEBUG=knex:tx for transactions
and DEBUG=knex* for everything.

answered Apr 27 '16 at 15:45

timruffs

910
8
9

2

after setting env then how to debug while running app? – user269867 Sep 29 '17 at 21:37
3

Much better answer than the one accepted or the other one where you need to register function that logs queries. Works really well! – iaforek Apr 19 '18 at 08:19

score 21 · Answer 2 · answered Jan 29 '16 at 09:19

21

If what you need is to show the query string, one way is to register a function that logs the query data using the event 'query' that Knex emit just before executing the query.

For example:

var knex = require( 'knex' );
knex.on( 'query', function( queryData ) {
    console.log( queryData );
});

After that, before every query, the anonymous function is called and queryData contains json with the information about the query.

answered Jan 29 '16 at 09:19

Emanuele Benedetti

520
5
10

I did this, but I got `TypeError: undefined is not a function` error. – Najafsen Sep 23 '16 at 17:17
11

This can be shortened to `knex.on('query', console.log)`. – Harpo Jaeger Jul 10 '18 at 18:08

score 7 · Accepted Answer · answered Jan 22 '14 at 20:43

7

Actually, if you're using MySQL, you can set

debug: ['ComQueryPacket']

as part of the config settings for mysql (not Knex).

I'll looking into adding this as an option in Knex though.

answered Jan 22 '14 at 20:43

tgriesser

2,808
1
22
22

knex.js - debug only SQL

3 Answers3