Share via


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
Public method Catalog Initializes a new instance of the Catalog class with the specified parent, name and password.

Top

Properties

  Name Description
Protected property AbstractIdentityKey (Inherited from SfcInstance.)
Public property EncryptionAlgorithm Gets the encryption algorithm used in a catalog.
Public property Executions Gets the execution collection.
Public property Folders Gets the folder collection.
Public property IdentityKey Gets the identity key.
Public property MaxProjectVersions Gets or sets the maximum number of stored versions per project.
Public property Metadata (Inherited from SfcInstance.)
Public property Name Gets or sets the name of the catalog.
Public property OperationCleanupEnabled Gets or sets a value that indicates whether the operation cleanup is enabled.
Public property OperationLogNumberOfRecords Gets the operation log number of records.
Public property OperationLogRetentionTime Gets or sets the retention period for the operation logs.
Public property OperationLogSize Gets the size of the operation log.
Public property Operations Gets the operation collection.
Public property Parent Gets or sets the parent.
Public property Properties (Inherited from SfcInstance.)
Public property SchemaBuild Gets the schema build of the catalog.
Public property SchemaVersion Gets the schema version of the catalog.
Public property ServerLoggingLevel Gets or sets the logging level type used in the catalog.
Protected property State (Inherited from SfcInstance.)
Public property Urn (Inherited from SfcInstance.)
Public property Validations Gets the validation collection.
Public property VersionCleanupEnabled Gets or sets a value that indicates whether the version cleanup is enabled.
Public property VersionLogNumberOfRecords Gets the version log number of records.
Public property VersionLogSize Gets the size of the version log of the catalog.

Top

Methods

  Name Description
Public method Alter Alters the catalog in the back-end server.
Public method ChangeEncryptionAlgorithm Changes the encryption algorithm.
Public method Create() Creates the catalog in the back-end server.
Public method Create(Boolean) Creates the catalog in the back-end server.
Protected method CreateIdentityKey (Inherited from SfcInstance.)
Public method Discover (Inherited from SfcInstance.)
Public method Drop Indicates the drop in the back-end server.
Public method Equals (Inherited from Object.)
Protected method GetChildCollection (Inherited from SfcInstance.)
Public method GetDomain (Inherited from SfcInstance.)
Public method GetHashCode (Inherited from Object.)
Public methodStatic member GetObjectFactory Gets the factory to create a new instance.
Public method GetPropertySet (Inherited from SfcInstance.)
Public method GetType (Inherited from Object.)
Protected method GetTypeMetadataImpl (Inherited from SfcInstance.)
Protected method InitializeUIPropertyState (Inherited from SfcInstance.)
Protected method OnPropertyMetadataChanges (Inherited from SfcInstance.)
Protected method OnPropertyValueChanges (Inherited from SfcInstance.)
Public method Refresh (Inherited from SfcInstance.)
Protected method ResetKey (Inherited from SfcInstance.)
Public method ScriptAlter Determines the script to alter the catalog.
Public method ScriptCreate Determines the script to create the catalog.
Public method ScriptDrop Determines the script to drop the catalog.
Public method Serialize (Inherited from SfcInstance.)
Public method ToString (Inherited from SfcInstance.)

Top

Events

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

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method 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