Dela via

  • Artikel

Column Class

The Column object represents a SQL Server 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
Public method Column() Initializes a new instance of the Column class.
Public method Column(SqlSmoObject, String) Initializes a new instance of the Column class that has the specified parent and specified name.
Public method Column(SqlSmoObject, String, DataType) Initializes a new instance of the Column class that has the specified parent and specified name.
Public method 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
Public property AnsiPaddingStatus Gets a Boolean property value that specifies whether the ANSI_PADDING_ENABLED column option is active.
Public property Collation Gets or sets the default collation that is used by the column.
Public property Computed Gets the Boolean property value that specifies whether the column is the product of computed expression
Public property ComputedText Gets or sets the Transact-SQL expression that is used to generate the value of a computed column
Public property DataType Gets or sets the data type that is assigned to the column.
Public property Default Gets or sets the default bound to the column.
Public property DefaultConstraint Gets a default value for the column.
Public property DefaultSchema Gets or sets the default schema that is bound to the column.
Protected property ExecuteForScalar Gets or sets the Boolean property value that specifies whether the object is set to the execute for scalar option. (Inherited from SqlSmoObject.)
Public property ExtendedProperties Represents a collection of ExtendedProperty objects. Each ExtendedProperty object represents an extended property for the Column object.
Public property ID Gets the column ID that uniquely identifies the column.
Public property Identity Gets or sets the Boolean property value that specifies whether the column is an identity column.
Public property IdentityIncrement Gets or sets the identity increment for an identity column.
Public property IdentitySeed Gets or sets the identity seed for an identity column.
Public property InPrimaryKey Gets the Boolean property value that specifies whether the column is included in the definition of a primary key or unique key constraint.
Public property IsColumnSet Gets or sets the Boolean property value that specifies whether the column has been set.
Public property IsDeterministic Gets or sets the Boolean property value that specifies whether the value of a computed column can change in subsequent invocations.
Public property IsFileStream Gets a boolean value that represents the FILESTREAM attribute of the column.
Public property IsForeignKey Gets the Boolean property value that specifies whether the column is a foreign key.
Public property IsFullTextIndexed Gets the Boolean property value that specifies whether the column participates in a full-text index.
Public property 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.
Public property IsPrecise Gets or sets the Boolean property value that specifies whether a computed column is a precise value.
Public property IsSparse Gets or sets the Boolean property value that specifies whether the column value is sparse.
Protected property 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.)
Public property Name Gets or sets a String value that specifies the name of the column. (Overrides NamedSmoObject.Name.)
Public property NotForReplication Gets the Boolean property value that specifies whether the column is participating in replication.
Public property Nullable Gets or sets the Boolean property value that specifies whether the column can accept null values.
Protected property 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.)
Public property Parent Gets the SqlSmoObject object that is the parent of the Column object.
Public property Properties Gets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
Public property RowGuidCol Gets or sets the Boolean property value that specifies whether the column is automatically updated with a unique GUID value.
Public property Rule Gets or sets the rule that is bound to the column.
Public property RuleSchema Gets or sets the rule schema that is bound to the column.
Protected property ScalarResult Gets the scalar result for the referenced object. (Inherited from SqlSmoObject.)
Public property State Gets the state of the referenced object. (Inherited from SmoObjectBase.)
Public property Urn Gets the Uniform Resource Name (URN) address value that uniquely identifies the object. (Inherited from SqlSmoObject.)
Public property UserData Gets or sets user-defined data associated with the referenced object. (Inherited from SmoObjectBase.)

Top

Methods

  Name Description
