FrameworkSqlResourceComponent Class
Inheritance Hierarchy
System.Object
Microsoft.TeamFoundation.Framework.Server.TeamFoundationSqlResourceComponent
Microsoft.TeamFoundation.Framework.Server.FrameworkSqlResourceComponent
Microsoft.TeamFoundation.Framework.Server.DatabasePartitionComponent
Namespace: Microsoft.TeamFoundation.Framework.Server
Assembly: Microsoft.TeamFoundation.Framework.Server (in Microsoft.TeamFoundation.Framework.Server.dll)
Syntax
'Declaration
Public MustInherit Class FrameworkSqlResourceComponent _
Inherits TeamFoundationSqlResourceComponent
public abstract class FrameworkSqlResourceComponent : TeamFoundationSqlResourceComponent
public ref class FrameworkSqlResourceComponent abstract : public TeamFoundationSqlResourceComponent
[<AbstractClass>]
type FrameworkSqlResourceComponent =
class
inherit TeamFoundationSqlResourceComponent
end
public abstract class FrameworkSqlResourceComponent extends TeamFoundationSqlResourceComponent
The FrameworkSqlResourceComponent type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
.gif "Protected method") |
FrameworkSqlResourceComponent() | |
|
FrameworkSqlResourceComponent(TeamFoundationRequestContext, String) | |
|
FrameworkSqlResourceComponent(String, Int32, Int32, Int32) |
Top
Properties
| Name | Description | |
|---|---|---|
.gif "Protected property") |
Author | The author is defined as the source of the change that caused the notification. See Author for more information. (Inherited from TeamFoundationSqlResourceComponent.) |
|
BoundParameters | Returns the number of currently bound parameters. (Inherited from TeamFoundationSqlResourceComponent.) |
|
Command | The SQL command that is used by the SqlResourceComponent. (Inherited from TeamFoundationSqlResourceComponent.) |
|
CommandText | Sql text for the current command. (Inherited from TeamFoundationSqlResourceComponent.) |
|
CommandTimeout | The CommandTimeout used for all executions unless otherwise specified for a given command. (Inherited from TeamFoundationSqlResourceComponent.) |
|
Connection | The SqlConnection used by this TeamFoundationSqlResourceComponent. (Inherited from TeamFoundationSqlResourceComponent.) |
|
ConnectionString | The connection string (Inherited from TeamFoundationSqlResourceComponent.) |
|
ContainerErrorCode | Read and Write the container error code for this component. (Inherited from TeamFoundationSqlResourceComponent.) |
.gif "Public property") |
DatabaseCategory | Read database category. (Inherited from TeamFoundationSqlResourceComponent.) |
|
DataReader | The SqlDataReader returned by the last SqlCommand execute. (Inherited from TeamFoundationSqlResourceComponent.) |
|
DataSource | Gets the name or network address of the instance of SQL Server to connect to. (Inherited from TeamFoundationSqlResourceComponent.) |
|
DeadlockPause | Number of milliseconds to pause before retrying after a deadlock occurs. (Inherited from TeamFoundationSqlResourceComponent.) |
|
ExecutionTimeThreshold | At which time do we trace this call (Inherited from TeamFoundationSqlResourceComponent.) |
|
InitialCatalog | Gets the name of the database associated with the component. (Inherited from TeamFoundationSqlResourceComponent.) |
|
IsSqlAzure | Returns true if component is used against SQL Azure. (Inherited from TeamFoundationSqlResourceComponent.) |
|
LoggingOptions | Controls whether TIME and IO statistics (or other information message output) should be collected and logged. (Inherited from TeamFoundationSqlResourceComponent.) |
|
MaxDeadlockRetries | Maximum number of times to retry the operation if a deadlock occurs. (Inherited from TeamFoundationSqlResourceComponent.) |
|
PartitionId | The id of the partition this component is associated with. (Inherited from TeamFoundationSqlResourceComponent.) |
|
PerformanceOptions | Whether or not to obtain context information, and how much to throttle. (Inherited from TeamFoundationSqlResourceComponent.) |
|
ProcedureName | Name of the procedure currently being executed. (Inherited from TeamFoundationSqlResourceComponent.) |
|
RequestContext | The request context of the current request. (Inherited from TeamFoundationSqlResourceComponent.) |
|
SelectedFeatures | Selected SQL resource component options. (Inherited from TeamFoundationSqlResourceComponent.) |
|
StatementIndex | Index used by the last AddStatement. -1 if AddStatement has not been called. (Inherited from TeamFoundationSqlResourceComponent.) |
|
TraceArea | Can be used in trace definitions to filter tracing to a specific area. (Inherited from TeamFoundationSqlResourceComponent.) |
|
TranslatedExceptions | Return the set of translated exceptions available from the integration resource component. (Overrides TeamFoundationSqlResourceComponent.TranslatedExceptions.) |
|
Version | The version of the service's schema (Inherited from TeamFoundationSqlResourceComponent.) |
Top
Methods
| Name | Description | |
|---|---|---|
|
AddStatement(String) | Add a statement to the current SQL batch. You must call PrepareSqlBatch before you call AddStatement. (Inherited from TeamFoundationSqlResourceComponent.) |
|
AddStatement(String, Int32) | Add a statement to the current SQL batch. You must call PrepareSqlBatch before you call AddStatement. If the number of parameters that will be added by using this statement will exceed the maximum number of allowed parameters in a single SQL batch, the statements that are already part of the batch will be executed, and then a new batch will begin with the statement that's being added. (Inherited from TeamFoundationSqlResourceComponent.) |
|
AddStatement(String, Int32, Boolean) | Add a statement to the current SQL batch. You must call PrepareSqlBatch before you call AddStatement. If the number of parameters that will be added by using this statement will exceed the maximum number of allowed parameters in a single SQL batch, the statements that are already part of the batch will be executed, and then a new batch will begin with the statement that's being added. (Inherited from TeamFoundationSqlResourceComponent.) |
|
AddStatement(String, Int32, Boolean, Boolean) | Add a statement to the current SQL batch. You must call PrepareSqlBatch before you call AddStatement. If the number of parameters that will be added by using this statement will exceed the maximum number of allowed parameters in a single SQL batch, the statements that are already part of the batch will be executed, and then a new batch will begin with the statement that's being added. (Inherited from TeamFoundationSqlResourceComponent.) |
.gif "Public method") |
BeginTransaction | Used to wrap several calls in a single transaction. All executes on this component will be in the transaction until Commit or RollBack are called. (Inherited from TeamFoundationSqlResourceComponent.) |
|
BindBinary(String, array<Byte[], SqlDbType) | This is a helper function that handles binding a binary value to a SqlParameter. (Inherited from TeamFoundationSqlResourceComponent.) |
|
BindBinary(String, array<Byte[], Int32, SqlDbType) | A helper function that handles binding a binary value to a sqlparameter. (Inherited from TeamFoundationSqlResourceComponent.) |
|
BindBoolean | A helper function that handles binding a Boolean or a bit value to a sqlparameter. (Inherited from TeamFoundationSqlResourceComponent.) |
|
BindByte(String, Byte) | A helper function that handles binding an 8-bit value to its sqlparameters. (Inherited from TeamFoundationSqlResourceComponent.) |
|
BindByte(String, Byte, Byte) | A helper function that handles binding an 8-bit value that might be null to its sqlparameters. (Inherited from TeamFoundationSqlResourceComponent.) |
|
BindDateTime | A helper function that handles binding a date/time value to a sqlparameter. (Inherited from TeamFoundationSqlResourceComponent.) |
|
BindDefault | A helper function that handles binding a value to default type. (Inherited from TeamFoundationSqlResourceComponent.) |
|
BindDouble | This is a helper function that takes care of binding 32 bit value to their sqlparameters. (Inherited from TeamFoundationSqlResourceComponent.) |
|
BindGuid | This is a helper function that handles binding GUIDs to their sqlparameters. (Inherited from TeamFoundationSqlResourceComponent.) |
|
BindInt | A helper function that handles binding a 32-bit value to its sqlparameters. (Inherited from TeamFoundationSqlResourceComponent.) |
|
BindLong | A helper function that handles binding a 64-bit value to its sqlparameters. (Inherited from TeamFoundationSqlResourceComponent.) |
|
BindNullableBoolean | This is a helper function that takes care of binding boolean or a bit value to a sqlparameter. (Inherited from TeamFoundationSqlResourceComponent.) |
|
BindNullableByte | This is a helper function that handles binding an 8-bit value to its SqlParameters. (Inherited from TeamFoundationSqlResourceComponent.) |
|
BindNullableDateTime | This is a helper function that takes care of binding a date/time value to a sqlparameter. (Inherited from TeamFoundationSqlResourceComponent.) |
|
BindNullableGuid | A helper function that handles binding GUIDs to their sqlparameters. The value Empty is considered NULL and a NULL is bound to the given parameter. (Inherited from TeamFoundationSqlResourceComponent.) |
|
BindNullableInt | If parameterValue == nullValue, a NULL is bound to the given parameter. Otherwise, parameterValue is bound as a 32-bit integer. (Inherited from TeamFoundationSqlResourceComponent.) |
|
BindNullableShort | If parameterValue == nullValue, a NULL is bound to the given parameter. Otherwise, parameterValue is bound as a 16-bit integer (Inherited from TeamFoundationSqlResourceComponent.) |
|
BindNullValue | This is a generic binding helper that builds a specific parameter typed null value. (Inherited from TeamFoundationSqlResourceComponent.) |
|
BindShort | This is a helper function that handles binding 16 bit value to their sqlparameters. (Inherited from TeamFoundationSqlResourceComponent.) |
|
BindString(String, String, Int32, BindStringBehavior, SqlDbType) | This is a helper function that handles binding strings to their SqlParameters. It makes sure that null values are correctly handled. (Inherited from TeamFoundationSqlResourceComponent.) |
|
BindString(String, String, Int32, Boolean, SqlDbType) | This is a helper function that handles binding strings to their SqlParameters.It makes sure that null values are correctly handled. This is the old version of this method; use the overload that takes a BindStringBehavior to be more explicit about how null and empty strings are to be handled. (Inherited from TeamFoundationSqlResourceComponent.) |
|
BindSysname | A helper function that handles binding sysname strings to their sqlparameters. It makes sure null values are correctly set up. (Inherited from TeamFoundationSqlResourceComponent.) |
|
BindTable<T> | Binds a table. (Inherited from TeamFoundationSqlResourceComponent.) |
|
BindVariant | (Inherited from TeamFoundationSqlResourceComponent.) |
|
BindXml(String, TeamFoundationDatabaseXmlWriter) | Used to bind an XML document to an XML parameter. (Inherited from TeamFoundationSqlResourceComponent.) |
|
BindXml(String, String) | Used to bind an XML document to an XML parameter. (Inherited from TeamFoundationSqlResourceComponent.) |
|
Cancel | (Inherited from TeamFoundationSqlResourceComponent.) |
|
CanRetryOnException | Indicates whether the SQL exception can be retried. (Inherited from TeamFoundationSqlResourceComponent.) |
|
CanRetryOnSqlError | (Inherited from TeamFoundationSqlResourceComponent.) |
|
CommitTransaction | Commit the transaction that is active for this component. (Inherited from TeamFoundationSqlResourceComponent.) |
|
Dispose | (Inherited from TeamFoundationSqlResourceComponent.) |
|
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
|
Execute | Internal helper that encapsulates the logic for ExecuteReader and ExecuteNonQuery. (Inherited from TeamFoundationSqlResourceComponent.) |
|
ExecuteNonQuery() | Executes the current SQL command and does not produce a result set. (Inherited from TeamFoundationSqlResourceComponent.) |
|
ExecuteNonQuery(Boolean) | Executes the current SQL command and does not produce a result set. The only result is the Return Value, which is a single scalar value. (Inherited from TeamFoundationSqlResourceComponent.) |
|
ExecuteReader() | Overload using default command behavior. (Inherited from TeamFoundationSqlResourceComponent.) |
|
ExecuteReader(CommandBehavior) | Executes the current SQL command and returns a reader. (Inherited from TeamFoundationSqlResourceComponent.) |
|
ExecuteScalar | Execute the current SQL command by using ExecuteScalar and stores the result. (Inherited from TeamFoundationSqlResourceComponent.) |
|
ExecuteUnknown(Object) | Executes the current SQL command by using ExecuteUnknown() and returns the object. (Inherited from TeamFoundationSqlResourceComponent.) |
|
ExecuteUnknown(SqlDataReader, Object) | The method that is used by ExecuteUnknown() to populate an object based on a reader caller of ExecuteUnknown must override this method. (Inherited from TeamFoundationSqlResourceComponent.) |
|
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
|
FlushBatch | Flushes the batch that is pended to this point and creates a new batch so that users may call AddStatement again. (Inherited from TeamFoundationSqlResourceComponent.) |
|
GetHashCode | Serves as the default hash function. (Inherited from Object.) |
|
GetParameterName | Helper method to format a parameter name. (Inherited from TeamFoundationSqlResourceComponent.) |
|
GetSqlErrorNumberAsString | Helper that returns all the error numbers in a string for tracing purposes It's not super efficient but should only be called in case SQL is having issues which *should* be rare. (Inherited from TeamFoundationSqlResourceComponent.) |
|
GetSqlErrorNumbers | Helper that returns all the error numbers contained in a sql exception object (Inherited from TeamFoundationSqlResourceComponent.) |
|
GetType | Gets the Type of the current instance. (Inherited from Object.) |
|
HandleCustomException | Handle custom exceptions. (Inherited from TeamFoundationSqlResourceComponent.) |
|
HandleException | Determine whether the SQL exception can be handled; SQL exceptions that cannot be retried or mapped are "unhandled." (Inherited from TeamFoundationSqlResourceComponent.) |
|
Initialize(String) | Initializes a component. (Inherited from TeamFoundationSqlResourceComponent.) |
|
Initialize(TeamFoundationRequestContext, String, Int32) | (Inherited from TeamFoundationSqlResourceComponent.) |
|
Initialize(String, Int32, Int32, Int32, Int32) | Initializes a component. (Inherited from TeamFoundationSqlResourceComponent.) |
|
MapException(SqlException) | Map a SQL exception into an application-specific exception, if it is possible. Otherwise, the exception is reported using Watson. (Inherited from TeamFoundationSqlResourceComponent.) |
|
MapException(SqlException, QueryExecutionState) | Map a SQL exception into an application-specific exception, if it is possible. Otherwise, the exception is reported using Watson. (Inherited from TeamFoundationSqlResourceComponent.) |
|
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
|
PrepareConnectionString | Allows derived classes to update connection string. (Inherited from TeamFoundationSqlResourceComponent.) |
|
PrepareSqlBatch(Int32) | Setup to execute a batch of SQL statements. This method will close all existing commands or readers. (Inherited from TeamFoundationSqlResourceComponent.) |
|
PrepareSqlBatch(Int32, Boolean) | Setup to execute a batch of SQL statements. This method will close all existing command or reader. (Inherited from TeamFoundationSqlResourceComponent.) |
|
PrepareStoredProcedure(String) | Setup to execute a SQL stored procedure. This method will close all existing commands or readers. (Inherited from TeamFoundationSqlResourceComponent.) |
|
PrepareStoredProcedure(String, Boolean) | Setup to execute a SQL Server stored procedure. This method will close all existing command or reader. (Inherited from TeamFoundationSqlResourceComponent.) |
|
PrepareStoredProcedure(String, Int32) | Setup to execute a SQL stored procedure. This method will close all existing commands or readers. (Inherited from TeamFoundationSqlResourceComponent.) |
|
PrepareStoredProcedure(String, Boolean, Int32) | Setup to execute a SQL Server stored procedure. This method will close all existing command or reader. (Inherited from TeamFoundationSqlResourceComponent.) |
|
ReleaseVerificationLock | (Inherited from TeamFoundationSqlResourceComponent.) |
|
RollbackTransaction | Roll back and discard all changes that were made during the transaction on this component. (Inherited from TeamFoundationSqlResourceComponent.) |
|
Sleep | (Inherited from TeamFoundationSqlResourceComponent.) |
|
ToString | Returns a string that represents the current object. (Inherited from Object.) |
|
Trace(Int32, TraceLevel, String, array<Object[]) | Push trace messages to the trace service associated with the request context. (Inherited from TeamFoundationSqlResourceComponent.) |
|
Trace(Int32, TraceLevel, array<String[], String, array<Object[]) | Push trace messages to the trace service associated with the request context. (Inherited from TeamFoundationSqlResourceComponent.) |
|
TraceEnter | Trace entry to a method with a consistently formatted message and a time stamp. (Inherited from TeamFoundationSqlResourceComponent.) |
|
TraceException | Report an exception at TraceLevel.Error to the trace log in a consistent way. (Inherited from TeamFoundationSqlResourceComponent.) |
|
TraceLeave | Trace exit from a method with a consistently formatted message and a time stamp. (Inherited from TeamFoundationSqlResourceComponent.) |
|
TranslateException | Examines a SQL Type Exception and transforms it into a more significant one.The default behavior is to do nothing; that is, it is to rethrow the original exception.WIT is the only component that currently overrides the current behavior. (Inherited from TeamFoundationSqlResourceComponent.) |
|
VerifyInitialized | Throws an InvalidOperationException if the component is not initialized. (Inherited from TeamFoundationSqlResourceComponent.) |
|
VerifyInMasterDbOnAzure | Throws InvalidOperationException if components is used against SQL Azure and the Initial Catalog in the connection string is not master or empty. (Inherited from TeamFoundationSqlResourceComponent.) |
|
VerifyNotSqlAzure | Throws NotSupportedException if components are used against SQL Azure. (Inherited from TeamFoundationSqlResourceComponent.) |
|
VerifyServiceVersion(String, Int32, Int32%, Int32%) | Connects to the database, takes a shared session lock on the TfsDb resource and verifies that the database supports specified service version.NOTE: This method will be re-written. We must query CONTEXT_INFO(), take a shared lock and query database service version using one query. In addition, we must make sure that the database still supports current component in case we lost connection to the database. (Inherited from TeamFoundationSqlResourceComponent.) |
|
VerifyServiceVersion(String, Int32, Int32%, Int32%, Boolean) | This method connects to the database, takes a shared or exclusive session lock on the TfsDb resource and verifies that the database supports specified service version. NOTE: This method will be re-written. We must query CONTEXT_INFO(), take a shared lock and query database service version using one query. In addition, we must ensure that the database still supports current component in case we lost connection to the database. (Inherited from TeamFoundationSqlResourceComponent.) |
Top
Events
| Name | Description | |
|---|---|---|
.gif "Public event") |
InfoMessage | Exposes the internal InfoMessage event of the SqlConnection. Occurs when SQL Server returns a warning or informational message. (Inherited from TeamFoundationSqlResourceComponent.) |
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.