Column Class

Article
08/11/2014

The Column object represents a SQL Server column.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Management.Smo.SmoObjectBase
    Microsoft.SqlServer.Management.Smo.SqlSmoObject
      Microsoft.SqlServer.Management.Smo.NamedSmoObject
        Microsoft.SqlServer.Management.Smo.ScriptNameObjectBase
          Microsoft.SqlServer.Management.Smo.Column

Namespace: Microsoft.SqlServer.Management.Smo
Assembly: Microsoft.SqlServer.Smo (in Microsoft.SqlServer.Smo.dll)

Syntax

'Declaration
Public NotInheritable Class Column _
    Inherits ScriptNameObjectBase _
    Implements ISfcSupportsDesignMode, ICreatable, IAlterable, IDroppable,  _
    IMarkForDrop, IExtendedProperties, IRenamable
'Usage
Dim instance As Column

public sealed class Column : ScriptNameObjectBase, 
    ISfcSupportsDesignMode, ICreatable, IAlterable, IDroppable, IMarkForDrop, 
    IExtendedProperties, IRenamable

public ref class Column sealed : public ScriptNameObjectBase, 
    ISfcSupportsDesignMode, ICreatable, IAlterable, IDroppable, IMarkForDrop, 
    IExtendedProperties, IRenamable

[<SealedAttribute>]
type Column =  
    class 
        inherit ScriptNameObjectBase 
        interface ISfcSupportsDesignMode 
        interface ICreatable 
        interface IAlterable 
        interface IDroppable 
        interface IMarkForDrop 
        interface IExtendedProperties 
        interface IRenamable 
    end

public final class Column extends ScriptNameObjectBase implements ISfcSupportsDesignMode, ICreatable, IAlterable, IDroppable, IMarkForDrop, IExtendedProperties, IRenamable

The Column type exposes the following members.

Constructors

	Name	Description
	Column()	Initializes a new instance of the Column class.
	Column(SqlSmoObject, String)	Initializes a new instance of the Column class that has the specified parent and specified name.
	Column(SqlSmoObject, String, DataType)	Initializes a new instance of the Column class that has the specified parent and specified name.
	Column(SqlSmoObject, String, DataType, Boolean)	Initializes a new instance of the Column class that uses the specified parent, datayype, and optionally adding the FILESTREAM attribute.

Top

Properties

	Name	Description
	AnsiPaddingStatus	Gets a Boolean property value that specifies whether the ANSI_PADDING_ENABLED column option is active.
	Collation	Gets or sets the default collation that is used by the column.
	Computed	Gets the Boolean property value that specifies whether the column is the product of computed expression
	ComputedText	Gets or sets the Transact-SQL expression that is used to generate the value of a computed column
	DataType	Gets or sets the data type that is assigned to the column.
	Default	Gets or sets the default bound to the column.
	DefaultConstraint	Gets a default value for the column.
	DefaultSchema	Gets or sets the default schema that is bound to the column.
	ExtendedProperties	Represents a collection of ExtendedProperty objects. Each ExtendedProperty object represents an extended property for the Column object.
	ID	Gets the column ID that uniquely identifies the column.
	Identity	Gets or sets the Boolean property value that specifies whether the column is an identity column.
	IdentityIncrement	Gets or sets the identity increment for an identity column.
	IdentitySeed	Gets or sets the identity seed for an identity column.
	InPrimaryKey	Gets the Boolean property value that specifies whether the column is included in the definition of a primary key or unique key constraint.
	IsColumnSet	Gets or sets a Boolean value that specifies whether the column is a sparse column that is a member of a column set.
	IsDeterministic	Gets or sets the Boolean property value that specifies whether the value of a computed column can change in subsequent invocations.
	IsFileStream	Gets a boolean value that represents the FILESTREAM attribute of the column.
	IsForeignKey	Gets the Boolean property value that specifies whether the column is a foreign key.
	IsFullTextIndexed	Gets the Boolean property value that specifies whether the column participates in a full-text index.
	IsPersisted	Gets the Boolean property value that specifies whether the computed value of the Column object is saved with the data, thus avoiding a computation each time the column is accessed.
	IsPrecise	Gets or sets the Boolean property value that specifies whether a computed column is a precise value.
	IsSparse	Gets or sets the Boolean property value that specifies whether this is a sparse column. For more information about sparse columns, see Use Sparse Columns.
	Name	Gets or sets a String value that specifies the name of the column. (Overrides NamedSmoObject.Name.)
	NotForReplication	Gets the Boolean property value that specifies whether the column is participating in replication.
	Nullable	Gets or sets the Boolean property value that specifies whether the column can accept null values.
	Parent	Gets the SqlSmoObject object that is the parent of the Column object.
	Properties	Gets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
	RowGuidCol	Gets or sets the Boolean property value that specifies whether the column is automatically updated with a unique GUID value.
	Rule	Gets or sets the rule that is bound to the column.
	RuleSchema	Gets or sets the rule schema that is bound to the column.
	State	Gets the state of the referenced object. (Inherited from SmoObjectBase.)
	StatisticalSemantics	Gets or sets a value to indicate whether a column has been enabled for Semantic Extraction and Indexing.
	Urn	Gets the Uniform Resource Name (URN) address value that uniquely identifies the object. (Inherited from SqlSmoObject.)
	UserData	Gets or sets user-defined data associated with the referenced object. (Inherited from SmoObjectBase.)

