Skip to content

Fixes to "db attach" doc #7525

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

Merged
philrz merged 1 commit into from
Oct 23, 2026
Merged

Fixes to "db attach" doc #7525

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 5 additions & 3 deletions book/src/command/db.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -241,13 +241,15 @@ super db -f db -c "from logs:objects"
### super db attach

```
super db attach <endpoint>
super db attach [options] [endpoint]
```
* [Global](options.md#global)
* [Database](options.md#database)

The `attach` command binds the local CLI to a database.
The `<endpoint>` argument specifies a local file system path,
The `attach` command binds the local CLI to a database, or, if the `endpoint`
argument is not provided, shows the currently attached database.

The `endpoint` argument specifies a local file system path,
an `s3` URL, or the URL of a service endpoint.
When connecting to a service that requires authentication,
attach initiates a login to obtain credentials.
Expand Down
2 changes: 1 addition & 1 deletion book/src/command/options.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ in which they occurred.
Database options available to the `super db` command and
to all `db` [sub-commands](db.md#sub-commands) include:
* `-configdir` configuration and credentials directory
* `-attach URI` database location for this command only (defaults to the [attached database](../database/intro.md#locating-the-database))
* `-attach URI` database location for this command only (defaults to the [attached database](db.md#super-db-attach))
* `-q` quiet mode to disable displaying status messages for many `super db` subcommands

## Commit
Expand Down
Loading