path: root/src/clojure_sql/dsl.clj

(ns clojure-sql.dsl
  (:refer-clojure :exclude [sort group take drop])
  (:require [clojure.set :as set]
            [clojure.walk :as walk]
            [clojure-sql.query :as q]
            [clojure-sql.util :as u]))


;; ==============================================================
;; The DSL for making query maps
;; ==============================================================

;; {
;;  :tables => tablename -> table_alias
;;  :fields => (table_alias, fieldname) -> field_alias
;;  :joins => [left-table type right-table on?]
;;  :where => expression
;;  :sort => [(field, direction)]
;;  :group => [field]
;;  :having => expression
;; }

(defn ^:private ambiguous-error [field & [query]]
  (throw (ex-info (str "Ambiguous field " field " in query")
                  {:field field
                   :query query})))

(defn ^:private same-rename-error [alias renames & [query]]
  (throw (ex-info (str "Cannot rename multiple fields to the same alias: " alias)
                  {:alias alias
                   :renames renames
                   :query query})))

(defn ^:private missing-rename-error [field renames & [query]]
  (throw (ex-info (str "Cannot rename field not present in query: " field)
                  {:field field
                   :query query
                   :renames renames})))

(defn ^:private common-fields-error [left right common-fields]
  (throw (ex-info "Cannot join with common fields unless natural join"
                  {:left left
                   :right right
                   :common-fields common-fields})))

(defn ^:private cross-join-duplicate-fields [common-fields left right]
  (throw (ex-info "Cross join will introduce ambiguous duplicate fields"
                  {:left left
                   :right right
                   :common-fields common-fields})))

(defn ^:private cross-join-condition-error [condition left right]
  (throw (ex-info "Cannot have a cross join with condition (maybe you wanted either a selection or an inner join)"
                  {:left left
                   :right right
                   :condition condition})))

(defn ^:private invalid-join-type [type left right]
  (throw (ex-info (str "Invalid join type: " type)
                  {:left left
                   :right right
                   :type type })))

(defn ^:private not-a-function-expression [expr]
  (throw (ex-info "Expr is not a function application - could not possibly be an aggregate"
                  {:expr expr})))

(defn ^:private invalid-union [queries]
  (throw (ex-info "Cannot union queries with different fields"
                  {:queries queries})))

(defn ^:private rename-table [query from to]
  (q/map->Query (walk/prewalk-replace {from to} (into {} query))))

(defn ^:private resolve-field [tables aliases field]
  (or (and aliases (aliases field))
      (if (= (count tables) 1)
        [(key (first tables)) field]
        (ambiguous-error field))))

(defn ^:private process-expression [tables aliases expression]
  (cond (vector? expression) (list 'quote (mapv (partial process-expression tables aliases) expression))
        (sequential? expression) (map (partial process-expression tables aliases) expression)
        (keyword? expression) (resolve-field tables aliases expression)
        :else expression))

(def ^:dynamic *default-executor* nil)
(defn set-default-query-executor! [executor]
  (alter-var-root #'*default-executor* (constantly executor)))
(defmacro with-default-query-executor [executor & body]
  `(binding [*default-executor* ~executor] ~@body))

(defn table
  "Create a query on a database table. If `table` is itself a query it
  will be wrapped, otherwise `table` will be used as the table name."
  [table & [executor]]
  (q/map->Query (let [table-name (if (u/named? table) (name table) "table")
                      table-keyword (keyword (gensym table-name))]
                  {:tables {table-keyword table}
                   :joins [table-keyword]
                   :executor (or executor *default-executor*)})))

(defn ^:private into-map-duplicate-error [coll error-fn]
  (reduce (fn [acc [k v]]
            (if (contains? acc k)
              (error-fn k v)
              (assoc acc k v)))
          {} coll))

(defn ^:private rename-with-fn [query field-renames]
  (let [new-name #(or (field-renames %) %)
        new-fields (map (fn [[alias field]]
                          [(new-name alias) field])
                        (:fields query))
        error-fn (fn [k _] (same-rename-error k field-renames query))]
    (assoc query
      :fields (into-map-duplicate-error new-fields error-fn))))

(defn ^:private rename-with-map [query field-renames]
  (doseq [[field alias] field-renames]
    (if-not (contains? (:fields query) field)
      (missing-rename-error field field-renames query)))
  (rename-with-fn query field-renames))

(defn rename
  "Rename fields in a query. All fields must already exist prior to
  calling rename (no automatic creation like `project`).

  `field-renames` can be either a function or a map. If a function is
  provided then it will be applied to each field: the return value
  will be used as the new alias, with a return of nil indicating no
  change. If a map is provided then it will behave identically to a
  function, but will throw errors if you are attempting to rename a
  non-existent field."
  [query field-renames]
  (if (map? field-renames)
    (rename-with-map query field-renames)
    (rename-with-fn query field-renames)))

(defn project
  "Limit a query's fields to a specified set of fields. `fields` can
  be either a seq of allowed field names, or a map of field names to
  aliases.

  If the query is currently on a single table then any unknown fields
  will be resolved as columns in that table. If the query is on more
  than one table then an exception will be thrown for unknown fields."
  [query fields]
  (if (map? fields)
    (-> (project query (keys fields))
        (rename-with-map fields))
    (let [get-real-name #(process-expression (:tables query) (:fields query) %)
          query (assoc query
                  :fields (->> fields
                               (map (juxt identity get-real-name))
                               (into {})))]
      query)))

(defn prefix-names-matching
  "Higher-order helper function to use with `rename`."
  [pred prefix] 
  (fn [alias]
    (if (pred alias)
      (keyword (str prefix (name alias)))
      alias)))

(defn prefix-names
  "Higher-order helper function to use with `rename`."
  [prefix] (prefix-names-matching (constantly true) prefix))

(defn as-subobject
  "Prefix all field names with \"{key}.\" to use them as sub-objects
  in the final result. Can also be useful to disambiguate fields for
  joins in a regular and predictable manner."
  [key] (prefix-names (str (name key) \.)))


(defn ^:private conjunction? [clause]
  (or (nil? clause)
      (and (sequential? clause)
           (= (name (first clause)) "and"))))

(defn ^:private clean-conjunction [clause]
  (if (conjunction? clause)
    (next clause)
    [clause]))

(defn ^:private combine-conjunctions [& wheres]
  (let [conjunction (reduce (fn [acc where]
                              `(and ~@(clean-conjunction acc)
                                    ~@(clean-conjunction where)))
                            nil wheres)]
    (case (count conjunction)
      1 nil
      2 (second conjunction)
      (seq conjunction))))

