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

DataStax Astra DB Serverless 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 private endpoints
        • AWS Private Link
        • Azure Private Link
        • GCP Private Endpoints
        • Connecting custom DNS
      • 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
        • Bring Your Own Key
          • BYOK AWS Astra DB console
          • BYOK GCP Astra DB console
          • BYOK AWS DevOps API
          • BYOK GCP DevOps API
        • 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
        • Export metrics to third party
          • Export metrics via Astra Portal
          • Export metrics via DevOps API
        • Manage access lists
        • Manage multiple keyspaces
        • Using multiple regions
        • Terminate your database
      • Managing with DevOps API
        • Managing database lifecycle
        • Managing roles
        • Managing users
        • Managing tokens
        • Managing BYOK AWS
        • Managing BYOK GCP
        • Managing access list
        • Managing multiple regions
        • Get private endpoints
        • AWS PrivateLink
        • Azure PrivateLink
        • GCP Private Service
    • Astra CLI
    • DataStax Astra Block
      • FAQs
      • About NFTs
      • DataStax Astra Block for Ethereum quickstart
    • 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 Serverless Documentation
  • Managing
  • Managing your database

Managing your Astra DB database

As a database administrator, you can manage your database. This includes the following tasks:

Create your database

Complete the following steps to create and launch your DataStax Astra DB database.

Procedure

  1. In your Astra DB dashboard, select Create Database.

    If you need more options, contact DataStax Support.
  2. Enter your basic details:

    • Database Name: Name your database something meaningful. The database name cannot be altered after the database is created. Use only alphanumeric characters; there is no character limit.

    • Keyspace Name: Name your keyspace to reflect your data model. You cannot name your keyspace “dse” or “system”. Use only alphanumeric characters and no more than 48 total characters.

  3. Select your cloud provider and then the region where you want to launch your database from the region menu, which reflects the available regions based on your selected cloud provider.

    Regions with the lock symbol require payment. When selecting a region with a lock, you have to option to upgrade to a Pay-as-you-go-plan. If you select a region without a lock, you are still on the Free plan.

    .

    You can preview the costs for the database based on read and write requests, storage, and data transfer.
  4. Select Create Database. The Database Created! page appears.

    database created

    1. Click Download Token Details to download tokens generated for you. You can also click the clipboard in the Your Token box to copy these tokens.

    2. Click Get Instructions for quick explanations on how to complete certain tasks and links for more information.

      .

    3. Click X at the top right of the screen to return to your Astra DB dashboard.

  5. You will see a screen highlighting your selected plan. Select Continue.

Results

You are redirected to your Organization Dashboard. The new database and status is shown under Databases. You will receive an email when your database creation is complete. Select the database name to manage or connect with your new database.

View your databases

View all databases in your organization, and select a database to view detailed information about the database.

The Dashboard shows all of your databases within your organization, including databases you created and databases created by other team members. From here, you can select an individual database name to manage and connect those databases.

Selecting a database in DataStax Astra DB provides access to detailed information about the database. You can view the keyspaces, size and location of the database, and the estimate cost per hour.

  1. Open a browser, navigate to Astra DB, and log in.

  2. On the Dashboard page, select the database name to access the Overview page for your selected database.

    You can only view connection details and database management operations for databases that you created.

  3. On the Overview tab, you can see several database details:

    • Database Name

    • Status

    • Usage for current billing period

      • Read Requests

      • Write Requests

      • Storage Consumed

      • Data Transfer

    • Compute Size [Only for Classic tier databases]

    • Replication Factor [Only for Classic tier databases]

    • Current Capacity [Only for Classic tier databases]

    • Regions

      • Provider

      • Area

      • Region

      • Datacenter ID

      • Region Availability

    • Keyspaces

Database statuses

Your database can exist in a range of statuses. These statuses vary based on the actions you take within your database.

To see the system status of Astra, see https://status.astra.datastax.com/.

To see the status of a specific database, view your database Dashboard.

All databases

Active

Your database is available and ready to use.

Initializing

You’ve made your database selections. It should be ready for you to use soon.

Terminating/Terminated

You have terminated your database, which means your database and all data on your database will be removed. Your database is no longer available.

Error

Something is wrong with your database. Contact DataStax Support.

Maintenance

When a database is moving into hibernated or restarting from hibernated, your database will display that it is in the Maintenance status.

Hibernated

When an Astra DB database on the Free plan has been unused for more than 48 hours, it will automatically enter the Hibernated status.

It may take a few minutes for your hibernated Astra DB database to resume (return to Active status).

Database hibernation only occurs on the Free plan. Hibernated does not occur on the Astra DB paid plans. To avoid Hibernated, and to take full advantage of additional Astra DB functionality, upgrade from the Free plan to a Pay As You Go plan, or to an Enterprise plan. For details, see Pricing and billing.

