Share via

DataSourceInformation Class

  • Article

Allows you to retrieve well-defined information about a specified data source in the form of properties constructed as name/value pairs.

Inheritance Hierarchy

System.Object
  Microsoft.VisualStudio.Data.Framework.DataSiteableObject<IVsDataConnection>
    Microsoft.VisualStudio.Data.Framework.DataSourceInformation
      Microsoft.VisualStudio.Data.Framework.AdoDotNet.AdoDotNetSourceInformation

Namespace:  Microsoft.VisualStudio.Data.Framework
Assembly:  Microsoft.VisualStudio.Data.Framework (in Microsoft.VisualStudio.Data.Framework.dll)

Syntax

'Declaration
Public MustInherit Class DataSourceInformation _
    Inherits DataSiteableObject(Of IVsDataConnection) _
    Implements IVsDataSourceInformation

public abstract class DataSourceInformation : DataSiteableObject<IVsDataConnection>, 
    IVsDataSourceInformation

public ref class DataSourceInformation abstract : public DataSiteableObject<IVsDataConnection^>, 
    IVsDataSourceInformation

[<AbstractClass>]
type DataSourceInformation =  
    class
        inherit DataSiteableObject<IVsDataConnection>
        interface IVsDataSourceInformation
    end

public abstract class DataSourceInformation extends DataSiteableObject<IVsDataConnection> implements IVsDataSourceInformation

The DataSourceInformation type exposes the following members.

Constructors

  Name Description
Protected method DataSourceInformation() Initializes a new instance of the DataSourceInformation class.
Protected method DataSourceInformation(IVsDataConnection) Initializes a parameterized instance of the DataSourceInformation class that provides the data connection.

Top

Properties

  Name Description
Public property Item Gets a data source information property with the specified name.
Public property Site Gets or sets the object site. (Inherited from DataSiteableObject<T>.)

Top

Methods

  Name Description
Protected method AddProperty(String) Adds a property to the list of supported properties.
Protected method AddProperty(String, Object) Adds a property and its value to the list of supported properties.
Public method Contains Retrieves a Boolean value indicating whether a specified property is contained in this data source information instance.
Public method Equals Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType() Gets the Type of the current instance. (Inherited from Object.)
Protected method GetType(String) Retrieves the Type value indicating the type of a specified property, thus enabling appropriate conversion of a retrieved value to the correct type.
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method OnSiteChanged Raises the SiteChanged event. (Inherited from DataSiteableObject<T>.)
Protected method RetrieveValue Retrieves a value for a specified data source information property.
Public method ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Events

  Name Description
Public event SiteChanged Occurs when the Site property is changed. (Inherited from DataSiteableObject<T>.)

Top

Fields

  Name Description
