github.com/scraniel/migrate@v0.0.0-20230320185700-339088f36cee/database/sqlserver/README.md (about)

     1  # Microsoft SQL Server
     2  
     3  `sqlserver://username:password@host/instance?param1=value&param2=value`
     4  `sqlserver://username:password@host:port?param1=value&param2=value`
     5  
     6  | URL Query  | WithInstance Config | Description |
     7  |------------|---------------------|-------------|
     8  | `x-migrations-table` | `MigrationsTable` | Name of the migrations table |
     9  | `username` | |  enter the SQL Server Authentication user id or the Windows Authentication user id in the DOMAIN\User format. On Windows, if user id is empty or missing Single-Sign-On is used. |
    10  | `password` | | The user's password. | 
    11  | `host` | | The host to connect to. |
    12  | `port` | | The port to connect to. |
    13  | `instance` | | SQL Server instance name. |
    14  | `database` | `DatabaseName` | The name of the database to connect to |
    15  | `connection+timeout` | | in seconds (default is 0 for no timeout), set to 0 for no timeout. |
    16  | `dial+timeout` | | in seconds (default is 15), set to 0 for no timeout. |
    17  | `encrypt` | | `disable` - Data send between client and server is not encrypted. `false` - Data sent between client and server is not encrypted beyond the login packet (Default). `true` - Data sent between client and server is encrypted. |
    18  | `app+name` || The application name (default is go-mssqldb). |
    19  | `useMsi` | | `true` - Use Azure MSI Authentication for connecting to Sql Server. Must be running from an Azure VM/an instance with MSI enabled. `false` - Use password authentication (Default). See [here for Azure MSI Auth details](https://docs.microsoft.com/en-us/azure/app-service/app-service-web-tutorial-connect-msi). NOTE: Since this cannot be tested locally, this is not officially supported.
    20  
    21  See https://github.com/microsoft/go-mssqldb for full parameter list.
    22  
    23  ## Driver Support
    24  
    25  ### Which go-mssqldb driver to us?
    26  
    27  Please note that the deprecated `mssql` driver is not supported. Please use the newer `sqlserver` driver.  
    28  See https://github.com/microsoft/go-mssqldb#deprecated for more information.
    29  
    30  ### Official Support by migrate
    31  
    32  Versions of MS SQL Server 2019 newer than CTP3.1 are not officially supported since there are issues testing against the Docker image.
    33  For more info, see: https://github.com/golang-migrate/migrate/issues/160#issuecomment-522433269