Merge pull request #11 from JesseStimpson/0-1-1

v0.1.1
foundationdb-beam · Aug 25, 2024 · bec63e0 · bec63e0
2 parents e5abdf8 + 88d118a
commit bec63e0
Show file tree

Hide file tree

Showing 5 changed files with 25 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -30,6 +30,24 @@ defp deps do
 end
 ```
 
+## Motivation
+
+What are some reasons to choose EctoFDB?
+
+FoundationDB offers:
+
+* Horizontal scaling of high-write workloads
+* Unbounded multi-tenancy
+* Serializable Transactions
+* Rich operations: multi-region, disaster recovery, backup/restore, telemetry
+
+EctoFoundationDB offers:
+
+* Object storage similar to [Record Layer](https://github.com/FoundationDB/fdb-record-layer)
+* Online migrations
+* Built-in common indexes
+* Extensible index types
+
 ## Usage
 
 See the [documentation](https://hexdocs.pm/ecto_foundationdb) for usage

diff --git a/lib/ecto/adapters/foundationdb.ex b/lib/ecto/adapters/foundationdb.ex
@@ -12,8 +12,8 @@ defmodule Ecto.Adapters.FoundationDB do
   Install the latest stable release of FoundationDB from the
   [official FoundationDB Releases](https://github.com/apple/foundationdb/releases).
 
-  You will only need to install the `foundationdb-server` package if you're
-  running an instance of the FoundationDB Server. For example, it's common to
+  The `foundationdb-server` package is required on any system that will be running
+  a FoundationDB server instance. For example, it's common to
   run the `foundationdb-server` on your development machine and on managed
   instances running a FoundationDB cluster, but not for your stateless Elixir
   application server in production.
@@ -25,7 +25,7 @@ defmodule Ecto.Adapters.FoundationDB do
   ```elixir
   defp deps do
     [
-      {:ecto_foundationdb, "~> 0.1.0"}
+      {:ecto_foundationdb, "~> 0.1"}
     ]
   end
   ```

diff --git a/mix.exs b/mix.exs
@@ -4,7 +4,7 @@ defmodule EctoFoundationdb.MixProject do
   def project do
     [
       app: :ecto_foundationdb,
-      version: "0.1.0",
+      version: "0.1.1",
       description: "FoundationDB adapter for Ecto",
       elixir: "~> 1.15",
       start_permanent: Mix.env() == :prod,
@@ -54,7 +54,7 @@ defmodule EctoFoundationdb.MixProject do
   # Run "mix help deps" to learn about dependencies.
   defp deps do
     [
-      {:erlfdb, "~> 0.1.0"},
+      {:erlfdb, "~> 0.1"},
       {:ecto, "~> 3.12"},
       {:jason, "~> 1.4"},
       {:credo, "~> 1.6", only: [:dev, :test, :docs]},

diff --git a/mix.lock b/mix.lock
@@ -8,7 +8,7 @@
   "earmark_parser": {:hex, :earmark_parser, "1.4.39", "424642f8335b05bb9eb611aa1564c148a8ee35c9c8a8bba6e129d51a3e3c6769", [:mix], [], "hexpm", "06553a88d1f1846da9ef066b87b57c6f605552cfbe40d20bd8d59cc6bde41944"},
   "ecto": {:hex, :ecto, "3.12.2", "bae2094f038e9664ce5f089e5f3b6132a535d8b018bd280a485c2f33df5c0ce1", [:mix], [{:decimal, "~> 2.0", [hex: :decimal, repo: "hexpm", optional: false]}, {:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: true]}, {:telemetry, "~> 0.4 or ~> 1.0", [hex: :telemetry, repo: "hexpm", optional: false]}], "hexpm", "492e67c70f3a71c6afe80d946d3ced52ecc57c53c9829791bfff1830ff5a1f0c"},
   "erlex": {:hex, :erlex, "0.2.6", "c7987d15e899c7a2f34f5420d2a2ea0d659682c06ac607572df55a43753aa12e", [:mix], [], "hexpm", "2ed2e25711feb44d52b17d2780eabf998452f6efda104877a3881c2f8c0c0c75"},
-  "erlfdb": {:hex, :erlfdb, "0.1.0", "1ef7958a5c42f695bf40bed3ef20d6083dbedaf07347226c6753aa7c06c9ec61", [:rebar3], [], "hexpm", "b05c0aba2877293c516c5be043d757e9e97dd90e72879d6886154deac7bc81a6"},
+  "erlfdb": {:hex, :erlfdb, "0.1.1", "6cfeba1418d616f8cdd048e211770310066b549ce19cb14380473d5e04cfaf00", [:rebar3], [], "hexpm", "36ac6d300ec9afacdc2e476235b92a6b921d386d0ee9f92d96e6f58b7eb4df05"},
   "ex_doc": {:hex, :ex_doc, "0.34.2", "13eedf3844ccdce25cfd837b99bea9ad92c4e511233199440488d217c92571e8", [:mix], [{:earmark_parser, "~> 1.4.39", [hex: :earmark_parser, repo: "hexpm", optional: false]}, {:makeup_c, ">= 0.1.0", [hex: :makeup_c, repo: "hexpm", optional: true]}, {:makeup_elixir, "~> 0.14 or ~> 1.0", [hex: :makeup_elixir, repo: "hexpm", optional: false]}, {:makeup_erlang, "~> 0.1 or ~> 1.0", [hex: :makeup_erlang, repo: "hexpm", optional: false]}, {:makeup_html, ">= 0.1.0", [hex: :makeup_html, repo: "hexpm", optional: true]}], "hexpm", "5ce5f16b41208a50106afed3de6a2ed34f4acfd65715b82a0b84b49d995f95c1"},
   "file_system": {:hex, :file_system, "1.0.0", "b689cc7dcee665f774de94b5a832e578bd7963c8e637ef940cd44327db7de2cd", [:mix], [], "hexpm", "6752092d66aec5a10e662aefeed8ddb9531d79db0bc145bb8c40325ca1d8536d"},
   "jason": {:hex, :jason, "1.4.1", "af1504e35f629ddcdd6addb3513c3853991f694921b1b9368b0bd32beb9f1b63", [:mix], [{:decimal, "~> 1.0 or ~> 2.0", [hex: :decimal, repo: "hexpm", optional: true]}], "hexpm", "fbb01ecdfd565b56261302f7e1fcc27c4fb8f32d56eab74db621fc154604a7a1"},

diff --git a/notebooks/guide.livemd b/notebooks/guide.livemd
@@ -2,7 +2,7 @@
 
 ```elixir
 Mix.install([
-  {:ecto_foundationdb, "~> 0.1.0"}
+  {:ecto_foundationdb, "~> 0.1"}
 ])
 ```