This documentation is archived and is not being maintained.

TSqlModel Class

 

Updated: April 20, 2017

Represents a model of a SQL Server database schema.

Namespace:   Microsoft.SqlServer.Dac.Model
Assembly:  Microsoft.SqlServer.Dac.Extensions (in Microsoft.SqlServer.Dac.Extensions.dll)

System.Object
  Microsoft.SqlServer.Dac.Model.TSqlModel

public sealed class TSqlModel : IDisposable

NameDescription
System_CAPS_pubpropertyCollationComparer

Gets the comparer that can compare strings and ObjectIdentifiers using the collation of this TSqlModel. This can be very useful when comparing objects in the model since comparisons will be consistent with the expected comparison results in SQL Server.

System_CAPS_pubpropertyDisplayServices

Gets the DisplayServices that support producing display properties for objects in the model.

System_CAPS_pubpropertyEngineVersion

The specific engine version targeted by the model. For On Premises platforms this will be consistent with the SqlServerVersion - for instance Sql90 will have an engine version of 9. For Microsoft Azure SQL Database the minimum valid version is 11, and the engine version will affect what features are supported in the model.

System_CAPS_pubpropertyIsScriptBacked

Gets a value that indicates whether this model is backed by scripts. In this case objects in the UserDefined scope will have source position information including a source name and information. This is important for scenarios such as use of the CodeAnalysisService. Any empty TSqlModel created will be script backed by default. Models loaded from a Dacpac will only be scipt backed if the LoadAsScriptBackedModel option is enabled. Note that creating a script backed model will take longer than using a standard model loaded from a Dacpac.

System_CAPS_pubpropertyVersion

Gets the specific SQL Server release targeted by the model.

NameDescription
System_CAPS_pubmethodAddObjects(String)

Adds objects to the model based on the contents of a TSql Script string. The script should consist of valid TSql DDL statements. Objects added using this method cannot be updated or deleted at a later point as update/delete requires a script name to be specified when adding the objects. If this is a requirement use the AddOrUpdateObjects method instead.

System_CAPS_pubmethodAddObjects(String, TSqlObjectOptions)

Adds objects to the model based on the contents of a TSql Script string, plus additional metadata defined by a TSqlObjectOptions object The script should consist of valid TSql DDL statements. Objects added using this method cannot be updated or deleted at a later point as update/delete requires a script name to be specified when adding the objects. If this is a requirement use the AddOrUpdateObjects method instead.

System_CAPS_pubmethodAddObjects(TSqlScript)

Adds objects to the model based on the contents of a TSqlScript object. The script should be valid TSql with no parse errors. Objects added using this method cannot be updated or deleted at a later point as update/delete requires a script name to be specified when adding the objects. If this is a requirement use the AddOrUpdateObjects method instead.

System_CAPS_pubmethodAddObjects(TSqlScript, TSqlObjectOptions)

Adds objects to the model based on the contents of a TSqlScript object, plus additional metadata defined by a TSqlObjectOptions object The script should be valid TSql with no parse errors. Objects added using this method cannot be updated or deleted at a later point as update/delete requires a script name to be specified when adding the objects. If this is a requirement use the AddOrUpdateObjects method instead.

System_CAPS_pubmethodAddOrUpdateObjects(String, String, TSqlObjectOptions)

Adds or updates the objects defined for a specified sourceName with the objects defined in the inputScript. If any objects were previously added with the same sourceName these will be completely replaced The object definitions are based on the contents of a TSql Script string plus additional metadata defined by a TSqlObjectOptions object The script should consist of valid TSql DDL statements.

System_CAPS_pubmethodAddOrUpdateObjects(TSqlScript, String, TSqlObjectOptions)

Adds or updates the objects defined for a specified sourceName with the objects defined in the inputScript. If any objects were previously added with the same sourceName these will be completely replaced The object definitions are based on the contents of a TSqlScript object plus additional metadata defined by a TSqlObjectOptions object The script should consist of valid TSql DDL statements.

System_CAPS_pubmethodCheckVersionCompatibility(SqlServerVersion, CancellationToken)

System_CAPS_pubmethodConvertToScriptedObject(TSqlObject, String)

System_CAPS_pubmethodCopyModelOptions()

Copies the DatabaseOptions for the model to a TSqlModelOptions object. This is useful if you wish to duplicate the options for a model when creating a new model.

System_CAPS_pubmethodDeleteObjects(String)

Deletes any objects that were added to the model with the specified sourceName.

System_CAPS_pubmethodDispose()

Releases all resources used by the TSqlModel object.

System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetModelErrors()

System_CAPS_pubmethodGetObject(ModelTypeClass, ObjectIdentifier, DacQueryScopes)

Returns TSqlObjects of the specified objectTypetype and ididentity. Only top level ModelTypeClass types are supported by this method - the objectTypetype parameter must be in the types returned from the TopLevelTypes method or the call will fail.

System_CAPS_pubmethodGetObjects(DacQueryScopes, ModelTypeClass[])

Returns all TSqlObjects matching the list of typeFilters. Only top level ModelTypeClass types are supported by this method - all types in the typeFilterstype parameter must be present in the TopLevelTypes or the call will fail.

System_CAPS_pubmethodGetObjects(ModelTypeClass, ObjectIdentifier, DacQueryScopes)

Returns all TSqlObjects that match the ModelTypeClass and ObjectIdentifier. Only top level ModelTypeClass types are supported by this method - the objectTypetype parameter must be in the types returned from the TopLevelTypes method or the call will fail.

System_CAPS_pubmethodGetObjects(String, ModelTypeClass[])

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodSystem_CAPS_staticLoadFromDacpac(Stream, ModelLoadOptions)

Loads a model from a DacPackage or BacPackage using the specified options to configure what kind of storage to use, and whether to load a script-backed model or not.

System_CAPS_pubmethodSystem_CAPS_staticLoadFromDacpac(Stream, ModelLoadOptions, CancellationToken)

System_CAPS_pubmethodSystem_CAPS_staticLoadFromDacpac(String, ModelLoadOptions)

Loads a model from a DacPackage or BacPackage using the specified options to configure what kind of storage to use, and whether to load a script-backed model or not.

System_CAPS_pubmethodSystem_CAPS_staticLoadFromDacpac(String, ModelLoadOptions, CancellationToken)

System_CAPS_pubmethodSystem_CAPS_staticLoadFromDatabase(String, ModelExtractOptions, Nullable<CancellationToken>, IUniversalAuthProvider)

System_CAPS_pubmethodSystem_CAPS_staticLoadFromDatabase(String, SecureString, ModelExtractOptions, Nullable<CancellationToken>)

System_CAPS_pubmethodSystem_CAPS_staticLoadFromDatabaseForUniversalAuth(String, IUniversalAuthProvider, ModelExtractOptions, Nullable<CancellationToken>)

System_CAPS_pubmethodToString()

(Inherited from Object.)

System_CAPS_pubmethodValidate()

Validates the model and returns a list of messages with any errors/warnings.

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: