• 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

Directives

Name

Description

Arguments

@cql_column

Set type field CQL values

name: String

partitionKey: true/false

clusteringOrder: ASC/DESC

typeHint: String

@cql_delete

Conditional delete clause, with possible consistency level, serial consistency level, or targetEntity

if Exists: true/false

consistencyLevel: MutationConsistency = ALL/LOCAL_ONE/LOCAL_QUORUM

serialConsistency: SerialConsistency = LOCAL_SERIAL/SERIAL

targetEntity: String

@cql_entity

Set a type field data type

name: String

target (UDT)

@cql_increment

Set a type field that will increment on UPDATE

field to increment (counter, set, and list only): String

The default is false, meaning that the value will be appended

prepend: Boolean = false

@cql_if

Set a type field that the predicate if <field> <predicate uses to check condition for DELETE and UPDATE.

field: String predicates (EQ, GT, GTE, IN, GT, LTE, and NEQ)

@cql_index

Create a type field index

name: String

class: (org.apache.cassandra.index.sasi.SASIIndex)

type: (FULL, VALUES)

options: (mode: 'CONTAINS')

target: String

@cql_input

Identify a type as an input type

name (optional): String

@cql_insert

Add a conditional clause, consistency level, serial consistency level, or time-to-live (TTL)

ifNotExists: true/false

consistencyLevel: MutationConsistency = ALL/LOCAL_ONE/LOCAL_QUORUM

serialConsistency: SerialConsistency = LOCAL_SERIAL/SERIAL

ttl: String (interpreted in seconds)

@cql_pagingState

The paging state to inject in the query

N/A

@cql_payload

Identify a type as a payload type

N/A

@cql_select

Set response arguments pageSize, limit, with possible consistencyLevel

consistencyLevel: QueryConsistency = ALL/LOCAL_ONE/LOCAL_QUORUM/LOCAL_SERIAL/SERIAL

pageSize: Int

limit: Int

@cql_update

Set an insertion to be an update, with possible conditional clause, consistency level, serial consistency level, time-to-live (TTL), or targetEntity

ifExists: true/false

consistencyLevel: MutationConsistency = ALL/LOCAL_ONE/LOCAL_QUORUM

serialConsistency: SerialConsistency = LOCAL_SERIAL/SERIAL

ttl: String (interpreted in seconds)

targetEntity: String

@cql_where

Predicates that customize the conditions of a parameter

field: String

predicate (EQ (default), GT, GTE, IN, LT, LTE, CONTAINS)

Getting directive information

To see information on all the CQL directives available in Stargate, run the following cURL command:

curl  https://$ASTRA_CLUSTER_ID-$ASTRA_REGION.apps.astra.datastax.com:8080/graphql-files/cql_directives.graphql \
  --header "X-Cassandra-Token: $ASTRA_DB_APPLICATION_TOKEN"

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