Catalog Catalog Catalog Class

Definition

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
Public NotInheritable Class Catalog
Inherits SfcInstance
Implements IAlterable, ICreatable, IDroppable, ISfcAlterable, ISfcCreatable, ISfcDroppable
Inheritance
Attributes
Implements

Constructors

Catalog(IntegrationServices) Catalog(IntegrationServices) Catalog(IntegrationServices)
Catalog(IntegrationServices, String, String) Catalog(IntegrationServices, String, String) Catalog(IntegrationServices, String, String)

Initializes a new instance of the Catalog class with the specified parent, name and password.

Properties

AbstractIdentityKey AbstractIdentityKey AbstractIdentityKey

Do not reference this member directly in your code. It supports the SQL Server infrastructure.

(Inherited from SfcInstance)
CustomizedLoggingLevels CustomizedLoggingLevels CustomizedLoggingLevels

The customized logging level collection

DefaultExecutionMode DefaultExecutionMode DefaultExecutionMode

Execute in scale out by default

EncryptionAlgorithm EncryptionAlgorithm EncryptionAlgorithm

Gets the encryption algorithm used in a catalog.

Executions Executions Executions

Gets the execution collection.

Folders Folders Folders

Gets the folder collection.

IdentityKey IdentityKey IdentityKey

Gets the identity key.

MaxProjectVersions MaxProjectVersions MaxProjectVersions

Gets or sets the maximum number of stored versions per project.

Metadata Metadata Metadata

Returns metadata about the instance and its domain.

(Inherited from SfcInstance)
Name Name Name

Gets or sets the name of the catalog.

OperationCleanupEnabled OperationCleanupEnabled OperationCleanupEnabled

Gets or sets a value that indicates whether the operation cleanup is enabled.

OperationLogNumberOfRecords OperationLogNumberOfRecords OperationLogNumberOfRecords

Gets the operation log number of records.

OperationLogRetentionTime OperationLogRetentionTime OperationLogRetentionTime

Gets or sets the retention period for the operation logs.

OperationLogSize OperationLogSize OperationLogSize

Gets the size of the operation log.

Operations Operations Operations

Gets the operation collection.

Parent Parent Parent

Gets or sets the parent.

Properties Properties Properties

Returns a collection instance properties.

(Inherited from SfcInstance)
PropertyStorageProvider PropertyStorageProvider PropertyStorageProvider

Do not reference this member directly in your code. It supports the SQL Server infrastructure.

(Inherited from SfcInstance)
ScaleOutEnabled ScaleOutEnabled ScaleOutEnabled

Enable scale out for the catalog

SchemaBuild SchemaBuild SchemaBuild

Gets the schema build of the catalog.

SchemaVersion SchemaVersion SchemaVersion

Gets the schema version of the catalog.

ServerCustomizedLoggingLevel ServerCustomizedLoggingLevel ServerCustomizedLoggingLevel

The server-wide default level of details that are captured during package execution.

ServerLoggingLevel ServerLoggingLevel ServerLoggingLevel

Gets or sets the logging level type used in the catalog.

State State State

Returns the state of the SfcInstance object.

(Inherited from SfcInstance)
Urn Urn Urn

Returns the uniform resource name of the SfcInstance object.

(Inherited from SfcInstance)
Validations Validations Validations

Gets the validation collection.

VersionCleanupEnabled VersionCleanupEnabled VersionCleanupEnabled

Gets or sets a value that indicates whether the version cleanup is enabled.

VersionLogNumberOfRecords VersionLogNumberOfRecords VersionLogNumberOfRecords

Gets the version log number of records.

VersionLogSize VersionLogSize VersionLogSize

Gets the size of the version log of the catalog.

Methods

Alter() Alter() Alter()

Alters the catalog in the back-end server.

AlterImpl() AlterImpl() AlterImpl()

Do not reference this member directly in your code. It supports the SQL Server infrastructure.

(Inherited from SfcInstance)
ChangeEncryptionAlgorithm(Catalog+Encryption) ChangeEncryptionAlgorithm(Catalog+Encryption) ChangeEncryptionAlgorithm(Catalog+Encryption)

Changes the encryption algorithm.

CheckObjectCreated() CheckObjectCreated() CheckObjectCreated()

Do not reference this member directly in your code. It supports the SQL Server infrastructure.

(Inherited from SfcInstance)
CheckObjectState() CheckObjectState() CheckObjectState()

Do not reference this member directly in your code. It supports the SQL Server infrastructure.

(Inherited from SfcInstance)
ConfigureAlwaysOnSupport(List<ReplicaDataInfo>) ConfigureAlwaysOnSupport(List<ReplicaDataInfo>) ConfigureAlwaysOnSupport(List<ReplicaDataInfo>)

Main fucntion to configure SSIS support for alwayson

Create() Create() Create()

Creates the catalog in the back-end server.

Create(Boolean) Create(Boolean) Create(Boolean)

Creates the catalog in the back-end server.

CreateIdentityKey() CreateIdentityKey() CreateIdentityKey()

Do not reference this member directly in your code. It supports the SQL Server infrastructure.

(Inherited from SfcInstance)
CreateImpl() CreateImpl() CreateImpl()

Do not reference this member directly in your code. It supports the SQL Server infrastructure.

