Catalog Class

Represents an Integration Services database.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Management.Sdk.Sfc.SfcInstance
    Microsoft.SqlServer.Management.IntegrationServices.Catalog

Namespace:  Microsoft.SqlServer.Management.IntegrationServices
Assembly:  Microsoft.SqlServer.Management.IntegrationServices (in Microsoft.SqlServer.Management.IntegrationServices.dll)

Syntax

'Declaration
<TypeConverterAttribute(GetType(LocalizableTypeConverter))> _
<LocalizedPropertyResourcesAttribute("Microsoft.SqlServer.Management.IntegrationServices.LocalizableResources")> _
Public NotInheritable Class Catalog _
    Inherits SfcInstance _
    Implements ISfcCreatable, ICreatable, ISfcAlterable, IAlterable,  _
    ISfcDroppable, IDroppable, ISfcDiscoverObject
'Usage
Dim instance As Catalog

[TypeConverterAttribute(typeof(LocalizableTypeConverter))]
[LocalizedPropertyResourcesAttribute("Microsoft.SqlServer.Management.IntegrationServices.LocalizableResources")]
public sealed class Catalog : SfcInstance, 
    ISfcCreatable, ICreatable, ISfcAlterable, IAlterable, ISfcDroppable, 
    IDroppable, ISfcDiscoverObject

[TypeConverterAttribute(typeof(LocalizableTypeConverter))]
[LocalizedPropertyResourcesAttribute(L"Microsoft.SqlServer.Management.IntegrationServices.LocalizableResources")]
public ref class Catalog sealed : public SfcInstance, 
    ISfcCreatable, ICreatable, ISfcAlterable, IAlterable, ISfcDroppable, 
    IDroppable, ISfcDiscoverObject

[<SealedAttribute>]
[<TypeConverterAttribute(typeof(LocalizableTypeConverter))>]
[<LocalizedPropertyResourcesAttribute("Microsoft.SqlServer.Management.IntegrationServices.LocalizableResources")>]
type Catalog =  
    class 
        inherit SfcInstance 
        interface ISfcCreatable 
        interface ICreatable 
        interface ISfcAlterable 
        interface IAlterable 
        interface ISfcDroppable 
        interface IDroppable 
        interface ISfcDiscoverObject 
    end

public final class Catalog extends SfcInstance implements ISfcCreatable, ICreatable, ISfcAlterable, IAlterable, ISfcDroppable, IDroppable, ISfcDiscoverObject

The Catalog type exposes the following members.

Constructors

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

Top

Properties

	Name	Description
	AbstractIdentityKey	(Inherited from SfcInstance.)
	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	(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	(Inherited from SfcInstance.)
	SchemaBuild	Gets the schema build of the catalog.
	SchemaVersion	Gets the schema version of the catalog.
	ServerLoggingLevel	Gets or sets the logging level type used in the catalog.
	State	(Inherited from SfcInstance.)
	Urn	(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.

Top

Methods

	Name	Description
	Alter	Alters the catalog in the back-end server.
	ChangeEncryptionAlgorithm	Changes the encryption algorithm.
	Create()	Creates the catalog in the back-end server.
	Create(Boolean)	Creates the catalog in the back-end server.
	CreateIdentityKey	(Inherited from SfcInstance.)
	Discover	(Inherited from SfcInstance.)
	Drop	Indicates the drop in the back-end server.
	Equals	(Inherited from Object.)
	GetChildCollection	(Inherited from SfcInstance.)
	GetDomain	(Inherited from SfcInstance.)
	GetHashCode	(Inherited from Object.)
	GetObjectFactory	Gets the factory to create a new instance.
	GetPropertySet	(Inherited from SfcInstance.)
	GetType	(Inherited from Object.)
	GetTypeMetadataImpl	(Inherited from SfcInstance.)
	InitializeUIPropertyState	(Inherited from SfcInstance.)
	OnPropertyMetadataChanges	(Inherited from SfcInstance.)
	OnPropertyValueChanges	(Inherited from SfcInstance.)
	Refresh	(Inherited from SfcInstance.)
	ResetKey	(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	(Inherited from SfcInstance.)
	ToString	(Inherited from SfcInstance.)

Top

Events

	Name	Description
	PropertyChanged	(Inherited from SfcInstance.)
	PropertyMetadataChanged	(Inherited from SfcInstance.)

Top

Explicit Interface Implementations

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

Top

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.

See Also

Reference

Microsoft.SqlServer.Management.IntegrationServices Namespace