To view the status of any database within your organization,

  1. Open your Astra DB dashboard.

    1. If you have more than one database in a hibernated status, a banner appears at the top of the screen prompting you to click Resume Databases.

    Astra DB console Resume DataBases message

  2. To activate a specific database, navigate to the Databases table on your dashboard. Select the database(s) to activate.

    1. Click Resume to activate a hibernated database.

    2. Hover Hibernated for a quick definition of this term.

    3. Click the database name to open it, but remain in the hibernated status.

    hibernate db

Monitor your databases

View connection details, performance metrics, and health details for databases in your organization.

The Databases page provides an overview of all databases in your organization, including the databases you created and databases created by other team members. However, only a database creator can make changes to a database and view its connection details, which can be shared manually with other team members.

View your databases

View all databases in your organization, and select a database to view detailed information about the database.

The Dashboard shows all of your databases within your organization, including databases you created and databases created by other team members. From here, you can select an individual database name to manage and connect those databases.

Selecting a database in DataStax Astra DB provides access to detailed information about the database. You can view the keyspaces, size and location of the database, and the estimate cost per hour.

  1. Open a browser, navigate to Astra DB, and log in.

  2. On the Dashboard page, select the database name to access the Overview page for your selected database.

    You can only view connection details and database management operations for databases that you created.

  3. On the Overview tab, you can see several database details:

    • Database Name

    • Status

    • Usage for current billing period

      • Read Requests

      • Write Requests

      • Storage Consumed

      • Data Transfer

    • Compute Size [Only for Classic tier databases]

    • Replication Factor [Only for Classic tier databases]

    • Current Capacity [Only for Classic tier databases]

    • Regions

      • Provider

      • Area

      • Region

      • Datacenter ID

      • Region Availability

    • Keyspaces

View health and metrics

Select a database to view health metrics and performance information. When selecting a database, you can view health metrics that include information regarding latency and throughput to the database. These metrics provide insights into the performance of the database and how workloads are distributed.

When viewing information about a database on the Health page, choose the region from the dropdown available at the right to view the health metrics of the database particular to that region. This is only applicable for multi-region databases.

Procedure

  1. Open a browser, navigate to DataStax Astra DB, and log in.

  2. On the Databases page, select the database name to view details for. Details for the database display on the Overview tab.

  3. To view health metrics for the database, select the Health tab.

  4. Select the time period to display in the health metrics for.

Results

Metrics for the database display in the Grafana dashboard embedded in Astra Portal. To view more granular metrics, hover over a specific time in the graph. Read and write latencies display in nanoseconds.

Health

View health dashboard in a full browser window

  1. Select Cycle View Mode in the upper right corner. This selection displays the cycle view.

  2. Press Esc.

  3. Select the share icon in the upper left corner.

  4. Copy the URL.

  5. Paste the URL in a new browser tab or window to see the dashboard.

Export Astra DB metrics to an external system

Enterprises depend on the ability to view database health metrics in centralized systems along with their other software metrics. The Astra DB Metrics feature lets you forward Astra DB database health metrics to an external third-party metrics system. We refer to the recipient of the exported metrics as the destination system.

Introduction

The functionality provided by the Astra DB Metrics feature is often referred to as:

  • Observability

  • External monitoring

  • Third-party metrics

  • Prometheus monitoring integration

Astra DB supports exporting health metrics from its serverless databases to:

  • Prometheus

  • Open-source Apache Kafka®

  • Confluent Kafka®

  • Amazon CloudWatch

  • Splunk (via DevOps API)

  • Pulsar (via DevOps API)

  • Datadog (via DevOps API)

You can also use Grafana or Grafana Cloud as a visualization tool.

Use Astra Portal or DevOps API to export metrics

You can export Astra DB health metrics via Astra Portal or the DevOps API. For details, see:

  • Export metrics via Astra Portal

  • Export metrics via DevOps API

Using Splunk, Pulsar, or Datadog as the destination for exported Astra DB health metrics is supported via the DevOps API, but not in Astra Portal at this time. See Export metrics via DevOps API.

Manage access list for public endpoints

Use access lists to limit what public endpoints are able to access your database. You can choose to restrict access in one of two ways:

  • Restrict access to specific IP addresses

  • Restrict access to a range of IP addresses using Classless Inter-Domain Routing (CIDR)

When Access List is configured and active, access to these endpoints is restricted:

  • CQL, GraphQL, and REST

  • GraphQL Playground

  • Swagger

  • CQLsh

This information applies to only serverless databases.

You can also manage your access list using the DevOps API.

If you are using the access list and restricting public access, these restrictions exclude the Astra internal site reliability controls.

Only Organization and Database Administrators for the database have permissions to manage the access list.

Restrict public access

