Back to Devexpress

MSSqlConnectionProvider Members

xpo-devexpress-dot-xpo-dot-db-dot-mssqlconnectionprovider-dot-underscore-members.md

latest39.8 KB
Original Source

MSSqlConnectionProvider Members

Implements data-aware operations for working with an Microsoft SQL Server or Microsoft SQL Azure database.

Constructors

NameDescription
MSSqlConnectionProvider(IDbConnection, AutoCreateOption)Initializes a new instance of the MSSqlConnectionProvider class with the specified settings.

Fields

NameDescription
DefaultCommandTimeoutSpecifies the timeout value passed to the IDbCommand.CommandTimeout property of each created command, in seconds. Inherited from ConnectionProviderSql.
EnableConnectionStringArgumentEscaping staticInherited from ConnectionProviderSql.
GlobalDefaultCommandTimeout staticSpecifies the timeout value passed to the IDbCommand.CommandTimeout property, in seconds. Can be overridden by the ConnectionProviderSql.DefaultCommandTimeout field. The default is 300. Inherited from ConnectionProviderSql.
GlobalQueryParameterMode staticSpecifies how connection providers initialize command parameters. Use the QueryParameterMode property to change this setting for a specific connection provider. Inherited from ConnectionProviderSql.
GlobalUseLegacyDateOnlyAndTimeOnlySupport staticInherited from ConnectionProviderSql.
GlobalUseLegacySqlClient staticDisables the smart discovery service that loads a data provider library.
GlobalUseLegacyUntypedParameters staticThis property is now obsolete. Use GlobalQueryParameterMode instead. Inherited from ConnectionProviderSql.
IdentityColumnMagicName staticInherited from ConnectionProviderSql.
IsNotForReplication staticSpecifies whether or not the “NOT FOR REPLICATION” option is used in SQL statements that create constraints.
MaxDeadLockRetryDelayMilliseconds staticInherited from ConnectionProviderSql.
MaxDeadLockTryCount staticInherited from ConnectionProviderSql.
MaximumBinarySizeThis member supports the internal infrastructure and is not intended to be used directly from your code.
MaximumStringSizeThis member supports the internal infrastructure and is not intended to be used directly from your code.
ObjectsOwnerThe default owner of the objects in the Microsoft SQL database. By default “dbo”.
QueryParameterModeSpecifies how a connection provider initializes command parameters. Inherited from ConnectionProviderSql.
UseLegacyTimeSpanSupport staticInherited from ConnectionProviderSql.
UseLegacyUntypedParametersThis property is now obsolete. Use QueryParameterMode instead. Inherited from ConnectionProviderSql.
XpoProviderTypeParameterName staticReturns a parameter name used to denote a provider type in a connection string. The default value is “XpoProvider”. Inherited from DataStoreBase.
XpoProviderTypeStringGets the name of the current connection provider. This name is used internally when generating a connection string via the MSSqlConnectionProvider.GetConnectionString method.

Properties

NameDescription
AutoCreateOptionReturns which operations are performed when a data store is accessed for the first time. Inherited from DataStoreBase.
BraceJoinInherited from ConnectionProviderSql.
CanCreateDatabaseInherited from ConnectionProviderSql.
CanCreateSchemaInherited from ConnectionProviderSql.
ConnectionInherited from ConnectionProviderSql.
ConnectionStringInherited from ConnectionProviderSql.
CustomAggregatesGets a collection of custom aggregate functions supplied by the current metadata provider. Inherited from ConnectionProviderSql.
CustomFunctionOperatorsInherited from ConnectionProviderSql.
Factories staticReturns registered provider factories. Inherited from DataStoreBase.
NativeOuterApplySupportedIndicates whether the connection provider supports the OUTER APPLY operators.
NativeSkipTakeSupportedIndicates whether the connection provider supports the SKIP and TAKE (TOP) operators.
SupportNamedParametersInherited from ConnectionProviderSql.
SyncRootObsolete. This API is obsolete now. Inherited from ConnectionProviderSql.
TransactionInherited from ConnectionProviderSql.

