Qodex.ai

Stargate-Document-API:library

Number of APIs: 34

This Stargate JSON Document API example collection is named Library.

It is documented here, make sure to read before using this collection.

Stargate requires a Cassandra cluster. Stargate is deployable to bare metal, VMs, Docker/Compose, EKS, GKE, K8ssandra.io and DataStax Enterprise.

Development mode will install a Cassandra DB for you locally with non-production / desktop development settings.

On Astra DB, both Cassandra and Stargate are automatically setup (and managed) for you.

Most desktop development is free with Astra DB's 80GB free monthly plan. Sign up in a few clicks, no credit card is required.

What is Stargate?

What is Apache Cassandra?

What is Astra DB?

  1. Delete data - Delete document from collection DELETE {{base_doc_url}}{{doc_api}}/{{namespace}}/collections/{{collection}}/{{bookdocid}}

  2. Authentication - Create a auth token (Stargate OSS only) POST {{base_auth_url}}{{auth_api}}

  3. Create collection schema - Create empty collection library2 POST {{base_doc_url}}{{doc_api}}/{{namespace}}/collections

  4. Create schema - Create a simple namespace test (Stargate OSS only) POST {{base_doc_url}}{{doc_schema}}

  5. Retrieve schema - Get a particular namespace (test) GET {{base_doc_url}}{{doc_schema}}/{{namespace}}

  6. Retrieve schema - Get all namespaces GET {{base_doc_url}}{{doc_schema}}

  7. Create collection schema - Put a JSON Schema PUT {{base_doc_url}}{{doc_api}}/{{namespace}}/collections/{{collection2}}/json-schema

  8. Get collection info - Get all collections from a namespace GET {{base_doc_url}}{{doc_api}}/{{namespace}}/collections

  9. Write data - PUT document with documentId PUT {{base_doc_url}}{{doc_api}}/{{namespace}}/collections/{{collection}}/{{docid}}

  10. Write data - POST ONE BOOK PUT {{base_doc_url}}{{doc_api}}/{{namespace}}/collections/{{collection}}/{{bookdocid}}