Grapher

v0.9.1

Grapher v0.9.1 Grapher.Document.Store View Source

Manages Saving, Updating and Lookup of GraphQL Documents. The Document Store uses an :ets table to store all documents. From the perspective of the Store a Document is a combination of a name and a Grapher.Document.t struct. The name is typically either an atom or a String.t.

Link to this section Summary

Functions

add_document(name, document)

Adds a new query document to the store under the given name. If a document already exists with that name then :document_exists is returned and nothing changes in the store

child_spec(arg)

Returns a specification to start this module under a supervisor

get(name)

Retrieves a document from the Store by name, if there is no document with that name then :no_such_document will be returned

update_document(name, document)

Updates an existing query document in the Store. If the given name is not associated with a document this function returns :no_such_document

Link to this section Functions

Link to this function add_document(name, document) View Source 
add_document(Grapher.name(), Grapher.Document.t()) :: :ok | :document_exists

Adds a new query document to the store under the given name. If a document already exists with that name then :document_exists is returned and nothing changes in the store.

Parameters

  • name: An atom that should be used to refer to the given document
  • document: The actual query document

Examples 

iex> Store.add_document(:add_test, "query testQuery($id: ID!) { testQuery(id: $id) { id }}")
:ok

iex> Store.add_document(:add_test2, "query {}")
iex> Store.add_document(:add_test2, "query {}")
:document_exists
Link to this function child_spec(arg) View Source

Returns a specification to start this module under a supervisor.

See Supervisor.

Link to this function get(name) View Source 
get(Grapher.name()) :: Grapher.Document.t() | :no_such_document

Retrieves a document from the Store by name, if there is no document with that name then :no_such_document will be returned.

Parameters

  • name: the name of the query which should be returned

Examples 

iex> Store.get(:missing)
:no_such_document

iex> Store.add_document(:get, "query {}")
iex> Store.get(:get)
"query {}"
Link to this function update_document(name, document) View Source 
update_document(Grapher.name(), Grapher.Document.t()) :: :ok | :no_such_document

Updates an existing query document in the Store. If the given name is not associated with a document this function returns :no_such_document

Parameters

  • name: An atom refering to the document to be updated
  • document: The new document that should be stored under name

Examples 

iex> Store.update_document(:missing, "query {}")
:no_such_document

iex> Store.add_document(:update, "query {}")
iex> Store.update_document(:update, "query { query() {}}")
:ok