Skip to main content

SQL Server Connection

The installer prompts for the SQL Server connection. Change it afterwards with configure_server. The connection is global: every Speediful operation uses it.

Run configure_server from a PowerShell prompt running with administrator permissions, either interactively (recommended) or with command-line parameters. A Windows Start menu item also updates your server connection.

Speediful prompts for each setting in turn. Press Enter to accept the default in brackets, or type a new value. After saving, Speediful verifies the settings with a test connection.

The ODBC driver step lists only the SQL Server ODBC drivers installed on this machine, with the best available driver marked <- recommended and pre-selected. Choose Other (enter manually) to type a driver name yourself (for example, one installed under a name Speediful doesn't recognize).

(admin powershell prompt)
PS C:\WINDOWS\system32> cd "C:\Program Files\Speediful\SLAM"
PS C:\Program Files\Speediful\SLAM> .\speediful_slam.exe configure_server
Version: x.x.x; Build: xxxxxxxxxx [xxxxxx] (xxxxxxxxxxxxx)
Process ID: 25636


**Configure SQL Server connection settings**
Press Enter to accept defaults shown in [brackets]

SQL Server [localhost]:
Select ODBC driver:
1. ODBC Driver 18 for SQL Server <- recommended
2. ODBC Driver 17 for SQL Server
3. Other (enter manually)
Choice [1]:
Select database authentication mode:
1. Windows Authentication (Trusted_Connection) <- current
2. SQL Server Authentication (username / password)
3. Microsoft Entra Password (experimental)
4. Microsoft Entra Integrated (experimental)
5. Microsoft Entra Service Principal (experimental)
6. Microsoft Entra Managed Identity (experimental)
7. Microsoft Entra Default (experimental)
Choice [1]:
Encrypt connection (true/false) [True]:
Trust server certificate (true/false) [True]:
Connection timeout (seconds) [30]:

Database connection settings saved successfully!
Server: localhost
Driver: {ODBC Driver 18 for SQL Server}
Auth mode: windows
Encrypt: True
Trust Certificate: True
Timeout: 30s

Testing the connection (SELECT 1)...
Connection test succeeded.

Press Enter to exit...

Choosing a mode other than Windows or SQL Server Authentication (options 3-7 above) also prompts to switch the ODBC driver to 18 if needed, since the Microsoft Entra modes require it. Modes that need a username/client id or password/client secret (SQL Server Authentication, Microsoft Entra Password, Microsoft Entra Service Principal) prompt for those as well.

Command-line mode​

Pass the settings as parameters. Speediful prompts for any parameter you leave out. The backtick (`) is PowerShell's line continuation character.

(admin powershell prompt)
PS C:\WINDOWS\system32> cd "C:\Program Files\Speediful\SLAM"
PS C:\Program Files\Speediful\SLAM> .\speediful_slam.exe configure_server `
--server "localhost" `
--driver "ODBC Driver 17 for SQL Server" `
--auth_mode windows `
--encrypt true `
--trust_server_certificate true `
--connection_timeout 30

To use SQL Server Authentication instead of Windows Authentication, pass --auth_mode sql along with --uid and --pwd:

PS C:\Program Files\Speediful\SLAM> .\speediful_slam.exe configure_server `
--server "localhost" `
--auth_mode sql `
--uid "sql_login" `
--pwd "P@ssw0rd"

A SQL login also needs the ADMINISTER BULK OPERATIONS permission. See Grant BULK INSERT Permission.

configure_server Command Line Parameters

NameTypeDefaultDescription
--server / -sSTRINGlocalhostSQL Server hostname or IP address
--driver / -dSTRINGODBC Driver 17 for SQL ServerODBC driver name. In interactive mode this is a menu of installed drivers instead of free text
--auth_modeSTRINGwindowsDatabase authentication mode. One of windows, sql, entra_password, entra_integrated, entra_service_principal, entra_managed_identity, entra_default. All entra_* modes are experimental and require ODBC Driver 18
--uid / -uSTRING(none)Username / client id. Required for sql, entra_password and entra_service_principal; optional user-assigned client id for entra_managed_identity
--pwd / -pSTRING(none)Password / client secret. Required for sql, entra_password and entra_service_principal
--encrypt / -eBOOLEANtrueEncrypt connection (true/false)
--trust_server_certificateBOOLEANtrueTrust server certificate (true/false)
--connection_timeoutINTEGER30Connection timeout in seconds
important

The server you configure here is the endpoint Speediful uses for every operation. When a stored procedure runs, it connects back to SQL Server using this configured server, not the server's internal name. Set it to a value that is directly reachable from the machine where Speediful runs, exactly as you would in a connection string.

This matters for named instances. If the instance is reachable only on a static TCP port and the SQL Server Browser service is not running, configure the server with an explicit host and port (for example myserver.example.com,1433) rather than a host\instance name.