;
+ }
+ }
+}
+```
+
+2. Add the new `@types` folder to `typeRoots` in your `tsconfig.json`.
+
+```json
+// tsconfig.json
+{
+ "compilerOptions": {
+ "typeRoots": ["node_modules/@types", "@types"]
+ }
+}
+```
+
+## Where Clauses
+
+Several methods exist to assist in dynamic where clauses. In many places functions may be used in place of values, constructing subqueries. In most places existing knex queries may be used to compose sub-queries, etc. Take a look at a few of the examples for each method for instruction on use:
+
+**Important:** Supplying knex with an `undefined` value to any of the `where` functions will cause knex to throw an error during sql compilation. This is both for yours and our sake. Knex cannot know what to do with undefined values in a where clause, and generally it would be a programmatic error to supply one to begin with. The error will throw a message containing the type of query and the compiled query-string. Example:
+
+```js
+knex('accounts').where('login', undefined).select().toSQL();
+```
+
+### where
+
+**.where(~mixed~)**
+**.orWhere**
+
+Object Syntax:
+
+```js
+knex('users')
+ .where({
+ first_name: 'Test',
+ last_name: 'User',
+ })
+ .select('id');
+```
+
+Key, Value:
+
+```js
+knex('users').where('id', 1);
+```
+
+Functions:
+
+```js
+knex('users')
+ .where((builder) =>
+ builder.whereIn('id', [1, 11, 15]).whereNotIn('id', [17, 19])
+ )
+ .andWhere(function () {
+ this.where('id', '>', 10);
+ });
+```
+
+Grouped Chain:
+
+```js
+knex('users')
+ .where(function () {
+ this.where('id', 1).orWhere('id', '>', 10);
+ })
+ .orWhere({ name: 'Tester' });
+```
+
+Operator:
+
+```js
+knex('users').where('columnName', 'like', '%rowlikeme%');
+```
+
+The above query demonstrates the common use case of returning all users for which a specific pattern appears within a designated column.
+
+```js
+knex('users').where('votes', '>', 100);
+
+const subquery = knex('users')
+ .where('votes', '>', 100)
+ .andWhere('status', 'active')
+ .orWhere('name', 'John')
+ .select('id');
+
+knex('accounts').where('id', 'in', subquery);
+```
+
+.orWhere with an object automatically wraps the statement and creates an `or (and - and - and)` clause
+
+```js
+knex('users').where('id', 1).orWhere({ votes: 100, user: 'knex' });
+```
+
+### whereNot
+
+**.whereNot(~mixed~)**
+**.orWhereNot**
+
+Object Syntax:
+
+```js
+knex('users')
+ .whereNot({
+ first_name: 'Test',
+ last_name: 'User',
+ })
+ .select('id');
+```
+
+Key, Value:
+
+```js
+knex('users').whereNot('id', 1);
+```
+
+Grouped Chain:
+
+```js
+knex('users')
+ .whereNot(function () {
+ this.where('id', 1).orWhereNot('id', '>', 10);
+ })
+ .orWhereNot({ name: 'Tester' });
+```
+
+Operator:
+
+```js
+knex('users').whereNot('votes', '>', 100);
+```
+
+::: warning
+WhereNot is not suitable for "in" and "between" type subqueries. You should use "not in" and "not between" instead.
+:::
+
+```js
+const subquery = knex('users')
+ .whereNot('votes', '>', 100)
+ .andWhere('status', 'active')
+ .orWhere('name', 'John')
+ .select('id');
+
+knex('accounts').where('id', 'not in', subquery);
+```
+
+### whereIn
+
+**.whereIn(column|columns, array|callback|builder)**
+**.orWhereIn**
+
+Shorthand for .where('id', 'in', obj), the .whereIn and .orWhereIn methods add a "where in" clause to the query. Note that passing empty array as the value results in a query that never returns any rows (`WHERE 1 = 0`)
+
+```js
+knex
+ .select('name')
+ .from('users')
+ .whereIn('id', [1, 2, 3])
+ .orWhereIn('id', [4, 5, 6]);
+
+knex
+ .select('name')
+ .from('users')
+ .whereIn('account_id', function () {
+ this.select('id').from('accounts');
+ });
+
+const subquery = knex.select('id').from('accounts');
+
+knex.select('name').from('users').whereIn('account_id', subquery);
+
+knex
+ .select('name')
+ .from('users')
+ .whereIn(
+ ['account_id', 'email'],
+ [
+ [3, 'test3@example.com'],
+ [4, 'test4@example.com'],
+ ]
+ );
+
+knex
+ .select('name')
+ .from('users')
+ .whereIn(
+ ['account_id', 'email'],
+ knex.select('id', 'email').from('accounts')
+ );
+```
+
+### whereNotIn
+
+**.whereNotIn(column, array|callback|builder)**
+**.orWhereNotIn**
+
+```js
+knex('users').whereNotIn('id', [1, 2, 3]);
+
+knex('users').where('name', 'like', '%Test%').orWhereNotIn('id', [1, 2, 3]);
+```
+
+### whereNull
+
+**.whereNull(column)**
+**.orWhereNull**
+
+```js
+knex('users').whereNull('updated_at');
+```
+
+### whereNotNull
+
+**.whereNotNull(column)**
+**.orWhereNotNull**
+
+```js
+knex('users').whereNotNull('created_at');
+```
+
+### whereExists
+
+**.whereExists(builder | callback)**
+**.orWhereExists**
+
+```js
+knex('users').whereExists(function () {
+ this.select('*').from('accounts').whereRaw('users.account_id = accounts.id');
+});
+
+knex('users').whereExists(
+ knex.select('*').from('accounts').whereRaw('users.account_id = accounts.id')
+);
+```
+
+### whereNotExists
+
+**.whereNotExists(builder | callback)**
+**.orWhereNotExists**
+
+```js
+knex('users').whereNotExists(function () {
+ this.select('*').from('accounts').whereRaw('users.account_id = accounts.id');
+});
+
+knex('users').whereNotExists(
+ knex.select('*').from('accounts').whereRaw('users.account_id = accounts.id')
+);
+```
+
+### whereBetween
+
+**.whereBetween(column, range)**
+**.orWhereBetween**
+
+```js
+knex('users').whereBetween('votes', [1, 100]);
+```
+
+### whereNotBetween
+
+**.whereNotBetween(column, range)**
+**.orWhereNotBetween**
+
+```js
+knex('users').whereNotBetween('votes', [1, 100]);
+```
+
+### whereRaw
+
+**.whereRaw(query, [bindings])**
+
+Convenience helper for .where(knex.raw(query)).
+
+```js
+knex('users').whereRaw('id = ?', [1]);
+```
+
+### whereLike
+
+**.whereLike(column, string|builder|raw)**
+**.orWhereLike**
+
+Adds a where clause with case-sensitive substring comparison on a given column with a given value.
+
+```js
+knex('users').whereLike('email', '%mail%');
+
+knex('users')
+ .whereLike('email', '%mail%')
+ .andWhereLike('email', '%.com')
+ .orWhereLike('email', '%name%');
+```
+
+### whereILike
+
+**.whereILike(column, string|builder|raw)**
+**.orWhereILike**
+
+Adds a where clause with case-insensitive substring comparison on a given column with a given value.
+
+```js
+knex('users').whereILike('email', '%mail%');
+
+knex('users')
+ .whereILike('email', '%MAIL%')
+ .andWhereILike('email', '%.COM')
+ .orWhereILike('email', '%NAME%');
+```
+
+### whereJsonObject
+
+**.whereJsonObject(column, string|json|builder|raw)**
+
+Adds a where clause with json object comparison on given json column.
+
+```js
+knex('users').whereJsonObject('json_col', { name: 'user_name' });
+```
+
+### whereJsonPath
+
+**.whereJsonPath(column, jsonPath, operator, value)**
+
+Adds a where clause with comparison of a value returned by a JsonPath given an operator and a value.
+
+```js
+knex('users').whereJsonPath('json_col', '$.age', '>', 18);
+
+knex('users').whereJsonPath('json_col', '$.name', '=', 'username');
+```
+
+### whereJsonSupersetOf
+
+**.whereJsonSupersetOf(column, string|json|builder|raw)**
+
+Adds a where clause where the comparison is true if a json given by the column include a given value. Only on MySQL, PostgreSQL and CockroachDB.
+
+```js
+knex('users').whereJsonSupersetOf('hobbies', { sport: 'foot' });
+```
+
+### whereJsonSubsetOf
+
+**.whereJsonSubsetOf(column, string|json|builder|raw)**
+
+Adds a where clause where the comparison is true if a json given by the column is included in a given value. Only on MySQL, PostgreSQL and CockroachDB.
+
+```js
+// given a hobby column with { "sport" : "tennis" },
+// the where clause is true
+knex('users').whereJsonSubsetOf('hobby', { sport: 'tennis', book: 'fantasy' });
+```
+
+## Join Methods
+
+Several methods are provided which assist in building joins.
+
+### join
+
+**.join(table, first, [operator], second)**
+
+The join builder can be used to specify joins between tables, with the first argument being the joining table, the next three arguments being the first join column, the join operator and the second join column, respectively.
+
+```js
+knex('users')
+ .join('contacts', 'users.id', '=', 'contacts.user_id')
+ .select('users.id', 'contacts.phone');
+
+knex('users')
+ .join('contacts', 'users.id', 'contacts.user_id')
+ .select('users.id', 'contacts.phone');
+```
+
+For grouped joins, specify a function as the second argument for the join query, and use `on` with `orOn` or `andOn` to create joins that are grouped with parentheses.
+
+```js
+knex
+ .select('*')
+ .from('users')
+ .join('accounts', function () {
+ this.on('accounts.id', '=', 'users.account_id').orOn(
+ 'accounts.owner_id',
+ '=',
+ 'users.id'
+ );
+ });
+```
+
+For nested join statements, specify a function as first argument of `on`, `orOn` or `andOn`
+
+```js
+knex
+ .select('*')
+ .from('users')
+ .join('accounts', function () {
+ this.on(function () {
+ this.on('accounts.id', '=', 'users.account_id');
+ this.orOn('accounts.owner_id', '=', 'users.id');
+ });
+ });
+```
+
+It is also possible to use an object to represent the join syntax.
+
+```js
+knex
+ .select('*')
+ .from('users')
+ .join('accounts', { 'accounts.id': 'users.account_id' });
+```
+
+If you need to use a literal value (string, number, or boolean) in a join instead of a column, use `knex.raw`.
+
+```js
+knex
+ .select('*')
+ .from('users')
+ .join('accounts', 'accounts.type', knex.raw('?', ['admin']));
+```
+
+### innerJoin
+
+**.innerJoin(table, ~mixed~)**
+
+```js
+knex.from('users').innerJoin('accounts', 'users.id', 'accounts.user_id');
+
+knex.table('users').innerJoin('accounts', 'users.id', '=', 'accounts.user_id');
+
+knex('users').innerJoin('accounts', function () {
+ this.on('accounts.id', '=', 'users.account_id').orOn(
+ 'accounts.owner_id',
+ '=',
+ 'users.id'
+ );
+});
+```
+
+### leftJoin
+
+**.leftJoin(table, ~mixed~)**
+
+```js
+knex
+ .select('*')
+ .from('users')
+ .leftJoin('accounts', 'users.id', 'accounts.user_id');
+
+knex
+ .select('*')
+ .from('users')
+ .leftJoin('accounts', function () {
+ this.on('accounts.id', '=', 'users.account_id').orOn(
+ 'accounts.owner_id',
+ '=',
+ 'users.id'
+ );
+ });
+```
+
+### leftOuterJoin
+
+**.leftOuterJoin(table, ~mixed~)**
+
+```js
+knex
+ .select('*')
+ .from('users')
+ .leftOuterJoin('accounts', 'users.id', 'accounts.user_id');
+
+knex
+ .select('*')
+ .from('users')
+ .leftOuterJoin('accounts', function () {
+ this.on('accounts.id', '=', 'users.account_id').orOn(
+ 'accounts.owner_id',
+ '=',
+ 'users.id'
+ );
+ });
+```
+
+### rightJoin
+
+**.rightJoin(table, ~mixed~)**
+
+```js
+knex
+ .select('*')
+ .from('users')
+ .rightJoin('accounts', 'users.id', 'accounts.user_id');
+
+knex
+ .select('*')
+ .from('users')
+ .rightJoin('accounts', function () {
+ this.on('accounts.id', '=', 'users.account_id').orOn(
+ 'accounts.owner_id',
+ '=',
+ 'users.id'
+ );
+ });
+```
+
+### rightOuterJoin
+
+**.rightOuterJoin(table, ~mixed~)**
+
+```js
+knex
+ .select('*')
+ .from('users')
+ .rightOuterJoin('accounts', 'users.id', 'accounts.user_id');
+
+knex
+ .select('*')
+ .from('users')
+ .rightOuterJoin('accounts', function () {
+ this.on('accounts.id', '=', 'users.account_id').orOn(
+ 'accounts.owner_id',
+ '=',
+ 'users.id'
+ );
+ });
+```
+
+### fullOuterJoin
+
+**.fullOuterJoin(table, ~mixed~)**
+
+```js
+knex
+ .select('*')
+ .from('users')
+ .fullOuterJoin('accounts', 'users.id', 'accounts.user_id');
+
+knex
+ .select('*')
+ .from('users')
+ .fullOuterJoin('accounts', function () {
+ this.on('accounts.id', '=', 'users.account_id').orOn(
+ 'accounts.owner_id',
+ '=',
+ 'users.id'
+ );
+ });
+```
+
+### crossJoin
+
+**.crossJoin(table, ~mixed~)**
+
+Cross join conditions are only supported in MySQL and SQLite3. For join conditions rather use innerJoin.
+
+```js
+knex.select('*').from('users').crossJoin('accounts');
+
+knex
+ .select('*')
+ .from('users')
+ .crossJoin('accounts', 'users.id', 'accounts.user_id');
+
+knex
+ .select('*')
+ .from('users')
+ .crossJoin('accounts', function () {
+ this.on('accounts.id', '=', 'users.account_id').orOn(
+ 'accounts.owner_id',
+ '=',
+ 'users.id'
+ );
+ });
+```
+
+### joinRaw
+
+**.joinRaw(sql, [bindings])**
+
+```js
+knex
+ .select('*')
+ .from('accounts')
+ .joinRaw('natural full join table1')
+ .where('id', 1);
+
+knex
+ .select('*')
+ .from('accounts')
+ .join(knex.raw('natural full join table1'))
+ .where('id', 1);
+```
+
+## OnClauses
+
+### onIn
+
+**.onIn(column, values)**
+
+Adds a onIn clause to the query.
+
+```js
+knex
+ .select('*')
+ .from('users')
+ .join('contacts', function () {
+ this.on('users.id', '=', 'contacts.id').onIn(
+ 'contacts.id',
+ [7, 15, 23, 41]
+ );
+ });
+```
+
+### onNotIn
+
+**.onNotIn(column, values)**
+
+Adds a onNotIn clause to the query.
+
+```js
+knex
+ .select('*')
+ .from('users')
+ .join('contacts', function () {
+ this.on('users.id', '=', 'contacts.id').onNotIn(
+ 'contacts.id',
+ [7, 15, 23, 41]
+ );
+ });
+```
+
+### onNull
+
+**.onNull(column)**
+
+Adds a onNull clause to the query.
+
+```js
+knex
+ .select('*')
+ .from('users')
+ .join('contacts', function () {
+ this.on('users.id', '=', 'contacts.id').onNull('contacts.email');
+ });
+```
+
+### onNotNull
+
+**.onNotNull(column)**
+
+Adds a onNotNull clause to the query.
+
+```js
+knex
+ .select('*')
+ .from('users')
+ .join('contacts', function () {
+ this.on('users.id', '=', 'contacts.id').onNotNull('contacts.email');
+ });
+```
+
+### onExists
+
+**.onExists(builder | callback)**
+
+Adds a onExists clause to the query.
+
+```js
+knex
+ .select('*')
+ .from('users')
+ .join('contacts', function () {
+ this.on('users.id', '=', 'contacts.id').onExists(function () {
+ this.select('*')
+ .from('accounts')
+ .whereRaw('users.account_id = accounts.id');
+ });
+ });
+```
+
+### onNotExists
+
+**.onNotExists(builder | callback)**
+
+Adds a onNotExists clause to the query.
+
+```js
+knex
+ .select('*')
+ .from('users')
+ .join('contacts', function () {
+ this.on('users.id', '=', 'contacts.id').onNotExists(function () {
+ this.select('*')
+ .from('accounts')
+ .whereRaw('users.account_id = accounts.id');
+ });
+ });
+```
+
+### onBetween
+
+**.onBetween(column, range)**
+
+Adds a onBetween clause to the query.
+
+```js
+knex
+ .select('*')
+ .from('users')
+ .join('contacts', function () {
+ this.on('users.id', '=', 'contacts.id').onBetween('contacts.id', [5, 30]);
+ });
+```
+
+### onNotBetween
+
+**.onNotBetween(column, range)**
+
+Adds a onNotBetween clause to the query.
+
+```js
+knex
+ .select('*')
+ .from('users')
+ .join('contacts', function () {
+ this.on('users.id', '=', 'contacts.id').onNotBetween(
+ 'contacts.id',
+ [5, 30]
+ );
+ });
+```
+
+### onJsonPathEquals
+
+**.onJsonPathEquals(column, range)**
+
+Adds a onJsonPathEquals clause to the query. The clause performs a join on value returned by two json paths on two json columns.
+
+```js
+knex('cities')
+ .select('cities.name as cityName', 'country.name as countryName')
+ .join('country', function () {
+ this.onJsonPathEquals(
+ // json column in cities
+ 'country_name',
+ // json path to country name in 'country_name' column
+ '$.country.name',
+ // json column in country
+ 'description',
+ // json field in 'description' column
+ '$.name'
+ );
+ });
+```
+
+## ClearClauses
+
+### clear
+
+**.clear(statement)**
+
+Clears the specified operator from the query. Available operators: 'select' alias 'columns', 'with', 'select', 'columns', 'where', 'union', 'join', 'group', 'order', 'having', 'limit', 'offset', 'counter', 'counters'. Counter(s) alias for method .clearCounter()
+
+```js
+knex
+ .select('email', 'name')
+ .from('users')
+ .where('id', '<', 10)
+ .clear('select')
+ .clear('where');
+```
+
+### clearSelect
+
+**.clearSelect()**
+
+Deprecated, use clear('select'). Clears all select clauses from the query, excluding subqueries.
+
+```js
+knex.select('email', 'name').from('users').clearSelect();
+```
+
+### clearWhere
+
+**.clearWhere()**
+
+Deprecated, use clear('where'). Clears all where clauses from the query, excluding subqueries.
+
+```js
+knex.select('email', 'name').from('users').where('id', 1).clearWhere();
+```
+
+### clearGroup
+
+**.clearGroup()**
+
+Deprecated, use clear('group'). Clears all group clauses from the query, excluding subqueries.
+
+```js
+knex.select().from('users').groupBy('id').clearGroup();
+```
+
+### clearOrder
+
+**.clearOrder()**
+
+Deprecated, use clear('order'). Clears all order clauses from the query, excluding subqueries.
+
+```js
+knex.select().from('users').orderBy('name', 'desc').clearOrder();
+```
+
+### clearHaving
+
+**.clearHaving()**
+
+Deprecated, use clear('having'). Clears all having clauses from the query, excluding subqueries.
+
+```js
+knex.select().from('users').having('id', '>', 5).clearHaving();
+```
+
+### clearCounters
+
+**.clearCounters()**
+
+Clears all increments/decrements clauses from the query.
+
+```js
+knex('accounts')
+ .where('id', '=', 1)
+ .update({ email: 'foo@bar.com' })
+ .decrement({
+ balance: 50,
+ })
+ .clearCounters();
+```
+
+### distinct
+
+**.distinct([\*columns])**
+
+Sets a distinct clause on the query. If the parameter is falsy or empty array, method falls back to '\*'.
+
+```js
+// select distinct 'first_name' from customers
+knex('customers').distinct('first_name', 'last_name');
+
+// select which eliminates duplicate rows
+knex('customers').distinct();
+```
+
+### distinctOn
+
+**.distinctOn([\*columns])**
+
+PostgreSQL only. Adds a distinctOn clause to the query.
+
+```js
+knex('users').distinctOn('age');
+```
+
+### groupBy
+
+**.groupBy(\*names)**
+
+Adds a group by clause to the query.
+
+```js
+knex('users').groupBy('count');
+```
+
+### groupByRaw
+
+**.groupByRaw(sql)**
+
+Adds a raw group by clause to the query.
+
+```js
+knex
+ .select('year', knex.raw('SUM(profit)'))
+ .from('sales')
+ .groupByRaw('year WITH ROLLUP');
+```
+
+### orderBy
+
+**.orderBy(column|columns, [direction], [nulls])**
+
+Adds an order by clause to the query. column can be string, or list mixed with string and object. nulls specify where the nulls values are put (can be 'first' or 'last').
+
+Single Column:
+
+```js
+knex('users').orderBy('email');
+
+knex('users').orderBy('name', 'desc');
+
+knex('users').orderBy('name', 'desc', 'first');
+```
+
+Multiple Columns:
+
+```js
+knex('users').orderBy(['email', { column: 'age', order: 'desc' }]);
+
+knex('users').orderBy([{ column: 'email' }, { column: 'age', order: 'desc' }]);
+
+knex('users').orderBy([
+ { column: 'email' },
+ { column: 'age', order: 'desc', nulls: 'last' },
+]);
+```
+
+### orderByRaw
+
+**.orderByRaw(sql)**
+
+Adds an order by raw clause to the query.
+
+```js
+knex.select('*').from('table').orderByRaw('col DESC NULLS LAST');
+```
+
+## Having Clauses
+
+### having
+
+**.having(column, operator, value)**
+
+Adds a having clause to the query.
+
+```js
+knex('users')
+ .groupBy('count')
+ .orderBy('name', 'desc')
+ .having('count', '>', 100);
+```
+
+### havingIn
+
+**.havingIn(column, values)**
+
+Adds a havingIn clause to the query.
+
+```js
+knex.select('*').from('users').havingIn('id', [5, 3, 10, 17]);
+```
+
+### havingNotIn
+
+**.havingNotIn(column, values)**
+
+Adds a havingNotIn clause to the query.
+
+```js
+knex.select('*').from('users').havingNotIn('id', [5, 3, 10, 17]);
+```
+
+### havingNull
+
+**.havingNull(column)**
+
+Adds a havingNull clause to the query.
+
+```js
+knex.select('*').from('users').havingNull('email');
+```
+
+### havingNotNull
+
+**.havingNotNull(column)**
+
+Adds a havingNotNull clause to the query.
+
+```js
+knex.select('*').from('users').havingNotNull('email');
+```
+
+### havingExists
+
+**.havingExists(builder | callback)**
+
+Adds a havingExists clause to the query.
+
+```js
+knex
+ .select('*')
+ .from('users')
+ .havingExists(function () {
+ this.select('*')
+ .from('accounts')
+ .whereRaw('users.account_id = accounts.id');
+ });
+```
+
+### havingNotExists
+
+**.havingNotExists(builder | callback)**
+
+Adds a havingNotExists clause to the query.
+
+```js
+knex
+ .select('*')
+ .from('users')
+ .havingNotExists(function () {
+ this.select('*')
+ .from('accounts')
+ .whereRaw('users.account_id = accounts.id');
+ });
+```
+
+### havingBetween
+
+**.havingBetween(column, range)**
+
+Adds a havingBetween clause to the query.
+
+```js
+knex.select('*').from('users').havingBetween('id', [5, 10]);
+```
+
+### havingNotBetween
+
+**.havingNotBetween(column, range)**
+
+Adds a havingNotBetween clause to the query.
+
+```js
+knex.select('*').from('users').havingNotBetween('id', [5, 10]);
+```
+
+### havingRaw
+
+**.havingRaw(sql, [bindings])**
+
+Adds a havingRaw clause to the query.
+
+```js
+knex('users')
+ .groupBy('count')
+ .orderBy('name', 'desc')
+ .havingRaw('count > ?', [100]);
+```
diff --git a/docs/src/guide/raw.md b/docs/src/guide/raw.md
new file mode 100644
index 0000000000..a60ec0f49f
--- /dev/null
+++ b/docs/src/guide/raw.md
@@ -0,0 +1,138 @@
+# Raw
+
+Sometimes you may need to use a raw expression in a query. Raw query object may be injected pretty much anywhere you want, and using proper bindings can ensure your values are escaped properly, preventing SQL-injection attacks.
+
+## Raw Parameter Binding
+
+One can parameterize sql given to `knex.raw(sql, bindings)`. Parameters can be positional named. One can also choose if parameter should be treated as value or as sql identifier e.g. in case of `'TableName.ColumnName'` reference.
+
+```js
+knex('users')
+ .select(knex.raw('count(*) as user_count, status'))
+ .where(knex.raw(1))
+ .orWhere(knex.raw('status <> ?', [1]))
+ .groupBy('status');
+```
+
+Positional bindings `?` are interpreted as values and `??` are interpreted as identifiers.
+
+```js
+knex('users').where(knex.raw('?? = ?', ['user.name', 1]));
+```
+
+Named bindings such as `:name` are interpreted as values and `:name:` interpreted as identifiers. Named bindings are processed so long as the value is anything other than `undefined`.
+
+```js
+const raw =
+ ':name: = :thisGuy or :name: = :otherGuy or :name: = :undefinedBinding';
+
+knex('users').where(
+ knex.raw(raw, {
+ name: 'users.name',
+ thisGuy: 'Bob',
+ otherGuy: 'Jay',
+ undefinedBinding: undefined,
+ })
+);
+```
+
+For simpler queries where one only has a single binding, `.raw` can accept said binding as its second parameter.
+
+```js
+knex('users')
+ .where(knex.raw('LOWER("login") = ?', 'knex'))
+ .orWhere(knex.raw('accesslevel = ?', 1))
+ .orWhere(knex.raw('updtime = ?', '01-01-2016'));
+```
+
+Since there is no unified syntax for array bindings, instead you need to treat them as multiple values by adding `?` directly in your query.
+
+```js
+const myArray = [1, 2, 3];
+knex.raw(
+ 'select * from users where id in (' + myArray.map((_) => '?').join(',') + ')',
+ [...myArray]
+);
+```
+
+query will become:
+
+```sql
+select * from users where id in (?, ?, ?) /* with bindings [1,2,3] */
+```
+
+To prevent replacement of `?` one can use the escape sequence `\\?`.
+
+```js
+knex
+ .select('*')
+ .from('users')
+ .where('id', '=', 1)
+ .whereRaw('?? \\? ?', ['jsonColumn', 'jsonKey']);
+```
+
+To prevent replacement of named bindings one can use the escape sequence `\\:`.
+
+```js
+knex
+ .select('*')
+ .from('users')
+ .whereRaw(":property: = '\\:value' OR \\:property: = :value", {
+ property: 'name',
+ value: 'Bob',
+ });
+```
+
+## Raw Expressions
+
+Raw expressions are created by using `knex.raw(sql, [bindings])` and passing this as a value for any value in the query chain.
+
+```js
+knex('users')
+ .select(knex.raw('count(*) as user_count, status'))
+ .where(knex.raw(1))
+ .orWhere(knex.raw('status <> ?', [1]))
+ .groupBy('status');
+```
+
+## Raw Queries
+
+The `knex.raw` may also be used to build a full query and execute it, as a standard query builder query would be executed. The benefit of this is that it uses the connection pool and provides a standard interface for the different client libraries.
+
+```js
+knex.raw('select * from users where id = ?', [1]).then(function (resp) {
+ /*...*/
+});
+```
+
+Note that the response will be whatever the underlying sql library would typically return on a normal query, so you may need to look at the documentation for the base library the queries are executing against to determine how to handle the response.
+
+## Wrapped Queries
+
+The raw query builder also comes with a `wrap` method, which allows wrapping the query in a value:
+
+```js
+const subcolumn = knex
+ .raw('select avg(salary) from employee where dept_no = e.dept_no')
+ .wrap('(', ') avg_sal_dept');
+
+knex
+ .select('e.lastname', 'e.salary', subcolumn)
+ .from('employee as e')
+ .whereRaw('dept_no = e.dept_no');
+```
+
+Note that the example above be achieved more easily using the [as](/guide/query-builder#as) method.
+
+```js
+const subcolumn = knex
+ .avg('salary')
+ .from('employee')
+ .whereRaw('dept_no = e.dept_no')
+ .as('avg_sal_dept');
+
+knex
+ .select('e.lastname', 'e.salary', subcolumn)
+ .from('employee as e')
+ .whereRaw('dept_no = e.dept_no');
+```
diff --git a/docs/src/guide/ref.md b/docs/src/guide/ref.md
new file mode 100644
index 0000000000..f8a7b368fb
--- /dev/null
+++ b/docs/src/guide/ref.md
@@ -0,0 +1,38 @@
+# Ref
+
+Can be used to create references in a query, such as column- or tablenames. This is a good and shorter alternative to using `knex.raw('??', 'tableName.columName')` which essentially does the same thing.
+
+## Usage
+
+`knex.ref` can be used essentially anywhere in a build-chain. Here is an example:
+
+```js
+knex(knex.ref('Users').withSchema('TenantId'))
+ .where(knex.ref('Id'), 1)
+ .orWhere(knex.ref('Name'), 'Admin')
+ .select(['Id', knex.ref('Name').as('Username')]);
+```
+
+
+
+### withSchema
+
+The Ref function supports schema using `.withSchema(string)`:
+
+```js
+knex(knex.ref('users').withSchema('TenantId')).select();
+```
+
+### alias
+
+Alias is supported using `.alias(string)`
+
+```js
+knex('users').select(knex.ref('Id').as('UserId'));
+```
+
+
diff --git a/docs/src/guide/schema-builder.md b/docs/src/guide/schema-builder.md
new file mode 100644
index 0000000000..72157d9a9f
--- /dev/null
+++ b/docs/src/guide/schema-builder.md
@@ -0,0 +1,1189 @@
+# Schema Builder
+
+The `knex.schema` is a **getter function**, which returns a stateful object containing the query. Therefore be sure to obtain a new instance of the `knex.schema` for every query. These methods return [promises](/guide/interfaces.html#promises).
+
+## Essentials
+
+### withSchema
+
+**knex.schema.withSchema([schemaName])**
+
+Specifies the schema to be used when using the schema-building commands.
+
+```js
+knex.schema.withSchema('public').createTable('users', function (table) {
+ table.increments();
+});
+```
+
+### createTable
+
+**knex.schema.createTable(tableName, callback)**
+
+Creates a new table on the database, with a callback function to modify the table's structure, using the schema-building commands.
+
+```js
+knex.schema.createTable('users', function (table) {
+ table.increments();
+ table.string('name');
+ table.timestamps();
+});
+```
+
+### createTableLike
+
+**knex.schema.createTableLike(tableName, tableNameToCopy, [callback])**
+
+Creates a new table on the database based on another table. Copy only the structure : columns, keys and indexes (expected on SQL Server which only copy columns) and not the data. Callback function can be specified to add columns in the duplicated table.
+
+```js
+knex.schema.createTableLike('new_users', 'users');
+
+// "new_users" table contains columns
+// of users and two new columns 'age' and 'last_name'.
+knex.schema.createTableLike('new_users', 'users', (table) => {
+ table.integer('age');
+ table.string('last_name');
+});
+```
+
+### dropTable
+
+**knex.schema.dropTable(tableName)**
+
+Drops a table, specified by tableName.
+
+```js
+knex.schema.dropTable('users');
+```
+
+### dropTableIfExists
+
+**knex.schema.dropTableIfExists(tableName)**
+
+Drops a table conditionally if the table exists, specified by tableName.
+
+```js
+knex.schema.dropTableIfExists('users');
+```
+
+### renameTable
+
+**knex.schema.renameTable(from, to)**
+
+Renames a table from a current tableName to another.
+
+```js
+knex.schema.renameTable('old_users', 'users');
+```
+
+### hasTable
+
+**knex.schema.hasTable(tableName)**
+
+Checks for a table's existence by tableName, resolving with a boolean to signal if the table exists.
+
+```js
+knex.schema.hasTable('users').then(function (exists) {
+ if (!exists) {
+ return knex.schema.createTable('users', function (t) {
+ t.increments('id').primary();
+ t.string('first_name', 100);
+ t.string('last_name', 100);
+ t.text('bio');
+ });
+ }
+});
+```
+
+### hasColumn
+
+**knex.schema.hasColumn(tableName, columnName)**
+
+Checks if a column exists in the current table, resolves the promise with a boolean, true if the column exists, false otherwise.
+
+### table
+
+**knex.schema.table(tableName, callback)**
+
+Chooses a database table, and then modifies the table, using the Schema Building functions inside of the callback.
+
+```js
+knex.schema.table('users', function (table) {
+ table.dropColumn('name');
+ table.string('first_name');
+ table.string('last_name');
+});
+```
+
+### alterTable
+
+**knex.schema.alterTable(tableName, callback)**
+
+Chooses a database table, and then modifies the table, using the Schema Building functions inside of the callback.
+
+```js
+knex.schema.alterTable('users', function (table) {
+ table.dropColumn('name');
+ table.string('first_name');
+ table.string('last_name');
+});
+```
+
+### createView
+
+**knex.schema.createView(tableName, callback)**
+
+Creates a new view on the database, with a callback function to modify the view's structure, using the schema-building commands.
+
+```js
+knex.schema.createView('users_view', function (view) {
+ view.columns(['first_name']);
+ view.as(knex('users').select('first_name').where('age', '>', '18'));
+});
+```
+
+### createViewOrReplace
+
+**knex.schema.createViewOrReplace(tableName, callback)**
+
+Creates a new view or replace it on the database, with a callback function to modify the view's structure, using the schema-building commands. You need to specify at least the same columns in same order (you can add extra columns). In SQLite, this function generate drop/create view queries (view columns can be different).
+
+```js
+knex.schema.createViewOrReplace('users_view', function (view) {
+ view.columns(['first_name']);
+ view.as(knex('users').select('first_name').where('age', '>', '18'));
+});
+```
+
+### createMaterializedView
+
+**knex.schema.createMaterializedView(viewName, callback)**
+
+Creates a new materialized view on the database, with a callback function to modify the view's structure, using the schema-building commands. Only on PostgreSQL, CockroachDb, Redshift and Oracle.
+
+```js
+knex.schema.createMaterializedView('users_view', function (view) {
+ view.columns(['first_name']);
+ view.as(knex('users').select('first_name').where('age', '>', '18'));
+});
+```
+
+### refreshMaterializedView
+
+**knex.schema.refreshMaterializedView(viewName)**
+
+Refresh materialized view on the database. Only on PostgreSQL, CockroachDb, Redshift and Oracle.
+
+```js
+knex.schema.refreshMaterializedView('users_view');
+```
+
+### dropView
+
+**knex.schema.dropView(viewName)**
+
+Drop view on the database.
+
+```js
+knex.schema.dropView('users_view');
+```
+
+### dropViewIfExists
+
+**knex.schema.dropViewIfExists(viewName)**
+
+Drop view on the database if exists.
+
+```js
+knex.schema.dropViewIfExists('users_view');
+```
+
+### dropMaterializedView
+
+**knex.schema.dropMaterializedView(viewName)**
+
+Drop materialized view on the database. Only on PostgreSQL, CockroachDb, Redshift and Oracle.
+
+```js
+knex.schema.dropMaterializedView('users_view');
+```
+
+### dropMaterializedViewIfExists
+
+**knex.schema.dropMaterializedViewIfExists(viewName)**
+
+Drop materialized view on the database if exists. Only on PostgreSQL, CockroachDb, Redshift and Oracle.
+
+```js
+knex.schema.dropMaterializedViewIfExists('users_view');
+```
+
+### renameView
+
+**knex.schema.renameView(viewName)**
+
+Rename a existing view in the database. Not supported by Oracle and SQLite.
+
+```js
+knex.schema.renameView('users_view');
+```
+
+### alterView
+
+**knex.schema.alterView(viewName)**
+
+Alter view to rename columns or change default values. Only available on PostgreSQL, MSSQL and Redshift.
+
+```js
+knex.schema.alterView('view_test', function (view) {
+ view.column('first_name').rename('name_user');
+ view.column('bio').defaultTo('empty');
+});
+```
+
+### generateDdlCommands
+
+**knex.schema.generateDdlCommands()**
+
+Generates complete SQL commands for applying described schema changes, without executing anything. Useful when knex is being used purely as a query builder. Generally produces same result as .toSQL(), with a notable exception with SQLite, which relies on asynchronous calls to the database for building part of its schema modification statements
+
+```js
+const ddlCommands = knex.schema
+ .alterTable('users', (table) => {
+ table
+ .foreign('companyId')
+ .references('company.companyId')
+ .withKeyName('fk_fkey_company');
+ })
+ .generateDdlCommands();
+```
+
+### raw
+
+**knex.schema.raw(statement)**
+
+Run an arbitrary sql query in the schema builder chain.
+
+```js
+knex.schema.raw("SET sql_mode='TRADITIONAL'").table('users', function (table) {
+ table.dropColumn('name');
+ table.string('first_name');
+ table.string('last_name');
+});
+```
+
+### queryContext
+
+**knex.schema.queryContext(context)**
+
+Allows configuring a context to be passed to the [wrapIdentifier](/guide/#wrapidentifier) hook. The context can be any kind of value and will be passed to `wrapIdentifier` without modification.
+
+```js
+knex.schema.queryContext({ foo: 'bar' }).table('users', function (table) {
+ table.string('first_name');
+ table.string('last_name');
+});
+```
+
+The context configured will be passed to `wrapIdentifier` for each identifier that needs to be formatted, including the table and column names. However, a different context can be set for the column names via [table.queryContext](/guide/query-builder#querycontext).
+
+Calling `queryContext` with no arguments will return any context configured for the schema builder instance.
+
+### dropSchema
+
+**knex.schema.dropSchema(schemaName, [cascade])**
+
+Drop a schema, specified by the schema's name, with optional cascade option (default to false). Only supported by PostgreSQL.
+
+```js
+//drop schema 'public'
+knex.schema.dropSchema('public');
+//drop schema 'public' cascade
+knex.schema.dropSchema('public', true);
+```
+
+### dropSchemaIfExists
+
+**knex.schema.dropSchemaIfExists(schemaName, [cascade])**
+
+Drop a schema conditionally if the schema exists, specified by the schema's name, with optional cascade option (default to false). Only supported by PostgreSQL.
+
+```js
+//drop schema if exists 'public'
+knex.schema.dropSchemaIfExists('public');
+//drop schema if exists 'public' cascade
+knex.schema.dropSchemaIfExists('public', true);
+```
+
+## Schema Building
+
+### dropColumn
+
+**table.dropColumn(name)**
+
+Drops a column, specified by the column's name
+
+### dropColumns
+
+**table.dropColumns(columns)**
+
+Drops multiple columns, taking a variable number of column names.
+
+### renameColumn
+
+**table.renameColumn(from, to)**
+
+Renames a column from one name to another.
+
+### increments
+
+**table.increments(name, options={[primaryKey: boolean = true])**
+
+Adds an auto incrementing column. In PostgreSQL this is a serial; in Amazon Redshift an integer identity(1,1). This will be used as the primary key for the table if the column isn't in another primary key. Also available is a bigIncrements if you wish to add a bigint incrementing number (in PostgreSQL bigserial). Note that a primary key is created by default if the column isn't in primary key (with primary function), but you can override this behaviour by passing the `primaryKey` option. If you use this function with primary function, the column is added to the composite primary key. With SQLite, autoincrement column need to be a primary key, so if primary function is used, primary keys are transformed in unique index. MySQL don't support autoincrement column without primary key, so multiple queries are generated to create int column, add increments column to composite primary key then modify the column to autoincrement column.
+
+```js
+// create table 'users'
+// with a primary key using 'increments()'
+knex.schema.createTable('users', function (table) {
+ table.increments('userId');
+ table.string('name');
+});
+
+// create table 'users'
+// with a composite primary key ('userId', 'name').
+// increments doesn't generate primary key.
+knex.schema.createTable('users', function (table) {
+ table.primary(['userId', 'name']);
+ table.increments('userId');
+ table.string('name');
+});
+
+// reference the 'users' primary key in new table 'posts'
+knex.schema.createTable('posts', function (table) {
+ table.integer('author').unsigned().notNullable();
+ table.string('title', 30);
+ table.string('content');
+
+ table.foreign('author').references('userId').inTable('users');
+});
+```
+
+A primaryKey option may be passed, to disable to automatic primary key creation:
+
+```js
+// create table 'users'
+// with a primary key using 'increments()'
+// but also increments field 'other_id'
+// that does not need primary key
+knex.schema.createTable('users', function (table) {
+ table.increments('id');
+ table.increments('other_id', { primaryKey: false });
+});
+```
+
+### integer
+
+**table.integer(name, length)**
+
+Adds an integer column. On PostgreSQL you cannot adjust the length, you need to use other option such as bigInteger, etc
+
+### bigInteger
+
+**table.bigInteger(name)**
+
+In MySQL or PostgreSQL, adds a bigint column, otherwise adds a normal integer. Note that bigint data is returned as a string in queries because JavaScript may be unable to parse them without loss of precision.
+
+### tinyint
+
+**table.tinyint(name, length)**
+
+Adds a tinyint column
+
+### smallint
+
+**table.smallint(name)**
+
+Adds a smallint column
+
+### mediumint
+
+**table.mediumint(name)**
+
+Adds a mediumint column
+
+### bigint
+
+**table.bigint(name)**
+
+Adds a bigint column
+
+### text
+
+**table.text(name, [textType])**
+
+Adds a text column, with optional textType for MySql text datatype preference. textType may be mediumtext or longtext, otherwise defaults to text.
+
+### string
+
+**table.string(name, [length])**
+
+Adds a string column, with optional length defaulting to 255.
+
+### float
+
+**table.float(column, [precision], [scale])**
+
+Adds a float column, with optional precision (defaults to 8) and scale (defaults to 2).
+
+### double
+
+**table.double(column, [precision], [scale])**
+
+Adds a double column, with optional precision (defaults to 8) and scale (defaults to 2). In SQLite/MSSQL this is a float with no precision/scale; In PostgreSQL this is a double precision; In Oracle this is a number with matching precision/scale.
+
+### decimal
+
+**table.decimal(column, [precision], [scale])**
+
+Adds a decimal column, with optional precision (defaults to 8) and scale (defaults to 2). Specifying NULL as precision creates a decimal column that can store numbers of any precision and scale. (Only supported for Oracle, SQLite, Postgres)
+
+### boolean
+
+**table.boolean(name)**
+
+Adds a boolean column.
+
+### date
+
+**table.date(name)**
+
+Adds a date column.
+
+### datetime
+
+**table.datetime(name, options={[useTz: boolean], [precision: number]})**
+
+Adds a datetime column. By default PostgreSQL creates column with timezone (timestamptz type). This behaviour can be overriden by passing the useTz option (which is by default true for PostgreSQL). MySQL and MSSQL do not have useTz option.
+
+A precision option may be passed:
+
+```js
+table.datetime('some_time', { precision: 6 }).defaultTo(knex.fn.now(6));
+```
+
+### time
+
+**table.time(name, [precision])**
+
+Adds a time column, with optional precision for MySQL. Not supported on Amazon Redshift.
+
+In MySQL a precision option may be passed:
+
+```js
+table.time('some_time', { precision: 6 });
+```
+
+### timestamp
+
+**table.timestamp(name, options={[useTz: boolean], [precision: number]})**
+
+Adds a timestamp column. By default PostgreSQL creates column with timezone (timestamptz type) and MSSQL does not (datetime2). This behaviour can be overriden by passing the useTz option (which is by default false for MSSQL and true for PostgreSQL). MySQL does not have useTz option.
+
+```js
+table.timestamp('created_at').defaultTo(knex.fn.now());
+```
+
+In PostgreSQL and MySQL a precision option may be passed:
+
+```js
+table.timestamp('created_at', { precision: 6 }).defaultTo(knex.fn.now(6));
+```
+
+In PostgreSQL and MSSQL a timezone option may be passed:
+
+```js
+table.timestamp('created_at', { useTz: true });
+```
+
+### timestamps
+
+**table.timestamps([useTimestamps], [defaultToNow], [useCamelCase])**
+
+Adds created_at and updated_at columns on the database, setting each to datetime types. When true is passed as the first argument a timestamp type is used instead. Both columns default to being not null and using the current timestamp when true is passed as the second argument. Note that on MySQL the .timestamps() only have seconds precision, to get better precision use the .datetime or .timestamp methods directly with precision. If useCamelCase is true, the name of columns are createdAt and updatedAt.
+
+::: info
+PostgreSQL `updated_at` field will not automatically be updated. Please see this [issue](https://github.com/knex/knex/issues/1928 'issue') for details
+:::
+
+### dropTimestamps
+
+**table.dropTimestamps([useCamelCase])**
+
+Drops the columns created_at and updated_at from the table, which can be created via timestamps. If useCamelCase is true, the name of columns are createdAt and updatedAt.
+
+### binary
+
+**table.binary(name, [length])**
+
+Adds a binary column, with optional length argument for MySQL.
+
+### enum / enu
+
+**table.enu(col, values, [options])**
+
+Adds a enum column, (aliased to enu, as enum is a reserved word in JavaScript). Implemented as unchecked varchar(255) on Amazon Redshift. Note that the second argument is an array of values. Example:
+
+```js
+table.enu('column', ['value1', 'value2']);
+```
+
+For Postgres, an additional options argument can be provided to specify whether or not to use Postgres's native TYPE:
+
+```js
+table.enu('column', ['value1', 'value2'], {
+ useNative: true,
+ enumName: 'foo_type',
+});
+```
+
+It will use the values provided to generate the appropriate TYPE. Example:
+
+```sql
+CREATE TYPE "foo_type" AS ENUM ('value1', 'value2');
+```
+
+To use an existing native type across columns, specify 'existingType' in the options (this assumes the type has already been created):
+
+::: info
+Since the enum values aren't utilized for a native && existing type, the type being passed in for values is immaterial.
+:::
+
+```js
+table.enu('column', null, {
+ useNative: true,
+ existingType: true,
+ enumName: 'foo_type',
+});
+```
+
+If you want to use existing enums from a schema, different from the schema of your current table, specify 'schemaName' in the options:
+
+```js
+table.enu('column', null, {
+ useNative: true,
+ existingType: true,
+ enumName: 'foo_type',
+ schemaName: 'public',
+});
+```
+
+Knex does not provide any way to alter enumerations after creation. To change an enumeration later on you must use Knex.raw, and the appropriate command for your database.
+
+### json
+
+**table.json(name)**
+
+Adds a json column, using the built-in json type in PostgreSQL, MySQL and SQLite, defaulting to a text column in older versions or in unsupported databases.
+
+For PostgreSQL, due to incompatibility between native array and json types, when setting an array (or a value that could be an array) as the value of a json or jsonb column, you should use JSON.stringify() to convert your value to a string prior to passing it to the query builder, e.g.
+
+```js
+knex
+ .table('users')
+ .where({ id: 1 })
+ .update({ json_data: JSON.stringify(mightBeAnArray) });
+```
+
+### jsonb
+
+**table.jsonb(name)**
+
+Adds a jsonb column. Works similar to table.json(), but uses native jsonb type if possible.
+
+### uuid
+
+**table.uuid(name, options=({[useBinaryUuid:boolean],[primaryKey:boolean]})**
+
+Adds a uuid column - this uses the built-in uuid type in PostgreSQL, and falling back to a char(36) in other databases by default.
+If useBinaryUuid is true, binary(16) is used. See uuidToBin function to convert uuid in binary before inserting and binToUuid to convert binary uuid to uuid.
+If primaryKey is true, then for PostgreSQL the field will be configured as `uuid primary key`, for CockroackDB an additional `default gen_random_uuid()` is set on the type.
+
+You may set the default value to the uuid helper function. Not supported by Redshift.
+
+```js
+knex.schema.createTable(tblName, (table) => {
+ table.uuid('uuidColumn').defaultTo(knex.fn.uuid());
+});
+```
+
+### geometry
+
+**table.geometry(name)**
+
+Adds a geometry column. Supported by SQLite, MSSQL and PostgreSQL.
+
+```js
+knex.schema.createTable(tblName, (table) => {
+ table.geometry('geometryColumn');
+});
+```
+
+### geography
+
+**table.geography(name)**
+
+Adds a geography column. Supported by SQLite, MSSQL and PostgreSQL (in PostGIS extension).
+
+```js
+knex.schema.createTable(tblName, (table) => {
+ table.geography('geographyColumn');
+});
+```
+
+### point
+
+**table.point(name)**
+
+Add a point column. Not supported by CockroachDB and MSSQL.
+
+```js
+knex.schema.createTable(tblName, (table) => {
+ table.point('pointColumn');
+});
+```
+
+### comment
+
+**table.comment(value)**
+
+Sets the comment for a table.
+
+### engine
+
+**table.engine(val)**
+
+Sets the engine for the database table, only available within a createTable call, and only applicable to MySQL.
+
+### charset
+
+**table.charset(val)**
+
+Sets the charset for the database table, only available within a createTable call, and only applicable to MySQL.
+
+### collate
+
+**table.collate(val)**
+
+Sets the collation for the database table, only available within a createTable call, and only applicable to MySQL.
+
+### inherits
+
+**table.inherits(val)**
+
+Sets the tables that this table inherits, only available within a createTable call, and only applicable to PostgreSQL.
+
+### specificType
+
+**table.specificType(name, type)**
+
+Sets a specific type for the column creation, if you'd like to add a column type that isn't supported here.
+
+### index
+
+**table.index(columns, [indexName], options=({[indexType: string], [storageEngineIndexType: 'btree'|'hash'], [predicate: QueryBuilder]}))**
+
+Adds an index to a table over the given columns. A default index name using the columns is used unless indexName is specified. In MySQL, the storage engine index type may be 'btree' or 'hash' index types, more info in Index Options section : [https://dev.mysql.com/doc/refman/8.0/en/create-index.html](https://dev.mysql.com/doc/refman/8.0/en/create-index.html). The indexType can be optionally specified for PostgreSQL and MySQL. Amazon Redshift does not allow creating an index. In PostgreSQL, SQLite and MSSQL a partial index can be specified by setting a 'where' predicate.
+
+```js
+knex.table('users', function (table) {
+ table.index(['name', 'last_name'], 'idx_name_last_name', {
+ indexType: 'FULLTEXT',
+ storageEngineIndexType: 'hash',
+ predicate: knex.whereNotNull('email'),
+ });
+});
+```
+
+### dropIndex
+
+**table.dropIndex(columns, [indexName])**
+
+Drops an index from a table. A default index name using the columns is used unless indexName is specified (in which case columns is ignored). Amazon Redshift does not allow creating an index.
+
+### setNullable
+
+**table.setNullable(column)**
+
+Makes table column nullable.
+
+### dropNullable
+
+**table.dropNullable(column)**
+
+Makes table column not nullable. Note that this operation will fail if there are already null values in this column.
+
+### primary
+
+**table.primary(columns, options=({[constraintName:string],[deferrable:'not deferrable'|'deferred'|'immediate']})**
+
+Create a primary key constraint on table using input `columns`. If you need to create a composite primary key, pass an array of columns to `columns`. Constraint name defaults to `tablename_pkey` unless `constraintName` is specified. On Amazon Redshift, all columns included in a primary key must be not nullable. Deferrable primary constraint are supported on Postgres and Oracle and can be set by passing deferrable option to options object.
+
+```js
+knex.schema.alterTable('users', function (t) {
+ t.unique('email');
+});
+knex.schema.alterTable('job', function (t) {
+ t.primary('email', {
+ constraintName: 'users_primary_key',
+ deferrable: 'deferred',
+ });
+});
+```
+
+::: info
+If you want to chain primary() while creating new column you can use [primary](#primary-1)
+:::
+
+### unique
+
+**table.unique(columns, options={[indexName: string], [deferrable:'not deferrable'|'immediate'|'deferred'], [storageEngineIndexType:'btree'|'hash'], [useConstraint:true|false], [predicate: QueryBuilder]})**
+
+Adds an unique index to a table over the given `columns`. In MySQL, the storage engine index type may be 'btree' or 'hash' index types, more info in Index Options section : [https://dev.mysql.com/doc/refman/8.0/en/create-index.html](https://dev.mysql.com/doc/refman/8.0/en/create-index.html). A default index name using the columns is used unless indexName is specified. If you need to create a composite index, pass an array of column to `columns`. Deferrable unique constraint are supported on Postgres and Oracle and can be set by passing deferrable option to options object. In MSSQL and Postgres, you can set the `useConstraint` option to true to create a unique constraint instead of a unique index (defaults to false for MSSQL, true for Postgres without `predicate`, false for Postgres with `predicate`). In PostgreSQL, SQLite and MSSQL a partial unique index can be specified by setting a 'where' predicate.
+
+```js
+knex.schema.alterTable('users', function (t) {
+ t.unique('email');
+});
+knex.schema.alterTable('job', function (t) {
+ t.unique(['account_id', 'program_id'], {
+ indexName: 'job_composite_index',
+ deferrable: 'deferred',
+ storageEngineIndexType: 'hash',
+ });
+});
+knex.schema.alterTable('job', function (t) {
+ t.unique(['account_id', 'program_id'], {
+ indexName: 'job_composite_index',
+ useConstraint: true,
+ });
+});
+knex.schema.alterTable('job', function (t) {
+ t.unique(['account_id', 'program_id'], {
+ indexName: 'job_composite_index',
+ predicate: knex.whereNotNull('account_id'),
+ });
+});
+```
+
+::: info
+If you want to chain unique() while creating new column you can use [unique](#unique-1)
+:::
+
+### foreign
+
+**table.foreign(columns, [foreignKeyName])[.onDelete(statement).onUpdate(statement).withKeyName(foreignKeyName).deferrable(type)]**
+
+Adds a foreign key constraint to a table for an existing column using `table.foreign(column).references(column)` or multiple columns using `table.foreign(columns).references(columns).inTable(table)`.
+
+A default key name using the columns is used unless `foreignKeyName` is specified.
+
+You can also chain `onDelete()` and/or `onUpdate()` to set the reference option `(RESTRICT, CASCADE, SET NULL, NO ACTION)` for the operation. You can also chain `withKeyName()` to override default key name that is generated from table and column names (result is identical to specifying second parameter to function `foreign()`).
+
+Deferrable foreign constraint is supported on Postgres and Oracle and can be set by chaining `.deferrable(type)`
+
+Note that using `foreign()` is the same as `column.references(column)` but it works for existing columns.
+
+```js
+knex.schema.table('users', function (table) {
+ table.integer('user_id').unsigned();
+ table
+ .foreign('user_id')
+ .references('Items.user_id_in_items')
+ .deferrable('deferred');
+});
+```
+
+### dropForeign
+
+**table.dropForeign(columns, [foreignKeyName])**
+
+Drops a foreign key constraint from a table. A default foreign key name using the columns is used unless foreignKeyName is specified (in which case columns is ignored).
+
+### dropUnique
+
+**table.dropUnique(columns, [indexName])**
+
+Drops a unique key constraint from a table. A default unique key name using the columns is used unless indexName is specified (in which case columns is ignored).
+
+### dropPrimary
+
+**table.dropPrimary([constraintName])**
+
+Drops the primary key constraint on a table. Defaults to tablename_pkey unless constraintName is specified.
+
+### queryContext
+
+**table.queryContext(context)**
+
+Allows configuring a context to be passed to the [wrapIdentifier](/guide/#wrapidentifier) hook for formatting table builder identifiers. The context can be any kind of value and will be passed to `wrapIdentifier` without modification.
+
+```js
+knex.schema.table('users', function (table) {
+ table.queryContext({ foo: 'bar' });
+ table.string('first_name');
+ table.string('last_name');
+});
+```
+
+This method also enables overwriting the context configured for a schema builder instance via [schema.queryContext](/guide/schema-builder#querycontext):
+
+```js
+knex.schema.queryContext('schema context').table('users', function (table) {
+ table.queryContext('table context');
+ table.string('first_name');
+ table.string('last_name');
+});
+```
+
+Note that it's also possible to overwrite the table builder context for any column in the table definition:
+
+```js
+knex.schema.queryContext('schema context').table('users', function (table) {
+ table.queryContext('table context');
+ table.string('first_name').queryContext('first_name context');
+ table.string('last_name').queryContext('last_name context');
+});
+```
+
+Calling `queryContext` with no arguments will return any context configured for the table builder instance.
+
+## Chainable Methods
+
+The following three methods may be chained on the schema building methods, as modifiers to the column.
+
+### alter
+
+**column.alter(options={[alterNullable: boolean = true, alterType: boolean = true])**
+
+Marks the column as an alter / modify, instead of the default add.
+
+::: warning
+This only works in .alterTable() and is not supported by SQlite or Amazon Redshift. Alter is _not_ done incrementally over older column type so if you like to add `notNullable` and keep the old default value, the alter statement must contain both `.notNullable().defaultTo(1).alter()`. If one just tries to add `.notNullable().alter()` the old default value will be dropped. Nullable alterations are done only if alterNullable is true. Type alterations are done only if alterType is true.
+:::
+
+```js
+knex.schema.alterTable('user', function (t) {
+ t.increments().primary(); // add
+ // drops previous default value from column,
+ // change type to string and add not nullable constraint
+ t.string('username', 35).notNullable().alter();
+ // drops both not null constraint and the default value
+ t.integer('age').alter();
+ // if alterNullable is false, drops only the default value
+ t.integer('age').alter({ alterNullable: false });
+ // if alterType is false, type of column is not altered.
+ t.integer('age').alter({ alterType: false });
+});
+```
+
+### index
+
+**column.index([indexName], options=({[indexType: string], [storageEngineIndexType: 'btree'|'hash'], [predicate: QueryBuilder]}))**
+
+Specifies a field as an index. If an indexName is specified, it is used in place of the standard index naming convention of tableName_columnName. In MySQL, the storage engine index type may be 'btree' or 'hash' index types, more info in Index Options section : [https://dev.mysql.com/doc/refman/8.0/en/create-index.html](https://dev.mysql.com/doc/refman/8.0/en/create-index.html). The indexType can be optionally specified for PostgreSQL and MySQL. No-op if this is chained off of a field that cannot be indexed. In PostgreSQL, SQLite and MSSQL a partial index can be specified by setting a 'where' predicate.
+
+### primary
+
+**column.primary(options=({[constraintName:string],[deferrable:'not deferrable'|'deferred'|'immediate']}));**
+
+Sets a primary key constraint on `column`. Constraint name defaults to `tablename_pkey` unless `constraintName` is specified. On Amazon Redshift, all columns included in a primary key must be not nullable. Deferrable primary constraint are supported on Postgres and Oracle and can be set by passing deferrable option to options object.
+
+```js
+knex.schema.table('users', function (table) {
+ table.integer('user_id').primary('email', {
+ constraintName: 'users_primary_key',
+ deferrable: 'deferred',
+ });
+});
+```
+
+::: info
+If you want to create primary constraint on existing column use [primary](#primary)
+:::
+
+### unique
+
+**column.unique(options={[indexName:string],[deferrable:'not deferrable'|'immediate'|'deferred']})**
+
+Sets the `column` as unique. On Amazon Redshift, this constraint is not enforced, but it is used by the query planner. Deferrable unique constraint are supported on Postgres and Oracle and can be set by passing deferrable option to options object.
+
+```js
+knex.schema.table('users', function (table) {
+ table
+ .integer('user_id')
+ .unique({ indexName: 'user_unique_id', deferrable: 'immediate' });
+});
+```
+
+::: info
+If you want to create unique constraint on existing column use [unique](#unique)
+:::
+
+### references
+
+**column.references(column)**
+
+Sets the "column" that the current column references as a foreign key. "column" can either be "." syntax, or just the column name followed up with a call to inTable to specify the table.
+
+### inTable
+
+**column.inTable(table)**
+
+Sets the "table" where the foreign key column is located after calling column.references.
+
+### onDelete
+
+**column.onDelete(command)**
+
+Sets the SQL command to be run "onDelete".
+
+### onUpdate
+
+**column.onUpdate(command)**
+
+Sets the SQL command to be run "onUpdate".
+
+### defaultTo
+
+**column.defaultTo(value, options={[constraintName: string = undefined]))**
+
+Sets the default value for the column on an insert.
+
+In MSSQL a constraintName option may be passed to ensure a specific constraint name:
+
+```js
+column.defaultTo('value', { constraintName: 'df_table_value' });
+```
+
+### unsigned
+
+**column.unsigned()**
+
+Specifies a number as unsigned. Only for numeric values.
+
+### notNullable
+
+**column.notNullable()**
+
+Adds a not null on the current column being created.
+
+### nullable
+
+**column.nullable()**
+
+Default on column creation, this explicitly sets a field to be nullable.
+
+### first
+
+**column.first()**
+
+Sets the column to be inserted on the first position, only used in MySQL alter tables.
+
+### after
+
+**column.after(field)**
+
+Sets the column to be inserted after another, only used in MySQL alter tables.
+
+### comment
+
+**column.comment(value)**
+
+Sets the comment for a column.
+
+```js
+knex.schema.createTable('accounts', function (t) {
+ t.increments().primary();
+ t.string('email').unique().comment('This is the email field');
+});
+```
+
+### collate
+
+**column.collate(collation)**
+
+Sets the collation for a column (only works in MySQL). Here is a list of all available collations: [https://dev.mysql.com/doc/refman/5.5/en/charset-charsets.html](https://dev.mysql.com/doc/refman/5.5/en/charset-charsets.html)
+
+```js
+knex.schema.createTable('users', function (t) {
+ t.increments();
+ t.string('email').unique().collate('utf8_unicode_ci');
+});
+```
+
+## View
+
+### columns
+
+**view.columns([columnNames])**
+
+Specify the columns of the view.
+
+```js
+knex.schema.createView('users_view', function (view) {
+ view.columns(['first_name', 'last_name']);
+ view.as(knex('users').select('first_name').where('age', '>', '18'));
+});
+```
+
+### as
+
+**view.as(selectQuery)**
+
+Specify the select query of the view.
+
+### checkOption
+
+**view.checkOption()**
+
+Add check option on the view definition. On OracleDb, MySQL, PostgreSQL and Redshift.
+
+### localCheckOption
+
+**view.localCheckOption()**
+
+Add local check option on the view definition. On MySQL, PostgreSQL and Redshift.
+
+### cascadedCheckOption
+
+**view.cascadedCheckOption()**
+
+Add cascaded check option on the view definition. On MySQL, PostgreSQL and Redshift.
+
+## Checks
+
+### check
+
+**table.check(checkPredicate, [bindings], [constraintName]))**
+
+Specify a check on table or column with raw predicate.
+
+```js
+knex.schema.createTable('product', function (table) {
+ table.integer('price_min');
+ table.integer('price');
+ table.check('?? >= ??', ['price', 'price_min']);
+});
+```
+
+### checkPositive
+
+**column.checkPositive([constraintName])**
+
+Specify a check on column that test if the value of column is positive.
+
+```js
+knex.schema.createTable('product', function (table) {
+ table.integer('price').checkPositive();
+});
+```
+
+### checkNegative
+
+**column.checkNegative([constraintName])**
+
+Specify a check on column that test if the value of column is negative.
+
+```js
+knex.schema.createTable('product', function (table) {
+ table.integer('price_decrease').checkNegative();
+});
+```
+
+### checkIn
+
+**column.checkIn(values, [constraintName])**
+
+Specify a check on column that test if the value of column is contained in a set of specified values.
+
+```js
+knex.schema.createTable('product', function (table) {
+ table.string('type').checkIn(['table', 'chair', 'sofa']);
+});
+```
+
+### checkNotIn
+
+**column.checkNotIn(values, [constraintName])**
+
+Specify a check on column that test if the value of column is not contains in a set of specified values.
+
+```js
+knex.schema.createTable('product', function (table) {
+ table.string('type').checkNotIn(['boot', 'shoe']);
+});
+```
+
+### checkBetween
+
+**column.checkBetween(values, [constraintName])**
+
+Specify a check on column that test if the value of column is within a range of values.
+
+```js
+knex.schema.createTable('product', function (table) {
+ table.integer('price').checkBetween([0, 100]);
+});
+// You can add checks on multiple intervals
+knex.schema.createTable('product', function (table) {
+ table.integer('price').checkBetween([
+ [0, 20],
+ [30, 40],
+ ]);
+});
+```
+
+### checkLength
+
+**column.checkLength(operator, length, [constraintName])**
+
+Specify a check on column that test if the length of a string match the predicate.
+
+```js
+knex.schema.createTable('product', function (table) {
+ // operator can be =, !=, <=, >=, <, >
+ t.varchar('phone').checkLength('=', 8);
+});
+```
+
+### checkRegex
+
+**column.checkRegex(regex, [constraintName])**
+
+Specify a check on column that test if the value match the specified regular expression. In MSSQL only simple pattern matching in supported but not regex syntax.
+
+```js
+knex.schema.createTable('product', function (table) {
+ table.string('phone').checkRegex('[0-9]{8}');
+ // In MSSQL, {8} syntax don't work,
+ // you need to duplicate [0-9].
+ table.string('phone').checkRegex('[0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9]');
+});
+```
+
+### dropChecks
+
+**table.dropChecks([checkConstraintNames])**
+
+Drop checks constraint given an array of constraint names.
+
+```js
+knex.schema.createTable('product', function (table) {
+ table.integer('price').checkPositive('price_check');
+ table
+ .integer('price_proportion')
+ .checkBetween([0, 100], 'price_proportion_check');
+ table.dropChecks(['price_check', 'price_proportion_check']);
+});
+```
diff --git a/docs/src/guide/transactions.md b/docs/src/guide/transactions.md
new file mode 100644
index 0000000000..890201af91
--- /dev/null
+++ b/docs/src/guide/transactions.md
@@ -0,0 +1,245 @@
+# Transactions
+
+Transactions are an important feature of relational databases, as they allow correct recovery from failures and keep a database consistent even in cases of system failure. All queries within a transaction are executed on the same database connection, and run the entire set of queries as a single unit of work. Any failure will mean the database will rollback any queries executed on that connection to the pre-transaction state.
+
+Transactions are handled by passing a handler function into `knex.transaction`. The handler function accepts a single argument, an object which may be used in two ways:
+
+1. As the "promise aware" knex connection
+2. As an object passed into a query with [transacting](/guide/query-builder#transacting) and eventually call commit or rollback.
+
+Consider these two examples:
+
+```js
+// Using trx as a query builder:
+knex
+ .transaction(function (trx) {
+ const books = [
+ { title: 'Canterbury Tales' },
+ { title: 'Moby Dick' },
+ { title: 'Hamlet' },
+ ];
+
+ return trx
+ .insert({ name: 'Old Books' }, 'id')
+ .into('catalogues')
+ .then(function (ids) {
+ books.forEach((book) => (book.catalogue_id = ids[0]));
+ return trx('books').insert(books);
+ });
+ })
+ .then(function (inserts) {
+ console.log(inserts.length + ' new books saved.');
+ })
+ .catch(function (error) {
+ // If we get here, that means that
+ // neither the 'Old Books' catalogues insert,
+ // nor any of the books inserts will have taken place.
+ console.error(error);
+ });
+```
+
+And then this example:
+
+```js
+// Using trx as a transaction object:
+knex
+ .transaction(function (trx) {
+ const books = [
+ { title: 'Canterbury Tales' },
+ { title: 'Moby Dick' },
+ { title: 'Hamlet' },
+ ];
+
+ knex
+ .insert({ name: 'Old Books' }, 'id')
+ .into('catalogues')
+ .transacting(trx)
+ .then(function (ids) {
+ books.forEach((book) => (book.catalogue_id = ids[0]));
+ return knex('books').insert(books).transacting(trx);
+ })
+ .then(trx.commit)
+ .catch(trx.rollback);
+ })
+ .then(function (inserts) {
+ console.log(inserts.length + ' new books saved.');
+ })
+ .catch(function (error) {
+ // If we get here, that means that
+ // neither the 'Old Books' catalogues insert,
+ // nor any of the books inserts will have taken place.
+ console.error(error);
+ });
+```
+
+Same example as above using await/async:
+
+```ts
+try {
+ await knex.transaction(async (trx) => {
+ const books = [
+ { title: 'Canterbury Tales' },
+ { title: 'Moby Dick' },
+ { title: 'Hamlet' },
+ ];
+
+ const ids = await trx('catalogues').insert(
+ {
+ name: 'Old Books',
+ },
+ 'id'
+ );
+
+ books.forEach((book) => (book.catalogue_id = ids[0]));
+ const inserts = await trx('books').insert(books);
+
+ console.log(inserts.length + ' new books saved.');
+ });
+} catch (error) {
+ // If we get here, that means that neither the 'Old Books' catalogues insert,
+ // nor any of the books inserts will have taken place.
+ console.error(error);
+}
+```
+
+Same example as above using another await/async approach:
+
+```ts
+try {
+ await knex.transaction(async (trx) => {
+ const books = [
+ { title: 'Canterbury Tales' },
+ { title: 'Moby Dick' },
+ { title: 'Hamlet' },
+ ];
+
+ const ids = await knex('catalogues')
+ .insert(
+ {
+ name: 'Old Books',
+ },
+ 'id'
+ )
+ .transacting(trx);
+
+ books.forEach((book) => (book.catalogue_id = ids[0]));
+ await knex('books').insert(books).transacting(trx);
+
+ console.log(inserts.length + ' new books saved.');
+ });
+} catch (error) {
+ console.error(error);
+}
+```
+
+Throwing an error directly from the transaction handler function automatically rolls back the transaction, same as returning a rejected promise.
+
+Notice that if a promise is not returned within the handler, it is up to you to ensure `trx.commit`, or `trx.rollback` are called, otherwise the transaction connection will hang.
+
+Calling `trx.rollback` will return a rejected Promise. If you don't pass any argument to `trx.rollback`, a generic `Error` object will be created and passed in to ensure the Promise always rejects with something.
+
+Note that Amazon Redshift does not support savepoints in transactions.
+
+In some cases you may prefer to create transaction but only execute statements in it later. In such case call method `transaction` without a handler function:
+
+```ts
+// Using trx as a transaction object:
+const trx = await knex.transaction();
+
+const books = [
+ { title: 'Canterbury Tales' },
+ { title: 'Moby Dick' },
+ { title: 'Hamlet' },
+];
+
+trx('catalogues')
+ .insert({ name: 'Old Books' }, 'id')
+ .then(function (ids) {
+ books.forEach((book) => (book.catalogue_id = ids[0]));
+ return trx('books').insert(books);
+ })
+ .then(trx.commit)
+ .catch(trx.rollback);
+```
+
+If you want to create a reusable transaction instance, but do not want to actually start it until it is used, you can create a transaction provider instance. It will start transaction after being called for the first time, and return same transaction on subsequent calls:
+
+```ts
+// Does not start a transaction yet
+const trxProvider = knex.transactionProvider();
+
+const books = [
+ { title: 'Canterbury Tales' },
+ { title: 'Moby Dick' },
+ { title: 'Hamlet' },
+];
+
+// Starts a transaction
+const trx = await trxProvider();
+const ids = await trx('catalogues').insert({ name: 'Old Books' }, 'id');
+books.forEach((book) => (book.catalogue_id = ids[0]));
+await trx('books').insert(books);
+
+// Reuses same transaction
+const sameTrx = await trxProvider();
+const ids2 = await sameTrx('catalogues').insert({ name: 'New Books' }, 'id');
+books.forEach((book) => (book.catalogue_id = ids2[0]));
+await sameTrx('books').insert(books);
+```
+
+You can access the promise that gets resolved after transaction is rolled back explicitly by user or committed, or rejected if it gets rolled back by DB itself, when using either way of creating transaction, from field `executionPromise`:
+
+```ts
+const trxProvider = knex.transactionProvider();
+const trx = await trxProvider();
+const trxPromise = trx.executionPromise;
+
+const trx2 = await knex.transaction();
+const trx2Promise = trx2.executionPromise;
+
+const trxInitPromise = new Promise(async (resolve, reject) => {
+ knex.transaction((transaction) => {
+ resolve(transaction);
+ });
+});
+const trx3 = await trxInitPromise;
+const trx3Promise = trx3.executionPromise;
+```
+
+You can check if a transaction has been committed or rolled back with the method `isCompleted`:
+
+```ts
+const trx = await knex.transaction();
+trx.isCompleted(); // false
+await trx.commit();
+trx.isCompleted(); // true
+
+const trx2 = knex.transactionProvider();
+await trx2.rollback();
+trx2.isCompleted(); // true
+```
+
+You can check the property `knex.isTransaction` to see if the current knex instance you are working with is a transaction.
+
+## Transaction Modes
+
+In case you need to specify an isolation level for your transaction, you can use a config parameter `isolationLevel`. Not supported by oracle and sqlite, options are `read uncommitted`, `read committed`, `repeatable read`, `snapshot` (mssql only), `serializable`.
+
+```ts
+// Simple read skew example
+const isolationLevel = 'read committed';
+const trx = await knex.transaction({ isolationLevel });
+const result1 = await trx(tableName).select();
+await knex(tableName).insert({ id: 1, value: 1 });
+const result2 = await trx(tableName).select();
+await trx.commit();
+// result1 may or may not deep equal result2 depending on isolation level
+```
+
+You may also set the transaction mode as `read only` using the `readOnly` config parameter. It is currently only supported on mysql, postgres, and redshift.
+
+```ts
+const trx = await knex.transaction({ readOnly: true });
+// 💥 Cannot `INSERT` while inside a `READ ONLY` transaction
+const result = await trx(tableName).insert({ id: 1, foo: 'bar' });
+```
diff --git a/docs/src/guide/utility.md b/docs/src/guide/utility.md
new file mode 100644
index 0000000000..7ff0fad6bc
--- /dev/null
+++ b/docs/src/guide/utility.md
@@ -0,0 +1,93 @@
+# Utility
+
+A collection of utilities that the knex library provides for convenience.
+
+## batchInsert
+
+**knex.batchInsert(tableName)**
+
+The `batchInsert` utility will insert a batch of rows wrapped inside a transaction _(which is automatically created unless explicitly given a transaction using [transacting](/guide/query-builder#transacting))_, at a given `chunkSize`.
+
+It's primarily designed to be used when you have thousands of rows to insert into a table.
+
+By default, the `chunkSize` is set to 1000.
+
+BatchInsert also allows for [returning values](/guide/query-builder#returning) and supplying transactions using [transacting](/guide/query-builder#transacting).
+
+```js
+const rows = [
+ {
+ /*...*/
+ },
+ {
+ /*...*/
+ },
+];
+const chunkSize = 30;
+knex
+ .batchInsert('TableName', rows, chunkSize)
+ .returning('id')
+ .then(function (ids) {
+ /*...*/
+ })
+ .catch(function (error) {
+ /*...*/
+ });
+
+knex
+ .transaction(function (tr) {
+ return knex.batchInsert('TableName', rows, chunkSize).transacting(tr);
+ })
+ .then(function () {
+ /*...*/
+ })
+ .catch(function (error) {
+ /*...*/
+ });
+```
+
+## now
+
+**knex.fn.now(precision)**
+
+Return the current timestamp with a precision (optional)
+
+```js
+table.datetime('some_time', { precision: 6 }).defaultTo(knex.fn.now(6));
+```
+
+## uuid
+
+**knex.fn.uuid()**
+
+Return a uuid generation function. Not supported by Redshift
+
+```js
+table.uuid('uuid').defaultTo(knex.fn.uuid());
+```
+
+## uuidToBin
+
+**knex.fn.uuidToBin(uuid)**
+
+Convert a string uuid (char(36)) to a binary uuid (binary(16))
+
+```js
+knex.schema.createTable('uuid_table', (t) => {
+ t.uuid('uuid_col_binary', { useBinaryUuid: true });
+});
+knex('uuid_table').insert({
+ uuid_col_binary: knex.fn.uuidToBin('3f06af63-a93c-11e4-9797-00505690773f'),
+});
+```
+
+## binToUuid
+
+**knex.fn.binToUuid(binaryUuid)**
+
+Convert a binary uuid (binary(16)) to a string uuid (char(36))
+
+```js
+const res = await knex('uuid_table').select('uuid_col_binary');
+knex.fn.binToUuid(res[0].uuid_col_binary);
+```
diff --git a/docs/src/index.md b/docs/src/index.md
new file mode 100644
index 0000000000..2352596286
--- /dev/null
+++ b/docs/src/index.md
@@ -0,0 +1,20 @@
+---
+home: true
+heroImage: /knex-logo.png
+heroAlt: Logo knex
+heroText: Knex.js
+tagline: SQL query builder
+actionText: View guide
+actionLink: /guide/
+altActionText: Star on GitHub
+altActionLink: https://github.com/knex/knex
+title: SQL Query Builder for Javascript
+---
+
+
+
+**Knex.js** (pronounced [/kəˈnɛks/](https://youtu.be/19Av0Lxml-I?t=521)) is a "batteries included" SQL query builder for **PostgreSQL**, **CockroachDB**, **MSSQL**, **MySQL**, **MariaDB**, **SQLite3**, **Better-SQLite3**, **Oracle**, and **Amazon Redshift** designed to be flexible, portable, and fun to use.
+
+It features both traditional node style [callbacks](/guide/interfaces#callbacks) as well as a [promise](/guide/interfaces#promises) interface for cleaner async flow control, [a stream interface](/guide/interfaces#streams), full-featured [query](/guide/query-builder) and [schema](/guide/schema-builder) builders, [**transaction support (with savepoints)**](/guide/transactions), connection [pooling](/guide/#pool) and standardized responses between different query clients and dialects.
+
+
diff --git a/docs/src/public/knex-logo.png b/docs/src/public/knex-logo.png
new file mode 100644
index 0000000000..eb2e902072
Binary files /dev/null and b/docs/src/public/knex-logo.png differ