Repository navigation
lake: clarify LakeSQL PATH setup after installation - #24608
ti-chi-bot[bot] merged 3 commits into
Conversation
- Explain that the installer adds LakeSQL to PATH in ~/.zprofile and ~/.profile, how to apply it in the current shell, and that Bash skips ~/.profile when ~/.bash_profile exists. - Note that the x86_64 Linux gnu build requires glibc 2.39 or later and point users on older systems to the statically linked musl build. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
ti-chi-bot
Bot
added
contribution
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the
Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
No actionable comments were generated in the recent review.
 |
| Layer / File(s) | Summary |
|---|---|
Shell PATH setup tidb-cloud-lake/guides/connect-using-lakesql.md |
The guide documents installer PATH entries in ~/.zprofile and ~/.profile, sourcing ~/.profile in the current terminal, and adding the PATH command to the file Bash reads when ~/.bash_profile or ~/.bash_login exists. |
Estimated code review effort: 1 (Trivial) | ~5 minutes
Change: Other
Suggested reviewers: qiancai
Merge Risk: 
f9893
-
This documentation-only change presents no identified merge-blocking risk.
Pre-merge checks: 
-
Check name Status Explanation Title check The title names the main change: clarifying the LakeSQL PATH setup after installation. It matches the raw summary and the PR objectives, which both describe documentation that explains how to make the… Description check The description covers the required sections. It states what changed and why, and it gives the reason for the change: users reported 'lakesql: command not found' after installation. It explains that t… Docstring Coverage No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentat… Linked Issues check Check skipped because no linked issues were found for this pull request. Out of Scope Changes check Check skipped because no linked issues were found for this pull request. Full details: Title check
-
Explanation
The title names the main change: clarifying the LakeSQL PATH setup after installation. It matches the raw summary and the PR objectives, which both describe documentation that explains how to make the lakesql command available after install. The title is short and specific, so a reviewer scanning history can identify the change.
Full details: Description check
-
Explanation
The description covers the required sections. It states what changed and why, and it gives the reason for the change: users reported 'lakesql: command not found' after installation. It explains that the installer writes PATH to ~/.zprofile and ~/.profile, that these only apply in a new login shell, and that Bash reads ~/.bash_profile when it exists. The version checkbox for v8.5 is ticked, and the AI agent involvement field is marked. The related reference links are provided. The template's first-time contributor checklist and the Contributor License Agreement item are not ticked. The description does not show whether that checklist applies, so the author should confirm it.
Full details: Docstring Coverage
-
Explanation
No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)
-
Finishing Touches
-
Generate unit tests (beta)
-
- Create a new PR
-
- Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
awxxxxxx
changed the title
[LGTM Timeline notifier]Timeline:
|
qiancai
added
translation/no-need
ti-chi-bot
Bot
removed
the
missing-translation-status
Co-authored-by: qiancai <79440533+qiancai@users.noreply.github.com> Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
|
/approve |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: qiancai The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
What is changed, added or deleted? (Required)
Users reported
lakesql: command not foundafter installing LakeSQL with the default shell script on Linux. This PR updates Connect to TiDB Cloud Lake with LakeSQL to explain how to make thelakesqlcommand available:bindirectory toPATHin~/.zprofileand~/.profile, which only take effect in a new login shell. The doc now tells users to runsource ~/.profilein the current terminal.~/.profilewhen~/.bash_profileexists (the default on CentOS, RHEL, and Alibaba Cloud Linux), so the doc notes that theexport PATH=...line must also be added to~/.bash_profile.The installer behavior was verified against the current installer script (
lakesql.sh).Which TiDB version(s) do your changes apply to? (Required)
Tips for choosing the affected version(s):
By default, CHOOSE MASTER ONLY so your changes will be applied to the next TiDB major or minor releases. If your PR involves a product feature behavior change or a compatibility change, CHOOSE THE AFFECTED RELEASE BRANCH(ES) AND MASTER.
For details, see tips for choosing the affected versions.
What is the related PR or file link(s)?
AI agent involvement
Do your changes match any of the following descriptions?
🤖 Generated with Claude Code
Summary by CodeRabbit
lakesqlin~/.lakesql/binand adds that directory to~/.zprofileand~/.profile.~/.profile.~/.bash_profileor~/.bash_logininstead of~/.profilewhen those files are present, including where to add the PATH command.