By default, public access to your database is not restricted. Access to your database is possible via public internet.

  1. In your database Settings, select the toggle to restrict public access.

  2. Confirm your selection to Restrict Public Access.

Until you add an address to your access list, public access is still available.

Add IP address or CIDR to access list

  1. Ensure public access is restricted.

  2. Select Add Access.

  3. Select Add new endpoint.

  4. Select IP Address or CIDR from the Type menu.

    A CIDR indicates a range of IP addresses. For example, the CIDR range '192.168.0.0/16' represents the first IP address of '192.168.0.0' through the last IP address of '192.168.255.255'. The '/16' mask indicates that the first 16 bits of the IP address are static. The addresses in the CIDR range are represented by all the permutations of the last 16 bits.

  5. Enter the IP address or CIDR into the Address field.

    If you want to add you current IP address, copy it from the display and paste it into the Address field.

    All IP address must be entered in the IPv4 format, which is four decimal numbers, each ranging from 0 to 255. For example, 179.46.234.11.

  6. Optional: Add a description for the address you are adding. For example, office or home.

  7. Select Add to add the address to the access list.

It takes approximately five minutes for each address to sync and have access.

Upload list of endpoints

  1. Ensure public access is restricted.

  2. Select Add Access.

  3. Select Upload from file.

    [
      {
        "address": "10.0.0.1",
        "description": "Reader"
      },
      {
        "address": "10.0.0.1/32",
        "description": "Librarians"
      }
    ]
  4. Use the Select File button to find the JSON file with your access list to upload.

    You will see the list of addresses to be added to the access list.

  5. Select Import to add the addresses to your access list.

Import endpoints from database

You can import an access list from another Astra database. If you do not have another active Astra database, this option will not be available.

  1. Ensure public access is restricted.

  2. Select Add Access.

  3. Select Import from database.

  4. Select the active Astra database from which you want to import the addresses.

    You will see the list of addresses to be added to the access list.

  5. Select Import to add the addresses to your access list.

Enable or disable an endpoint

  1. Select the overflow menu for the address you want to enable or disable.

  2. Select Enable or Disable.

    The overflow menu will show the Disable option only when the address is enabled and the Enable option only when the address is disabled.

  3. Confirm your selection to Enable or Disable the endpoint.

Your access list remains active, even if all endpoints are disabled. If you want to allow public access, you must select the toggle to stop restricting public access.

Delete an endpoint

If you remove all of the addresses on your access list, your database will be accessible from the public internet, even if Restrict public access is selected.

  1. Select the overflow menu for the address you want to remove.

  2. Select Delete.

  3. Confirm your selection to Delete the endpoint.

It takes approximately five minutes for each address to sync and be removed from the access list.

Allow public access

If you stop restricting public access, access to your database is possible via public internet.

  1. Select the toggle to stop restricting public access.

  2. Confirm your selection to Enable public access.

Manage multiple keyspaces

In Astra, keyspaces hold the datacenter names associated with your Astra regions and defines the replication factor (3 for writes in LOCAL_QUORUM) for each datacenter. A replication factor of 3 ensures against losing your data. You can create keyspaces either with the Astra Dashboard or the DevOps API. Use the instructions below to delete a keyspace with your Astra account, if necessary.

Creating a database with multiple keyspaces allows you to create different data models for each keyspace or store unique data in unique keyspaces. Multiple keyspaces within a single region allows for an application built on a per-keyspace data model.

Adding a new keyspace

  1. Open a browser, navigate to Astra DB, and log in.

  1. On the Dashboard page, select the database name to access the Overview page for your selected database.

  1. Select Add Keyspace.

  1. Enter the name of the new keyspace.

  1. Select Save.

Your list of keyspaces displays on the Overview page for your database.

Deleting a keyspace

If you delete a keyspace, all data in that keyspace is removed and cannot be recovered.

  1. Open a browser, navigate to DataStax Astra DB, and log in.

  1. On the Dashboard page, select the database name to access the Overview page for your selected database.

  1. Select the overview menu (…​) for the keyspace you want to delete.

  1. Select Delete.

  1. In the Delete keyspace menu, type in the name of the keyspace to delete.

  1. Select Delete Keyspace.

Your list of keyspaces will be updated on the Overview page to show only the remaining keyspaces for your database.

Using multiple regions

You can replicate data to multiple regions for high availability scenarios to ensure active-active applications failover models. Multiple regions also ensure application data availability for locality purposes with the added value of cost savings.

Having multiple regions increase may your billing. For more, see Pricing and billing.

Video introduction

See this short video introduction to the Astra DB multi-region implementation:

Eventual consistency model and multi-region updates

DataStax Astra DB follows the eventual consistency model. Depending on the selected consistency level, data written to one region might not be immediately accessible to other regions in the same database.

