Skip to content

docs: replace deprecated --max-rows flag reference in execute_sql docs - #396

Merged
tianzhou merged 1 commit into
bytebase:mainfrom
laserduor:fix/execute-sql-param-table
Aug 8, 2026
Merged

docs: replace deprecated --max-rows flag reference in execute_sql docs#396
tianzhou merged 1 commit into
bytebase:mainfrom
laserduor:fix/execute-sql-param-table

Conversation

@laserduor

Copy link
Copy Markdown
Contributor

Summary

The --max-rows CLI flag was removed from DBHub — the CLI now prints an error pointing users to the TOML [[tools]] configuration instead (see src/config/env.ts). The execute_sql docs still reference the deprecated flag.

Change

Update the Row limiting feature entry in docs/tools/execute-sql.mdx to reference max_rows configured per tool via TOML [[tools]]:

-- **Row limiting**: Configure `--max-rows` to limit SELECT query results
+- **Row limiting**: Configure `max_rows` per tool via TOML `[[tools]]` to limit SELECT query results

Why

  • The flag no longer works (exits with an error), so the docs currently describe a non-existent feature
  • TOML is the supported way to configure row limiting since the flag was removed

Single-line, docs-only change. No behavior change.

…e_sql docs

The --max-rows CLI flag was removed and now exits with an error pointing
to the TOML [[tools]] configuration. Update the execute_sql docs to
reference max_rows in [[tools]] instead.

@tianzhou tianzhou left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@tianzhou
tianzhou merged commit ecf8c86 into bytebase:main Aug 8, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants