Skip to content

Commit 920bae4

Browse files
Copilotdlevy-msft-sql
Copilot
and
dlevy-msft-sql
committed
Correct documentation: only YAML format is actually supported
Co-authored-by: dlevy-msft-sql <[email protected]>
1 parent ff25b13 commit 920bae4

13 files changed

Lines changed: 36 additions & 44 deletions

File tree

‎README.md‎

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -84,23 +84,15 @@ sqlcmd config view
8484

8585
#### Custom Configuration Files
8686

87-
You can specify a custom configuration file using the `--sqlconfig` flag. The configuration file must use one of the following supported file extensions:
88-
- `.yaml` or `.yml` (YAML format)
89-
- `.json` (JSON format)
90-
- `.toml` (TOML format)
91-
- `.ini` (INI format)
92-
- `.env` or `.dotenv` (Dotenv format)
93-
- `.properties`, `.props`, or `.prop` (Properties format)
94-
95-
Additional formats like `.hcl` and `.tfvars` are also supported but less commonly used with sqlcmd.
87+
You can specify a custom configuration file using the `--sqlconfig` flag. Configuration files must be in **YAML format** and should use the `.yaml` or `.yml` file extension.
9688

9789
Example:
9890
```
9991
sqlcmd config --sqlconfig ./myproject.yaml add-endpoint --name ep1434 --address localhost --port 1434
10092
sqlcmd config --sqlconfig ./myproject.yaml view
10193
```
10294

103-
**Note:** Using unsupported file extensions (like `.sqlconfig`) will result in an "Unsupported Config Type" error when modifying the configuration (e.g., `add-endpoint`, `add-user`). Read-only commands (like `view`) may still work. The default configuration file at `~/.sqlcmd/sqlconfig` uses YAML format without an extension.
95+
**Note:** The default configuration file at `~/.sqlcmd/sqlconfig` uses YAML format without an extension. Using unsupported file extensions (like `.sqlconfig`) or non-YAML formats will result in errors when reading or writing the configuration.
10496

10597
### Versions
10698

