Class MySQLIndexExtensions

Extension methods for Microsoft.EntityFrameworkCore.Metadata.IIndex for MySQL specific metadata.

Inheritance

System.Object

MySQLIndexExtensions

Namespace: MySql.EntityFrameworkCore.Extensions

Assembly: MySql.EntityFrameworkCore.dll

Version: 9.3.0

Syntax

public static class MySQLIndexExtensions

Methods

FullTextParser(IIndex)

Returns a value indicating which full text parser to use.

Declaration

public static string FullTextParser(this IIndex index)

Parameters

Type	Name	Description
Microsoft.EntityFrameworkCore.Metadata.IIndex	index	The index.

Returns

Type	Description
System.String	The name of the full text parser.

GetFullTextParserConfigurationSource(IConventionIndex)

Returns the Microsoft.EntityFrameworkCore.Metadata.ConfigurationSource for whether the index is full text.

Declaration

public static ConfigurationSource? GetFullTextParserConfigurationSource(this IConventionIndex property)

Parameters

Type	Name	Description
Microsoft.EntityFrameworkCore.Metadata.IConventionIndex	property	The property.

Returns

Type	Description
System.Nullable<Microsoft.EntityFrameworkCore.Metadata.ConfigurationSource>	The Microsoft.EntityFrameworkCore.Metadata.ConfigurationSource for whether the index is full text.

GetIsFullTextConfigurationSource(IConventionIndex)

Returns the Microsoft.EntityFrameworkCore.Metadata.ConfigurationSource for whether the index is full text.

Declaration

public static ConfigurationSource? GetIsFullTextConfigurationSource(this IConventionIndex property)

Parameters

Type	Name	Description
Microsoft.EntityFrameworkCore.Metadata.IConventionIndex	property	The property.

Returns

Type	Description
System.Nullable<Microsoft.EntityFrameworkCore.Metadata.ConfigurationSource>	The Microsoft.EntityFrameworkCore.Metadata.ConfigurationSource for whether the index is full text.

GetIsSpatialConfigurationSource(IConventionIndex)

Indicates whether the index is spatial.

Declaration

public static ConfigurationSource? GetIsSpatialConfigurationSource(this IConventionIndex property)

Parameters

Type	Name	Description
Microsoft.EntityFrameworkCore.Metadata.IConventionIndex	property	The property.

Returns

Type	Description
System.Nullable<Microsoft.EntityFrameworkCore.Metadata.ConfigurationSource>	The Microsoft.EntityFrameworkCore.Metadata.ConfigurationSource to show if the index is spartial.

GetPrefixLengthConfigurationSource(IConventionIndex)

Returns the Microsoft.EntityFrameworkCore.Metadata.ConfigurationSource for prefix lengths of the index.

Declaration

public static ConfigurationSource? GetPrefixLengthConfigurationSource(this IConventionIndex property)

Parameters

Type	Name	Description
Microsoft.EntityFrameworkCore.Metadata.IConventionIndex	property	The property.

Returns

Type	Description
System.Nullable<Microsoft.EntityFrameworkCore.Metadata.ConfigurationSource>	The Microsoft.EntityFrameworkCore.Metadata.ConfigurationSource for prefix lengths of the index.

IsFullText(IIndex)

Returns a value indicating whether the index is full text.

Declaration

public static bool? IsFullText(this IIndex index)

Parameters

Type	Name	Description
Microsoft.EntityFrameworkCore.Metadata.IIndex	index	The index.

Returns

Type	Description
System.Nullable<System.Boolean>	true if the index is clustered; otherwise, false.

IsSpatial(IIndex)

Returns a value indicating whether the index is spartial.

Declaration

public static bool? IsSpatial(this IIndex index)

Parameters

Type	Name	Description
Microsoft.EntityFrameworkCore.Metadata.IIndex	index	The index.

Returns

Type	Description
System.Nullable<System.Boolean>	true if the index is clustered; otherwise, false

PrefixLength(IIndex)

Returns prefix lengths for the index.

