Class StructuredFieldSchema

Describes a single field of a StructuredTableSchema.

Inheritance

object

StructuredFieldSchema

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

Namespace: Serenity.Persistence.Domain.ValueObjects

Assembly: Serenity.Global.Domain.dll

Syntax

public sealed class StructuredFieldSchema

Constructors

StructuredFieldSchema(string, StructuredFieldType, int, bool, bool, bool)

Creates a new StructuredFieldSchema.

Declaration

public StructuredFieldSchema(string name, StructuredFieldType type, int maxLength = 0, bool nullable = false, bool byteOrdinalCollation = false, bool isIdentity = false)

Parameters

Type	Name	Description
string	name
StructuredFieldType	type
int	maxLength
bool	nullable
bool	byteOrdinalCollation
bool	isIdentity

Properties

ByteOrdinalCollation

Whether the field must be compared/collated byte-ordinally by backends whose default text collation would otherwise reorder identifiers case-insensitively or culture-sensitively (identifier-like string fields need this).

Declaration

public bool ByteOrdinalCollation { get; }

Property Value

Type	Description
bool

IsIdentity

Whether this field is the table's store-assigned identity column.

Declaration

public bool IsIdentity { get; }

Property Value

Type	Description
bool

MaxLength

Maximum length for String fields. Zero means unspecified.

Declaration

public int MaxLength { get; }

Property Value

Type	Description
int

Name

The field name.

Declaration

public string Name { get; }

Property Value

Type	Description
string

Nullable

Whether the field accepts Null.

Declaration

public bool Nullable { get; }

Property Value

Type	Description
bool

Type

The field's declared type.

Declaration

public StructuredFieldType Type { get; }

Property Value

Type	Description
StructuredFieldType