commands

^

New-DbaConnectionString

Author Chrissy LeMaire (@cl), netnerds.net
Availability Windows, Linux, macOS

 

Synopsis

Builds or extracts a SQL Server Connection String

Description

Builds or extracts a SQL Server Connection String. Note that dbatools-style syntax is used.

So you do not need to specify "Data Source", you can just specify -SqlInstance and -SqlCredential and we'll handle it for you.

This is the simplified PowerShell approach to connection string building. See examples for more info.

See https://msdn.microsoft.com/en-us/library/system.data.sqlclient.sqlconnection.connectionstring.aspx and https://msdn.microsoft.com/en-us/library/system.data.sqlclient.sqlconnectionstringbuilder.aspx and https://msdn.microsoft.com/en-us/library/system.data.sqlclient.sqlconnection.aspx

Syntax

New-DbaConnectionString
    [-SqlInstance] <DbaInstanceParameter[]>
    [[-Credential] <PSCredential>]
    [[-AccessToken] <String>]
    [[-ApplicationIntent] <String>]
    [[-BatchSeparator] <String>]
    [[-ClientName] <String>]
    [[-ConnectTimeout] <Int32>]
    [[-Database] <String>]
    [-EncryptConnection]
    [[-FailoverPartner] <String>]
    [-IsActiveDirectoryUniversalAuth]
    [[-LockTimeout] <Int32>]
    [[-MaxPoolSize] <Int32>]
    [[-MinPoolSize] <Int32>]
    [-MultipleActiveResultSets]
    [-MultiSubnetFailover]
    [[-NetworkProtocol] <String>]
    [-NonPooledConnection]
    [[-PacketSize] <Int32>]
    [[-PooledConnectionLifetime] <Int32>]
    [[-SqlExecutionModes] <String>]
    [[-StatementTimeout] <Int32>]
    [-TrustServerCertificate]
    [[-WorkstationId] <String>]
    [[-AppendConnectionString] <String>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

 

Examples

 

Example: 1
PS C:\> New-DbaConnectionString -SqlInstance sql2014

Creates a connection string that connects using Windows Authentication

Example: 2
PS C:\> Connect-DbaInstance -SqlInstance sql2016 | New-DbaConnectionString

Builds a connected SMO object using Connect-DbaInstance then extracts and displays the connection string

Example: 3
PS C:\> $wincred = Get-Credential ad\sqladmin
PS C:\> New-DbaConnectionString -SqlInstance sql2014 -Credential $wincred

Creates a connection string that connects using alternative Windows credentials

Example: 4
PS C:\> $sqlcred = Get-Credential sqladmin
PS C:\> $server = New-DbaConnectionString -SqlInstance sql2014 -Credential $sqlcred

Login to sql2014 as SQL login sqladmin.

Example: 5
PS C:\> $connstring = New-DbaConnectionString -SqlInstance mydb.database.windows.net -SqlCredential [email protected] -Database db

Creates a connection string for an Azure Active Directory login to Azure SQL db. Output looks like this:
Data Source=TCP:mydb.database.windows.net,1433;Initial Catalog=db;User [email protected];Password=fakepass;MultipleActiveResultSets=False;Connect
Timeout=30;Encrypt=True;TrustServerCertificate=False;Application Name="dbatools PowerShell module - dbatools.io";Authentication="Active Directory Password"

Example: 6
PS C:\> $server = New-DbaConnectionString -SqlInstance sql2014 -ClientName "mah connection"

Creates a connection string that connects using Windows Authentication and uses the client name "mah connection". So when you open up profiler or use extended events, you can search for "mah
connection".

Example: 7
PS C:\> $server = New-DbaConnectionString -SqlInstance sql2014 -AppendConnectionString "Packet Size=4096;AttachDbFilename=C:\MyFolder\MyDataFile.mdf;User Instance=true;"

Creates a connection string that connects to sql2014 using Windows Authentication, then it sets the packet size (this can also be done via -PacketSize) and other connection attributes.

Example: 8
PS C:\> $server = New-DbaConnectionString -SqlInstance sql2014 -NetworkProtocol TcpIp -MultiSubnetFailover

Creates a connection string with Windows Authentication that uses TCPIP and has MultiSubnetFailover enabled.

Example: 9
PS C:\> $connstring = New-DbaConnectionString sql2016 -ApplicationIntent ReadOnly

Creates a connection string with ReadOnly ApplicationIntent.

Required Parameters

-SqlInstance

The target SQL Server instance or instances.

Alias ServerInstance,SqlServer,Server,DataSource
Required True
Pipeline true (ByValue)
Default Value

Optional Parameters

-Credential

Login to the target instance using alternative credentials. Accepts PowerShell credentials (Get-Credential). Windows Authentication, SQL Server Authentication, Active Directory - Password, and Active Directory - Integrated are all supported. For MFA support, please use Connect-DbaInstance. be it Windows or SQL Server. Windows users are determined by the existence of a backslash, so if you are intending to use an alternative Windows connection instead of a SQL login, ensure it contains a backslash.

Alias SqlCredential
Required False
Pipeline false
Default Value
-AccessToken

Basically tells the connection string to ignore authentication. Does not include the AccessToken in the resulting connecstring.

Alias
Required False
Pipeline false
Default Value
-ApplicationIntent

Declares the application workload type when connecting to a server. Possible values are ReadOnly and ReadWrite.

Alias
Required False
Pipeline false
Default Value
Accepted Values ReadOnly,ReadWrite
-BatchSeparator

By default, this is "GO"

Alias
Required False
Pipeline false
Default Value
-ClientName

By default, this command sets the client's ApplicationName property to "dbatools PowerShell module - dbatools.io". If you're doing anything that requires profiling, you can look for this client name. Using -ClientName allows you to set your own custom client application name.

Alias
Required False
Pipeline false
Default Value custom connection
-ConnectTimeout

The length of time (in seconds) to wait for a connection to the server before terminating the attempt and generating an error. Valid values are greater than or equal to 0 and less than or equal to 2147483647. When opening a connection to a Azure SQL Database, set the connection timeout to 30 seconds.

Alias
Required False
Pipeline false
Default Value 0
-Database

Database name

Alias
Required False
Pipeline false
Default Value
-EncryptConnection

When true, SQL Server uses SSL encryption for all data sent between the client and server if the server has a certificate installed. Recognized values are true, false, yes, and no. For more information, see Connection String Syntax. Beginning in .NET Framework 4.5, when TrustServerCertificate is false and Encrypt is true, the server name (or IP address) in a SQL Server SSL certificate must exactly match the server name (or IP address) specified in the connection string. Otherwise, the connection attempt will fail. For information about support for certificates whose subject starts with a wildcard character (*), see Accepted wildcards used by server certificates for server authentication.

Alias
Required False
Pipeline false
Default Value False
-FailoverPartner

The name of the failover partner server where database mirroring is configured. If the value of this key is "", then Initial Catalog must be present, and its value must not be "". The server name can be 128 characters or less. If you specify a failover partner but the failover partner server is not configured for database mirroring and the primary server (specified with the Server keyword) is not available, then the connection will fail. If you specify a failover partner and the primary server is not configured for database mirroring, the connection to the primary server (specified with the Server keyword) will succeed if the primary server is available.

Alias
Required False
Pipeline false
Default Value
-IsActiveDirectoryUniversalAuth

Azure related

Alias
Required False
Pipeline false
Default Value False
-LockTimeout

Sets the time in seconds required for the connection to time out when the current transaction is locked.

Alias
Required False
Pipeline false
Default Value 0
-MaxPoolSize

Sets the maximum number of connections allowed in the connection pool for this specific connection string.

Alias
Required False
Pipeline false
Default Value 0
-MinPoolSize

Sets the minimum number of connections allowed in the connection pool for this specific connection string.

Alias
Required False
Pipeline false
Default Value 0
-MultipleActiveResultSets

When used, an application can maintain multiple active result sets (MARS). When false, an application must process or cancel all result sets from one batch before it can execute any other batch on that connection.

Alias
Required False
Pipeline false
Default Value False
-MultiSubnetFailover

If your application is connecting to an AlwaysOn availability group (AG) on different subnets, setting MultiSubnetFailover provides faster detection of and connection to the (currently) active server. For more information about SqlClient support for Always On Availability Groups

Alias
Required False
Pipeline false
Default Value False
-NetworkProtocol

Connect explicitly using 'TcpIp','NamedPipes','Multiprotocol','AppleTalk','BanyanVines','Via','SharedMemory' and 'NWLinkIpxSpx'

Alias
Required False
Pipeline false
Default Value
Accepted Values TcpIp,NamedPipes,Multiprotocol,AppleTalk,BanyanVines,Via,SharedMemory,NWLinkIpxSpx
-NonPooledConnection

Request a non-pooled connection

Alias
Required False
Pipeline false
Default Value False
-PacketSize

Sets the size in bytes of the network packets used to communicate with an instance of SQL Server. Must match at server.

Alias
Required False
Pipeline false
Default Value 0
-PooledConnectionLifetime

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. This is useful in clustered configurations to force load balancing between a running server and a server just brought online. A value of zero (0) causes pooled connections to have the maximum connection timeout.

Alias
Required False
Pipeline false
Default Value 0
-SqlExecutionModes

The SqlExecutionModes enumeration contains values that are used to specify whether the commands sent to the referenced connection to the server are executed immediately or saved in a buffer. Valid values include CaptureSql, ExecuteAndCaptureSql and ExecuteSql.

Alias
Required False
Pipeline false
Default Value
Accepted Values CaptureSql,ExecuteAndCaptureSql,ExecuteSql
-StatementTimeout

Sets the number of seconds a statement is given to run before failing with a time-out error.

Alias
Required False
Pipeline false
Default Value 0
-TrustServerCertificate

Sets a value that indicates whether the channel will be encrypted while bypassing walking the certificate chain to validate trust.

Alias
Required False
Pipeline false
Default Value False
-WorkstationId

Sets the name of the workstation connecting to SQL Server.

Alias
Required False
Pipeline false
Default Value
-AppendConnectionString

Appends to the current connection string. Note that you cannot pass authentication information using this method. Use -SqlInstance and, optionally, -SqlCredential to set authentication information.

Alias
Required False
Pipeline false
Default Value
-WhatIf

If this switch is enabled, no actions are performed but informational messages will be displayed that explain what would happen if the command were to run.

Alias wi
Required False
Pipeline false
Default Value
-Confirm

If this switch is enabled, you will be prompted for confirmation before executing any operations that change state.

Alias cf
Required False
Pipeline false
Default Value

 

Want to see the source code for this command? Check out New-DbaConnectionString on GitHub.
Want to see the Bill Of Health for this command? Check out New-DbaConnectionString.