docs: add documentation for specifying SQL Server instance name (#5586)

Closes: #5585
typeorm · Mar 2, 2020 · adebcb1 · adebcb1
1 parent 7fe8853
commit adebcb1
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/docs/connection-options.md b/docs/connection-options.md
@@ -268,6 +268,8 @@ See [SSL options](https://github.com/mysqljs/mysql#ssl-options).
  will fail with an error. However, if `options.fallbackToDefaultDb` is set to `true`, then the user's default database will
   be used instead (Default: `false`).
 
+* `options.instanceName` - The instance name to connect to. The SQL Server Browser service must be running on the database server, and UDP port 1434 on the database server must be reachable. Mutually exclusive with `port`. (no default).
+
 * `options.enableAnsiNullDefault` - If true, SET ANSI_NULL_DFLT_ON ON will be set in the initial sql. This means new
  columns will be nullable by default. See the [T-SQL documentation](https://msdn.microsoft.com/en-us/library/ms187375.aspx)
  for more details. (Default: `true`).