Methods

NameDescription
ClearDatabase(IDbCommand) staticThis member supports the internal infrastructure and is not intended to be used directly from your code.
CollectTablesToCreate(ICollection)This method supports the internal infrastructure and is not intended to be called directly from your code.
CompareSchema(IEnumerable<DBTable>, SchemaMigrationOptions)Inherited from ConnectionProviderSql.
ComposeSafeColumnName(String)Inherited from ConnectionProviderSql.
ComposeSafeConstraintName(String)Inherited from ConnectionProviderSql.
ComposeSafeSchemaName(String)Returns the valid schema name for the specified table’s name.
ComposeSafeTableName(String)Inherited from ConnectionProviderSql.
CreateColumn(DBTable, DBColumn)Inherited from ConnectionProviderSql.
CreateCommand()Inherited from ConnectionProviderSql.
CreateConnection(String) staticFor internal use.
CreateForeignKey(DBTable, DBForeignKey)Inherited from ConnectionProviderSql.
CreateIndex(DBTable, DBIndex)Inherited from ConnectionProviderSql.
CreatePrimaryKey(DBTable)Inherited from ConnectionProviderSql.
CreateProviderFromConnection(IDbConnection, AutoCreateOption) staticThis method supports the internal infrastructure and is not intended to be called directly from your code.
CreateProviderFromString(String, AutoCreateOption, out IDisposable[]) staticThis method supports the internal infrastructure and is not intended to be called directly from your code.
CreateTable(DBTable)Inherited from ConnectionProviderSql.
EmptyAllTablesInDatabase(IDbCommand) staticThis method supports the internal infrastructure and is not intended to be used directly in your code.
Equals(Object, Object) staticDetermines whether the specified object instances are considered equal. Inherited from Object.
Equals(Object)Determines whether the specified object is equal to the current object. Inherited from Object.
EscapeConnectionStringArgument(String) staticInherited from ConnectionProviderSql.
ExecSql(Query)Inherited from ConnectionProviderSql.
ExecSqlAsync(Query, AsyncOperationIdentifier, CancellationToken)Inherited from ConnectionProviderSql.
ExecuteUpdateSchemaStatements(IEnumerable<UpdateSchemaStatement>)Inherited from ConnectionProviderSql.
ExplicitBeginTransaction()Inherited from ConnectionProviderSql.
ExplicitBeginTransaction(IsolationLevel)Inherited from ConnectionProviderSql.
ExplicitCommitTransaction()Inherited from ConnectionProviderSql.
ExplicitRollbackTransaction()Inherited from ConnectionProviderSql.
FormatBinary(BinaryOperatorType, String, String)This member supports the internal infrastructure and is not intended to be used directly from your code.
FormatColumn(String, String)This member supports the internal infrastructure and is not intended to be used directly from your code.
FormatColumn(String)This member supports the internal infrastructure and is not intended to be used directly from your code.
FormatColumnSafe(String)Inherited from ConnectionProviderSql.
FormatConstraint(String)This member supports the internal infrastructure and is not intended to be used directly from your code.
FormatConstraintSafe(String)Inherited from ConnectionProviderSql.
FormatDelete(String, String)This member supports the internal infrastructure and is not intended to be used directly from your code.
FormatFunction(FunctionOperatorType, String[])This member supports the internal infrastructure and is not intended to be used directly from your code.
FormatFunction(ProcessParameter, FunctionOperatorType, Object[])This member supports the internal infrastructure and is not intended to be used directly from your code.
FormatInsert(String, String, String)This member supports the internal infrastructure and is not intended to be used directly from your code.
FormatInsertDefaultValues(String)This member supports the internal infrastructure and is not intended to be used directly from your code.
FormatOrder(String, SortingDirection)Inherited from ConnectionProviderSql.
FormatOuterApply(String, String)Inherited from ConnectionProviderSql.
FormatSelect(String, String, String, String, String, String, Int32, Int32)This member supports the internal infrastructure and is not intended to be used directly from your code.
FormatSelect(String, String, String, String, String, String, Int32)Inherited from ConnectionProviderSql.
FormatTable(String, String, String)This member supports the internal infrastructure and is not intended to be used directly from your code.
FormatTable(String, String)This member supports the internal infrastructure and is not intended to be used directly from your code.
FormatTableSafe(DBTable)Inherited from ConnectionProviderSql.
FormatUnary(UnaryOperatorType, String)Inherited from ConnectionProviderSql.
FormatUpdate(String, String, String)This member supports the internal infrastructure and is not intended to be used directly from your code.
FormatUpdateSchemaScript(IEnumerable<UpdateSchemaStatement>)Inherited from ConnectionProviderSql.
FormatUpdateSchemaStatements(IEnumerable<UpdateSchemaStatement>)Inherited from ConnectionProviderSql.
GenerateStoredProcedures(DBTable, out String)Generates DDL (Data Description Language) code for the Generating Persistent Classes wizard, when mapping persistent classes to Microsoft SQL Server database views with the help of INSTEAD-OF triggers and stored procedures.
GenerateStoredProceduresInfoOnce()Inherited from ConnectionProviderSql.
GetColumnType(DbType, Boolean) staticInherited from ConnectionProviderSql.
GetConnectionString(String, Int32, String, String, String) staticReturns a connection string used to open a specified Microsoft SQL database using provided login credentials.
GetConnectionString(String, Int32, String) staticReturns a connection string used to open a specified Microsoft SQL database using provided login credentials.
GetConnectionString(String, String, String, String) staticReturns a connection string used to open a specified Microsoft SQL database using provided login credentials.
GetConnectionString(String, String) staticReturns a connection string used to open a specified Microsoft SQL database using Windows Integrated Security.
GetConnectionString2005CacheRoot(String, String, String, String) staticReturns a connection string used to open a specified Microsoft SQL database using provided login credentials and to enable the SqlDependency feature.
GetConnectionString2005CacheRoot(String, String) staticReturns a connection string used to open a specified Microsoft SQL database using Windows Integrated Security and to enable the SqlDependency feature.
GetConnectionString2005WithCache(String, String, String, String) staticReturns a connection string used to open a specified Microsoft SQL database using provided login credentials and to enable the SqlDependency feature.
GetConnectionString2005WithCache(String, String) staticReturns a connection string used to open a specified Microsoft SQL database using Windows Integrated Security and to enable the SqlDependency feature.
GetConnectionStringWithAttach(String, String, Boolean) staticReturns a connection string to connect to a Microsoft SQL Server database by attaching a specified .mdf database file to a specific server using Windows Integrated Security.
GetConnectionStringWithAttach(String, String, String, String, Boolean) staticReturns a connection string to connect to a Microsoft SQL Server database by attaching a specified .mdf database file to a specific server using specified login credentials.
GetConnectionStringWithAttachForLocalDB(String, String, String) staticReturns the connection string to SQL Server 2012 Express LocalDB for the specified server, database and database file location.
GetConnectionStringWithoutIntegratedSecurity(String, String, String, String) static
GetConnectionStringWithoutIntegratedSecurity(String, String, String) static
GetCustomAggregate(String)Searches custom aggregate functions registered in an application via the RegisterCustomAggregate(ICustomAggregateFormattable) and RegisterCustomAggregates(ICollection<ICustomAggregateFormattable>) method calls for a function with the specified name. Inherited from ConnectionProviderSql.
GetCustomFunctionOperator(String)Inherited from ConnectionProviderSql.
GetDbType(DBColumnType) staticInherited from ConnectionProviderSql.
GetHashCode()Serves as the default hash function. Inherited from Object.
GetLifetimeService()Retrieves the current lifetime service object that controls the lifetime policy for this instance. Inherited from MarshalByRefObject.
GetParameterName(OperandValue, Int32, ref Boolean)This member supports the .NET Framework infrastructure and cannot be used directly from your code.
GetSqlCreateColumnFullAttributes(DBTable, DBColumn, Boolean)
GetSqlCreateColumnFullAttributes(DBTable, DBColumn)This method supports the internal infrastructure and is not intended to be used directly from your code.
GetStorageTables(String[])Inherited from ConnectionProviderSql.
GetStorageTablesList(Boolean)Returns a list of the available tables in the data store.
GetStoredProcedures()This member supports the internal infrastructure and is not intended to be used directly from your code.
GetTableSchema(DBTable, Boolean, Boolean)This member supports the internal infrastructure and is not intended to be used directly from your code.
GetType()Gets the Type of the current instance. Inherited from Object.
InitializeLifetimeService()Obtains a lifetime service object to control the lifetime policy for this instance. Inherited from MarshalByRefObject.
MemberwiseClone() protectedCreates a shallow copy of the current Object. Inherited from Object.
MemberwiseClone(Boolean) protectedCreates a shallow copy of the current MarshalByRefObject object. Inherited from MarshalByRefObject.
ModifyData(ModificationStatement[])Inherited from ConnectionProviderSql.
ModifyDataAsync(CancellationToken, ModificationStatement[])Inherited from ConnectionProviderSql.
QueryDataStore(IDbConnection, AutoCreateOption) staticCreates a data store based on specified settings. Inherited from DataStoreBase.
QueryDataStore(String, String, AutoCreateOption, out IDisposable[]) staticCreates a data store based on specified settings. Inherited from DataStoreBase.
ReferenceEquals(Object, Object) staticDetermines whether the specified Object instances are the same instance. Inherited from Object.
Register() staticRegisters the provider for use with XPO.
RegisterCustomAggregate(ICustomAggregateFormattable)Registers a custom aggregate function to use in any CriteriaOperator-based criteria in your application. Inherited from ConnectionProviderSql.
RegisterCustomAggregates(ICollection<ICustomAggregateFormattable>)Registers custom aggregate functions to use in any CriteriaOperator-based criteria in your application. Inherited from ConnectionProviderSql.
RegisterCustomFunctionOperator(ICustomFunctionOperatorFormattable)Inherited from ConnectionProviderSql.
RegisterCustomFunctionOperators(ICollection<ICustomFunctionOperatorFormattable>)Inherited from ConnectionProviderSql.
RegisterDataStoreProvider(String, DataStoreCreationFromConnectionDelegate) staticRegisters a data store provider using a specified connection type name and a procedure that establishes a connection for the provider. Inherited from DataStoreBase.
RegisterDataStoreProvider(String, DataStoreCreationFromStringDelegate) staticRegisters a data store provider using a specified name and a procedure that establishes a connection for the provider. Inherited from DataStoreBase.
RegisterFactory(ProviderFactory) staticRegisters a specified data store provider factory. Inherited from DataStoreBase.
SelectData(SelectStatement[])Inherited from ConnectionProviderSql.
SelectDataAsync(CancellationToken, SelectStatement[])Inherited from ConnectionProviderSql.
ToString()Returns a string that represents the current object. Inherited from Object.
UnregisterCustomAggregate(ICustomAggregateFormattable)Unregisters a specified custom aggregate function from use in any ConnectionProviderSql-based connection provider in your application. Inherited from ConnectionProviderSql.
UnregisterCustomAggregate(String)Unregisters a custom aggregate function with the specified name from use in any ConnectionProviderSql-based connection provider in your application. Inherited from ConnectionProviderSql.
UnregisterCustomFunctionOperator(ICustomFunctionOperatorFormattable)Inherited from ConnectionProviderSql.
UnregisterCustomFunctionOperator(String)Inherited from ConnectionProviderSql.
UpdateSchema(DBTable[])Updates a data store’s schema according to specified settings. Inherited from DataStoreBase.
UpdateSchema(Boolean, DBTable[])Inherited from ConnectionProviderSql.
UpdateSchemaAsync(CancellationToken, Boolean, DBTable[])Inherited from ConnectionProviderSql.

Events

NameDescription
ReconnectedInherited from ConnectionProviderSql.

See Also

MSSqlConnectionProvider Class

DevExpress.Xpo.DB Namespace