Stargate Api Document - datastaxdevs/awesome-astra GitHub Wiki

🏠 Back to home | Written by Cedrick Lunven, Last Update 3/14/2022

The document Api is an abstraction on top of Apache Cassandra to allow document-oriented accesses. The algorithm used is called document shredding and optimized to limit tombstones on edits and deletes.

• You would work with JSON document with no validation.

• You can search on any field thanks to the support out of the box of the secondary index SAI

• Data is stored in collections, that would create a technical table under the hood not mean to be queried through CQL

create table <collection_name> (
  key text,
  p0 text,
  … p[N] text,
  bool_value boolean,
  txt_value text,
  dbl_value double, 
  leaf text
)

A json like {"a": { "b": 1 }, "c": 2} will be stored like

This also work with arrays {"a": { "b": 1 }, "c": [{"d": 2}]}

⚠️ Limitations: As of today there are no aggregations nor sorting available in the Document Api.

• You should have an Astra account
• You should Create and Astra Database
• You should Have an Astra Token

• You should install Postman to import some collections we provided.

• Import the configuration File Astra_Document_Api_Configuration.json in postman. In the menu locate File > Import and drag the file in the box.

• Edit the values for you db:

• this is what it is look like

• Import the Document Api Collection Astra_Document_Api.json in postman. Same as before File > Menu

• That's it you have now access to a few dozens operations for namespace, collections and documents

• You should have an Astra account
• You should Create and Astra Database
• You should Have an Astra Token

• Working with CURL:You should have curl commands available either installing following steps here or

curl --version