Federation Class

Definition

Represents a federation object on the SQL Azure database.

public ref class Federation sealed : Microsoft::SqlServer::Management::Smo::ScriptNameObjectBase, Microsoft::SqlServer::Management::Common::IAlterable, Microsoft::SqlServer::Management::Common::ICreatable, Microsoft::SqlServer::Management::Common::IDroppable, Microsoft::SqlServer::Management::Smo::IScriptable
[Microsoft.SqlServer.Management.Sdk.Sfc.Metadata.SfcElement(Microsoft.SqlServer.Management.Sdk.Sfc.Metadata.SfcElementFlags.SqlAzureDatabase | Microsoft.SqlServer.Management.Sdk.Sfc.Metadata.SfcElementFlags.Standalone)]
public sealed class Federation : Microsoft.SqlServer.Management.Smo.ScriptNameObjectBase, Microsoft.SqlServer.Management.Common.IAlterable, Microsoft.SqlServer.Management.Common.ICreatable, Microsoft.SqlServer.Management.Common.IDroppable, Microsoft.SqlServer.Management.Smo.IScriptable
[<Microsoft.SqlServer.Management.Sdk.Sfc.Metadata.SfcElement(Microsoft.SqlServer.Management.Sdk.Sfc.Metadata.SfcElementFlags.SqlAzureDatabase | Microsoft.SqlServer.Management.Sdk.Sfc.Metadata.SfcElementFlags.Standalone)>]
type Federation = class
    inherit ScriptNameObjectBase
    interface IDroppable
    interface IAlterable
    interface ICreatable
    interface IScriptable
Public NotInheritable Class Federation
Inherits ScriptNameObjectBase
Implements IAlterable, ICreatable, IDroppable, IScriptable
Inheritance
Attributes
Microsoft.SqlServer.Management.Sdk.Sfc.Metadata.SfcElementAttribute
Implements

Constructors

Federation()

Initializes a new instance of the Federation class.

Federation(Database, String)

Initializes a new instance of the Federation class.

Federation(Database, String, String, DataType, DistributionType)

Initializes a new instance of the Federation class.

Fields

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)

Properties

DataType

Gets or sets the type name for federation key type.

DistributionName

Gets or sets the name for the federation key.

DistributionType

Gets or sets the type of partitioning.

ExecuteForScalar

Gets or sets the Boolean property value that specifies whether the object is set to the execute for scalar option.

(Inherited from SqlSmoObject)
ExecutionManager

Gets the object to execute to the manager.

(Inherited from SqlSmoObject)
ID

Gets or sets the identifier of the federation.

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 the name of the federation.

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 or sets the parent database of the federation.

Properties

Gets a collection of Property objects that represent the object properties.

(Inherited from SqlSmoObject)
ScalarResult

Gets the scalar result for the referenced object.

(Inherited from SqlSmoObject)
State

Gets the state of the referenced object.

(Inherited from SmoObjectBase)
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)

Methods

AddDatabaseContext(StringCollection)

Add the database context to the collection of queries identified by the queries parameter.

(Inherited from SqlSmoObject)
Alter()

Alters the federation object on the SQL Azure database.

AlterImpl()

Activates the object altered event.

(Inherited from SqlSmoObject)
AlterImplWorker()

Calls the Alter methods.

(Inherited from SqlSmoObject)
AppendCommaText(StringBuilder, String, Boolean, String)

Appends text, optionally separated by a comma.

(Inherited from ScriptNameObjectBase)
AppendWithCommaText(StringBuilder, String, Boolean)

Appends text, optionally separated by a comma.

(Inherited from ScriptNameObjectBase)
AppendWithOption(StringBuilder, String, String, Boolean)

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 automatically based on the object Guid.

(Inherited from ScriptNameObjectBase)
BindDefaultImpl(String, String, Boolean)

Binds the default items identified by the parameters.

(Inherited from SqlSmoObject)
BindRuleImpl(String, String, Boolean)

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(Boolean)

Checks the state of a SqlSmoObject.

(Inherited from SqlSmoObject)
CheckTextCorectness(String, Boolean, Boolean, String[], DdlTextParserHeaderInfo)

Checks text for correctness against the parameters.

(Inherited from ScriptNameObjectBase)
CheckTextModeSupport()

Checks mode of support.

(Inherited from ScriptNameObjectBase)
CleanObject()

Cleans the referenced object.

(Inherited from ScriptNameObjectBase)
Create()

Creates the federation object on the SQL Azure database.

CreateImpl()

Creates an object with scripting options.

(Inherited from SqlSmoObject)
Discover()

Discovers a list of type Object.

(Inherited from SqlSmoObject)
Drop()

Drops the federation object from the SQL Azure database.

DropImpl(Boolean)

Drops a SqlSmoObject.

(Inherited from SqlSmoObject)
DropImplWorker(Urn, Boolean)

Drops the IMPL worker.

(Inherited from SqlSmoObject)
ExecuteNonQuery(StringCollection, Boolean)

Executes a batch of statements that does not return a result set.

(Inherited from SqlSmoObject)
ExecuteRenameQuery(String)

Executes the rename query for the object.

(Inherited from NamedSmoObject)
ForceTextModeOnTextBody()

Enforces text mode on the text body.

