# `Ecto.Adapter.Structure`
[🔗](https://github.com/elixir-ecto/ecto_sql/blob/v3.13.5/lib/ecto/adapter/structure.ex#L1)

Specifies the adapter structure (dump/load) API.

# `dump_cmd`

```elixir
@callback dump_cmd(args :: [String.t()], opts :: Keyword.t(), config :: Keyword.t()) ::
  {output :: Collectable.t(), exit_status :: non_neg_integer()}
```

Runs the dump command for the given repo / config.

Calling this function will setup authentication and run the dump cli
command with your provided `args`.

The options in `opts` are passed directly to `System.cmd/3`.

Returns `{output, exit_status}` where `output` is a string of the stdout
(as long as no option `into` is provided, see `System.cmd/3`) and `exit_status`
is the exit status of the invocation. (`0` for success)

## Examples

    iex> dump_cmd(["--data-only", "--table", "table_name"], [stdout_to_stderr: true], Acme.Repo.config())
    {"--
-- PostgreSQL database dump
--
" <> _rest, 0}

# `structure_dump`

```elixir
@callback structure_dump(default :: String.t(), config :: Keyword.t()) ::
  {:ok, String.t()} | {:error, term()}
```

Dumps the given structure.

The path will be looked in the `config` under :dump_path or
default to the structure path inside `default`.

Returns an `:ok` tuple if it was dumped successfully, an error tuple otherwise.

## Examples

    structure_dump("priv/repo", username: "postgres",
                                database: "ecto_test",
                                hostname: "localhost")

# `structure_load`

```elixir
@callback structure_load(default :: String.t(), config :: Keyword.t()) ::
  {:ok, String.t()} | {:error, term()}
```

Loads the given structure.

The path will be looked in the `config` under :dump_path or
default to the structure path inside `default`.

Returns an `:ok` tuple if it was loaded successfully, an error tuple otherwise.

## Examples

    structure_load("priv/repo", username: "postgres",
                                database: "ecto_test",
                                hostname: "localhost")

---

*Consult [api-reference.md](api-reference.md) for complete listing*