artemis.stores.protocols
GQLStorecljsprotocol
Defines a protocol that can be applied on any type of GraphQL data store.
Defines a protocol that can be applied on any type of GraphQL data store.
-readcljs
(-read this document variables return-partial?)Returns the result of a GraphQL query against the store. The store should
return a map of {:data <any>, :partial? <boolean>}.
documentAnartemis.document/DocumentvariablesA map of variables for the queryreturn-partial?States if a partially fulfilled query can be returned
If the query cannot be fulfilled at all, i.e. the data does not exist in
the store, or if return-partial? is false and the store is not able to
fulfill the entire query, should return nil.
Returns the result of a GraphQL query against the store. The store should
return a map of `{:data <any>, :partial? <boolean>}`.
- `document` An `artemis.document/Document`
- `variables` A map of variables for the query
- `return-partial?` States if a partially fulfilled query can be returned
If the query cannot be fulfilled at all, i.e. the data does not exist in
the store, or if `return-partial?` is `false` and the store is not able to
fulfill the entire query, should return `nil`.-read-fragmentcljs
(-read-fragment this document entity-ref return-partial?)Returns the result of a executing a GraphQL fragment against an entity
identified by entity-ref. The store should return a map of {:data <any>, :partial? <boolean>}.
documentAn artemis document containing a GraphQL fragment operationentity-refA unqiue reference to a specific stored entityreturn-partial?States if a partially fulfilled query can be returned
If the fragment cannot be fulfilled at all, i.e. the entity does not exist
in the store, or if return-partial? is false and the store is not able
to fulfill the entire fragment selection, should return nil.
Returns the result of a executing a GraphQL fragment against an entity
identified by `entity-ref`. The store should return a map of `{:data <any>,
:partial? <boolean>}`.
- `document` An artemis document containing a GraphQL fragment
operation
- `entity-ref` A unqiue reference to a specific stored entity
- `return-partial?` States if a partially fulfilled query can be returned
If the fragment cannot be fulfilled at all, i.e. the entity does not exist
in the store, or if `return-partial?` is `false` and the store is not able
to fulfill the entire fragment selection, should return `nil`.-writecljs
(-write this data document variables)Writes the data resulting from a GraphQL query to the store.
dataThe result received from executing a GraphQL query (ex. against a server)documentTheartemis.document/Documentthat was run to producedatavariablesA map of variables for the query that was run
Should return the updated store.
Writes the data resulting from a GraphQL query to the store.
- `data` The result received from executing a GraphQL query (ex.
against a server)
- `document` The `artemis.document/Document` that was run to produce `data`
- `variables` A map of variables for the query that was run
Should return the updated store.-write-fragmentcljs
(-write-fragment this data document entity-ref)Writes the data resulting from a GraphQL query to the store.
dataThe value(s) to update the entity as a hash-map.documentAn artemis document containing a GraphQL fragment operationentity-refA unqiue reference to a specific stored entity
Should return the updated store.
Writes the data resulting from a GraphQL query to the store.
- `data` The value(s) to update the entity as a hash-map.
- `document` An artemis document containing a GraphQL fragment
operation
- `entity-ref` A unqiue reference to a specific stored entity
Should return the updated store.cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close