Skip to content
This repository was archived by the owner on Dec 24, 2022. It is now read-only.

Commit 8126fc6

Browse files
mythzmythz
committed
Deprecate API's which will move to ServiceStack.OrmLite.Legacy in future
1 parent 01c0b40 commit 8126fc6

File tree

7 files changed

+46
-0
lines changed

7 files changed

+46
-0
lines changed

‎src/ServiceStack.OrmLite/OrmLiteReadApi.cs

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,7 @@ public static List<T> Select<T>(this IDbConnection dbConn, string sql, Dictionar
6161
/// <para>db.SelectFmt&lt;Person&gt;("Age &gt; {0}", 40)</para>
6262
/// <para>db.SelectFmt&lt;Person&gt;("SELECT * FROM Person WHERE Age &gt; {0}", 40)</para>
6363
/// </summary>
64+
[Obsolete(Messages.LegacyApi)]
6465
public static List<T> SelectFmt<T>(this IDbConnection dbConn, string sqlFormat, params object[] filterParams)
6566
{
6667
return dbConn.Exec(dbCmd => dbCmd.SelectFmt<T>(sqlFormat, filterParams));
@@ -80,6 +81,7 @@ public static List<TModel> Select<TModel>(this IDbConnection dbConn, Type fromTa
8081
/// Returns a partial subset of results from the specified tableType using a SqlFormat query. E.g:
8182
/// <para>db.SelectFmt&lt;EntityWithId&gt;(typeof(Person), "Age &gt; {0}", 40)</para>
8283
/// </summary>
84+
[Obsolete(Messages.LegacyApi)]
8385
public static List<TModel> SelectFmt<TModel>(this IDbConnection dbConn, Type fromTableType, string sqlFormat, params object[] filterParams)
8486
{
8587
return dbConn.Exec(dbCmd => dbCmd.SelectFmt<TModel>(fromTableType, sqlFormat, filterParams));
@@ -206,6 +208,7 @@ public static T Single<T>(this IDbConnection dbConn, string sql, object anonType
206208
/// Returns the first result using a SqlFormat query. E.g:
207209
/// <para>db.SingleFmt&lt;Person&gt;("Age = {0}", 42)</para>
208210
/// </summary>
211+
[Obsolete(Messages.LegacyApi)]
209212
public static T SingleFmt<T>(this IDbConnection dbConn, string sqlFormat, params object[] filterParams)
210213
{
211214
return dbConn.Exec(dbCmd => dbCmd.SingleFmt<T>(sqlFormat, filterParams));
@@ -260,6 +263,7 @@ public static T Scalar<T>(this IDbConnection dbConn, string sql, object anonType
260263
/// Returns a single scalar value using an SqlFormat query. E.g:
261264
/// <para>db.ScalarFmt&lt;int&gt;("SELECT COUNT(*) FROM Person WHERE Age &gt; {0}", 40)</para>
262265
/// </summary>
266+
[Obsolete(Messages.LegacyApi)]
263267
public static T ScalarFmt<T>(this IDbConnection dbConn, string sqlFormat, params object[] sqlParams)
264268
{
265269
return dbConn.Exec(dbCmd => dbCmd.ScalarFmt<T>(sqlFormat, sqlParams));
@@ -323,6 +327,7 @@ public static List<T> Column<T>(this IDbConnection dbConn, string sql, object an
323327
/// Returns the first column in a List using a SqlFormat query. E.g:
324328
/// <para>db.ColumnFmt&lt;string&gt;("SELECT LastName FROM Person WHERE Age = {0}", 27)</para>
325329
/// </summary>
330+
[Obsolete(Messages.LegacyApi)]
326331
public static List<T> ColumnFmt<T>(this IDbConnection dbConn, string sqlFormat, params object[] sqlParams)
327332
{
328333
return dbConn.Exec(dbCmd => dbCmd.ColumnFmt<T>(sqlFormat, sqlParams));
@@ -359,6 +364,7 @@ public static HashSet<T> ColumnDistinct<T>(this IDbConnection dbConn, string sql
359364
/// Returns the distinct first column values in a HashSet using an SqlFormat query. E.g:
360365
/// <para>db.ColumnDistinctFmt&lt;int&gt;("SELECT Age FROM Person WHERE Age &lt; {0}", 50)</para>
361366
/// </summary>
367+
[Obsolete(Messages.LegacyApi)]
362368
public static HashSet<T> ColumnDistinctFmt<T>(this IDbConnection dbConn, string sqlFormat, params object[] sqlParams)
363369
{
364370
return dbConn.Exec(dbCmd => dbCmd.ColumnDistinctFmt<T>(sqlFormat, sqlParams));
@@ -395,6 +401,7 @@ public static Dictionary<K, List<V>> Lookup<K, V>(this IDbConnection dbConn, str
395401
/// Returns an Dictionary&lt;K, List&lt;V&gt;&gt; grouping made from the first two columns using an SqlFormat query. E.g:
396402
/// <para>db.LookupFmt&lt;int, string&gt;("SELECT Age, LastName FROM Person WHERE Age &lt; {0}", 50)</para>
397403
/// </summary>
404+
[Obsolete(Messages.LegacyApi)]
398405
public static Dictionary<K, List<V>> LookupFmt<K, V>(this IDbConnection dbConn, string sqlFormat, params object[] sqlParams)
399406
{
400407
return dbConn.Exec(dbCmd => dbCmd.LookupFmt<K, V>(sqlFormat, sqlParams));
@@ -482,6 +489,7 @@ public static bool Exists<T>(this IDbConnection dbConn, string sql, object anonT
482489
/// <para>db.ExistsFmt&lt;Person&gt;("Age = {0}", 42)</para>
483490
/// <para>db.ExistsFmt&lt;Person&gt;("SELECT * FROM Person WHERE Age = {0}", 50)</para>
484491
/// </summary>
492+
[Obsolete(Messages.LegacyApi)]
485493
public static bool ExistsFmt<T>(this IDbConnection dbConn, string sqlFormat, params object[] filterParams)
486494
{
487495
return dbConn.Exec(dbCmd => dbCmd.ExistsFmt<T>(sqlFormat, filterParams));

‎src/ServiceStack.OrmLite/OrmLiteReadApiAsync.cs

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,7 @@ public static class OrmLiteReadApiAsync
6767
/// <para>db.SelectFmt&lt;Person&gt;("Age &gt; {0}", 40)</para>
6868
/// <para>db.SelectFmt&lt;Person&gt;("SELECT * FROM Person WHERE Age &gt; {0}", 40)</para>
6969
/// </summary>
70+
[Obsolete(Messages.LegacyApi)]
7071
public static Task<List<T>> SelectFmtAsync<T>(this IDbConnection dbConn, CancellationToken token, string sqlFormat, params object[] filterParams)
7172
{
7273
return dbConn.Exec(dbCmd => dbCmd.SelectFmtAsync<T>(token, sqlFormat, filterParams));
@@ -90,10 +91,12 @@ public static Task<List<T>> SelectFmtAsync<T>(this IDbConnection dbConn, string
9091
/// Returns a partial subset of results from the specified tableType using a SqlFormat query. E.g:
9192
/// <para>db.SelectFmt&lt;EntityWithId&gt;(typeof(Person), "Age &gt; {0}", 40)</para>
9293
/// </summary>
94+
[Obsolete(Messages.LegacyApi)]
9395
public static Task<List<TModel>> SelectFmtAsync<TModel>(this IDbConnection dbConn, CancellationToken token, Type fromTableType, string sqlFormat, params object[] filterParams)
9496
{
9597
return dbConn.Exec(dbCmd => dbCmd.SelectFmtAsync<TModel>(token, fromTableType, sqlFormat, filterParams));
9698
}
99+
[Obsolete(Messages.LegacyApi)]
97100
public static Task<List<TModel>> SelectFmtAsync<TModel>(this IDbConnection dbConn, Type fromTableType, string sqlFormat, params object[] filterParams)
98101
{
99102
return dbConn.Exec(dbCmd => dbCmd.SelectFmtAsync<TModel>(default(CancellationToken), fromTableType, sqlFormat, filterParams));
@@ -175,10 +178,12 @@ public static Task<List<TModel>> SelectFmtAsync<TModel>(this IDbConnection dbCon
175178
/// Returns the first result using a SqlFormat query. E.g:
176179
/// <para>db.SingleFmt&lt;Person&gt;("Age = {0}", 42)</para>
177180
/// </summary>
181+
[Obsolete(Messages.LegacyApi)]
178182
public static Task<T> SingleFmtAsync<T>(this IDbConnection dbConn, CancellationToken token, string sqlFormat, params object[] filterParams)
179183
{
180184
return dbConn.Exec(dbCmd => dbCmd.SingleFmtAsync<T>(token, sqlFormat, filterParams));
181185
}
186+
[Obsolete(Messages.LegacyApi)]
182187
public static Task<T> SingleFmtAsync<T>(this IDbConnection dbConn, string sqlFormat, params object[] filterParams)
183188
{
184189
return dbConn.Exec(dbCmd => dbCmd.SingleFmtAsync<T>(default(CancellationToken), sqlFormat, filterParams));
@@ -241,10 +246,12 @@ public static T ScalarAsync<T>(this IDbCommand dbCmd, string sql, IEnumerable<ID
241246
/// Returns a single scalar value using an SqlFormat query. E.g:
242247
/// <para>db.ScalarFmt&lt;int&gt;("SELECT COUNT(*) FROM Person WHERE Age &gt; {0}", 40)</para>
243248
/// </summary>
249+
[Obsolete(Messages.LegacyApi)]
244250
public static Task<T> ScalarFmtAsync<T>(this IDbConnection dbConn, CancellationToken token, string sqlFormat, params object[] sqlParams)
245251
{
246252
return dbConn.Exec(dbCmd => dbCmd.ScalarFmtAsync<T>(token, sqlFormat, sqlParams));
247253
}
254+
[Obsolete(Messages.LegacyApi)]
248255
public static Task<T> ScalarFmtAsync<T>(this IDbConnection dbConn, string sqlFormat, params object[] sqlParams)
249256
{
250257
return dbConn.Exec(dbCmd => dbCmd.ScalarFmtAsync<T>(default(CancellationToken), sqlFormat, sqlParams));
@@ -281,10 +288,12 @@ public static Task<T> ScalarFmtAsync<T>(this IDbConnection dbConn, string sqlFor
281288
/// Returns the first column in a List using a SqlFormat query. E.g:
282289
/// <para>db.ColumnFmt&lt;string&gt;("SELECT LastName FROM Person WHERE Age = {0}", 27)</para>
283290
/// </summary>
291+
[Obsolete(Messages.LegacyApi)]
284292
public static Task<List<T>> ColumnFmtAsync<T>(this IDbConnection dbConn, CancellationToken token, string sqlFormat, params object[] sqlParams)
285293
{
286294
return dbConn.Exec(dbCmd => dbCmd.ColumnFmtAsync<T>(token, sqlFormat, sqlParams));
287295
}
296+
[Obsolete(Messages.LegacyApi)]
288297
public static Task<List<T>> ColumnFmtAsync<T>(this IDbConnection dbConn, string sqlFormat, params object[] sqlParams)
289298
{
290299
return dbConn.Exec(dbCmd => dbCmd.ColumnFmtAsync<T>(default(CancellationToken), sqlFormat, sqlParams));
@@ -321,10 +330,12 @@ public static Task<List<T>> ColumnFmtAsync<T>(this IDbConnection dbConn, string
321330
/// Returns the distinct first column values in a HashSet using an SqlFormat query. E.g:
322331
/// <para>db.ColumnDistinctFmt&lt;int&gt;("SELECT Age FROM Person WHERE Age &lt; {0}", 50)</para>
323332
/// </summary>
333+
[Obsolete(Messages.LegacyApi)]
324334
public static Task<HashSet<T>> ColumnDistinctFmtAsync<T>(this IDbConnection dbConn, CancellationToken token, string sqlFormat, params object[] sqlParams)
325335
{
326336
return dbConn.Exec(dbCmd => dbCmd.ColumnDistinctFmtAsync<T>(token, sqlFormat, sqlParams));
327337
}
338+
[Obsolete(Messages.LegacyApi)]
328339
public static Task<HashSet<T>> ColumnDistinctFmtAsync<T>(this IDbConnection dbConn, string sqlFormat, params object[] sqlParams)
329340
{
330341
return dbConn.Exec(dbCmd => dbCmd.ColumnDistinctFmtAsync<T>(default(CancellationToken), sqlFormat, sqlParams));
@@ -361,10 +372,12 @@ public static Task<HashSet<T>> ColumnDistinctFmtAsync<T>(this IDbConnection dbCo
361372
/// Returns an Dictionary&lt;K, List&lt;V&gt;&gt; grouping made from the first two columns using an SqlFormat query. E.g:
362373
/// <para>db.LookupFmt&lt;int, string&gt;("SELECT Age, LastName FROM Person WHERE Age &lt; {0}", 50)</para>
363374
/// </summary>
375+
[Obsolete(Messages.LegacyApi)]
364376
public static Task<Dictionary<K, List<V>>> LookupFmtAsync<K, V>(this IDbConnection dbConn, CancellationToken token, string sqlFormat, params object[] sqlParams)
365377
{
366378
return dbConn.Exec(dbCmd => dbCmd.LookupFmtAsync<K, V>(token, sqlFormat, sqlParams));
367379
}
380+
[Obsolete(Messages.LegacyApi)]
368381
public static Task<Dictionary<K, List<V>>> LookupFmtAsync<K, V>(this IDbConnection dbConn, string sqlFormat, params object[] sqlParams)
369382
{
370383
return dbConn.Exec(dbCmd => dbCmd.LookupFmtAsync<K, V>(default(CancellationToken), sqlFormat, sqlParams));
@@ -401,10 +414,12 @@ public static Task<Dictionary<K, List<V>>> LookupFmtAsync<K, V>(this IDbConnecti
401414
/// Returns a Dictionary from the first 2 columns: Column 1 (Keys), Column 2 (Values) using an SqlFormat query. E.g:
402415
/// <para>db.DictionaryFmt&lt;int, string&gt;("SELECT Id, LastName FROM Person WHERE Age &lt; {0}", 50)</para>
403416
/// </summary>
417+
[Obsolete(Messages.LegacyApi)]
404418
public static Task<Dictionary<K, V>> DictionaryFmtAsync<K, V>(this IDbConnection dbConn, CancellationToken token, string sqlFormat, params object[] sqlParams)
405419
{
406420
return dbConn.Exec(dbCmd => dbCmd.DictionaryFmtAsync<K, V>(token, sqlFormat, sqlParams));
407421
}
422+
[Obsolete(Messages.LegacyApi)]
408423
public static Task<Dictionary<K, V>> DictionaryFmtAsync<K, V>(this IDbConnection dbConn, string sqlFormat, params object[] sqlParams)
409424
{
410425
return dbConn.Exec(dbCmd => dbCmd.DictionaryFmtAsync<K, V>(default(CancellationToken), sqlFormat, sqlParams));
@@ -466,10 +481,12 @@ public static Task<Dictionary<K, V>> DictionaryFmtAsync<K, V>(this IDbConnection
466481
/// <para>db.ExistsFmt&lt;Person&gt;("Age = {0}", 42)</para>
467482
/// <para>db.ExistsFmt&lt;Person&gt;("SELECT * FROM Person WHERE Age = {0}", 50)</para>
468483
/// </summary>
484+
[Obsolete(Messages.LegacyApi)]
469485
public static Task<bool> ExistsFmtAsync<T>(this IDbConnection dbConn, CancellationToken token, string sqlFormat, params object[] filterParams)
470486
{
471487
return dbConn.Exec(dbCmd => dbCmd.ExistsFmtAsync<T>(token, sqlFormat, filterParams));
472488
}
489+
[Obsolete(Messages.LegacyApi)]
473490
public static Task<bool> ExistsFmtAsync<T>(this IDbConnection dbConn, string sqlFormat, params object[] filterParams)
474491
{
475492
return dbConn.Exec(dbCmd => dbCmd.ExistsFmtAsync<T>(default(CancellationToken), sqlFormat, filterParams));
@@ -633,6 +650,7 @@ public static Task<bool> ExistsFmtAsync<T>(this IDbConnection dbConn, string sql
633650
/// Returns results from a Stored Procedure using an SqlFormat query. E.g:
634651
/// <para></para>
635652
/// </summary>
653+
[Obsolete(Messages.LegacyApi)]
636654
public static Task<List<TOutputModel>> SqlProcedureFmtAsync<TOutputModel>(this IDbConnection dbConn, CancellationToken token,
637655
object anonType,
638656
string sqlFilter,

‎src/ServiceStack.OrmLite/OrmLiteVariables.cs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,9 @@ public static class OrmLiteVariables
44
{
55
public const string SystemUtc = "{SYSTEM_UTC}";
66
}
7+
8+
public static class Messages
9+
{
10+
public const string LegacyApi = "API is deprecated and will move to ServiceStack.OrmLite.Legacy namespace in future release";
11+
}
712
}

‎src/ServiceStack.OrmLite/OrmLiteWriteApi.cs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -224,6 +224,7 @@ public static int DeleteAll(this IDbConnection dbConn, Type tableType)
224224
/// Delete rows using a SqlFormat filter. E.g:
225225
/// </summary>
226226
/// <returns>number of rows deleted</returns>
227+
[Obsolete(Messages.LegacyApi)]
227228
public static int DeleteFmt<T>(this IDbConnection dbConn, string sqlFilter, params object[] filterParams)
228229
{
229230
return dbConn.Exec(dbCmd => dbCmd.DeleteFmt<T>(sqlFilter, filterParams));
@@ -234,6 +235,7 @@ public static int DeleteFmt<T>(this IDbConnection dbConn, string sqlFilter, para
234235
/// </summary>
235236
/// <para>db.DeleteFmt(typeof(Person), "Age = {0}", 27)</para>
236237
/// <returns>number of rows deleted</returns>
238+
[Obsolete(Messages.LegacyApi)]
237239
public static int DeleteFmt(this IDbConnection dbConn, Type tableType, string sqlFilter, params object[] filterParams)
238240
{
239241
return dbConn.Exec(dbCmd => dbCmd.DeleteFmt(tableType, sqlFilter, filterParams));

‎src/ServiceStack.OrmLite/OrmLiteWriteApiAsync.cs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -210,10 +210,12 @@ public static Task<int> DeleteNonDefaultsAsync<T>(this IDbConnection dbConn, par
210210
/// Delete rows using a SqlFormat filter. E.g:
211211
/// </summary>
212212
/// <returns>number of rows deleted</returns>
213+
[Obsolete(Messages.LegacyApi)]
213214
public static Task<int> DeleteFmtAsync<T>(this IDbConnection dbConn, CancellationToken token, string sqlFilter, params object[] filterParams)
214215
{
215216
return dbConn.Exec(dbCmd => dbCmd.DeleteFmtAsync<T>(token, sqlFilter, filterParams));
216217
}
218+
[Obsolete(Messages.LegacyApi)]
217219
public static Task<int> DeleteFmtAsync<T>(this IDbConnection dbConn, string sqlFilter, params object[] filterParams)
218220
{
219221
return dbConn.Exec(dbCmd => dbCmd.DeleteFmtAsync<T>(default(CancellationToken), sqlFilter, filterParams));
@@ -224,10 +226,12 @@ public static Task<int> DeleteFmtAsync<T>(this IDbConnection dbConn, string sqlF
224226
/// </summary>
225227
/// <para>db.DeleteFmt(typeof(Person), "Age = {0}", 27)</para>
226228
/// <returns>number of rows deleted</returns>
229+
[Obsolete(Messages.LegacyApi)]
227230
public static Task<int> DeleteFmtAsync(this IDbConnection dbConn, CancellationToken token, Type tableType, string sqlFilter, params object[] filterParams)
228231
{
229232
return dbConn.Exec(dbCmd => dbCmd.DeleteFmtAsync(token, tableType, sqlFilter, filterParams));
230233
}
234+
[Obsolete(Messages.LegacyApi)]
231235
public static Task<int> DeleteFmtAsync(this IDbConnection dbConn, Type tableType, string sqlFilter, params object[] filterParams)
232236
{
233237
return dbConn.Exec(dbCmd => dbCmd.DeleteFmtAsync(default(CancellationToken), tableType, sqlFilter, filterParams));

‎src/ServiceStack.OrmLite/OrmLiteWriteExpressionsApi.cs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -132,6 +132,7 @@ public static int Update<T>(this IDbConnection dbConn, object updateOnly, Expres
132132
/// db.Update&lt;Person&gt;(set:"FirstName = {0}".Params("JJ"), where:"LastName = {0}".Params("Hendrix"));
133133
/// UPDATE "Person" SET FirstName = 'JJ' WHERE LastName = 'Hendrix'
134134
/// </summary>
135+
[Obsolete(Messages.LegacyApi)]
135136
public static int UpdateFmt<T>(this IDbConnection dbConn, string set = null, string where = null)
136137
{
137138
return dbConn.Exec(dbCmd => dbCmd.UpdateFmt<T>(set, where));
@@ -143,6 +144,7 @@ public static int UpdateFmt<T>(this IDbConnection dbConn, string set = null, str
143144
/// db.Update(table:"Person", set: "FirstName = {0}".Params("JJ"), where: "LastName = {0}".Params("Hendrix"));
144145
/// UPDATE "Person" SET FirstName = 'JJ' WHERE LastName = 'Hendrix'
145146
/// </summary>
147+
[Obsolete(Messages.LegacyApi)]
146148
public static int UpdateFmt(this IDbConnection dbConn, string table = null, string set = null, string where = null)
147149
{
148150
return dbConn.Exec(dbCmd => dbCmd.UpdateFmt(table, set, where));
@@ -210,6 +212,7 @@ public static int Delete<T>(this IDbConnection dbConn, SqlExpression<T> where)
210212
/// db.Delete&lt;Person&gt;(where:"Age = {0}".Params(27));
211213
/// DELETE FROM "Person" WHERE Age = 27
212214
/// </summary>
215+
[Obsolete(Messages.LegacyApi)]
213216
public static int DeleteFmt<T>(this IDbConnection dbConn, string where = null)
214217
{
215218
return dbConn.Exec(dbCmd => dbCmd.DeleteFmt<T>(where));
@@ -221,6 +224,7 @@ public static int DeleteFmt<T>(this IDbConnection dbConn, string where = null)
221224
/// db.Delete(table:"Person", where: "Age = {0}".Params(27));
222225
/// DELETE FROM "Person" WHERE Age = 27
223226
/// </summary>
227+
[Obsolete(Messages.LegacyApi)]
224228
public static int DeleteFmt(this IDbConnection dbConn, string table = null, string where = null)
225229
{
226230
return dbConn.Exec(dbCmd => dbCmd.DeleteFmt(table, where));

0 commit comments

Comments
 (0)