(Inherited from ScriptNameObjectBase)
FormatSqlVariant(Object)

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(FragmentationOption)

Gets a FragmentationOption object as a string value.

(Inherited from SqlSmoObject)
GetIsSystemNamed()

Indicates a 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(String)

Gets a property value of the SqlSmoObject object.

(Inherited from SqlSmoObject)
GetPropValueOptional(String)

Gets a property value of the SqlSmoObject object.

(Inherited from SqlSmoObject)
GetPropValueOptionalAllowNull(String)

Gets a property value of the SqlSmoObject object.

(Inherited from SqlSmoObject)
GetRealValue(Property, Object)

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(Boolean)

Returns the text header.

(Inherited from ScriptNameObjectBase)
GetTextMode()

Determines whether the script name is using text mode.

(Inherited from ScriptNameObjectBase)
GetTextProperty(String)

Gets the text of the object, if not available, throw appropriate exception based on the state of the object.

(Inherited from ScriptNameObjectBase)
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(String[], OrderBy[])

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)
IsSupportedProperty(String)

Determines whether the specified property is supported in the target .NET Framework.

(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)
MarkForDropImpl(Boolean)

Sets the SqlSmoState for drop operation.

(Inherited from SqlSmoObject)
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 script name.

(Inherited from ScriptNameObjectBase)
RenameImpl(String)

This method supports the SMO infrastructure and is not intended to be used directly from your code.

(Inherited from NamedSmoObject)
RenameImplWorker(String)

Identified for informational purposes only. Not supported. Future compatibility is not guaranteed.

(Inherited from NamedSmoObject)
Script()

Generates a Transact-SQL script that can be used to re-create the federation.

Script(ScriptingOptions)

Generates a Transact-SQL script that can be used to re-create the federation with specified options.

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(Boolean, SmoCollectionBase)

Sets the collection text mode.

(Inherited from ScriptNameObjectBase)
SetIsSystemNamed(Boolean)

Specifies a value that indicates whether the system is named.

(Inherited from ScriptNameObjectBase)
SetParentImpl(SqlSmoObject)

Sets the parent of the SqlSmoObject to the newParent parameter.

(Inherited from SqlSmoObject)
SetSchemaOwned()

Sets the schema owned value for the named Smo object.

(Inherited from NamedSmoObject)
SetTextBody(String)

Specifies the text body.

(Inherited from ScriptNameObjectBase)
SetTextHeader(String)

Specifies the text header.

(Inherited from ScriptNameObjectBase)
SetTextMode(Boolean, SmoCollectionBase[])

Specifies the text mode.

(Inherited from ScriptNameObjectBase)
SwitchTextMode(Boolean, SmoCollectionBase[])

Switches the text mode.

(Inherited from ScriptNameObjectBase)
ThrowIfAboveVersion100(String)

Throws the object if above version 100.

(Inherited from SqlSmoObject)
ThrowIfAboveVersion80(String)

Throws SqlSmoObject if version is above 80.

(Inherited from SqlSmoObject)
ThrowIfBelowVersion100(String)

Throws exception if the version is below 100.

(Inherited from SqlSmoObject)
ThrowIfBelowVersion110(String)

Throws the object if the version belows 110.

(Inherited from SqlSmoObject)
ThrowIfBelowVersion110Prop(String)

Throws the SqlSmoObject if version is below 110Prop.

(Inherited from SqlSmoObject)
ThrowIfBelowVersion120(String)

Throws the object if the version is below 120.

(Inherited from SqlSmoObject)
ThrowIfBelowVersion120Prop(String)

Throws the object if the version belows 120 property.

(Inherited from SqlSmoObject)
ThrowIfBelowVersion130(String)

Throws the object if the version is below 130.

(Inherited from SqlSmoObject)
ThrowIfBelowVersion130Prop(String)

Throws an object if BelowVersion130Prop.

(Inherited from SqlSmoObject)
ThrowIfBelowVersion80(String)

Throws the object if the version is below 80.

(Inherited from SqlSmoObject)
ThrowIfBelowVersion80SP3()

Throws an exception if the version is below 80SP3.

(Inherited from SqlSmoObject)
ThrowIfBelowVersion90(String)

Throws the object if the version is below 90.

(Inherited from SqlSmoObject)
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()

Implements a touch object.

(Inherited from SqlSmoObject)
UnbindDefaultImpl(Boolean)

Unbinds the default columns of the SqlSmoObject.

(Inherited from SqlSmoObject)
UnbindRuleImpl(Boolean)

Unbinds rules of the SqlSmoObject.

(Inherited from SqlSmoObject)
Validate(String, Object[])

Validates the state of an object.

(Inherited from SmoObjectBase)

Events

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)

Explicit Interface Implementations

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(String)

Gets the type of the specified property.

(Inherited from SqlSmoObject)
IAlienObject.GetPropertyValue(String, Type)

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(String)

Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object.

(Inherited from SqlSmoObject)
IAlienObject.SetObjectState(SfcObjectState)

Sets the object state to the specified SfcObjectState value.

(Inherited from SqlSmoObject)
IAlienObject.SetPropertyValue(String, Type, Object)

Sets the property value.

(Inherited from SqlSmoObject)
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)

Applies to