(defn ^:private joinable? [query] 
  (and (nil? (:group query))
       (nil? (:having query))
       (nil? (:take query))
       (nil? (:drop query))
       (nil? (:distinct query))
       (nil? (:set-operation query))))

(defn ^:private convert-to-subquery [query]
  (-> (table query)
      (project (keys (:fields query)))))

(defn ^:private remove-sort [query]
  (dissoc query :sort))

(defn ^:private make-join-subquery [query]
  (cond (joinable? query) query
        (:take query) (convert-to-subquery query)
        (:drop query) (convert-to-subquery query)
        (:distinct query) (convert-to-subquery query)
        :else (convert-to-subquery (remove-sort query))))

(defn ^:private rename-all-tables [query]
  (reduce (fn [query [alias table]]
            (rename-table query alias (keyword (gensym "table"))))
          query (:tables query)))

(def ^:private valid-join-type? (comp boolean #{:cross :inner :outer :full-outer}))
(defn join
  "Join two queries into one query. The fields of the resultant query
  will be the union of the argument queries.

  If `type` is not provided then the join type will be automatically
  set: if the arguments have any fields in common, or if an `on` is
  provided, then an inner join will be performed (joining on common
  fields if no `on` is provided), otherwise a cross join will be
  performed.

  Valid join types are :cross, :inner, :outer and :full-outer. An
  outer join is considered a LEFT outer join. To achieve a right outer
  join reverse the query arguments."
  [left right & {:keys [on type]}]
  (assert (= (:executor left) (:executor right)) "Cannot join queries with different executors.")
  (let [left (make-join-subquery left)
        right (rename-all-tables (make-join-subquery right))
        merged-tables (merge (:tables left) (:tables right))
        common-fields (set/intersection (set (keys (:fields left)))
                                        (set (keys (:fields right))))
        merged-fields (merge (:fields right) (:fields left)) ;; favour the left name for outer joins
        join-condition (cond
                        (nil? on) (->> common-fields
                                       (map (fn [field] `(= ~(resolve-field (:tables left) (:fields left) field)
                                                            ~(resolve-field (:tables right) (:fields right) field))))
                                       (reduce combine-conjunctions)) 
                        (seq common-fields) (common-fields-error left right common-fields)
                        :else (process-expression merged-tables merged-fields on))
        type (or type (if join-condition :inner :cross))
        [join-condition where] (if (or (= type :outer) (= type :full-outer))
                                 [(combine-conjunctions (:where right) join-condition) (:where left)]
                                 [join-condition (combine-conjunctions (:where left) (:where right))])]
    (cond
     (not (valid-join-type? type)) (invalid-join-type type left right)
     (and (= type :cross) join-condition) (if (seq common-fields)
                                            (cross-join-duplicate-fields common-fields left right)
                                            (cross-join-condition-error join-condition left right))
     :else (assoc left
             :fields merged-fields
             :tables merged-tables
             :joins {:left (:joins left)
                     :right (:joins right)
                     :type type
                     :on join-condition}
             :where where
             :sort (seq (concat (:sort left)
                                (:sort right)))))))

(defn select
  "Apply a filter to a query. The expression is an unevaluated
  expression which is compiled by the clojure-sql
  compiler. Alternatively a map can be provided instead of an
  expression, in which case the keys and values will be compiled as an
  equality test in the resulting query.

  Any keywords present in the query are interpreted as field names. A
  quote can be used to suppress evaluation of terms in the
  expression.

  If the query being filtered is the result of a previous grouping
  operation then a `select` operation will compile in one of two
  different ways:
    1. If the selection is entirely made on grouped attributes it will
    compile into a `having` clause in the resulting query.
    2. If the selection includes non-grouped attributes then a
    subquery will be introduced.

  Example:
    (select query `(= :id 10)) - filter for an id of 10
    (select query {:id 10}) - equivalent to the above
    (select query `(in :id '(1 2 3)) - filter for an id of 1, 2 or 3"
  [query expression]
  (let [expression (if (map? expression)
                     (reduce combine-conjunctions
                             (map #(cons '= %) expression))
                     expression)
        expression-fields (filter keyword? (flatten expression))
        bad-expression-fields (set/difference (set (process-expression nil
                                                                       (:fields query)
                                                                       expression-fields))
                                              (set (:group query)))
        where? (nil? (:group query))
        having? (empty? bad-expression-fields)]
    (if (or where? having?)
      (let [attr (if where? :where :having) 
            resolved-expression (process-expression (:tables query) (:fields query) expression)]
        (update-in query [attr] combine-conjunctions resolved-expression))
      (recur (convert-to-subquery query) expression))))

(defn sort
  "Apply a sort to a query. Replaces any existing sort on the
  query (ie. is not stable) .

  `fields` is a sequential collection of fields to sort by. Each
  element of fields can be either a field name, :field, or a vector of
  field and direction, [:field :desc].

  If a `take` or `drop` has already been applied to this query then
  the sort will be applied *after* the `take`/`drop` (which results in
  a subquery being created)."
  [query fields]
  (let [query (if (or (:take query) (:drop query))
                (convert-to-subquery query)
                query)
        fields-seq (if (sequential? fields)
                     fields
                     [fields])]
    (assoc query
      :sort (for [field fields-seq]
              (if (vector? field)
                [(process-expression (:tables query) (:fields query) (first field)) (second field)]
                [(process-expression (:tables query) (:fields query) field) :asc])))))

(defn group
  "Apply a grouping to a query.

  `fields` is a collection of fields to group by. `projection` is a
  map with which to perform a projection.

  The projection must perform an aggregate function on each
  non-grouped field, or else the resulting group is invalid. This is
  not verifiable without knowing the full set of aggregate
  functions (which is not possible in general), so any projection will
  be accepted as long as a function is called as a part of each
  projection.

  If the query has already been grouped then this will create a
  subquery."
  [query fields projection]
  (let [query (if (:group query)
                (convert-to-subquery query)
                query)
        fields-seq (if (sequential? fields)
                     fields
                     [fields])
        fields-map (into {} (map vector fields fields))]
    (doseq [[expr name] projection]
      (try (or (some #{expr} fields-seq)
               (seq expr))
           (catch Exception e
             (not-a-function-expression expr))))
    (-> query
        (assoc :group (map (partial resolve-field (:tables query) (:fields query))
                           fields-seq))
        (project (into fields-map projection)))))

(defn take
  "Limit the number of results of a query.

  Note: take/drop will function as they do on clojure sequences. They
  will not simply overwrite the previous take/drop value. Example:
    (-> query (take 10) (drop 2)) = (-> query (drop 2) (take 8))"
  [query n]
  (if-let [old-take (:take query)]
    (assoc query :take (min old-take n))
    (assoc query :take n)))

(defn drop
  "Exclude the first `n` results of a query.

  Note: take/drop will function as they do on clojure sequences. They
  will not simply overwrite the previous take/drop value. Example:
    (-> query (take 10) (drop 2)) = (-> query (drop 2) (take 8))"
  [query n]
  (let [query (if-let [old-take (:take query)]
                (assoc query :take (max (- old-take n) 0))
                query)]
    (if-let [old-drop (:drop query)]
      (assoc query :drop (+ old-drop n))
      (assoc query :drop n))))

(defn distinct
  "Return only unique rows from this query."
  [query]
  (assoc (if (or (:take query) (:drop query))
           (convert-to-subquery query)
           query)
    :distinct true))

(defn ^:private union-compatible? [& queries]
  (and (every? (comp seq keys :fields) queries)
       (apply = (map (comp set keys :fields) queries))
       (apply = (map :executor queries))))

(defn union
  "Combine the results of two queries.

  Will always introduce a subquery."
  [& queries]
  {:pre [(apply union-compatible? queries)]}
  (convert-to-subquery (q/map->Query {:set-operation :union
                                      :queries queries
                                      :fields (zipmap (keys (:fields (first queries))) (repeat nil))})))

(defn intersection
  "Take the common rows in two queries.

  Will always introduce a subquery."
  [& queries]
  {:pre [(apply union-compatible? queries)]}
  (convert-to-subquery (q/map->Query {:set-operation :intersect
                                      :queries queries
                                      :fields (zipmap (keys (:fields (first queries))) (repeat nil))
                                      :executor (:executor (first queries))})))