Skip to content

docs: add connection update command to cdata-cli skill #8

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
justinf-cdata wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: add connection update command to cdata-cli skill #8

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7f39cf2
docs: add connection update command (merge, replace, unset) to cdata-…
justinf-cdata Jul 22, 2026
dc1b434
docs: add --force flag to connection update command
justinf-cdata Jul 22, 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
11 changes: 10 additions & 1 deletion skills/cdata-cli/SKILL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,10 @@ If `cdatacli --version` is missing, install:
| Inspect connection properties | `drivers connectionprops <Driver> [--full]` |
| Generate driver-specific skill | `drivers skill <Driver>` |
| Create connection | `connection create --driver <Driver> --name N --connectionstring CS` |
| Update connection (merge) | `connection update --name N --connectionstring CS` |
| Update connection (replace) | `connection update --name N --connectionstring CS --replace` |
| Update, skip validation | `connection update --name N --connectionstring CS --force` |
| Remove properties | `connection update --name N --unset "Key1,Key2"` |
| List connections | `connection list` |
| Delete connection | `connection delete --name N` |
| List catalogs | `metadata catalogs --connection N` |
Expand Down Expand Up @@ -245,9 +249,14 @@ Common patterns:

```bash
cdatacli connection list
cdatacli connection update --name "<connection-name>" --connectionstring "<new-or-changed-properties>"
cdatacli connection update --name "<connection-name>" --connectionstring "<properties>" --replace
cdatacli connection update --name "<connection-name>" --unset "Key1,Key2"
cdatacli connection delete --name "<connection-name>"
```

`connection update` merges new properties into the existing connection by default — useful for changing a single property without recreating the connection. Use `--replace` to swap the entire connection string, or `--unset` to remove specific properties. Property names are case-insensitive. `--replace` and `--unset` cannot be combined. Use `--force` to skip connection validation — useful for placeholder connections or testing without a live source.

Connections are saved as encrypted `.conn` files (AES-256):

| OS | Location |
Expand Down Expand Up @@ -328,7 +337,7 @@ cdatacli query sql --connection <name> --sql "UPDATE [TableName] SET [Col1] = 'n
cdatacli query sql --connection <name> --sql "DELETE FROM [TableName] WHERE [Id] = '123'"
```

If writes fail, the connection may have `ReadOnly=true`. Do not change this on your own — point it out to the user and ask whether they want to recreate the connection without `ReadOnly=true` before taking any action.
If writes fail, the connection may have `ReadOnly=true`. Do not change this on your own — point it out to the user and ask whether they want to remove it. If they confirm, use `connection update --unset "ReadOnly"` rather than recreating the connection.

#### Stored Procedures

Expand Down