Top

Methods

	Name	Description
	AddDefaultConstraint()	Adds a default constraint to the column.
	AddDefaultConstraint(String)	Adds a default constraint to the column.
	Alter	Updates any Column object property changes on the instance of SQL Server.
	BindDefault	Binds a default to the column.
	BindRule	Binds a rule to the column.
	Create	Creates a column on the instance of Microsoft SQL Server as defined by the Column object.
	Discover	Discovers a list of type Object. (Inherited from SqlSmoObject.)
	Drop	Drops the column.
	EnumForeignKeys	Enumerates a list of foreign keys that reference the column.
	EnumIndexes	Enumerates a list of indexes that include the column.
	EnumUserPermissions	Enumerates a list of permissions for a specified user.
	Equals	(Inherited from Object.)
	FormatSqlVariant	Formats an object as SqlVariant type. (Inherited from SqlSmoObject.)
	GetContextDB	Gets the context database that is associated with this object. (Inherited from SqlSmoObject.)
	GetDBName	Gets the database name that is associated with the object. (Inherited from SqlSmoObject.)
	GetHashCode	(Inherited from Object.)
	GetPropValue	Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetPropValueOptional	Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetPropValueOptionalAllowNull	Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetServerObject	Gets the server of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetType	(Inherited from Object.)
	Initialize()	Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
	Initialize(Boolean)	Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
	IsObjectInitialized	Verifies whether the object has been initialized. (Inherited from SqlSmoObject.)
	IsObjectInSpace	Verifies whether the object is isolated or connected to the instance of SQL Server. (Inherited from SqlSmoObject.)
	MarkForDrop	Marks the column to be dropped when the Alter method is run on the column's parent Table object.
	Refresh	Refreshes the Column object properties. (Overrides ScriptNameObjectBase.Refresh().)
	Rename	Renames the column.
	SetParentImpl	Sets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.)
	ToString	Returns a String that represents the referenced object. (Inherited from SqlSmoObject.)
	UnbindDefault	Unbinds the currently bound default from the column.
	UnbindRule	Unbinds the currently bound rule from the column.
	UpdateStatistics()	Updates Statistic objects that monitor this column.
	UpdateStatistics(StatisticsScanType)	Updates Statistic objects that monitor this column.
	UpdateStatistics(StatisticsScanType, Int32)	Updates Statistic objects that monitor this column using a sampled scan.
	UpdateStatistics(StatisticsScanType, Int32, Boolean)	Updates Statistic objects that monitor this column using a sampled scan.
	Validate	Validates the state of an object. (Inherited from SmoObjectBase.)

Top

Events

	Name	Description
	PropertyChanged	Represents the event that occurs when a property is changed. (Inherited from SqlSmoObject.)
	PropertyMetadataChanged	Represents the event that occurs when property metadata changes. (Inherited from SqlSmoObject.)

Top

Explicit Interface Implementations

	Name	Description
	IAlienObject.Discover	Discovers any dependencies. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
	IAlienObject.GetDomainRoot	Returns the root of the domain. (Inherited from SqlSmoObject.)
	IAlienObject.GetParent	Gets the parent of this object. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
	IAlienObject.GetPropertyType	Gets the type of the specified property. (Inherited from SqlSmoObject.)
	IAlienObject.GetPropertyValue	Gets the value of the specified property. (Inherited from SqlSmoObject.)
	IAlienObject.GetUrn	Gets the Unified Resource Name (URN) of the object. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
	IAlienObject.Resolve	Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. (Inherited from SqlSmoObject.)
	IAlienObject.SetObjectState	Sets the object state to the specified SfcObjectState value. (Inherited from SqlSmoObject.)
	IAlienObject.SetPropertyValue	Sets the property value. (Inherited from SqlSmoObject.)
	ISfcPropertyProvider.GetPropertySet	Gets the interface reference to the set of properties of this object. (Inherited from SqlSmoObject.)
	ISfcSupportsDesignMode.IsDesignMode	Gets a Boolean value that specifies whether the column supports design mode.

Top

Remarks

To get Column object properties, users can be a member of the public fixed server role.

To do any of the following, users must have ALTER permission on the parent table, or be a member of the db_owner fixed database role:

Set Column object properties and run the Alter method
Create a column
Drop a column

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are safe for multithreaded operations. Any instance members are not guaranteed to be thread safe.

Examples

Working with Database Objects

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Column Class

Inheritance Hierarchy

Syntax

Constructors

Properties

Methods

Events

Explicit Interface Implementations

Remarks

Thread Safety

Examples

Thread Safety

See Also

Reference

Other Resources

Additional resources