‎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 (supported extensions: .yaml, .yml, .json, .toml, .ini, .env, .properties)"),
124+
Usage: localizer.Sprintf("configuration file (YAML format, use .yaml or .yml extension)"),
125125
})
126126

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

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -54,9 +54,9 @@
5454
"fuzzy": true
5555
},
5656
{
57-
"id": "configuration file (supported extensions: .yaml, .yml, .json, .toml, .ini, .env, .properties)",
58-
"message": "configuration file (supported extensions: .yaml, .yml, .json, .toml, .ini, .env, .properties)",
59-
"translation": "Konfigurationsdatei (unterstützte Erweiterungen: .yaml, .yml, .json, .toml, .ini, .env, .properties)",
57+
"id": "configuration file (YAML format, use .yaml or .yml extension)",
58+
"message": "configuration file (YAML format, use .yaml or .yml extension)",
59+
"translation": "configuration file (YAML format, use .yaml or .yml extension)",
6060
"translatorComment": "Copied from source.",
6161
"fuzzy": true
6262
},

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -54,9 +54,9 @@
5454
"fuzzy": true
5555
},
5656
{
57-
"id": "configuration file (supported extensions: .yaml, .yml, .json, .toml, .ini, .env, .properties)",
58-
"message": "configuration file (supported extensions: .yaml, .yml, .json, .toml, .ini, .env, .properties)",
59-
"translation": "configuration file (supported extensions: .yaml, .yml, .json, .toml, .ini, .env, .properties)",
57+
"id": "configuration file (YAML format, use .yaml or .yml extension)",
58+
"message": "configuration file (YAML format, use .yaml or .yml extension)",
59+
"translation": "configuration file (YAML format, use .yaml or .yml extension)",
6060
"translatorComment": "Copied from source.",
6161
"fuzzy": true
6262
},

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -54,9 +54,9 @@
5454
"fuzzy": true
5555
},
5656
{
57-
"id": "configuration file (supported extensions: .yaml, .yml, .json, .toml, .ini, .env, .properties)",
58-
"message": "configuration file (supported extensions: .yaml, .yml, .json, .toml, .ini, .env, .properties)",
59-
"translation": "configuration file (supported extensions: .yaml, .yml, .json, .toml, .ini, .env, .properties)",
57+
"id": "configuration file (YAML format, use .yaml or .yml extension)",
58+
"message": "configuration file (YAML format, use .yaml or .yml extension)",
59+
"translation": "configuration file (YAML format, use .yaml or .yml extension)",
6060
"translatorComment": "Copied from source.",
6161
"fuzzy": true
6262
},

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -54,9 +54,9 @@
5454
"fuzzy": true
5555
},
5656
{
57-
"id": "configuration file (supported extensions: .yaml, .yml, .json, .toml, .ini, .env, .properties)",
58-
"message": "configuration file (supported extensions: .yaml, .yml, .json, .toml, .ini, .env, .properties)",
59-
"translation": "configuration file (supported extensions: .yaml, .yml, .json, .toml, .ini, .env, .properties)",
57+
"id": "configuration file (YAML format, use .yaml or .yml extension)",
58+
"message": "configuration file (YAML format, use .yaml or .yml extension)",
59+
"translation": "configuration file (YAML format, use .yaml or .yml extension)",
6060
"translatorComment": "Copied from source.",
6161
"fuzzy": true
6262
},

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -54,9 +54,9 @@
5454
"fuzzy": true
5555
},
5656
{
57-
"id": "configuration file (supported extensions: .yaml, .yml, .json, .toml, .ini, .env, .properties)",
58-
"message": "configuration file (supported extensions: .yaml, .yml, .json, .toml, .ini, .env, .properties)",
59-
"translation": "configuration file (supported extensions: .yaml, .yml, .json, .toml, .ini, .env, .properties)",
57+
"id": "configuration file (YAML format, use .yaml or .yml extension)",
58+
"message": "configuration file (YAML format, use .yaml or .yml extension)",
59+
"translation": "configuration file (YAML format, use .yaml or .yml extension)",
6060
"translatorComment": "Copied from source.",
6161
"fuzzy": true
6262
},

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -54,9 +54,9 @@
5454
"fuzzy": true
5555
},
5656
{
57-
"id": "configuration file (supported extensions: .yaml, .yml, .json, .toml, .ini, .env, .properties)",
58-
"message": "configuration file (supported extensions: .yaml, .yml, .json, .toml, .ini, .env, .properties)",
59-
"translation": "configuration file (supported extensions: .yaml, .yml, .json, .toml, .ini, .env, .properties)",
57+
"id": "configuration file (YAML format, use .yaml or .yml extension)",
58+
"message": "configuration file (YAML format, use .yaml or .yml extension)",
59+
"translation": "configuration file (YAML format, use .yaml or .yml extension)",
6060
"translatorComment": "Copied from source.",
6161
"fuzzy": true
6262
},

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -54,9 +54,9 @@
5454
"fuzzy": true
5555
},
5656
{
57-
"id": "configuration file (supported extensions: .yaml, .yml, .json, .toml, .ini, .env, .properties)",
58-
"message": "configuration file (supported extensions: .yaml, .yml, .json, .toml, .ini, .env, .properties)",
59-
"translation": "configuration file (supported extensions: .yaml, .yml, .json, .toml, .ini, .env, .properties)",
57+
"id": "configuration file (YAML format, use .yaml or .yml extension)",
58+
"message": "configuration file (YAML format, use .yaml or .yml extension)",
59+
"translation": "configuration file (YAML format, use .yaml or .yml extension)",
6060
"translatorComment": "Copied from source.",
6161
"fuzzy": true
6262
},

‎internal/translations/locales/pt-BR/out.gotext.json‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -54,9 +54,9 @@
5454
"fuzzy": true
5555
},
5656
{
57-
"id": "configuration file (supported extensions: .yaml, .yml, .json, .toml, .ini, .env, .properties)",
58-
"message": "configuration file (supported extensions: .yaml, .yml, .json, .toml, .ini, .env, .properties)",
59-
"translation": "configuration file (supported extensions: .yaml, .yml, .json, .toml, .ini, .env, .properties)",
57+
"id": "configuration file (YAML format, use .yaml or .yml extension)",
58+
"message": "configuration file (YAML format, use .yaml or .yml extension)",
59+
"translation": "configuration file (YAML format, use .yaml or .yml extension)",
6060
"translatorComment": "Copied from source.",
6161
"fuzzy": true
6262
},

0 commit comments

Comments
 (0)