Packages

electric_client

0.1.0-dev-15
0.10.3 0.10.2 0.10.1 0.10.1-beta-1 0.10.0 0.9.5-beta-1 0.9.4 0.9.4-beta-1 0.9.3 0.9.2 0.9.1 0.9.0 0.8.3 0.8.3-beta-1 0.8.2 0.8.1 0.8.0 0.8.0-beta-1 0.7.3 0.7.2 0.7.1 0.7.0 0.6.5 0.6.5-beta-5 0.6.5-beta-4 0.6.5-beta-3 0.6.5-beta-2 0.6.5-beta-1 0.6.4 0.6.3 0.6.2 0.6.1 0.6.0 0.5.0 0.5.0-beta-1 0.4.1 0.4.0 0.3.2 0.3.1 0.3.0 0.3.0-beta.4 0.3.0-beta.3 0.3.0-beta.2 0.2.6-pre-1 retired 0.2.6-beta.1 0.2.6-beta.0 0.2.5 0.2.4 0.2.4-pre-8 0.2.4-pre-7 0.2.4-pre-6 0.2.4-pre-5 0.2.4-pre-4 0.2.4-pre-3 0.2.4-pre-2 0.2.4-pre-1 0.2.3 0.2.3-rc-1 0.2.2 0.2.2-rc-1 0.2.1 0.2.1-rc-3 0.2.1-rc-2 0.2.1-rc-1 0.2.0 0.1.2 0.1.1 0.1.0 0.1.0-dev-9 0.1.0-dev-8 0.1.0-dev-7 0.1.0-dev-6 0.1.0-dev-5 0.1.0-dev-4 0.1.0-dev-3 0.1.0-dev-2 0.1.0-dev-17 0.1.0-dev-16 0.1.0-dev-15 0.1.0-dev-14 0.1.0-dev-13 0.1.0-dev-12 0.1.0-dev-11 0.1.0-dev-10 0.1.0-dev

Elixir client for ElectricSQL

HexDocs

Current section

Files

Jump to
Readme
85 Versions
5 Dependencies
Dependants
Files
Activity
electric_client README.md
Raw

README.md 

<p align="center">

  <a href="https://electric-sql.com" target="_blank">

    <picture>

      <source media="(prefers-color-scheme: dark)"

          srcset="https://raw.githubusercontent.com/electric-sql/meta/main/identity/ElectricSQL-logo-next.svg"

      />

      <source media="(prefers-color-scheme: light)"

          srcset="https://raw.githubusercontent.com/electric-sql/meta/main/identity/ElectricSQL-logo-black.svg"

      />

      <img alt="ElectricSQL logo"

          src="https://raw.githubusercontent.com/electric-sql/meta/main/identity/ElectricSQL-logo-black.svg"

      />

    </picture>

  </a>

</p>



<p align="center">

  <a href="https://github.com/electric-sql/electric/actions"><img src="https://github.com/electric-sql/electric/actions/workflows/elixir_client_tests.yml/badge.svg"></a>

  <a href="https://github.com/electric-sql/electric/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-Apache_2.0-green" alt="License - Apache 2.0"></a>

  <a href="https://github.com/electric-sql/electric/milestones"><img src="https://img.shields.io/badge/status-alpha-orange" alt="Status - Alpha"></a>

  <a href="https://discord.electric-sql.com"><img src="https://img.shields.io/discord/933657521581858818?color=5969EA&label=discord" alt="Chat - Discord"></a>

  <a href="https://x.com/ElectricSQL" target="_blank"><img src="https://img.shields.io/twitter/follow/ElectricSQL.svg?style=social&label=Follow @ElectricSQL"></a>

</p>



# Elixir client for ElectricSQL



Real-time Postgres sync for modern apps.



Electric provides an [HTTP interface](https://electric-sql.com/docs/api/http) to Postgres to enable a massive number of clients to query and get real-time updates to subsets of the database, called [Shapes](https://electric-sql.com//docs/guides/shapes). In this way, Electric turns Postgres into a real-time database.



The Elixir client helps ease reading Shapes from the HTTP API in Elixir applications.



## Installation



```elixir

def deps do

  [

    {:electric_client, "~> 0.1.0"}

  ]

end

```



## Usage



```elixir

{:ok, client} = Electric.Client.new(base_url: "http://localhost:3000")



incomplete_todos = Electric.Client.shape("todos", where: "completed = false")



# Passing `live: false` means the stream will terminate once it's reached

# the head of the update log from Electric.

#

# Without `live: false` the stream is infinite.

stream = Electric.Client.stream(client, incomplete_todos, live: false)



messages = Enum.into(stream, [])

```



See the [Documentation](https://hexdocs.pm/electric_client).



## Testing



[Run Electric](https://github.com/electric-sql/electric/blob/main/packages/sync-service/README.md) and Postgres.



Define `DATABASE_URL` and `ELECTRIC_URL` as env vars. Or see the defaults in `config/runtime.exs`.



Then run:



```sh

mix test

```