• Start
Sign In

Overview

Instances

What an instance is, how the Start and Scale plans differ, and where each operational task is documented.

An instance is a SurrealDB deployment that SurrealDB runs for you.

That covers provisioning, high availability, patching, backups, and version upgrades. You choose a plan, a size, and a region, then connect your application.

Every instance belongs to an organisation, which also holds members, usage, and billing. You operate instances from SurrealDB Studio, or from a terminal with surrealctl. To run and operate the server yourself, see Self-hosted.

Open SurrealDB Studio

Two plans are available. The plan you choose at deploy time fixes the topology of the instance.

PlanTopologyHow it growsStorageSuited to
StartA single nodeVertically, by moving to a larger instance typeA dedicated disk per instanceDevelopment, staging, and workloads that fit on one node
ScaleA cluster of three nodes or moreVertically and horizontally, by using larger nodes or more nodesDistributed storage shared across the clusterProduction that must survive the loss of a node

Start offers three families of instance type. Free is for trying SurrealDB out, Burstable is for low-traffic and intermittent workloads, and General purpose is for steady production traffic. Scale uses General purpose nodes.

The plan also gates some options. Configurable backup frequency is available on Scale instances only.

Current capacity ceilings and prices are on the pricing page. The plan cards in the deploy flow show what applies to your organisation. For the topology behind each plan, see Architecture.

The Instances section of SurrealDB Studio lists every instance in the organisation you are viewing. Each card shows the SurrealDB version and the region. Use the search box and the Version and Type filters to narrow a long list.

The Instances page of SurrealDB Studio for the Acme Corp organisation, listing three instance cards: api-production on SurrealDB 3.2.4, and api-staging and analytics-eu on SurrealDB 3.2.1. All three are in AWS Europe (Ireland). The page also has a search box, Version and Type filters, and a Deploy new instance button.

Selecting an instance opens its own workspace. That workspace holds a dashboard of resource use, the schema and query views, and Settings. Settings is where configuration, capabilities, versions, compute, and backups live.

surrealctl instance list prints the same list in a terminal, and --json makes it scriptable. See surrealctl instances.

You control the lifecycle of an instance with four actions.

ActionEffectWhere
DeployProvisions the instance on the chosen plan, type, and regionCreate an instance
ResizeChanges the instance type or the storage capacity in placeScaling
PauseStops compute and usage billing. Data and configuration are kept, and the instance is unreachable until you resume itConfigure an instance
DeleteDestroys the instance and everything stored in it, with no way to recover itConfigure an instance

You cannot change an instance name after deployment. Pick a name a colleague will still recognise in six months, such as api-production rather than db1.

  • Organisations: accounts, members, roles, usage, billing, and support.

  • surrealctl: the management-plane command-line tool.

  • Observability: the full metric, audit-log, and slow-query reference.

  • Self-hosted: running SurrealDB on your own infrastructure instead.

Was this page helpful?