Configuration

Here are the configuration options, set to the default values, for this service. If you are unsure about where this goes or what this means, we highly recommend scanning the services documentation to get a good handle on how the magicks work.

Also note that options, in addition to the build steps and overrides that are available to every service, are shown below:

Be careful when switching database type, version or credentials!

You should be careful switching database type, version or creds.

In the case of type and version, the underlying database files between these things will likely not be compatible. In the case of credentials, these are set when the container is initially created so in order to change them you need to lando destroy && lando start. Note that lando destroy will delete all the data in your database.

Ignoring this warning can prevent your database from starting

services:
  myservice:
    type: mssql
    portforward: false
    creds:
      password: he11oTHERE

Port forwarding

portforward will allow you to access this service externally by assigning a port directly on your host's localhost. Note that portforward can be set to either true or a specific port but we highly recommend you set it to true unless you have pretty good knowledge of how port assignment works or you have a very compelling reason for needing a locked down port.

portforward: true will prevent inevitable port collisions and provide greater reliability and stability across Lando apps. That said, one downside of portforward: true is that Docker will assign a different port every time you restart your application. You can read more about accessing services externally over here.

tl;dr

Recommended

services:
  myservice:
    type: mssql
    portforward: true

Not recommended

services:
  myservice:
    type: mssql
    portforward: 1433

Setting custom credentials

You can also configure the default password for the sa user. However, it is very important to note that these things get set the FIRST TIME YOU START the service and ONLY THE FIRST TIME.

This means that if you change any of the creds, you need to lando destroy and then lando start the service for the changes to take effect. This stands in contrast to the normal lando rebuild method to change config and is a consequence of persisting the database's data directory between rebuilds.

services:
  myservice:
    type: mssql
    creds:
      user: he11oTHERE -> 1337PASSword

lando destroy -y && lando start

WARNING

By default, most Lando recipes set their default database credentials to the name of the recipe (ex: @lando/symfony sets the database password to symfony). Since MSSQL requires an 8+ character password with special characters, if you are overriding the default database service on a recipe you will need to provide a different password:

name: symfony_mssql
recipe: symfony
services:
  database:
    creds:
      password: L4ndoSymfony! #needs to be 8 characters minimum with special characters

Getting information

You can get connection and credential information about your mssql instance by running lando info. It may also be worth checking out our accessing services externally guide.

Adding tooling commands

By default a service will not do any tooling routing for you but you can add helpful lando commands.

tooling:
  dotnet:
    service: myservice

You can then invoke them on the command line.

lando dotnet

Lando tooling is actually pretty powerful so definitely check out the rest of its cool features.

Adding routing

By default a service will not do any proxy routing for you but you can add your own.

proxy:
  myservice:
    - myapp.lndo.site
    - something.else.local

Lando proxying is actually pretty powerful so definitely check out the rest of its cool features.