forked from clojure/java.jdbc
/
jdbc.clj
1094 lines (981 loc) · 44.4 KB
/
jdbc.clj
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
;; Copyright (c) Sean Corfield, Stephen C. Gilardi. All rights reserved.
;; The use and distribution terms for this software are covered by
;; the Eclipse Public License 1.0
;; (http://opensource.org/licenses/eclipse-1.0.php) which can be
;; found in the file epl-v10.html at the root of this distribution.
;; By using this software in any fashion, you are agreeing to be
;; bound by the terms of this license. You must not remove this
;; notice, or any other, from this software.
;;
;; jdbc.clj
;;
;; A Clojure interface to sql databases via jdbc
;;
;; scgilardi (gmail)
;; Created 2 April 2008
;;
;; seancorfield (gmail)
;; Migrated from clojure.contrib.sql 17 April 2011
(ns
^{
:author "Stephen C. Gilardi, Sean Corfield",
:doc "A Clojure interface to SQL databases via JDBC
clojure.java.jdbc provides a simple abstraction for CRUD (create, read,
update, delete) operations on a SQL database, along with basic transaction
support. Basic DDL operations are also supported (create table, drop table,
access to table metadata).
Maps are used to represent records, making it easy to store and retrieve
data. Results can be processed using any standard sequence operations.
For most operations, Java's PreparedStatement is used so your SQL and
parameters can be represented as simple vectors where the first element
is the SQL string, with ? for each parameter, and the remaining elements
are the parameter values to be substituted. In general, operations return
the number of rows affected, except for a single record insert where any
generated keys are returned (as a map).
As of release 0.3.0, the API has undergone a major overhaul and most of the
original API has been deprecated in favor of a more idiomatic API, and a
minimal DSL for generating SQL has been added as an option. The original
API is still supported but will be deprecated before a 1.0.0 release is
made at some future date." }
clojure.java.jdbc
(:import [java.net URI]
[java.sql BatchUpdateException DriverManager ParameterMetaData
PreparedStatement ResultSet SQLException Statement Types]
[java.util Hashtable Map Properties]
[javax.naming InitialContext Name]
[javax.sql DataSource])
(:refer-clojure :exclude [resultset-seq])
(:require [clojure.string :as str]
[clojure.java.jdbc.sql :as sql]))
;; technically deprecated but still used as defaults in a couple of
;; places for backward compatibility...
(def ^{:private true :dynamic true
:doc "The default entity naming strategy is to do nothing."}
*as-str*
identity)
(def ^{:private true :dynamic true
:doc "The default keyword naming strategy is to lowercase the entity."}
*as-key*
str/lower-case)
;; end of deprecated API artifacts...
(defn- ^Properties as-properties
"Convert any seq of pairs to a java.utils.Properties instance.
Uses sql/as-str to convert both keys and values into strings."
[m]
(let [p (Properties.)]
(doseq [[k v] m]
(.setProperty p (sql/as-str identity k) (sql/as-str identity v)))
p))
(defprotocol Connectable
(add-connection [db connection])
(get-level [db]))
(defn- inc-level
"Increment the nesting level for a transacted database connection.
If we are at the top level, also add in a rollback state."
[db]
(let [nested-db (update-in db [:level] (fnil inc 0))]
(if (= 1 (:level nested-db))
(assoc nested-db :rollback (atom false))
nested-db)))
(extend-protocol Connectable
String
(add-connection [s connection] {:connection connection :level 0 :connection-string s})
(get-level [_] 0)
clojure.lang.Associative
(add-connection [m connection] (assoc m :connection connection))
(get-level [m] (or (:level m) 0))
nil
(add-connection [_ connection] {:connection connection :level 0 :legacy true})
(get-level [_] 0))
(def ^{:private true :dynamic true} *db* (add-connection nil nil))
(def ^{:private true :doc "Map of classnames to subprotocols"} classnames
{"postgresql" "org.postgresql.Driver"
"mysql" "com.mysql.jdbc.Driver"
"sqlserver" "com.microsoft.sqlserver.jdbc.SQLServerDriver"
"jtds:sqlserver" "net.sourceforge.jtds.jdbc.Driver"
"derby" "org.apache.derby.jdbc.EmbeddedDriver"
"hsqldb" "org.hsqldb.jdbcDriver"
"sqlite" "org.sqlite.JDBC"})
(def ^{:private true :doc "Map of schemes to subprotocols"} subprotocols
{"postgres" "postgresql"})
(defn- mysql?
"Given a db spec, return true if it represents MySQL. This is used for set-parameters."
[db]
(cond (string? db)
(re-find #"mysql:" db)
(:subprotocol db)
(= "mysql" (:subprotocol db))
(:connection db)
(.startsWith (.getName (type (:connection db))) "com.mysql.")))
(defn- parse-properties-uri [^URI uri]
(let [host (.getHost uri)
port (if (pos? (.getPort uri)) (.getPort uri))
path (.getPath uri)
scheme (.getScheme uri)]
(merge
{:subname (if port
(str "//" host ":" port path)
(str "//" host path))
:subprotocol (subprotocols scheme scheme)}
(if-let [user-info (.getUserInfo uri)]
{:user (first (str/split user-info #":"))
:password (second (str/split user-info #":"))}))))
(defn- strip-jdbc [^String spec]
(if (.startsWith spec "jdbc:")
(.substring spec 5)
spec))
(defn get-connection
"Creates a connection to a database. db-spec is a map containing connection
parameters. db-spec is a map containing values for one of the following
parameter sets:
Existing Connection:
:connection (required) an existing open connection that can be used
but cannot be closed (only the parent connection can be closed)
Factory:
:factory (required) a function of one argument, a map of params
(others) (optional) passed to the factory function in a map
DriverManager:
:subprotocol (required) a String, the jdbc subprotocol
:subname (required) a String, the jdbc subname
:classname (optional) a String, the jdbc driver class name
(others) (optional) passed to the driver as properties.
DataSource:
:datasource (required) a javax.sql.DataSource
:username (optional) a String
:password (optional) a String, required if :username is supplied
JNDI:
:name (required) a String or javax.naming.Name
:environment (optional) a java.util.Map
Raw:
:connection-uri (required) a String
Passed directly to DriverManager/getConnection
URI:
Parsed JDBC connection string - see below
String:
subprotocol://user:password@host:post/subname
An optional prefix of jdbc: is allowed."
[{:keys [connection
factory
connection-uri
classname subprotocol subname
datasource username password
name environment]
:as db-spec}]
(cond
connection
connection
(instance? URI db-spec)
(get-connection (parse-properties-uri db-spec))
(string? db-spec)
(get-connection (URI. (strip-jdbc db-spec)))
factory
(factory (dissoc db-spec :factory))
connection-uri
(DriverManager/getConnection connection-uri)
(and subprotocol subname)
(let [url (format "jdbc:%s:%s" subprotocol subname)
etc (dissoc db-spec :classname :subprotocol :subname)
classname (or classname (classnames subprotocol))]
(clojure.lang.RT/loadClassForName classname)
(DriverManager/getConnection url (as-properties etc)))
(and datasource username password)
(.getConnection ^DataSource datasource ^String username ^String password)
datasource
(.getConnection ^DataSource datasource)
name
(let [env (and environment (Hashtable. ^Map environment))
context (InitialContext. env)
^DataSource datasource (.lookup context ^String name)]
(.getConnection datasource))
:else
(let [^String msg (format "db-spec %s is missing a required parameter" db-spec)]
(throw (IllegalArgumentException. msg)))))
(defn- make-name-unique
"Given a collection of column names and a new column name,
return the new column name made unique, if necessary, by
appending _N where N is some unique integer suffix."
[cols col-name n]
(let [suffixed-name (if (= n 1) col-name (str col-name "_" n))]
(if (apply distinct? suffixed-name cols)
suffixed-name
(recur cols col-name (inc n)))))
(defn- make-cols-unique
"Given a collection of column names, rename duplicates so
that the result is a collection of unique column names."
[cols]
(if (or (empty? cols) (apply distinct? cols))
cols
(reduce (fn [unique-cols col-name] (conj unique-cols (make-name-unique unique-cols col-name 1))) [] cols)))
(defn result-set-seq
"Creates and returns a lazy sequence of maps corresponding to the rows in the
java.sql.ResultSet rs. Loosely based on clojure.core/resultset-seq but it
respects the specified naming strategy. Duplicate column names are made unique
by appending _N before applying the naming strategy (where N is a unique integer)."
[^ResultSet rs & {:keys [identifiers as-arrays?]
:or {identifiers str/lower-case}}]
(let [rsmeta (.getMetaData rs)
idxs (range 1 (inc (.getColumnCount rsmeta)))
keys (->> idxs
(map (fn [^Integer i] (.getColumnLabel rsmeta i)))
make-cols-unique
(map (comp keyword identifiers)))
row-values (fn [] (map (fn [^Integer i] (.getObject rs i)) idxs))
;; This used to use create-struct (on keys) and then struct to populate each row.
;; That had the side effect of preserving the order of columns in each row. As
;; part of JDBC-15, this was changed because structmaps are deprecated. We don't
;; want to switch to records so we're using regular maps instead. We no longer
;; guarantee column order in rows but using into {} should preserve order for up
;; to 16 columns (because it will use a PersistentArrayMap). If someone is relying
;; on the order-preserving behavior of structmaps, we can reconsider...
records (fn thisfn []
(when (.next rs)
(cons (zipmap keys (row-values)) (lazy-seq (thisfn)))))
rows (fn thisfn []
(when (.next rs)
(cons (vec (row-values)) (lazy-seq (thisfn)))))]
(if as-arrays?
(cons (vec keys) (rows))
(records))))
(defn resultset-seq
^{:doc "A deprecated version of result-set-seq that uses the
dynamic *as-key* variable."
:deprecated "0.3.0"}
[^ResultSet rs & {:keys [identifiers]
:or {identifiers *as-key*}}]
(result-set-seq rs :identifiers identifiers))
(defn- execute-batch
"Executes a batch of SQL commands and returns a sequence of update counts.
(-2) indicates a single operation operating on an unknown number of rows.
Specifically, Oracle returns that and we must call getUpdateCount() to get
the actual number of rows affected. In general, operations return an array
of update counts, so this may not be a general solution for Oracle..."
[^Statement stmt]
(let [result (.executeBatch stmt)]
(if (and (= 1 (count result)) (= -2 (first result)))
(list (.getUpdateCount stmt))
(seq result))))
(def ^{:private true
:doc "Map friendly :concurrency values to ResultSet constants."}
result-set-concurrency
{:read-only ResultSet/CONCUR_READ_ONLY
:updatable ResultSet/CONCUR_UPDATABLE})
(def ^{:private true
:doc "Map friendly :cursors values to ResultSet constants."}
result-set-holdability
{:hold ResultSet/HOLD_CURSORS_OVER_COMMIT
:close ResultSet/CLOSE_CURSORS_AT_COMMIT})
(def ^{:private true
:doc "Map friendly :type values to ResultSet constants."}
result-set-type
{:forward-only ResultSet/TYPE_FORWARD_ONLY
:scroll-insensitive ResultSet/TYPE_SCROLL_INSENSITIVE
:scroll-sensitive ResultSet/TYPE_SCROLL_SENSITIVE})
(defn prepare-statement
"Create a prepared statement from a connection, a SQL string and an
optional list of parameters:
:return-keys true | false - default false
:result-type :forward-only | :scroll-insensitive | :scroll-sensitive
:concurrency :read-only | :updatable
:cursors
:fetch-size n
:max-rows n"
[^java.sql.Connection con ^String sql &
{:keys [return-keys result-type concurrency cursors fetch-size max-rows]}]
(let [^PreparedStatement
stmt (cond return-keys
(try
(.prepareStatement con sql java.sql.Statement/RETURN_GENERATED_KEYS)
(catch Exception _
;; assume it is unsupported and try basic PreparedStatement:
(.prepareStatement con sql)))
(and result-type concurrency)
(if cursors
(.prepareStatement con sql
(result-type result-set-type)
(concurrency result-set-concurrency)
(cursors result-set-holdability))
(.prepareStatement con sql
(result-type result-set-type)
(concurrency result-set-concurrency)))
:else
(.prepareStatement con sql))]
(when fetch-size (.setFetchSize stmt fetch-size))
(when max-rows (.setMaxRows stmt max-rows))
stmt))
(defn- set-parameters
"Add the parameters to the given statement. Use parameter metadata if it is
available, which allows us to specify the SQL type and support NULL better."
[^PreparedStatement stmt params db]
(let [^ParameterMetaData metadata (when-not (mysql? db)
(try (.getParameterMetaData stmt)
(catch SQLException _)))]
(dorun (map-indexed (fn [ix value]
(let [ix* (inc ix)
sql-type (when metadata
(try (.getParameterType metadata ix*)
(catch SQLException _)))]
(if sql-type
(if (nil? value)
(.setNull stmt ix* sql-type)
(.setObject stmt ix* value))
(.setObject stmt ix* value))))
params))))
(defn create-table-ddl
"Given a table name and column specs with an optional table-spec
return the DDL string for creating a table based on that."
[name & specs]
(let [split-specs (partition-by #(= :table-spec %) specs)
col-specs (first split-specs)
table-spec (first (second (rest split-specs)))
table-spec-str (or (and table-spec (str " " table-spec)) "")
specs-to-string (fn [specs]
(apply str
(map (sql/as-str identity)
(apply concat
(interpose [", "]
(map (partial interpose " ") specs))))))]
(format "CREATE TABLE %s (%s)%s"
(sql/as-str identity name)
(specs-to-string col-specs)
table-spec-str)))
(defn print-sql-exception
"Prints the contents of an SQLException to *out*"
[^SQLException exception]
(let [^Class exception-class (class exception)]
(println
(format (str "%s:" \newline
" Message: %s" \newline
" SQLState: %s" \newline
" Error Code: %d")
(.getSimpleName exception-class)
(.getMessage exception)
(.getSQLState exception)
(.getErrorCode exception)))))
(defn print-sql-exception-chain
"Prints a chain of SQLExceptions to *out*"
[^SQLException exception]
(loop [e exception]
(when e
(print-sql-exception e)
(recur (.getNextException e)))))
(def ^{:private true} special-counts
{Statement/EXECUTE_FAILED "EXECUTE_FAILED"
Statement/SUCCESS_NO_INFO "SUCCESS_NO_INFO"})
(defn print-update-counts
"Prints the update counts from a BatchUpdateException to *out*"
[^BatchUpdateException exception]
(println "Update counts:")
(dorun
(map-indexed
(fn [index count]
(println (format " Statement %d: %s"
index
(get special-counts count count))))
(.getUpdateCounts exception))))
;; java.jdbc pieces rewritten to not use dynamic bindings
(defn db-find-connection
"Returns the current database connection (or nil if there is none)"
^java.sql.Connection [db]
(and (map? db)
(:connection db)))
(defn db-connection
"Returns the current database connection (or throws if there is none)"
^java.sql.Connection [db]
(or (db-find-connection db)
(throw (Exception. "no current database connection"))))
(defn- throw-non-rte
"This ugliness makes it easier to catch SQLException objects
rather than something wrapped in a RuntimeException which
can really obscure your code when working with JDBC from
Clojure... :("
[^Throwable ex]
(cond (instance? java.sql.SQLException ex) (throw ex)
(and (instance? RuntimeException ex) (.getCause ex)) (throw-non-rte (.getCause ex))
:else (throw ex)))
(defn db-set-rollback-only!
"Marks the outermost transaction such that it will rollback rather than
commit when complete"
[db]
(reset! (:rollback db) true))
(defn db-unset-rollback-only!
"Marks the outermost transaction such that it will not rollback when complete"
[db]
(reset! (:rollback db) false))
(defn db-is-rollback-only
"Returns true if the outermost transaction will rollback rather than
commit when complete"
[db]
(deref (:rollback db)))
(defn db-transaction*
"Evaluates func as a transaction on the open database connection. Any
nested transactions are absorbed into the outermost transaction. By
default, all database updates are committed together as a group after
evaluating the outermost body, or rolled back on any uncaught
exception. If rollback is set within scope of the outermost transaction,
the entire transaction will be rolled back rather than committed when
complete."
[db func]
(if (zero? (get-level db))
(let [^java.sql.Connection con (get-connection db)
nested-db (inc-level (add-connection db con))
auto-commit (.getAutoCommit con)]
(io!
(.setAutoCommit con false)
(try
(let [result (func nested-db)]
(if (db-is-rollback-only nested-db)
(.rollback con)
(.commit con))
result)
(catch Throwable t
(.rollback con)
(throw-non-rte t))
(finally
(db-unset-rollback-only! nested-db)
(.setAutoCommit con auto-commit)))))
(try
(func (inc-level db))
(catch Exception e
(throw-non-rte e)))))
(defmacro db-transaction
"Evaluates body in the context of a transaction on the specified database connection.
The binding provides the database connection for the transaction and the name to which
that is bound for evaluation of the body.
See db-transaction* for more details."
[binding & body]
`(db-transaction* ~(second binding)
(fn [~(first binding)] ~@body)))
(defn db-do-commands
"Executes SQL commands on the specified database connection. Wraps the commands
in a transaction if transaction? is true."
[db transaction? & commands]
(with-open [^Statement stmt (let [^java.sql.Connection con (get-connection db)] (.createStatement con))]
(doseq [^String cmd commands]
(.addBatch stmt cmd))
(if transaction?
(db-transaction [t-db (add-connection db (.getConnection stmt))]
(execute-batch stmt))
(try
(execute-batch stmt)
(catch Exception e
(throw-non-rte e))))))
(defn db-do-prepared-return-keys
"Executes an (optionally parameterized) SQL prepared statement on the
open database connection. The param-group is a seq of values for all of
the parameters.
Return the generated keys for the (single) update/insert."
[db transaction? sql param-group]
(with-open [^PreparedStatement stmt (prepare-statement (get-connection db) sql :return-keys true)]
(set-parameters stmt param-group db)
(letfn [(exec-and-return-keys []
(let [counts (.executeUpdate stmt)]
(try
(let [rs (.getGeneratedKeys stmt)
result (first (result-set-seq rs))]
;; sqlite (and maybe others?) requires
;; record set to be closed
(.close rs)
result)
(catch Exception _
;; assume generated keys is unsupported and return counts instead:
counts))))]
(if transaction?
(db-transaction [t-db (add-connection db (.getConnection stmt))]
(exec-and-return-keys))
(try
(exec-and-return-keys)
(catch Exception e
(throw-non-rte e)))))))
(defn db-do-prepared
"Executes an (optionally parameterized) SQL prepared statement on the
open database connection. Each param-group is a seq of values for all of
the parameters.
Return a seq of update counts (one count for each param-group)."
[db transaction? sql & param-groups]
(with-open [^PreparedStatement stmt (prepare-statement (get-connection db) sql)]
(if (empty? param-groups)
(if transaction?
(db-transaction [t-db (add-connection db (.getConnection stmt))]
(vector (.executeUpdate stmt)))
(try
(vector (.executeUpdate stmt))
(catch Exception e
(throw-non-rte e))))
(do
(doseq [param-group param-groups]
(set-parameters stmt param-group db)
(.addBatch stmt))
(if transaction?
(db-transaction [t-db (add-connection db (.getConnection stmt))]
(execute-batch stmt))
(try
(execute-batch stmt)
(catch Exception e
(throw-non-rte e))))))))
(defn db-with-query-results*
"Executes a query, then evaluates func passing in a seq of the results as
an argument. The first argument is a vector containing either:
[sql & params] - a SQL query, followed by any parameters it needs
[stmt & params] - a PreparedStatement, followed by any parameters it needs
(the PreparedStatement already contains the SQL query)
[options sql & params] - options and a SQL query for creating a
PreparedStatement, followed by any parameters it needs
See prepare-statement for supported options."
[db sql-params func identifiers as-arrays?]
(when-not (vector? sql-params)
(let [^Class sql-params-class (class sql-params)
^String msg (format "\"%s\" expected %s %s, found %s %s"
"sql-params"
"vector"
"[sql param*]"
(.getName sql-params-class)
(pr-str sql-params))]
(throw (IllegalArgumentException. msg))))
(let [special (first sql-params)
sql-is-first (string? special)
options-are-first (map? special)
sql (cond sql-is-first special
options-are-first (second sql-params))
params (vec (cond sql-is-first (rest sql-params)
options-are-first (rest (rest sql-params))
:else (rest sql-params)))
prepare-args (when (map? special) (flatten (seq special)))]
(with-open [^PreparedStatement stmt (if (instance? PreparedStatement special)
special
(apply prepare-statement (get-connection db) sql prepare-args))]
(set-parameters stmt params db)
(with-open [rset (.executeQuery stmt)]
(func (result-set-seq rset :identifiers identifiers :as-arrays? as-arrays?))))))
;; top-level API for actual SQL operations
(defn query
"Given a database connection and a vector containing SQL and optional parameters,
perform a simple database query. The optional keyword arguments specify how to
construct the result set:
:result-set-fn - applied to the entire result set, default doall
:row-fn - applied to each row as the result set is constructed, default identity
:identifiers - applied to each column name in the result set, default lower-case
:as-arrays? - return the results as a set of arrays, default false."
[db sql-params & {:keys [result-set-fn row-fn identifiers as-arrays?]
:or {result-set-fn doall
row-fn identity
identifiers sql/lower-case}}]
(let [query-helper (fn [db]
(db-with-query-results* db
(vec sql-params)
(fn [rs]
(result-set-fn (if as-arrays?
(cons (first rs)
(vec (map row-fn (rest rs))))
(map row-fn rs))))
identifiers
as-arrays?))]
(if-let [con (and (map? db) (:connection db))]
(query-helper db)
(with-open [con (get-connection db)]
(query-helper
(add-connection db con))))))
(defn execute!
"Given a database connection and a vector containing SQL and optional parameters,
perform a general (non-select) SQL operation. The optional keyword argument specifies
whether to run the operation in a transaction or not (default true)."
[db sql-params & {:keys [transaction?]
:or {transaction? true}}]
(let [execute-helper (fn [db]
(db-do-prepared db
transaction?
(first sql-params)
(rest sql-params)))]
(if-let [con (and (map? db) (:connection db))]
(execute-helper db)
(with-open [con (get-connection db)]
(execute-helper (add-connection db con))))))
(defn delete!
"Given a database connection, a table name and a where clause of columns to match,
perform a delete. The optional keyword arguments specify how to transform
column names in the map (default 'as-is') and whether to run the delete in
a transaction (default true).
Example:
(delete! db :person (where {:zip 94546}))
is equivalent to:
(execute! db [\"DELETE FROM person WHERE zip = ?\" 94546])"
[db table where-clause & {:keys [entities transaction?]
:or {entities sql/as-is transaction? true}}]
(execute! db
(sql/delete table where-clause :entities entities)
:transaction? transaction?))
(defn- multi-insert-helper
"Given a (connected) database connection and some SQL statements (for multiple
inserts), run a prepared statement on each and return any generated keys.
Note: we are eager so an unrealized lazy-seq cannot escape from the connection."
[db stmts]
(doall (map (fn [row]
(db-do-prepared-return-keys db false (first row) (rest row)))
stmts)))
(defn- insert-helper
"Given a (connected) database connection, a transaction flag and some SQL statements
(for one or more inserts), run a prepared statement or a sequence of them."
[db transaction? stmts]
(if (string? (first stmts))
(apply db-do-prepared db transaction? (first stmts) (rest stmts))
(if transaction?
(db-transaction [t-db db] (multi-insert-helper t-db stmts))
(multi-insert-helper db stmts))))
(defn- extract-transaction?
"Given a sequence of data, look for :transaction? arg in it and return a pair of
the transaction? value (defaulting to true) and the data without the option."
[data]
(let [before (take-while (partial not= :transaction?) data)
after (drop-while (partial not= :transaction?) data)]
(if (seq after)
[(second after) (concat before (nnext after))]
[true data])))
(defn insert!
"Given a database connection, a table name and either maps representing rows or
a list of column names followed by lists of column values, perform an insert.
Use :transaction? argument to specify whether to run in a transaction or not.
The default is true (use a transaction)."
[db table & options]
(let [[transaction? maps-or-cols-and-values-etc] (extract-transaction? options)
stmts (apply sql/insert table maps-or-cols-and-values-etc)]
(if-let [con (and (map? db) (:connection db))]
(insert-helper db transaction? stmts)
(with-open [con (get-connection db)]
(insert-helper (add-connection db con) transaction? stmts)))))
(defn update!
"Given a database connection, a table name, a map of column values to set and a
where clause of columns to match, perform an update. The optional keyword arguments
specify how column names (in the set / match maps) should be transformed (default
'as-is') and whether to run the update in a transaction (default true).
Example:
(update! db :person {:zip 94540} (where {:zip 94546}))
is equivalent to:
(execute! db [\"UPDATE person SET zip = ? WHERE zip = ?\" 94540 94546])"
[db table set-map where-clause & {:keys [entities transaction?]
:or {entities sql/as-is transaction? true}}]
(execute! db
(sql/update table set-map where-clause :entities entities)
:transaction? transaction?))
;; original API mostly rewritten in terms of new API primarily without dynamic binding
(defn ^{:doc "Returns the current database connection (or nil if there is none)"
:deprecated "0.3.0"}
find-connection
^java.sql.Connection []
(db-find-connection *db*))
(defn ^{:doc "Returns the current database connection (or throws if there is none)"
:deprecated "0.3.0"}
connection
^java.sql.Connection []
(db-connection *db*))
(defn ^{:doc "Evaluates func in the context of a new connection to a database then
closes the connection."
:deprecated "0.3.0"}
with-connection*
[db-spec func]
(with-open [^java.sql.Connection con (get-connection db-spec)]
(binding [*db* (assoc *db* :connection con :level 0 :rollback (atom false))]
(func))))
(defmacro ^{:doc "Evaluates body in the context of a new connection to a database then
closes the connection."
:deprecated "0.3.0"}
with-connection
[db-spec & body]
`(with-connection* ~db-spec (fn [] ~@body)))
(defn transaction*
^{:doc "Evaluates func as a transaction on the open database connection. Any
nested transactions are absorbed into the outermost transaction. By
default, all database updates are committed together as a group after
evaluating the outermost body, or rolled back on any uncaught
exception. If rollback is set within scope of the outermost transaction,
the entire transaction will be rolled back rather than committed when
complete."
:deprecated "0.3.0"}
[func]
(binding [*db* (update-in *db* [:level] inc)]
(if (= (:level *db*) 1)
(let [^java.sql.Connection con (get-connection *db*)
auto-commit (.getAutoCommit con)]
(io!
(.setAutoCommit con false)
(try
(let [result (func)]
(if (db-is-rollback-only *db*)
(.rollback con)
(.commit con))
result)
(catch Throwable t
(.rollback con)
(throw-non-rte t))
(finally
(db-unset-rollback-only! *db*)
(.setAutoCommit con auto-commit)))))
(try
(func)
(catch Exception e
(throw-non-rte e))))))
(defmacro
^{:doc "Evaluates body as a transaction on the open database connection. Any
nested transactions are absorbed into the outermost transaction. By
default, all database updates are committed together as a group after
evaluating the outermost body, or rolled back on any uncaught
exception. If set-rollback-only is called within scope of the outermost
transaction, the entire transaction will be rolled back rather than
committed when complete."
:deprecated "0.3.0"}
transaction
[& body]
`(transaction* (fn [] ~@body)))
(defn
^{:doc "Marks the outermost transaction such that it will rollback rather than
commit when complete"
:deprecated "0.3.0"}
set-rollback-only
[]
(db-set-rollback-only! *db*))
(defn
^{:doc "Returns true if the outermost transaction will rollback rather than
commit when complete"
:deprecated "0.3.0"}
is-rollback-only
[]
(db-is-rollback-only *db*))
(defn
^{:doc "Executes SQL commands on the open database connection."
:deprecated "0.3.0"}
do-commands
[& commands]
(apply db-do-commands *db* true commands))
(defn
^{:doc "Executes an (optionally parameterized) SQL prepared statement on the
open database connection. Each param-group is a seq of values for all of
the parameters.
Return a seq of update counts (one count for each param-group)."
:deprecated "0.3.0"}
do-prepared
[sql & param-groups]
(apply db-do-prepared *db* true sql param-groups))
(defn create-table
"Creates a table on the open database connection given a table name and
specs. Each spec is either a column spec: a vector containing a column
name and optionally a type and other constraints, or a table-level
constraint: a vector containing words that express the constraint. An
optional suffix to the CREATE TABLE DDL describing table attributes may
by provided as :table-spec {table-attributes-string}. All words used to
describe the table may be supplied as strings or keywords."
[name & specs]
(do-commands (apply create-table-ddl name specs)))
(defn drop-table
"Drops a table on the open database connection given its name, a string
or keyword"
[name]
(do-commands
(format "DROP TABLE %s" (sql/as-str identity name))))
(defn
^{:doc "Executes an (optionally parameterized) SQL prepared statement on the
open database connection. The param-group is a seq of values for all of
the parameters.
Return the generated keys for the (single) update/insert."
:deprecated "0.3.0"}
do-prepared-return-keys
[sql param-group]
(db-do-prepared-return-keys *db* true sql param-group))
(defn
^{:doc "Inserts rows into a table with values for specified columns only.
column-names is a vector of strings or keywords identifying columns. Each
value-group is a vector containing a values for each column in
order. When inserting complete rows (all columns), consider using
insert-rows instead.
If a single set of values is inserted, returns a map of the generated keys."
:deprecated "0.3.0"}
insert-values
[table column-names & value-groups]
(apply insert! *db* table column-names (concat value-groups [:entities *as-str*])))
(defn insert-rows
^{:doc "Inserts complete rows into a table. Each row is a vector of values for
each of the table's columns in order.
If a single row is inserted, returns a map of the generated keys."
:deprecated "0.3.0"}
[table & rows]
(apply insert! *db* table nil (concat rows [:entities *as-str*])))
(defn
^{:doc "Inserts records into a table. records are maps from strings or keywords
(identifying columns) to values. Inserts the records one at a time.
Returns a sequence of maps containing the generated keys for each record."
:deprecated "0.3.0"}
insert-records
[table & records]
(apply insert! *db* table (concat records [:entities *as-str*])))
(defn
^{:doc "Inserts a single record into a table. A record is a map from strings or
keywords (identifying columns) to values.
Returns a map of the generated keys."
:deprecated "0.3.0"}
insert-record
[table record]
(first (insert-records table record)))
(defn
^{:doc "Deletes rows from a table. where-params is a vector containing a string
providing the (optionally parameterized) selection criteria followed by
values for any parameters."
:deprecated "0.3.0"}
delete-rows
[table where-params]
(apply delete! *db* table where-params [:entities *as-str*]))
(defn
^{:doc "Updates values on selected rows in a table. where-params is a vector
containing a string providing the (optionally parameterized) selection
criteria followed by values for any parameters. record is a map from
strings or keywords (identifying columns) to updated values."
:deprecated "0.3.0"}
update-values
[table where-params record]
(apply update! *db* table record where-params [:entities *as-str*]))
(defn update-or-insert-values
"Updates values on selected rows in a table, or inserts a new row when no
existing row matches the selection criteria. where-params is a vector
containing a string providing the (optionally parameterized) selection
criteria followed by values for any parameters. record is a map from
strings or keywords (identifying columns) to updated values."
[table where-params record]
(transaction
(let [result (update-values table where-params record)]
(if (zero? (first result))
(insert-values table (keys record) (vals record))
result))))
(defn
^{:doc "Executes a query, then evaluates func passing in a seq of the results as
an argument. The first argument is a vector containing either:
[sql & params] - a SQL query, followed by any parameters it needs
[stmt & params] - a PreparedStatement, followed by any parameters it needs
(the PreparedStatement already contains the SQL query)
[options sql & params] - options and a SQL query for creating a
PreparedStatement, followed by any parameters it needs
See prepare-statement for supported options."
:deprecated "0.3.0"}
with-query-results*
[sql-params func]
(when-not (vector? sql-params)
(let [^Class sql-params-class (class sql-params)
^String msg (format "\"%s\" expected %s %s, found %s %s"
"sql-params"
"vector"
"[sql param*]"
(.getName sql-params-class)
(pr-str sql-params))]
(throw (IllegalArgumentException. msg))))
(let [special (first sql-params)
sql-is-first (string? special)
options-are-first (map? special)
sql (cond sql-is-first special
options-are-first (second sql-params))
params (vec (cond sql-is-first (rest sql-params)
options-are-first (rest (rest sql-params))
:else (rest sql-params)))
prepare-args (when (map? special) (flatten (seq special)))]
(with-open [^PreparedStatement stmt (if (instance? PreparedStatement special) special (apply prepare-statement (get-connection *db*) sql prepare-args))]
(set-parameters stmt params *db*)
(with-open [rset (.executeQuery stmt)]
(binding [*db* (assoc *db* :connection (.getConnection stmt))]
(func (resultset-seq rset)))))))
(defmacro
^{:doc "Executes a query, then evaluates body with results bound to a seq of the
results. sql-params is a vector containing either:
[sql & params] - a SQL query, followed by any parameters it needs
[stmt & params] - a PreparedStatement, followed by any parameters it needs
(the PreparedStatement already contains the SQL query)
[options sql & params] - options and a SQL query for creating a
PreparedStatement, followed by any parameters it needs
See prepare-statement for supported options."
:deprecated "0.3.0"}
with-query-results
[results sql-params & body]
`(with-query-results* ~sql-params (fn [~results] ~@body)))
(defn as-key
^{:doc "Given a naming strategy and a string, return the string as a
keyword per that naming strategy. Given (a naming strategy and)
a keyword, return it as-is."
:deprecated "0.3.0"}