This topic has not yet been rated - Rate this topic

Column Class

The Column object represents a SQL Server column.

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

C++

JScript

Copy


public sealed class Column : ScriptNameObjectBase, 
	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.
	ExecuteForScalar	Gets or sets the Boolean property value that specifies whether the object is set to the execute for scalar option. (Inherited from SqlSmoObject.)
	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 System.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.
	IsTouched	Gets the Boolean property value that specifies whether the object properties have been updated but not yet persisted on the server. (Inherited from SqlSmoObject.)
	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.
	ObjectInSpace	Gets the Boolean property value that specifies whether the object exists in isolation, or whether it is directly or indirectly connected to the instance of SQL Server. (Inherited from SqlSmoObject.)
	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.
	ScalarResult	Gets the scalar result for the referenced object. (Inherited from SqlSmoObject.)
	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
	AddDatabaseContext	Add the database context to the collection of queries identified by the queries parameter. (Inherited from SqlSmoObject.)
	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.
	AlterImpl	Activates the object altered event. (Inherited from SqlSmoObject.)
	AlterImplWorker	Calls the Alter methods. (Inherited from SqlSmoObject.)
	AppendCommaText	Appends text, optionally separated by a comma. (Inherited from ScriptNameObjectBase.)
	AppendWithCommaText	Appends text, optionally separated by a comma. (Inherited from ScriptNameObjectBase.)
	AppendWithOption	Appends text and option text separated from the main text with a “WITH” string and optionally separated by a comma. (Inherited from ScriptNameObjectBase.)
	AutoGenerateName	Generates a name based on the object Guid. (Inherited from ScriptNameObjectBase.)
	BindDefault	Binds a default to the column.
	BindDefaultImpl	Binds the default items identified by the parameters. (Inherited from SqlSmoObject.)
	BindRule	Binds a rule to the column.
	BindRuleImpl	Binds the rule schema to the rule and columns identified by the parameters. (Inherited from SqlSmoObject.)
	CheckObjectDirty	Checks whether object has been modified and not persisted. (Inherited from ScriptNameObjectBase.)
	CheckObjectState()	Validates the state of the referenced object. (Inherited from SqlSmoObject.)
	CheckObjectState(Boolean)	Validates the state of the referenced object with the option to specify that an exception is thrown if the object is not yet created. (Inherited from SqlSmoObject.)
	CheckObjectStateImpl	Checks the state of a SqlSmoObject. (Inherited from SqlSmoObject.)
	CheckTextCorectness	Checks text for correctness against the parameters. (Inherited from ScriptNameObjectBase.)
	CheckTextModeSupport	Checks mode of support. (Inherited from ScriptNameObjectBase.)
	CheckVersion100	Checks whether version of SQL Server is SQL Server 2008. (Inherited from SqlSmoObject.)
	CheckVersion110()	Checks whether version of SQL Server is SQL Server 2012. (Inherited from SqlSmoObject.)
	CheckVersion110(String)	Checks whether the version of SQL Server is SQL Server 2012 with the specified name. (Inherited from SqlSmoObject.)
	CheckVersion80	Checks the validity of the object on SQL Server 2000. (Inherited from SqlSmoObject.)
	CheckVersion80SP3	Checks the validity of the object on SQL Server 2000 SP3. (Inherited from SqlSmoObject.)
	CheckVersion90	Check the validity of the object on SQL Server 2005. (Inherited from SqlSmoObject.)
	CheckVersionBelow110	Checks whether version of SQL Server is before SQL Server 2012. (Inherited from SqlSmoObject.)
	CheckVersionBelow90	Checks whether version of SQL Server is before SQL Server 2005. (Inherited from SqlSmoObject.)
	CleanObject	Cleans the referenced object. (Inherited from ScriptNameObjectBase.)
	Create	Creates a column on the instance of Microsoft SQL Server as defined by the Column object.
	CreateImpl	Creates an object with scripting options. (Inherited from SqlSmoObject.)
	Discover	Discovers a list of type Object. (Inherited from SqlSmoObject.)
	Drop	Drops the column.
	DropImpl	Drops a SqlSmoObject. (Inherited from SqlSmoObject.)
	DropImplWorker	Calls the drop methods. (Inherited from SqlSmoObject.)
	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.)
	ExecuteNonQuery	Executes a batch of statements that does not return a result set. (Inherited from SqlSmoObject.)
	ExecuteRenameQuery	Executes the rename query for the object. (Inherited from NamedSmoObject.)
	Finalize	(Inherited from Object.)
	ForceTextModeOnTextBody	Enforces text mode on the text body. (Inherited from ScriptNameObjectBase.)
	FormatSqlVariant	Formats an object as Microsoft.Data.Schema.Sql.DataGenerator.SqlVariant type. (Inherited from SqlSmoObject.)
	GenerateAlterEvent()	Generates the alter event with the specified value. (Inherited from SqlSmoObject.)
	GenerateAlterEvent(Urn, Object)	Generates alter event with the specified URN and inner object value. (Inherited from SqlSmoObject.)
	GetBraketNameForText	Gets the bracket name for the text. (Inherited from ScriptNameObjectBase.)
	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.)
	GetFragOptionString	Gets a FragmentationOption object as a string value. (Inherited from SqlSmoObject.)
	GetHashCode	(Inherited from Object.)
	GetIsSystemNamed	Gets a Boolean value that specifies whether the system is named. (Inherited from ScriptNameObjectBase.)
	GetIsTextDirty	Determines whether the text value is consistent with stored value. (Inherited from ScriptNameObjectBase.)
	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.)
	GetRealValue	Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetServerName	Gets the name of the instance of SQL Server with which the object is associated. (Inherited from SqlSmoObject.)
	GetServerObject	Gets the server of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetSqlServerVersionName	Gets the version name of the instance of SQL Server with which the object is associated. (Inherited from SqlSmoObject.)
	GetTextBody()	Returns the text body. (Inherited from ScriptNameObjectBase.)
	GetTextBody(Boolean)	Returns the text body. (Inherited from ScriptNameObjectBase.)
	GetTextHeader	Returns the text header. (Inherited from ScriptNameObjectBase.)
	GetTextMode	Determines whether the script name is using text mode. (Inherited from ScriptNameObjectBase.)
	GetTextProperty	Gets the text of the object, if not available, throw appropriate exception based on the state of the object. (Inherited from ScriptNameObjectBase.)
	GetType	(Inherited from Object.)
	GetUrnRecursive(StringBuilder)	Assigns an Urn object of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetUrnRecursive(StringBuilder, UrnIdOption)	Assigns an Urn object of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	ImplInitialize	Initializes the fields of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	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.)
	IsObjectDirty	Determines whether the referenced object is consistent with the stored object. (Inherited from ScriptNameObjectBase.)
	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.)
	IsVersion80SP3	Determines whether the version of SQL Server is SQL Server 2000 with SP3. (Inherited from SqlSmoObject.)
	IsVersion90AndAbove	Determines whether the version of SQL Server is SQL Server 2005 or later. (Inherited from SqlSmoObject.)
	MarkDropped	Sets the SqlSmoState to dropped. (Inherited from SqlSmoObject.)
	MarkForDrop	Marks the column to be dropped when the Alter method is run on the column's parent Table object.
	MarkForDropImpl	Sets the SqlSmoState for drop operation. (Inherited from SqlSmoObject.)
	MemberwiseClone	(Inherited from Object.)
	PostAlter	The method that is activated after the SqlSmoObject is altered. (Inherited from SqlSmoObject.)
	PostCreate	The method that is activated after the SqlSmoObject is created. (Inherited from SqlSmoObject.)
	PostDrop	The method that is activated after the SqlSmoObject is dropped. (Inherited from SqlSmoObject.)
	Refresh	Refreshes the Column object properties. (Overrides ScriptNameObjectBase.Refresh().)
	Rename	Renames the column.
	RenameImpl	This method supports the SMO infrastructure and is not intended to be used directly from your code. (Inherited from NamedSmoObject.)
	RenameImplWorker	Identified for informational purposes only. Not supported. Future compatibility is not guaranteed. (Inherited from NamedSmoObject.)
	ScriptImpl()	Gets a collection of scripts of the SqlSmoObject. (Inherited from SqlSmoObject.)
	ScriptImpl(ScriptingOptions)	Gets a collection of scripts of the SqlSmoObject. (Inherited from SqlSmoObject.)
	SetCollectionTextMode	Sets the collection text mode. (Inherited from ScriptNameObjectBase.)
	SetIsSystemNamed	Sets a Boolean value that specifies whether the system is named. (Inherited from ScriptNameObjectBase.)
	SetParentImpl	Sets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.)
	SetSchemaOwned	Sets the schema owned value. (Inherited from NamedSmoObject.)
	SetTextBody	Specifies the text body. (Inherited from ScriptNameObjectBase.)
	SetTextHeader	Specifies the text header. (Inherited from ScriptNameObjectBase.)
	SetTextMode	Specifies the text mode. (Inherited from ScriptNameObjectBase.)
	SwitchTextMode	Switches the text mode. (Inherited from ScriptNameObjectBase.)
	ThrowIfTextIsDirtyForAlter	Throws an exception of text has been modified and not persisted. (Inherited from ScriptNameObjectBase.)
	ToString	Returns a String that represents the referenced object. (Inherited from SqlSmoObject.)
	TouchImpl	Not implemented. (Inherited from SqlSmoObject.)
	UnbindDefault	Unbinds the currently bound default from the column.
	UnbindDefaultImpl	Unbinds the default columns of the SqlSmoObject. (Inherited from SqlSmoObject.)
	UnbindRule	Unbinds the currently bound rule from the column.
	UnbindRuleImpl	Unbinds rules of the SqlSmoObject. (Inherited from SqlSmoObject.)
	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

Fields

	Name	Description
	m_ExtendedProperties	Represents a property that is defined to extend the properties provided by a SqlSmoObject. (Inherited from SqlSmoObject.)
	singletonParent	Represents the singleton parent. (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.

Reference

Microsoft.SqlServer.Management.Smo Namespace

Other Resources

CREATE TABLE (Transact-SQL)

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)

Community Content Add

FAQ