Share via


TSqlObject Class

Represents an instance of an object for a SQL Server database schema.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Dac.Model.TSqlObject

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

Syntax

'Declaration
Public NotInheritable Class TSqlObject
'Usage
Dim instance As TSqlObject
public sealed class TSqlObject
public ref class TSqlObject sealed
[<SealedAttribute>]
type TSqlObject =  class end
public final class TSqlObject

The TSqlObject type exposes the following members.

Properties

  Name Description
Public property Item Gets the property value.
Public property Name Gets the identity of the object.
Public property ObjectType Gets the model type of the object.

Top

Methods

  Name Description
Public method Equals (Inherited from Object.)
Public method GetAst Generates the AST for the TSqlObject.
Public method GetChildren() Returns all TSqlObject child objects within the Default scope.
Public method GetChildren(DacQueryScopes) Returns all TSqlObject child objects within the specified DacQueryScopes scope.
Public method GetHashCode (Inherited from Object.)
Public method GetMetadata(ModelMetadataClass) Returns the metadata property value.
Public method GetMetadata<T>(ModelMetadataClass) Returns the metadata property value.
Public method GetParent() Returns the parent TSqlObject, if it is within the Default scope and if there is only one TSqlObject that could be the parent for this object.
Public method GetParent(DacQueryScopes) Returns the parent TSqlObject, if it is within the specified DacQueryScopes scope and if there is only one TSqlObject that could be the parent for this object.
Public method GetProperty(ModelPropertyClass) Returns the property value.
Public method GetProperty<T>(ModelPropertyClass) Returns the property value.
Public method GetReferenced() Gets all referenced objects within the Default scope.
Public method GetReferenced(DacQueryScopes) Gets all referenced objects within a given DacQueryScopes scope.
Public method GetReferenced(ModelRelationshipClass) Gets referenced objects for a given ModelRelationshipClass, where objects are within the Default scope.
Public method GetReferenced(ModelRelationshipClass, DacQueryScopes) Gets referenced objects for a given ModelRelationshipClass, where objects are within a given DacQueryScopes scope.
Public method GetReferencedRelationshipInstances() For each object referenced by this TSqlObject, returns the ModelRelationshipInstance defining the relationship data. This will include the referenced object if it exists, the ObjectIdentifier used to identify the referenced object, and any properties specific to this relationship. Only objects within the Default scope will be returned.
Public method GetReferencedRelationshipInstances(DacExternalQueryScopes) For each object referenced by this TSqlObject, returns the ModelRelationshipInstance defining the relationship data. This will include the referenced object if it exists, the ObjectIdentifier used to identify the referenced object, and any properties specific to this relationship. Only objects within the specified DacQueryScopes scope will be returned. To return non-composite or system references the scope must be set to include externals. In addition, in this case only the ObjectIdentifier of the referenced object will be returned.
Public method GetReferencedRelationshipInstances(DacQueryScopes) For each object referenced by this TSqlObject, returns the ModelRelationshipInstance defining the relationship data. This will include the referenced object if it exists, the ObjectIdentifier used to identify the referenced object, and any properties specific to this relationship. Only objects within the specified DacQueryScopes scope will be returned. To return non-composite or system references the GetReferencedRelationshipInstances(DacExternalQueryScopes) method should be called instead.
Public method GetReferencedRelationshipInstances(ModelRelationshipClass) For objects referenced by this TSqlObject with a specific ModelRelationshipClass, returns the ModelRelationshipInstance defining the relationship data. This will include the referenced object if it exists, the ObjectIdentifier used to identify the referenced object, and any properties specific to this relationship. Only objects within the Default scope will be returned.
Public method GetReferencedRelationshipInstances(ModelRelationshipClass, DacExternalQueryScopes) For objects referenced by this TSqlObject with a specific ModelRelationshipClass, returns the ModelRelationshipInstance defining the relationship data. This will include the referenced object if it exists, the ObjectIdentifier used to identify the referenced object, and any properties specific to this relationship. Only objects within the specified DacExternalQueryScopes scope will be returned. To return non-composite or system references the scope must be set to include externals. In addition, in this case only the ObjectIdentifier of the referenced object will be returned.
Public method GetReferencedRelationshipInstances(ModelRelationshipClass, DacQueryScopes) For objects referenced by this TSqlObject with a specific ModelRelationshipClass, returns the ModelRelationshipInstance defining the relationship data. This will include the referenced object if it exists, the ObjectIdentifier used to identify the referenced object, and any properties specific to this relationship. Only objects within the specified DacQueryScopes scope will be returned. To return non-composite or system references the GetReferencedRelationshipInstances(DacExternalQueryScopes) method should be called instead.
Public method GetReferencing() Gets all referencing objects within the Default scope.
Public method GetReferencing(DacQueryScopes) Gets all referencing objects within a given DacQueryScopes scope.
Public method GetReferencing(ModelRelationshipClass) Gets referencing objects, where the relationship is defined by a specific ModelRelationshipClass and where objects are within the Default scope.
Public method GetReferencing(ModelRelationshipClass, DacQueryScopes) Gets referencing objects, where the relationship is defined by a specific ModelRelationshipClass and where objects are within a given DacQueryScopes scope.
Public method GetReferencingRelationshipInstances() For each object referencing this TSqlObject, returns the ModelRelationshipInstance defining the relationship data. This will include the referencing object - definedby the FromObject field, and any properties specific to this relationship. Only objects within the specified DacQueryScopes scope will be returned.
Public method GetReferencingRelationshipInstances(DacQueryScopes) For each object referencing this TSqlObject, returns the ModelRelationshipInstance defining the relationship data. This will include the referencing object - definedby the FromObject field, and any properties specific to this relationship. Only objects within the Default scope will be returned.
Public method GetReferencingRelationshipInstances(ModelRelationshipClass) For each object referencing this TSqlObject with a specific ModelRelationshipClass, returns the ModelRelationshipInstance defining the relationship data. This will include the referencing object - definedby the FromObject field, and any properties specific to this relationship. Only objects within the Default scope will be returned.
Public method GetReferencingRelationshipInstances(ModelRelationshipClass, DacQueryScopes) For each object referencing this TSqlObject with a specific ModelRelationshipClass, returns the ModelRelationshipInstance defining the relationship data. This will include the referencing object - definedby the FromObject field, and any properties specific to this relationship. Only objects within the specified DacQueryScopes scope will be returned.
Public method GetScript Generates a CREATE script from the objects AST.
Public method GetType (Inherited from Object.)
Public method ToString (Inherited from Object.)
Public method TryGetAst Attempts to generate an AST for the object.
Public method TryGetScript Attempts to generate a script from the object’s AST.

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.Dac.Model Namespace