Astra.Document (astra v0.5.0)
Provides functions to access the public methods of the Document API for databases hosted on https://astra.datastax.com.
Astra's Document API is implemented using the stargate project, https://stargate.io. Swagger docs for this interface are available here https://docs.astra.datastax.com/reference#namespaces-1.
If required, raw access to the Astra REST Document API can be obtained through the Astra.Document.Http module.
Link to this section Summary
Functions
delete a document
delete a sub document
get a document by id
get a sub document by id
update part of a document
update part of a sub document
add a new document, id will be an auto generated uuid
replace a document
replace a sub document
search for documents in a collection
Link to this section Functions
Link to this function
delete_doc(namespace, collection, id)
Specs
delete_doc(String, String, String) :: {Atom, []}
delete a document
Parameters
- namespace: namespace name
- collection: name of the document collection
- id: the id of the document to destroy
Examples
> Astra.Document.delete_doc("test", "docs", id)
{:ok, []}
Link to this function
delete_sub_doc(namespace, collection, id, path)
Specs
delete_sub_doc(String, String, String, String) :: {Atom, []}
delete a sub document
Parameters
- namespace: namespace name
- collection: name of the document collection
- id: the id of the document to destroy
- path: the path to the subdocument. Nested paths can be matched by joining the keys with a
\, ex.address\city
Examples
doc = %{
name: "other-stuff",
other: %{ first: "thing", last: "thing"}
}
> {:ok, %{documentId: id}} = Astra.Document.post_doc("test", "docs", doc)
> Astra.Document.get_sub_doc("test", "docs", id, "other")
{:ok, %{ first: "thing", last: "thing"}}
Link to this function
get_doc(namespace, collection, id)
Specs
get_doc(String, String, String) :: {Atom, Map}
get a document by id
Parameters
- namespace: namespace name
- collection: name of the document collection
- id: the id of the document to retrieve
Examples
> Astra.Document.get_doc("test", "docs", id)
{:ok, %{name: "other-stuff", other: "This makes no sense"}}
Link to this function
get_sub_doc(namespace, collection, id, path)
Specs
get_sub_doc(String, String, String, String) :: {Atom, Map}
get a sub document by id
Parameters
- namespace: namespace name
- collection: name of the document collection
- id: the id of the document to retrieve
- path: the path to the subdocument. Nested paths can be matched by joining the keys with a
\, ex.address\city
Examples
doc = %{
name: "other-stuff",
other: %{ first: "thing", last: "thing"}
}
> {:ok, %{documentId: id}} = Astra.Document.post_doc("test", "docs", doc)
> Astra.Document.get_sub_doc("test", "docs", id, "other")
{:ok, %{ first: "thing", last: "thing"}}
Link to this function
patch_doc(namespace, collection, id, patch)
Specs
patch_doc(String, String, String, Map) :: {Atom, nil}
update part of a document
Parameters
- namespace: namespace name
- collection: name of the document collection
- id: the id of the document
Examples
> Astra.Document.patch_doc("test", "docs", id, %{name: "fred"})
{:ok, nil}
Link to this function
patch_sub_doc(namespace, collection, id, path, patch)
Specs
patch_sub_doc(String, String, String, String, Map) :: {Atom, nil}
update part of a sub document
Parameters
- namespace: namespace name
- collection: name of the document collection
- id: the id of the document'
- path: the path to the subdocument. Nested paths can be matched by joining the keys with a
\, ex.address\city - patch: a map of attributes to match. Sub-document attributes not in the patch Map will remain as is.
Examples
> Astra.Document.patch_sub_doc("test", "docs", id, "other", %{first: "object"})
{:ok, nil}
Link to this function
post_doc(namespace, collection, document)
Specs
post_doc(String, String, Map) :: {Atom, Map}
add a new document, id will be an auto generated uuid
Parameters
- namespace: namespace name
- collection: name of the document collection
- doc: the new document.
Examples
> doc = %{
name: "other-stuff",
other: %{ first: "thing", last: "thing"}
}
> Astra.Document.post_doc("test", "docs", doc)
{:ok, %{documentId: "3f9d03af-e29d-40d5-9fe1-c77a2ff6a40a"}}
Link to this function
put_doc(namespace, collection, id, doc)
Specs
put_doc(String, String, String, Map) :: {Atom, Map}
replace a document
Parameters
- namespace: namespace name
- collection: name of the document collection
- id: the id of the document
- doc: the new document. Any existing document at the id will be removed.
Examples
> doc = %{
name: "other-stuff",
other: %{ first: "thing", last: "thing"}
}
> Astra.Document.put_doc("test", "docs", uuid, doc)
Link to this function
put_sub_doc(namespace, collection, id, path, subdoc)
Specs
put_sub_doc(String, String, String, String, Map) :: {Atom, Map}
replace a sub document
Parameters
- namespace: namespace name
- collection: name of the document collection
- id: the id of the document
- path: the path to the subdocument. Nested paths can be matched by joining the keys with a
\, ex.address\city - doc: the new document. Any existing document at the id will be removed.
Examples
> doc = %{
name: "other-stuff",
other: %{ first: "thing", last: "thing"}
}
> Astra.Document.put_doc("test", "docs", uuid, doc)
Link to this function
search_docs(namespace, collection, where, options)
Specs
search_docs(String, String, Map, Map) :: {Atom, Map}
search for documents in a collection
Parameters
- namespace: namespace name
- collection: name of the document collection
- where: search clause for matching documents
- options: Valid options [:fields, :"page-size", :"page-state", :sort]
Examples
> query = %{
other: %{
"$eq": uuid
}
}
> Astra.Document.search_docs("test", "docs", query, %{"page-size": 20})