-
Notifications
You must be signed in to change notification settings - Fork 8
/
Repository.cs
1008 lines (919 loc) · 54.6 KB
/
Repository.cs
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
using Microsoft.Data.SqlClient;
using System.Collections.Generic;
using System.Data;
using System.Linq;
using System.Threading.Tasks;
// Dapper.SimpleRepository was created by Casey Crookston. You are free to use it however you would like.
// I hope it makes your developent faster and easier.
namespace Dapper.SimpleRepository
{
/// <summary>
/// Main class for Dapper.SimpleRepository extensions. This option is not strongly typed.
/// </summary>
public class Repository : IRepositoryGeneric
{
private readonly string _connectionString;
/// <summary>
/// Inject the connection string (as a string) when creating an instance of this class.
/// </summary>
/// <param name="connectionString"></param>
public Repository(string connectionString)
{
_connectionString = connectionString;
}
private SqlConnection OpenConnection(string connectionString)
{
SqlConnection con = new SqlConnection(connectionString);
con.Open();
return con;
}
// ----------- GET Single Item Methods ----------- //
/// <summary>
/// <para>Get a specific record by the primary key (id).</para>
/// <para>Queries the table matching the type T.</para>
/// </summary>
/// <param name="id"></param>
/// <param name="commandTimeout">Optional command time out value.</param>
/// <returns>A single record of type T where the primary key matches the supplied id.</returns>
public T Get<T>(object id, int? commandTimeout = null)
{
T entity;
using (var connection = OpenConnection(_connectionString))
{
entity = connection.Get<T>(id, commandTimeout: commandTimeout);
}
return entity;
}
/// <summary>
/// <para>Get a specific record by the primary key (id).</para>
/// <para>Queries the table matching the type T.</para>
/// </summary>
/// <param name="id"></param>
/// <param name="commandTimeout">Optional command time out value.</param>
/// <returns>A single record of type T where the primary key matches the supplied id.</returns>
public async Task<T> GetAsync<T>(object id, int? commandTimeout = null)
{
T entity;
using (var connection = OpenConnection(_connectionString))
{
entity = await connection.GetAsync<T>(id, commandTimeout: commandTimeout);
}
return entity;
}
/// <summary>
/// <para>Get a specific record that matches the specified filter.</para>
/// <para>Queries the table matching the type T.</para>
/// </summary>
/// <typeparam name="T">The type that matches the database table.</typeparam>
/// <param name="where">The SQL WHERE clause.</param>
/// <param name="parms">Optional set of parameters that matches the query.</param>
/// <param name="commandTimeout">Optional command time out value.</param>
/// <returns>A single record of type T where the data matches the supplied WHERE filter.</returns>
public T Get<T>(string where, Dictionary<string, object> parms = null, int? commandTimeout = null)
{
IEnumerable<T> entities;
using (var connection = OpenConnection(_connectionString))
{
if (parms != null)
entities = connection.GetList<T>(where, new DynamicParameters(parms), commandTimeout: commandTimeout);
else
entities = connection.GetList<T>(where, commandTimeout: commandTimeout);
}
if (entities != null && entities.Any())
return entities.FirstOrDefault();
else
return default;
}
/// <summary>
/// <para>Get a specific record that matches the specified filter</para>
/// <para>Queries the table matching the type T.</para>
/// </summary>
/// <typeparam name="T">The type that matches the database table.</typeparam>
/// <param name="where">The SQL WHERE clause.</param>
/// <param name="parms">Optional set of parameters that matches the query.</param>
/// <param name="commandTimeout">Optional command time out value.</param>
/// <returns>A single record of type T where the data matches the supplied WHERE filter.</returns>
public async Task<T> GetAsync<T>(string where, Dictionary<string, object> parms = null, int? commandTimeout = null)
{
IEnumerable<T> entities;
using (var connection = OpenConnection(_connectionString))
{
if (parms != null)
entities = await connection.GetListAsync<T>(where, new DynamicParameters(parms), commandTimeout: commandTimeout);
else
entities = await connection.GetListAsync<T>(where, commandTimeout: commandTimeout);
}
if (entities != null && entities.Any())
return entities.FirstOrDefault();
else
return default;
}
/// <summary>
/// <para>Get a specific type from a query. This type could be a database model, or it could be a single string, or it could be an INT if the query is a SELECT COUNT().</para>
/// <para>Queries the table matching the type T.</para>
/// </summary>
/// <typeparam name="T">The type that matches the database table.</typeparam>
/// <param name="query"></param>
/// <param name="parms">Optional set of parameters that matches the query.</param>
/// <param name="commandTimeout">Optional command time out value.</param>
/// <returns>A single instance of type T that matches the supplied query.</returns>
public T GetFromQuery<T>(string query, Dictionary<string, object> parms = null, int? commandTimeout = null)
{
T entity;
using (var connection = OpenConnection(_connectionString))
{
if (parms != null)
entity = connection.Query<T>(query, new DynamicParameters(parms), commandTimeout: commandTimeout).FirstOrDefault();
else
entity = connection.Query<T>(query, commandTimeout: commandTimeout).FirstOrDefault();
}
return entity;
}
/// <summary>
/// <para>Get a specific type from a query. This type could be a database model, or it could be a single string, or it could be an INT if the query is a SELECT COUNT().</para>
/// <para>Queries the table matching the type T.</para>
/// </summary>
/// <typeparam name="T">The type that matches the database table.</typeparam>
/// <param name="query"></param>
/// <param name="parms">Optional set of parameters that matches the query.</param>
/// <param name="commandTimeout">Optional command time out value.</param>
/// <returns>A single instance of type T that matches the supplied query.</returns>
public async Task<T> GetFromQueryAsync<T>(string query, Dictionary<string, object> parms = null, int? commandTimeout = null)
{
IEnumerable<T> entity;
using (var connection = OpenConnection(_connectionString))
{
if (parms != null)
{
entity = await connection.QueryAsync<T>(query, new DynamicParameters(parms), commandTimeout: commandTimeout);
}
else
{
entity = await connection.QueryAsync<T>(query, commandTimeout: commandTimeout);
}
}
return entity.FirstOrDefault();
}
// ----------- GET List Methods ----------- //
/// <summary>
/// <para>Get an IEnumerable of all records.</para>
/// <para>Queries the table matching the type T.</para>
/// </summary>
/// <returns>an IEnumerable of type T.</returns>
public IEnumerable<T> GetAll<T>()
{
IEnumerable<T> entities;
using (var connection = OpenConnection(_connectionString))
{
entities = connection.GetList<T>();
}
return entities;
}
/// <summary>
/// <para>Get an IEnumerable of all records.</para>
/// <para>Queries the table matching the type T.</para>
/// </summary>
/// <returns>An IEnumerable of type T.</returns>
public async Task<IEnumerable<T>> GetAllAsync<T>()
{
IEnumerable<T> entities;
using (var connection = OpenConnection(_connectionString))
{
entities = await connection.GetListAsync<T>();
}
return entities;
}
/// <summary>
/// <para>Get an IEnumerable that matches the specified filter</para>
/// <para>Queries the table matching the type T.</para>
/// </summary>
/// <typeparam name="T">The type that matches the database table.</typeparam>
/// <param name="where">The SQL WHERE clause.</param>
/// <param name="parms">Optional set of parameters that matches the query.</param>
/// <param name="commandTimeout">Optional command time out value.</param>
/// <returns>An IEnumerable of type T where the data matches the supplied WHERE filter.</returns>
public IEnumerable<T> GetList<T>(string where, Dictionary<string, object> parms = null, int? commandTimeout = null)
{
IEnumerable<T> entities;
using (var connection = OpenConnection(_connectionString))
{
if (parms != null)
entities = connection.GetList<T>(where, new DynamicParameters(parms), commandTimeout: commandTimeout);
else
entities = connection.GetList<T>(where, commandTimeout: commandTimeout);
}
return entities;
}
/// <summary>
/// <para>Get an IEnumerable that matches the specified filter</para>
/// <para>Queries the table matching the type T.</para>
/// </summary>
/// <typeparam name="T">The type that matches the database table.</typeparam>
/// <param name="where">The SQL WHERE clause.</param>
/// <param name="parms">Optional set of parameters that matches the query.</param>
/// <param name="commandTimeout">Optional command time out value.</param>
/// <returns>An IEnumerable of type T where the data matches the supplied WHERE filter.</returns>
public async Task<IEnumerable<T>> GetListAsync<T>(string where, Dictionary<string, object> parms = null, int? commandTimeout = null)
{
IEnumerable<T> entities;
using (var connection = OpenConnection(_connectionString))
{
if (parms != null)
entities = await connection.GetListAsync<T>(where, new DynamicParameters(parms), commandTimeout: commandTimeout);
else
entities = await connection.GetListAsync<T>(where, commandTimeout: commandTimeout);
}
return entities;
}
/// <summary>
/// <para>Get an IEnumerable based on a custom query and any (optional) parameters</para>
/// <para>Queries the table matching the type T.</para>
/// </summary>
/// <typeparam name="T">The type that matches the database table.</typeparam>
/// <param name="query"></param>
/// <param name="parms">Optional set of parameters that matches the query.</param>
/// <param name="commandTimeout">Optional command time out value.</param>
/// <returns>An IEnumerable of type T that matches the supplied query.</returns>
public IEnumerable<T> GetListFromQuery<T>(string query, Dictionary<string, object> parms = null, int? commandTimeout = null)
{
IEnumerable<T> entities;
using (var connection = OpenConnection(_connectionString))
{
if (parms != null)
entities = connection.Query<T>(query, new DynamicParameters(parms), commandTimeout: commandTimeout);
else
entities = connection.Query<T>(query, commandTimeout: commandTimeout);
}
return entities;
}
/// <summary>
/// <para>Get an IEnumerable based on a custom query and any (optional) parameters</para>
/// <para>Queries the table matching the type T.</para>
/// </summary>
/// <typeparam name="T">The type that matches the database table.</typeparam>
/// <param name="query"></param>
/// <param name="parms">Optional set of parameters that matches the query.</param>
/// <param name="commandTimeout">Optional command time out value.</param>
/// <returns>An IEnumerable of type T that matches the supplied query.</returns>
public async Task<IEnumerable<T>> GetListFromQueryAsync<T>(string query, Dictionary<string, object> parms = null, int? commandTimeout = null)
{
IEnumerable<T> entities;
using (var connection = OpenConnection(_connectionString))
{
if (parms != null)
entities = await connection.QueryAsync<T>(query, new DynamicParameters(parms), commandTimeout: commandTimeout);
else
entities = await connection.QueryAsync<T>(query, commandTimeout: commandTimeout);
}
return entities;
}
/// <summary>
/// <para>Get a paged IEnumerable of all records.</para>
/// <para>Queries the table matching the type T.</para>
/// </summary>
/// <typeparam name="T">The type that matches the database table.</typeparam>
/// <param name="pageNumber">The offset (or page number) of the total set to select.</param>
/// <param name="rowsPerPage">The number of total records to return per page.</param>
/// <param name="where">Optional WHERE clause to filter the resutls.</param>
/// <param name="orderBy">Optional ORDER BY clause to order the results.</param>
/// <param name="parms">Optinal set of paramaters used in WHERE or ORDER BY clauses.</param>
/// <param name="commandTimeout">Optional command time out value.</param>
/// <returns>A paged IEnumerable of type T.</returns>
public IEnumerable<T> GetListPaged<T>(int pageNumber, int rowsPerPage, string where, string orderBy, Dictionary<string, object> parms = null, int? commandTimeout = null)
{
IEnumerable<T> entities;
using (var connection = OpenConnection(_connectionString))
{
entities = connection.GetListPaged<T>(pageNumber, rowsPerPage, where, orderBy, parms, commandTimeout: commandTimeout);
}
return entities;
}
/// <summary>
/// <para>Get a paged IEnumerable of all records.</para>
/// <para>Queries the table matching the type T.</para>
/// </summary>
/// <typeparam name="T">The type that matches the database table.</typeparam>
/// <param name="pageNumber">The offset (or page number) of the total set to select.</param>
/// <param name="rowsPerPage">The number of total records to return per page.</param>
/// <param name="where">Optional WHERE clause to filter the resutls.</param>
/// <param name="orderBy">Optional ORDER BY clause to order the results.</param>
/// <param name="parms">Optinal set of paramaters used in WHERE or ORDER BY clauses.</param>
/// <param name="commandTimeout">Optional command time out value.</param>
/// <returns>A paged IEnumerable of type T.</returns>
public async Task<IEnumerable<T>> GetListPagedAsync<T>(int pageNumber, int rowsPerPage, string where, string orderBy, Dictionary<string, object> parms = null, int? commandTimeout = null)
{
IEnumerable<T> entities;
using (var connection = OpenConnection(_connectionString))
{
entities = await connection.GetListPagedAsync<T>(pageNumber, rowsPerPage, where, orderBy, parms, commandTimeout: commandTimeout);
}
return entities;
}
// ----------- UPDATE Methods ----------- //
/// <summary>
/// <para>Update an existing record.</para>
/// <para>Queries the table matching the type T.</para>
/// </summary>
/// <param name="entity">An instance of type T to be updated.</param>
/// <param name="commandTimeout">Optional command time out value.</param>
/// <returns>Number of rows affected.</returns>
public int Update<T>(T entity, int? commandTimeout = null)
{
using (var connection = OpenConnection(_connectionString))
{
return connection.Update(entity, commandTimeout: commandTimeout);
}
}
/// <summary>
/// <para>Update an existing record.</para>
/// <para>Queries the table matching the type T.</para>
/// </summary>
/// <param name="entity">An instance of type T to be updated.</param>
/// <param name="commandTimeout"></param>
/// <returns>Number of rows affected.</returns>
public async Task<int> UpdateAsync<T>(T entity, int? commandTimeout = null)
{
int records;
using (var connection = OpenConnection(_connectionString))
{
records = await connection.UpdateAsync(entity, commandTimeout: commandTimeout);
}
return records;
}
// ----------- INSERT Methods ----------- //
/// <summary>
/// <para>Insert a new record.</para>
/// <para>Inserts into the table matching the type T.</para>
/// </summary>
/// <param name="entity">An instance of type T to be updated.</param>
/// <param name="commandTimeout">Optional command time out value.</param>
/// <returns>The ID (primary key) of the newly inserted record.</returns>
public int? Insert<T>(T entity, int? commandTimeout = null)
{
int? newId;
using (var connection = OpenConnection(_connectionString))
{
newId = connection.Insert<T>(entity, commandTimeout: commandTimeout);
}
return newId;
}
/// <summary>
/// <para>Insert a new record.</para>
/// <para>Inserts into the table matching the type T.</para>
/// <para>Allows the PK Type to be defined.</para>
/// </summary>
/// <typeparam name="TKey"></typeparam>
/// <typeparam name="T"></typeparam>
/// <param name="entity"></param>
/// <param name="commandTimeout"></param>
/// <returns></returns>
public TKey Insert<TKey, T>(T entity, int? commandTimeout = null)
{
using (var connection = OpenConnection(_connectionString))
{
var result = connection.Insert<TKey, T>(entity, commandTimeout: commandTimeout);
return result;
}
}
/// <summary>
/// <para>Insert a new record.</para>
/// <para>Inserts into the table matching the type T.</para>
/// </summary>
/// <param name="entity">An instance of type T to be updated.</param>
/// <param name="commandTimeout">Optional command time out value.</param>
/// <returns>The ID (primary key) of the newly inserted record.</returns>
public async Task<int?> InsertAsync<T>(T entity, int? commandTimeout = null)
{
int? newId;
using (var connection = OpenConnection(_connectionString))
{
newId = await connection.InsertAsync<T>(entity, commandTimeout: commandTimeout);
}
return newId;
}
/// <summary>
/// <para>Insert a new record.</para>
/// <para>Inserts into the table matching the type T.</para>
/// <para>Allows the PK Type to be defined.</para>
/// </summary>
/// <typeparam name="TKey"></typeparam>
/// <typeparam name="T"></typeparam>
/// <param name="entity"></param>
/// <param name="commandTimeout"></param>
/// <returns></returns>
public async Task<TKey> InsertAsync<TKey, T>(T entity, int? commandTimeout = null)
{
using (var connection = OpenConnection(_connectionString))
{
var result = await connection.InsertAsync<TKey, T>(entity, commandTimeout: commandTimeout);
return result;
}
}
// ----------- DELETE Methods ----------- //
/// <summary>
/// <para>Delete a record by primary key (id).</para>
/// <para>Deletes from the table matching the type T.</para>
/// </summary>
/// <param name="id">The ID (primary key) of the item to be deleted.</param>
/// <param name="commandTimeout">Optional command time out value.</param>
/// <returns>Number of rows affected.</returns>
public int Delete<T>(object id, int? commandTimeout = null)
{
using (var connection = OpenConnection(_connectionString))
{
return connection.Delete<T>(id, commandTimeout: commandTimeout);
}
}
/// <summary>
/// <para>Delete a record by primary key (id).</para>
/// <para>Deletes from the table matching the type T.</para>
/// </summary>
/// <param name="id">The ID (primary key) of the item to be deleted.</param>
/// <param name="commandTimeout">Optional command time out value.</param>
/// <returns>Number of rows affected.</returns>
public async Task<int> DeleteAsync<T>(object id, int? commandTimeout = null)
{
using (var connection = OpenConnection(_connectionString))
{
return await connection.DeleteAsync<T>(id, commandTimeout: commandTimeout);
}
}
/// <summary>
/// <para>Delete all records that match the specified filter.</para>
/// <para>Deletes from the table matching the type T.</para>
/// </summary>
/// <param name="where">Optional WHERE clause.</param>
/// <param name="parms">Optional set of parameters that matches the WHERE clause.</param>
/// <param name="commandTimeout">Optional command time out value.</param>
/// <returns>Number of rows affected.</returns>
public int Delete<T>(string where, Dictionary<string, object> parms = null, int? commandTimeout = null)
{
using (var connection = OpenConnection(_connectionString))
{
return connection.DeleteList<T>(where, new DynamicParameters(parms), commandTimeout: commandTimeout);
}
}
/// <summary>
/// <para>Delete all records that match the specified filter.</para>
/// <para>Deletes from the table matching the type T.</para>
/// </summary>
/// <param name="where">Optional WHERE clause.</param>
/// <param name="parms">Optional set of parameters that matches the WHERE clause.</param>
/// <param name="commandTimeout">Optional command time out value.</param>
/// <returns>Number of rows affected.</returns>
public async Task<int> DeleteAsync<T>(string where, Dictionary<string, object> parms = null, int? commandTimeout = null)
{
using (var connection = OpenConnection(_connectionString))
{
return await connection.DeleteListAsync<T>(where, new DynamicParameters(parms), commandTimeout: commandTimeout);
}
}
// ----------- EXECUTE QUERY Method ----------- //
/// <summary>
/// <para>Execute any custom query where a return data set it not expected.</para>
/// <para>Queries the table matching the type T.</para>
/// </summary>
/// <typeparam name="T">The type that matches the database table.</typeparam>
/// <param name="query">Full SQL query.</param>
/// <param name="parms">Optional set of parameters that matches the query.</param>
/// <param name="commandTimeout">Optional command time out value.</param>
public void ExecuteQuery<T>(string query, Dictionary<string, object> parms = null, int? commandTimeout = null)
{
using (var connection = OpenConnection(_connectionString))
{
connection.Query<T>(query, param: parms, commandTimeout: commandTimeout);
}
}
/// <summary>
/// <para>Execute any custom query where a return data set it not expected.</para>
/// <para>Queries the table matching the type T.</para>
/// </summary>
/// <typeparam name="T">The type that matches the database table.</typeparam>
/// <param name="query">Full SQL query.</param>
/// <param name="parms">Optional set of parameters that matches the query.</param>
/// <param name="commandTimeout">Optional command time out value.</param>
public async Task ExecuteQueryAsync<T>(string query, Dictionary<string, object> parms = null, int? commandTimeout = null)
{
using (var connection = OpenConnection(_connectionString))
{
await connection.ExecuteAsync(query, param: parms, commandTimeout: commandTimeout);
}
}
/// <summary>
/// <para>Execute any custom query where a single return item is expected. This type could be a database model, or it could be a single string, or it could be an INT if the query is a SELECT COUNT().</para>
/// <para>Queries the table matching the type T.</para>
/// </summary>
/// <param name="query">Full SQL query.</param>
/// <param name="parms">Optional set of parameters that matches the query.</param>
/// <param name="commandTimeout">Optional command time out value.</param>
/// <returns>A single instance of type T that matches the supplied query.</returns>
public T ExecuteScalar<T>(string query, Dictionary<string, object> parms = null, int? commandTimeout = null)
{
using (var connection = OpenConnection(_connectionString))
{
return connection.ExecuteScalar<T>(query, param: parms, commandTimeout: commandTimeout);
}
}
/// <summary>
/// <para>Execute any custom query where a single return item is expected. This type could be a database model, or it could be a single string, or it could be an INT if the query is a SELECT COUNT().</para>
/// <para>Queries the table matching the type T.</para>
/// </summary>
/// <param name="query">Full SQL query.</param>
/// <param name="parms">Optional set of parameters that matches the query.</param>
/// <param name="commandTimeout">Optional command time out value.</param>
/// <returns>A single instance of type T that matches the supplied query.</returns>
public async Task<T> ExecuteScalarAsync<T>(string query, Dictionary<string, object> parms = null, int? commandTimeout = null)
{
using (var connection = OpenConnection(_connectionString))
{
return await connection.ExecuteScalarAsync<T>(query, param: parms, commandTimeout: commandTimeout);
}
}
// ----------- STORED PROCEDURE Methods ----------- //
/// <summary>
/// <para>Execute any Stored Procedure where a return data set it not expected.</para>
/// </summary>
/// <param name="storedProcedureName">Name of the stored procedure to be executed.</param>
/// <param name="parms">Optional set of parameters that matches the query.</param>
/// <param name="commandTimeout">Optional command time out value.</param>
public void ExecuteSP(string storedProcedureName, Dictionary<string, object> parms = null, int? commandTimeout = null)
{
using (var connection = OpenConnection(_connectionString))
{
connection.Execute(storedProcedureName, parms, commandType: CommandType.StoredProcedure, commandTimeout: commandTimeout);
}
}
/// <summary>
/// <para>Execute any Stored Procedure where a return data set it not expected.</para>
/// </summary>
/// <param name="storedProcedureName">Name of the stored procedure to be executed.</param>
/// <param name="parms">Optional set of parameters that matches the query.</param>
/// <param name="commandTimeout">Optional command time out value.</param>
public async Task ExecuteSPAsync(string storedProcedureName, Dictionary<string, object> parms = null, int? commandTimeout = null)
{
using (var connection = OpenConnection(_connectionString))
{
await connection.ExecuteAsync(storedProcedureName, parms, commandType: CommandType.StoredProcedure, commandTimeout: commandTimeout);
}
}
/// <summary>
/// <para>Execute any Stored Procedure where a single item is expected as a return.</para>
/// </summary>
/// <typeparam name="T">The type that matches the database table.</typeparam>
/// <param name="storedProcedureName">Name of the stored procedure to be executed.</param>
/// <param name="parms">Optional set of parameters that matches the query.</param>
/// <param name="commandTimeout">Optional command time out value.</param>
/// <returns>A single instance of type T.</returns>
public T ExecuteSPSingle<T>(string storedProcedureName, Dictionary<string, object> parms = null, int? commandTimeout = null)
{
IEnumerable<T> entities;
using (var connection = OpenConnection(_connectionString))
{
entities = connection.Query<T>(storedProcedureName, parms, commandType: CommandType.StoredProcedure, commandTimeout: commandTimeout);
}
if (entities != null && entities.Any())
return entities.FirstOrDefault();
else
return default;
}
/// <summary>
/// <para>Execute any Stored Procedure where a single item is expected as a return.</para>
/// </summary>
/// <typeparam name="T">The type that matches the database table.</typeparam>
/// <param name="storedProcedureName">Name of the stored procedure to be executed.</param>
/// <param name="parms">Optional set of parameters that matches the query.</param>
/// <param name="commandTimeout">Optional command time out value.</param>
/// <returns>A single instance of type T.</returns>
public async Task<T> ExecuteSPSingleAsync<T>(string storedProcedureName, Dictionary<string, object> parms = null, int? commandTimeout = null)
{
IEnumerable<T> entities;
using (var connection = OpenConnection(_connectionString))
{
entities = await connection.QueryAsync<T>(storedProcedureName, parms, commandType: CommandType.StoredProcedure, commandTimeout: commandTimeout);
}
if (entities != null && entities.Any())
return entities.FirstOrDefault();
else
return default;
}
/// <summary>
/// <para>Execute a Store Procedure when a List of T is expected in return.</para>
/// </summary>
/// <typeparam name="T">The type that matches the database table.</typeparam>
/// <param name="storedProcedureName">Name of the stored procedure to be executed.</param>
/// <param name="parms">Optional set of parameters that matches the query.</param>
/// <param name="commandTimeout">Optional command time out value.</param>
/// <returns>An IEnumerable of type T.</returns>
public IEnumerable<T> ExecuteSPList<T>(string storedProcedureName, Dictionary<string, object> parms = null, int? commandTimeout = null)
{
using (var connection = OpenConnection(_connectionString))
{
if (commandTimeout == null) commandTimeout = 60;
IEnumerable<T> output = connection.Query<T>(storedProcedureName, param: parms, commandType: CommandType.StoredProcedure, commandTimeout: commandTimeout);
return output;
}
}
/// <summary>
/// <para>Execute a Store Procedure when a List of T is expected in return.</para>
/// </summary>
/// <typeparam name="T">The type that matches the database table.</typeparam>
/// <param name="storedProcedureName">Name of the stored procedure to be executed.</param>
/// <param name="parms">Optional set of parameters that matches the query.</param>
/// <param name="commandTimeout">Optional command time out value.</param>
/// <returns>An IEnumerable of type T.</returns>
public async Task<IEnumerable<T>> ExecuteSPListAsync<T>(string storedProcedureName, Dictionary<string, object> parms = null, int? commandTimeout = null)
{
using (var connection = OpenConnection(_connectionString))
{
if (commandTimeout == null) commandTimeout = 60;
var output = await connection.QueryAsync<T>(storedProcedureName, param: parms, commandType: CommandType.StoredProcedure, commandTimeout: commandTimeout);
return output;
}
}
}
/// <summary>
/// Main class for Dapper.SimpleRepository extensions. This option is strongly typed.
/// </summary>
/// <typeparam name="T">The type that matches the database table.</typeparam>
public class Repository<T> : IRepositoryStrong<T>
{
private readonly Repository _base;
/// <summary>
/// Inject the connection string (as a string) when creating an instance of this class.
/// </summary>
/// <param name="connectionString"></param>
public Repository(string connectionString)
{
_base = new Repository(connectionString);
}
// ----------- GET Single Item Methods ----------- //
/// <summary>
/// <para>Get a specific record by the primary key (id).</para>
/// </summary>
/// <param name="id"></param>
/// <param name="commandTimeout">Optional command time out value.</param>
/// <returns>A single record of type T where the primary key matches the supplied id.</returns>
public T Get(object id, int? commandTimeout = null) => _base.Get<T>(id, commandTimeout: commandTimeout);
/// <summary>
/// <para>Get a specific record by the primary key (id).</para>
/// </summary>
/// <param name="id"></param>
/// <param name="commandTimeout">Optional command time out value.</param>
/// <returns>A single record of type T where the primary key matches the supplied id.</returns>
public async Task<T> GetAsync(object id, int? commandTimeout = null) => await _base.GetAsync<T>(id, commandTimeout: commandTimeout);
/// <summary>
/// <para>Get a specific record that matches the specified filter.</para>
/// </summary>
/// <param name="where">The SQL WHERE clause.</param>
/// <param name="parms">Optional set of parameters that matches the query.</param>
/// <param name="commandTimeout">Optional command time out value.</param>
/// <returns>A single record of type T where the data matches the supplied WHERE filter.</returns>
public T Get(string where, Dictionary<string, object> parms = null, int? commandTimeout = null) => _base.Get<T>(where, parms, commandTimeout: commandTimeout);
/// <summary>
/// <para>Get a specific record that matches the specified filter.</para>
/// </summary>
/// <param name="where">The SQL WHERE clause.</param>
/// <param name="parms">Optional set of parameters that matches the query.</param>
/// <param name="commandTimeout">Optional command time out value.</param>
/// <returns>A single record of type T where the data matches the supplied WHERE filter.</returns>
public async Task<T> GetAsync(string where, Dictionary<string, object> parms = null, int? commandTimeout = null) => await _base.GetAsync<T>(where, parms, commandTimeout: commandTimeout);
/// <summary>
/// <para>Get a specific type from a query. This type could be a database model, or it could be a single string, or it could be an INT if the query is a SELECT COUNT().</para>
/// </summary>
/// <param name="query"></param>
/// <param name="parms">Optional set of parameters that matches the query.</param>
/// <param name="commandTimeout">Optional command time out value.</param>
/// <returns>A single instance of type T that matches the supplied query.</returns>
public T GetFromQuery(string query, Dictionary<string, object> parms = null, int? commandTimeout = null) => _base.GetFromQuery<T>(query, parms, commandTimeout: commandTimeout);
/// <summary>
/// <para>Get a specific type from a query. This type could be a database model, or it could be a single string, or it could be an INT if the query is a SELECT COUNT().</para>
/// </summary>
/// <param name="query"></param>
/// <param name="parms">Optional set of parameters that matches the query.</param>
/// <param name="commandTimeout">Optional command time out value.</param>
/// <returns>A single instance of type T that matches the supplied query.</returns>
public async Task<T> GetFromQueryAsync(string query, Dictionary<string, object> parms = null, int? commandTimeout = null) => await _base.GetFromQueryAsync<T>(query, parms, commandTimeout: commandTimeout);
// ----------- GET List Methods ----------- //
/// <summary>
/// <para>Get an IEnumerable of all records.</para>
/// </summary>
/// <returns>an IEnumerable of type T.</returns>
public IEnumerable<T> GetAll() => _base.GetAll<T>();
/// <summary>
/// <para>Get an IEnumerable of all records.</para>
/// </summary>
/// <returns>an IEnumerable of type T.</returns>
public async Task<IEnumerable<T>> GetAllAsync() => await _base.GetAllAsync<T>();
/// <summary>
/// <para>Get an IEnumerable that matches the specified filter</para>
/// </summary>
/// <param name="where">The SQL WHERE clause.</param>
/// <param name="parms">Optional set of parameters that matches the query.</param>
/// <param name="commandTimeout">Optional command time out value.</param>
/// <returns>An IEnumerable of type T where the data matches the supplied WHERE filter.</returns>
public IEnumerable<T> GetList(string where, Dictionary<string, object> parms = null, int? commandTimeout = null) => _base.GetList<T>(where, parms, commandTimeout: commandTimeout);
/// <summary>
/// <para>Get an IEnumerable that matches the specified filter</para>
/// </summary>
/// <param name="where">The SQL WHERE clause.</param>
/// <param name="parms">Optional set of parameters that matches the query.</param>
/// <param name="commandTimeout">Optional command time out value.</param>
/// <returns>An IEnumerable of type T where the data matches the supplied WHERE filter.</returns>
public async Task<IEnumerable<T>> GetListAsync(string where, Dictionary<string, object> parms = null, int? commandTimeout = null) => await _base.GetListAsync<T>(where, parms, commandTimeout: commandTimeout);
/// <summary>
/// <para>Get an IEnumerable based on a custom query and any (optional) parameters</para>
/// </summary>
/// <param name="query"></param>
/// <param name="parms">Optional set of parameters that matches the query.</param>
/// <param name="commandTimeout">Optional command time out value.</param>
/// <returns>An IEnumerable of type T that matches the supplied query.</returns>
public IEnumerable<T> GetListFromQuery(string query, Dictionary<string, object> parms = null, int? commandTimeout = null) => _base.GetListFromQuery<T>(query, parms, commandTimeout: commandTimeout);
/// <summary>
/// <para>Get an IEnumerable based on a custom query and any (optional) parameters</para>
/// </summary>
/// <param name="query"></param>
/// <param name="parms">Optional set of parameters that matches the query.</param>
/// <param name="commandTimeout">Optional command time out value.</param>
/// <returns>An IEnumerable of type T that matches the supplied query.</returns>
public async Task<IEnumerable<T>> GetListFromQueryAsync(string query, Dictionary<string, object> parms = null, int? commandTimeout = null) => await _base.GetListFromQueryAsync<T>(query, parms, commandTimeout: commandTimeout);
/// <summary>
/// <para>Get a paged IEnumerable of all records.</para>
/// </summary>
/// <param name="pageNumber">The offset (or page number) of the total set to select.</param>
/// <param name="rowsPerPage">The number of total records to return per page.</param>
/// <param name="where">Optional WHERE clause to filter the resutls.</param>
/// <param name="orderBy">Optional ORDER BY clause to order the results.</param>
/// <param name="parms">Optinal set of paramaters used in WHERE or ORDER BY clauses.</param>
/// <param name="commandTimeout">Optional command time out value.</param>
/// <returns>A paged IEnumerable of type T.</returns>
public IEnumerable<T> GetListPaged(int pageNumber, int rowsPerPage, string where, string orderBy, Dictionary<string, object> parms = null, int? commandTimeout = null) => _base.GetListPaged<T>(pageNumber, rowsPerPage, where, orderBy, parms, commandTimeout: commandTimeout);
/// <summary>
/// <para>Get a paged IEnumerable of all records.</para>
/// </summary>
/// <param name="pageNumber">The offset (or page number) of the total set to select.</param>
/// <param name="rowsPerPage">The number of total records to return per page.</param>
/// <param name="where">Optional WHERE clause to filter the resutls.</param>
/// <param name="orderBy">Optional ORDER BY clause to order the results.</param>
/// <param name="parms">Optinal set of paramaters used in WHERE or ORDER BY clauses.</param>
/// <param name="commandTimeout">Optional command time out value.</param>
/// <returns>A paged IEnumerable of type T.</returns>
public async Task<IEnumerable<T>> GetListPagedAsync(int pageNumber, int rowsPerPage, string where, string orderBy, Dictionary<string, object> parms = null, int? commandTimeout = null) => await _base.GetListPagedAsync<T>(pageNumber, rowsPerPage, where, orderBy, parms, commandTimeout: commandTimeout);
// ----------- UPDATE Methods ----------- //
/// <summary>
/// <para>Update an existing record.</para>
/// </summary>
/// <param name="entity">An instance of type T to be updated.</param>
/// <param name="commandTimeout">Optional command time out value.</param>
/// <returns>Number of rows affected.</returns>
public int Update(T entity, int? commandTimeout = null) => _base.Update<T>(entity, commandTimeout: commandTimeout);
/// <summary>
/// <para>Update an existing record.</para>
/// </summary>
/// <param name="entity">An instance of type T to be updated.</param>
/// <param name="commandTimeout">Optional command time out value.</param>
/// <returns>Number of rows affected.</returns>
public async Task<int> UpdateAsync(T entity, int? commandTimeout = null) => await _base.UpdateAsync<T>(entity, commandTimeout: commandTimeout);
// ----------- INSERT Methods ----------- //
/// <summary>
/// <para>Insert a new record.</para>
/// </summary>
/// <param name="entity">An instance of type T to be updated.</param>
/// <param name="commandTimeout">Optional command time out value.</param>
/// <returns>The ID (primary key) of the newly inserted record.</returns>
public int? Insert(T entity, int? commandTimeout = null) => _base.Insert<T>(entity, commandTimeout: commandTimeout);
/// <summary>
/// <para>Insert a new record.</para>
/// <para>Allows the PK Type to be defined.</para>
/// </summary>
/// <typeparam name="TKey"></typeparam>
/// <param name="entity"></param>
/// <param name="commandTimeout"></param>
/// <returns></returns>
public TKey Insert<TKey>(T entity, int? commandTimeout = null) => _base.Insert<TKey, T>(entity, commandTimeout: commandTimeout);
/// <summary>
/// <para>Insert a new record.</para>
/// </summary>
/// <param name="entity">An instance of type T to be updated.</param>
/// <param name="commandTimeout">Optional command time out value.</param>
/// <returns>The ID (primary key) of the newly inserted record.</returns>
public async Task<int?> InsertAsync(T entity, int? commandTimeout = null) => await _base.InsertAsync<T>(entity, commandTimeout: commandTimeout);
/// <summary>
/// <para>Insert a new record.</para>
/// <para>Allows the PK Type to be defined.</para>
/// </summary>
/// <typeparam name="TKey"></typeparam>
/// <param name="entity"></param>
/// <param name="commandTimeout"></param>
/// <returns></returns>
public async Task<TKey> InsertAsync<TKey>(T entity, int? commandTimeout = null) => await _base.InsertAsync<TKey, T>(entity, commandTimeout: commandTimeout);
// ----------- DELETE Methods ----------- //
/// <summary>
/// <para>Delete a record by primary key (id)..</para>
/// </summary>
/// <param name="id">The ID (primary key) of the item to be deleted.</param>
/// <param name="commandTimeout">Optional command time out value.</param>
/// <returns>Number of rows affected.</returns>
public int Delete(object id, int? commandTimeout = null) => _base.Delete<T>(id, commandTimeout: commandTimeout);
/// <summary>
/// <para>Delete a record by primary key (id)..</para>
/// </summary>
/// <param name="id">The ID (primary key) of the item to be deleted.</param>
/// <param name="commandTimeout">Optional command time out value.</param>
/// <returns>Number of rows affected.</returns>
public async Task<int> DeleteAsync(object id, int? commandTimeout = null) => await _base.DeleteAsync<T>(id, commandTimeout: commandTimeout);
/// <summary>
/// <para>Delete all records that match the specified filter.</para>
/// </summary>
/// <param name="where">Optional WHERE clause.</param>
/// <param name="parms">Optional set of parameters that matches the WHERE clause.</param>
/// <param name="commandTimeout">Optional command time out value.</param>
/// <returns>Number of rows affected.</returns>
public int Delete(string where, Dictionary<string, object> parms = null, int? commandTimeout = null) => _base.Delete<T>(where, parms, commandTimeout: commandTimeout);
/// <summary>
/// <para>Delete all records that match the specified filter.</para>
/// </summary>
/// <param name="where">Optional WHERE clause.</param>
/// <param name="parms">Optional set of parameters that matches the WHERE clause.</param>
/// <param name="commandTimeout">Optional command time out value.</param>
/// <returns>Number of rows affected.</returns>
public async Task<int> DeleteAsync(string where, Dictionary<string, object> parms = null, int? commandTimeout = null) => await _base.DeleteAsync<T>(where, parms, commandTimeout: commandTimeout);
// ----------- EXECUTE QUERY Methods ----------- //
/// <summary>
/// <para>Execute any custom query where a return data set it not expected.</para>
/// </summary>
/// <param name="query">Full SQL query.</param>
/// <param name="parms">Optional set of parameters that matches the query.</param>
/// <param name="commandTimeout">Optional command time out value.</param>
public void ExecuteQuery(string query, Dictionary<string, object> parms = null, int? commandTimeout = null) => _base.ExecuteQuery<T>(query, parms, commandTimeout: commandTimeout);
/// <summary>
/// <para>Execute any custom query where a return data set it not expected.</para>
/// </summary>
/// <param name="query">Full SQL query.</param>
/// <param name="parms">Optional set of parameters that matches the query.</param>
/// <param name="commandTimeout">Optional command time out value.</param>
public async Task ExecuteQueryAsync(string query, Dictionary<string, object> parms = null, int? commandTimeout = null) => await _base.ExecuteQueryAsync<T>(query, parms, commandTimeout: commandTimeout);
/// <summary>
/// <para>Execute any custom query where a single return item is expected. This type could be a database model, or it could be a single string, or it could be an INT if the query is a SELECT COUNT().</para>
/// </summary>
/// <param name="query">Full SQL query.</param>
/// <param name="parms">Optional set of parameters that matches the query.</param>
/// <param name="commandTimeout">Optional command time out value.</param>
/// <returns>A single instance of type T that matches the supplied query.</returns>
public T ExecuteScalar(string query, Dictionary<string, object> parms = null, int? commandTimeout = null) => _base.ExecuteScalar<T>(query, parms, commandTimeout: commandTimeout);
/// <summary>
/// <para>Execute any custom query where a single return item is expected. This type could be a database model, or it could be a single string, or it could be an INT if the query is a SELECT COUNT().</para>
/// </summary>
/// <param name="query">Full SQL query.</param>
/// <param name="parms">Optional set of parameters that matches the query.</param>
/// <param name="commandTimeout">Optional command time out value.</param>
/// <returns>A single instance of type T that matches the supplied query.</returns>
public async Task<T> ExecuteScalarAsync(string query, Dictionary<string, object> parms = null, int? commandTimeout = null) => await _base.ExecuteScalarAsync<T>(query, parms, commandTimeout: commandTimeout);
// ----------- STORED PROCEDURE Methods ----------- //
/// <summary>
/// <para>Execute any Stored Procedure where a return data set it not expected.</para>
/// </summary>
/// <param name="storedProcedureName">Name of the stored procedure to be executed.</param>
/// <param name="parms">Optional set of parameters that matches the query.</param>
/// <param name="commandTimeout">Optional command time out value.</param>
public void ExecuteSP(string storedProcedureName, Dictionary<string, object> parms = null, int? commandTimeout = null) => _base.ExecuteSP(storedProcedureName, parms, commandTimeout: commandTimeout);
/// <summary>
/// <para>Execute any Stored Procedure where a return data set it not expected.</para>
/// </summary>
/// <param name="storedProcedureName">Name of the stored procedure to be executed.</param>
/// <param name="parms">Optional set of parameters that matches the query.</param>
/// <param name="commandTimeout">Optional command time out value.</param>
public async Task ExecuteSPAsync(string storedProcedureName, Dictionary<string, object> parms = null, int? commandTimeout = null) => await _base.ExecuteSPAsync(storedProcedureName, parms, commandTimeout: commandTimeout);
/// <summary>
/// <para>Execute any Stored Procedure where a single item is expected as a return.</para>
/// </summary>
/// <param name="storedProcedureName">Name of the stored procedure to be executed.</param>
/// <param name="parms">Optional set of parameters that matches the query.</param>
/// <param name="commandTimeout">Optional command time out value.</param>
/// <returns>A single instance of type T.</returns>
public T ExecuteSPSingle(string storedProcedureName, Dictionary<string, object> parms = null, int? commandTimeout = null) => _base.ExecuteSPSingle<T>(storedProcedureName, parms, commandTimeout: commandTimeout);
/// <summary>
/// <para>Execute any Stored Procedure where a single item is expected as a return.</para>
/// </summary>
/// <param name="storedProcedureName">Name of the stored procedure to be executed.</param>
/// <param name="parms">Optional set of parameters that matches the query.</param>
/// <param name="commandTimeout">Optional command time out value.</param>
/// <returns>A single instance of type T.</returns>
public async Task<T> ExecuteSPSingleAsync(string storedProcedureName, Dictionary<string, object> parms = null, int? commandTimeout = null) => await _base.ExecuteSPSingleAsync<T>(storedProcedureName, parms, commandTimeout: commandTimeout);
/// <summary>
/// <para>Execute a Store Procedure when a List of T is expected in return.</para>
/// </summary>
/// <param name="storedProcedureName">Name of the stored procedure to be executed.</param>
/// <param name="parms">Optional set of parameters that matches the query.</param>
/// <param name="commandTimeout">Optional command time out value.</param>
/// <returns>An IEnumerable of type T.</returns>
public IEnumerable<T> ExecuteSPList(string storedProcedureName, Dictionary<string, object> parms = null, int? commandTimeout = null) => _base.ExecuteSPList<T>(storedProcedureName, parms, commandTimeout: commandTimeout);
/// <summary>
/// <para>Execute a Store Procedure when a List of T is expected in return.</para>