View Source Arke.Core.Query (Arke v1.1.33)

@type t() :: %Arke.Core.Query{
  arke: term(),
  filters: term(),
  limit: term(),
  link: term(),
  offset: term(),
  orders: term(),
  persistence: term(),
  project: term()
}

Link to this section Functions

add_filter(query, filter)

Add a filter to a query

parameters
Parameters

query => refer to new/1
filter => refer to Arke.Core.Query.BaseFilter

example
Example

iex> person = Arke.Core.Arke.new(id: :person, label: "Person")
...> query = Arke.Core.Query.new(person, :arke_system)
...> parameter = Arke.Boundary.ParameterManager.get(:id,:arke_system)
...> filter = Arke.Core.Query.new_filter(parameter,:eq, "name", false)
...> Arke.Core.Query.add_filter(query, filter)

return
Return

%Arke.Core.Query{... filters: [ %Arke.Core.Query.Filter{} ] ... }

add_filter(query, logic, negate, base_filters)

Add a filter to a query

parameters
Parameters

query => refer to new/1
logic => :and | :or => the logic of the filter
negate => boolean => used to figure out whether the condition is to be denied
base_filters

example
Example

iex> person = Arke.new(id: :person, label: "Person")
...> query = Arke.Core.Query.new(person, :arke_system)
...> parameter = Arke.Core.ParameterManager.get(:id,:arke_system)
...> Arke.Core.Query.add_filter(query, parameter, :eq, "name", false)

return
Return

 %Arke.Core.Query{... filters: [ %Arke.Core.Query.Filter{} ] ... }

add_filter(query, parameter, operator, value, negate)

Add a filter to a query

parameters
Parameters

query => refer to new/1
parameter
operator
value
negate

example
Example

iex> person = Arke.Core.Arke.new(id: :person, label: "Person")
...> query = Arke.Core.Query.new(person, :arke_system)
...> parameter = Arke.Boundary.ParameterManager.get(:id,:arke_system)
...> base_filter = Arke.Core.Query.new_base_filter(parameter, :eq, "name", false)
...> Arke.Core.Query.add_filter(query, :and, false, base_filter)

return
Return

 %Arke.Core.Query{... filters: [ %Arke.Core.Query.Filter{} ] ... }

add_link_filter(query, unit, depth, direction, type)

@spec add_link_filter(
  query :: t(),
  unit :: Arke.Core.Unit.t(),
  depth :: integer(),
  direction :: atom(),
  connection_type :: String.t()
) :: t()

Add a new link filter

parameters
Parameters

query => refer to new/1
unit => %Arke.Core.{arke_struct}{} => the arke_struct of the unit which we want to filter on. See Arke.Struct
depth => integer => how many results we want to have at max
direction => "child" | "parent" => the direction the query will use to search
type => the name of the link we want to look at

example
Example

iex> person = Arke.Core.Arke.new(id: :person, label: "Person")
...> query = Arke.Core.Query.new(person, :arke_system)
...> Arke.Core.Query.add_link_filter(query, person, 0, "child", "link")

return
Return

%Arke.Core.Query{... link: %Arke.Core.Query.LinkFilter{} ... }

add_order(query, parameter, direction)

Get the query result ordered by specific criteria

parameters
Parameters

query => refer to refer to new/1
parameter => %Arke.Core.Parameter.ParameterType => refer to Arke.Core.Parameter
direction => "child" | "parent" => the direction the query will use to search

example
Example

iex> person = Arke.Core.Arke.new(id: "person", label: "Person")
...> query = Arke.Core.Query.new(person, :arke_system)
...> parameter = Arke.Boundary.ParameterManager.get(:id,:arke_system)
...> Arke.Core.Query.add_order(query, parameter, :asc)

return
Return

%Arke.Core.Query{ ... orders: [ %Arke.Core.Query.Order{} ] ... }

new(arke, project)

@spec new(
  arke :: %Arke.Core.Arke{
    active: term(),
    id: term(),
    label: term(),
    parameters: term(),
    type: term()
  },
  project :: atom()
) :: t()

Create a new Query

parameters
Parameters

arke => %Arke.Core.{arke_struct}{} => the arke_struct of the unit which we want to filter on. See Arke.Struct
project => :atom => identify the Arke.Core.Project

example
Example

