> ## Documentation Index
> Fetch the complete documentation index at: https://docs.getcargo.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Overview

> Set up and manage a system of record (SOR) — the authoritative synced copy of a source system you query and migrate from the CLI.

A **system of record** (SOR) is an authoritative, synced copy of a source system (a CRM or warehouse) that Cargo keeps up to date so you can query it, migrate its schema, and cut over to new versions safely. The `cargo-ai system-of-record` domain manages the full lifecycle.

## Connect a warehouse

Cargo ships with a **default managed BigQuery** warehouse, so you can start immediately. To bring your own warehouse, follow the setup guide for your provider — it walks through the permissions, credentials, and the **Workspace settings → System of record** form:

<CardGroup cols={2}>
  <Card title="BigQuery" icon="google" href="/reference/system-of-record/bigquery">
    Use Cargo's default BigQuery or connect your existing Google Cloud project (service account, storage bucket, scope).
  </Card>

  <Card title="Snowflake" icon="snowflake" href="/reference/system-of-record/snowflake">
    Connect your existing Snowflake instance (roles, RSA key, IP allowlist).
  </Card>
</CardGroup>

Once connected, manage the SOR lifecycle from the CLI.

## Create and inspect

```bash theme={null}
cargo-ai system-of-record sor list
cargo-ai system-of-record sor get <sor-uuid>
cargo-ai system-of-record sor create --kind <kind> --config '{ ... }'
cargo-ai system-of-record sor update --uuid <sor-uuid> --config '{ ... }'
```

## Migrate and cut over

Schema changes are staged as a migration, then promoted with a cutover so live reads switch atomically:

```bash theme={null}
cargo-ai system-of-record sor migrate <sor-uuid>   # stage a schema change
cargo-ai system-of-record sor cutover <sor-uuid>   # promote it live
```

## Query the synced data

```bash theme={null}
cargo-ai system-of-record client get-documentation <slug>      # queryable schema
```

## Monitor sync health

```bash theme={null}
cargo-ai system-of-record log list
cargo-ai system-of-record log get-metrics --from 2025-01-01 --to 2025-01-31
```

## Using the UI

The workspace also surfaces SOR status, migrations, and sync logs visually — use the CLI for scripted setup and migrations, and the UI to review sync health at a glance.
