Skip to content
ScopeDB Docs
ScopeDB Docs

ScopeDB Cloud concepts

On this page

ScopeDB Cloud is the managed ScopeDB service. You work with data through the Console, SDKs, the ScopeDB CLI, and the HTTP data API.

Core concepts

ConceptWhat it means
WorkspaceThe current Console context for a data catalog and its programmatic access. Connection values and API keys shown in the Console belong to this workspace.
ConsoleThe workspace-specific UI for exploring the catalog, running queries, connecting clients, and managing API keys.
ScopeDB API addressThe HTTPS base URL shown under its purpose label in Connect. SDKs, HTTP clients, and non-interactive CLI jobs use it as their endpoint.
API keyA secret credential for SDKs, HTTP clients, and non-interactive CLI jobs. Send it as a bearer token and keep it out of client-side applications.
CatalogThe databases, schemas, tables, and views available in the current workspace. ScopeQL operates on these objects.

Console and API responsibilities

Use the Console when you need workspace-specific information or an interactive workflow:

  • Explore to browse the catalog;
  • Query to run ScopeQL interactively;
  • Connect to copy a purpose-labeled API address and client recipe;
  • API Keys to create or revoke credentials.

Use an SDK, the CLI, or the HTTP API when an application, job, or script needs programmatic access. The documentation uses placeholders such as https://<endpoint> because the authoritative value comes from Connect in your workspace. For interactive CLI use, sign in with your ScopeDB Cloud account instead of configuring an API key.

Typical workflow

  1. Open ScopeDB Console; the current workspace is the context for the workflow.
  2. Inspect existing data in Explore or run ScopeQL in Query.
  3. For programmatic access, open Connect and copy the ScopeDB API address.
  4. Create an API key and copy its one-time secret.
  5. Configure a server-side client and verify it with SELECT 1.

Continue with Connect an application for the exact SDK and HTTP steps, or use the ScopeDB CLI to sign in interactively.