Maincloud

import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; import { CppModuleVersionNotice } from "@site/src/components/CppModuleVersionNotice";

Maincloud is SpacetimeDB's fully managed serverless platform. It handles infrastructure, scaling, replication, and backups so you can focus on building your application. Maincloud scales to zero when your database is idle, so you only pay for what you use.

For pricing details, see the pricing page.

Prerequisites

1. Install the SpacetimeDB CLI: Install SpacetimeDB
2. Log in to link your CLI identity with your web account:

spacetime login

This opens a browser window where you sign in with your GitHub account. Once authenticated, your CLI identity is linked to your Maincloud account, and any databases you publish will appear on the web dashboard.

:::tip If you previously published a database without logging in first, your CLI identity will not be linked to your web account. Run spacetime logout followed by spacetime login to re-authenticate. :::

Publishing to Maincloud

After creating your module (see Getting Started), publish it to Maincloud:

spacetime publish my-database --server maincloud

SpacetimeDB compiles your module, uploads it, runs your init reducer (if defined), and outputs the database identity. Save this identity for administrative tasks.

To update an existing module, run the same command. SpacetimeDB hot-swaps the module code without disconnecting clients. See Automatic Migrations for details on schema changes during updates.

To clear all data and start fresh:

spacetime publish my-database --server maincloud --delete-data

Connecting Clients to Maincloud

To connect your client application to a module running on Maincloud, use https://maincloud.spacetimedb.com as the host URL and your database name as the module name:

DbConnection.builder()
  .withUri("https://maincloud.spacetimedb.com")
  .withDatabaseName("my-database")
  .build();

DbConnection.Builder()
    .WithUri("https://maincloud.spacetimedb.com")
    .WithDatabaseName("my-database")
    .Build();

DbConnection::builder()
    .with_uri("https://maincloud.spacetimedb.com")
    .with_database_name("my-database")
    .build()
    .expect("Failed to connect");

auto conn = DbConnection::builder()
    .with_uri("https://maincloud.spacetimedb.com")
    .with_database_name("my-database")
    .build();

Viewing Your Database on the Web Dashboard

After publishing, you can manage your database through the web dashboard at spacetimedb.com.

Finding your database

There are two ways to navigate to your database:

1. Direct URL: Go to https://spacetimedb.com/my-database or https://spacetimedb.com/@my-username/my-database (replacing my-database with your database name).
2. Profile page: Click your profile picture in the top-right corner of spacetimedb.com and select "My profile". All of your published databases are listed there. You can also navigate directly to https://spacetimedb.com/@your-username.

Dashboard features

The database dashboard gives you access to:

• Overview: View your database identity, name, status (Running or Paused), table and reducer counts, and energy usage. The overview also shows stats for the past 24 hours including CCU, rows per table, and transactions.
• Usage breakdown: See this month's energy consumption broken down by bytes scanned, bytes written, index seeks, CPU instructions, bandwidth, and table storage.
• Logs: View your module's log output in real time.
• SQL console: Run ad-hoc SQL queries against your database.
• SpacetimeAuth: Enable and configure the built-in authentication provider (see SpacetimeAuth).

Database Lifecycle

Maincloud databases have two states:

• Running (green dot on dashboard): The database is actively serving requests. Any client connection, reducer call, or dashboard visit will keep it in this state.
• Paused (pause icon on dashboard): The database is suspended. All data is preserved, but the database is not serving requests and does not consume energy.

Automatic suspension (Free tier)

On the Free tier, Maincloud automatically pauses databases after a period of inactivity (no client connections, no reducer calls). A paused database resumes automatically when it receives a connection or request. Startup time is typically less than one second.

On the Pro and Team tiers, databases are never automatically suspended as long as you have pay-as-you-go enabled or have not exceeded your self-set spending limit. If you want to ensure your database is always available, upgrade to the Pro or Team tier.

Manual pause and resume

You can manually pause and resume your database from the web dashboard:

1. Navigate to your database on spacetimedb.com.
2. In the left sidebar, check the Status field to see if your database is Running or Paused.
3. Click Pause Database to suspend the database, or Start Database to resume it.

Pausing a database stops all energy usage for that database. This is useful if you want to keep your data but are not actively using the database.

Deleting a Database

To permanently delete a database and all its data:

spacetime delete my-database --server maincloud

This action cannot be undone.

Next Steps

• Explore the dashboard: Visit spacetimedb.com to view your database, check logs, and run queries.
• Set up authentication: Enable SpacetimeAuth or connect a third-party OIDC provider to authenticate your users.
• Connect a client: Follow a quickstart guide to build a client that connects to your Maincloud database.
• Monitor your usage: Check your energy consumption and plan limits on the pricing page.