Skip to content
TerraScale Documentation

Database Management

Manage your TerraScale databases through the web dashboard with an intuitive visual interface.

Creating a Database

Section titled “Creating a Database”

Step 1: Open Create Dialog

Section titled “Step 1: Open Create Dialog”

Click “Create Database” from the dashboard home page or navigate to Databases and click the create button.

Step 2: Configure Database

Section titled “Step 2: Configure Database”

Enter your database configuration:

FieldDescriptionRequirements
Database NameUnique identifierLowercase letters, numbers, hyphens only
RegionGeographic locationSelect from dropdown
Automatic BackupsDaily backup scheduleOptional, configurable retention
Deletion ProtectionPrevent accidental deletionOptional, recommended for production

Step 3: Create

Section titled “Step 3: Create”

Click “Create Database” to provision your database. It will be ready within seconds and appear with “Active” status.

Database List

Section titled “Database List”

The Databases page shows all your databases with:

ColumnDescription
NameDatabase identifier (click to open details)
RegionGeographic location
StatusActive, Creating, or Deleting
CreatedCreation timestamp
ItemsTotal item count
StorageStorage used
Section titled “Filtering and Search”
  • Use the search box to filter by database name
  • Sort by any column by clicking the header
  • Filter by region or status

Database Details

Section titled “Database Details”

Click on any database to view its detail page with three tabs:

Overview metrics for your database:

  • Item Count: Total number of items stored
  • Storage Used: Current storage consumption
  • Read Units: Read capacity consumed
  • Write Units: Write capacity consumed
  • Recent Activity: Graph of operations over time

Query Explorer

Section titled “Query Explorer”

The built-in Query Explorer allows you to run queries directly in your browser:

Running a Query

Section titled “Running a Query”
  1. Navigate to your database’s Explorer tab
  2. Write your query in the editor
  3. Click “Execute” or press Ctrl+Enter
  4. View results in the JSON viewer below

Example Queries

Section titled “Example Queries”
// Get a single item
{
  "operation": "GetItem",
  "pk": "user#123",
  "sk": "profile"
}
// Query items by partition key
{
  "operation": "Query",
  "pk": "user#123",
  "skCondition": {
    "operator": "begins_with",
    "value": "order#"
  }
}

Query Editor Features

Section titled “Query Editor Features”
FeatureDescription
Syntax HighlightingJSON syntax colors for readability
Auto-formattingFormat JSON with Ctrl+Shift+F
Error IndicatorsRed underlines for syntax errors
Line NumbersEasy reference for debugging
Query HistoryAccess recent queries from dropdown

Database Settings

Section titled “Database Settings”

Automatic Backups

Section titled “Automatic Backups”

Enable daily automated backups:

  1. Navigate to database Settings tab
  2. Toggle Automatic Backups on
  3. Set Retention Period (7, 14, or 30 days)
  4. Click Save

Backups run daily and can be restored by contacting support.

Deletion Protection

Section titled “Deletion Protection”

Prevent accidental database deletion:

  1. Navigate to database Settings tab
  2. Toggle Deletion Protection on
  3. Click Save

When enabled, the delete button is disabled. You must first disable protection to delete the database.

Deleting a Database

Section titled “Deleting a Database”

To delete a database:

  1. Navigate to the database’s Settings tab
  2. Ensure Deletion Protection is disabled
  3. Scroll to Danger Zone
  4. Click “Delete Database”
  5. Type the database name to confirm
  6. Click “Delete”

Deletion is permanent and cannot be undone.

Best Practices

Section titled “Best Practices”

Production Databases

Section titled “Production Databases”
  • Enable Deletion Protection for all production databases
  • Enable Automatic Backups with 30-day retention
  • Use descriptive names like prod-users or staging-orders

Development Databases

Section titled “Development Databases”
  • Use naming conventions like dev-* or test-*
  • Consider shorter backup retention to save storage
  • Clean up unused databases regularly

Naming Conventions

Section titled “Naming Conventions”
EnvironmentPatternExample
Productionprod-{service}prod-users
Stagingstaging-{service}staging-orders
Developmentdev-{service}dev-inventory
Testingtest-{feature}test-auth-flow

Next Steps

Section titled “Next Steps”