TraceDB Examples

Split Checkpoint

Status: SDK example boundary active after the Trace-DB organization split.

Checkpoint plan:

1. Keep this repository focused on verified, runnable examples for released or release-candidate SDK surfaces.
2. Treat each example README as part of the verification contract: prerequisites, run command, verification command, expected receipt, and cleanup notes.
3. Add new examples only when the documented verification path can run in a lightweight local smoke or a remote-offloaded validation job.

Registry-backed quickstarts cover the current TraceDB v0 HTTP SDK workflows for TypeScript (@tracedb/sdk on npm), Python (tracedb on PyPI), and Rust (tracedb-sdk on crates.io). Each example targets a running TraceDB server and exits non-zero on failure.

This repository contains SDK examples only. It does not claim managed-cloud readiness, hosted-alpha readiness, SQL compatibility, benchmark wins, production SLA, or example coverage that is not checked in here. It must not contain hosted-service internals, operator-console flows, production credentials, provider-specific deployment automation, or private SaaS control-plane code.

Examples

Language	Directory	Source
TypeScript	typescript-quickstart/	Generated client construction and health request
Python	python-quickstart/	Generated client construction and health request
Rust	rust-quickstart/	Generated client construction and health request

Requirements

Each example directory includes:

• README.md with what the example demonstrates.
• Exact prerequisites and commands.
• A verification command that exits non-zero on failure.
• The TraceDB server/SDK version or protocol lock it was verified against.
• No secrets, real customer data, or network calls unless explicitly documented.

Proposal Checklist

Before adding a new example, copy EXAMPLE_TEMPLATE.md into the new example directory and fill in:

• The exact TraceDB server or SDK version/protocol lock used for verification.
• A single setup path from a fresh checkout.
• A run command and a separate verification command.
• Expected output or receipt fields.
• Cleanup instructions for local ports, temp directories, and generated files.
• Any network, credential, or external-service dependency.

Do not claim a tutorial is verified until its verification command has been run against the repo layout it documents.

Layout

typescript-quickstart/
  README.md
  quickstart.ts
python-quickstart/
  README.md
  http_smoke.py
rust-quickstart/
  README.md
  Cargo.toml
  Cargo.lock
  quickstart.rs