Skip to content

Document that --sqlconfig flag only supports YAML format #684

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Copilot wants to merge 9 commits into
base: main
Choose a base branch
from
Open

Document that --sqlconfig flag only supports YAML format #684

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
3f0900a
Initial plan
Copilot Jan 31, 2026
e3d9c23
Add documentation for supported config file extensions
Copilot Jan 31, 2026
c1203ce
Clarify read vs write behavior and add all supported extensions
Copilot Jan 31, 2026
d8f5851
Update internal/translations/locales/de-DE/out.gotext.json
dlevy-msft-sql Feb 1, 2026
8fd45bc
Address review comments: Remove .hcl/.tfvars, restore missing transla…
Copilot Feb 1, 2026
ff25b13
Fix German translation for configuration file string
Copilot Feb 1, 2026
920bae4
Correct documentation: only YAML format is actually supported
Copilot Feb 1, 2026
1440de1
Address review feedback: clarify README and fix unrelated translation…
Copilot Feb 1, 2026
694dbdb
Merge branch 'main' into copilot/add-documentation-for-config-types
dlevy-msft-sql Feb 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,18 @@ sqlcmd config connection-strings
sqlcmd config view
```

#### Custom Configuration Files

You can specify a custom configuration file using the `--sqlconfig` flag. Configuration files must be in **YAML format** and use the `.yaml` or `.yml` file extension.

Example:
```
sqlcmd config --sqlconfig ./myproject.yaml add-endpoint --name ep1434 --address localhost --port 1434
sqlcmd config --sqlconfig ./myproject.yaml view
```

**Note:** The default configuration file at `~/.sqlcmd/sqlconfig` is an exception and uses YAML format without an extension. When specifying a custom configuration file, always use the `.yaml` or `.yml` extension to avoid errors.

### Versions

To see all version tags to choose from (2017, 2019, 2022 etc.), and install a specific version, run:
Expand Down
2 changes: 1 addition & 1 deletion cmd/modern/root.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ func (c *Root) addGlobalFlags() {
String: &c.configFilename,
DefaultString: config.DefaultFileName(),
Name: "sqlconfig",
Usage: localizer.Sprintf("configuration file"),
Usage: localizer.Sprintf("configuration file (YAML format, use .yaml or .yml extension)"),
})

/* BUG(stuartpa): - At the moment this is a top level flag, but it doesn't
Expand Down
9 changes: 8 additions & 1 deletion internal/translations/locales/de-DE/out.gotext.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,13 @@
"translatorComment": "Copied from source.",
"fuzzy": true
},
{
"id": "configuration file (YAML format, use .yaml or .yml extension)",
"message": "configuration file (YAML format, use .yaml or .yml extension)",
"translation": "configuration file (YAML format, use .yaml or .yml extension)",
"translatorComment": "Copied from source.",
"fuzzy": true
},
{
"id": "log level, error=0, warn=1, info=2, debug=3, trace=4",
"message": "log level, error=0, warn=1, info=2, debug=3, trace=4",
Expand Down Expand Up @@ -3737,4 +3744,4 @@
"fuzzy": true
}
]
}
}
9 changes: 8 additions & 1 deletion internal/translations/locales/en-US/out.gotext.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,13 @@
"translatorComment": "Copied from source.",
"fuzzy": true
},
{
"id": "configuration file (YAML format, use .yaml or .yml extension)",
"message": "configuration file (YAML format, use .yaml or .yml extension)",
"translation": "configuration file (YAML format, use .yaml or .yml extension)",
"translatorComment": "Copied from source.",
"fuzzy": true
},
{
"id": "log level, error=0, warn=1, info=2, debug=3, trace=4",
"message": "log level, error=0, warn=1, info=2, debug=3, trace=4",
Expand Down Expand Up @@ -3741,4 +3748,4 @@
"fuzzy": true
}
]
}
}
9 changes: 8 additions & 1 deletion internal/translations/locales/es-ES/out.gotext.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,13 @@
"translatorComment": "Copied from source.",
"fuzzy": true
},
{
"id": "configuration file (YAML format, use .yaml or .yml extension)",
"message": "configuration file (YAML format, use .yaml or .yml extension)",
"translation": "configuration file (YAML format, use .yaml or .yml extension)",
"translatorComment": "Copied from source.",
"fuzzy": true
},
{
"id": "log level, error=0, warn=1, info=2, debug=3, trace=4",
"message": "log level, error=0, warn=1, info=2, debug=3, trace=4",
Expand Down Expand Up @@ -3737,4 +3744,4 @@
"fuzzy": true
}
]
}
}
9 changes: 8 additions & 1 deletion internal/translations/locales/fr-FR/out.gotext.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,13 @@
"translatorComment": "Copied from source.",
"fuzzy": true
},
{
"id": "configuration file (YAML format, use .yaml or .yml extension)",
"message": "configuration file (YAML format, use .yaml or .yml extension)",
"translation": "configuration file (YAML format, use .yaml or .yml extension)",
"translatorComment": "Copied from source.",
"fuzzy": true
},
{
"id": "log level, error=0, warn=1, info=2, debug=3, trace=4",
"message": "log level, error=0, warn=1, info=2, debug=3, trace=4",
Expand Down Expand Up @@ -3737,4 +3744,4 @@
"fuzzy": true
}
]
}
}
9 changes: 8 additions & 1 deletion internal/translations/locales/it-IT/out.gotext.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,13 @@
"translatorComment": "Copied from source.",
"fuzzy": true
},
{
"id": "configuration file (YAML format, use .yaml or .yml extension)",
"message": "configuration file (YAML format, use .yaml or .yml extension)",
"translation": "configuration file (YAML format, use .yaml or .yml extension)",
"translatorComment": "Copied from source.",
"fuzzy": true
},
{
"id": "log level, error=0, warn=1, info=2, debug=3, trace=4",
"message": "log level, error=0, warn=1, info=2, debug=3, trace=4",
Expand Down Expand Up @@ -3737,4 +3744,4 @@
"fuzzy": true
}
]
}
}
9 changes: 8 additions & 1 deletion internal/translations/locales/ja-JP/out.gotext.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,13 @@
"translatorComment": "Copied from source.",
"fuzzy": true
},
{
"id": "configuration file (YAML format, use .yaml or .yml extension)",
"message": "configuration file (YAML format, use .yaml or .yml extension)",
"translation": "configuration file (YAML format, use .yaml or .yml extension)",
"translatorComment": "Copied from source.",
"fuzzy": true
},
{
"id": "log level, error=0, warn=1, info=2, debug=3, trace=4",
"message": "log level, error=0, warn=1, info=2, debug=3, trace=4",
Expand Down Expand Up @@ -3737,4 +3744,4 @@
"fuzzy": true
}
]
}
}
9 changes: 8 additions & 1 deletion internal/translations/locales/ko-KR/out.gotext.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,13 @@
"translatorComment": "Copied from source.",
"fuzzy": true
},
{
"id": "configuration file (YAML format, use .yaml or .yml extension)",
"message": "configuration file (YAML format, use .yaml or .yml extension)",
"translation": "configuration file (YAML format, use .yaml or .yml extension)",
"translatorComment": "Copied from source.",
"fuzzy": true
},
{
"id": "log level, error=0, warn=1, info=2, debug=3, trace=4",
"message": "log level, error=0, warn=1, info=2, debug=3, trace=4",
Expand Down Expand Up @@ -3737,4 +3744,4 @@
"fuzzy": true
}
]
}
}
9 changes: 8 additions & 1 deletion internal/translations/locales/pt-BR/out.gotext.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,13 @@
"translatorComment": "Copied from source.",
"fuzzy": true
},
{
"id": "configuration file (YAML format, use .yaml or .yml extension)",
"message": "configuration file (YAML format, use .yaml or .yml extension)",
"translation": "configuration file (YAML format, use .yaml or .yml extension)",
"translatorComment": "Copied from source.",
"fuzzy": true
},
{
"id": "log level, error=0, warn=1, info=2, debug=3, trace=4",
"message": "log level, error=0, warn=1, info=2, debug=3, trace=4",
Expand Down Expand Up @@ -3737,4 +3744,4 @@
"fuzzy": true
}
]
}
}
9 changes: 8 additions & 1 deletion internal/translations/locales/ru-RU/out.gotext.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,13 @@
"translatorComment": "Copied from source.",
"fuzzy": true
},
{
"id": "configuration file (YAML format, use .yaml or .yml extension)",
"message": "configuration file (YAML format, use .yaml or .yml extension)",
"translation": "configuration file (YAML format, use .yaml or .yml extension)",
"translatorComment": "Copied from source.",
"fuzzy": true
},
{
"id": "log level, error=0, warn=1, info=2, debug=3, trace=4",
"message": "log level, error=0, warn=1, info=2, debug=3, trace=4",
Expand Down Expand Up @@ -3737,4 +3744,4 @@
"fuzzy": true
}
]
}
}
9 changes: 8 additions & 1 deletion internal/translations/locales/zh-CN/out.gotext.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,13 @@
"translatorComment": "Copied from source.",
"fuzzy": true
},
{
"id": "configuration file (YAML format, use .yaml or .yml extension)",
"message": "configuration file (YAML format, use .yaml or .yml extension)",
"translation": "configuration file (YAML format, use .yaml or .yml extension)",
"translatorComment": "Copied from source.",
"fuzzy": true
},
{
"id": "log level, error=0, warn=1, info=2, debug=3, trace=4",
"message": "log level, error=0, warn=1, info=2, debug=3, trace=4",
Expand Down Expand Up @@ -3737,4 +3744,4 @@
"fuzzy": true
}
]
}
}
9 changes: 8 additions & 1 deletion internal/translations/locales/zh-TW/out.gotext.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,13 @@
"translatorComment": "Copied from source.",
"fuzzy": true
},
{
"id": "configuration file (YAML format, use .yaml or .yml extension)",
"message": "configuration file (YAML format, use .yaml or .yml extension)",
"translation": "configuration file (YAML format, use .yaml or .yml extension)",
"translatorComment": "Copied from source.",
"fuzzy": true
},
{
"id": "log level, error=0, warn=1, info=2, debug=3, trace=4",
"message": "log level, error=0, warn=1, info=2, debug=3, trace=4",
Expand Down Expand Up @@ -3737,4 +3744,4 @@
"fuzzy": true
}
]
}
}
Loading