Workspaces

A workspace is a container for your data views. Each workspace can optionally connect to a database and holds one or more views that define how your data is structured and displayed.

Workspace List

The workspace overview shows all workspaces in your organization. Each workspace displays its name, description, status badge, and view count.

Creating a Workspace

1. Click Create Workspace (requires Admin or Owner role)
2. Fill in the workspace details:
   • Name — Display name (required, minimum 2 characters)
   • Slug — URL-friendly identifier (auto-generated from name, or enter your own)
   • Description — Optional description
3. Optionally configure a database connection (see below)
4. Click Create

Workspace Detail

Click a workspace to see its detail page, which includes:

• Header — Name, description, slug, and status badge
• Statistics — Total views, schema status, team members, recent activity
• Quick Actions — Invite members, change access mode, connect database

Schema Drift Detection

If your workspace is connected to a database, SchemaStack can detect when the database schema has changed:

• In Sync — Workspace metadata matches the database
• Drift Detected — Changes found (columns added, modified, or removed)

When drift is detected, a warning banner appears with options to Synchronize Schema or View Detailed Changes.

You can also manually trigger a drift check from the workspace detail page.

Reset Workspace

Organization Admins and Owners can reset all view columns to match entity definitions. This is useful after major schema changes.

Database Connection

Each workspace can connect to an external database.

Supported Databases

Vendor	Default Port
PostgreSQL	5432
MySQL	3306
SQL Server	1433

Configuring a Connection

1. Open Workspace Settings
2. Enable the database connection toggle
3. Fill in the connection details:
   • Vendor — Select your database type
   • Host — Database server address
   • Port — Connection port (auto-filled based on vendor)
   • Database Name — Name of the database
   • Username and Password — Database credentials
   • Additional Parameters — Optional (e.g., sslmode=require)
4. Click Test Connection to verify
5. Click Save Changes

Editing an Existing Connection

If a database is already configured, you'll see the current connection info (database name, host, port, vendor). Click Edit to modify the configuration. When updating, username and password are optional — leave them blank to keep the existing credentials.

Schema Import

After connecting a database, you need to import the schema to start working with your data.

First-Time Import

1. Click Import Schema on the workspace detail page
2. SchemaStack reads the database and presents a list of available tables
3. Select the tables you want to include in the workspace
4. Click Import
5. Columns and relationships are created based on the database schema

Syncing After Database Changes

When your database schema changes (new tables, altered columns), sync the workspace to pick up the changes:

1. Click Sync Schema on the workspace detail page (or respond to a drift detection warning)
2. Review the proposed changes — added, modified, and removed tables/columns are listed
3. Confirm to apply the changes

Syncing does not delete any data in SchemaStack. Removed columns are hidden but can be restored.

Access Modes

Workspaces support different access modes to control what operations are allowed:

Mode	Data Reads	Data Writes	Schema Changes	Who Can Access
Active	Yes	Yes	Yes	Everyone
Schema Locked	Yes	Yes	No	Everyone
Read Only	Yes	No	No	Everyone
Design	Yes	No	Yes	Everyone
Maintenance	No	No	No	Admins only

To change the access mode:

1. Click Change Mode on the workspace detail page (or in settings)
2. Select the desired mode
3. Confirm the change

A status banner appears on the workspace when it's in any mode other than Active.

Workspace Settings

General Settings

• Name — Workspace display name
• Slug — URL identifier (lowercase, alphanumeric, hyphens only)
• Description — Optional description

API Keys

Manage API keys for programmatic access to workspace data.

• Create — Click New API Key, enter a description, and copy the generated key. The key is only shown once.
• View — The API Keys list shows each key's description, creation date, and last-used date.
• Revoke — Click Revoke next to a key to permanently disable it. Revoked keys cannot be restored.

See API Authentication for how to use API keys in requests.

Storage Settings

Configure S3-compatible storage for file and image uploads.

• Bucket — S3 bucket name (required)
• Region — AWS region (required)
• Access Key ID / Secret — Credentials for the bucket. Leave blank when updating to keep existing credentials.
• Custom Endpoint — For S3-compatible providers like MinIO, Backblaze B2, etc.
• Path-style access — Use path-style URLs (required by some providers)
• Presigned URL mode — Generate presigned URLs for direct file access
• File Path Template — Customize the S3 key structure for uploaded files. See File Path Templates for details.

Danger Zone

• Delete Workspace — Permanently removes the workspace and all its views. A confirmation dialog will appear before deletion.