Azure SQL Database Scripts

ThingWorx Model Definition in Composer > Data Storage > Persistence Providers > Using Azure SQL Database as the Persistence Provider > Azure SQL Database Scripts

All scripts create a log file when they are executed that capture any errors and other information. The scripts are created in the same path they are executed from.

thingworxAzureSingleInstanceDBSetup

This script creates a single Azure SQL database with the given parameters.

Option	Default	Description
-d \| -D \| --database \| -n \| --name	thingworx	The name of the database to create in Azure.
-g \| --resourceGroup		The name of the resource group in Azure to create the database under.
-h \| -H \| --server		The SQL server resource to store the DB in.
-c \| --capacity		The capacity component of the sku in integer number of DTUs or vcores.
--catalog-collation		Collation of the metadata catalog. Accepted Values: DATABASE_DEFAULT, SQL_Latin1_General_CP1_CI_AS
--collation	Latin1_General_100_CS_AS_SC	The collation to use for the database.
-e \| --edition \| --tier		The edition component of the sku. Accepted Values: Basic, Standard, Premium, GeneralPurpose, BusinessCritical.
--elastic-pool		The name of the elastic pool the database is associated with.
-f \| --family		The compute generation component of the sku -- for vcore skus only. Accepted Values: Gen4, Gen5.
--license-type		The license type to apply for this Azure SQL DB. Accepted Values: BasePrice, LicenseIncluded.
--max-size		The max storage size. If a unit is not specified, defaults to bytes - B.
--no-wait		Do not wait for the long-running operation to finish.
--sample-name		The name of the sample schema to apply when creating this database.
--service-objective		The SLA set on the database. Accepted Values: Basic, S0, P1, GP_Gen4_1, BC_Gen5_2
--tags		The tags on the database used to filter when searching.
--use-device-code	false	Specifies the type of authentication to use. True for device code or false for browser login.
-z \| --zone-redundant		Specifies whether to enable zone redundancy.

thingworxAzureSingleInstanceSchemaSetup

This script sets up ThingWorx schema for a single Azure SQL database. Authentication to access the database is granted with the SQL Server Username and password.


-d \| -D \| --database \| -n \| --name	thingworx	The name of the database to create in Azure.
-h \| -H \| --server		The SQL server resource to store the database in.
-i \| -I		Server instance holding the database.
-s \| -S \| --schema	twschema	Schema to identify all of the SQL objects to be created from this script.
-t \| -T		The password ThingWorx uses to authenticate with the Azure SQL database.
-l \| -L		SQL Server username used to log into the Azure SQL server resource.
-u \| -U	twadmin	Username ThingWorx uses to authenticate with the Azure SQL database.
-o \| -O \| --option	all	Pass in one of the available options to indicate what parts of the schema to install. Available options: all, property, model, data, modelwithproperty, and enablesso

thingworxAzureSingleInstanceCleanup

This script deletes the given single Azure SQL database.

Option	Default	Description
-d \| -D \| --database \| -n \| --name	thingworx	The name of the database to delete in Azure
-h \| -H \| --server		The SQL server resource the DB is stored in
-g \| --resourceGroup		The resource group in Azure the DB resides under
-y \| --yes		Do not prompt for confirmation
--no-wait		Do not wait for the long-running operation to finish
--use-device-code	false	Specify what kind of authentication to use. True for device code or false for browser login

thingworxAzureManagedInstanceDBSetup

This script creates database and schema in the Azure SQL managed instance.

Option	Default	Description
-d \| -D	thingworx	The name of the database in managed instance to clean
-h \| -H		The Managed instance name
-i \| -I		Server instance holding the DB.
-a \| -A		Managed instance admin login
-s \| -S	twschema	Schema to identify all of the SQL objects to be created from this script
-l \| -L	twadmin	SQL Server Username used to log into the Azure SQL server resource
-u \| -U		Username ThingWorx uses to authenticate with the Azure SQL DB

thingworxAzureManagedInstanceSchemaSetup

This script setups the ThingWorx schema in Azure SQL Managed instance database.

Option	Default	Description
-d \| -D	thingworx	The name of the database in the managed instance to clean.
-h \| -H		The Managed instance name.
-i \| -I		Server instance holding the database.
-l \| -L	twadmin	SQL Server Username used to log into the Azure SQL server resource.
-o \| -O	all	Pass in one of the available options to indicate what parts of the schema to install Valid values: all, enablesso, model, property, data, modelwithproperty

thingworxAzureManagedInstanceDBCleanup

This script cleans up the ThingWorx schema in Azure SQL managed instance.

Option	Default	Description
-d \| -D	thingworx	The name of the database in managed instance to clean.
-h \| -H		The managed instance name.
-i \| -I		Server instance holding the database.
-a \| -A		Managed instance admin login

thingworxAzureElasticpoolSetup

This script creates an elastic pool for the given login and subscription.

Option	Default	Description
-n \| --name		The name of the elastic pool to create in Azure.
-g \| --resourceGroup		The resource group in Azure to create the database under. Configure a default with: az configure --defaults group=<name>
-h \| -H \| --server		The SQL server resource to store the database in. Configure a default with: az configure --defaults sql-server=<name>
-c \| --capacity \| --dtu		The capacity component of the sku in integer number of DTUs or vcores.
--db-dtu-max \| --db-max-capacity \| --db-max-dtu		The maximum capacity, in DTUs or vcores, any one database can consume.
--db-dtu-min \| --db-min-capacity \| --db-min-dtu		The minimum capacity, in DTUs or vcores, each database is guaranteed.
-e \| --edition \| --tier		The edition component of the sku. Allowed values include: Basic, Standard, Premium, GeneralPurpose, BusinessCritical.
-f \| --family		The compute generation component of the sku, for vcore skus only. Allowed values include: Gen4, Gen5.
--license-type		The license type to apply for this elastic pool. Allowed values include: BasePrice, LicenseIncluded.
--max-size		The max storage size. If a unit is not specified, defaults to bytes - B.
--no-wait		Do not wait for the long-running operation to finish.
--tags		The tags on the database used to filter when searching.
-z \| --zone-redundant		Specifies whether to enable zone redundancy.

thingworxAzureElasticpoolCleanup

This script deletes the Azure Elastic Pool for given login and subscription.

Option	Default	Description
-n \| --name		The name of the elastic pool to delete in Azure
-h \| -H \| --server		The SQL server resource the elastic pool is stored in.
-g \| --resourceGroup		The resource group in Azure the elastic pool resides under.
-y \| --yes		Do not prompt for confirmation.
--no-wait		Do not wait for the long-running operation to finish.
--use-device-code		Specify what kind of authentication to use. True for device code or false for browser login.

Was this helpful?