documentation for templates, a lot of examples some fixes

Author: artzhookov

.gitignore

@@ -1,2 +1,3 @@
 node_modules/
-coverage/
+coverage/
+npm-debug.log

.npmignore

@@ -1,2 +1,5 @@
-.npmignore
-test
+tests/
+examples/
+coverage/
+docs/
+gulpfile.js

LICENSE

@@ -1,6 +1,6 @@
 (The MIT License)
 
-Copyright (c) 2013-2014 Oleg Korobenko <oleg.korobenko@gmail.com>
+Copyright (c) 2013-2015 2do2go team <dev.2do2go@gmail.com>
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

README.md

@@ -142,4 +142,4 @@ $ gulp coverage
 
 ## License
 
-MIT
+[MIT](./LICENSE)

docs/README.md

@@ -53,9 +53,62 @@ Return object with properties:
 | `getValuesArray` | Method to get values as array.<br>Exists only if `separatedValues = true`. |
 | `getValuesObject` | Method to get values as object.<br>Exists only if `separatedValues = true`. |
 
-## Queries
+## Query types
 
 ### select
 
-__template:__ `{with} {withRecursive} select {distinct} {fields} from {from} {table} {query} {select} {expression} {alias} {join} {condition} {group} {sort} {limit} {offset}`
+Template for select queries.
 
+__template:__ `{with} {withRecursive} select {distinct} {fields} from {table} {query} {select} {expression} {alias} {join} {condition} {group} {sort} {limit} {offset}`
+
+### insert
+
+Template for insert queries.
+
+__template:__ `{with} {withRecursive} insert {or} into {table} {values} {condition} {returning}`
+
+### update
+
+Template for update queries.
+
+__template:__ `{with} {withRecursive} update {or} {table} {modifier} {condition} {returning}`
+
+### remove
+
+Template for remove queries.
+
+__template:__ `{with} {withRecursive} delete from {table} {condition} {returning}`
+
+### union / intersect / except
+
+Template for union, intersect and except queries.
+
+__template:__ `{with} {withRecursive} {queries} {sort} {limit} {offset}`
+
+### Auxiliary templates
+
+Templates below are used inside of blocks:
+
+### subQuery
+
+Template is used to build subqueries.
+
+__template:__ `({queryBody})`
+
+### insertValues
+
+Template is used by `values` block.
+
+__template:__ `({fields}) values {fieldValues}`
+
+### joinItem
+
+Template is used by `join` block to build each item.
+
+__template:__ `{type} join {table} {query} {select} {expression} {alias} {on}`
+
+### withItem
+
+Template is used by `with` and `withRecursive` blocks to build each item.
+
+__template:__ `{name} {fields} as {query} {select} {expression}`

examples/common/condition.md

@@ -0,0 +1,49 @@
+# Condition
+
+## Example 1 - array
+
+Query:
+
+``` js
+var sql = jsonSql.build({
+    table: 'table',
+    condition: [
+        {a: {$gt: 1}},
+        {b: {$lt: 10}}
+    ]
+});
+```
+
+Result:
+
+``` js
+sql.query
+// select * from "table" where "a" > 1 and "b" < 10;
+
+sql.values
+// {}
+```
+
+## Example 2 - object
+
+Query:
+
+``` js
+var sql = jsonSql.build({
+    table: 'table',
+    condition: {
+        a: {$gt: 1},
+        b: {$lt: 10}
+    }
+});
+```
+
+Result:
+
+``` js
+sql.query
+// select * from "table" where "a" > 1 and "b" < 10;
+
+sql.values
+// {}
+```

examples/common/returning.md

@@ -0,0 +1,22 @@
+# Returning
+
+Query:
+
+``` js
+var sql = jsonSql.build({
+    type: 'insert',
+    table: 'table',
+    values: {a: 5},
+    returning: ['table.*']
+});
+```
+
+Result:
+
+``` js
+sql.query
+// insert into "table" ("a") values (5) returning "table".*;
+
+sql.values
+// {}
+```

examples/common/table.md

@@ -0,0 +1,19 @@
+# Table
+
+Query:
+
+``` js
+var sql = jsonSql.build({
+    table: 'table'
+});
+```
+
+Result:
+
+``` js
+sql.query
+// select * from "table";
+
+sql.values
+// {}
+```

examples/common/with.md

@@ -0,0 +1,51 @@
+# With
+
+## Example 1 - array
+
+Query:
+
+``` js
+var sql = jsonSql.build({
+    'with': [{
+        name: 'table',
+        select: {table: 'withTable'}
+    }],
+    table: 'table'
+});
+```
+
+Result:
+
+``` js
+sql.query
+// with "table" as (select * from "withTable") select * from "table";
+
+sql.values
+// {}
+```
+
+
+## Example 2 - object
+
+Query:
+
+``` js
+var sql = jsonSql.build({
+    'with': {
+        table: {
+            select: {table: 'withTable'}
+        }
+    },
+    table: 'table'
+});
+```
+
+Result:
+
+``` js
+sql.query
+// with "table" as (select * from "withTable") select * from "table";
+
+sql.values
+// {}
+```

examples/common/withRecursive.md

@@ -0,0 +1,51 @@
+# With (recursive)
+
+## Example 1 - array
+
+Query:
+
+``` js
+var sql = jsonSql.build({
+    withRecursive: [{
+        name: 'table',
+        select: {table: 'withTable'}
+    }],
+    table: 'table'
+});
+```
+
+Result:
+
+``` js
+sql.query
+// with recursive "table" as (select * from "withTable") select * from "table";
+
+sql.values
+// {}
+```
+
+
+## Example 2 - object
+
+Query:
+
+``` js
+var sql = jsonSql.build({
+    withRecursive: {
+        table: {
+            select: {table: 'withTable'}
+        }
+    },
+    table: 'table'
+});
+```
+
+Result:
+
+``` js
+sql.query
+// with recursive "table" as (select * from "withTable") select * from "table";
+
+sql.values
+// {}
+```