Class PostgreSqlIndexBuilder

Namespace

LfrlAnvil.PostgreSql.Objects.Builders

Assembly

LfrlAnvil.PostgreSql.dll

Represents an SQL index constraint builder.

public sealed class PostgreSqlIndexBuilder : SqlIndexBuilder, ISqlIndexBuilder, ISqlConstraintBuilder, ISqlObjectBuilder

Inheritance

object

SqlBuilderApi

SqlObjectBuilder

SqlConstraintBuilder

SqlIndexBuilder

PostgreSqlIndexBuilder

Implements

ISqlIndexBuilder

ISqlConstraintBuilder

ISqlObjectBuilder

Inherited Members

SqlIndexBuilder.IsUnique

SqlIndexBuilder.IsVirtual

SqlIndexBuilder.Filter

SqlIndexBuilder.CanRemove

SqlConstraintBuilder.ToString()

SqlObjectBuilder.Id

SqlObjectBuilder.Type

SqlObjectBuilder.Name

SqlObjectBuilder.IsRemoved

SqlObjectBuilder.ReferencingObjects

SqlObjectBuilder.GetHashCode()

SqlObjectBuilder.Remove()

SqlObjectBuilder.ThrowIfRemoved()

SqlObjectBuilder.ThrowIfReferenced()

object.Equals(object)

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Extension Methods

PostgreSqlObjectExtensions.SetFilter(PostgreSqlIndexBuilder, Func<SqlTableBuilderNode, SqlConditionNode?>)

PostgreSqlObjectExtensions.ForPostgreSql(ISqlIndexBuilder, Action<PostgreSqlIndexBuilder>)

Remarks

PostgreSqlDialect implementation.

Properties

Columns

Collection of columns that define this index.

public SqlIndexBuilderColumns<PostgreSqlColumnBuilder> Columns { get; }

Property Value

SqlIndexBuilderColumns<PostgreSqlColumnBuilder>

Database

Database that this object belongs to.

public PostgreSqlDatabaseBuilder Database { get; }

Property Value

PostgreSqlDatabaseBuilder

PrimaryKey

Optional ISqlPrimaryKeyBuilder instance attached to this index.

public PostgreSqlPrimaryKeyBuilder? PrimaryKey { get; }

Property Value

PostgreSqlPrimaryKeyBuilder

ReferencedColumns

Collection of columns referenced by this index's Columns.

public SqlObjectBuilderArray<PostgreSqlColumnBuilder> ReferencedColumns { get; }

Property Value

SqlObjectBuilderArray<PostgreSqlColumnBuilder>

ReferencedFilterColumns

Collection of columns referenced by this index's Filter.

public SqlObjectBuilderArray<PostgreSqlColumnBuilder> ReferencedFilterColumns { get; }

Property Value

SqlObjectBuilderArray<PostgreSqlColumnBuilder>

Table

Table that this constraint is attached to.

public PostgreSqlTableBuilder Table { get; }

Property Value

PostgreSqlTableBuilder

Methods

MarkAsUnique(bool)

Changes IsUnique value of this index.

public PostgreSqlIndexBuilder MarkAsUnique(bool enabled = true)

Parameters

enabled bool

Value to set. Equal to true by default.

Returns

PostgreSqlIndexBuilder

this.

Exceptions

SqlObjectBuilderException

When uniqueness cannot be changed.

MarkAsVirtual(bool)

Changes IsVirtual value of this index.

public PostgreSqlIndexBuilder MarkAsVirtual(bool enabled = true)

Parameters

enabled bool

Value to set. Equal to true by default.

Returns

PostgreSqlIndexBuilder

this.

Exceptions

SqlObjectBuilderException

When virtuality cannot be changed.

SetDefaultName()

Changes the name of this object to a default name.

public PostgreSqlIndexBuilder SetDefaultName()

Returns

PostgreSqlIndexBuilder

this.

Remarks

See ISqlDefaultObjectNameProvider for more information.

Exceptions

SqlObjectBuilderException

When name cannot be changed.

SetFilter(SqlConditionNode?)

Changes Filter value of this index.

public PostgreSqlIndexBuilder SetFilter(SqlConditionNode? filter)

Parameters

filter SqlConditionNode

Value to set.

Returns

PostgreSqlIndexBuilder

this.

Exceptions

SqlObjectBuilderException

When filter cannot be changed.

SetName(string)

Changes the name of this object.

public PostgreSqlIndexBuilder SetName(string name)

Parameters

name string

Name to set.

Returns

PostgreSqlIndexBuilder

this.

Exceptions

SqlObjectBuilderException

When name cannot be changed.