luciano/honeysql
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

readme tweaks

Browse source
This commit is contained in:
Justin Kramer 2012-07-13 13:13:37 -04:00
parent f73b02907f
commit fe1561e355
1 changed files with 6 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -22,14 +22,14 @@ Everything is built on top of maps representing SQL queries:
:where [:= :f.a "baz"]}) :where [:= :f.a "baz"]})
``` ```
`format-sql` turns maps into `clojure.java.jdbc`-compatible, parameterized SQL: `format` turns maps into `clojure.java.jdbc`-compatible, parameterized SQL:
```clj ```clj
(sql/format sqlmap) (sql/format sqlmap)
=> ["SELECT a, b, c FROM foo WHERE (f.a = ?)" ["baz"]] => ["SELECT a, b, c FROM foo WHERE (f.a = ?)" ["baz"]]
``` ```
There are helper functions to build SQL maps. They compose together nicely. There are helper functions to build SQL maps. They compose together nicely:
```clj ```clj
(-> (select :a :b :c) (-> (select :a :b :c)
@ -37,7 +37,7 @@ There are helper functions to build SQL maps. They compose together nicely.
(where [:= :f.a "baz"])) (where [:= :f.a "baz"]))
``` ```
Order doesn't matter. Order doesn't matter:
```clj ```clj
(= (-> (select :*) (from :foo)) (= (-> (select :*) (from :foo))
@ -45,14 +45,14 @@ Order doesn't matter.
=> true => true
``` ```
When using the vanilla helper functions, new clauses will replace old clauses. When using the vanilla helper functions, new clauses will replace old clauses:
```clj ```clj
(-> sqlmap (select :*)) (-> sqlmap (select :*))
=> {:from [:foo], :where [:= :f.a "baz"], :select (:*)} => {:from [:foo], :where [:= :f.a "baz"], :select (:*)}
``` ```
To add to clauses instead of replacing them, use `merge-select`, `merge-where`, etc. To add to clauses instead of replacing them, use `merge-select`, `merge-where`, etc.:
```clj ```clj
(sql/format (sql/format
@ -106,7 +106,7 @@ Here's a big, complicated query. (Note that Honey SQL makes no attempt to verify
=> ["SELECT DISTINCT f.*, b.baz, c.quux, NOW(), @x := 10 FROM foo AS f, baz AS b LEFT JOIN clod AS c ON (f.a = c.d) JOIN draq ON (f.b = draq.x) WHERE (((f.a = ?) AND (b.baz != ?)) OR (f.e IN (1, 2, 3)) OR f.e BETWEEN 10 AND 20) ORDER BY b.baz DESC, c.quux LIMIT 50 OFFSET 10" => ["SELECT DISTINCT f.*, b.baz, c.quux, NOW(), @x := 10 FROM foo AS f, baz AS b LEFT JOIN clod AS c ON (f.a = c.d) JOIN draq ON (f.b = draq.x) WHERE (((f.a = ?) AND (b.baz != ?)) OR (f.e IN (1, 2, 3)) OR f.e BETWEEN 10 AND 20) ORDER BY b.baz DESC, c.quux LIMIT 50 OFFSET 10"
["bort" "gabba"]] ["bort" "gabba"]]
;; Fully readable ;; Printable and readable
(= *2 (read-string (pr-str *2))) (= *2 (read-string (pr-str *2)))
=> true => true
``` ```