Webql behaviour (webql v0.1.0-alpha.1)

Defines and runs WebQL instances.

Examples

defmodule MyApp.Webql do
  use Webql,
    memory: MyApp.Webql.Memory.new/0,
    engine: MyApp.Webql.Engine.new/0
end

__engine__()

Returns the configured engine instance.

__memory__()

Returns the configured memory instance.

introspect(dsl)

Returns introspection results for a WebQL schema.

Creates a new WebQL instance.

Runs an operation with the given parameters.

@callback __engine__() :: term()

Returns the configured engine instance.

@callback __memory__() :: term()

Returns the configured memory instance.

@callback introspect(dsl :: module()) :: map()

Returns introspection results for a WebQL schema.

@callback new(memory :: term(), engine :: term()) :: term()

Creates a new WebQL instance.

@callback run(webql :: term(), source :: binary(), dsl :: module(), params :: map()) ::
  map()

Runs an operation with the given parameters.