Skip to content

Conversation

amotl
Copy link
Member

@amotl amotl commented Aug 14, 2025

About

Re-submitting this here from crate/crate-clients-tools#118 by @chandrevdw31 -- thanks!

Added MindsDB to docs. MindsDB integrates with CrateDB, making data from CrateDB accessible to a diverse range of AI/ML models. Feel free to ask any questions.

Preview

https://cratedb-guide--253.org.readthedocs.build/integrate/mindsdb/

@amotl amotl added the new content New content being added. label Aug 14, 2025
Copy link

coderabbitai bot commented Aug 14, 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 2 minutes and 10 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 6236c1c and cfe23e7.

📒 Files selected for processing (3)
  • docs/integrate/index.md (1 hunks)
  • docs/integrate/mindsdb/index.md (1 hunks)
  • docs/topic/ml/index.md (1 hunks)

Walkthrough

Adds MindsDB integration documentation: inserts it into the integrations index, creates a new MindsDB integration page with connection and query examples, and links it from the ML topic page. No code or API changes; all updates are within documentation.

Changes

Cohort / File(s) Summary
Integrations index update
docs/integrate/index.md
Inserted mindsdb/index into the toctree after metabase/index and before mongodb/index.
New MindsDB integration page
docs/integrate/mindsdb/index.md
Added a new page describing MindsDB integration with CrateDB, including About, Synopsis with CREATE DATABASE example and sample query, tutorial cards (Quickstart and Use CrateDB with MindsDB), and external links; includes logo and layout directives.
ML topic cross-link
docs/topic/ml/index.md
Added a “MindsDB” section with anchor and a toctree linking to ../../integrate/mindsdb/index (maxdepth: 1).

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~7 minutes

Possibly related PRs

Suggested labels

guidance

Suggested reviewers

  • bmunkholm
  • karynzv
  • surister

Poem

I thump my paws on pages new,
MindsDB hops into the view.
With SQL trails and carrot cues,
I link the burrows, spread the news.
In docs we weave a burrow bright—
Hop in, connect, query delight! 🥕🐇

✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch mindsdb

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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@amotl amotl changed the title Added MindsDB Integrate: Add MindsDB Aug 14, 2025
@amotl amotl mentioned this pull request Aug 14, 2025
2 tasks
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Nitpick comments (2)
docs/integrate/mindsdb/index.md (2)

53-57: Fix typo: “MindDB’s” → “MindsDB’s”

Spelling of the product name should be consistent throughout.

- Learn more about MindDB's integration with CrateDB and see examples.
+ Learn more about MindsDB's integration with CrateDB and see examples.

48-50: Satisfy MD034 (no-bare-urls) in directive options

Wrap bare URLs in angle brackets to silence markdownlint while preserving behavior.

-:link: https://docs.mindsdb.com/quickstart-tutorial
+:link: <https://docs.mindsdb.com/quickstart-tutorial>
@@
-:link: https://docs.mindsdb.com/integrations/data-integrations/cratedb
+:link: <https://docs.mindsdb.com/integrations/data-integrations/cratedb>

Also applies to: 54-56

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

💡 Knowledge Base configuration:

  • MCP integration is disabled by default for public repositories
  • Jira integration is disabled by default for public repositories
  • Linear integration is disabled by default for public repositories

You can enable these settings in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between d38aa51 and 8f27f4d.

📒 Files selected for processing (3)
  • docs/integrate/index.md (1 hunks)
  • docs/integrate/mindsdb/index.md (1 hunks)
  • docs/topic/ml/index.md (1 hunks)
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2025-08-09T16:19:43.966Z
Learnt from: amotl
PR: crate/cratedb-guide#238
File: docs/integrate/azure-functions/learn.rst:1-1
Timestamp: 2025-08-09T16:19:43.966Z
Learning: In the CrateDB Guide documentation, main integration anchors (e.g., `azure-functions`) are intentionally placed in the `index.md` files of their respective integration folders, while detailed tutorials use the `-learn` suffix (e.g., `azure-functions-learn`) in their `learn.rst` or `learn.md` files. This is a deliberate architectural pattern for the documentation restructuring.

Applied to files:

  • docs/integrate/mindsdb/index.md
🪛 LanguageTool
docs/integrate/index.md

[grammar] ~47-~47: There might be a mistake here.
Context: ...ltano/index metabase/index mindsdb/index mongodb/index mqtt/index mysql/index n8n...

(QB_NEW_EN)

docs/integrate/mindsdb/index.md

[grammar] ~1-~1: There might be a mistake here.
Context: (mindsdb)= # MindsDB ```{div} .float-right [![MindsD...

(QB_NEW_EN)


