Saving changes

Author: stuartpa

README.md

@@ -49,7 +49,7 @@ Use `sqlcmd` to create SQL Server and Azure SQL Edge instances using a local con
 To create a local SQL Server instance with the AdventureWorksLT database restored, query it, and connect to it using Azure Data Studio, run:
 
 ```
-sqlcmd create mssql --accept-eula --using https://aka.ms/AdventureWorksLT.bak
+sqlcmd create mssql --accept-eula --use https://aka.ms/AdventureWorksLT.bak
 sqlcmd query "SELECT DB_NAME()"
 sqlcmd open ads
 ```

cmd/modern/main.go

@@ -20,6 +20,7 @@ import (
 	"github.com/microsoft/go-sqlcmd/internal/output"
 	"github.com/microsoft/go-sqlcmd/internal/output/verbosity"
 	"github.com/microsoft/go-sqlcmd/internal/pal"
+	"github.com/microsoft/go-sqlcmd/pkg/mssqlcontainer"
 	"github.com/microsoft/go-sqlcmd/pkg/sqlcmd"
 	"github.com/spf13/cobra"
 	"path"
@@ -130,6 +131,10 @@ func initializeCallback() {
 			HintHandler:  displayHints,
 			LineBreak:    sqlcmd.SqlcmdEol,
 		})
+	mssqlcontainer.Initialize(mssqlcontainer.InitializeOptions{
+		ErrorHandler: checkErr,
+		TraceHandler: outputter.Tracef,
+	})
 	config.SetFileName(rootCmd.configFilename)
 	config.Load()
 }

cmd/modern/root.go

