Skip to content

Commit 77fffe6

Browse files
docs: document --sqlconfig YAML-only format requirement
1 parent fb4625f commit 77fffe6

14 files changed

Lines changed: 3627 additions & 3639 deletions

File tree

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,17 @@ sqlcmd config connection-strings
8484
sqlcmd config view
8585
```
8686

87+
#### Custom Configuration Files
88+
89+
The `--sqlconfig` flag specifies a custom configuration file. Files must be **YAML format** with a `.yaml` or `.yml` extension:
90+
91+
```
92+
sqlcmd config --sqlconfig ./myproject.yaml add-endpoint --name ep1434 --address localhost --port 1434
93+
sqlcmd config --sqlconfig ./myproject.yaml view
94+
```
95+
96+
The default file (`~/.sqlcmd/sqlconfig`) has no extension but is also YAML.
97+
8798
### Versions
8899

89100
To see all version tags to choose from (2017, 2019, 2022 etc.), and install a specific version, run:

cmd/modern/root.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ func (c *Root) addGlobalFlags() {
121121
String: &c.configFilename,
122122
DefaultString: config.DefaultFileName(),
123123
Name: "sqlconfig",
124-
Usage: localizer.Sprintf("configuration file"),
124+
Usage: localizer.Sprintf("YAML configuration file (.yaml or .yml extension)"),
125125
})
126126

127127
/* BUG(stuartpa): - At the moment this is a top level flag, but it doesn't

internal/translations/catalog.go

Lines changed: 3582 additions & 3585 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

internal/translations/locales/de-DE/out.gotext.json

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -47,11 +47,9 @@
4747
"fuzzy": true
4848
},
4949
{
50-
"id": "configuration file",
51-
"message": "configuration file",
52-
"translation": "Konfigurationsdatei",
53-
"translatorComment": "Copied from source.",
54-
"fuzzy": true
50+
"id": "YAML configuration file (.yaml or .yml extension)",
51+
"message": "YAML configuration file (.yaml or .yml extension)",
52+
"translation": ""
5553
},
5654
{
5755
"id": "log level, error=0, warn=1, info=2, debug=3, trace=4",

internal/translations/locales/en-US/out.gotext.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,9 @@
4747
"fuzzy": true
4848
},
4949
{
50-
"id": "configuration file",
51-
"message": "configuration file",
52-
"translation": "configuration file",
50+
"id": "YAML configuration file (.yaml or .yml extension)",
51+
"message": "YAML configuration file (.yaml or .yml extension)",
52+
"translation": "YAML configuration file (.yaml or .yml extension)",
5353
"translatorComment": "Copied from source.",
5454
"fuzzy": true
5555
},

internal/translations/locales/es-ES/out.gotext.json

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -47,11 +47,9 @@
4747
"fuzzy": true
4848
},
4949
{
50-
"id": "configuration file",
51-
"message": "configuration file",
52-
"translation": "archivo de configuración",
53-
"translatorComment": "Copied from source.",
54-
"fuzzy": true
50+
"id": "YAML configuration file (.yaml or .yml extension)",
51+
"message": "YAML configuration file (.yaml or .yml extension)",
52+
"translation": ""
5553
},
5654
{
5755
"id": "log level, error=0, warn=1, info=2, debug=3, trace=4",

internal/translations/locales/fr-FR/out.gotext.json

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -47,11 +47,9 @@
4747
"fuzzy": true
4848
},
4949
{
50-
"id": "configuration file",
51-
"message": "configuration file",
52-
"translation": "fichier de configuration",
53-
"translatorComment": "Copied from source.",
54-
"fuzzy": true
50+
"id": "YAML configuration file (.yaml or .yml extension)",
51+
"message": "YAML configuration file (.yaml or .yml extension)",
52+
"translation": ""
5553
},
5654
{
5755
"id": "log level, error=0, warn=1, info=2, debug=3, trace=4",

internal/translations/locales/it-IT/out.gotext.json

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -47,11 +47,9 @@
4747
"fuzzy": true
4848
},
4949
{
50-
"id": "configuration file",
51-
"message": "configuration file",
52-
"translation": "file di configurazione",
53-
"translatorComment": "Copied from source.",
54-
"fuzzy": true
50+
"id": "YAML configuration file (.yaml or .yml extension)",
51+
"message": "YAML configuration file (.yaml or .yml extension)",
52+
"translation": ""
5553
},
5654
{
5755
"id": "log level, error=0, warn=1, info=2, debug=3, trace=4",

internal/translations/locales/ja-JP/out.gotext.json

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -47,11 +47,9 @@
4747
"fuzzy": true
4848
},
4949
{
50-
"id": "configuration file",
51-
"message": "configuration file",
52-
"translation": "構成ファイル",
53-
"translatorComment": "Copied from source.",
54-
"fuzzy": true
50+
"id": "YAML configuration file (.yaml or .yml extension)",
51+
"message": "YAML configuration file (.yaml or .yml extension)",
52+
"translation": ""
5553
},
5654
{
5755
"id": "log level, error=0, warn=1, info=2, debug=3, trace=4",

internal/translations/locales/ko-KR/out.gotext.json

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -47,11 +47,9 @@
4747
"fuzzy": true
4848
},
4949
{
50-
"id": "configuration file",
51-
"message": "configuration file",
52-
"translation": "구성 파일",
53-
"translatorComment": "Copied from source.",
54-
"fuzzy": true
50+
"id": "YAML configuration file (.yaml or .yml extension)",
51+
"message": "YAML configuration file (.yaml or .yml extension)",
52+
"translation": ""
5553
},
5654
{
5755
"id": "log level, error=0, warn=1, info=2, debug=3, trace=4",

0 commit comments

Comments
 (0)