Class EntitySchemaIndex
Индекс схемы.
Inherited Members
Namespace: Terrasoft.Core.Entities
Assembly: Terrasoft.Core.dll
Syntax
[MetaType("{50F857F9-0AAB-43f1-B83B-25C09A03EC5F}")]
public class EntitySchemaIndex : MetaItem, IMetaItem, IMetaDataSerializable, ICloneable
Constructors
EntitySchemaIndex()
Инициализирует новый экземпляр EntitySchemaIndex.
Declaration
public EntitySchemaIndex()
EntitySchemaIndex(EntitySchemaIndex, Boolean)
Initializes a clone instance of the EntitySchemaIndex.
Declaration
public EntitySchemaIndex(EntitySchemaIndex source, bool isSchemaExtendParent = false)
Parameters
Type | Name | Description |
---|---|---|
EntitySchemaIndex | source | The EntitySchemaIndex object, which will be cloned. |
System.Boolean | isSchemaExtendParent | Flag that indicates whether index will be created in the extended or inherited schemes. |
Properties
Columns
Коллекция колонок индекса.
Declaration
[MetaTypeProperty("{63B80D74-A95A-4c7f-AC6F-A1E62D1C9A34}")]
public EntitySchemaIndexColumnCollection Columns { get; }
Property Value
Type | Description |
---|---|
EntitySchemaIndexColumnCollection |
GetIndexPrefix
Declaration
public static Func<EntitySchemaColumn, string> GetIndexPrefix { get; set; }
Property Value
Type | Description |
---|---|
System.Func<EntitySchemaColumn, System.String> |
IsAutoName
Признак автоматического присвоения имени индексу.
Declaration
[MetaTypeProperty("{F3BA1C56-CBAC-4a2d-A295-0FEC1997245A}")]
public bool IsAutoName { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
IsClustered
Определяет, является ли индекс кластерным, то есть содержащим значения индексируемых колонок.
Declaration
[MetaTypeProperty("{BFE98DC4-5462-4d7a-8547-5B1D3EC49AB8}")]
public bool IsClustered { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
IsInherited
Признак, является ли индекс унаследованным.
Declaration
public bool IsInherited { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
IsUnique
Определяет, является ли индекс уникальным.
Declaration
[MetaTypeProperty("{4C56168C-83B0-407c-902A-8C28ED1C1AF0}")]
public bool IsUnique { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
Name
Имя индекса схемы.
Declaration
public override string Name { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Overrides
NamePrefix
Префикс.
Declaration
public override string NamePrefix { get; }
Property Value
Type | Description |
---|---|
System.String |
Overrides
ParentCollection
Родительская коллекция.
Declaration
public EntitySchemaIndexCollection ParentCollection { get; }
Property Value
Type | Description |
---|---|
EntitySchemaIndexCollection |
ParentMetaSchema
Родительский объект, содержащий индекс.
Declaration
public override IMetaSchema ParentMetaSchema { get; set; }
Property Value
Type | Description |
---|---|
IMetaSchema |
Overrides
UId
Идентификатор индекса схемы.
Declaration
[DBMetaTypeProperty(DBMetaInfoItemType.Index, typeof(GuidDBMetaTypeConverter))]
public override Guid UId { get; set; }
Property Value
Type | Description |
---|---|
System.Guid |
Overrides
Methods
ApplyMetaDataValue(DataReader)
Вычитка значений свойств индекса схемы из метаданных с помощью заданного DataReader.
Declaration
protected override void ApplyMetaDataValue(DataReader reader)
Parameters
Type | Name | Description |
---|---|---|
DataReader | reader | Экземпляр |
Overrides
Clone()
Возвращает клон текущего индекса схемы.
Declaration
public override object Clone()
Returns
Type | Description |
---|---|
System.Object | Клон текущего индекса схемы. |
Overrides
GetIndexName(EntitySchema, EntitySchemaColumn)
Возвращает сформированное уникальное имя индекса по колонке таблицы базы данных, которое включает в себя префикс, идентификатор схемы, идентификатор колонки.
Declaration
public static string GetIndexName(EntitySchema schema, EntitySchemaColumn column)
Parameters
Type | Name | Description |
---|---|---|
EntitySchema | schema | Экземпляр EntitySchema, по которому определяется идентификатор схемы, участвующий в формировании имени индекса. |
EntitySchemaColumn | column | Экземпляр EntitySchemaColumn, по которой определяются дополнительные параметры для формирования имени индекса. |
Returns
Type | Description |
---|---|
System.String | Строка, представляющая уникальное имя индекса таблицы базы данных. |
WriteMetaData(DataWriter)
Осуществляет запись метаданных индекса схемы с помощью заданного экземпляра DataWriter.
Declaration
public override void WriteMetaData(DataWriter writer)
Parameters
Type | Name | Description |
---|---|---|
DataWriter | writer | Экземпляр DataWriter, с помощью которого записываются метаданные индекса. |