Microsoft.SqlServer.ConnectionInfo

Network protocols

TcpIp

NamedPipes

Multiprotocol

AppleTalk

BanyanVines

Via

SharedMemory

NWLinkIpxSpx

NotSpecified

the possible values of server configuration

The server has a Standalone configuration The server has a Cloud configuration

The possible values returned by SERVERPROPERTY('EngineEdition'). See for more details

Currently these values are duplicated in src\Microsoft\SqlServer\Management\Smo\enumerations.cs Eventually we would like to remove the type defined there (see TFS#7818885) but until that happens make sure to update both enums with any changes *

Personal or Desktop Engine (Not available in SQL Server 2005 (9.x) and later versions.)

Standard (For Standard, Web, and Business Intelligence.)

Enterprise (For Evaluation, Developer, and Enterprise editions.)

Express (For Express, Express with Tools, and Express with Advanced Services)

Azure SQL Database

Azure Synapse dedicated SQL pool (formerly DataWarehouse)

Stretch Database

Azure SQL Managed Instance

Azure SQL Edge (For all editions of Azure SQL Edge)

Azure Arc Managed SQL Instance

Azure Synapse serverless SQL pool (SQL OnDemand)

Statement execution constants are used to direct the behavior of the ExecuteImmediate method, altering execution behavior or interpretation of the statement submitted for execution

No statement execution options set

Ignore the command terminator in the script. Execute as a single batch

Batch execution continues on any error that does not break the connection

Execute SET NOEXEC ON prior to batch execution. Execute SET NOEXEC OFF after batch execution.

Execute SET PARSEONLY ON prior to batch execution. Execute SET PARSEONLY OFF after batch execution

Execute SET QUOTED_IDENTIFIER ON prior to batch execution. Execute SET QUOTED_IDENTIFIER OFF after batch execution.

Determines if SQL statements are captured or sent to the server.

execute sql

sql is captured

sql is executed and captured

none

System administrators

Server administrators

Setup administrators

Security administrators

Process administrators

Database creators

Disk administrators

Bulk insert administrators

regulates the disconnect policy

after statement is executed if connection is pooled disconnect connection

don't disconnect connection

Valid connection types

SQL Engine

DO NOT USE - the name is SQL Server Compact Edition

SQL CE

Possible values for Server.HostPlatform property in SMO

Type converters to use to translate enum values to their string values and back

Set of helper methods for use with the enums defined here

Gets the set of supported for a given

ConnectionException is the base class for most ConnectionInfo exceptions

Serialization constructor

This exception is thrown when an attempt is made to use a connected that is forced in disconnected mode

Constructor

Sets the AccessToken property on SqlConnection object

Get AccessToken from SqlConnection

Will be an empty string if AccessToken is not supported in the current .NET Framework (<4.6)

Creates SqlConnection from the SqlConnectionInfo class

connection settings and creation

TBD

Constructor. Initialize properties by using information from parameter sqlConnectionObject. If the status of sqlConnectionObject is Open, also query server for @@LOCK_TIMEOUT to set the LockTimeout property.

SqlConnection

Initialize the SqlConnection object.

if ConnectionString needs to be set.

Returns true if the object has been connected with the server at least once. If true, property changes are not allowed any more and ConnectionCannotBeChangedException will be thrown when a property has been changed.

LockTimeout is the Lock timeout in seconds. Default -1 is for indefinite. InvalidPropertyValueException is thrown for all other negative numbers. Positive LockTimeout will be multiplied by 1000 and then used for "SET LOCK_TIMEOUT" setting.

Returns the major version number of SQL Server. I.e. 8 for SQL Server 2000. Exceptions: ConnectionFailureException

Gets the ProductVersion server property of this connection

Returns the database engine type of SQL Server. Exceptions: ConnectionFailureException

The edition of the Database Engine

Returns true if the server is a part of Microsoft Fabric

Returns the server collation

The host platform of the server (Linux/Windows/etc)

Connection protocol.

Returns true if the database engine authenticates using contained authentication. Exceptions: ConnectionFailureException

Returns a reference to the SqlConnection object used by the ConnectionContext object. This should always return the valid sqlConnection object with the latest valid ConnectionString set. Exceptions: PropertyNotAvailableException

Returns the current database context.

connects to the server impersonating if necessary

Creates the actual connection to SQL Server. Ignored if already connected. It is optional to call this method, as the connection will be opened when required. Exceptions: ConnectionFailureException

Defines all the Methods used to Execute T-SQL on a server in the ServerConnection object.

Executes T-SQL using the appropriate methods depending on the action information passed as the parameter.

Defines method to be used for executing T-SQL Object on which that method needs to be called DataSet in which data need to filled in case of SqlDataAdapter execObject If the exception to be caught.

Determines if a SqlException is related to expired access tokens

The SqlException to check True if the exception is related to expired tokens, false otherwise

Attempts to prepare the connection for retry after an exception

The SqlException that occurred The current database context to restore Whether to catch and retry on exceptions True if a retry should be attempted, false otherwise

Executes T-SQL asynchronously using the appropriate methods depending on the action information passed as the parameter.

Defines method to be used for executing T-SQL SqlCommand to execute If the exception to be caught. Cancellation token for the async operation Task containing the result of the execution

Populates a DataTable asynchronously from a SqlCommand by executing it as a reader

Handles exceptions during async SQL execution with retry logic

Verifies that a given database exists

Check if we are connecting to a supported server version. block off <= 7.0 in ServerConnection.

Closes the connection with SQL Server. Ignored if already disconnected. Exceptions: ConnectionFailureException

connects only if not already connected

disconnects only if it is pooled

Returns true if the SqlConnection object is connected with the server. This can only return true for non pooled connections as pooled connections are always closed directly after an operation.

Occurs when the state of the connection changes. Uses System.Data.StateChangeEventHandler.

Occurs when SQL Server returns a warning or informational message. Uses SqlClient.SqlInfoMessageEventHandler.

Event that is called each time a T-SQL statement has been executed and capture is set This allows users to add a event hook to trace T-SQL statements.

Called when the server needs to connect to remote servers and the login fails

Enforces a disconnect and ensures that connection cannot be re-opened again

Indicates that the connection has been forcefully disconnected

connection settings and creation

Infinite wait

TBD

The name of the SQL Server the object will connect to. If not set, the local server is implied. Exceptions: ConnectionCannotBeChangedException InvalidPropertyValueException

true if Login property has been initialized

The SQL Server Login name that is used to connect to the server. Exceptions: ConnectionCannotBeChangedException InvalidPropertyValueException PropertyNotSetException

true if Password property has been initialized

The password that is used with Login to connect to the server. Exceptions: ConnectionCannotBeChangedException InvalidPropertyValueException PropertyNotSetException

If set to true, Windows integrated security is used and Login and Password are ignored. If not set, Sql Server Authentication is used. Exceptions: ConnectionCannotBeChangedException

Specifies the Windows user that is used when creating an impersonated connection. The user must have interactive logon privileges. Exceptions: ConnectionCannotBeChangedException InvalidPropertyValueException PropertyNotSetException

Two user name formats are supported: "domain\user" and "user@domain"

Specifies password of the Windows user that is used when creating an impersonated connection. Exceptions: ConnectionCannotBeChangedException InvalidPropertyValueException PropertyNotSetException

If set to true, the connection will be made with the credentials of the specified user. This will assume impersonation, however the LoginSecure flags and Login and Password fields will not be affected. This setting is only usable on Windows.

By default, all connections to SQL Server are taken from an ADO.NET connection pool.If set to true, this allows users to create a non-pooled connection (will not be reused when closed). Exceptions: ConnectionCannotBeChangedException

When a connection is returned to the pool, its creation time is compared with the current time, and the connection is destroyed if that time span (in seconds) exceeds the value specified by connection lifetime. Exceptions: ConnectionCannotBeChangedException InvalidPropertyValueException

The minimum number of connections maintained in the pool. Exceptions: ConnectionCannotBeChangedException InvalidPropertyValueException

The maximum number of connections allowed in the pool. Exceptions: ConnectionCannotBeChangedException InvalidPropertyValueException

The length of time (in seconds) to wait for a connection to the server before terminating the attempt and throwing an exception. Default is 30 seconds (same as Shiloh). Exceptions: ConnectionCannotBeChangedException InvalidPropertyValueException

The authentication type of the connection

The application intent of the connection Valid values are ReadWrite and ReadOnly

Indicate whether the client trusts the server certificate

The property will return either the user specified connection string or it will return the computed connection string based on object settings. If explicitly set, All properties in the ServerConnection object will be populated to reflect the passed in connection string. Exceptions: ConnectionCannotBeChangedException InvalidPropertyValueException

The property will return a SecureString version of either the user specified connection string or it will return the computed connection string based on object settings. If explicitly set, All properties in the ServerConnection object will be populated to reflect the passed in connection string. Exceptions: ConnectionCannotBeChangedException

Identifies the client network protocol that is used to connect to SQL Server. If you do not specify a network and you use a local server, shared memory is used. If you do not specify a network and you use a remote server, the one of the configured client protocols is used. Exceptions: ConnectionCannotBeChangedException InvalidPropertyValueException

true if ApplicationName property has been initialized

The name of the application. 'SQL Management' if no application name has been provided. Exceptions: ConnectionCannotBeChangedException InvalidPropertyValueException

true if WorkstationId property has been initialized

The name of the workstation connecting to SQL Server. Exceptions: ConnectionCannotBeChangedException InvalidPropertyValueException

true if DatabaseName property has been initialized

TBD

Size in bytes of the network packets used to communicate with an instance of SQL Server. Default is 8192. Exceptions: ConnectionCannotBeChangedException InvalidPropertyValueException

Enable MARS from the connection. Default is false.

Returns true if the current values for LoginSecure and Authentication use the Login property

Returns true if the current values for LoginSecure and Authentication require a Login property to be set

whether "encrypt=true" is specified in the connection string

Whether "encrypt=strict" is specified in the connection string. When true, the value of is ignored.

The host name provided in certificate to be used for certificate validation.

The path to server certificate to be used for certificate validation.

Returns whether additional parameters have been specified in connection string

check that we are not already connected

check if the input value is valid ( != null )

string to be checked

check if the input value is valid ( > 0 )

integer to be checked

builds the connection string

Set Authentication using reflection

Set the ApplicationIntent of the SqlConnectionStringBuilder. If the property is not supported or we have an invalid ApplicationIntent the value is ignored.

Gets the InitialCatalog.

Tells us whether ConnectionString needs to be reset in SqlConnectionObject property of ConnectionManager or not.

Helper methods for enum DatabaseEngineType

This method always returns false Once we fix all the dependents to remove matrix related code, we shall remove this class

Utility methods for working with SecureStrings

Decrypt a SecureString

The secure string to decrypt

Encrypt a string

The string to encrypt

General utility methods.

Makes the string a SQL identifier.

Makes the string a unicode sql string.

Escape the specified cEsc character

ExecutionCache is a simple cache that manages cached items. The cache holds up to #capacity# number of items and will remove the first item it added to the cache when it is full. It is intent to be used by a single thread. Implementation note: The access time is linear to the number of item in the cache. The cache is initially extracted from ServerConnection such that the cache and item management can be unit tested thoughtfully without configuration. It is not designed to be a widely-used cache utilities class. It is generalized for testability.

Constructor.

The capacity of the cache. If item is added when the cache is full, the first item of the cache will be evicted.

Returns true of the cache contains an item with the specified key.

Add a cache item into the cache. The item must have a unique key. The item and key must not be null.

Item to be added Throws to indicate another item in the cache has the same key as the specified item

Obtain the cache item with the specified key.

Clear results in all cache items.

Clear the cache.

Report if the cache is empty.

Report the number of item in the cache.

CacheItem is a item container for the payloads identified the same key. The CacheItem has three specific concepts, Key, Result and ExecutionCount. Each item is identified by its key, and it must be unique. Adding non-unique item to the cache results in exception. The Result and ExecutionCount is specific payload that a CacheItem supports. The result distinguishes between null result and no result by hasResult(). ExecutionCount is nothing more than a manual counter. Sub-class of CacheItem can add more payload that suite the purpose of them.

Constructor

The key of the cache item.

The result of the item

Returns to if result has been set.

Unset the result

Execution count

Interface for CreateOrAlter method. All classes that support create or alter implement this interface.

Create OR ALTER the object. First perform setup for execution Then validate "CREATE OR ALTER" syntax through ScriptCreateOrAlter(), Finally execute the query and do cleanup. return without exception.

Interface for DropIfExists method. All classes that support drop with existence check implement this interface.

Drops the object with IF EXISTS option. If object is invalid for drop function will return without exception.

Implemented by objects that can be dropped as part of the Alter command on their parent.

Sets the object in either ToBeDropped or Existing state

When true and the current object state is Existing, sets object state to ToBeDropped when its parent's Alter method is called. When false and the current object state is ToBeDropped, sets the object state to Existing

Implemented by objects that may prefer to have the UI confirm the rename before proceeding

Simple interface to hide details of access token renewal. Consumers of this interface must defer retrieval of the token string until the point of SqlConnectionUsage

Returns the expiration time of the most recently retrieved token If no token has been retrieved the value is undefined.

Returns an access token that can be used to query the associated Resource until the TokenExpiry time

The URL of the resource associated with the token

The tenant id associated with the token

The user id associated with the token

This interface is a high-level connection interface.

Returns if the connection is currently active.

Name of the server we are connecting to.

Returns the version of the service we are connected to.

Enforces a disconnect and ensures that connection cannot be re-opened again

Indicates that the connection has been forcefully disconnected

The name of the resources containing localized property category, name, and description strings

The name of the resources containing localized property category and name strings

Returns true if the keys should be picked up by defaults or if they should be retrieve as attributes

Constructor

The name of the resources (e.g. Microsoft.SqlServer.Foo.BarStrings)

Constructor

the name of the resource (e.g. Microsoft.SqlServer.Foo.BarStrings)

Constructor

The type of the resources (e.g. Microsoft.SqlServer.Foo.BarStrings)

A factory method for getting an instance of the type that implements IDisplayKey

Gets the Display value for a field

Gets the Display value for a property

Gets the Display value for a Type

Retrives the key from the resource manager

Retrives the first key value from the customAttribute and retrives the value from the resource manager

A helper class for getting an empty string if the value is null

Returns the default key for a property

/// Returns the default key for a type

/// Returns the default key for a field

The key used to look up the localized property category

The key used to look up a localized property category in a default resource file

The key used to look up a localized type category in a default resource file

The key used to look up a localized field category in a default resource file

Constructor

The key used to look up the localized property category

The key used to look up the localized property name

The AttributeTargets.Field is added to allow this attribute to be placed on Enum elements which the EnumConverter will use to localize each Enum value

The key used to look up the localized property name

The key used to look up a localized property category in a default resource file

Constructor

The key used to look up the localized property name

The key used to look up the localized description

The key used to look up the localized property description

The key used to look up a localized property category in a default resource file

Constructor

The key used to look up the localized property description

The ICommonDynamicVisible interface should be implemented by any class that wants to limit the visibility of certain Enum values based on state of the class at that moment. If a class contains a property which exposes an Enum and that class implements the ICommonDynamicVisible interface then it will be called for each property that is of an Enum type. The context param can be used to determine for which Enum this method is being called. If a class only has one Enum it is not necessary to make this check. The way to limit the visibility of certain items is to simply remove the unwanted Enum values from the values ArrayList. This method is called on every drop down of the enum so it is possible to change the list on each and every drop down. If the list will not change once it has been initially determined caching the ArrayList and returning it would be helpful. Care should be taken to ensure that you are not removing values that the Enum property is already set to. This will not cause any errors as all Enum values are still valid but when the user clicks on the dropdown they will not see the current choice as an option. Also no new values should be added to the list since these values will not be convertable to valid Enum values and an error will be thrown at runtime. If more dynamic control is needed then consider using the DynamicValues design.

Removing items from the values list and returning that new list will control the values shown in the Enum specified in context. The enum can be determined with code similar to the following if (context.PropertyDescriptor.PropertyType == typeof(myEnum))

The CommonLocalizableEnumConverter allows for the values of an Enum to be converted to localized strings based on the DisplayNameKey attribute applied to the individual items in the Enum.

public enum ScriptModeOptions { [DisplayNameKey("CreateOnlyMode")] scriptCreateOnly, [DisplayNameKey("DropOnlyMode")] scriptDropOnly }

Load display names for the enum fields

The .NET Type for the enum The resource manager used to load localized field names

Load localized display names for the enum fields from a resource manager

The .NET Type for the enum The resource manager used to load localized field names

Load the field names for the enum

this is called when there are no localized strings for the field names. In lieu of localized field names, the method puts the C# enum field names in the field name dictionary. The .NET Type for the enum

This constructor is used by our internal PropertyDescriptor when it is created automatically for any Enum property.

This constructor is the default constructor that would be used if this converter is placed on an Enum class directly and not via the abstraction through the LocalizedTypeConverter attribute on the containing class.

used to translate the enum value into the localized string.

Get the enum value based on the string. This uses the hashtable lookup to increase perf.

Does the conversion from Enum to string and the odd string to string. All others are passed on to the base

Does the conversion from string to enum and the odd enum to enum. All others are passed on to the base

Returns the list of values for the list box in the property grid. If the ICommonDynamicVisible interface is defined then we call into that to get the manipulated values array. If not then we just return the list of values.

whether connection should be opened with encryption

Deep copy

get the HTOKEN of the specifies user, this token can then be used to impersonate the user

Thrown when LogonUser API fails

Returns a comparer which matches the server's master database string comparer

Utility used for comparing database names using the same semantics as the target server

Gets or sets a value indicating the QueryParameterizationMode all ServerConnection instances use

Gets or sets the UseMode all ServerConnection instances use

Gets or sets a value indicating whether ServerConnection instances should cache query results

Creates a ServerConnection object taking in the token. The extra boolean is used to overload this constructor as another constructor with string is present.

An optional access token provider

Constructs a new ServerConnection object from the given SqlConnection

Constructs a new ServerConnection object

This function performs a deep copy

Used to add the query parameters when the query is in parameterization mode ParameterizeLiterals

Match delegate method for parameter replacement RegEx Adds each parameter value to parameter collection during RegEx search of query text Returns parameter marker (e.g., @P0) for insertion into query text

Match object passed in by RegEx engine Marker corresponding to value added to parameter collection

Translate a query with embedded literals to a normalized form (all literals replaced by a standard token)

Examples: SELECT * FROM table WHERE column = 123 becomes: SELECT * FROM table WHERE column = ? SELECT * FROM table WHERE column = 'foo' becomes: SELECT * FROM table WHERE column = '?' Query text to normalize Switch indicating whether query text expects QUOTED_IDENTIFER to be enabled Query text with inline literals translated to ? symbols

Overload for the above function -- see it for details

Creates a SqlCommand with CommandText set to the specified query

This is the number of seconds that a statement is attempted to be sent to the server before it fails. Default is 600 seconds (same as Shiloh). Exceptions: InvalidPropertyValueException

Temporary function needed as long as the sql enumerator is unaware of the SqlStoreConnection type

Executes the T-SQL statements in the StringCollection. The command termininator ('GO') is recognized by ExecuteNonQuery. Batches separated with the GO statement will be sent and executed individually. The statement is recorded and not executed if CaptureMode has been set to true. An array of int values is returned that contain the numbers of rows affected for each statement in the StringCollection. If multiple batches are executed, the total numbers of affected rows of all batches is returned. The Connect() method will be called if the connection with the server is not open. Exceptions: ConnectionFailureException ExecutionFailureExeception

Whether we should retry if an exception is thrown during execution

Executes a T-SQL statement. The command termininator ('GO') is recognized by ExecuteNonQuery. Batches will be sent and executed individually. The statement is recorded and not executed if CaptureMode has been set to true. An int value is returned that contain the numbers of rows affected. If multiple batches are executed, the total numbers of affected rows of all batches is returned. The Connect() method will be called if the connection with the server is not open. Exceptions: ConnectionFailureException ExecutionFailureExeception

Whether we should retry if an exception is thrown during execution

Defines the batch separator used by the ExecuteNonQuery methods. Default is "GO". The batch separator is case-insensitive.

Executes the T-SQL statements in the StringCollection. An array of DataSets are returned that contain the results for each statement in the StringCollection. The Connect() method will be called if the connection with the server is not open. Exceptions: ConnectionFailureException ExecutionFailureExeception

Executes the T-SQL statements in sqlCommand. A DataSet is returned that contains the results. The Connect() method will be called if the connection with the server is not open. Exceptions: ConnectionFailureException ExecutionFailureExeception

Whether we should retry if an exception is thrown during execution

Executes T-SQL statements. A SqlDataReader object is returned that can be used to read the stream of rows that are returned by SQL Server. The Connect() method will be called if the connection with the server is not open. it doesn't automatically disconnect Exceptions: ConnectionFailureException ExecutionFailureExeception

The SQL command text. The data reader.

Executes T-SQL statements. A SqlDataReader object is returned that can be used to read the stream of rows that are returned by SQL Server. A SqlCommand object is also returned that can be used to cancel the data reader pipe if an abort of a long-running query is needed. it doesn't automatically disconnect Exceptions: ConnectionFailureException ExecutionFailureExeception

The SQL command text. The resulting SqlCommand object for data reader pipe cancellation. The data reader.

Executes T-SQL statements. A SqlDataReader object is returned that can be used to read the stream of rows that are returned by SQL Server. Exceptions: ConnectionFailureException ExecutionFailureExeception

SQL command object. The data reader.

Returns a SqlDataReader with an active connection.

Ready to execute sqlcommand object.

Executes the T-SQL statements in the StringCollection. An array of objects are returned that each contain the first column of the first row of the result set of each executed statement. The Connect() method will be called if the connection with the server is not open. Exceptions: ConnectionFailureException ExecutionFailureExeception

Executes a T-SQL statement. An objects is returned that contains the first column of the first row of the result set. The Connect() method will be called if the connection with the server is not open. Exceptions: ConnectionFailureException ExecutionFailureExeception

Executes a T-SQL statement asynchronously. The command terminator ('GO') is recognized by ExecuteNonQueryAsync. Batches will be sent and executed individually. The statement is recorded and not executed if CaptureMode has been set to true. An int value is returned that contains the number of rows affected. If multiple batches are executed, the total number of affected rows of all batches is returned. The Connect() method will be called if the connection with the server is not open.

The T-SQL command to execute Cancellation token for the async operation Task containing the number of rows affected

Executes T-SQL statements asynchronously from a collection of commands. The command terminator ('GO') is recognized by ExecuteNonQueryAsync. Batches separated with the GO statement will be sent and executed individually. The statement is recorded and not executed if CaptureMode has been set to true. Commands are executed sequentially. If cancellation is requested mid-batch, the currently executing command is cancelled and remaining commands are not executed. The Connect() method will be called if the connection with the server is not open.

Collection of SQL commands to execute Cancellation token for the async operation Task containing the number of rows affected by each command

Executes T-SQL statements asynchronously. A SqlDataReader object is returned that can be used to read the stream of rows that are returned by SQL Server. The Connect() method will be called if the connection with the server is not open. It doesn't automatically disconnect - caller is responsible for disposing the reader.

The SQL command text Cancellation token for the async operation Task containing the data reader

Executes the T-SQL statements asynchronously in sqlCommand. A DataTable is returned that contains the results. The Connect() method will be called if the connection with the server is not open.

The SQL command Cancellation token for the async operation Task containing a DataTable with the results

Executes the T-SQL statements asynchronously from a collection of commands. A DataTable is returned that contains the combined results. The Connect() method will be called if the connection with the server is not open. Commands are executed sequentially. If cancellation is requested mid-batch, the currently executing command is cancelled and remaining commands are not executed.

Collection of SQL commands to execute Cancellation token for the async operation Task containing a DataTable with the combined results

Executes a T-SQL statement asynchronously. An object is returned that contains the first column of the first row of the result set. The Connect() method will be called if the connection with the server is not open.

The SQL command Cancellation token for the async operation Task containing the scalar result

Starts a new transaction. If CaptureMode is true, the transaction statement will be added to the capture buffer.It is possible to nest transactions. It is the user's responsibility to commit or rollback every opened transaction. It is not guaranteed that all T-SQL emitted by the object model, can be encapsulated by a transaction. Furthermore, the state of the objects that have been changed will not reflect the actual database state until a transaction has been committed or after a transaction has been rolled backed. It is the responsibility of the user to refresh affected objects. Use with care.

Commits a transaction. If CaptureMode is true, the transaction command will be added to the capture buffer. Exceptions: NotInTransactionException

Aborts a transaction (all changes made will not be saved to the database). If CaptureMode is true, the transaction command will be added to the capture buffer. Exceptions: NotInTransactionException

Provides the transaction depth as counted by the object model. This doesn't include any transactions that may have been started on the server, or by issuing BEGIN TRAN with the ExecuteNonQuery method.

Determines if SQL statements are captured or sent to the server.

Returns an enum that specified the fixed server role the login is member of.

Tests if login is member of any of the specified server roles.

The UserProfile property returns a high-level role description for the Microsoft SQL Server login used by the current connection.

The ProcessID property returns the SQL Server process identifier for the connection used by the ServerConnection object.

The TrueLogin property returns the login record name used by the current connection.

The TrueName property returns the result set of the Microsoft® SQL Server global function @@INSTANCENAME.

Returns a connection that has the specified database name in the connection string. If the current connection is already referencing the given database, the current connection is returned.

Returns a connection that has the specified database name in the connection string If the current connection is already referencing the given database, the current connection is returned.

The factory also takes care of caching the connections

Gets the server comparer used for this connection factory

Gets the connection factory instance for the given server connection

Connection for which to get a factory A cached connection factory instance

Creates a new object

Connection for which to create the connection factory

Returns a connection that has the specified database name in the connection string

Database for which to get a connection Indicates if the connection should be pooled Access token for the connection Connection to the specified database

Helper function to create a ServerConnection object with the specified parameters

Connection string to use Initial database Indicates if pooling should be used Access token for the connection Server connection

Encapsulates server version, database engine type and database engine edition values into a single entity

Constructs a new ServerInformation object with the given values and HostPlatform of Windows Use this constructor only when the real value of the host platform isn't needed

Constructs a new ServerInformation object with the given values

net_transport value from dm_exec_connections for the current spid

The host platform of the connection as given by select host_platform from sys.dm_os_host_info

Returns Windows prior to 2016 (when this DMV was introduced)

The server version string given when this was initialized

The Product Version as given by SERVERPROPERTY('ProductVersion')

The DatabaseEngineType of the connection as given by SERVERPROPERTY('EDITION')

The DatabaseEngineEdition of the connection as given by SERVERPROPERTY('EngineEdition')

Protocol used for the connection.

Returns true if the server is running in Microsoft Fabric

The server collation as given by SERVERPROPERTY('Collation')

server version

initializes server version

major version

minor version

string representation in format Major.Minor.BuildNumber Example: 11.0.1234

Explicit conversion to .Net Version type

EventSource for SQL Server Management Objects (SMO) tracing. Provides structured logging for database operations, scripting, and execution management.

Singleton instance of the SmoEventSource.

Keywords for categorizing SMO events by functional area. Ordered by increasing likelihood of being needed for debugging (most common = lowest bit value).

General informational events not specific to a functional area.

Events related to database operations and connections.

Events related to execution management and SQL command processing.

Events related to connection lifecycle and management.

Events related to SFC (SQL Foundation Classes) operations.

Events related to SQL script generation and execution.

Events related to data enumeration and type handling.

Events related to database object transfer operations.

Events related to performance and timing measurements.

Events related to server event handling and subscriptions.

Events related to differencing operations.

Events related to serialization operations.

Event IDs used throughout the SMO EventSource. These IDs must remain stable for backwards compatibility.

Database connection or operation failure.

SQL exception during database operations.

General database operation message.

HADR query failure.

URN data retrieval operation.

Dependency resolution operation.

General execution manager message.

Connection retry exception caught and not thrown.

Connection configuration warning.

Connection attempt started.

Connection established successfully.

Connection closed or disconnected.

Connection failure with retry information.

Long-running query detected.

Query execution completed with timing.

Connection timeout occurred.

Script generation invocation.

Scripting progress update.

URN discovery during script generation.

Object creation script generation.

Script creation completion for individual objects.

Error in data type scripting.

Removal of all server event subscriptions.

Server event subscription updated.

Server event subscription added.

Server event subscription removed.

Server event subscription started.

Server event subscription query created.

Server event received.

Server event raised to handler.

General informational message.

SFC component trace message.

SFC exception logging.

SFC connection helper exception.

Differencing operation trace.

Differencing exception logging.

Transfer dependency discovery started.

Transfer scripting all discovered objects.

Transfer visiting object for dependency analysis.

Transfer marking node for cycle breaking.

Missing property warning during initialization.

Initializes a new instance of the SmoEventSource class.

Logs database connection or operation failures.

Current state of the database object. State of the property bag. Error message details.

Logs SQL exceptions during database operations.

SQL exception number. Current state of the database object.

Logs general database operation messages.

Database operation message.

Logs HADR (High Availability Disaster Recovery) query failures.

Primary error message. Inner exception message if available.

Logs URN (Uniform Resource Name) data retrieval operations.

The URN being processed.

Logs dependency resolution operations.

Logs general execution manager messages.

Execution manager message.

Logs connection retry exceptions that are caught and not thrown.

The exception message from the caught exception.

Logs connection configuration warnings.

The configuration warning message.

Logs connection attempt started.

Name of the server being connected to. Name of the database being connected to.

Logs successful connection establishment.

Time taken to establish connection in milliseconds. Name of the server connected to. Name of the database connected to.

Logs connection closure or disconnection.

Name of the server being disconnected from. Reason for disconnection.

Logs connection failure with retry information.

Whether a retry will be attempted. Name of the server that failed to connect. Error message from the connection failure.

Logs detection of long-running queries.

Duration of the query in milliseconds. Threshold that was exceeded. Text of the long-running query (truncated if necessary).

Logs query execution completion with timing information.

Duration of the query execution in milliseconds. Number of rows affected by the query. Text of the executed query (truncated if necessary).

Logs connection timeout occurrences.

Timeout value in seconds. Operation that timed out.

Logs script generation operations.

Number of URNs being scripted. List of URNs being processed.

Logs scripting progress updates.

Current progress stage.

Logs discovered URNs during script generation.

Number of URNs discovered. List of discovered URNs.

Logs object creation script generation.

Number of URNs for object creation. List of URNs being created.

Logs completion of script creation for individual objects.

URN of the completed object.

Logs removal of all server event subscriptions.

Logs when a server event subscription handler is updated.

The event class being updated. The target class name.

Logs when a server event subscription is added.

The event class being subscribed to. The target class name.

Logs when a server event subscription is removed.

The event class being unsubscribed from. The target class name.

Logs when a server event subscription is started.

The WMI scope path. The WQL query string.

Logs when a server event subscription query is created.

The WQL query string.

Logs when a server event is received from WMI.

The event class name. The target class name.

Logs when a server event is raised to a handler.

The event class name. The subscription key.

Logs errors in data type scripting.

Data type that caused the error.

Logs general informational messages.

General message.

Logs SFC component trace messages.

Name of the SFC component. Trace message.

Logs SFC exceptions that are caught.

The exception message.

Logs SFC exceptions that are caught with full exception details.

The exception to log.

Logs SFC connection helper exceptions.

The exception message.

Logs SFC connection helper exceptions with full exception details.

The exception to log.

Logs differencing operation trace messages.

Trace message.

Logs differencing exceptions that are caught.

The exception message.

Logs differencing exceptions that are caught with full exception details.

The exception to log.

Logs transfer dependency discovery phase.

Logs transfer scripting phase.

Logs transfer visiting an object for dependency analysis.

True if only non-system objects are added Information about the object being visited.

Logs transfer marking node for cycle breaking.

Information about the node being marked.

Logs missing property warnings during object initialization.

Whether the property is an expensive property. Whether the object is in design mode. Name of the missing property. Type name of the object. Current property bag state.

Deep copy

The Authentication Method used to log in

NotSpecified implies the real authentication type is inferred from other connection string parameters

User id and password are used for SQL login authentication

User id is an Azure AD principal

The current AD or Kerberos principal credentials are used to connect

Uses an interactive UI flow to acquire a token to authenticate. User id is optional.

Prompt the user to acquire a token from an external device

Use system assigned or user assigned managed identity to acquire a token.

Alias for ActiveDirectoryManagedIdentity

User id is the client id of an Azure service principal, and password is the client secret.

Attempts multiple non-interactive authentication methods tried sequentially to acquire an access token. This method does not fallback to the Active Directory Interactive authentication method.

The authentication method uses Active Directory Workload Identity. Use a federated User Assigned Managed Identity to connect to SQL Database from Azure client environments that have enabled support for Workload Identity. The 'User Id' or 'UID' is required to be set to the "client ID" of the user identity.

Checks whether "Authentication" is supported in the runtime environment

Retrieve the Authentication value from SqlConnectionStringBuilder and convert it to SqlConnectionInfo.AuthenticationMethod

SqlConnectionInfo.AuthenticationMethod

Initializes SqlConnectionInfo from ServerConnection object

return SqlConnectionInfo.AuthenticationMethod

ApplicationIntent for the connection

return whether to trust server certificate

The access token value to use for universal auth

Deep copy

Returns a new IDbConnection implementation. Callers should use this object and release the reference to it in a short amount of time, as the associated access token may have a limited lifetime.

Whether to set Encrypt=true in the connection string

Whether to set Encrypt=Strict in the connection string. If Strict is not supported by the current SqlClient, when true this value will set Encrypt=true

Sets host name provided in certificate to be used for certificate validation.

Sets Path to Server Certificate to be used for Certificate validation.

Checks whether "ApplicationIntent" is supported in the runtime environment

"ApplicationIntent" is not supported until .Net4.5

Deep copy

SqlDirectConnection is a simple ConnectionInfoBase that wraps a SqlConnection object.

Constructs a new SqlDirectConnection with no SqlConnection

Constructs a new SqlDirectConnection whose properties are calculated from the given SqlConnection

Returns the ServerName from the wrapped SqlConnection

Returns the wrapped SqlConnection

Deep copy

SqlServerManagementException is the base class for all SQL Management Objects exceptions.

Constructs a new SqlServerManagementException with an empty message and no inner exception

Constructs a new SqlServerManagementException with the given message and no inner exception

Constructs a new SqlServerManagementException with the given message and inner exception

ProductName specifies the ProdName value used in the HelpLink property of SqlServerManagementException instances.

constructor

Returns a copy of the string collection that contains the captured SQL statements. The buffer has to be explicitly cleared with Clear. NOTE: According to Dima, no memory will be copied over; will be handled by URT and therefore there is not added overhead.

Adds the string to the capture buffer.

Clears the capture buffer.

Event Handler for Statements

This class contains the details of an executed Sql statement.

TBD

statement executes Execution time

statement executed

execution time

string representation

the prototype of the callback method

Arguments for the event handler

Enables storage and retrieval of passwords from Windows Credential Manager, keyed by connection type and user name

Here are factors influencing the choice of key: 1. SSMS stores the list of saved connections in a versioned file, for both connection dialog and registered servers. If in SSMS 19 we decide we want to use the same credentials as 18, we can change this code to use the 18 instead of the SSMSMajorVersionString. Having a version allows us to change the semantic in the future, perhaps by encoding the entire blob in the store and enumerating all the credentials from there instead of from the BIN file. 2. There are multiple saved connection lists - SSMS registered servers, SqlRepl Ui registered servers, SSMS connection dialog. We have a repo name for each of those lists. 3. All the lists have groupings by server type, auth type, and user name. 4. We want it to be human readable so users can edit the passwords using the Windows ui if desired. Unfortunately the Windows UI truncates the key name in the display but that's beyond our control. The user has to hover over the name to see the full text in a tooltip.

Returns a key for Azure Data Studio credential

Stores the password for the given SSMS saved connection in Windows Credential Manager

The server name The type of authentication used by the connection. The meaning of the value depends on the The user name The type of server connection. The valid values are application dependent. The password The version identifier of the calling application Thrown when saving the password fails

Stores the password for the given RegSvr connection in Windows Credential Manager. Currently only used by SqlRepl UI, not to be confused with SSMS registered servers.

Returns the password from Windows Credential Manager for the given SSMS saved connection

Returns the password from Windows Credential Manager for the given RegSvr. Currently only used by SqlRepl UI, not to be confused with SSMS registered servers.

Removes the password of the given SSMS saved connection from Windows Credential Manager

Removes the password of the given registered server from Windows Credential Manager

Deep copy

Connection properties cannot be changed after a connection has been established.

Cannot perform this operation as there is no open transaction.

Failed to connect to server {server}.

Cannot apply value '{value}' to property {property}: {reason}.

Value cannot be null.

Property {property} is only supported on Windows operating systems.

Value cannot be smaller than {value}.

An exception occurred while executing a Transact-SQL statement or batch.

Property {property} was not set.

Cannot set {property} property because LoginSecure property is set to true.

Property {property} cannot be changed or read after a connection string has been set.

This SQL Server version ({serverVersion}) is not supported.

{className} class default constructor cannot be used.

Parse error occurred while looking for GO statement. Line {line}.

Password could not be changed.

Invalid LockTimeout value: {lockTimeout}.

Cache capacity must be greater than {capacity}.

The cache item returns a null key.

The cache already contains an item with the same key {key}.

Microsoft Azure SQL Database Edition

Microsoft Azure Synapse Analytics dedicated SQL pools Edition

Microsoft SQL Server Enterprise Edition

Microsoft SQL Server Express Edition

Microsoft SQL Server Personal Edition

Microsoft SQL Server Standard Edition

Microsoft SQL Server Stretch Database Edition

Microsoft Azure SQL Database Managed Instance Edition

Microsoft Azure Synapse Analytics serverless SQL pool on-demand Edition

Microsoft Azure SQL Edge Edition

Microsoft Azure Arc SQL Managed Instance Edition

Microsoft Azure SQL Database

Standalone SQL Server

InstAPI is required for this type, but it is not installed on this computer.

Could not instantiate InstAPI.

Could not load MethodInfo from InstAPI.

Failed to load assembly {assemblyName}. Error message: {originalerror}

This functionality is disabled in the SQLCLR. It is recommended that you execute from your client application.

ServerVersion cannot be set while connected.

Operation cannot be performed when the connection is forced to be disconnected.

TrueName cannot be set, unless the connection is forced to be disconnected.

TrueName must be set if the connection is forced to be disconnected.

The password for user '{userName}' could not be saved to the Windows credential manager.