Elixir

This page documents the preview version (v2.23). Preview includes features under active development and is for development and testing only. For production, use the stable version (v2024.1). To learn more, see Versioning.

Supported projects

The following projects can be used to implement Elixir applications using the YugabyteDB YSQL APIs.

Project Documentation and Guides Latest Driver Version Supported YugabyteDB Version
Postgrex Driver Documentation v0.18.0
Phoenix Framework Documentation 1.7.14

Learn how to establish a connection to a YugabyteDB database and begin basic CRUD operations by referring to a sample Elixir app using Postgrex or building an app using Phoenix framework.

Prerequisites

To develop Elixir applications for YugabyteDB, you need the following:

  • Elixir

    Install the latest versions of Elixir, Erlang VM, IEx and Mix (tested with Elixir 1.17.1 and Erlang/OTP 26 erts-14.2.5).

  • YugabyteDB cluster

    • Create a free cluster on YugabyteDB Aeon. Refer to Use a cloud cluster. Note that YugabyteDB Aeon requires SSL.
    • Alternatively, set up a standalone YugabyteDB cluster by following the steps in Install YugabyteDB.

Next step