monolayer Docs
monolayer Docs
Introduction

Getting Started

Install monolayer in your AWSAdd a GitHub App

User Guide

OverviewCreate a Project
OverviewApplication Metrics and LogsDatabasesStorage BucketsBackground TasksCrons
Project Playground Sessions

Platform

Deployment ArchitectureProcfile

Other

Feedbackmonolayer SDK Docsmonolayer.dev
ProjectsEnvironments

Databases

Monitor deployed databases, and manage PostgreSQL workloads using Database Studio.

Environment Databases and Caching

This chapter describes how to monitor and manage the stateful database and cache resources provisioned in your environments.

About Deployed Databases

monolayer provisions database and cache resources inside your environment network based on your application's software development kit (SDK) configuration. Supported resources include PostgreSQL databases on Amazon Aurora Serverless v2 and Redis caches on Amazon ElastiCache.

Monitoring and Performance Metrics

The Databases page shows active database workloads and Amazon CloudWatch metrics, including active connections and central processing unit (CPU) utilization.

NOTE: If your application does not define database storage, the page displays an empty state with a link to the monolayer SDK documentation.

Database Studio

The Database Studio is an integrated database management interface in the monolayer control plane. It provides secure, direct access to your deployed PostgreSQL database workloads. You can inspect table structures, modify rows, and run raw SQL statements without setting up an external database client or configuring a manual virtual private network (VPN) connection.

The Database Studio provides three primary capabilities to help you manage your storage:

  • Table Browser: Use the visual data grid to explore database schemas, sort columns, paginate results, edit cells inline, and manage rows.
  • SQL Editor: Use the monospaced editor to write queries with multiple tab support, syntax highlighting, query execution metrics, and localized history.
  • External Credentials Generator: Use the security helper to generate temporary Identity and Access Management (IAM) credentials for external desktop clients.

Monitoring Database Performance

When your application defines and deploys at least one database workload, you can use the databases dashboard to review health signals, inspect active connections, and track CPU utilization.

  1. Click Projects in the global sidebar.
  2. Click your target project.
  3. Click the target environment in the projects list.
  4. Click Databases in the environment sidebar.
  5. Locate the target Postgres or Redis card.
  6. Inspect the active connections chart and CPU utilization graph.

The page displays real-time database metrics for your selected workload.

Accessing Database Studio

When your project has a deployed PostgreSQL database workload configured through the monolayer SDK, you can open the Database Studio using the environment sidebar.

  1. Click Projects in the global sidebar.
  2. Click your target project.
  3. Click the target environment in the projects list.
  4. Click Databases in the environment sidebar.
  5. Click the Database Studio tab on the target Postgres card.

Once opened, the interface displays the Table Browser tab as your default view.

Browsing and Modifying Tables

If your database contains at least one table in your selected schema, you can use the Table Browser to inspect table data, edit column values, or insert new records.

  1. Choose your target schema from the schema pop-up menu.
  2. Click your target table in the table sidebar list.
  3. Double-click any cell to edit its value inline.
  4. Press Enter to save your changes to the cell.
  5. Click Add Row to insert a new record. Type the field values, and then click Save.
  6. Click Delete Row in the actions column of a row to permanently remove that record.

The Table Browser automatically commits your changes and refreshes the data grid.

Querying Data with the SQL Editor

You can use the SQL Editor to execute raw PostgreSQL statements and review query execution metrics. Before executing your statements, verify that they match PostgreSQL syntax standards.

  1. Click the SQL Editor tab in the Database Studio.
  2. Click the Plus (+) button to create a new query tab if needed.
  3. Type your PostgreSQL query in the monospaced editor panel.
  4. Click the Play button to execute your SQL statement.

The results pane displays the returned rows, the total row count, and the execution time in milliseconds. If the query alters the database schema, the studio automatically refetches your database schema.

Generating External Credentials

If your local desktop client supports SSL-required connections, you can generate temporary credentials to connect applications like pgAdmin or DBeaver to your private database.

  1. Click Credentials in the top bar of the Database Studio.
  2. View the generated connection details in the credentials dialog.
  3. Click the Copy button next to each parameter to copy the values.
  4. Click Close when you are finished configuring your external SQL client.

The password IAM token expires in 15 minutes. If your local client disconnects after 15 minutes, you must generate a new credential token.


Databases Reference

This section provides definitions and requirements for the Database Studio connection parameters and system resources.

Connection Parameters

The following parameters are required to configure an external database client:

Database (string) The specific target database name within the PostgreSQL instance.

Host (string) The private Domain Name System (DNS) endpoint of the database cluster.

Password (IAM Token) (string) The short-lived IAM-signed database authentication token.

Port (integer) The network port used to connect to the database. The default PostgreSQL port is 5432.

Username (string) The database account name authorized to perform database operations.

Application Metrics and Logs

Monitor application metrics and logs for a deployed environment.

Storage Buckets

Monitor object storage buckets, object counts, and storage size for an environment.

On this page

Environment Databases and CachingAbout Deployed DatabasesMonitoring and Performance MetricsDatabase StudioMonitoring Database PerformanceAccessing Database StudioBrowsing and Modifying TablesQuerying Data with the SQL EditorGenerating External CredentialsDatabases ReferenceConnection Parameters