Skip to content

Commit c1203ce

Browse files
Clarify read vs write behavior and add all supported extensions
Co-authored-by: dlevy-msft-sql <[email protected]>
1 parent e3d9c23 commit c1203ce

1 file changed

Lines changed: 5 additions & 3 deletions

File tree

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -89,16 +89,18 @@ You can specify a custom configuration file using the `--sqlconfig` flag. The co
8989
- `.json` (JSON format)
9090
- `.toml` (TOML format)
9191
- `.ini` (INI format)
92-
- `.env` (Dotenv format)
93-
- `.properties` (Properties 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.
9496

9597
Example:
9698
```
9799
sqlcmd config --sqlconfig ./myproject.yaml add-endpoint --name ep1434 --address localhost --port 1434
98100
sqlcmd config --sqlconfig ./myproject.yaml view
99101
```
100102

101-
**Note:** Using unsupported file extensions (like `.sqlconfig`) will result in an "Unsupported Config Type" error when modifying the configuration. The default configuration file at `~/.sqlcmd/sqlconfig` uses YAML format without an extension.
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.
102104

103105
### Versions
104106

0 commit comments

Comments
 (0)