@@ -26,7 +26,7 @@ type Root struct {
 // It also provides usage examples for sqlcmd.
 func (c *Root) DefineCommand(...cmdparser.CommandOptions) {
 	// Example usage steps
-	steps := []string{"sqlcmd create mssql --accept-eula --using https://aka.ms/AdventureWorksLT.bak"}
+	steps := []string{"sqlcmd create mssql --accept-eula --use https://aka.ms/AdventureWorksLT.bak"}
 
 	if runtime.GOOS == "windows" || runtime.GOOS == "darwin" {
 		steps = append(steps, "sqlcmd open ads")

cmd/modern/root/config/connection-strings.go

@@ -69,7 +69,7 @@ func (c *ConnectionStrings) run() {
 		if endpoint.AssetDetails != nil && endpoint.AssetDetails.ContainerDetails != nil {
 			controller := container.NewController()
 			if controller.ContainerRunning(endpoint.AssetDetails.ContainerDetails.Id) {
-				s := sql.New(sql.SqlOptions{})
+				s := sql.NewSql(sql.SqlOptions{})
 				s.Connect(endpoint, user, sql.ConnectOptions{Interactive: false})
 				c.database = s.ScalarString("PRINT DB_NAME()")
 			} else {

cmd/modern/root/install/edge_test.go

@@ -25,7 +25,7 @@ func TestInstallEdge(t *testing.T) {
 	cmdparser.TestCmd[*edge.GetTags]()
 	cmdparser.TestCmd[*Edge](
 		fmt.Sprintf(
-			`--accept-eula --user-database foo --errorlog-wait-line "Hello from Docker!" --registry %v --repo %v`,
+			`--accept-eula --database foo --errorlog-wait-line "Hello from Docker!" --registry %v --repo %v`,
 			registry,
 			repo))
 

cmd/modern/root/install/mssql-base.go

@@ -270,31 +270,30 @@ func (c *MssqlBase) AddFlags(
 // If the EULA has not been accepted, it prints an error message with suggestions for how to proceed,
 // and exits the program.
 func (c *MssqlBase) Run() {
-	output := c.Cmd.Output()
-
 	var imageName string
 
+	output := c.Cmd.Output()
+
 	if !c.acceptEula && viper.GetString("ACCEPT_EULA") == "" {
 		output.FatalWithHints(
 			[]string{"Either, add the --accept-eula flag to the command-line",
-				fmt.Sprintf("Or, set the environment variable i.e. %s SQLCMD_ACCEPT_EULA=YES ", pal.CreateEnvVarKeyword())},
+				fmt.Sprintf(
+					"Or, set the environment variable i.e. %s SQLCMD_ACCEPT_EULA=YES ",
+					pal.CreateEnvVarKeyword())},
 			"EULA not accepted")
 	}
 
-	imageName = fmt.Sprintf(
-		"%s/%s:%s",
-		c.registry,
-		c.repo,
-		c.tag)
+	imageName = fmt.Sprintf("%s/%s:%s", c.registry, c.repo, c.tag)
 
+	// If no context name provided, set it to the default (e.g. mssql or edge)
 	if c.contextName == "" {
 		c.contextName = c.defaultContextName
 	}
 
 	c.createContainer(imageName, c.contextName)
 }
 
-// createContainer installs an image for a SQL Server container. The image
+// createContainer creates a SQL Server container for an image. The image
 // is specified by imageName, and the container will be given the name contextName.
 // If the useCached flag is set, the function will skip downloading the image
 // from the internet. The function outputs progress messages to the command-line
@@ -305,25 +304,19 @@ func (c *MssqlBase) createContainer(imageName string, contextName string) {
 	controller := container.NewController()
 	saPassword := c.generatePassword()
 
-	env := []string{
-		"ACCEPT_EULA=Y",
-		fmt.Sprintf("MSSQL_SA_PASSWORD=%s", saPassword),
-		fmt.Sprintf("MSSQL_COLLATION=%s", c.collation),
-	}
-
 	if c.port == 0 {
 		c.port = config.FindFreePortForTds()
 	}
 
 	// Do an early exit if url doesn't exist
 	var useDatabase ingest.Ingest
 	if c.useDatabaseUrl != "" {
-		useDatabase = c.verifyUseSourceFileExists(useDatabase, controller, output)
+		useDatabase = c.verifyUseSourceFileExists(controller, output)
 	}
 
 	if c.defaultDatabase != "" {
 		if !c.validateDbName(c.defaultDatabase) {
-			output.Fatalf("--user-database %q contains non-ASCII chars and/or quotes", c.defaultDatabase)
+			output.Fatalf("--database %q contains non-ASCII chars and/or quotes", c.defaultDatabase)
 		}
 	}
 
@@ -332,38 +325,34 @@ func (c *MssqlBase) createContainer(imageName string, contextName string) {
 	}
 
 	runOptions := container.RunOptions{
-		Env:          env,
 		Port:         c.port,
 		Name:         c.name,
 		Hostname:     c.hostname,
 		Architecture: c.architecture,
-		Os:           c.os,
-		Command:      []string{},
-	}
+		Os:           c.os}
+
+	runOptions.Env = []string{
+		"ACCEPT_EULA=Y",
+		fmt.Sprintf("MSSQL_SA_PASSWORD=%s", saPassword),
+		fmt.Sprintf("MSSQL_COLLATION=%s", c.collation)}
 
 	output.Infof("Starting %v", imageName)
 	containerId := controller.ContainerRun(imageName, runOptions)
 	previousContextName := config.CurrentContextName()
 
-	userName := pal.UserName()
-	password := c.generatePassword()
-
 	// Save the config now, so user can uninstall/delete, even if mssql in the container
 	// fails to start
-
 	contextOptions := config.ContextOptions{
 		ImageName:          imageName,
 		PortNumber:         c.port,
 		ContainerId:        containerId,
-		Username:           userName,
-		Password:           password,
-		PasswordEncryption: c.passwordEncryption,
-	}
-
+		Username:           pal.UserName(),
+		Password:           c.generatePassword(),
+		PasswordEncryption: c.passwordEncryption}
 	config.AddContextWithContainer(contextName, contextOptions)
 
 	output.Infof(
-		"Created context %q in \"%s\", configuring user account...",
+		"Created context %q in \"%s\", configuring user account",
 		config.CurrentContextName(),
 		config.GetConfigFileUsed())
 
@@ -372,7 +361,7 @@ func (c *MssqlBase) createContainer(imageName string, contextName string) {
 	output.Infof("Disabled %q account (and rotated %q password). Creating user %q",
 		"sa",
 		"sa",
-		userName)
+		contextOptions.Username)
 
 	endpoint, _ := config.CurrentContext()
 
@@ -384,7 +373,7 @@ func (c *MssqlBase) createContainer(imageName string, contextName string) {
 	if c.errorLogEntryToWaitFor == "Hello from Docker!" {
 		sqlOptions.UnitTesting = true
 	}
-	c.sql = sql.New(sqlOptions)
+	c.sql = sql.NewSql(sqlOptions)
 
 	saUser := &sqlconfig.User{
 		AuthenticationType: "basic",
@@ -394,27 +383,34 @@ func (c *MssqlBase) createContainer(imageName string, contextName string) {
 			Password:           secret.Encode(saPassword, c.passwordEncryption)},
 		Name: "sa"}
 
-	c.sql.Connect(endpoint, saUser, sql.ConnectOptions{Database: "master", Interactive: false})
-	c.createNonSaUser(userName, password)
+	// Connect to master database on SQL Server in the container as `sa`
+	c.sql.Connect(endpoint, saUser, sql.ConnectOptions{Database: "master"})
+
+	// Create a new (non-sa) SQL Server user
+	c.createUser(contextOptions.Username, contextOptions.Password)
 
-	// Download and restore DB if asked
+	// Download and restore/attach etc. DB if asked
 	if useDatabase != nil {
-		output.Infof("Copying to container")
+		if useDatabase.IsRemoteUrl() {
+			output.Infof("Downloading %q to container", useDatabase.UrlFilename())
+		} else {
+			output.Infof("Copying %q to container", useDatabase.UrlFilename())
+		}
 		useDatabase.CopyToContainer(containerId)
 
 		if useDatabase.IsExtractionNeeded() {
-			output.Infof("Extracting files from archive")
+			output.Infof("Extracting files from %q archive", useDatabase.UrlFilename())
 			useDatabase.Extract()
 		}
 
-		output.Infof("Bringing database online")
-		useDatabase.BringOnline(c.sql.Query, userName, password)
+		output.Infof("Bringing database %q online", useDatabase.DatabaseName())
+		useDatabase.BringOnline(c.sql.Query, contextOptions.Username, contextOptions.Password)
 	}
 
 	if c.openTool == "" {
 		hints := [][]string{}
 
-		// TODO: sqlcmd open ads only support on Windows right now, add Mac support
+		// TODO: sqlcmd open ads only support on Windows/Mac right now, add Linux support
 		if runtime.GOOS == "windows" || runtime.GOOS == "darwin" {
 			hints = append(hints, []string{"Open in Azure Data Studio", "sqlcmd open ads"})
 		}
@@ -452,10 +448,10 @@ func (c *MssqlBase) createContainer(imageName string, contextName string) {
 		user := &sqlconfig.User{
 			AuthenticationType: "basic",
 			BasicAuth: &sqlconfig.BasicAuthDetails{
-				Username:           userName,
+				Username:           contextOptions.Username,
 				PasswordEncryption: c.passwordEncryption,
-				Password:           secret.Encode(password, c.passwordEncryption)},
-			Name: userName}
+				Password:           secret.Encode(contextOptions.Password, c.passwordEncryption)},
+			Name: contextOptions.Username}
 
 		ads.PersistCredentialForAds(endpoint.EndpointDetails.Address, endpoint, user)
 
@@ -466,7 +462,7 @@ func (c *MssqlBase) createContainer(imageName string, contextName string) {
 			c.port))}
 
 		args = append(args, fmt.Sprintf("--user=%s",
-			strings.Replace(userName, `"`, `\"`, -1)))
+			strings.Replace(contextOptions.Username, `"`, `\"`, -1)))
 
 		tool := tools.NewTool("ads")
 		if !tool.IsInstalled() {
@@ -478,7 +474,10 @@ func (c *MssqlBase) createContainer(imageName string, contextName string) {
 	}
 }
 
-func (c *MssqlBase) verifyUseSourceFileExists(useDatabase ingest.Ingest, controller *container.Controller, output *output.Output) ingest.Ingest {
+func (c *MssqlBase) verifyUseSourceFileExists(
+	controller *container.Controller,
+	output *output.Output,
+) (useDatabase ingest.Ingest) {
 	useDatabase = ingest.NewIngest(c.useDatabaseUrl, controller, ingest.IngestOptions{
 		Mechanism: c.useMechanism,
 	})
@@ -487,44 +486,52 @@ func (c *MssqlBase) verifyUseSourceFileExists(useDatabase ingest.Ingest, control
 		output.FatalfWithHints(
 			[]string{
 				fmt.Sprintf(
-					"--using must be a path to a file with a %q extension",
+					"--use must be a path to a file with a %q extension",
 					ingest.ValidFileExtensions(),
 				),
 			},
-			"%q is not a valid file extension for --using flag", useDatabase.UserProvidedFileExt())
+			"%q is not a valid file extension for --use flag", useDatabase.UserProvidedFileExt())
 	}
 
 	if useDatabase.IsRemoteUrl() && !useDatabase.IsValidScheme() {
 		output.FatalfWithHints(
 			[]string{
 				fmt.Sprintf(
-					"--using URL must one of %q",
+					"--use URL must one of %q",
 					strings.Join(useDatabase.ValidSchemes(), ", "),
 				),
 			},
-			"%q is not a valid URL for --using flag", c.useDatabaseUrl)
+			"%q is not a valid URL for --use flag", c.useDatabaseUrl)
 	}
 
 	if !useDatabase.SourceFileExists() {
 		output.FatalfWithHints(
 			[]string{fmt.Sprintf("File does not exist at URL %q", c.useDatabaseUrl)},
 			"Unable to download file")
 	}
-	return useDatabase
+	return
 }
 
-// createNonSaUser creates a user (non-sa) and assigns the sysadmin role
+// createUser creates a user (non-sa) and assigns the sysadmin role
 // to the user. It also creates a default database with the provided name
 // and assigns the default database to the user. Finally, it disables
 // the sa account and rotates the sa password for security reasons.
-func (c *MssqlBase) createNonSaUser(
+func (c *MssqlBase) createUser(
 	userName string,
 	password string,
 ) {
+	const createLogin = `CREATE LOGIN [%s]
+WITH PASSWORD=N'%s',
+DEFAULT_DATABASE=[%s],
+CHECK_EXPIRATION=OFF,
+CHECK_POLICY=OFF`
+	const addSrvRoleMember = `EXEC master..sp_addsrvrolemember
+@loginame = N'%s',
+@rolename = N'sysadmin'`
+
 	output := c.Cmd.Output()
 
 	defaultDatabase := "master"
-
 	if c.defaultDatabase != "" {
 		defaultDatabase = c.defaultDatabase
 
@@ -533,15 +540,6 @@ func (c *MssqlBase) createNonSaUser(
 		c.sql.Query(fmt.Sprintf("CREATE DATABASE [%s]", defaultDatabase))
 	}
 
-	const createLogin = `CREATE LOGIN [%s]
-WITH PASSWORD=N'%s',
-DEFAULT_DATABASE=[%s],
-CHECK_EXPIRATION=OFF,
-CHECK_POLICY=OFF`
-	const addSrvRoleMember = `EXEC master..sp_addsrvrolemember
-@loginame = N'%s',
-@rolename = N'sysadmin'`
-
 	c.sql.Query(fmt.Sprintf(createLogin, userName, password, defaultDatabase))
 	c.sql.Query(fmt.Sprintf(addSrvRoleMember, userName))
 

cmd/modern/root/install/mssql.go

@@ -35,13 +35,13 @@ func (c *Mssql) DefineCommand(...cmdparser.CommandOptions) {
 			},
 			{
 				Description: "Create SQL Server, download and attach AdventureWorks sample database",
-				Steps:       []string{"sqlcmd create mssql --using https://aka.ms/AdventureWorksLT.bak"}},
+				Steps:       []string{"sqlcmd create mssql --use https://aka.ms/AdventureWorksLT.bak"}},
 			{
 				Description: "Create SQL Server, download and attach AdventureWorks sample database with different database name",
-				Steps:       []string{"sqlcmd create mssql --using https://aka.ms/AdventureWorksLT.bak,adventureworks"}},
+				Steps:       []string{"sqlcmd create mssql --use https://aka.ms/AdventureWorksLT.bak,adventureworks"}},
 			{
 				Description: "Create SQL Server with an empty user database",
-				Steps:       []string{"sqlcmd create mssql --user-database db1"}},
+				Steps:       []string{"sqlcmd create mssql --database db1"}},
 			{
 				Description: "Install/Create SQL Server with full logging",
 				Steps:       []string{"sqlcmd create mssql --verbosity 4"}},