Implement :serverlist command

README.md

@@ -154,6 +154,41 @@ switches are most important to you to have implemented next in the new sqlcmd.
 - `:Connect` now has an optional `-G` parameter to select one of the authentication methods for Azure SQL Database  - `SqlAuthentication`, `ActiveDirectoryDefault`, `ActiveDirectoryIntegrated`, `ActiveDirectoryServicePrincipal`, `ActiveDirectoryManagedIdentity`, `ActiveDirectoryPassword`. If `-G` is not provided, either Integrated security or SQL Authentication will be used, dependent on the presence of a `-U` username parameter.
 - The new `--driver-logging-level` command line parameter allows you to see traces from the `go-mssqldb` client driver. Use `64` to see all traces.
 - Sqlcmd can now print results using a vertical format. Use the new `--vertical` command line option to set it. It's also controlled by the `SQLCMDFORMAT` scripting variable.
+- `:help` displays a list of available sqlcmd commands.
+- `:serverlist` lists local SQL Server instances discovered via the SQL Server Browser service (UDP port 1434). The command queries the SQL Browser service and displays the server name and instance name for each discovered instance. If no instances are found or the Browser service is not running, no output is produced. Non-timeout errors are printed to stderr.
+
+```
+1> :serverlist
+MYSERVER\SQL2019
+MYSERVER\SQL2022
+```
+
+#### Using :serverlist in batch scripts
+
+When automating server discovery, you can capture the output and check for errors:
+
+```batch
+@echo off
+REM Discover local SQL Server instances and connect to the first one
+sqlcmd -Q ":serverlist" 2>nul > servers.txt
+if %errorlevel% neq 0 (
+    echo Error discovering servers
+    exit /b 1
+)
+for /f "tokens=1" %%s in (servers.txt) do (
+    echo Connecting to %%s...
+    sqlcmd -S %%s -Q "SELECT @@SERVERNAME"
+    goto :done
+)
+echo No SQL Server instances found
+:done
+```
+
+To capture stderr separately (for error logging):
+```batch
+sqlcmd -Q ":serverlist" 2>errors.log > servers.txt
+if exist errors.log if not "%%~z errors.log"=="0" type errors.log
+```
 
 ```
 1> select session_id, client_interface_name, program_name from sys.dm_exec_sessions where session_id=@@spid

cmd/sqlcmd/sqlcmd.go

@@ -5,20 +5,16 @@
 package sqlcmd
 
 import (
-	"context"
 	"errors"
 	"fmt"
-	"net"
 	"os"
 	"regexp"
 	"runtime/trace"
 	"strconv"
 	"strings"
-	"time"
 
 	mssql "github.com/microsoft/go-mssqldb"
 	"github.com/microsoft/go-mssqldb/azuread"
-	"github.com/microsoft/go-mssqldb/msdsn"
 	"github.com/microsoft/go-sqlcmd/internal/localizer"
 	"github.com/microsoft/go-sqlcmd/pkg/console"
 	"github.com/microsoft/go-sqlcmd/pkg/sqlcmd"
@@ -236,7 +232,7 @@ func Execute(version string) {
 					fmt.Println()
 					fmt.Println(localizer.Sprintf("Servers:"))
 				}
-				listLocalServers()
+				sqlcmd.ListLocalServers(os.Stdout)
 				os.Exit(0)
 			}
 			if len(argss) > 0 {
@@ -911,76 +907,3 @@ func run(vars *sqlcmd.Variables, args *SQLCmdArguments) (int, error) {
 	s.SetError(nil)
 	return s.Exitcode, err
 }
-
-func listLocalServers() {
-	bmsg := []byte{byte(msdsn.BrowserAllInstances)}
-	resp := make([]byte, 16*1024-1)
-	dialer := &net.Dialer{}
-	ctx, cancel := context.WithTimeout(context.Background(), time.Second*30)
-	defer cancel()
-	conn, err := dialer.DialContext(ctx, "udp", ":1434")
-	// silently ignore failures to connect, same as ODBC
-	if err != nil {
-		return
-	}
-	defer conn.Close()
-	dl, _ := ctx.Deadline()
-	_ = conn.SetDeadline(dl)
-	_, err = conn.Write(bmsg)
-	if err != nil {
-		if !errors.Is(err, os.ErrDeadlineExceeded) {
-			fmt.Println(err)
-		}
-		return
-	}
-	read, err := conn.Read(resp)
-	if err != nil {
-		if !errors.Is(err, os.ErrDeadlineExceeded) {
-			fmt.Println(err)
-		}
-		return
-	}
-
-	data := parseInstances(resp[:read])
-	instances := make([]string, 0, len(data))
-	for s := range data {
-		if s == "MSSQLSERVER" {
-
-			instances = append(instances, "(local)", data[s]["ServerName"])
-		} else {
-			instances = append(instances, fmt.Sprintf(`%s\%s`, data[s]["ServerName"], s))
-		}
-	}
-	for _, s := range instances {
-		fmt.Println("  ", s)
-	}
-}
-
-func parseInstances(msg []byte) msdsn.BrowserData {
-	results := msdsn.BrowserData{}
-	if len(msg) > 3 && msg[0] == 5 {
-		out_s := string(msg[3:])
-		tokens := strings.Split(out_s, ";")
-		instdict := map[string]string{}
-		got_name := false
-		var name string
-		for _, token := range tokens {
-			if got_name {
-				instdict[name] = token
-				got_name = false
-			} else {
-				name = token
-				if len(name) == 0 {
-					if len(instdict) == 0 {
-						break
-					}
-					results[strings.ToUpper(instdict["InstanceName"])] = instdict
-					instdict = map[string]string{}
-					continue
-				}
-				got_name = true
-			}
-		}
-	}
-	return results
-}