Declaration

public static int[] PrefixLength(this IIndex index)

Parameters

Type	Name	Description
Microsoft.EntityFrameworkCore.Metadata.IIndex	index	The index.

Returns

Type	Description
System.Int32[]	The prefix lengths. A value of 0 indicates, that the full length should be used for that column.

SetFullTextParser(IConventionIndex, String, Boolean)

Sets a value indicating which full text parser to be used.

Declaration

public static string SetFullTextParser(this IConventionIndex index, string value, bool fromDataAnnotation = false)

Parameters

Type	Name	Description
Microsoft.EntityFrameworkCore.Metadata.IConventionIndex	index	The index.
System.String	value	The value to set.
System.Boolean	fromDataAnnotation	Indicates whether the configuration was specified using a data annotation.

Returns

Type	Description
System.String

SetFullTextParser(IMutableIndex, String)

Sets a value indicating which full text parser to be used.

Declaration

public static void SetFullTextParser(this IMutableIndex index, string value)

Parameters

Type	Name	Description
Microsoft.EntityFrameworkCore.Metadata.IMutableIndex	index	The index.
System.String	value	The value to set.

SetIsFullText(IConventionIndex, Nullable<Boolean>, Boolean)

Sets a value indicating whether the index is full text.

Declaration

public static void SetIsFullText(this IConventionIndex index, bool? value, bool fromDataAnnotation = false)

Parameters

Type	Name	Description
Microsoft.EntityFrameworkCore.Metadata.IConventionIndex	index	The index.
System.Nullable<System.Boolean>	value	The value to set.
System.Boolean	fromDataAnnotation	Indicates whether the configuration was specified using a data annotation.

SetIsFullText(IMutableIndex, Nullable<Boolean>)

Sets a value indicating whether the index is full text.

Declaration

public static void SetIsFullText(this IMutableIndex index, bool? value)

Parameters

Type	Name	Description
Microsoft.EntityFrameworkCore.Metadata.IMutableIndex	index	The index.
System.Nullable<System.Boolean>	value	The value to set.

SetIsSpatial(IConventionIndex, Nullable<Boolean>, Boolean)

Sets a value indicating whether the index is spartial.

Declaration

public static void SetIsSpatial(this IConventionIndex index, bool? value, bool fromDataAnnotation = false)

Parameters

Type	Name	Description
Microsoft.EntityFrameworkCore.Metadata.IConventionIndex	index	The index.
System.Nullable<System.Boolean>	value	The value to set.
System.Boolean	fromDataAnnotation	Indicates whether the configuration was specified using a data annotation.

SetIsSpatial(IMutableIndex, Nullable<Boolean>)

Sets a value indicating whether the index is spartial.

Declaration

public static void SetIsSpatial(this IMutableIndex index, bool? value)

Parameters

Type	Name	Description
Microsoft.EntityFrameworkCore.Metadata.IMutableIndex	index	The index.
System.Nullable<System.Boolean>	value	The value to set.

SetPrefixLength(IConventionIndex, Int32[], Boolean)

Sets prefix lengths for the index.

Declaration

public static int[] SetPrefixLength(this IConventionIndex index, int[] values, bool fromDataAnnotation = false)

Parameters

Type	Name	Description
Microsoft.EntityFrameworkCore.Metadata.IConventionIndex	index	The index.
System.Int32[]	values	The prefix lengths to set. A value of 0 indicates, that the full length should be used for that column.
System.Boolean	fromDataAnnotation	Indicates whether the configuration was specified using a data annotation.

Returns

Type	Description
System.Int32[]

SetPrefixLength(IMutableIndex, Int32[])

Sets prefix lengths for the index.

Declaration

public static void SetPrefixLength(this IMutableIndex index, int[] values)

Parameters

Type	Name	Description
Microsoft.EntityFrameworkCore.Metadata.IMutableIndex	index	The index.
System.Int32[]	values	The prefix lengths to set. A value of 0 indicates, that the full length should be used for that column.