Driver: Add page about Erlang

[amotl]

About

What the title says.

Preview

https://cratedb-guide--420.org.readthedocs.build/connect/erlang/

[coderabbitai]

Walkthrough

Adds an Erlang driver entry to the Connect index and a new docs/connect/erlang/ section with pages for odbc and epgsql, including example code and CrateDB Cloud SSL guidance.

Changes

Cohort / File(s)	Summary
Connect index docs/connect/index.md	Added an Erlang grid-item-card (link connect-erlang, {fab\erlang`}icon, classes) and insertederlang/index` into the languages toctree.
Erlang docs (new) docs/connect/erlang/index.md, docs/connect/erlang/epgsql.md, docs/connect/erlang/odbc.md	Added Erlang section index and two pages: epgsql.md (rebar dependency, epgsql_example.erl, connection/query/cleanup, Cloud SSL ssl_opts) and odbc.md (ODBC prerequisites, odbc_example.erl, run instructions, Cloud SSL sslmode=require).

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

• Pay attention to toctree/link correctness in docs/connect/index.md.
• Verify code example correctness and formatting in epgsql.md and odbc.md.
• Verify SSL guidance for CrateDB Cloud and any placeholder credentials.

Possibly related PRs

• Connect: Reorganize and clean up section #361 — Adds Erlang driver card and toctree entries touching the same files and features.
• Chore: Improve UI responsiveness, specifically for smaller screen sizes #426 — Modifies the drivers grid/layout in docs/connect/index.md, related to card additions.
• Connect: Migrate pages from crate-clients-tools, to be retired soon #221 — Earlier changes to the connect section and driver listings; overlaps with these edits.

Suggested labels

cross linking

Suggested reviewers

• seut
• matriv

Poem

🐇 I hopped through files at morning light,
Planted an Erlang card so bright.
ODBC and epgsql snug in a row,
Queries ready, connections go.
Hops and docs — onward we write!

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	You can run @coderabbitai generate docstrings to improve docstring coverage.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title Check	✅ Passed	The PR title "Driver: Add page about Erlang" directly and clearly describes the main change in the changeset. The pull request adds a new Erlang driver documentation page with supporting files for integration guides using epgsql and ODBC. The title is specific, concise, and accurately summarizes the primary objective without being misleading or off-topic.
Description Check	✅ Passed	The PR description is minimal but related to the changeset. It references the title and provides a preview link to the newly added Erlang documentation page, which directly corresponds to the changes. While the description lacks extensive detail, it is not unrelated or off-topic—it points to the actual Erlang documentation that was added and includes a working preview URL, making it sufficiently related to the changeset.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch erlang

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6dbdbfc and b8d2f40.

📒 Files selected for processing (4)

• docs/connect/erlang/epgsql.md (1 hunks)
• docs/connect/erlang/index.md (1 hunks)
• docs/connect/erlang/odbc.md (1 hunks)
• docs/connect/index.md (2 hunks)

🚧 Files skipped from review as they are similar to previous changes (2)

• docs/connect/erlang/odbc.md
• docs/connect/erlang/epgsql.md

🧰 Additional context used

🧠 Learnings (9)

📓 Common learnings

Learnt from: amotl
PR: crate/cratedb-guide#408
File: docs/connect/elixir.md:18-22
Timestamp: 2025-10-16T10:58:18.401Z
Learning: When connecting to CrateDB using PostgreSQL-compatible drivers like Postgrex (Elixir), the `database` parameter handling may differ from standard PostgreSQL usage because CrateDB has no notion of databases like PostgreSQL does. CrateDB uses schemas to separate concerns instead. The `database` parameter might need to be omitted or handled differently to avoid connection issues.

Learnt from: amotl
PR: crate/cratedb-guide#420
File: docs/connect/erlang.md:100-113
Timestamp: 2025-10-19T19:21:49.864Z
Learning: In the cratedb-guide repository, when documenting cloud or alternative connection methods, show only the differences from the canonical example (e.g., SSL configuration) rather than repeating the entire workflow (query execution, cleanup, etc.). This pattern is used consistently across pages to avoid repetition.

Learnt from: amotl
PR: crate/cratedb-guide#406
File: docs/connect/go.md:110-137
Timestamp: 2025-10-20T21:49:18.785Z
Learning: In the cratedb-guide repository, documentation examples for connecting to CrateDB (e.g., Go examples in docs/connect/go.md) should be kept minimal and focused on demonstrating basic functionality, rather than including comprehensive error handling. Full examples with proper error handling are maintained separately in the cratedb-examples repository.

Learnt from: amotl
PR: crate/cratedb-guide#0
File: :0-0
Timestamp: 2025-10-06T16:40:16.322Z
Learning: In the crate/cratedb-guide repository, documentation is organized by content type: files in `docs/feature/`, `docs/integrate/`, and `docs/ingest/` are reference material designed for quick access, while `docs/start/` contains learning path content. Reference material sections use top-right reference layouts for efficient navigation.

📚 Learning: 2025-10-19T19:21:49.864Z

Learnt from: amotl
PR: crate/cratedb-guide#420
File: docs/connect/erlang.md:100-113
Timestamp: 2025-10-19T19:21:49.864Z
Learning: In the cratedb-guide repository, when documenting cloud or alternative connection methods, show only the differences from the canonical example (e.g., SSL configuration) rather than repeating the entire workflow (query execution, cleanup, etc.). This pattern is used consistently across pages to avoid repetition.

Applied to files:

• docs/connect/erlang/index.md

📚 Learning: 2025-10-20T21:49:18.785Z

Learnt from: amotl
PR: crate/cratedb-guide#406
File: docs/connect/go.md:110-137
Timestamp: 2025-10-20T21:49:18.785Z
Learning: In the cratedb-guide repository, documentation examples for connecting to CrateDB (e.g., Go examples in docs/connect/go.md) should be kept minimal and focused on demonstrating basic functionality, rather than including comprehensive error handling. Full examples with proper error handling are maintained separately in the cratedb-examples repository.

Applied to files:

• docs/connect/erlang/index.md

📚 Learning: 2025-08-22T18:11:12.776Z

Learnt from: amotl
PR: crate/cratedb-guide#263
File: docs/integrate/kafka/docker-python.md:112-120
Timestamp: 2025-08-22T18:11:12.776Z
Learning: In documentation and tutorial repositories like cratedb-guide, code examples should prioritize simplicity, clarity, and educational value over production-ready features. Comprehensive error handling, extensive validation, and other production concerns can distract from the main learning objectives and make examples harder to follow. Review suggestions should focus on correctness and clarity rather than production hardening.

Applied to files:

• docs/connect/erlang/index.md

📚 Learning: 2025-08-14T12:42:12.744Z

Learnt from: amotl
PR: crate/cratedb-guide#248
File: docs/integrate/amqp/tutorial.md:36-41
Timestamp: 2025-08-14T12:42:12.744Z
Learning: In the cratedb-guide repository, code examples and tutorials prioritize simplicity and ease of following over security hardening. Security recommendations should be more lenient in tutorial/demo contexts to avoid distracting from the main learning objectives.

Applied to files:

• docs/connect/erlang/index.md

📚 Learning: 2025-09-25T19:31:54.320Z

Learnt from: bmunkholm
PR: crate/cratedb-guide#340
File: docs/home/index.md:84-97
Timestamp: 2025-09-25T19:31:54.320Z
Learning: In the CrateDB Guide docs (MyST), the CrateDB Cloud card on the homepage should link to `getting-started` using `:link-type: ref` instead of the previous `cloud:index` intersphinx target. This change was implemented in PR #340 to direct users to the getting started section rather than directly to the Cloud documentation.

Applied to files:

• docs/connect/erlang/index.md

📚 Learning: 2025-10-10T17:58:26.545Z

Learnt from: amotl
PR: crate/cratedb-guide#395
File: docs/install/cloud/azure/terraform.md:108-127
Timestamp: 2025-10-10T17:58:26.545Z
Learning: In the crate/cratedb-guide repository, during documentation format conversions (e.g., from reStructuredText to MyST/Markdown), markdownlint warnings such as MD053 (unused reference-style links) should be ignored and not flagged as issues.

Applied to files:

• docs/connect/erlang/index.md

📚 Learning: 2025-10-16T10:58:18.401Z

Learnt from: amotl
PR: crate/cratedb-guide#408
File: docs/connect/elixir.md:18-22
Timestamp: 2025-10-16T10:58:18.401Z
Learning: When connecting to CrateDB using PostgreSQL-compatible drivers like Postgrex (Elixir), the `database` parameter handling may differ from standard PostgreSQL usage because CrateDB has no notion of databases like PostgreSQL does. CrateDB uses schemas to separate concerns instead. The `database` parameter might need to be omitted or handled differently to avoid connection issues.

Applied to files:

• docs/connect/erlang/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/connect/erlang/index.md

⏰ 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/connect/index.md (2)

66-74: ✅ Erlang card is properly integrated into the drivers grid.

The new grid-item-card for Erlang (lines 66–74) follows the established pattern:

• Reference label matches the link target (connect-erlang)
• Icon and styling are consistent with other language cards
• Card placement maintains visual hierarchy

---

218-218: ✅ Toctree entry correctly added.

The erlang/index entry is properly positioned in the hidden toctree (line 218) and will make the Erlang documentation discoverable.

docs/connect/erlang/index.md (1)

9-12: Incorrect review comment: child documentation files do exist.

The flagged "blocking issue" is not valid. Script verification confirms both docs/connect/erlang/odbc.md and docs/connect/erlang/epgsql.md are present in the repository. The toctree references at lines 9–12 will resolve correctly and will not cause build failures.

Likely an incorrect or invalid review comment.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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