catalog

surrealctl catalog browses the platform catalogues: the regions, instance types, versions and billing countries SurrealDB Cloud offers. These are the slugs instance create and instance update expect.

surrealctl catalog <COMMAND> [OPTIONS]

These are nouns rather than list verbs, because a catalogue has exactly one thing you can do with it. None takes a positional argument, none takes --org, and none carries any flag beyond the list presentation flags.

surrealctl catalog regions

List the regions instances can be deployed in.

surrealctl catalog regions [OPTIONS]

This command takes no positional arguments and no options of its own. Column ids are slug and description, with flag under --wide.

surrealctl catalog regions

SLUG        DESCRIPTION
aws-euw1    Europe (Ireland)
aws-use1    US East (N. Virginia)
aws-usw2    US West (Oregon)

surrealctl catalog regions --columns slug --no-header

The slug is what --region accepts.

surrealctl catalog instance-types

List the instance types available on the platform.

surrealctl catalog instance-types [OPTIONS]

This command takes no positional arguments and no options of its own. Column ids are slug, category, cpu, memory, units, price_hour, storage and enabled, with display_name, restricted and description under --wide.

surrealctl catalog instance-types

surrealctl catalog instance-types --sort price_hour

The slug is what --type accepts. Prices stay in integer minor units under --json.

The enabled column is left unset here, because whether a type is available to you is a property of your organisation's plan rather than of the platform — check org plans, or price a specific combination with instance estimate.

surrealctl catalog storage-types

List the storage instance types available on the platform.

surrealctl catalog storage-types [OPTIONS]

This command takes no positional arguments and no options of its own. The columns are the same as instance-types.

surrealctl catalog storage-types

An empty list is a success, and says why on stderr:

No storage instance types are offered. Distributed storage may not be available here.

surrealctl catalog instance-versions

List the SurrealDB versions instances can run.

surrealctl catalog instance-versions [OPTIONS]

This command takes no positional arguments and no options of its own. The single column id is version.

surrealctl catalog instance-versions

surrealctl catalog instance-versions --limit 1 --no-header

The API's own order is newest-first and is left alone. --sort version sorts as strings, so 3.10.0 would come before 3.9.0 — prefer the default order when you want the newest release.

An empty list should not happen, and says so:

The API returned no versions, which should not happen. Try again, or report it.

surrealctl catalog billing-countries

List the countries billing details can be registered in.

surrealctl catalog billing-countries [OPTIONS]

This command takes no positional arguments and no options of its own. Column ids are code and name.

surrealctl catalog billing-countries

surrealctl catalog billing-countries --json | jq -e '.[] | select(.code == "IE")' > /dev/null

Related pages

• •

  instance create — where these slugs are used

• •

  org plans — the organisation-scoped subset

• •

  instance estimate — pricing a type and region before committing to it

• •

  Overview — the rest of the reference

• •

  SurrealDB CLI — for working with the data inside an instance