• Glossary
  • Support
  • Downloads
  • DataStax Home
Get Live Help
Expand All
Collapse All

DataStax Astra DB Classic Documentation

    • Overview
      • Release notes
      • Astra DB FAQs
      • Astra DB glossary
      • Get support
    • Getting Started
      • Grant a user access
      • Load and retrieve data
        • Use DSBulk to load data
        • Use Data Loader in Astra Portal
      • Connect a driver
      • Build sample apps
      • Use integrations
        • Connect with DataGrip
        • Connect with DBSchema
        • Connect with JanusGraph
        • Connect with Strapi
    • Planning
      • Plan options
      • Database regions
    • Securing
      • Security highlights
      • Security guidelines
      • Default user permissions
      • Change your password
      • Reset your password
      • Authentication and Authorization
      • Astra DB Plugin for HashiCorp Vault
    • Connecting
      • Connecting to a VPC
      • Connecting Change Data Capture (CDC)
      • Connecting CQL console
      • Connect the Spark Cassandra Connector to Astra
      • Drivers for Astra DB
        • Connecting C++ driver
        • Connecting C# driver
        • Connecting Java driver
        • Connecting Node.js driver
        • Connecting Python driver
        • Drivers retry policies
      • Connecting Legacy drivers
      • Get Secure Connect Bundle
    • Migrating
      • FAQs
      • Preliminary steps
        • Feasibility checks
        • Deployment and infrastructure considerations
        • Create target environment for migration
        • Understand rollback options
      • Phase 1: Deploy ZDM Proxy and connect client applications
        • Set up the ZDM Automation with ZDM Utility
        • Deploy the ZDM Proxy and monitoring
          • Configure Transport Layer Security
        • Connect client applications to ZDM Proxy
        • Manage your ZDM Proxy instances
      • Phase 2: Migrate and validate data
      • Phase 3: Enable asynchronous dual reads
      • Phase 4: Change read routing to Target
      • Phase 5: Connect client applications directly to Target
      • Troubleshooting
        • Troubleshooting tips
        • Troubleshooting scenarios
      • Additional resources
        • Glossary
        • Contribution guidelines
        • Release Notes
    • Managing
      • Managing your organization
        • User permissions
        • Pricing and billing
        • Audit Logs
        • Configuring SSO
          • Configure SSO for Microsoft Azure AD
          • Configure SSO for Okta
          • Configure SSO for OneLogin
      • Managing your database
        • Create your database
        • View your databases
        • Database statuses
        • Use DSBulk to load data
        • Use Data Loader in Astra Portal
        • Monitor your databases
        • Manage multiple keyspaces
        • Using multiple regions
        • Terminate your database
        • Resize your classic database
        • Park your classic database
        • Unpark your classic database
      • Managing with DevOps API
        • Managing database lifecycle
        • Managing roles
        • Managing users
        • Managing tokens
        • Managing multiple regions
        • Get private endpoints
        • AWS PrivateLink
        • Azure PrivateLink
        • GCP Private Service
    • Astra CLI
    • Developing with Stargate APIs
      • Develop with REST
      • Develop with Document
      • Develop with GraphQL
        • Develop with GraphQL (CQL-first)
        • Develop with GraphQL (Schema-first)
      • Develop with gRPC
        • gRPC Rust client
        • gRPC Go client
        • gRPC Node.js client
        • gRPC Java client
      • Develop with CQL
      • Tooling Resources
      • Node.js Document API client
      • Node.js REST API client
    • Stargate QuickStarts
      • Document API QuickStart
      • REST API QuickStart
      • GraphQL API CQL-first QuickStart
    • API References
      • DevOps REST API v2
      • Stargate Document API v2
      • Stargate REST API v2
  • DataStax Astra DB Classic Documentation
  • Developing with Stargate APIs
  • Tooling Resources

Tooling Resources

Postman resources

Postman is a widely-used collaboration platform for API development and testing. Using this third-party tool, you can easily test APIs with environments generated for your test platforms and imported testing collections of API queries.

Postman collections are comprised of REST, Document, or GraphQL schema and queries to run or test against one or more defined environments. The tool includes a collection runner testing utility for testing against query assertions embedded in the collection. Collections and environments can be imported or exported with Postman.

