Catalog Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Represents an Integration Services database.
public ref class Catalog sealed : Microsoft::SqlServer::Management::Sdk::Sfc::SfcInstance, Microsoft::SqlServer::Management::Common::IAlterable, Microsoft::SqlServer::Management::Common::ICreatable, Microsoft::SqlServer::Management::Common::IDroppable, Microsoft::SqlServer::Management::Sdk::Sfc::ISfcAlterable, Microsoft::SqlServer::Management::Sdk::Sfc::ISfcCreatable, Microsoft::SqlServer::Management::Sdk::Sfc::ISfcDroppable
[Microsoft.SqlServer.Management.Sdk.Sfc.LocalizedPropertyResources("Microsoft.SqlServer.Management.IntegrationServices.LocalizableResources")]
[System.ComponentModel.TypeConverter(typeof(Microsoft.SqlServer.Management.Sdk.Sfc.LocalizableTypeConverter))]
public sealed class Catalog : Microsoft.SqlServer.Management.Sdk.Sfc.SfcInstance, Microsoft.SqlServer.Management.Common.IAlterable, Microsoft.SqlServer.Management.Common.ICreatable, Microsoft.SqlServer.Management.Common.IDroppable, Microsoft.SqlServer.Management.Sdk.Sfc.ISfcAlterable, Microsoft.SqlServer.Management.Sdk.Sfc.ISfcCreatable, Microsoft.SqlServer.Management.Sdk.Sfc.ISfcDroppable
[<Microsoft.SqlServer.Management.Sdk.Sfc.LocalizedPropertyResources("Microsoft.SqlServer.Management.IntegrationServices.LocalizableResources")>]
[<System.ComponentModel.TypeConverter(typeof(Microsoft.SqlServer.Management.Sdk.Sfc.LocalizableTypeConverter))>]
type Catalog = class
inherit SfcInstance
interface ISfcCreatable
interface ICreatable
interface ISfcAlterable
interface IAlterable
interface ISfcDroppable
interface IDroppable
interface ISfcDiscoverObject
Public NotInheritable Class Catalog
Inherits SfcInstance
Implements IAlterable, ICreatable, IDroppable, ISfcAlterable, ISfcCreatable, ISfcDroppable
- Inheritance
- Attributes
- Implements
Constructors
Catalog(IntegrationServices) | |
Catalog(IntegrationServices, String, String) |
Initializes a new instance of the Catalog class with the specified parent, name and password. |
Properties
AbstractIdentityKey |
Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance) |
CustomizedLoggingLevels |
The customized logging level collection |
DefaultExecutionMode |
Execute in scale out by default |
EncryptionAlgorithm |
Gets the encryption algorithm used in a catalog. |
Executions |
Gets the execution collection. |
Folders |
Gets the folder collection. |
IdentityKey |
Gets the identity key. |
MaxProjectVersions |
Gets or sets the maximum number of stored versions per project. |
Metadata |
Returns metadata about the instance and its domain. (Inherited from SfcInstance) |
Name |
Gets or sets the name of the catalog. |
OperationCleanupEnabled |
Gets or sets a value that indicates whether the operation cleanup is enabled. |
OperationLogNumberOfRecords |
Gets the operation log number of records. |
OperationLogRetentionTime |
Gets or sets the retention period for the operation logs. |
OperationLogSize |
Gets the size of the operation log. |
Operations |
Gets the operation collection. |
Parent |
Gets or sets the parent. |
Properties |
Returns a collection instance properties. (Inherited from SfcInstance) |
PropertyStorageProvider |
Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance) |
ScaleOutEnabled |
Enable scale out for the catalog |
SchemaBuild |
Gets the schema build of the catalog. |
SchemaVersion |
Gets the schema version of the catalog. |
ServerCustomizedLoggingLevel |
The server-wide default level of details that are captured during package execution. |
ServerLoggingLevel |
Gets or sets the logging level type used in the catalog. |
State |
Returns the state of the SfcInstance object. (Inherited from SfcInstance) |
Urn |
Returns the uniform resource name of the SfcInstance object. (Inherited from SfcInstance) |
Validations |
Gets the validation collection. |
VersionCleanupEnabled |
Gets or sets a value that indicates whether the version cleanup is enabled. |
VersionLogNumberOfRecords |
Gets the version log number of records. |
VersionLogSize |
Gets the size of the version log of the catalog. |
Methods
Alter() |
Alters the catalog in the back-end server. |
AlterImpl() |
Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance) |
ChangeEncryptionAlgorithm(Catalog+Encryption) |
Changes the encryption algorithm. |
CheckObjectCreated() |
Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance) |
CheckObjectState() |
Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance) |
ConfigureAlwaysOnSupport(List<ReplicaDataInfo>) |
Main fucntion to configure SSIS support for alwayson |
Create() |
Creates the catalog in the back-end server. |
Create(Boolean) |
Creates the catalog in the back-end server. |
CreateIdentityKey() |
Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance) |
CreateImpl() |
Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance) |
Discover(ISfcDependencyDiscoveryObjectSink) |
Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance) |
Drop() |
Indicates the drop in the back-end server. |
DropImpl() |
Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance) |
EnableScaleout() |
Enable SSIS Scale Out for multiple package executions. |
GetChildCollection(String) |
Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance) |
GetDomain() |
Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance) |
GetObjectFactory() |
Gets the factory to create a new instance. |
GetPropertySet() |
Returns the set of properties for the SfcInstance object. (Inherited from SfcInstance) |
GetTypeMetadataImpl() |
Indicates the domains that override by returning the right TypeMetadata class directly. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance) |
InitializeUIPropertyState() |
Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance) |
InitialSupportForAlwaysOnPrimary() |
This function is used to do some initialization for an instance prepared as a primary node |
InitialSupportForAlwaysOnSecondary(String) |
This function is called when current instance is prepared as secondary node. Drop everything of SSIS catalog except SSISDB if enable support for alwayson secondary functions throw exception. |
MarkForDropImpl(Boolean) |
Returns a value that indicates the existing objects to be dropped. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance) |
MarkRootAsConnected() |
Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance) |
MoveImpl(SfcInstance) |
Indicates the new parent object to move in an instance. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance) |
OnPropertyMetadataChanges(SfcPropertyMetadataChangedEventArgs) |
Invoked whenever the effective value of any SfcInstance metadata is updated. (Inherited from SfcInstance) |
OnPropertyValueChanges(PropertyChangedEventArgs) |
Invoked whenever the effective value of any SfcInstance property is updated. (Inherited from SfcInstance) |
PostAlter(Object) |
Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance) |
PostCreate(Object) |
Indicates the default implementor that creates the execution result. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance) |
PostDrop(Object) |
Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance) |
PostMove(Object) |
Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance) |
PostRename(Object) |
Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance) |
Refresh() |
Refreshes the object's properties by reading them from the server. (Inherited from SfcInstance) |
RenameImpl(SfcKey) |
Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance) |
ResetKey() |
Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance) |
ScriptAlter() |
Determines the script to alter the catalog. |
ScriptCreate() |
Determines the script to create the catalog. |
ScriptDrop() |
Determines the script to drop the catalog. |
Serialize(XmlWriter) |
Serializes the instance to XML. (Inherited from SfcInstance) |
ToString() |
Returns a string representation of the instance Urn. (Inherited from SfcInstance) |
UpdateUIPropertyState() |
Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance) |
Validate() |
Indicates the basic child object's validation. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance) |
Events
propertyChanged |
Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance) |
PropertyChanged |
Occurs when a property value changes. (Inherited from SfcInstance) |
propertyMetadataChanged |
Do not reference this member directly in your code. It supports the SQL Server infrastructure. Occurs when a property metadata value changes. (Inherited from SfcInstance) |
PropertyMetadataChanged |
Occurs when the metadata for a property has changed. (Inherited from SfcInstance) |
Explicit Interface Implementations
ISfcDiscoverObject.Discover(ISfcDependencyDiscoveryObjectSink) |
Specifies whether to discover children and if their IsCrudActionHandledByParent is false (default), accumulate their CRUD scripts to the action script. |