(Inherited from SfcInstance)
Discover(ISfcDependencyDiscoveryObjectSink) Discover(ISfcDependencyDiscoveryObjectSink) Discover(ISfcDependencyDiscoveryObjectSink)

Do not reference this member directly in your code. It supports the SQL Server infrastructure.

(Inherited from SfcInstance)
Drop() Drop() Drop()

Indicates the drop in the back-end server.

DropImpl() DropImpl() DropImpl()

Do not reference this member directly in your code. It supports the SQL Server infrastructure.

(Inherited from SfcInstance)
EnableScaleout() EnableScaleout() EnableScaleout()

Enable SSIS Scale Out for multiple package executions.

GetChildCollection(String) GetChildCollection(String) GetChildCollection(String)

Do not reference this member directly in your code. It supports the SQL Server infrastructure.

(Inherited from SfcInstance)
GetDomain() GetDomain() GetDomain()

Do not reference this member directly in your code. It supports the SQL Server infrastructure.

(Inherited from SfcInstance)
GetObjectFactory() GetObjectFactory() GetObjectFactory()

Gets the factory to create a new instance.

GetPropertySet() GetPropertySet() GetPropertySet()

Returns the set of properties for the SfcInstance object.

(Inherited from SfcInstance)
GetTypeMetadataImpl() GetTypeMetadataImpl() 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() InitializeUIPropertyState() InitializeUIPropertyState()

Do not reference this member directly in your code. It supports the SQL Server infrastructure.

(Inherited from SfcInstance)
InitialSupportForAlwaysOnPrimary() InitialSupportForAlwaysOnPrimary() InitialSupportForAlwaysOnPrimary()

This function is used to do some initialization for an instance prepared as a primary node

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

Do not reference this member directly in your code. It supports the SQL Server infrastructure.

(Inherited from SfcInstance)
MoveImpl(SfcInstance) MoveImpl(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) OnPropertyMetadataChanges(SfcPropertyMetadataChangedEventArgs) OnPropertyMetadataChanges(SfcPropertyMetadataChangedEventArgs)

Invoked whenever the effective value of any SfcInstance metadata is updated.

(Inherited from SfcInstance)
OnPropertyValueChanges(PropertyChangedEventArgs) OnPropertyValueChanges(PropertyChangedEventArgs) OnPropertyValueChanges(PropertyChangedEventArgs)

Invoked whenever the effective value of any SfcInstance property is updated.

(Inherited from SfcInstance)
PostAlter(Object) PostAlter(Object) PostAlter(Object)

Do not reference this member directly in your code. It supports the SQL Server infrastructure.

(Inherited from SfcInstance)
PostCreate(Object) PostCreate(Object) 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) PostDrop(Object) PostDrop(Object)

Do not reference this member directly in your code. It supports the SQL Server infrastructure.

(Inherited from SfcInstance)
PostMove(Object) PostMove(Object) PostMove(Object)

Do not reference this member directly in your code. It supports the SQL Server infrastructure.

(Inherited from SfcInstance)
PostRename(Object) PostRename(Object) PostRename(Object)

Do not reference this member directly in your code. It supports the SQL Server infrastructure.

(Inherited from SfcInstance)
Refresh() Refresh() Refresh()

Refreshes the object's properties by reading them from the server.

(Inherited from SfcInstance)
RenameImpl(SfcKey) RenameImpl(SfcKey) RenameImpl(SfcKey)

Do not reference this member directly in your code. It supports the SQL Server infrastructure.

(Inherited from SfcInstance)
ResetKey() ResetKey() ResetKey()

Do not reference this member directly in your code. It supports the SQL Server infrastructure.

(Inherited from SfcInstance)
ScriptAlter() ScriptAlter() ScriptAlter()

Determines the script to alter the catalog.

ScriptCreate() ScriptCreate() ScriptCreate()

Determines the script to create the catalog.

ScriptDrop() ScriptDrop() ScriptDrop()

Determines the script to drop the catalog.

Serialize(XmlWriter) Serialize(XmlWriter) Serialize(XmlWriter)

Serializes the instance to XML.

(Inherited from SfcInstance)
ToString() ToString() ToString()

Returns a string representation of the instance Urn.

(Inherited from SfcInstance)
UpdateUIPropertyState() UpdateUIPropertyState() UpdateUIPropertyState()

Do not reference this member directly in your code. It supports the SQL Server infrastructure.

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

Explicit Interface Implementations

ISfcDiscoverObject.Discover(ISfcDependencyDiscoveryObjectSink) ISfcDiscoverObject.Discover(ISfcDependencyDiscoveryObjectSink) ISfcDiscoverObject.Discover(ISfcDependencyDiscoveryObjectSink)

Specifies whether to discover children and if their IsCrudActionHandledByParent is false (default), accumulate their CRUD scripts to the action script.

Events

propertyChanged propertyChanged propertyChanged

Do not reference this member directly in your code. It supports the SQL Server infrastructure.

(Inherited from SfcInstance)
PropertyChanged PropertyChanged PropertyChanged

Occurs when a property value changes.

(Inherited from SfcInstance)
propertyMetadataChanged propertyMetadataChanged 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 PropertyMetadataChanged PropertyMetadataChanged

Occurs when the metadata for a property has changed.

(Inherited from SfcInstance)

Applies to