iex> person = Arke.Core.Arke.new(id: "person", label: "Person")
...> Arke.Core.Query.new(person, :default)

return
Return

%Arke.Core.Query{}

new_base_filter(parameter, operator, value, negate)

Create a new base filter

parameters
Parameters

parameter => %Arke.Core.Parameter.ParameterType => refer to Arke.Core.Parameter
operator => refer to operators
value => any => the value that the query will search for
negate => boolean => used to figure out whether the condition is to be denied

example
Example

iex> parameter = Arke.Boundary.ParameterManager.get(:id,:arke_system)
...> Arke.Core.Query.new_base_filter(parameter, :eq, "name", false)

return
Return

%Arke.Core.Query.BaseFilter{}

new_filter(logic, negate, base_filters)

Create a new filter

parameters
Parameters

logic => :and | :or => the logic of the filter
negate => boolean => used to figure out whether the condition is to be denied
base_filters => refer to Arke.Core.Query.BaseFilter

example
Example

iex> base_filter = Arke.Core.Query.new_base_filter(parameter, :eq, "name", false)
...> Arke.Core.Query.new_filter(:and, false, base_filter)

return
Return

%Arke.Core.Query.Filter{base_filters: [ %Arke.Core.Query.BaseFilter{} ]}

new_filter(parameter, operator, value, negate)

Create a new filter

parameters
Parameters

parameter => %Arke.Core.Parameter.ParameterType => refer to Arke.Core.Parameter
operator => refer to operators
value => any => the value that the query will search for
negate => boolean => used to figure out whether the condition is to be denied

example
Example

iex> parameter = Arke.Boundary.ParameterManager.get(:id,:arke_system)
...> Arke.Core.Query.new_filter(parameter,:eq, "name", false)

return
Return

%Arke.Core.Query.Filter{base_filters: [ %Arke.Core.Query.BaseFilter{} ]}

set_limit(query, offset)

Define the limit of the query

parameters
Parameters

query => refer to new/1
limit => integer => set the results limit of the query

example
Example

iex> person = Arke.Core.Arke.new(id: :person, label: "Person")
...> query = Arke.Core.Query.new(person, :arke_system)
...> Arke.Core.Query.set_limit(query, 100)

return
Return

%Arke.Core.Query{... limit: value ...}

set_offset(query, offset)

Define the offset of the query

parameters
Parameters

query => refer to new/1
offset => integer => define the offset of the query

example
Example

iex> person = Arke.Core.Arke.new(id: :person, label: "Person")
...> query = Arke.Core.Query.new(person, :arke_system)
...> Arke.Core.Query.set_offset(query, 5)

return
Return

%Arke.Core.Query{... offset: value ...}

Settings View Source Arke.Core.Query (Arke v1.1.33)

Link to this section Summary

Types

Functions

Link to this section Types

t()

Link to this section Functions

add_filter(query, filter)

parameters Parameters

example Example

return Return

add_filter(query, logic, negate, base_filters)

parameters Parameters

example Example

return Return

add_filter(query, parameter, operator, value, negate)

parameters Parameters

example Example

return Return

add_link_filter(query, unit, depth, direction, type)

parameters Parameters

example Example

return Return

add_order(query, parameter, direction)

parameters Parameters

example Example

return Return

new(arke, project)

parameters Parameters

example Example

return Return

new_base_filter(parameter, operator, value, negate)

parameters Parameters

example Example

return Return

new_filter(logic, negate, base_filters)

parameters Parameters

example Example

return Return

new_filter(parameter, operator, value, negate)

parameters Parameters

example Example

return Return

set_limit(query, offset)

parameters Parameters

example Example

return Return

set_offset(query, offset)

parameters Parameters

example Example

return Return

View Source Arke.Core.Query (Arke v1.1.33)

parameters
Parameters

example
Example

return
Return

parameters
Parameters

example
Example

return
Return

parameters
Parameters

example
Example

return
Return

parameters
Parameters

example
Example

return
Return

parameters
Parameters

example
Example

return
Return

parameters
Parameters

example
Example

return
Return

parameters
Parameters

example
Example

return
Return

parameters
Parameters

example
Example

return
Return

parameters
Parameters

example
Example

return
Return

parameters
Parameters

example
Example

return
Return

parameters
Parameters

example
Example

return
Return