Connect: Migrate pages from crate-clients-tools, to be retired soon
#221
Conversation
WalkthroughThis update reorganizes and expands the CrateDB documentation related to connectivity. It introduces a new "Connect" section with detailed guides for connecting via various languages (Java, Python, JavaScript, PHP, Ruby), ORM libraries, CLI tools, and data frame libraries. It also provides comprehensive driver listings and configuration instructions. Legacy connectivity documentation and references are removed or updated for consistency. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Docs
participant CrateDB
User->>Docs: Access "Connect" section
Docs->>User: Show guides for CLI, Java, Python, JS, PHP, Ruby, ORM, DataFrames, Drivers
User->>Docs: Follow language/driver-specific guide
Docs->>User: Provide connection string/configuration example
User->>CrateDB: Initiate connection using provided example
CrateDB-->>User: Responds to connection/query
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Poem
Note ⚡️ Unit Test Generation is now available in beta!Learn more here, or try it out under "Finishing Touches" below. ✨ Finishing Touches🧪 Generate unit tests
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 9
🧹 Nitpick comments (9)
docs/connect/java.rst (1)
7-8: Nit: grammatical typo“provides a common interfaces” → “provides a common interface”.
-JDBC is a standard Java API that provides a common interfaces for accessing +JDBC is a standard Java API that provides a common interface for accessingdocs/connect/php.rst (1)
48-50: Use a PHP syntax-highlighted block instead of “console”.The second example contains PHP code, yet it is declared with
.. code-block:: console.
Keeping the language consistent improves rendering and copy-paste usability.-.. code-block:: console +.. code-block:: phpdocs/connect/df.md (1)
121-122: Stylistic nit – prefer “among” to “amongst”.“amongst” is considered archaic by some style guides. Switching to “among” matches modern usage.
- by dividing the workload amongst the available CPU cores + by dividing the workload among the available CPU coresdocs/connect/python.rst (1)
111-114: Unmatched parenthesis and typo in aiopg descriptionText currently reads:
“from the asyncio PEP-3156/tulip) framework.”Remove the stray closing parenthesis and capitalise “Python”.
Suggested wording:
-aiopg is a python library for accessing a PostgreSQL database from the asyncio -PEP-3156/tulip) framework. +aiopg is a Python library for accessing a PostgreSQL database from the +asyncio (PEP 3156, *Tulip*) framework.docs/connect/index.md (1)
24-26: Spelling: “off-the-shelf”, not “off-the-shelve”-off-the-shelve, 3rd-party, open-source, and proprietary applications. +off-the-shelf, 3rd-party, open-source, and proprietary applications.docs/connect/javascript.rst (4)
7-8: Capitalize “Node.js” consistentlyThroughout the doc the runtime is written as “node.js”. The standard spelling is “Node.js”. Using the canonical form improves polish and search-ability.
-This section provides a quick overview of available node.js modules and -drivers for CrateDB Cloud. +This section provides a quick overview of available Node.js modules and +drivers for CrateDB Cloud.
13-15: Apply the same “Node.js” spelling inside section bodyThe section heading was fixed above, but the body still contains the lowercase variant.
-node-postgres is a collection of node.js modules for interfacing with a CrateDB -Cloud database. +node-postgres is a collection of Node.js modules for interfacing with a +CrateDB Cloud database.
22-28: Avoid hard-coding credentials in example codeHard-coding the admin password inside the source example can encourage insecure copy-paste practices. Prefer an environment variable or placeholder that nudges users toward safer patterns.
- user: "admin", - password: "<PASSWORD>", + user: process.env.DB_USER ?? "admin", + password: process.env.DB_PASSWORD ?? "<PASSWORD>",A short explanatory sentence (“Consider exporting
DB_USERandDB_PASSWORDas environment variables”) would reinforce the guidance.
41-42: Clarify wording & product name“for CRATE” is ambiguous and uses a deprecated all-caps product name. Use “for CrateDB” and mention the “_sql” HTTP endpoint explicitly.
-node-crate is an independent node.js driver implementation for CRATE using the _sql endpoint REST API. +node-crate is an independent Node.js driver for CrateDB that communicates via +the `_sql` HTTP endpoint.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (16)
docs/connect/cli.md(1 hunks)docs/connect/df.md(1 hunks)docs/connect/index.md(1 hunks)docs/connect/java.rst(1 hunks)docs/connect/javascript.rst(1 hunks)docs/connect/orm.md(1 hunks)docs/connect/php.rst(1 hunks)docs/connect/python.rst(1 hunks)docs/connect/ruby.rst(1 hunks)docs/feature/connectivity/index.md(0 hunks)docs/feature/index.md(1 hunks)docs/index.md(1 hunks)docs/install/index.rst(1 hunks)docs/integrate/df.md(0 hunks)docs/integrate/index.md(0 hunks)docs/integrate/orm.md(0 hunks)
💤 Files with no reviewable changes (4)
- docs/integrate/orm.md
- docs/integrate/index.md
- docs/integrate/df.md
- docs/feature/connectivity/index.md
🧰 Additional context used
🧠 Learnings (5)
📓 Common learnings
Learnt from: amotl
PR: crate/cratedb-guide#204
File: docs/integrate/mcp/community.md:22-33
Timestamp: 2025-05-18T12:50:36.393Z
Learning: In the CrateDB Guide repository, the prefix `ctk:` in documentation links (like `ctk:query/mcp/server`) is an intersphinx reference that points to external content in the CrateDB Toolkit documentation at https://cratedb-toolkit.readthedocs.io/. These references are intentionally not pointing to local files within the repository.
Learnt from: amotl
PR: crate/cratedb-guide#204
File: docs/integrate/mcp/community.md:8-20
Timestamp: 2025-05-18T12:50:38.681Z
Learning: In the CrateDB guide repository, references with the `ctk:` prefix (like `ctk:query/mcp/landscape`) are intersphinx references that link to resources in the cratedb-toolkit repository (https://github.com/crate/cratedb-toolkit/tree/main/doc), which are rendered at https://cratedb-toolkit.readthedocs.io/. These are valid cross-references between separate Sphinx documentation sets, not local file references.
Learnt from: amotl
PR: crate/cratedb-guide#204
File: docs/integrate/mcp/community.md:6-8
Timestamp: 2025-05-18T13:25:11.786Z
Learning: In the CrateDB Guide documentation, particularly for MCP-related pages, the author prefers a 1-column grid layout for multiple cards to stack them vertically rather than side by side, as this is an intentional design choice.
📚 Learning: the `records.database("crate://", echo=true)` connection string for cratedb works with defaults: loc...
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/connect/java.rstdocs/connect/ruby.rstdocs/connect/orm.mddocs/connect/cli.mddocs/connect/python.rstdocs/connect/index.md
📚 Learning: in the cratedb guide repository, the prefix `ctk:` in documentation links (like `ctk:query/mcp/serve...
Learnt from: amotl
PR: crate/cratedb-guide#204
File: docs/integrate/mcp/community.md:22-33
Timestamp: 2025-05-18T12:50:36.393Z
Learning: In the CrateDB Guide repository, the prefix `ctk:` in documentation links (like `ctk:query/mcp/server`) is an intersphinx reference that points to external content in the CrateDB Toolkit documentation at https://cratedb-toolkit.readthedocs.io/. These references are intentionally not pointing to local files within the repository.
Applied to files:
docs/connect/orm.mddocs/feature/index.mddocs/connect/cli.mddocs/connect/python.rstdocs/connect/index.md
📚 Learning: in the cratedb guide repository, references with the `ctk:` prefix (like `ctk:query/mcp/landscape`) ...
Learnt from: amotl
PR: crate/cratedb-guide#204
File: docs/integrate/mcp/community.md:8-20
Timestamp: 2025-05-18T12:50:38.681Z
Learning: In the CrateDB guide repository, references with the `ctk:` prefix (like `ctk:query/mcp/landscape`) are intersphinx references that link to resources in the cratedb-toolkit repository (https://github.com/crate/cratedb-toolkit/tree/main/doc), which are rendered at https://cratedb-toolkit.readthedocs.io/. These are valid cross-references between separate Sphinx documentation sets, not local file references.
Applied to files:
docs/connect/orm.mddocs/feature/index.mddocs/connect/cli.mddocs/connect/python.rstdocs/connect/index.md
📚 Learning: in the cratedb guide documentation, particularly for mcp-related pages, the author prefers a 1-colum...
Learnt from: amotl
PR: crate/cratedb-guide#204
File: docs/integrate/mcp/community.md:6-8
Timestamp: 2025-05-18T13:25:11.786Z
Learning: In the CrateDB Guide documentation, particularly for MCP-related pages, the author prefers a 1-column grid layout for multiple cards to stack them vertically rather than side by side, as this is an intentional design choice.
Applied to files:
docs/feature/index.md
🪛 LanguageTool
docs/connect/df.md
[style] ~122-~122: The preposition ‘amongst’ is correct, but some people think that it is old-fashioned or literary. A more frequently used alternative is the preposition “among”.
Context: ...your machine by dividing the workload amongst the available CPU cores without any a...
(AMONGST)
docs/connect/index.md
[style] ~24-~24: Consider using a more concise synonym.
Context: ...ectivity options at a glance. You have a variety of options to connect to CrateDB, and to i...
(A_VARIETY_OF)
[grammar] ~25-~25: Ensure spelling is correct
Context: ...ateDB, and to integrate it with off-the-shelve, 3rd-party, open-source, and proprietar...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[style] ~53-~53: Consider a more concise word here.
Context: ... drivers, applications, and frameworks, in order to get time series data in and out of Crat...
(IN_ORDER_TO_PREMIUM)
[style] ~86-~86: Consider a more concise word here.
Context: ...C] - [SQL] :::: ::::: ## Configure In order to connect to CrateDB, your application or...
(IN_ORDER_TO_PREMIUM)
🪛 markdownlint-cli2 (0.17.2)
docs/connect/df.md
117-117: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
135-135: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
136-136: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
140-140: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
141-141: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
145-145: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
146-146: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
150-150: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
151-151: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
155-155: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
156-156: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
177-177: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
⏰ 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 (3)
docs/install/index.rst (1)
3-5: Heading rename looks OKChanging the visible heading from “Installation” to “Install” does not affect anchors (
.. _install:) or existing cross-references. No further action needed.docs/feature/index.md (1)
76-78: Verify that the new:link: connecttarget existsThe card now points to a connect reference. Please double-check that
docs/connect/index.*defines.. _connect:(or an equivalent:label:) so the reference resolves without producing a Sphinx “unknown target” warning.docs/index.md (1)
308-308: Addition ofconnect/indexacknowledgedThe toctree entry correctly surfaces the new “Connect” section. No issues spotted.
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
docs/connect/index.md (1)
599-601: Broken placeholder link[](#build-status)is still presentIssue already raised in a previous review; the anchor
#build-statusdoes not exist, so this renders as empty text.
🧹 Nitpick comments (2)
docs/connect/df.md (2)
154-167: Duplicate section headings trigger MD024 and fragment-ID clashesThe second occurrence of “## Dask / pandas / Polars” re-defines identical headings that are already present earlier (Lines 34, 59, 95).
Besides violating MD024, this produces duplicated fragment IDs in the generated HTML and breaks in-page links.-## Dask -… -## pandas -… -## Polars -…Either remove the repetition or turn these examples into bullet points under the original “Examples” section.
41-44: Missing accessible alt-text for inline logosThe three linked images rely solely on their visuals. Screen-reader users will only hear the raw URL.
-[{w=180px}](https://www.dask.org/) +[{w=180px}](https://www.dask.org/)Provide concise
alttext for each logo to meet WCAG 2.1 1.1.1.Also applies to: 63-65, 98-102
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (16)
docs/connect/cli.md(1 hunks)docs/connect/df.md(1 hunks)docs/connect/index.md(1 hunks)docs/connect/java.rst(1 hunks)docs/connect/javascript.rst(1 hunks)docs/connect/orm.md(1 hunks)docs/connect/php.rst(1 hunks)docs/connect/python.rst(1 hunks)docs/connect/ruby.rst(1 hunks)docs/feature/connectivity/index.md(0 hunks)docs/feature/index.md(1 hunks)docs/index.md(1 hunks)docs/install/index.rst(1 hunks)docs/integrate/df.md(0 hunks)docs/integrate/index.md(0 hunks)docs/integrate/orm.md(0 hunks)
💤 Files with no reviewable changes (4)
- docs/integrate/index.md
- docs/integrate/orm.md
- docs/integrate/df.md
- docs/feature/connectivity/index.md
✅ Files skipped from review due to trivial changes (6)
- docs/install/index.rst
- docs/feature/index.md
- docs/connect/php.rst
- docs/index.md
- docs/connect/ruby.rst
- docs/connect/cli.md
🚧 Files skipped from review as they are similar to previous changes (4)
- docs/connect/java.rst
- docs/connect/orm.md
- docs/connect/javascript.rst
- docs/connect/python.rst
🧰 Additional context used
🧠 Learnings (4)
📓 Common learnings
Learnt from: amotl
PR: crate/cratedb-guide#204
File: docs/integrate/mcp/community.md:22-33
Timestamp: 2025-05-18T12:50:36.393Z
Learning: In the CrateDB Guide repository, the prefix `ctk:` in documentation links (like `ctk:query/mcp/server`) is an intersphinx reference that points to external content in the CrateDB Toolkit documentation at https://cratedb-toolkit.readthedocs.io/. These references are intentionally not pointing to local files within the repository.
Learnt from: amotl
PR: crate/cratedb-guide#204
File: docs/integrate/mcp/community.md:8-20
Timestamp: 2025-05-18T12:50:38.681Z
Learning: In the CrateDB guide repository, references with the `ctk:` prefix (like `ctk:query/mcp/landscape`) are intersphinx references that link to resources in the cratedb-toolkit repository (https://github.com/crate/cratedb-toolkit/tree/main/doc), which are rendered at https://cratedb-toolkit.readthedocs.io/. These are valid cross-references between separate Sphinx documentation sets, not local file references.
Learnt from: amotl
PR: crate/cratedb-guide#204
File: docs/integrate/mcp/community.md:6-8
Timestamp: 2025-05-18T13:25:11.786Z
Learning: In the CrateDB Guide documentation, particularly for MCP-related pages, the author prefers a 1-column grid layout for multiple cards to stack them vertically rather than side by side, as this is an intentional design choice.
📚 Learning: in the cratedb guide repository, the prefix `ctk:` in documentation links (like `ctk:query/mcp/serve...
Learnt from: amotl
PR: crate/cratedb-guide#204
File: docs/integrate/mcp/community.md:22-33
Timestamp: 2025-05-18T12:50:36.393Z
Learning: In the CrateDB Guide repository, the prefix `ctk:` in documentation links (like `ctk:query/mcp/server`) is an intersphinx reference that points to external content in the CrateDB Toolkit documentation at https://cratedb-toolkit.readthedocs.io/. These references are intentionally not pointing to local files within the repository.
Applied to files:
docs/connect/index.md
📚 Learning: in the cratedb guide repository, references with the `ctk:` prefix (like `ctk:query/mcp/landscape`) ...
Learnt from: amotl
PR: crate/cratedb-guide#204
File: docs/integrate/mcp/community.md:8-20
Timestamp: 2025-05-18T12:50:38.681Z
Learning: In the CrateDB guide repository, references with the `ctk:` prefix (like `ctk:query/mcp/landscape`) are intersphinx references that link to resources in the cratedb-toolkit repository (https://github.com/crate/cratedb-toolkit/tree/main/doc), which are rendered at https://cratedb-toolkit.readthedocs.io/. These are valid cross-references between separate Sphinx documentation sets, not local file references.
Applied to files:
docs/connect/index.md
📚 Learning: the `records.database("crate://", echo=true)` connection string for cratedb works with defaults: loc...
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/connect/index.md
🪛 LanguageTool
docs/connect/index.md
[style] ~24-~24: Consider using a more concise synonym.
Context: ...ectivity options at a glance. You have a variety of options to connect to CrateDB, and to i...
(A_VARIETY_OF)
[style] ~53-~53: Consider a more concise word here.
Context: ... drivers, applications, and frameworks, in order to get time series data in and out of Crat...
(IN_ORDER_TO_PREMIUM)
[style] ~86-~86: Consider a more concise word here.
Context: ...C] - [SQL] :::: ::::: ## Configure In order to connect to CrateDB, your application or...
(IN_ORDER_TO_PREMIUM)
🪛 markdownlint-cli2 (0.17.2)
docs/connect/df.md
154-154: Multiple headings with the same content
(MD024, no-duplicate-heading)
160-160: Multiple headings with the same content
(MD024, no-duplicate-heading)
165-165: Multiple headings with the same content
(MD024, no-duplicate-heading)
⏰ 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
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
docs/connect/orm.md (1)
12-14: Broken intra-document anchors#machine-learningand#etl.The page doesn’t define headings with these IDs, so the links render as plain text and Sphinx link-check will fail. Replace the fragments with proper references (e.g.
{ref}or{doc}) or drop them.-Python-based [DataFrame](df/index.md) -and [ML](#machine-learning) libraries, and a few [ETL](#etl) +Python-based [DataFrame](df/index) +and machine-learning libraries, and a few ETL frameworks
🧹 Nitpick comments (2)
docs/connect/orm.md (1)
12-12: Use{doc}links instead of.mdfile names.Explicit “.md” suffices for GitHub Markdown but can break when the file is renamed or converted to reStructuredText. Switching to
{doc}keeps the link resilient.-Python-based [DataFrame](df/index.md) +Python-based {doc}`df/index`docs/connect/index.md (1)
172-192: Several link definitions appear unused.
ADBC,Authentication,CrateDB Examples,python-dbapi-by-example, etc. are defined here but not referenced in the page. They clutter the source and triggermarkdownlintMD053 warnings.Consider deleting unused definitions or adding the corresponding links.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (18)
docs/connect/cli.md(1 hunks)docs/connect/configure.md(1 hunks)docs/connect/df/index.md(1 hunks)docs/connect/df/learn.md(1 hunks)docs/connect/drivers.md(1 hunks)docs/connect/index.md(1 hunks)docs/connect/java.rst(1 hunks)docs/connect/javascript.rst(1 hunks)docs/connect/orm.md(1 hunks)docs/connect/php.rst(1 hunks)docs/connect/python.rst(1 hunks)docs/connect/ruby.rst(1 hunks)docs/feature/connectivity/index.md(0 hunks)docs/feature/index.md(1 hunks)docs/index.md(1 hunks)docs/install/index.rst(1 hunks)docs/integrate/index.md(0 hunks)docs/integrate/orm.md(0 hunks)
💤 Files with no reviewable changes (3)
- docs/integrate/index.md
- docs/integrate/orm.md
- docs/feature/connectivity/index.md
✅ Files skipped from review due to trivial changes (6)
- docs/install/index.rst
- docs/connect/df/learn.md
- docs/connect/ruby.rst
- docs/connect/drivers.md
- docs/connect/cli.md
- docs/connect/df/index.md
🚧 Files skipped from review as they are similar to previous changes (6)
- docs/index.md
- docs/connect/php.rst
- docs/feature/index.md
- docs/connect/java.rst
- docs/connect/javascript.rst
- docs/connect/python.rst
🧰 Additional context used
🧠 Learnings (5)
📓 Common learnings
Learnt from: amotl
PR: crate/cratedb-guide#204
File: docs/integrate/mcp/community.md:22-33
Timestamp: 2025-05-18T12:50:36.393Z
Learning: In the CrateDB Guide repository, the prefix `ctk:` in documentation links (like `ctk:query/mcp/server`) is an intersphinx reference that points to external content in the CrateDB Toolkit documentation at https://cratedb-toolkit.readthedocs.io/. These references are intentionally not pointing to local files within the repository.
Learnt from: amotl
PR: crate/cratedb-guide#204
File: docs/integrate/mcp/community.md:8-20
Timestamp: 2025-05-18T12:50:38.681Z
Learning: In the CrateDB guide repository, references with the `ctk:` prefix (like `ctk:query/mcp/landscape`) are intersphinx references that link to resources in the cratedb-toolkit repository (https://github.com/crate/cratedb-toolkit/tree/main/doc), which are rendered at https://cratedb-toolkit.readthedocs.io/. These are valid cross-references between separate Sphinx documentation sets, not local file references.
Learnt from: amotl
PR: crate/cratedb-guide#204
File: docs/integrate/mcp/community.md:6-8
Timestamp: 2025-05-18T13:25:11.786Z
Learning: In the CrateDB Guide documentation, particularly for MCP-related pages, the author prefers a 1-column grid layout for multiple cards to stack them vertically rather than side by side, as this is an intentional design choice.
📚 Learning: in the cratedb guide repository, the prefix `ctk:` in documentation links (like `ctk:query/mcp/serve...
Learnt from: amotl
PR: crate/cratedb-guide#204
File: docs/integrate/mcp/community.md:22-33
Timestamp: 2025-05-18T12:50:36.393Z
Learning: In the CrateDB Guide repository, the prefix `ctk:` in documentation links (like `ctk:query/mcp/server`) is an intersphinx reference that points to external content in the CrateDB Toolkit documentation at https://cratedb-toolkit.readthedocs.io/. These references are intentionally not pointing to local files within the repository.
Applied to files:
docs/connect/configure.mddocs/connect/index.mddocs/connect/orm.md
📚 Learning: the `records.database("crate://", echo=true)` connection string for cratedb works with defaults: loc...
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/connect/configure.mddocs/connect/index.mddocs/connect/orm.md
📚 Learning: in the cratedb guide repository, references with the `ctk:` prefix (like `ctk:query/mcp/landscape`) ...
Learnt from: amotl
PR: crate/cratedb-guide#204
File: docs/integrate/mcp/community.md:8-20
Timestamp: 2025-05-18T12:50:38.681Z
Learning: In the CrateDB guide repository, references with the `ctk:` prefix (like `ctk:query/mcp/landscape`) are intersphinx references that link to resources in the cratedb-toolkit repository (https://github.com/crate/cratedb-toolkit/tree/main/doc), which are rendered at https://cratedb-toolkit.readthedocs.io/. These are valid cross-references between separate Sphinx documentation sets, not local file references.
Applied to files:
docs/connect/index.mddocs/connect/orm.md
📚 Learning: in the cratedb guide documentation, particularly for mcp-related pages, the author prefers a 1-colum...
Learnt from: amotl
PR: crate/cratedb-guide#204
File: docs/integrate/mcp/community.md:6-8
Timestamp: 2025-05-18T13:25:11.786Z
Learning: In the CrateDB Guide documentation, particularly for MCP-related pages, the author prefers a 1-column grid layout for multiple cards to stack them vertically rather than side by side, as this is an intentional design choice.
Applied to files:
docs/connect/index.md
🪛 LanguageTool
docs/connect/configure.md
[style] ~4-~4: Consider a more concise word here.
Context: (connect-configure)= # Configure In order to connect to CrateDB, your application or...
(IN_ORDER_TO_PREMIUM)
docs/connect/index.md
[style] ~24-~24: Consider using a more concise synonym.
Context: ...ectivity options at a glance. You have a variety of options to connect to CrateDB, and to i...
(A_VARIETY_OF)
[style] ~92-~92: Consider a more concise word here.
Context: ...ext-smaller Configure database URI +++ In order to connect to CrateDB, your application or...
(IN_ORDER_TO_PREMIUM)
🪛 markdownlint-cli2 (0.17.2)
docs/connect/index.md
172-172: Link and image reference definitions should be needed
Unused link or image reference definition: "adbc"
(MD053, link-image-reference-definitions)
173-173: Link and image reference definitions should be needed
Unused link or image reference definition: "authentication"
(MD053, link-image-reference-definitions)
176-176: Link and image reference definitions should be needed
Unused link or image reference definition: "cratedb examples"
(MD053, link-image-reference-definitions)
177-177: Link and image reference definitions should be needed
Unused link or image reference definition: "cratedb http interface"
(MD053, link-image-reference-definitions)
178-178: Link and image reference definitions should be needed
Unused link or image reference definition: "cratedb postgresql interface"
(MD053, link-image-reference-definitions)
185-185: Link and image reference definitions should be needed
Unused link or image reference definition: "python-dbapi-by-example"
(MD053, link-image-reference-definitions)
186-186: Link and image reference definitions should be needed
Unused link or image reference definition: "python-sqlalchemy-by-example"
(MD053, link-image-reference-definitions)
187-187: Link and image reference definitions should be needed
Unused link or image reference definition: "schema"
(MD053, link-image-reference-definitions)
188-188: Link and image reference definitions should be needed
Unused link or image reference definition: "schemas"
(MD053, link-image-reference-definitions)
191-191: Link and image reference definitions should be needed
Unused link or image reference definition: "superuser"
(MD053, link-image-reference-definitions)
docs/connect/orm.md
13-13: Link fragments should be valid
(MD051, link-fragments)
13-13: Link fragments should be valid
(MD051, link-fragments)
⏰ 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
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (1)
docs/connect/orm.md (1)
12-15: Broken intra-document anchors remain (#machine-learning,#etl).The two fragment links still point to non-existent headings, so Sphinx will render them as plain text and link checking will fail. Replace them with real
{ref}targets or remove the links.
🧹 Nitpick comments (4)
docs/connect/index.md (2)
6-8: Hyphen shorthand is unclear in English.The construct “compatibility-adapters and -dialects” (Line 7) reads awkwardly; drop the leading dash:
-and CrateDB Cloud, using database drivers, and compatibility-adapters and -dialects. +and CrateDB Cloud, using database drivers, compatibility adapters and dialects.
172-191: Several link definitions are unused – remove or reference them.
[ADBC],[Authentication],[CrateDB Examples],[schema],[schemas],[superuser], etc. are defined but never referenced in this file. They trigger MD053 warnings and add noise to the build. Either:
- Delete the unused definitions, or
- Add at least one reference to each of them.
Cleaning this up will silence markdown-lint and avoid confusion.
docs/connect/configure.md (1)
53-76: Specify a language for fenced code blocks to silence MD040 and improve highlighting.All showcased URIs are in plain text, yet the linter flags them. Add
text(orbashfor CLI snippets) after the opening back-ticks:-``` +```text postgresql://<user>:<password>@<cluster>.cratedb.net:5432/docApply the same to every code block in this file.
Also applies to: 113-136
docs/connect/df/index.md (1)
68-70: Hyphenate compound adjective “open-source”.-... easy to use open source data analysis and manipulation tool ... +... easy-to-use open-source data analysis and manipulation tool ...
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (18)
docs/connect/cli.md(1 hunks)docs/connect/configure.md(1 hunks)docs/connect/df/index.md(1 hunks)docs/connect/df/learn.md(1 hunks)docs/connect/drivers.md(1 hunks)docs/connect/index.md(1 hunks)docs/connect/java.rst(1 hunks)docs/connect/javascript.rst(1 hunks)docs/connect/orm.md(1 hunks)docs/connect/php.rst(1 hunks)docs/connect/python.rst(1 hunks)docs/connect/ruby.rst(1 hunks)docs/feature/connectivity/index.md(0 hunks)docs/feature/index.md(1 hunks)docs/index.md(1 hunks)docs/install/index.rst(1 hunks)docs/integrate/index.md(0 hunks)docs/integrate/orm.md(0 hunks)
💤 Files with no reviewable changes (3)
- docs/integrate/orm.md
- docs/integrate/index.md
- docs/feature/connectivity/index.md
✅ Files skipped from review due to trivial changes (5)
- docs/install/index.rst
- docs/connect/ruby.rst
- docs/connect/javascript.rst
- docs/connect/cli.md
- docs/connect/drivers.md
🚧 Files skipped from review as they are similar to previous changes (6)
- docs/feature/index.md
- docs/index.md
- docs/connect/df/learn.md
- docs/connect/php.rst
- docs/connect/java.rst
- docs/connect/python.rst
🧰 Additional context used
🧠 Learnings (6)
📓 Common learnings
Learnt from: amotl
PR: crate/cratedb-guide#204
File: docs/integrate/mcp/community.md:22-33
Timestamp: 2025-05-18T12:50:36.393Z
Learning: In the CrateDB Guide repository, the prefix `ctk:` in documentation links (like `ctk:query/mcp/server`) is an intersphinx reference that points to external content in the CrateDB Toolkit documentation at https://cratedb-toolkit.readthedocs.io/. These references are intentionally not pointing to local files within the repository.
Learnt from: hammerhead
PR: crate/cratedb-guide#221
File: docs/connect/configure.md:58-66
Timestamp: 2025-08-05T07:14:57.389Z
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.
Learnt from: amotl
PR: crate/cratedb-guide#204
File: docs/integrate/mcp/community.md:8-20
Timestamp: 2025-05-18T12:50:38.681Z
Learning: In the CrateDB guide repository, references with the `ctk:` prefix (like `ctk:query/mcp/landscape`) are intersphinx references that link to resources in the cratedb-toolkit repository (https://github.com/crate/cratedb-toolkit/tree/main/doc), which are rendered at https://cratedb-toolkit.readthedocs.io/. These are valid cross-references between separate Sphinx documentation sets, not local file references.
Learnt from: amotl
PR: crate/cratedb-guide#204
File: docs/integrate/mcp/community.md:6-8
Timestamp: 2025-05-18T13:25:11.786Z
Learning: In the CrateDB Guide documentation, particularly for MCP-related pages, the author prefers a 1-column grid layout for multiple cards to stack them vertically rather than side by side, as this is an intentional design choice.
📚 Learning: in cratedb connection strings, the user:password@ syntax is valid for http basic authentication on p...
Learnt from: hammerhead
PR: crate/cratedb-guide#221
File: docs/connect/configure.md:58-66
Timestamp: 2025-08-05T07:14:57.389Z
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/connect/configure.mddocs/connect/index.md
📚 Learning: in the cratedb guide repository, the prefix `ctk:` in documentation links (like `ctk:query/mcp/serve...
Learnt from: amotl
PR: crate/cratedb-guide#204
File: docs/integrate/mcp/community.md:22-33
Timestamp: 2025-05-18T12:50:36.393Z
Learning: In the CrateDB Guide repository, the prefix `ctk:` in documentation links (like `ctk:query/mcp/server`) is an intersphinx reference that points to external content in the CrateDB Toolkit documentation at https://cratedb-toolkit.readthedocs.io/. These references are intentionally not pointing to local files within the repository.
Applied to files:
docs/connect/configure.mddocs/connect/index.mddocs/connect/orm.md
📚 Learning: the `records.database("crate://", echo=true)` connection string for cratedb works with defaults: loc...
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/connect/configure.mddocs/connect/index.mddocs/connect/orm.md
📚 Learning: in the cratedb guide repository, references with the `ctk:` prefix (like `ctk:query/mcp/landscape`) ...
Learnt from: amotl
PR: crate/cratedb-guide#204
File: docs/integrate/mcp/community.md:8-20
Timestamp: 2025-05-18T12:50:38.681Z
Learning: In the CrateDB guide repository, references with the `ctk:` prefix (like `ctk:query/mcp/landscape`) are intersphinx references that link to resources in the cratedb-toolkit repository (https://github.com/crate/cratedb-toolkit/tree/main/doc), which are rendered at https://cratedb-toolkit.readthedocs.io/. These are valid cross-references between separate Sphinx documentation sets, not local file references.
Applied to files:
docs/connect/configure.mddocs/connect/df/index.mddocs/connect/index.mddocs/connect/orm.md
📚 Learning: in the cratedb guide documentation, particularly for mcp-related pages, the author prefers a 1-colum...
Learnt from: amotl
PR: crate/cratedb-guide#204
File: docs/integrate/mcp/community.md:6-8
Timestamp: 2025-05-18T13:25:11.786Z
Learning: In the CrateDB Guide documentation, particularly for MCP-related pages, the author prefers a 1-column grid layout for multiple cards to stack them vertically rather than side by side, as this is an intentional design choice.
Applied to files:
docs/connect/index.md
🪛 LanguageTool
docs/connect/configure.md
[style] ~4-~4: Consider a more concise word here.
Context: (connect-configure)= # Configure In order to connect to CrateDB, your application or...
(IN_ORDER_TO_PREMIUM)
docs/connect/df/index.md
[uncategorized] ~68-~68: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...st, powerful, flexible, and easy to use open source data analysis and manipulation tool, bu...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
docs/connect/index.md
[style] ~24-~24: Consider using a more concise synonym.
Context: ...ectivity options at a glance. You have a variety of options to connect to CrateDB, and to i...
(A_VARIETY_OF)
[style] ~92-~92: Consider a more concise word here.
Context: ...ext-smaller Configure database URI +++ In order to connect to CrateDB, your application or...
(IN_ORDER_TO_PREMIUM)
🪛 markdownlint-cli2 (0.17.2)
docs/connect/configure.md
35-35: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
53-53: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
54-54: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
58-58: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
59-59: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
63-63: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
64-64: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
68-68: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
69-69: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
73-73: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
74-74: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
95-95: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
113-113: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
114-114: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
118-118: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
119-119: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
123-123: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
124-124: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
128-128: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
129-129: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
133-133: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
134-134: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
docs/connect/index.md
172-172: Link and image reference definitions should be needed
Unused link or image reference definition: "adbc"
(MD053, link-image-reference-definitions)
173-173: Link and image reference definitions should be needed
Unused link or image reference definition: "authentication"
(MD053, link-image-reference-definitions)
176-176: Link and image reference definitions should be needed
Unused link or image reference definition: "cratedb examples"
(MD053, link-image-reference-definitions)
177-177: Link and image reference definitions should be needed
Unused link or image reference definition: "cratedb http interface"
(MD053, link-image-reference-definitions)
178-178: Link and image reference definitions should be needed
Unused link or image reference definition: "cratedb postgresql interface"
(MD053, link-image-reference-definitions)
185-185: Link and image reference definitions should be needed
Unused link or image reference definition: "python-dbapi-by-example"
(MD053, link-image-reference-definitions)
186-186: Link and image reference definitions should be needed
Unused link or image reference definition: "python-sqlalchemy-by-example"
(MD053, link-image-reference-definitions)
187-187: Link and image reference definitions should be needed
Unused link or image reference definition: "schema"
(MD053, link-image-reference-definitions)
188-188: Link and image reference definitions should be needed
Unused link or image reference definition: "schemas"
(MD053, link-image-reference-definitions)
191-191: Link and image reference definitions should be needed
Unused link or image reference definition: "superuser"
(MD053, link-image-reference-definitions)
docs/connect/orm.md
13-13: Link fragments should be valid
(MD051, link-fragments)
13-13: Link fragments should be valid
(MD051, link-fragments)
amotl
changed the title
crate-clients-tools, to be phased out sooncrate-clients-tools, to be retired soon
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (1)
docs/connect/orm.md (1)
12-15: Broken intra-document link fragments (#machine-learning,#etl).These fragment links do not point to any heading in this document, so Sphinx will render them as plain text and link-checking will fail.
-Python-based [DataFrame](df/index.md) -and [ML](#machine-learning) libraries, and a few [ETL](#etl) +Python-based [DataFrame](df/index.md) +and {ref}`machine-learning libraries <insert-proper-target>`, and a few +{ref}`ETL frameworks <insert-proper-target>`Replace the fragments with proper
{ref}cross-references (or remove them) once the correct targets are known.
🧹 Nitpick comments (2)
docs/connect/configure.md (1)
9-20: Inline<style>block should live in theme / global CSS, not per-page markup.Embedding raw CSS in every page complicates maintenance and violates DRY. Move the rules to a shared stylesheet (e.g.
_static/css/driver-slim.css) and add it viahtml_static_path/extra_cssinconf.py.This keeps documentation content clean and styling centralized.
docs/connect/index.md (1)
171-190: Unused link reference definitions trigger MD053 warnings.
markdownlint-cli2reports that the definitions for[ADBC],[Authentication],[CrateDB Examples],[CrateDB HTTP interface],[CrateDB PostgreSQL interface],[python-dbapi-by-example],[python-sqlalchemy-by-example],[schema],[schemas], and[superuser]are not used in this page.Delete the unused references or add corresponding links to silence the linter and avoid reader confusion.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (18)
docs/connect/cli.md(1 hunks)docs/connect/configure.md(1 hunks)docs/connect/df/index.md(1 hunks)docs/connect/df/learn.md(1 hunks)docs/connect/drivers.md(1 hunks)docs/connect/index.md(1 hunks)docs/connect/java.rst(1 hunks)docs/connect/javascript.rst(1 hunks)docs/connect/orm.md(1 hunks)docs/connect/php.rst(1 hunks)docs/connect/python.rst(1 hunks)docs/connect/ruby.rst(1 hunks)docs/feature/connectivity/index.md(0 hunks)docs/feature/index.md(1 hunks)docs/index.md(1 hunks)docs/install/index.rst(1 hunks)docs/integrate/index.md(0 hunks)docs/integrate/orm.md(0 hunks)
💤 Files with no reviewable changes (3)
- docs/integrate/index.md
- docs/integrate/orm.md
- docs/feature/connectivity/index.md
✅ Files skipped from review due to trivial changes (3)
- docs/install/index.rst
- docs/connect/ruby.rst
- docs/connect/cli.md
🚧 Files skipped from review as they are similar to previous changes (9)
- docs/feature/index.md
- docs/index.md
- docs/connect/php.rst
- docs/connect/java.rst
- docs/connect/df/learn.md
- docs/connect/javascript.rst
- docs/connect/drivers.md
- docs/connect/python.rst
- docs/connect/df/index.md
🧰 Additional context used
🧠 Learnings (6)
📓 Common learnings
Learnt from: amotl
PR: crate/cratedb-guide#204
File: docs/integrate/mcp/community.md:22-33
Timestamp: 2025-05-18T12:50:36.393Z
Learning: In the CrateDB Guide repository, the prefix `ctk:` in documentation links (like `ctk:query/mcp/server`) is an intersphinx reference that points to external content in the CrateDB Toolkit documentation at https://cratedb-toolkit.readthedocs.io/. These references are intentionally not pointing to local files within the repository.
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.
Learnt from: amotl
PR: crate/cratedb-guide#204
File: docs/integrate/mcp/community.md:8-20
Timestamp: 2025-05-18T12:50:38.681Z
Learning: In the CrateDB guide repository, references with the `ctk:` prefix (like `ctk:query/mcp/landscape`) are intersphinx references that link to resources in the cratedb-toolkit repository (https://github.com/crate/cratedb-toolkit/tree/main/doc), which are rendered at https://cratedb-toolkit.readthedocs.io/. These are valid cross-references between separate Sphinx documentation sets, not local file references.
Learnt from: amotl
PR: crate/cratedb-guide#204
File: docs/integrate/mcp/community.md:6-8
Timestamp: 2025-05-18T13:25:11.786Z
Learning: In the CrateDB Guide documentation, particularly for MCP-related pages, the author prefers a 1-column grid layout for multiple cards to stack them vertically rather than side by side, as this is an intentional design choice.
📚 Learning: in cratedb connection strings, the user:password@ syntax is valid for http basic authentication on p...
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/connect/configure.mddocs/connect/index.md
📚 Learning: in the cratedb guide repository, the prefix `ctk:` in documentation links (like `ctk:query/mcp/serve...
Learnt from: amotl
PR: crate/cratedb-guide#204
File: docs/integrate/mcp/community.md:22-33
Timestamp: 2025-05-18T12:50:36.393Z
Learning: In the CrateDB Guide repository, the prefix `ctk:` in documentation links (like `ctk:query/mcp/server`) is an intersphinx reference that points to external content in the CrateDB Toolkit documentation at https://cratedb-toolkit.readthedocs.io/. These references are intentionally not pointing to local files within the repository.
Applied to files:
docs/connect/configure.mddocs/connect/index.mddocs/connect/orm.md
📚 Learning: the `records.database("crate://", echo=true)` connection string for cratedb works with defaults: loc...
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/connect/configure.mddocs/connect/index.mddocs/connect/orm.md
📚 Learning: in the cratedb guide repository, references with the `ctk:` prefix (like `ctk:query/mcp/landscape`) ...
Learnt from: amotl
PR: crate/cratedb-guide#204
File: docs/integrate/mcp/community.md:8-20
Timestamp: 2025-05-18T12:50:38.681Z
Learning: In the CrateDB guide repository, references with the `ctk:` prefix (like `ctk:query/mcp/landscape`) are intersphinx references that link to resources in the cratedb-toolkit repository (https://github.com/crate/cratedb-toolkit/tree/main/doc), which are rendered at https://cratedb-toolkit.readthedocs.io/. These are valid cross-references between separate Sphinx documentation sets, not local file references.
Applied to files:
docs/connect/configure.mddocs/connect/index.mddocs/connect/orm.md
📚 Learning: in the cratedb guide documentation, particularly for mcp-related pages, the author prefers a 1-colum...
Learnt from: amotl
PR: crate/cratedb-guide#204
File: docs/integrate/mcp/community.md:6-8
Timestamp: 2025-05-18T13:25:11.786Z
Learning: In the CrateDB Guide documentation, particularly for MCP-related pages, the author prefers a 1-column grid layout for multiple cards to stack them vertically rather than side by side, as this is an intentional design choice.
Applied to files:
docs/connect/index.md
🪛 LanguageTool
docs/connect/configure.md
[style] ~4-~4: Consider a more concise word here.
Context: (connect-configure)= # Configure In order to connect to CrateDB, your application or...
(IN_ORDER_TO_PREMIUM)
docs/connect/index.md
[style] ~23-~23: Consider using a more concise synonym.
Context: ...ectivity options at a glance. You have a variety of options to connect to CrateDB, and to i...
(A_VARIETY_OF)
[style] ~91-~91: Consider a more concise word here.
Context: ...ext-smaller Configure database URI +++ In order to connect to CrateDB, your application or...
(IN_ORDER_TO_PREMIUM)
🪛 markdownlint-cli2 (0.17.2)
docs/connect/index.md
171-171: Link and image reference definitions should be needed
Unused link or image reference definition: "adbc"
(MD053, link-image-reference-definitions)
172-172: Link and image reference definitions should be needed
Unused link or image reference definition: "authentication"
(MD053, link-image-reference-definitions)
175-175: Link and image reference definitions should be needed
Unused link or image reference definition: "cratedb examples"
(MD053, link-image-reference-definitions)
176-176: Link and image reference definitions should be needed
Unused link or image reference definition: "cratedb http interface"
(MD053, link-image-reference-definitions)
177-177: Link and image reference definitions should be needed
Unused link or image reference definition: "cratedb postgresql interface"
(MD053, link-image-reference-definitions)
184-184: Link and image reference definitions should be needed
Unused link or image reference definition: "python-dbapi-by-example"
(MD053, link-image-reference-definitions)
185-185: Link and image reference definitions should be needed
Unused link or image reference definition: "python-sqlalchemy-by-example"
(MD053, link-image-reference-definitions)
186-186: Link and image reference definitions should be needed
Unused link or image reference definition: "schema"
(MD053, link-image-reference-definitions)
187-187: Link and image reference definitions should be needed
Unused link or image reference definition: "schemas"
(MD053, link-image-reference-definitions)
190-190: Link and image reference definitions should be needed
Unused link or image reference definition: "superuser"
(MD053, link-image-reference-definitions)
docs/connect/orm.md
13-13: Link fragments should be valid
(MD051, link-fragments)
13-13: Link fragments should be valid
(MD051, link-fragments)
⏰ 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
About
This patch adopts the whole connect section from
crate-clients-tools, so we can phase out the repository soon. This is exclusively a 1:1 refactoring operation in the spirit of getting closer to monorepo-state for the documentation-only documentation parts.Preview
https://cratedb-guide--221.org.readthedocs.build/connect/
Review
The content has been reviewed once upon a time already. Still, it doesn't hurt to receive additional eyeballs once again. We will collect relevant feedback for a future iteration. Thanks!
Outlook
If the focus is on easyness, future iterations can implement that easily by reorganizing content within the new subsection. Contributions are very much welcome. 🍀
References
A future update in this area will provide concise driver information at your fingertips.
/cc @karynzv, @hammerhead, @surister, @kneth, @bmunkholm, @joncombe