/
storage.ex
39 lines (28 loc) · 1 KB
/
storage.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
defmodule Ecto.Adapter.Storage do
@moduledoc """
Specifies the adapter storage API.
"""
use Behaviour
@doc """
Create the storage in the data store and return `:ok` if it was created
successfully.
Returns `{:error, :already_up}` if the storage has already been created or
`{:error, term}` in case anything else goes wrong.
## Examples
storage_up(username: postgres,
database: 'ecto_test',
hostname: 'localhost')
"""
defcallback storage_up(Keyword.t) :: :ok | {:error, :already_up} | {:error, term}
@doc """
Drop the storage in the data store and return `:ok` if it was dropped
successfully.
Returns `{:error, :already_down}` if the storage has already been dropped or
`{:error, term}` in case anything else goes wrong.
## Examples
storage_down(username: postgres,
database: 'ecto_test',
hostname: 'localhost')
"""
defcallback storage_down(Keyword.t) :: :ok | {:error, :already_down} | {:error, term}
end