-
Notifications
You must be signed in to change notification settings - Fork 3.2k
/
Copy pathRelationalPropertyExtensions.cs
1980 lines (1778 loc) · 91.8 KB
/
RelationalPropertyExtensions.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
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
using System.Globalization;
using System.Runtime.CompilerServices;
using System.Text;
using Microsoft.EntityFrameworkCore.Metadata.Internal;
// ReSharper disable once CheckNamespace
namespace Microsoft.EntityFrameworkCore;
/// <summary>
/// Property extension methods for relational database metadata.
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-modeling">Modeling entity types and relationships</see> for more information and examples.
/// </remarks>
public static class RelationalPropertyExtensions
{
private static readonly MethodInfo GetFieldValueMethod =
typeof(DbDataReader).GetRuntimeMethod(nameof(DbDataReader.GetFieldValue), new[] { typeof(int) })!;
private static readonly MethodInfo IsDbNullMethod =
typeof(DbDataReader).GetRuntimeMethod(nameof(DbDataReader.IsDBNull), new[] { typeof(int) })!;
private static readonly MethodInfo ThrowReadValueExceptionMethod
= typeof(RelationalPropertyExtensions).GetTypeInfo().GetDeclaredMethod(nameof(ThrowReadValueException))!;
/// <summary>
/// Returns the base name of the column to which the property would be mapped.
/// </summary>
/// <param name="property">The property.</param>
/// <returns>The base name of the column to which the property would be mapped.</returns>
[Obsolete("Use GetColumnName")]
public static string GetColumnBaseName(this IReadOnlyProperty property)
=> property.GetColumnName();
/// <summary>
/// Returns the name of the column to which the property would be mapped.
/// </summary>
/// <param name="property">The property.</param>
/// <returns>The base name of the column to which the property would be mapped.</returns>
public static string GetColumnName(this IReadOnlyProperty property)
=> (string?)property.FindAnnotation(RelationalAnnotationNames.ColumnName)?.Value ?? property.GetDefaultColumnName();
/// <summary>
/// Returns the name of the column to which the property is mapped for a particular table.
/// </summary>
/// <param name="property">The property.</param>
/// <param name="storeObject">The identifier of the table-like store object containing the column.</param>
/// <returns>The name of the column to which the property is mapped.</returns>
public static string? GetColumnName(this IReadOnlyProperty property, in StoreObjectIdentifier storeObject)
{
var overrides = property.FindOverrides(storeObject);
if (overrides?.IsColumnNameOverridden == true)
{
return overrides.ColumnName;
}
if (storeObject.StoreObjectType != StoreObjectType.Function
&& storeObject.StoreObjectType != StoreObjectType.SqlQuery)
{
if (property.IsPrimaryKey())
{
var tableFound = false;
if (property.DeclaringEntityType.FindMappingFragment(storeObject) != null)
{
tableFound = true;
}
else
{
foreach (var containingType in property.DeclaringEntityType.GetDerivedTypesInclusive())
{
if (StoreObjectIdentifier.Create(containingType, storeObject.StoreObjectType) == storeObject)
{
tableFound = true;
break;
}
}
}
if (!tableFound)
{
return null;
}
}
else if (property.DeclaringEntityType.GetMappingStrategy() != RelationalAnnotationNames.TpcMappingStrategy)
{
var declaringStoreObject = StoreObjectIdentifier.Create(property.DeclaringEntityType, storeObject.StoreObjectType);
if (declaringStoreObject == null)
{
var tableFound = false;
var queue = new Queue<IReadOnlyEntityType>();
queue.Enqueue(property.DeclaringEntityType);
while (queue.Count > 0 && !tableFound)
{
foreach (var containingType in queue.Dequeue().GetDirectlyDerivedTypes())
{
declaringStoreObject = StoreObjectIdentifier.Create(containingType, storeObject.StoreObjectType);
if (declaringStoreObject == null)
{
queue.Enqueue(containingType);
continue;
}
if (declaringStoreObject == storeObject)
{
tableFound = true;
break;
}
}
}
if (!tableFound)
{
return null;
}
}
else
{
var fragments = property.DeclaringEntityType.GetMappingFragments(storeObject.StoreObjectType).ToList();
if (fragments.Count > 0)
{
if (overrides == null
&& (declaringStoreObject != storeObject
|| fragments.Any(f => property.FindOverrides(f.StoreObject) != null)))
{
return null;
}
}
else if (declaringStoreObject != storeObject)
{
return null;
}
}
}
}
var columnAnnotation = property.FindAnnotation(RelationalAnnotationNames.ColumnName);
if (columnAnnotation != null)
{
return (string?)columnAnnotation.Value;
}
return GetDefaultColumnName(property, storeObject);
}
/// <summary>
/// Returns the default base name of the column to which the property would be mapped
/// </summary>
/// <param name="property">The property.</param>
/// <returns>The default base column name to which the property would be mapped.</returns>
[Obsolete("Use GetDefaultColumnName")]
public static string GetDefaultColumnBaseName(this IReadOnlyProperty property)
=> property.GetDefaultColumnName();
/// <summary>
/// Returns the default base name of the column to which the property would be mapped
/// </summary>
/// <param name="property">The property.</param>
/// <returns>The default base column name to which the property would be mapped.</returns>
public static string GetDefaultColumnName(this IReadOnlyProperty property)
{
var name = property.Name;
if (property.IsShadowProperty()
&& property.GetContainingForeignKeys().Count() == 1)
{
var foreignKey = property.GetContainingForeignKeys().First();
var principalEntityType = foreignKey.PrincipalEntityType;
if (!principalEntityType.HasSharedClrType
&& principalEntityType.ClrType.IsConstructedGenericType
&& foreignKey.DependentToPrincipal == null)
{
var principalProperty = property.FindFirstPrincipal()!;
var principalName = principalEntityType.ShortName();
if (property.Name.Length == (principalName.Length + principalProperty.Name.Length)
&& property.Name.StartsWith(principalName, StringComparison.Ordinal)
&& property.Name.EndsWith(principalProperty.Name, StringComparison.Ordinal))
{
name = principalEntityType.ClrType.ShortDisplayName() + principalProperty.Name;
}
}
}
return Uniquifier.Truncate(name, property.DeclaringEntityType.Model.GetMaxIdentifierLength());
}
/// <summary>
/// Returns the default column name to which the property would be mapped.
/// </summary>
/// <param name="property">The property.</param>
/// <param name="storeObject">The identifier of the table-like store object containing the column.</param>
/// <returns>The default column name to which the property would be mapped.</returns>
public static string? GetDefaultColumnName(this IReadOnlyProperty property, in StoreObjectIdentifier storeObject)
{
if (property.DeclaringEntityType.IsMappedToJson())
{
return null;
}
var sharedTablePrincipalPrimaryKeyProperty = FindSharedObjectRootPrimaryKeyProperty(property, storeObject);
if (sharedTablePrincipalPrimaryKeyProperty != null)
{
return sharedTablePrincipalPrimaryKeyProperty.GetColumnName(storeObject)!;
}
var sharedTablePrincipalConcurrencyProperty = FindSharedObjectRootConcurrencyTokenProperty(property, storeObject);
if (sharedTablePrincipalConcurrencyProperty != null)
{
return sharedTablePrincipalConcurrencyProperty.GetColumnName(storeObject)!;
}
var entityType = property.DeclaringEntityType;
StringBuilder? builder = null;
var currentStoreObject = storeObject;
while (true)
{
var ownership = entityType.GetForeignKeys().SingleOrDefault(fk => fk.IsOwnership);
if (ownership == null)
{
break;
}
var ownerType = ownership.PrincipalEntityType;
if (StoreObjectIdentifier.Create(ownerType, currentStoreObject.StoreObjectType) != currentStoreObject
&& ownerType.GetMappingFragments(storeObject.StoreObjectType)
.All(f => f.StoreObject != currentStoreObject))
{
break;
}
builder ??= new StringBuilder();
builder.Insert(0, "_");
builder.Insert(0, ownership.PrincipalToDependent!.Name);
entityType = ownerType;
}
var baseName = storeObject.StoreObjectType == StoreObjectType.Table ? property.GetDefaultColumnName() : property.Name;
if (builder == null)
{
return baseName;
}
builder.Append(baseName);
baseName = builder.ToString();
return Uniquifier.Truncate(baseName, property.DeclaringEntityType.Model.GetMaxIdentifierLength());
}
/// <summary>
/// Sets the column to which the property is mapped.
/// </summary>
/// <param name="property">The property.</param>
/// <param name="name">The name to set.</param>
public static void SetColumnName(this IMutableProperty property, string? name)
=> property.SetOrRemoveAnnotation(
RelationalAnnotationNames.ColumnName,
Check.NullButNotEmpty(name, nameof(name)));
/// <summary>
/// Sets the column to which the property is mapped.
/// </summary>
/// <param name="property">The property.</param>
/// <param name="name">The name to set.</param>
/// <param name="fromDataAnnotation">Indicates whether the configuration was specified using a data annotation.</param>
/// <returns>The configured value.</returns>
public static string? SetColumnName(
this IConventionProperty property,
string? name,
bool fromDataAnnotation = false)
=> (string?)property.SetOrRemoveAnnotation(
RelationalAnnotationNames.ColumnName,
Check.NullButNotEmpty(name, nameof(name)),
fromDataAnnotation)?.Value;
/// <summary>
/// Sets the column to which the property is mapped for a particular table-like store object.
/// </summary>
/// <param name="property">The property.</param>
/// <param name="name">The name to set.</param>
/// <param name="storeObject">The identifier of the table-like store object containing the column.</param>
public static void SetColumnName(
this IMutableProperty property,
string? name,
in StoreObjectIdentifier storeObject)
=> property.GetOrCreateOverrides(storeObject).ColumnName = name;
/// <summary>
/// Sets the column to which the property is mapped for a particular table-like store object.
/// </summary>
/// <param name="property">The property.</param>
/// <param name="name">The name to set.</param>
/// <param name="storeObject">The identifier of the table-like store object containing the column.</param>
/// <param name="fromDataAnnotation">Indicates whether the configuration was specified using a data annotation.</param>
/// <returns>The configured value.</returns>
public static string? SetColumnName(
this IConventionProperty property,
string? name,
in StoreObjectIdentifier storeObject,
bool fromDataAnnotation = false)
=> property.GetOrCreateOverrides(storeObject, fromDataAnnotation).SetColumnName(name, fromDataAnnotation);
/// <summary>
/// Gets the <see cref="ConfigurationSource" /> for the column name.
/// </summary>
/// <param name="property">The property.</param>
/// <returns>The <see cref="ConfigurationSource" /> for the column name.</returns>
public static ConfigurationSource? GetColumnNameConfigurationSource(this IConventionProperty property)
=> property.FindAnnotation(RelationalAnnotationNames.ColumnName)?.GetConfigurationSource();
/// <summary>
/// Gets the <see cref="ConfigurationSource" /> for the column name for a particular table-like store object.
/// </summary>
/// <param name="property">The property.</param>
/// <param name="storeObject">The identifier of the table-like store object containing the column.</param>
/// <returns>The <see cref="ConfigurationSource" /> for the column name for a particular table-like store object.</returns>
public static ConfigurationSource? GetColumnNameConfigurationSource(
this IConventionProperty property,
in StoreObjectIdentifier storeObject)
=> property.FindOverrides(storeObject)?.GetColumnNameConfigurationSource();
/// <summary>
/// Returns the order of the column this property is mapped to.
/// </summary>
/// <param name="property">The property.</param>
/// <returns>The column order.</returns>
public static int? GetColumnOrder(this IReadOnlyProperty property)
=> (property is RuntimeProperty)
? throw new InvalidOperationException(CoreStrings.RuntimeModelMissingData)
: (int?)property.FindAnnotation(RelationalAnnotationNames.ColumnOrder)?.Value;
/// <summary>
/// Returns the order of the column this property is mapped to for a particular table.
/// </summary>
/// <param name="property">The property.</param>
/// <param name="storeObject">The identifier of the table-like store object containing the column.</param>
/// <returns>The column order.</returns>
public static int? GetColumnOrder(this IReadOnlyProperty property, in StoreObjectIdentifier storeObject)
{
if (property is RuntimeProperty)
{
throw new InvalidOperationException(CoreStrings.RuntimeModelMissingData);
}
var annotation = property.FindAnnotation(RelationalAnnotationNames.ColumnOrder);
if (annotation != null)
{
return (int?)annotation.Value;
}
var sharedTableRootProperty = property.FindSharedStoreObjectRootProperty(storeObject);
return sharedTableRootProperty != null
? GetColumnOrder(sharedTableRootProperty, storeObject)
: null;
}
/// <summary>
/// Sets the order of the column the property is mapped to.
/// </summary>
/// <param name="property">The property.</param>
/// <param name="order">The column order.</param>
public static void SetColumnOrder(this IMutableProperty property, int? order)
=> property.SetOrRemoveAnnotation(RelationalAnnotationNames.ColumnOrder, order);
/// <summary>
/// Sets the order of the column the property is mapped to.
/// </summary>
/// <param name="property">The property.</param>
/// <param name="order">The column order.</param>
/// <param name="fromDataAnnotation">A value indicating whether the configuration was specified using a data annotation.</param>
/// <returns>The configured value.</returns>
public static int? SetColumnOrder(this IConventionProperty property, int? order, bool fromDataAnnotation = false)
=> (int?)property.SetOrRemoveAnnotation(
RelationalAnnotationNames.ColumnOrder,
order,
fromDataAnnotation)?.Value;
/// <summary>
/// Gets the <see cref="ConfigurationSource" /> of the column order.
/// </summary>
/// <param name="property">The property.</param>
/// <returns>The <see cref="ConfigurationSource" />.</returns>
public static ConfigurationSource? GetColumnOrderConfigurationSource(this IConventionProperty property)
=> property.FindAnnotation(RelationalAnnotationNames.ColumnName)?.GetConfigurationSource();
/// <summary>
/// Returns the database type of the column to which the property is mapped, or <see langword="null" /> if the database type
/// could not be found.
/// </summary>
/// <param name="property">The property.</param>
/// <returns>
/// The database type of the column to which the property is mapped, or <see langword="null" /> if the database type could not
/// be found.
/// </returns>
public static string? GetColumnType(this IReadOnlyProperty property)
=> (string?)(property.FindRelationalTypeMapping()?.StoreType
?? property.FindAnnotation(RelationalAnnotationNames.ColumnType)?.Value);
/// <summary>
/// Returns the database type of the column to which the property is mapped.
/// </summary>
/// <param name="property">The property.</param>
/// <returns>The database type of the column to which the property is mapped.</returns>
public static string GetColumnType(this IProperty property)
=> ((IReadOnlyProperty)property).GetColumnType()!;
/// <summary>
/// Returns the database type of the column to which the property is mapped, or <see langword="null" /> if the database type
/// could not be found.
/// </summary>
/// <param name="property">The property.</param>
/// <param name="storeObject">The identifier of the table-like store object containing the column.</param>
/// <returns>
/// The database type of the column to which the property is mapped, or <see langword="null" /> if the database type could not
/// be found.
/// </returns>
public static string? GetColumnType(this IReadOnlyProperty property, in StoreObjectIdentifier storeObject)
{
var annotation = property.FindAnnotation(RelationalAnnotationNames.ColumnType);
if (annotation != null)
{
return property.FindRelationalTypeMapping()?.StoreType ?? (string?)annotation.Value;
}
return GetDefaultColumnType(property, storeObject);
}
/// <summary>
/// Returns the database type of the column to which the property is mapped.
/// </summary>
/// <param name="property">The property.</param>
/// <param name="storeObject">The identifier of the table-like store object containing the column.</param>
/// <returns>The database type of the column to which the property is mapped.</returns>
public static string GetColumnType(this IProperty property, in StoreObjectIdentifier storeObject)
=> ((IReadOnlyProperty)property).GetColumnType(storeObject)!;
private static string? GetDefaultColumnType(IReadOnlyProperty property, in StoreObjectIdentifier storeObject)
{
var sharedTableRootProperty = property.FindSharedStoreObjectRootProperty(storeObject);
return sharedTableRootProperty != null
? sharedTableRootProperty.GetColumnType(storeObject)
: property.FindRelationalTypeMapping(storeObject)?.StoreType;
}
/// <summary>
/// Sets the database type of the column to which the property is mapped.
/// </summary>
/// <param name="property">The property.</param>
/// <param name="value">The value to set.</param>
public static void SetColumnType(this IMutableProperty property, string? value)
=> property.SetOrRemoveAnnotation(
RelationalAnnotationNames.ColumnType,
Check.NullButNotEmpty(value, nameof(value)));
/// <summary>
/// Sets the database type of the column to which the property is mapped.
/// </summary>
/// <param name="property">The property.</param>
/// <param name="value">The value to set.</param>
/// <param name="fromDataAnnotation">Indicates whether the configuration was specified using a data annotation.</param>
/// <returns>The configured value.</returns>
public static string? SetColumnType(
this IConventionProperty property,
string? value,
bool fromDataAnnotation = false)
=> (string?)property.SetOrRemoveAnnotation(
RelationalAnnotationNames.ColumnType,
Check.NullButNotEmpty(value, nameof(value)),
fromDataAnnotation)?.Value;
/// <summary>
/// Gets the <see cref="ConfigurationSource" /> for the column name.
/// </summary>
/// <param name="property">The property.</param>
/// <returns>The <see cref="ConfigurationSource" /> for the column name.</returns>
public static ConfigurationSource? GetColumnTypeConfigurationSource(this IConventionProperty property)
=> property.FindAnnotation(RelationalAnnotationNames.ColumnType)?.GetConfigurationSource();
/// <summary>
/// Returns the default columns to which the property would be mapped.
/// </summary>
/// <param name="property">The property.</param>
/// <returns>The default columns to which the property would be mapped.</returns>
public static IEnumerable<IColumnMappingBase> GetDefaultColumnMappings(this IProperty property)
=> (IEnumerable<IColumnMappingBase>?)property.FindRuntimeAnnotationValue(
RelationalAnnotationNames.DefaultColumnMappings)
?? Enumerable.Empty<IColumnMappingBase>();
/// <summary>
/// Returns the table columns to which the property is mapped.
/// </summary>
/// <param name="property">The property.</param>
/// <returns>The table columns to which the property is mapped.</returns>
public static IEnumerable<IColumnMapping> GetTableColumnMappings(this IProperty property)
=> (IEnumerable<IColumnMapping>?)property.FindRuntimeAnnotationValue(
RelationalAnnotationNames.TableColumnMappings)
?? Enumerable.Empty<IColumnMapping>();
/// <summary>
/// Returns the view columns to which the property is mapped.
/// </summary>
/// <param name="property">The property.</param>
/// <returns>The view columns to which the property is mapped.</returns>
public static IEnumerable<IViewColumnMapping> GetViewColumnMappings(this IProperty property)
=> (IEnumerable<IViewColumnMapping>?)property.FindRuntimeAnnotationValue(
RelationalAnnotationNames.ViewColumnMappings)
?? Enumerable.Empty<IViewColumnMapping>();
/// <summary>
/// Returns the SQL query columns to which the property is mapped.
/// </summary>
/// <param name="property">The property.</param>
/// <returns>The SQL query columns to which the property is mapped.</returns>
public static IEnumerable<ISqlQueryColumnMapping> GetSqlQueryColumnMappings(this IProperty property)
=> (IEnumerable<ISqlQueryColumnMapping>?)property.FindRuntimeAnnotationValue(
RelationalAnnotationNames.SqlQueryColumnMappings)
?? Enumerable.Empty<ISqlQueryColumnMapping>();
/// <summary>
/// Returns the function columns to which the property is mapped.
/// </summary>
/// <param name="property">The property.</param>
/// <returns>The function columns to which the property is mapped.</returns>
public static IEnumerable<IFunctionColumnMapping> GetFunctionColumnMappings(this IProperty property)
=> (IEnumerable<IFunctionColumnMapping>?)property.FindRuntimeAnnotationValue(
RelationalAnnotationNames.FunctionColumnMappings)
?? Enumerable.Empty<IFunctionColumnMapping>();
/// <summary>
/// Returns the insert stored procedure result columns to which the property is mapped.
/// </summary>
/// <param name="property">The property.</param>
/// <returns>The insert stored procedure result columns to which the property is mapped.</returns>
public static IEnumerable<IStoredProcedureResultColumnMapping> GetInsertStoredProcedureResultColumnMappings(this IProperty property)
=> (IEnumerable<IStoredProcedureResultColumnMapping>?)property.FindRuntimeAnnotationValue(
RelationalAnnotationNames.InsertStoredProcedureResultColumnMappings)
?? Enumerable.Empty<IStoredProcedureResultColumnMapping>();
/// <summary>
/// Returns the insert stored procedure parameters to which the property is mapped.
/// </summary>
/// <param name="property">The property.</param>
/// <returns>The insert stored procedure parameters to which the property is mapped.</returns>
public static IEnumerable<IStoredProcedureParameterMapping> GetInsertStoredProcedureParameterMappings(this IProperty property)
=> (IEnumerable<IStoredProcedureParameterMapping>?)property.FindRuntimeAnnotationValue(
RelationalAnnotationNames.InsertStoredProcedureParameterMappings)
?? Enumerable.Empty<IStoredProcedureParameterMapping>();
/// <summary>
/// Returns the delete stored procedure parameters to which the property is mapped.
/// </summary>
/// <param name="property">The property.</param>
/// <returns>The delete stored procedure parameters to which the property is mapped.</returns>
public static IEnumerable<IStoredProcedureParameterMapping> GetDeleteStoredProcedureParameterMappings(this IProperty property)
=> (IEnumerable<IStoredProcedureParameterMapping>?)property.FindRuntimeAnnotationValue(
RelationalAnnotationNames.DeleteStoredProcedureParameterMappings)
?? Enumerable.Empty<IStoredProcedureParameterMapping>();
/// <summary>
/// Returns the update stored procedure result columns to which the property is mapped.
/// </summary>
/// <param name="property">The property.</param>
/// <returns>The update stored procedure result columns to which the property is mapped.</returns>
public static IEnumerable<IStoredProcedureResultColumnMapping> GetUpdateStoredProcedureResultColumnMappings(this IProperty property)
=> (IEnumerable<IStoredProcedureResultColumnMapping>?)property.FindRuntimeAnnotationValue(
RelationalAnnotationNames.UpdateStoredProcedureResultColumnMappings)
?? Enumerable.Empty<IStoredProcedureResultColumnMapping>();
/// <summary>
/// Returns the update stored procedure parameters to which the property is mapped.
/// </summary>
/// <param name="property">The property.</param>
/// <returns>The update stored procedure parameters to which the property is mapped.</returns>
public static IEnumerable<IStoredProcedureParameterMapping> GetUpdateStoredProcedureParameterMappings(this IProperty property)
=> (IEnumerable<IStoredProcedureParameterMapping>?)property.FindRuntimeAnnotationValue(
RelationalAnnotationNames.UpdateStoredProcedureParameterMappings)
?? Enumerable.Empty<IStoredProcedureParameterMapping>();
/// <summary>
/// Returns the column corresponding to this property if it's mapped to the given table-like store object.
/// </summary>
/// <param name="property">The property.</param>
/// <param name="storeObject">The identifier of the table-like store object containing the column.</param>
/// <returns>The column to which the property is mapped.</returns>
public static IColumnBase? FindColumn(this IProperty property, in StoreObjectIdentifier storeObject)
{
switch (storeObject.StoreObjectType)
{
case StoreObjectType.Table:
foreach (var mapping in property.GetTableColumnMappings())
{
if (mapping.TableMapping.Table.Name == storeObject.Name && mapping.TableMapping.Table.Schema == storeObject.Schema)
{
return mapping.Column;
}
}
return null;
case StoreObjectType.View:
foreach (var mapping in property.GetViewColumnMappings())
{
if (mapping.TableMapping.Table.Name == storeObject.Name && mapping.TableMapping.Table.Schema == storeObject.Schema)
{
return mapping.Column;
}
}
return null;
case StoreObjectType.SqlQuery:
foreach (var mapping in property.GetSqlQueryColumnMappings())
{
if (mapping.TableMapping.Table.Name == storeObject.Name)
{
return mapping.Column;
}
}
return null;
case StoreObjectType.Function:
foreach (var mapping in property.GetFunctionColumnMappings())
{
if (mapping.TableMapping.Table.Name == storeObject.Name)
{
return mapping.Column;
}
}
return null;
case StoreObjectType.InsertStoredProcedure:
foreach (var mapping in property.GetInsertStoredProcedureResultColumnMappings())
{
if (mapping.TableMapping.Table.Name == storeObject.Name && mapping.TableMapping.Table.Schema == storeObject.Schema)
{
return mapping.Column;
}
}
return null;
case StoreObjectType.UpdateStoredProcedure:
foreach (var mapping in property.GetUpdateStoredProcedureResultColumnMappings())
{
if (mapping.TableMapping.Table.Name == storeObject.Name && mapping.TableMapping.Table.Schema == storeObject.Schema)
{
return mapping.Column;
}
}
return null;
default:
throw new NotSupportedException(storeObject.StoreObjectType.ToString());
}
}
/// <summary>
/// Returns the SQL expression that is used as the default value for the column this property is mapped to.
/// </summary>
/// <param name="property">The property.</param>
/// <returns>The SQL expression that is used as the default value for the column this property is mapped to.</returns>
public static string? GetDefaultValueSql(this IReadOnlyProperty property)
=> (string?)property.FindAnnotation(RelationalAnnotationNames.DefaultValueSql)?.Value;
/// <summary>
/// Returns the SQL expression that is used as the default value for the column this property is mapped to.
/// </summary>
/// <param name="property">The property.</param>
/// <param name="storeObject">The identifier of the table-like store object containing the column.</param>
/// <returns>The SQL expression that is used as the default value for the column this property is mapped to.</returns>
public static string? GetDefaultValueSql(this IReadOnlyProperty property, in StoreObjectIdentifier storeObject)
{
var annotation = property.FindAnnotation(RelationalAnnotationNames.DefaultValueSql);
if (annotation != null)
{
return (string?)annotation.Value;
}
var sharedTableRootProperty = property.FindSharedStoreObjectRootProperty(storeObject);
return sharedTableRootProperty != null
? GetDefaultValueSql(sharedTableRootProperty, storeObject)
: null;
}
/// <summary>
/// Sets the SQL expression that is used as the default value for the column this property is mapped to.
/// </summary>
/// <param name="property">The property.</param>
/// <param name="value">The value to set.</param>
public static void SetDefaultValueSql(this IMutableProperty property, string? value)
=> property.SetOrRemoveAnnotation(
RelationalAnnotationNames.DefaultValueSql,
value);
/// <summary>
/// Sets the SQL expression that is used as the default value for the column this property is mapped to.
/// </summary>
/// <param name="property">The property.</param>
/// <param name="value">The value to set.</param>
/// <param name="fromDataAnnotation">Indicates whether the configuration was specified using a data annotation.</param>
/// <returns>The configured value.</returns>
public static string? SetDefaultValueSql(
this IConventionProperty property,
string? value,
bool fromDataAnnotation = false)
=> (string?)property.SetOrRemoveAnnotation(
RelationalAnnotationNames.DefaultValueSql,
value,
fromDataAnnotation)?.Value;
/// <summary>
/// Gets the <see cref="ConfigurationSource" /> for the default value SQL expression.
/// </summary>
/// <param name="property">The property.</param>
/// <returns>The <see cref="ConfigurationSource" /> for the default value SQL expression.</returns>
public static ConfigurationSource? GetDefaultValueSqlConfigurationSource(this IConventionProperty property)
=> property.FindAnnotation(RelationalAnnotationNames.DefaultValueSql)?.GetConfigurationSource();
/// <summary>
/// Returns the SQL expression that is used as the computed value for the column this property is mapped to.
/// </summary>
/// <param name="property">The property.</param>
/// <returns>The SQL expression that is used as the computed value for the column this property is mapped to.</returns>
public static string? GetComputedColumnSql(this IReadOnlyProperty property)
=> (string?)property.FindAnnotation(RelationalAnnotationNames.ComputedColumnSql)?.Value;
/// <summary>
/// Returns the SQL expression that is used as the computed value for the column this property is mapped to.
/// </summary>
/// <param name="property">The property.</param>
/// <param name="storeObject">The identifier of the table-like store object containing the column.</param>
/// <returns>The SQL expression that is used as the computed value for the column this property is mapped to.</returns>
public static string? GetComputedColumnSql(this IReadOnlyProperty property, in StoreObjectIdentifier storeObject)
{
var annotation = property.FindAnnotation(RelationalAnnotationNames.ComputedColumnSql);
if (annotation != null)
{
return (string?)annotation.Value;
}
var sharedTableRootProperty = property.FindSharedStoreObjectRootProperty(storeObject);
return sharedTableRootProperty != null
? GetComputedColumnSql(sharedTableRootProperty, storeObject)
: null;
}
/// <summary>
/// Sets the SQL expression that is used as the computed value for the column this property is mapped to.
/// </summary>
/// <param name="property">The property.</param>
/// <param name="value">The value to set.</param>
public static void SetComputedColumnSql(this IMutableProperty property, string? value)
=> property.SetOrRemoveAnnotation(
RelationalAnnotationNames.ComputedColumnSql,
value);
/// <summary>
/// Sets the SQL expression that is used as the computed value for the column this property is mapped to.
/// </summary>
/// <param name="property">The property.</param>
/// <param name="value">The value to set.</param>
/// <param name="fromDataAnnotation">Indicates whether the configuration was specified using a data annotation.</param>
/// <returns>The configured value.</returns>
public static string? SetComputedColumnSql(
this IConventionProperty property,
string? value,
bool fromDataAnnotation = false)
=> (string?)property.SetOrRemoveAnnotation(
RelationalAnnotationNames.ComputedColumnSql,
value,
fromDataAnnotation)?.Value;
/// <summary>
/// Gets the <see cref="ConfigurationSource" /> for the computed value SQL expression.
/// </summary>
/// <param name="property">The property.</param>
/// <returns>The <see cref="ConfigurationSource" /> for the computed value SQL expression.</returns>
public static ConfigurationSource? GetComputedColumnSqlConfigurationSource(this IConventionProperty property)
=> property.FindAnnotation(RelationalAnnotationNames.ComputedColumnSql)?.GetConfigurationSource();
/// <summary>
/// Gets whether the value of the computed column this property is mapped to is stored in the database, or calculated when
/// it is read.
/// </summary>
/// <param name="property">The property.</param>
/// <returns>
/// Whether the value of the computed column this property is mapped to is stored in the database,
/// or calculated when it is read.
/// </returns>
public static bool? GetIsStored(this IReadOnlyProperty property)
=> (bool?)property.FindAnnotation(RelationalAnnotationNames.IsStored)?.Value;
/// <summary>
/// Gets whether the value of the computed column this property is mapped to is stored in the database, or calculated when
/// it is read.
/// </summary>
/// <param name="property">The property.</param>
/// <param name="storeObject">The identifier of the table-like store object containing the column.</param>
/// <returns>
/// Whether the value of the computed column this property is mapped to is stored in the database,
/// or calculated when it is read.
/// </returns>
public static bool? GetIsStored(this IReadOnlyProperty property, in StoreObjectIdentifier storeObject)
{
var annotation = property.FindAnnotation(RelationalAnnotationNames.IsStored);
if (annotation != null)
{
return (bool?)annotation.Value;
}
var sharedTableRootProperty = property.FindSharedStoreObjectRootProperty(storeObject);
return sharedTableRootProperty != null
? GetIsStored(sharedTableRootProperty, storeObject)
: null;
}
/// <summary>
/// Sets whether the value of the computed column this property is mapped to is stored in the database, or calculated when
/// it is read.
/// </summary>
/// <param name="property">The property.</param>
/// <param name="value">The value to set.</param>
public static void SetIsStored(this IMutableProperty property, bool? value)
=> property.SetOrRemoveAnnotation(RelationalAnnotationNames.IsStored, value);
/// <summary>
/// Sets whether the value of the computed column this property is mapped to is stored in the database, or calculated when
/// it is read.
/// </summary>
/// <param name="property">The property.</param>
/// <param name="value">The value to set.</param>
/// <param name="fromDataAnnotation">Indicates whether the configuration was specified using a data annotation.</param>
/// <returns>The configured value.</returns>
public static bool? SetIsStored(
this IConventionProperty property,
bool? value,
bool fromDataAnnotation = false)
=> (bool?)property.SetOrRemoveAnnotation(
RelationalAnnotationNames.IsStored,
value,
fromDataAnnotation)?.Value;
/// <summary>
/// Gets the <see cref="ConfigurationSource" /> for the computed value SQL expression.
/// </summary>
/// <param name="property">The property.</param>
/// <returns>The <see cref="ConfigurationSource" /> for the computed value SQL expression.</returns>
public static ConfigurationSource? GetIsStoredConfigurationSource(this IConventionProperty property)
=> property.FindAnnotation(RelationalAnnotationNames.IsStored)?.GetConfigurationSource();
/// <summary>
/// Returns the object that is used as the default value for the column this property is mapped to.
/// </summary>
/// <param name="property">The property.</param>
/// <returns>The object that is used as the default value for the column this property is mapped to.</returns>
public static object? GetDefaultValue(this IReadOnlyProperty property)
{
property.TryGetDefaultValue(out var defaultValue);
return defaultValue;
}
/// <summary>
/// Returns the object that is used as the default value for the column this property is mapped to.
/// </summary>
/// <param name="property">The property.</param>
/// <param name="defaultValue">The default value, or the CLR default if no explicit default has been set.</param>
/// <returns><see langword="true" /> if a default value has been explicitly set; <see langword="false" /> otherwise.</returns>
public static bool TryGetDefaultValue(this IReadOnlyProperty property, out object? defaultValue)
{
var annotation = property.FindAnnotation(RelationalAnnotationNames.DefaultValue);
if (annotation != null)
{
defaultValue = annotation.Value;
return defaultValue != null;
}
defaultValue = property.ClrType.GetDefaultValue();
return false;
}
/// <summary>
/// Returns the object that is used as the default value for the column this property is mapped to.
/// </summary>
/// <param name="property">The property.</param>
/// <param name="storeObject">The identifier of the table-like store object containing the column.</param>
/// <returns>The object that is used as the default value for the column this property is mapped to.</returns>
public static object? GetDefaultValue(this IReadOnlyProperty property, in StoreObjectIdentifier storeObject)
{
property.TryGetDefaultValue(storeObject, out var defaultValue);
return defaultValue;
}
/// <summary>
/// Returns the object that is used as the default value for the column this property is mapped to.
/// </summary>
/// <param name="property">The property.</param>
/// <param name="storeObject">The identifier of the table-like store object containing the column.</param>
/// <param name="defaultValue">The default value, or the CLR default if no explicit default has been set.</param>
/// <returns><see langword="true" /> if a default value has been explicitly set; <see langword="false" /> otherwise.</returns>
public static bool TryGetDefaultValue(
this IReadOnlyProperty property,
in StoreObjectIdentifier storeObject,
out object? defaultValue)
{
var annotation = property.FindAnnotation(RelationalAnnotationNames.DefaultValue);
if (annotation != null)
{
defaultValue = annotation.Value;
return defaultValue != null;
}
var sharedTableRootProperty = property.FindSharedStoreObjectRootProperty(storeObject);
if (sharedTableRootProperty != null)
{
return TryGetDefaultValue(sharedTableRootProperty, storeObject, out defaultValue);
}
defaultValue = property.ClrType.GetDefaultValue();
return false;
}
/// <summary>
/// Sets the object that is used as the default value for the column this property is mapped to.
/// </summary>
/// <param name="property">The property.</param>
/// <param name="value">The value to set.</param>
public static void SetDefaultValue(this IMutableProperty property, object? value)
=> property.SetOrRemoveAnnotation(RelationalAnnotationNames.DefaultValue, ConvertDefaultValue(property, value));
/// <summary>
/// Sets the object that is used as the default value for the column this property is mapped to.
/// </summary>
/// <param name="property">The property.</param>
/// <param name="value">The value to set.</param>
/// <param name="fromDataAnnotation">Indicates whether the configuration was specified using a data annotation.</param>
/// <returns>The configured value.</returns>
public static object? SetDefaultValue(
this IConventionProperty property,
object? value,
bool fromDataAnnotation = false)
=> property.SetOrRemoveAnnotation(
RelationalAnnotationNames.DefaultValue,
ConvertDefaultValue(property, value),
fromDataAnnotation)?.Value;
private static object? ConvertDefaultValue(IReadOnlyProperty property, object? value)
{
if (value == null
|| value == DBNull.Value)
{
return value;
}
var valueType = value.GetType();
if (!property.ClrType.UnwrapNullableType().IsAssignableFrom(valueType))
{
try
{
return Convert.ChangeType(value, property.ClrType, CultureInfo.InvariantCulture);
}
catch (Exception)
{
throw new InvalidOperationException(
RelationalStrings.IncorrectDefaultValueType(
value, valueType, property.Name, property.ClrType, property.DeclaringEntityType.DisplayName()));
}
}
return value;
}
/// <summary>
/// Gets the <see cref="ConfigurationSource" /> for the default value.
/// </summary>
/// <param name="property">The property.</param>
/// <returns>The <see cref="ConfigurationSource" /> for the default value.</returns>
public static ConfigurationSource? GetDefaultValueConfigurationSource(this IConventionProperty property)
=> property.FindAnnotation(RelationalAnnotationNames.DefaultValue)?.GetConfigurationSource();
/// <summary>
/// Gets the maximum length of data that is allowed in this property. For example, if the property is a <see cref="string" />
/// then this is the maximum number of characters.
/// </summary>
/// <param name="property">The property.</param>
/// <param name="storeObject">The identifier of the table-like store object containing the column.</param>
/// <returns>The maximum length, or <see langword="null" /> if none is defined.</returns>
public static int? GetMaxLength(this IReadOnlyProperty property, in StoreObjectIdentifier storeObject)
{
var maxLength = property.GetMaxLength();
if (maxLength != null)
{
return maxLength.Value;
}
var sharedTableRootProperty = property.FindSharedStoreObjectRootProperty(storeObject);
return sharedTableRootProperty != null ? GetMaxLength(sharedTableRootProperty, storeObject) : null;
}
/// <summary>
/// Gets the precision of data that is allowed in this property.
/// For example, if the property is a <see cref="decimal" /> then this is the maximum number of digits.