View Source Ecto.Adapter.Structure behaviour (Ecto SQL v3.8.3)

Specifies the adapter structure (dump/load) API.

Link to this section Summary

Callbacks

Dumps the given structure.

Loads the given structure.

Link to this section Callbacks

Link to this callback

structure_dump(default, config)

View Source
@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 :ok if it was dumped successfully, an error tuple otherwise.

examples

Examples

structure_dump("priv/repo", username: "postgres",
                            database: "ecto_test",
                            hostname: "localhost")
Link to this callback

structure_load(default, config)

View Source
@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 :ok if it was loaded successfully, an error tuple otherwise.

examples

Examples

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