Using Postman

Prerequisites

  • Install Postman to run postman testing.

Postman collections

Postman collections are accessed in the Stargate-Cassandra workspace hosted on postman.com.

You can either run the collections in the workspace, export the collections to use in your own Postman application, or run the collections using the Run in Postman.

For Stargate development, collections that correspond to the documentation code examples are available:

  • REST API

    • Postman Workspace: REST API collection

    • Run in Postman with Astra environment

    • Run in Postman with Stargate environment

  • Document API

    • Postman Workspace: Document API collection

    • Run in Postman with Astra environment

    • Run in Postman with Stargate environment

  • GraphQL API

    • Postman Workspace: GraphQL API collection

    • Run in Postman with Astra environment

    • Run in Postman with Stargate environment

  • gRPC API

    • Postman Workspace: gRPC API collection

Each collection lets you try out creation, insertion, and deletion of both data and schema, as required.

Postman environment configuration

To use the collections, you’ll need to download and configure a Postman environment.

Two environments are also available, one for the open-source Stargate docker image and one for DataStax Astra.

A small amount of configuration is necessary in the single environment to set your parameters before use.

  • Astra environment

  • Stargate OSS environment

Stargate OSS

If you are using non-standard ports, you’ll need to change them in the Postman environment. You can also edit the JSON file directly, if you prefer.

Astra

There are three items that must be retrieved from the Astra dashboard and configured in the Postman environment:

  • ASTRA_DB_ID

  • ASTRA_DB_REGION

  • ASTRA_DB_APPLICATION_TOKEN

Open the environment in Postman and copy/paste in the appropriate values. You can also edit the JSON file directly, if you prefer.

GraphQL resources

The easiest way to get started with GraphQL is to use the built-in GraphQL playground.

Prerequisites

Add your to the HTTP HEADERS section at the lower lefthand corner of the GraphQL Playground window:

{"x-cassandra-token":"$AUTH_TOKEN"}

Using the GraphQL Playground

Once in the playground, you can create new schema and interact with the GraphQL APIs. The server paths are structured to provide access to creating and querying schema, as well as querying and modifying Astra DB Classic data:

  • /graphql-schema

    • An API for exploring and creating schema, or Data Definition Language (DDL). For example, Astra DB Classic has queries to create, modify, or drop tables, such as createTable, or dropTable.

  • /graphql-admin

    • An API for deploying GraphQL schema.

  • /graphql/<keyspace>

    • An API for querying and modifying data in your tables using GraphQL fields.

REST and Document API

The Swagger UI allows you to interact with the REST and Document APIs in a web browser.

Using the Swagger UI

BloomRPC gRPC resources

Prerequisites

  • Install BloomRPC to run gRPC testing

Using BloomRPC

BloomRPC aims to provide the simplest and most efficient developer experience for exploring and querying your GRPC services. Using this third-party tool, you can easily test gRPC proto files with environments generated for your test platforms.

For instance, the proto files can be imported into BloomRPC. Select ExecuteQuery from the imported files. Set the environment to localhost:8090 if running a Stargate docker container. In the metadata, add an authentication token with {"x-cassandra-token": "<auth_token>"}. If you have followed one of the gRPC client instructions, add the following query and push the run button:

{
  "cql": "SELECT * FROM users",
  "values": {
    "type": 0
  },
  "parameters": {
    "keyspace": {
      "value": "test"
    }
  }
}

You should get the same results from the database table that you received running command-line tools.

Develop with CQL Node.js Document API client

General Inquiries: +1 (650) 389-6000 info@datastax.com

© DataStax | Privacy policy | Terms of use

DataStax, Titan, and TitanDB are registered trademarks of DataStax, Inc. and its subsidiaries in the United States and/or other countries.

Apache, Apache Cassandra, Cassandra, Apache Tomcat, Tomcat, Apache Lucene, Apache Solr, Apache Hadoop, Hadoop, Apache Pulsar, Pulsar, Apache Spark, Spark, Apache TinkerPop, TinkerPop, Apache Kafka and Kafka are either registered trademarks or trademarks of the Apache Software Foundation or its subsidiaries in Canada, the United States and/or other countries.

Kubernetes is the registered trademark of the Linux Foundation.

landing_page landingpage