next.jdbc.sql.builder — com.github.seancorfield/next.jdbc 1.3.909

Some utility functions for building SQL strings.

These were originally private functions in next.jdbc.sql but they may prove useful to developers who want to write their own 'SQL sugar' functions, such as a database-specific upsert! etc.

as-? clj

(as-? key-map _)

Given a hash map of column names and values, or a vector of column names, return a string of ? placeholders for them.

as-cols clj

(as-cols cols opts)

Given a sequence of raw column names, return a string of all the formatted column names.

If a raw column name is a keyword, apply :column-fn to its name, from the options if present.

If a raw column name is a vector pair, treat it as an expression with an alias. If the first item is a keyword, apply :column-fn to its name, else accept it as-is. The second item should be a keyword and that will have :column-fn applied to its name.

This allows columns to be specified as simple names, e.g., :foo, as simple aliases, e.g., [:foo :bar], or as expressions with an alias, e.g., ["count(*)" :total].

as-keys clj

(as-keys key-map opts)

Given a hash map of column names and values, return a string of all the column names.

Applies any :column-fn supplied in the options.

by-keys clj

(by-keys key-map clause opts)

Given a hash map of column names and values and a clause type (:set, :where), return a vector of a SQL clause and its parameters.

Applies any :column-fn supplied in the options.

for-delete clj

(for-delete table where-params opts)

Given a table name and either a hash map of column names and values or a vector of SQL (where clause) and its parameters, return a vector of the full DELETE SQL string and its parameters.

Applies any :table-fn / :column-fn supplied in the options.

If :suffix is provided in opts, that string is appended to the DELETE ... statement.

for-insert clj

(for-insert table key-map opts)

Given a table name and a hash map of column names and their values, return a vector of the full INSERT SQL string and its parameters.

Applies any :table-fn / :column-fn supplied in the options.

If :suffix is provided in opts, that string is appended to the INSERT ... statement.

for-insert-multi clj

(for-insert-multi table cols rows opts)

Given a table name, a vector of column names, and a vector of row values (each row is a vector of its values), return a vector of the full INSERT SQL string and its parameters.

Applies any :table-fn / :column-fn supplied in the options.

If :batch is set to true in opts the INSERT statement will be prepared using a single set of placeholders and remaining parameters in the vector will be grouped at the row level.

If :suffix is provided in opts, that string is appended to the INSERT ... statement.

for-order clj

(for-order order-by opts)

Given an :order-by vector, return an ORDER BY clause.

for-order-col clj

(for-order-col col opts)

Given a column name, or a pair of column name and direction, return the sub-clause for addition to ORDER BY.

for-query clj

(for-query table where-params opts)

Given a table name and either a hash map of column names and values or a vector of SQL (where clause) and its parameters, return a vector of the full SELECT SQL string and its parameters.

Applies any :table-fn / :column-fn supplied in the options.

Handles pagination options (:top, :limit / :offset, or :offset / :fetch) for SQL Server, MySQL / SQLite, ANSI SQL respectively.

By default, this selects all columns, but if the :columns option is present the select will only be those columns.

If :suffix is provided in opts, that string is appended to the SELECT ... statement.

for-update clj

(for-update table key-map where-params opts)

Given a table name, a vector of column names to set and their values, and either a hash map of column names and values or a vector of SQL (where clause) and its parameters, return a vector of the full UPDATE SQL string and its parameters.

Applies any :table-fn / :column-fn supplied in the options.

If :suffix is provided in opts, that string is appended to the UPDATE ... statement.