Public fieldStatic member CatalogInvalidCharacters Specifies the data source information property that provides a string of characters that are not valid, that is, that may not appear in a generic catalog name.
Public fieldStatic member CatalogInvalidStartCharacters Specifies the data source information property that provides a string of characters whose use at the start of a generic catalog name is not valid.
Public fieldStatic member CatalogIsSuffixed Specifies the data source information property that indicates whether a catalog name is suffixed on a multi-part object identifier, as opposed to being a prefix.
Public fieldStatic member CatalogMaxLength Specifies the data source information property that indicates the maximum length of a catalog name.
Public fieldStatic member CatalogSeparator Specifies the data source information property that indicates the character separating a catalog name from the other parts in an object identifier.
Public fieldStatic member CatalogSupported Specifies the data source information property that indicates whether a catalog name is supported in a multi-part object identifier.
Public fieldStatic member CatalogSupportedInDml Specifies the data source information property that indicates whether a catalog name is supported in object identifiers that appear in SQL DML clauses.
Public fieldStatic member ColumnAliasInvalidCharacters Specifies the data source information property that provides a string of characters whose appearance in a column alias is not valid.
Public fieldStatic member ColumnAliasInvalidStartCharacters Specifies the data source information property that provides a string of characters whose appearance at the start of a column alias is not valid.
Public fieldStatic member ColumnAliasMaxLength Specifies the data source information property that indicates the maximum length of a column alias.
Public fieldStatic member ColumnAliasSupported Specifies the data source information property that indicates whether a column alias is supported in a multi-part object identifier.
Public fieldStatic member ColumnInvalidCharacters Specifies the data source information property that provides a string of characters whose appearance in a column name is not valid.
Public fieldStatic member ColumnInvalidStartCharacters Specifies the data source information property that provides a string of characters whose appearance at the start of a column name is not valid.
Public fieldStatic member ColumnMaxLength Specifies the data source information property that indicates the maximum length of a column name.
Public fieldStatic member ColumnSupported Specifies the data source information property that indicates whether a column name is supported in a multi-part object identifier.
Public fieldStatic member CommandDeriveParametersSupport Specifies what types of commands are supported by the DeriveParameters method.
Public fieldStatic member CommandDeriveSchemaSupport Specifies what types of commands are supported by the DeriveSchema method.
Public fieldStatic member CommandExecuteSupport Specifies what types of commands are supported by the Execute(String, DataCommandType, array<IVsDataParameter[], Int32) and ExecuteWithoutResults(String, DataCommandType, array<IVsDataParameter[], Int32) methods.
Public fieldStatic member CommandParameterSupport Specifies which parameter directions are supported.
Public fieldStatic member CommandPrepareSupport Specifies which types of commands are supported by the Prepare(String, DataCommandType, array<IVsDataParameter[], Int32) method.
Public fieldStatic member DataSourceCulture Specifies the geographical culture of the data source.
Public fieldStatic member DataSourceName Specifies the name of the data source.
Public fieldStatic member DataSourceProduct Specifies the name of the product of the data source.
Public fieldStatic member DataSourceVersion Specifies the version of the data source.
Public fieldStatic member DateLiteralPrefix Specifies the data source information property that provides the character or characters that prefix a date/time literal.
Public fieldStatic member DateLiteralSuffix Specifies the data source information property that provides the character or characters that suffix a date/time literal.
Public fieldStatic member DefaultCatalog Specifies the data source information property that provides the name of the default catalog.
Public fieldStatic member DefaultSchema Specifies the data source information property that provides the name of the default schema.
Public fieldStatic member IdentifierCloseQuote Specifies the data source information property that provides the character used to close an identifier part that needs to be enclosed in quotation marks.
Public fieldStatic member IdentifierOpenQuote Specifies the data source information property that provides the character used to open an identifier part that needs to be enclosed in quotation marks.
Public fieldStatic member IdentifierPartsCaseSensitive Specifies the data source information property that indicates whether identifier parts are treated as case sensitive.
Public fieldStatic member IdentifierPartsStorageCase Specifies the data source information property that indicates the case of identifier parts that are stored in the data source.
Public fieldStatic member IndexInvalidCharacters Specifies the data source information property that provides a string of characters whose appearance as an index name is not valid.
Public fieldStatic member IndexInvalidStartCharacters Specifies the data source information property that provides a string of characters whose appearance at the start of an index name is not valid.
Public fieldStatic member IndexMaxLength Specifies the data source information property that indicates the maximum length of an index name.
Public fieldStatic member IndexSupported Specifies the data source information property that indicates whether an index name is supported in a multi-part object identifier.
Public fieldStatic member LikeClausePercent Specifies the data source information property that indicates the wildcard character used to capture zero or more characters within values for a LIKE clause in a SQL DML statement.
Public fieldStatic member LikeClausePercentEscape Specifies the data source information property that indicates the character used to escape the LikeClausePercent character within values for a LIKE clause in a SQL DML statement.
Public fieldStatic member LikeClauseUnderscore Specifies the data source information property that indicates the wildcard character used to capture a single character within values for a LIKE clause in a SQL DML statement.
Public fieldStatic member LikeClauseUnderscoreEscape Specifies the data source information property that indicates the character used to escape the LikeClauseUnderscore character within values for a LIKE clause in a SQL DML statement.
Public fieldStatic member ParameterPrefix Specifies the data source information property that provides the character used to prefix a parameter name.
Public fieldStatic member ParameterPrefixInName Specifies the data source information property that indicates whether the parameter prefix should appear in the value set for the Name property.
Public fieldStatic member ProcedureInvalidCharacters Specifies the data source information property that provides a string of characters whose appearance in a procedure name is not valid.
Public fieldStatic member ProcedureInvalidStartCharacters Specifies the data source information property that provides a string of characters whose appearance at the start of a procedure name is not valid.
Public fieldStatic member ProcedureMaxLength Specifies the data source information property that indicates the maximum length of a procedure name.
Public fieldStatic member ProcedureSupported Specifies the data source information property that indicates whether a procedure name is supported in a multi-part object identifier.
Public fieldStatic member QuotedIdentifierPartsCaseSensitive Specifies the data source information property that indicates whether identifier parts enclosed in quotation marks are treated as case sensitive.
Public fieldStatic member QuotedIdentifierPartsStorageCase Specifies the data source information property that indicates the case of identifier parts enclosed in quotation marks that are stored in the data source.
Public fieldStatic member ReservedWords Specifies the data source information property that provides the set of reserved words on the data source.
Public fieldStatic member SchemaInvalidCharacters Specifies the data source information property that provides a string of characters whose appearance in a schema name is not valid.
Public fieldStatic member SchemaInvalidStartCharacters Specifies the data source information property that provides a string of characters whose appearance at the start of a schema name is not valid.
Public fieldStatic member SchemaMaxLength Specifies the data source information property that indicates the maximum length of a schema name.
Public fieldStatic member SchemaSeparator Specifies the data source information property that indicates the character separating a schema name from the other parts of an object identifier.
Public fieldStatic member SchemaSupported Specifies the data source information property that indicates whether a schema name is supported in a multi-part object identifier.
Public fieldStatic member SchemaSupportedInDml Specifies the data source information property that indicates whether a schema name is supported in object identifiers that appear in SQL DML clauses.
Public fieldStatic member ServerSeparator Specifies the data source information property that indicates the character separating a server name from the other parts of an object identifier.
Public fieldStatic member SupportsAnsi92Sql Specifies the data source information property that indicates whether the data source supports the ANSI92 SQL standard.
Public fieldStatic member SupportsCommandTimeout Specifies the data source information property that indicates whether command timeouts are supported.
Public fieldStatic member SupportsNestedTransactions Specifies the data source information property that indicates whether transactions can be started, committed, or rolled back inside other transactions.
Public fieldStatic member SupportsQuotedIdentifierParts Specifies the data source information property that indicates whether identifier parts enclosed in quotation marks are supported.
Public fieldStatic member SupportsVerifySql Specifies the data source information property that indicates whether SQL verification is supported.
Public fieldStatic member TableAliasInvalidCharacters Specifies the data source information property that provides a string of characters whose appearance in a table alias is not valid.
Public fieldStatic member TableAliasInvalidStartCharacters Specifies the data source information property that provides a string of characters whose appearance at the start of a table alias is not valid.
Public fieldStatic member TableAliasMaxLength Specifies the data source information property that indicates the maximum length of a table alias.
Public fieldStatic member TableAliasSupported Specifies the data source information property that indicates whether a table alias is supported in a multi-part object identifier.
Public fieldStatic member TableInvalidCharacters Specifies the data source information property that provides a string of characters whose appearance in a table name is not valid.
Public fieldStatic member TableInvalidStartCharacters Specifies the data source information property that provides a string of characters whose appearance at the start of a table name is not valid.
Public fieldStatic member TableMaxLength Specifies the data source information property that indicates the maximum length of a table name.
Public fieldStatic member TableSupported Specifies the data source information property that indicates whether a table name is supported in a multi-part object identifier.
Public fieldStatic member UserInvalidCharacters Specifies the data source information property that provides a string of characters whose appearance in a user name is not valid.
Public fieldStatic member UserInvalidStartCharacters Specifies the data source information property that provides a string of characters whose appearance at the start of a user name is not valid.
Public fieldStatic member UserMaxLength Specifies the data source information property that indicates the maximum length of a user name.
Public fieldStatic member UserSupported Specifies the data source information property that indicates whether a user name is supported in a multi-part object identifier.
Public fieldStatic member ViewInvalidCharacters Specifies the data source information property that provides a string of characters whose appearance in a view name is not valid.
Public fieldStatic member ViewInvalidStartCharacters Specifies the data source information property that provides a string of characters whose appearance at the start of a view name is not valid.
Public fieldStatic member ViewMaxLength Specifies the data source information property that indicates the maximum length of a view name.
Public fieldStatic member ViewSupported Specifies the data source information property that indicates whether a view name is supported in a multi-part object identifier.

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.VisualStudio.Data.Framework Namespace