/
index.ex
193 lines (165 loc) · 6.21 KB
/
index.ex
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
defmodule Meilisearch.Index do
@moduledoc """
Manipulate Meilisearch indexes.
[Index API](https://www.meilisearch.com/docs/reference/api/indexes)
"""
use TypedEctoSchema
@primary_key false
typed_embedded_schema null: false do
field(:uid, :string)
field(:primaryKey, :string)
field(:createdAt, :utc_datetime)
field(:updatedAt, :utc_datetime)
end
def cast(data) when is_list(data), do: Enum.map(data, &cast(&1))
def cast(data) when is_map(data) do
%__MODULE__{}
|> Ecto.Changeset.cast(data, [:uid, :primaryKey, :createdAt, :updatedAt])
|> Ecto.Changeset.apply_changes()
end
@doc """
List indexes of your Meilisearch instance.
[Meilisearch documentation](https://www.meilisearch.com/docs/reference/api/indexes#index-object)
## Examples
iex> client = Meilisearch.Client.new(endpoint: "http://localhost:7700", key: "master_key_test")
iex> Meilisearch.Index.list(client, limit: 20, offset: 0)
{:ok, %{offset: 0, limit: 20, total: 1, results: [%{
uid: "movies",
primaryKey: "id",
createdAt: ~U[2021-08-12 10:00:00],
updatedAt: ~U[2021-08-12 10:00:00]
}]}}
"""
@spec list(Tesla.Client.t(), offset: integer(), limit: integer()) ::
{:ok, Meilisearch.Pagination.t(__MODULE__.t())}
| {:error, Meilisearch.Client.error()}
def list(client, opts \\ []) do
with {:ok, data} <-
client
|> Tesla.get("/indexes", query: opts)
|> Meilisearch.Client.handle_response() do
{:ok, Meilisearch.Pagination.cast(data, &__MODULE__.cast/1)}
end
end
@doc """
Get an Index of your Meilisearch instance.
[Meilisearch documentation](https://www.meilisearch.com/docs/reference/api/indexes#get-one-index)
## Examples
iex> client = Meilisearch.Client.new(endpoint: "http://localhost:7700", key: "master_key_test")
iex> Meilisearch.Index.get(client, "movies")
{:ok, %{
uid: "movies",
primaryKey: "id",
createdAt: ~U[2021-08-12 10:00:00],
updatedAt: ~U[2021-08-12 10:00:00]
}}
"""
@spec get(Tesla.Client.t(), String.t()) ::
{:ok, __MODULE__.t()} | {:error, Meilisearch.Client.error()}
def get(client, index_uid) do
with {:ok, data} <-
client
|> Tesla.get("/indexes/:index_uid", opts: [path_params: [index_uid: index_uid]])
|> Meilisearch.Client.handle_response() do
{:ok, cast(data)}
end
end
@doc """
Create a new Index in your Meilisearch instance.
[Meilisearch documentation](https://www.meilisearch.com/docs/reference/api/indexes#create-an-index)
## Examples
iex> client = Meilisearch.Client.new(endpoint: "http://localhost:7700", key: "master_key_test")
iex> Meilisearch.Index.create(client, %{uid: "movies", primaryKey: "id"})
{:ok, %{
taskUid: 0,
indexUid: "movies",
status: :enqueued,
type: :indexCreation,
enqueuedAt: ~U[2021-08-12 10:00:00]
}}
"""
@spec create(Tesla.Client.t(), %{uid: String.t(), primaryKey: String.t() | nil}) ::
{:ok, Meilisearch.SummarizedTask.t()} | {:error, Meilisearch.Client.error()}
def create(client, params) do
with {:ok, data} <-
client
|> Tesla.post("/indexes", params)
|> Meilisearch.Client.handle_response() do
{:ok, Meilisearch.SummarizedTask.cast(data)}
end
end
@doc """
Update an existing Index in your Meilisearch instance.
[Meilisearch documentation](https://www.meilisearch.com/docs/reference/api/indexes#update-an-index)
## Examples
iex> client = Meilisearch.Client.new(endpoint: "http://localhost:7700", key: "master_key_test")
iex> Meilisearch.Index.update(client, "movies", %{primaryKey: "id"})
{:ok, %{
taskUid: 0,
indexUid: "movies",
status: :enqueued,
type: :indexUpdate,
enqueuedAt: ~U[2021-08-12 10:00:00]
}}
"""
@spec update(Tesla.Client.t(), String.t(), %{primaryKey: String.t() | nil}) ::
{:ok, Meilisearch.SummarizedTask.t()} | {:error, Meilisearch.Client.error()}
def update(client, index_uid, params) do
with {:ok, data} <-
client
|> Tesla.patch("/indexes/:index_uid", params,
opts: [path_params: [index_uid: index_uid]]
)
|> Meilisearch.Client.handle_response() do
{:ok, Meilisearch.SummarizedTask.cast(data)}
end
end
@doc """
Delete an existing Index in your Meilisearch instance.
[Meilisearch documentation](https://www.meilisearch.com/docs/reference/api/indexes#delete-an-index)
## Examples
iex> client = Meilisearch.Client.new(endpoint: "http://localhost:7700", key: "master_key_test")
iex> Meilisearch.Index.delete(client, "movies")
{:ok, %{
taskUid: 0,
indexUid: "movies",
status: :enqueued,
type: :indexDeletion,
enqueuedAt: ~U[2021-08-12 10:00:00]
}}
"""
@spec delete(Tesla.Client.t(), String.t()) ::
{:ok, Meilisearch.SummarizedTask.t()} | {:error, Meilisearch.Client.error()}
def delete(client, index_uid) do
with {:ok, data} <-
client
|> Tesla.delete("/indexes/:index_uid", opts: [path_params: [index_uid: index_uid]])
|> Meilisearch.Client.handle_response() do
{:ok, Meilisearch.SummarizedTask.cast(data)}
end
end
@doc """
Create a new Index in your Meilisearch instance.
[Meilisearch documentation](https://www.meilisearch.com/docs/reference/api/indexes#swap-indexes)
## Examples
iex> client = Meilisearch.Client.new(endpoint: "http://localhost:7700", key: "master_key_test")
iex> Meilisearch.Index.swap(client, [%{indexes: ["movies", "actors"]}])
{:ok, %{
taskUid: 0,
indexUid: nil,
status: :enqueued,
type: :indexSwap,
enqueuedAt: ~U[2021-08-12 10:00:00]
}}
"""
@spec swap(Tesla.Client.t(), list(%{indexes: list(String.t())})) ::
{:ok, Meilisearch.SummarizedTask.t()} | {:error, Meilisearch.Client.error()}
def swap(client, params) do
with {:ok, data} <-
client
|> Tesla.post("/swap-indexes", params)
|> Meilisearch.Client.handle_response() do
{:ok, Meilisearch.SummarizedTask.cast(data)}
end
end
end