-
Notifications
You must be signed in to change notification settings - Fork 40
/
IReadOnlyIndex.xml
217 lines (217 loc) · 13.2 KB
/
IReadOnlyIndex.xml
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
<Type Name="IReadOnlyIndex" FullName="Microsoft.EntityFrameworkCore.Metadata.IReadOnlyIndex">
<TypeSignature Language="C#" Value="public interface IReadOnlyIndex : Microsoft.EntityFrameworkCore.Infrastructure.IReadOnlyAnnotatable" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract IReadOnlyIndex implements class Microsoft.EntityFrameworkCore.Infrastructure.IReadOnlyAnnotatable" FrameworkAlternate="efcore-6.0;efcore-7.0" />
<TypeSignature Language="DocId" Value="T:Microsoft.EntityFrameworkCore.Metadata.IReadOnlyIndex" />
<TypeSignature Language="VB.NET" Value="Public Interface IReadOnlyIndex
Implements IReadOnlyAnnotatable" />
<TypeSignature Language="F#" Value="type IReadOnlyIndex = interface
 interface IReadOnlyAnnotatable" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract beforefieldinit IReadOnlyIndex implements class Microsoft.EntityFrameworkCore.Infrastructure.IReadOnlyAnnotatable" FrameworkAlternate="efcore-8.0" />