If you are using the EACH_QUORUM consistency level for normal updates or SERIAL consistency level for Lightweight Transactions (LWT), then data is immediately accessible on all regions provided the operation successfully completes. These consistency levels are for only write requests.

For all other consistency levels, data might not be immediately accessible. The time span is normally within a few minutes to fully replicate the data. However, it could take longer, and possibly span one or more days. There are several contributing factors to the latter scenario, such as the workload volume, the number of regions, the data repair operations, and network resources.

For more, see the FAQs in this topic.

Serverless databases

Multiple regions is available on only pay as you go and annual plans.

If you are adding multiple regions to your database, you can use each region only once. You cannot add the same region to the same database more than one time.

Add a new region to your database

  1. From your database’s Dashboard, select Add Region.

    db multiregion1
  2. Select your desired region from the dropdown menu of available choices.

    You can review your selected region and its cost below the dropdown menu.

    You can add only a single region at one time.

    db multiregion2
  3. Select Add Region to add the region to your database.

After you add the new region, your new region appears in the list of regions on your database dashboard. Your existing region status will change to Maintenance, but will still be available for operations.

db multiregion3

The information displayed on the Connect page for your database is region specific.

Delete a region from your database

The information displayed on the Connect page for your database is region specific.

Removing a region is not reversible. Proceed with caution.

  1. From you database Dashboard, select the overflow menu for the database you want to delete.

  2. Select Delete.

    db multiregion5
  3. Type "delete" in the text bar.

    db multiregion6
  4. Select Delete to delete your region.

    db multiregion7

Limitations

If there are network issues between regions, the following operations might not be available or have limited availability:

  • Schema changes

  • Table truncation

  • Lightweight transactions

  • Data repair

While adding a new region, you cannot drop a table or keyspace and you cannot truncate a table.

Data sovereignty

Astra DB serverless replicates all data in the database to all of a database’s regions. By contrast, multiple keyspaces in Apache Cassandra® and DataStax Enterprise (DSE) allow a database to replicate some tables to a subset of regions. To achieve the same behavior as Cassandra or DSE, create a separate Astra DB instance that adheres to the necessary region restrictions. The database client will need to add a separate connection for the additional database and send queries to the appropriate connection depending on the table being queried.

Astra DB Serverless multi-region FAQ

While creating an Astra DB database, can I select multiple regions?

No. The workflow is to create a database with a selected region; then once the launched database reaches an Active status, you may add a region.

How many regions can I add?

The only limitation is the number of regions that are available in Astra DB. See Database Regions for the list of supported regions.

How many regions can I add or remove at a time?

The current implementation allows one addition or removal at a time.

How quickly are updates applied to all regions in the same database cluster?

It depends on several factors. Astra DB follows the eventual consistency model. As a result, data written to one region might not be immediately accessible in other regions in the same database cluster. The time span is normally within a few minutes to fully replicate the data. However, it could take longer, and possibly span one or more days. There are several contributing factors to the latter scenario, such as the workload volume, the number of regions, the data repair operations, and network resources.

Can I remove a region that I no longer need?

Yes, this action is supported with Astra DB Serverless. Exception: you cannot remove the original region selected when you created the Astra DB database. The original region can be deleted after all other regions are deleted by using the Terminate database operation.

Will I lose data when I remove a region?

No. All data in the datacenter is replicated prior to being decommissioned.

Can I park a region?

No. The best option, in this case, is to remove the region.

Can I specify replication rules by keyspace?

By default, replication is applied at the database level. With Astra DB Serverless, there is no upfront database setup costs. The replication goal may be addressed by separating workloads by database without an impact on costs.

Is the Access List configuration by region?

The Access List configuration applies at the database level.

How are backups managed?

  • Backups are taken on the region in which the database was first created.

  • The restore process follows this workflow: restore to the original region, and then add the other regions.

  • For help with restore, please contact DataStax Support.

What’s next?

See additional database management topics.

Terminating your database

When you no longer need a database, terminate it to reduce costs and streamline operations. When you terminate a database, all data is permanently deleted and cannot be recovered.

If you have administrator privileges in the DataStax Astra Portal for your team, you can contact DataStax to terminate databases that are owned by other team members. For example, if a team member leaves your organization and you want to delete their databases, contact DataStax with the names of the databases owned by that team member.

Procedure

See instructions on how to terminate a multi-region database here.

  1. Open a browser, navigate to Astra DB, and log in.

  2. From the Dashboard page, select the overflow menu for the database you want to terminate and select Terminate.

    All data in the database will be permanently deleted. You cannot restart the database. Proceed with caution.

  3. To terminate the database, type in the database name you want to terminate and select Terminate.

Results

Your database is removed from the list of available databases. You will receive an email when your database is successfully terminated.

Configure SSO for OneLogin Create your database

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