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

Tweak docstring

Browse source
This commit is contained in:
Sean Corfield 2021-04-10 00:13:04 -07:00
parent 35c6fc58a5
commit 7a83bc13fe
1 changed files with 8 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
src/honey/sql.cljc
View file

@ -8,20 +8,24 @@
supported syntax. supported syntax.
In addition, functions to extend HoneySQL are also provided here: In addition, functions to extend HoneySQL are also provided here:
* `sql-kw` -- turns a Clojure keyword into SQL code (makes it uppercase * `clause-order` -- returns the current clause priority ordering;
and replaces - with space). intended as aid when registering new clauses.
* `format-dsl` -- intended to format SQL statements; returns a vector * `format-dsl` -- intended to format SQL statements; returns a vector
containing a SQL string followed by parameter values. containing a SQL string followed by parameter values.
* `format-entity` -- intended to format SQL entities; returns a string
representing the SQL entity.
* `format-expr` -- intended to format SQL expressions; returns a vector * `format-expr` -- intended to format SQL expressions; returns a vector
containing a SQL string followed by parameter values. containing a SQL string followed by parameter values.
* `format-expr-list` -- intended to format a list of SQL expressions; * `format-expr-list` -- intended to format a list of SQL expressions;
returns a pair comprising: a sequence of SQL expressions (to be returns a pair comprising: a sequence of SQL expressions (to be
join with a delimiter) and a sequence of parameter values. join with a delimiter) and a sequence of parameter values.
* `set-dialect!` -- set the default dialect to be used for formatting.
* `register-clause!` -- register a new statement/clause formatter. * `register-clause!` -- register a new statement/clause formatter.
* `register-fn!` -- register a new function call (or special syntax) * `register-fn!` -- register a new function call (or special syntax)
formatter. formatter.
* `register-op!` -- register a new operator formatter." * `register-op!` -- register a new operator formatter.
* `set-dialect!` -- set the default dialect to be used for formatting.
* `sql-kw` -- turns a Clojure keyword (or symbol) into SQL code (makes
it uppercase and replaces - with space). "
(:refer-clojure :exclude [format]) (:refer-clojure :exclude [format])
(:require [clojure.string :as str])) (:require [clojure.string :as str]))