<AssemblyInfo>
<AssemblyName>Microsoft.EntityFrameworkCore</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Interfaces>
<Interface>
<InterfaceName>Microsoft.EntityFrameworkCore.Infrastructure.IReadOnlyAnnotatable</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<summary>
Represents an index on a set of properties.
</summary>
<remarks>
See <see href="https://aka.ms/efcore-docs-modeling">Modeling entity types and relationships</see> for more information and examples.
</remarks>
</Docs>
<Members>
<Member MemberName="DeclaringEntityType">
<MemberSignature Language="C#" Value="public Microsoft.EntityFrameworkCore.Metadata.IReadOnlyEntityType DeclaringEntityType { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.EntityFrameworkCore.Metadata.IReadOnlyEntityType DeclaringEntityType" />
<MemberSignature Language="DocId" Value="P:Microsoft.EntityFrameworkCore.Metadata.IReadOnlyIndex.DeclaringEntityType" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property DeclaringEntityType As IReadOnlyEntityType" />
<MemberSignature Language="F#" Value="member this.DeclaringEntityType : Microsoft.EntityFrameworkCore.Metadata.IReadOnlyEntityType" Usage="Microsoft.EntityFrameworkCore.Metadata.IReadOnlyIndex.DeclaringEntityType" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.EntityFrameworkCore</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.EntityFrameworkCore.Metadata.IReadOnlyEntityType</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the entity type the index is defined on. This may be different from the type that <see cref="P:Microsoft.EntityFrameworkCore.Metadata.IReadOnlyIndex.Properties" />
are defined on when the index is defined a derived type in an inheritance hierarchy (since the properties
may be defined on a base type).
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DisplayName">
<MemberSignature Language="C#" Value="public virtual string DisplayName ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance string DisplayName() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.EntityFrameworkCore.Metadata.IReadOnlyIndex.DisplayName" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function DisplayName () As String" />
<MemberSignature Language="F#" Value="abstract member DisplayName : unit -> string
override this.DisplayName : unit -> string" Usage="iReadOnlyIndex.DisplayName " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.EntityFrameworkCore</AssemblyName>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="efcore-7.0;efcore-8.0">
<AttributeName Language="C#">[System.Diagnostics.DebuggerStepThrough]</AttributeName>
<AttributeName Language="F#">[<System.Diagnostics.DebuggerStepThrough>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Gets the friendly display name for the given <see cref="T:Microsoft.EntityFrameworkCore.Metadata.IReadOnlyIndex" />, returning its <see cref="P:Microsoft.EntityFrameworkCore.Metadata.IReadOnlyIndex.Name" /> if one is defined,
or a string representation of its <see cref="P:Microsoft.EntityFrameworkCore.Metadata.IReadOnlyIndex.Properties" /> if this is an unnamed index.
</summary>
<returns>The display name.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="IsDescending">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IReadOnlyList<bool>? IsDescending { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IReadOnlyList`1<bool> IsDescending" />
<MemberSignature Language="DocId" Value="P:Microsoft.EntityFrameworkCore.Metadata.IReadOnlyIndex.IsDescending" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property IsDescending As IReadOnlyList(Of Boolean)" />
<MemberSignature Language="F#" Value="member this.IsDescending : System.Collections.Generic.IReadOnlyList<bool>" Usage="Microsoft.EntityFrameworkCore.Metadata.IReadOnlyIndex.IsDescending" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.EntityFrameworkCore</AssemblyName>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IReadOnlyList<System.Boolean></ReturnType>
</ReturnValue>
<Docs>
<summary>
A set of values indicating whether each corresponding index column has descending sort order.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="IsUnique">
<MemberSignature Language="C#" Value="public bool IsUnique { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool IsUnique" />
<MemberSignature Language="DocId" Value="P:Microsoft.EntityFrameworkCore.Metadata.IReadOnlyIndex.IsUnique" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property IsUnique As Boolean" />
<MemberSignature Language="F#" Value="member this.IsUnique : bool" Usage="Microsoft.EntityFrameworkCore.Metadata.IReadOnlyIndex.IsUnique" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.EntityFrameworkCore</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets a value indicating whether the values assigned to the indexed properties are unique.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Name">
<MemberSignature Language="C#" Value="public string? Name { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Name" />
<MemberSignature Language="DocId" Value="P:Microsoft.EntityFrameworkCore.Metadata.IReadOnlyIndex.Name" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Name As String" />
<MemberSignature Language="F#" Value="member this.Name : string" Usage="Microsoft.EntityFrameworkCore.Metadata.IReadOnlyIndex.Name" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.EntityFrameworkCore</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the name of this index.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Properties">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IReadOnlyList<Microsoft.EntityFrameworkCore.Metadata.IReadOnlyProperty> Properties { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IReadOnlyList`1<class Microsoft.EntityFrameworkCore.Metadata.IReadOnlyProperty> Properties" />
<MemberSignature Language="DocId" Value="P:Microsoft.EntityFrameworkCore.Metadata.IReadOnlyIndex.Properties" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Properties As IReadOnlyList(Of IReadOnlyProperty)" />
<MemberSignature Language="F#" Value="member this.Properties : System.Collections.Generic.IReadOnlyList<Microsoft.EntityFrameworkCore.Metadata.IReadOnlyProperty>" Usage="Microsoft.EntityFrameworkCore.Metadata.IReadOnlyIndex.Properties" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.EntityFrameworkCore</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IReadOnlyList<Microsoft.EntityFrameworkCore.Metadata.IReadOnlyProperty></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the properties that this index is defined on.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ToDebugString">
<MemberSignature Language="C#" Value="public virtual string ToDebugString (Microsoft.EntityFrameworkCore.Infrastructure.MetadataDebugStringOptions options = Microsoft.EntityFrameworkCore.Infrastructure.MetadataDebugStringOptions.ShortDefault, int indent = 0);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance string ToDebugString(valuetype Microsoft.EntityFrameworkCore.Infrastructure.MetadataDebugStringOptions options, int32 indent) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.EntityFrameworkCore.Metadata.IReadOnlyIndex.ToDebugString(Microsoft.EntityFrameworkCore.Infrastructure.MetadataDebugStringOptions,System.Int32)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function ToDebugString (Optional options As MetadataDebugStringOptions = Microsoft.EntityFrameworkCore.Infrastructure.MetadataDebugStringOptions.ShortDefault, Optional indent As Integer = 0) As String" />
<MemberSignature Language="F#" Value="abstract member ToDebugString : Microsoft.EntityFrameworkCore.Infrastructure.MetadataDebugStringOptions * int -> string
override this.ToDebugString : Microsoft.EntityFrameworkCore.Infrastructure.MetadataDebugStringOptions * int -> string" Usage="iReadOnlyIndex.ToDebugString (options, indent)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.EntityFrameworkCore</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="options" Type="Microsoft.EntityFrameworkCore.Infrastructure.MetadataDebugStringOptions" />
<Parameter Name="indent" Type="System.Int32" />
</Parameters>
<Docs>
<param name="options">Options for generating the string.</param>
<param name="indent">The number of indent spaces to use before each new line.</param>
<summary>
<para>
Creates a human-readable representation of the given metadata.
</para>
<para>
Warning: Do not rely on the format of the returned string.
It is designed for debugging only and may change arbitrarily between releases.
</para>
</summary>
<returns>A human-readable representation.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>