[grammar] ~10-~10: There might be a mistake here.
Context: ...``{div} .clearfix ``` :::{rubric} About ::: [MindsDB] is the platform for custo...

(QB_NEW_EN)


[grammar] ~13-~13: There might be a mistake here.
Context: ...ng AI from enterprise data. With MindsDB and its nearly 200 integrations to [data...

(QB_NEW_EN)


[grammar] ~18-~18: There might be a mistake here.
Context: ...and more securely. :::{rubric} Synopsis ::: Connect to the CrateDB database in M...

(QB_NEW_EN)


[grammar] ~19-~19: There might be a mistake here.
Context: ...more securely. :::{rubric} Synopsis ::: Connect to the CrateDB database in Minds...

(QB_NEW_EN)


[grammar] ~39-~39: There might be a mistake here.
Context: ..._datasource.demo; ``` :::{rubric} Learn ::: MindsDB integrates with CrateDB, ma...

(QB_NEW_EN)


[grammar] ~42-~42: There might be a mistake here.
Context: ..., making data from CrateDB accessible to a diverse range of AI/ML models. ::::{g...

(QB_NEW_EN)

docs/topic/ml/index.md

[grammar] ~350-~350: There might be a mistake here.
Context: ...ate/llamaindex/index ::: (ml-mindsdb)= ### MindsDB :::{toctree} :maxdepth: 1 ../....

(QB_NEW_EN)


[grammar] ~353-~353: There might be a mistake here.
Context: ... (ml-mindsdb)= ### MindsDB :::{toctree} :maxdepth: 1 ../../integrate/mindsdb/in...

(QB_NEW_EN)

🪛 markdownlint-cli2 (0.17.2)
docs/integrate/mindsdb/index.md

48-48: Bare URL used

(MD034, no-bare-urls)


54-54: Bare URL used

(MD034, no-bare-urls)

🔇 Additional comments (3)
docs/integrate/index.md (1)

47-47: LGTM: MindsDB entry correctly added and alphabetically placed

The toctree insertion is consistent with neighboring entries and site structure.

docs/integrate/mindsdb/index.md (1)

1-12: Structure, anchors, and layout match the doc patterns

Anchor placement, rubric usage, grid cards, and link references align with the established integration-doc architecture.

Also applies to: 39-61

docs/topic/ml/index.md (1)

350-357: LGTM: MindsDB added to ML topic with proper anchor and toctree

Placement mirrors LangChain/LlamaIndex sections and uses the correct relative path.

@amotl amotl requested review from bmunkholm and kneth August 14, 2025 19:03
@amotl amotl marked this pull request as ready for review August 14, 2025 19:03
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (3)
docs/integrate/mindsdb/index.md (3)

20-20: Tighten phrasing: “from MindsDB” reads clearer

“Connect to CrateDB from MindsDB.” is more direct and consistent with other integration pages.

-Connect to the CrateDB database in MindsDB.
+Connect to CrateDB from MindsDB.

21-33: Add a short note clarifying protocol/port and why defaults are used

To prevent confusion between HTTP (4200) and PostgreSQL (5432) and to document the rationale for runnable defaults, add a brief note right after the connection block. This aligns with the docs pattern of using out-of-the-box local defaults.

     parameters = {
         "user": "crate",
         "password": "",
         "host": "127.0.0.1",
         "port": 4200,
         "schema_name": "doc"
     };

+:::{note}
+MindsDB’s CrateDB engine connects via CrateDB’s HTTP API (default port 4200), not the PostgreSQL wire protocol (5432).
+The example above uses CrateDB’s local defaults (user: "crate", blank password, host: 127.0.0.1) so it runs out of the box on a local instance.
+:::


---

`35-37`: **Optional: limit the sample query output**

Adding a LIMIT makes example output manageable and avoids large result sets in interactive sessions.


```diff
-SELECT * FROM cratedb_datasource.demo;
+SELECT * FROM cratedb_datasource.demo
+LIMIT 10;
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

💡 Knowledge Base configuration:

  • MCP integration is disabled by default for public repositories
  • Jira integration is disabled by default for public repositories
  • Linear integration is disabled by default for public repositories

You can enable these settings in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 8f27f4d and 6236c1c.

📒 Files selected for processing (3)
  • docs/integrate/index.md (1 hunks)
  • docs/integrate/mindsdb/index.md (1 hunks)
  • docs/topic/ml/index.md (1 hunks)
🧰 Additional context used
🧠 Learnings (4)
📚 Learning: 2025-08-09T16:19:43.966Z
Learnt from: amotl
PR: crate/cratedb-guide#238
File: docs/integrate/azure-functions/learn.rst:1-1
Timestamp: 2025-08-09T16:19:43.966Z
Learning: In the CrateDB Guide documentation, main integration anchors (e.g., `azure-functions`) are intentionally placed in the `index.md` files of their respective integration folders, while detailed tutorials use the `-learn` suffix (e.g., `azure-functions-learn`) in their `learn.rst` or `learn.md` files. This is a deliberate architectural pattern for the documentation restructuring.

Applied to files:

  • docs/integrate/mindsdb/index.md
📚 Learning: 2025-08-14T19:02:43.262Z
Learnt from: amotl
PR: crate/cratedb-guide#253
File: docs/integrate/mindsdb/index.md:21-33
Timestamp: 2025-08-14T19:02:43.262Z
Learning: In CrateDB integration documentation examples, default connection parameters (user="crate", password="", host="127.0.0.1") are intentionally used to provide working out-of-the-box examples for users with local CrateDB instances, rather than using placeholder values that require customization.

Applied to files:

  • docs/integrate/mindsdb/index.md
📚 Learning: 2025-08-05T07:14:57.416Z
Learnt from: hammerhead
PR: crate/cratedb-guide#221
File: docs/connect/configure.md:58-66
Timestamp: 2025-08-05T07:14:57.416Z
Learning: In CrateDB connection strings, the user:password@ syntax is valid for HTTP Basic authentication on port 4200, but PostgreSQL JDBC drivers do not support this format and require credentials as query parameters (?user=<user>&password=<password>) instead.

Applied to files:

  • docs/integrate/mindsdb/index.md
📚 Learning: 2025-06-05T14:29:15.512Z
Learnt from: amotl
PR: crate/cratedb-guide#207
File: docs/integrate/etl/iceberg-risingwave.md:205-207
Timestamp: 2025-06-05T14:29:15.512Z
Learning: The `records.Database("crate://", echo=True)` connection string for CrateDB works with defaults: localhost as host, "crate" as user, and blank password. This is valid and functional code in the records library.

Applied to files:

  • docs/integrate/mindsdb/index.md
🪛 LanguageTool
docs/integrate/index.md

[grammar] ~47-~47: There might be a mistake here.
Context: ...ltano/index metabase/index mindsdb/index mongodb/index mqtt/index mysql/index n8n...

(QB_NEW_EN)

docs/integrate/mindsdb/index.md

[grammar] ~1-~1: There might be a mistake here.
Context: (mindsdb)= # MindsDB ```{div} .float-right [![MindsD...

(QB_NEW_EN)


[grammar] ~10-~10: There might be a mistake here.
Context: ...``{div} .clearfix ``` :::{rubric} About ::: [MindsDB] is the platform for custo...

(QB_NEW_EN)


[grammar] ~13-~13: There might be a mistake here.
Context: ...ng AI from enterprise data. With MindsDB and its nearly 200 integrations to [data...

(QB_NEW_EN)


[grammar] ~18-~18: There might be a mistake here.
Context: ...and more securely. :::{rubric} Synopsis ::: Connect to the CrateDB database in M...

(QB_NEW_EN)


[grammar] ~19-~19: There might be a mistake here.
Context: ...more securely. :::{rubric} Synopsis ::: Connect to the CrateDB database in Minds...

(QB_NEW_EN)


[grammar] ~39-~39: There might be a mistake here.
Context: ..._datasource.demo; ``` :::{rubric} Learn ::: MindsDB integrates with CrateDB, ma...

(QB_NEW_EN)


[grammar] ~42-~42: There might be a mistake here.
Context: ..., making data from CrateDB accessible to a diverse range of AI/ML models. ::::{g...

(QB_NEW_EN)

docs/topic/ml/index.md

[grammar] ~350-~350: There might be a mistake here.
Context: ...ate/llamaindex/index ::: (ml-mindsdb)= ### MindsDB :::{toctree} :maxdepth: 1 ../....

(QB_NEW_EN)


[grammar] ~353-~353: There might be a mistake here.
Context: ... (ml-mindsdb)= ### MindsDB :::{toctree} :maxdepth: 1 ../../integrate/mindsdb/in...

(QB_NEW_EN)

🪛 markdownlint-cli2 (0.17.2)
docs/integrate/mindsdb/index.md

48-48: Bare URL used

(MD034, no-bare-urls)


54-54: Bare URL used

(MD034, no-bare-urls)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: Build docs
🔇 Additional comments (2)
docs/integrate/index.md (1)

47-47: MindsDB entry added to integrations index — LGTM

Placement and naming are consistent with existing entries and alphabetical ordering. No issues spotted.

docs/topic/ml/index.md (1)

350-357: MindsDB entry in ML topic — LGTM

Anchor, heading, and toctree target look correct; relative path resolves to the new integration page. Consistent with LangChain/LlamaIndex sections.

Added MindsDB to docs. MindsDB integrates with CrateDB, making
data from CrateDB accessible to a diverse range of AI/ML models.
Feel free to ask any questions.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

new content New content being added.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants