Command Line Overview

• Getting started
• Build execution actions to update or query databases
• Utility Actions
• Batch sub-commands
• Kubernetes sub-commands
• Azure Container Instance sub-commands
• Logging

---

Getting started

The sbm executable uses a command pattern for execution sbm [command]

For detailed information on the available and required options for each command, leverage the self-generated documentation via sbm [command] --help

Build execution actions to update or query databases

• build - Performs a standard, local SBM execution via command line (docs)
• threaded - For updating multiple databases simultaneously from the current machine (docs)
• batch - Commands for setting and executing a batch run using Azure Batch (docs)
• k8s - Commands for setting and executing a distributed run using Kubernetes (docs)
• containerapp - Commands for setting and executing a distributed run using Azure Container Apps (docs)
• aci - Commands for setting and executing a distributed run using Azure Container Instances (docs)

Utility actions

• create - Creates an SBM package or SBX project file from a list of supplied script files
  • fromscripts - Creates an SBM package or SBX project file from a list of scripts (type is determined by file extension: .sbm or .sbx)
  • fromdiff - Creates an SBM package from a calculated diff between two databases
  • fromdacpacs - Creates an SBM package from differences between two DACPAC files
  • fromdacpacdiff- Extract a SBM package from a source --platinumdacpac and a target database connection
• add - Adds scripts to an existing SBM package or SBX project file
• package - Creates an SBM package from an SBX configuration file and scripts
• list - Output scripts information on SBM packages (run order, script name, date added/modified, user info, script ids, script hashes)
• dacpac - Create a DACPAC file from the source --database and --server
• policycheck - Performs a script policy check on the specified SBM package
• gethash - Calculates the SHA-1 hash fingerprint value for the SBM package(scripts + run order)
• createbackout - Generates a back out package (reversing stored procedure and scripted object changes)
• getdifference - Determines the difference between SQL Build run histories for two databases. Calculate and list out packages that need to be run between --database and --golddatabase. Only supports Windows Auth
• synchronize - Performs a database synchronization between between --database and --golddatabase. Can only be used for Windows Auth database targets
• scriptextract - Extract a SBM package from a source --platinumdacpac (this command is being deprecated in favor of sbm create fromdacpacdiff and will be removed in a future release)

Batch sub-commands

sbm batch [command]

• savesettings - Save a settings json file for Batch arguments (see Batch documentation)
• prestage - Pre-stage the Azure Batch VM nodes
• enqueue - Sends database override targets to Service Bus Topic
• run - For updating multiple databases simultaneously using Azure batch services
• query - Run a SELECT query across multiple databases using Azure Batch
• cleanup - Azure Batch Clean Up - remove VM nodes
• dequeue - Careful! Removes the Service Bus Topic subscription and deletes the messages and deadletters without processing them (see queue docs)

For details information on running batch builds, see the Batch documentation

• sbm batch savesettings
• sbm batch enqueue
• sbm batch run
• sbm batch prestage
• sbm batch cleanup

Kubernetes sub-commands

sbm k8s [command]

For examples of each, see the Kubernetes documentation

• savesettings - Saves settings file for Kubernetes deployments
• run - Run a build in Kubernetes (Orchestrates the prep, enqueue and monitor commands as well as kubectl). [NOTE: ‘kubectl’ must be installed and in your path]
• prep - Creates a storage container and uploads the SBM and/or DACPAC files that will be used for the build. If the –runtimefile option is provided, it will also update that file with the updated values
• enqueue - Sends database override targets to Service Bus Topic
• monitor - Poll the Service Bus Topic to see how many messages are left to be processed and watch the Event Hub for build outcomes (commits & errors)
• dequeue - Careful! Removes the Service Bus Topic subscription and deletes the messages and deadletters without processing them
• createyaml - Helper command to create yaml files from a settings json file and runtime parameters
• worker - [Used by Kubernetes] Starts the pod as a worker - polling and retrieving items from target service bus queue topic

ACI sub-commands

sbm aci [command]

For examples of each, see the Azure Container Instance (ACI) documentation

• savesettings - Saves settings file for Azure Container Instances container deployments. This option always leverages Azure Key Vault to manage secrets
• prep - Creates ACI arm template, a storage container, and uploads the SBM and/or DACPAC files that will be used for the build.
• enqueue - Sends database override targets to Service Bus Topic
• deploy - Deploy the ACI instance using the template file created from ‘sbm prep’ and start containers
• monitor - Poll the Service Bus Topic to see how many messages are left to be processed and watch the Event Hub for build outcomes (commits & errors)
• dequeue - Careful! Removes the Service Bus Topic subscription and deletes the messages and deadletters without processing them
• worker - [Used by ACI] Starts the container(s) as a worker - polling and retrieving items from target service bus queue topic

ContainerApp sub-commands

sbm containerapp [command]

• savesettings - Saves settings file for Azure Container App deployments
• run - Runs a build on Container Apps (orchestrates the prep, enqueue, deploy and montitor commands)
• prep - Creates an Azure storage container and uploads the SBM and/or DACPAC files that will be used for the build.
• enqueue - Sends database override targets to Service Bus Topic
• deploy - Deploy the Container App instance using the template file created from ‘sbm containerapp prep’ and start containers
• monitor - Poll the Service Bus Topic to see how many messages are left to be processed and watch the Event Hub for build outcomes (commits & errors)
• dequeue - Careful! Removes the Service Bus Topic subscription and deletes the messages and deadletters without processing them
• worker - [Used by Container Apps] Starts the pod as a worker - polling and retrieving items from target service bus queue topic

---

Logging

For general logging, the SqlBuildManager.Console.exe has its own local messages. This log file is named SqlBuildManager.Console{date stamp}.log and can be found in the same folder as the executable. This file will be the first place to check for general execution errors or problems.

To accommodate the logging of a threaded or batch build, all of the output is saved to files and folders under the path specified in the --rootloggingpath flag. For a simple threaded execution, this is a single root folder. For a remote server execution, this folder is created for each execution server.

For for details and script run troubleshooting suggestions, see Log Files Details for Threaded, Batch, Kubernetes and ACI execution