Skip to content

Quickstart

This page takes you from nothing to a working query against NamiDB Cloud in a few minutes. To run the engine yourself instead, see Self-hosted.

1. Create an account and an organization

  1. Go to app.namidb.com/signup. Sign up with your name, email and a password (at least 10 characters), or with GitHub or Google when they are offered.

  2. Confirm your address. The email carries a link and a 6-digit code; either one works, once, for 15 minutes.

  3. Name your organization. The organization is your workspace: it owns the databases, API keys, members and billing. You can also pick where its storage lives, or keep the default (closest to you).

New organizations start on the Free plan. Nothing is charged until an owner picks a paid plan and completes checkout. See Billing.

2. Create a database

In the console, open Databases → Create database and name it movies. Names use lowercase letters, numbers, - and _, start with a letter or a number, and are at most 63 characters.

The database page opens on its Connect tab, which shows the HTTPS endpoint and the Bolt URI with ready-to-copy snippets. An empty database also offers Load sample dataset in the Query tab: a small movies graph you can try queries on.

3. Create an API key

Open API keys → Create key:

  • Name: something that says where it is used, such as quickstart.
  • Access: Read & write for this guide. Use Read only for anything that only reads.
  • Databases: All databases, or only movies.
  • Expires: 90 days by default.

The key looks like nmdb_live_… and is shown once. Copy it into an environment variable now:

Terminal window
export NAMIDB_API_KEY=nmdb_live_…

NamiDB stores only a keyed hash of it. If you lose it, revoke it and create a new one. More in API keys and management tokens.

4. Run your first query

Terminal window
curl https://db.namidb.com/v1/movies/cypher \
-H "Authorization: Bearer $NAMIDB_API_KEY" \
-H "Content-Type: application/json" \
-d '{"query": "CREATE (:Movie {title: $title, released: $year})", "params": {"title": "Heat", "year": 1995}}'
curl https://db.namidb.com/v1/movies/cypher \
-H "Authorization: Bearer $NAMIDB_API_KEY" \
-H "Content-Type: application/json" \
-d '{"query": "MATCH (m:Movie) RETURN m.title AS title, m.released AS year"}'
{"columns": ["title", "year"], "rows": [{"title": "Heat", "year": 1995}]}

The first query after a quiet period can take a moment while the database wakes up. The SDKs and drivers wait for it; see Scale to zero.

5. Look at it in the console

Open the database’s Query tab and run:

MATCH (m:Movie) RETURN m

Switch the result to Graph to see the nodes, or Table and JSON for the raw values. The Metrics tab shows reads and writes as they happen, and Usage shows them against your plan’s allowance.

Next steps