Skip to content

Conversation

amotl
Copy link
Member

@amotl amotl commented Oct 16, 2025

@amotl amotl added the cross linking Linking to different locations of the documentation. label Oct 16, 2025
@coderabbitai
Copy link

coderabbitai bot commented Oct 16, 2025

Warning

Rate limit exceeded

@amotl has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 8 minutes and 13 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 98061e8 and 58488ca.

📒 Files selected for processing (2)
  • docs/connect/go/index.md (1 hunks)
  • docs/connect/index.md (2 hunks)

Walkthrough

Adds a new Go connectivity guide (docs/connect/go.md) with pgx v5 and pq examples, Docker/Cloud notes, and an Example card; updates docs/connect/index.md to add a Go driver card and include go in the drivers toctree.

Changes

Cohort / File(s) Summary
New Go connection guide
docs/connect/go.md
New documentation file with module metadata, pgx v5 and pq (database/sql) examples demonstrating connection via DATABASE_URL, a sample query (SELECT mountain, height FROM sys.summits ...), result scanning/printing, Docker/Podman and CrateDB Cloud notes, Example card and reference links.
Connect index updates
docs/connect/index.md
Adds a Go driver card to the "Drivers by language" grid (link, link-type, icon, styling) and inserts go into the connect toctree alongside existing language entries.

Sequence Diagram(s)

sequenceDiagram
    participant Reader
    participant Docs as "docs/connect/go.md"
    participant Index as "docs/connect/index.md"
    participant Example as "External Example / Repo"

    Reader->>Index: Open Drivers-by-language page
    Note right of Index #f0f9ff: New Go card links to guide
    Reader->>Docs: Open Go connectivity guide
    Note right of Docs #e6f7ff: Shows pgx v5 & pq examples, Docker/Cloud notes, Example card
    Docs->>Example: Link to example code / repo
    Reader->>Example: Follow link or copy example
Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Suggested labels

guidance

Suggested reviewers

  • kneth
  • surister

Poem

I hop through docs with code in paw,
pgx and pq I gently draw.
A Docker cup, a cloud-sent view,
three summits print — hooray! — anew.
🐇

Pre-merge checks and finishing touches

❌ Failed checks (1 inconclusive)
Check name Status Explanation Resolution
Description Check ❓ Inconclusive The pull request description consists solely of "What the title says" and a preview link. While the PR title "Driver: Add page about Go" is clearly related to the changeset, which adds Go driver documentation to docs/connect/go.md and updates the navigation index, the description itself is extremely vague and does not independently convey any meaningful information about what was actually changed. The phrase defers entirely to the title rather than describing the changeset in its own right, making it difficult to understand the specific modifications from the description alone. Consider expanding the description to explicitly state what was added or modified, such as "Adds new Go driver documentation page with pgx and pq examples and updates the driver navigation index." This would provide meaningful information about the changeset without requiring readers to reference external links or the title alone. Even a brief description of the key additions would significantly improve clarity for reviewers and future reference.
✅ Passed checks (2 passed)
Check name Status Explanation
Title Check ✅ Passed The pull request title "Driver: Add page about Go" directly and accurately summarizes the main change in the changeset. The raw summary confirms that a new documentation file docs/connect/go.md was added detailing Go connectivity to CrateDB, and a Go entry was added to the driver navigation in docs/connect/index.md. The title is concise, clear, and specific enough to convey the primary change to a teammate reviewing the history.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

coderabbitai[bot]

This comment was marked as resolved.

@amotl amotl force-pushed the go branch 3 times, most recently from a5568d4 to 8f7a983 Compare October 16, 2025 10:47
@amotl amotl requested review from kneth and surister October 16, 2025 11:12
@kneth kneth mentioned this pull request Oct 17, 2025
Copy link
Member

@kneth kneth left a comment

Choose a reason for hiding this comment

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

We need to merge #415 before this PR can be merged

@amotl amotl force-pushed the go branch 2 times, most recently from 6e459e5 to 6e33ebd Compare October 17, 2025 15:25
coderabbitai[bot]

This comment was marked as resolved.

@amotl amotl requested a review from kneth October 17, 2025 15:26
@amotl

This comment was marked as resolved.

Comment on lines +12 to +18
:::{rubric} About
:::

[pgx] is a pure Go driver and toolkit for PostgreSQL.
Copy link
Member Author

Choose a reason for hiding this comment

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

I just discovered lib/pq, a pure Go PostgreSQL driver for database/sql.

Copy link
Member Author

@amotl amotl Oct 20, 2025

Choose a reason for hiding this comment

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

0c1d156 adds information about it. /cc @coderabbitai

Copy link

Choose a reason for hiding this comment

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

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Show the commit details for 0c1d156b9c
git show 0c1d156b9c

Length of output: 2003


@amotl, thanks for the heads up! I've reviewed commit 0c1d156.

Great addition! The documentation now covers both major PostgreSQL drivers for Go:

  • pgx: A more modern, feature-rich driver with advanced features like connection pooling
  • pq: The traditional, widely-adopted database/sql driver

The new pq section follows the same clear structure as the pgx section with:

  • Basic usage example showing standard database/sql patterns
  • Connection string examples for both local and CrateDB Cloud setups
  • Proper error handling guidance (using sslmode=disable for local, sslmode=require for cloud)

This gives users flexibility to choose based on their needs - pgx for more advanced features or pq for traditional database/sql compatibility. The documentation is comprehensive and consistent! 👍

coderabbitai[bot]

This comment was marked as resolved.

@amotl amotl added the new content New content being added. label Oct 20, 2025
@amotl amotl force-pushed the go branch 2 times, most recently from 958f282 to 4d9dcc3 Compare October 21, 2025 12:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cross linking Linking to different locations of the documentation. new content New content being added.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants