Driver: Add page about Erlang

[amotl]

About

What the title says.

Preview

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

[coderabbitai]

Walkthrough

Adds a new Erlang connectivity guide (ODBC and epgsql) with examples, Docker/Podman run and build/run instructions, and CrateDB Cloud SSL notes; also registers an Erlang driver card and adds erlang to the drivers toctree in the drivers index.

Changes

Cohort / File(s)	Summary
New Erlang connection documentation docs/connect/erlang.md	New page describing Erlang connectivity to CrateDB: ODBC guidance with prerequisites and odbc_example.erl, epgsql integration with rebar dependency (epgsql 4.8.0) and epgsql_example.erl, Docker/Podman run commands, compile/run steps, CrateDB Cloud SSL options, and reference links.
Driver index update docs/connect/index.md	Added an Erlang grid-item-card to "Drivers by language" (link connect-erlang, {fab} erlang icon, layout metadata) and inserted erlang into the drivers toctree list.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  participant ErlangApp as Erlang App
  participant Docs as Docs/examples
  participant CrateDB as CrateDB
  rect rgba(135,206,250,0.12)
    Note over ErlangApp,CrateDB: ODBC flow (odbc_example.erl)
    ErlangApp->>CrateDB: open ODBC connection
    ErlangApp->>CrateDB: execute SQL query
    CrateDB-->>ErlangApp: return rows
    ErlangApp->>ErlangApp: close connection
  end
  rect rgba(144,238,144,0.12)
    Note over ErlangApp,CrateDB: epgsql flow (epgsql_example.erl)
    ErlangApp->>CrateDB: epgsql:connect(host,port,creds,ssl_opts?)
    ErlangApp->>CrateDB: epgsql:squery(SQL)
    CrateDB-->>ErlangApp: result
    ErlangApp->>ErlangApp: epgsql:close
  end
  Note right of Docs: Docs supply config snippets, Docker/Podman commands, and Cloud SSL guidance

Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

• Connect: Reorganize and clean up section #361 — Edits to docs/connect/index.md; directly related to adding/updating language driver cards.
• Connect: Improve guidance re. learning path and reference styles #383 — Changes to the drivers grid/toctree structure that may interact with adding the Erlang card.
• Connect: Improve index page #231 — Earlier modifications to docs/connect/index.md drivers/cards layout; overlaps with this insertion.

Suggested labels

guidance, cross linking

Suggested reviewers

• kneth
• surister

Poem

🐰 I hopped a page to show the way,

ODBC and epgsql ready to play,
Containers hum, examples compile,
SSL tucked in for cloudy style,
Hooray — Erlang joins the data mile! 🥕

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title Check	✅ Passed	The title "Driver: Add page about Erlang" is fully related to the main change in the changeset. According to the raw summary, the PR adds a new documentation page at docs/connect/erlang.md with guidance on connecting to CrateDB from Erlang, and updates docs/connect/index.md to include the new Erlang card in the driver list. The title accurately and concisely summarizes this primary change, making it clear to reviewers that a new Erlang connection documentation page is being introduced.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.
Description Check	✅ Passed	The pull request description states "What the title says" and provides a preview link to the rendered Erlang documentation page. The PR title explicitly states "Driver: Add page about Erlang (PR #420)," and the changeset includes a new documentation file (docs/connect/erlang.md) and an update to the driver index to add Erlang support. The description is clearly related to the changeset, as it references the title and provides evidence of the addition through the preview link. While the description is minimal and vague, the evaluation criteria explicitly state that "level of detail is not important" for passing this check.

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

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

---

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.}