Protected method AddDatabaseContext(StringCollection) Add the database context to the collection of queries identified by the queries parameter. (Inherited from SqlSmoObject.)
Protected method AddDatabaseContext(StringCollection, ScriptingOptions) Add the database context to the collection of queries identified by the queries parameter, and using the specified scripting options. (Inherited from SqlSmoObject.)
Public method AddDefaultConstraint() Adds a default constraint to the column.
Public method AddDefaultConstraint(String) Adds a default constraint to the column.
Public method Alter Updates any Column object property changes on the instance of SQL Server.
Protected method AlterImpl Activates the object altered event. (Inherited from SqlSmoObject.)
Protected method AlterImplFinish Method called when object altered event finishes. (Inherited from SqlSmoObject.)
Protected method AlterImplInit Method called when object-altered event is intialized. (Inherited from SqlSmoObject.)
Protected method AlterImplWorker Calls the Alter methods. (Inherited from SqlSmoObject.)
Protected method AppendCommaText Appends text, optionally separated by a comma. (Inherited from ScriptNameObjectBase.)
Protected method AppendWithCommaText Appends text, optionally separated by a comma. (Inherited from ScriptNameObjectBase.)
Protected method AppendWithOption Appends text and option text separated from the main text with a “WITH” string and optionally separated by a comma. (Inherited from ScriptNameObjectBase.)
Protected method AutoGenerateName Generates a name based on the object Guid. (Inherited from ScriptNameObjectBase.)
Public method BindDefault Binds a default to the column.
Protected method BindDefaultImpl Binds the default items identified by the parameters. (Inherited from SqlSmoObject.)
Public method BindRule Binds a rule to the column.
Protected method BindRuleImpl Binds the rule schema to the rule and columns identified by the parameters. (Inherited from SqlSmoObject.)
Protected method CheckCollation Checks the order of the scripting options by the collation method identified by the collationName parameter. (Inherited from SqlSmoObject.)
Protected method CheckObjectDirty Checks whether object has been modified and not persisted. (Inherited from ScriptNameObjectBase.)
Protected method CheckObjectState() Validates the state of the referenced object. (Inherited from SqlSmoObject.)
Protected method 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.)
Protected method CheckObjectStateImpl Checks the state of a SqlSmoObject. (Inherited from SqlSmoObject.)
Protected method CheckTextCorectness Checks text for correctness against the parameters. (Inherited from ScriptNameObjectBase.)
Protected method CheckTextModeSupport Checks mode of support. (Inherited from ScriptNameObjectBase.)
Protected method CheckVersion100 Checks whether version of SQL Server is SQL Server 2008. (Inherited from SqlSmoObject.)
Protected method CheckVersion80 Checks the validity of the object on SQL Server 2000. (Inherited from SqlSmoObject.)
Protected method CheckVersion80SP3 Checks the validity of the object on SQL Server 2000 SP3. (Inherited from SqlSmoObject.)
Protected method CheckVersion90 Check the validity of the object on SQL Server 2005. (Inherited from SqlSmoObject.)
Protected method CheckVersionBelow90 Checks whether version of SQL Server is before SQL Server 2005. (Inherited from SqlSmoObject.)
Protected method CleanObject Cleans the referenced object. (Inherited from ScriptNameObjectBase.)
Public method Create Creates a column on the instance of Microsoft SQL Server as defined by the Column object.
Protected method CreateImpl Creates an object with scripting options. (Inherited from SqlSmoObject.)
Protected method CreateImplFinish Method called when the create event finishes. (Inherited from SqlSmoObject.)
Protected method CreateImplInit Method called when the create event initializes. (Inherited from SqlSmoObject.)
Public method Discover Discovers a list of type Object. (Inherited from SqlSmoObject.)
Public method Drop Drops the column.
Protected method DropImpl Drops a SqlSmoObject. (Inherited from SqlSmoObject.)
Protected method DropImplWorker Calls the drop methods. (Inherited from SqlSmoObject.)
Public method EnumForeignKeys Enumerates a list of foreign keys that reference the column.
Public method EnumIndexes Enumerates a list of indexes that include the column.
Protected method EnumScriptImpl Enumerates scripts specified by the so parameter. (Inherited from SqlSmoObject.)
Protected method EnumScriptImplWorker Calls the methods that enumerate scripts specified by the so parameter. (Inherited from SqlSmoObject.)
Protected method EnumScriptImplWorkerSOChanged Returns an IEnumerable string describing the scripting options for an object. (Inherited from SqlSmoObject.)
Public method EnumUserPermissions Enumerates a list of permissions for a specified user.
Public method Equals (Inherited from Object.)
Protected method ExecuteNonQuery Executes a batch in the context of the database where there are no results returned. (Inherited from SqlSmoObject.)
Protected method Finalize (Inherited from Object.)
Protected method ForceTextModeOnTextBody Enforces text mode on the text body. (Inherited from ScriptNameObjectBase.)
Protected method FormatSqlVariant Formats an object as SqlVariant type. (Inherited from SqlSmoObject.)
Protected method GenerateDataSpaceFileStreamScript Generates a script to create data file. (Inherited from SqlSmoObject.)
Protected method GenerateDataSpaceScript Generates a script to allocate space in the data file. (Inherited from SqlSmoObject.)
Protected method GetBindDefaultScript Gets the script that binds defaults specified by the defSchema and defName parameters. (Inherited from SqlSmoObject.)
Protected method GetBindRuleScript Gets the script that specifies the binding rules. (Inherited from SqlSmoObject.)
Protected method GetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32%) Assigns a Boolean parameter of the SqlSmoObject. (Inherited from SqlSmoObject.)
Protected method GetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) Assigns a Boolean property of the SqlSmoObject. (Inherited from SqlSmoObject.)
Protected method GetBraketNameForText Gets the bracket name. (Inherited from ScriptNameObjectBase.)
Protected method GetDateTimeParameter Assigns the datetime property of the SqlSmoObject. (Inherited from SqlSmoObject.)
Protected method GetDateTimeParameterAsInt Assigns the datetime property of the SqlSmoObject as an integer value if the datetime property is not null. (Inherited from SqlSmoObject.)
Protected method GetDBName Gets the database name that is associated with the object. (Inherited from SqlSmoObject.)
Protected method GetEnumParameter Assigns an enumeration property of the SqlSmoObject. (Inherited from SqlSmoObject.)
Protected method GetFragOptionString Gets a FragmentationOption object as a string value. (Inherited from SqlSmoObject.)
Protected method GetGuidParameter Assigns a Guid property of the SqlSmoObject. (Inherited from SqlSmoObject.)
Public method GetHashCode (Inherited from Object.)
Protected method GetIsSystemNamed Gets a Boolean value that specifies whether the system is named. (Inherited from ScriptNameObjectBase.)
Protected method GetIsTextDirty Determines whether the text value is consistent with stored value. (Inherited from ScriptNameObjectBase.)
Protected method GetParameter(StringBuilder, ScriptingOptions, String, String, Int32%) Assigns a parameter of the SqlSmoObject. (Inherited from SqlSmoObject.)
Protected method GetParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) Assigns a parameter of the SqlSmoObject. (Inherited from SqlSmoObject.)
Protected method GetPropValue Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetPropValueOptional Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetPropValueOptionalAllowNull Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetRealValue Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetScriptIncludeExists Gets the script including the test for existence of type being scripted. (Inherited from ScriptNameObjectBase.)
Protected method GetScriptingOptionsForCreate Gets ScriptingOptions for the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetServerName Gets the name of the instance of SQL Server with which the object is associated. (Inherited from SqlSmoObject.)
Protected method GetServerObject Gets the server of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetSqlServerVersionName Gets the version name of the instance of SQL Server with which the object is associated. (Inherited from SqlSmoObject.)
Protected method GetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32%) Assigns a string parameter of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) Assigns a string parameter of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetTextBody() Returns the text body. (Inherited from ScriptNameObjectBase.)
Protected method GetTextBody(Boolean) Returns the text body. (Inherited from ScriptNameObjectBase.)
Protected method GetTextForScript(ScriptingOptions, Boolean, array<String[]) Gets the text for scripting. (Inherited from ScriptNameObjectBase.)
Protected method GetTextForScript(ScriptingOptions, Boolean, array<String[], Boolean) Gets the text of script object. (Inherited from ScriptNameObjectBase.)
Protected method GetTextHeader Returns the text header. (Inherited from ScriptNameObjectBase.)
Protected method GetTextMode Determines whether the script name is using text mode. (Inherited from ScriptNameObjectBase.)
Protected method GetTextProperty(String) Gets the property as text. (Inherited from ScriptNameObjectBase.)
Protected method GetTextProperty(String, ScriptingOptions) Gets the property as text. (Inherited from ScriptNameObjectBase.)
Protected method GetTimeSpanParameterAsInt Assigns a time span parameter of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Public method GetType (Inherited from Object.)
Protected method GetUrnRecursive(StringBuilder) Assigns an Urn object of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetUrnRecursive(StringBuilder, UrnIdOption) Assigns an Urn object of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method ImplInitialize Initializes the fields of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Public method Initialize() Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Public method Initialize(Boolean) Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Protected method IsObjectDirty Determines whether the referenced object is consistent with the stored object. (Inherited from ScriptNameObjectBase.)
Protected method IsObjectInitialized Verifies whether the object has been initialized. (Inherited from SqlSmoObject.)
Protected method IsObjectInSpace Verifies whether the object is isolated or connected to the instance of SQL Server. (Inherited from SqlSmoObject.)
Protected method IsVersion80SP3 Determines whether the version of SQL Server is SQL Server 2000 with SP3. (Inherited from SqlSmoObject.)
Protected method IsVersion90AndAbove Determines whether the version of SQL Server is SQL Server 2005 or later. (Inherited from SqlSmoObject.)
Protected method MarkDropped Sets the SqlSmoState to dropped. (Inherited from SqlSmoObject.)
Public method MarkForDrop Marks the column to be dropped when the Alter method is run on the column's parent Table object.
Protected method MarkForDropImpl Sets the SqlSmoState to dropped. (Inherited from SqlSmoObject.)
Protected method MemberwiseClone (Inherited from Object.)
Protected method PostAlter Method activated after the SqlSmoObject is altered. (Inherited from SqlSmoObject.)
Protected method PostCreate Method activated after the SqlSmoObject is created. (Inherited from SqlSmoObject.)
Protected method PostDrop Method activated after the SqlSmoObject is dropped. (Inherited from SqlSmoObject.)
Public method Refresh Refreshes the Column object properties. (Overrides ScriptNameObjectBase.Refresh().)
Public method Rename Renames the column.
Protected method RenameImpl Identified for informational purposes only. Not supported. Future compatibility is not guaranteed. (Inherited from NamedSmoObject.)
Protected method RenameImplWorker Identified for informational purposes only. Not supported. Future compatibility is not guaranteed. (Inherited from NamedSmoObject.)
Protected method ScriptAlter Alters the SqlSmoObject according to the parameters. (Inherited from SqlSmoObject.)
Protected method ScriptAnsiQI Scripts the database object in ANSI text. (Inherited from ScriptNameObjectBase.)
Protected method ScriptChangeOwner This method supports the SMO infrastructure and is not intended to be used directly from your code. (Inherited from NamedSmoObject.)
Protected method ScriptCreate Alters the SqlSmoObject according to the parameters. (Inherited from SqlSmoObject.)
Protected method ScriptDdl Throws InvalidSmoOperationException. (Inherited from SqlSmoObject.)
Protected method ScriptDrop Throws InvalidSmoOperationException. (Inherited from SqlSmoObject.)
Protected method ScriptImpl() Gets a collection of scripts of the SqlSmoObject. (Inherited from SqlSmoObject.)
Protected method ScriptImpl(ScriptingOptions) Gets a collection of scripts of the SqlSmoObject. (Inherited from SqlSmoObject.)
Protected method ScriptImplWorker Gets a collection of scripts of the SqlSmoObject. (Inherited from SqlSmoObject.)
Protected method ScriptInformativeHeaders Scripts the information headers. (Inherited from ScriptNameObjectBase.)
Protected method ScriptOwner Alters the script owner authorization. (Inherited from NamedSmoObject.)
Protected method ScriptRename This method supports the SMO infrastructure and is not intended to be used directly from your code. (Inherited from NamedSmoObject.)
Protected method SetCollectionTextMode Sets the collection text mode. (Inherited from ScriptNameObjectBase.)
Protected method SetIsSystemNamed Sets a Boolean value that specifies whether the system is named. (Inherited from ScriptNameObjectBase.)
Protected method SetParentImpl Sets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.)
Protected method SetSchemaOwned Sets the schema owned value. (Inherited from NamedSmoObject.)
Protected method SetTextBody Specifies the text body. (Inherited from ScriptNameObjectBase.)
Protected method SetTextHeader Specifies the text header. (Inherited from ScriptNameObjectBase.)
Protected method SetTextMode Specifies the text mode. (Inherited from ScriptNameObjectBase.)
Protected method SwitchTextMode Switches the text mode. (Inherited from ScriptNameObjectBase.)
Protected method ThrowIfTextIsDirtyForAlter Throws an exception of text has been modified and not persisted. (Inherited from ScriptNameObjectBase.)
Public method ToString Returns a String that represents the referenced object. (Inherited from SqlSmoObject.)
Protected method TouchImpl Not implemented. (Inherited from SqlSmoObject.)
Public method UnbindDefault Unbinds the currently bound default from the column.
Protected method UnbindDefaultImpl Unbinds the default columns of the SqlSmoObject. (Inherited from SqlSmoObject.)
Public method UnbindRule Unbinds the currently bound rule from the column.
Protected method UnbindRuleImpl Unbinds rules of the SqlSmoObject. (Inherited from SqlSmoObject.)
Public method UpdateStatistics() Updates Statistic objects that monitor this column.
Public method UpdateStatistics(StatisticsScanType) Updates Statistic objects that monitor this column.
Public method UpdateStatistics(StatisticsScanType, Int32) Updates Statistic objects that monitor this column using a sampled scan.
Public method UpdateStatistics(StatisticsScanType, Int32, Boolean) Updates Statistic objects that monitor this column using a sampled scan.
Public method Validate Validates the state of an object. (Inherited from SmoObjectBase.)

Top

Events

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

Top

Fields

  Name Description
Protected field m_ExtendedProperties Represents a property that is defined to extend the properties provided by a SqlSmoObject. (Inherited from SqlSmoObject.)
Protected field singletonParent Represents the singleton parent. (Inherited from SqlSmoObject.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method IAlienObject.Discover Discovers any dependencies. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.GetDomainRoot Returns the root of the domain. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method 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.)
Explicit interface implemetationPrivate method IAlienObject.GetPropertyType Gets the type of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.GetPropertyValue Gets the value of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.GetUrn Gets the Unified Resource Name of the object. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.Resolve Gets the instance that contains the information about the object from the Unified Resource Name of the object. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.SetObjectState Sets the object state to the specified SfcObjectState value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.SetPropertyValue Sets the property value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method ISfcPropertyProvider.GetPropertySet Gets the interface reference to the set of properties of this object. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate property 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.

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.