Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix documentation about compileSqlOnError #463

Merged
merged 1 commit into from
Sep 23, 2022
Merged

Fix documentation about compileSqlOnError #463

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/guide/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -455,11 +455,11 @@ const knex = require('knex')({

### compileSqlOnError

Knex builds an error message in case of query error. To avoid leaking sensitive values, the parameterized SQL (`SELECT * FROM users WHERE password = ?`) will be added to the message by default, this can be changed to compiled SQL (`SELECT * FROM users WHERE password = 'myPassword'`) by setting `compileSqlOnError` to true.
Knex builds an error message in case of query error. By default Knex adds compiled SQL (`SELECT * FROM users WHERE password = 'myPassword'`) to the error message. This can be changed to parameterized SQL (`SELECT * FROM users WHERE password = ?`) by setting `compileSqlOnError` to `false`.

```js
const knex = require('knex')({
compileSqlOnError: true
compileSqlOnError: false
});
```

Expand Down