Quickstart a Server

Before you begin

Install Tabsdata

tdkserver quickstart bundles initializing, creating, and starting a Tabsdata server into a single command, using a default configuration for compute and storage.

Set the Tabsdata index

Temporary

quickstart builds the instance its own Python environment and installs the same Tabsdata version into it, so it needs the Tabsdata index in its environment. Export these in the same terminal before running it, and keep them set through instance creation and the instance's first run:

macOS / Linux

export UV_INDEX=https://pypi.tabsdata.com/simple/
export UV_INDEX_STRATEGY=unsafe-best-match

Windows (PowerShell)

$env:UV_INDEX = "https://pypi.tabsdata.com/simple/"
$env:UV_INDEX_STRATEGY = "unsafe-best-match"

Dropping them before the instance has created and run once leaves the server unable to resolve Tabsdata. Tabsdata 2.0.0 is not on PyPI yet, held up by an operational limit on uploads, so this is required until the packages reach PyPI.

Start the Tabsdata server

tdkserver quickstart initializes and deploys a Tabsdata Instance. The command should take around 30 seconds to fully execute.

Anthropic

tdkserver quickstart --anthropic-key $ANTHROPIC_KEY

OpenAI

tdkserver quickstart --openai-key $OPENAI_KEY

note

If you plan to use the MySQL or PostgreSQL CDC connectors, they need database drivers that Tabsdata cannot redistribute. Pass a requirements file with --reqs-td, as described in Installing Third-Party Database Drivers. Adding them later means re-running the installation.

Check Tabsdata server status

View all your Tabsdata Instances

tdkserver list

Output

Instances
┌──────────┬──────────────────────────────────────────────────┬──────────┬─────────┬─────────┬─────────┬─────────────────┬───────────────┬───────────────────────┐
│ Name     │ Folder                                           │ Provider │ Version │ State   │ Status  │ API Server Port │ Database Port │ API Server URL        │
├──────────┼──────────────────────────────────────────────────┼──────────┼─────────┼─────────┼─────────┼─────────────────┼───────────────┼───────────────────────┤
│ tabsdata │ ~/.tabsdata/instances/tabsdata │ kminus   │ 2.0.0   │ created │ Running │ 2457            │ 2460          │ http://localhost:2457 │
└──────────┴──────────────────────────────────────────────────┴──────────┴─────────┴─────────┴─────────┴─────────────────┴───────────────┴───────────────────────┘

View the status of the Tabsdata Instance you just deployed.

tdkserver status

Output

Deployments                              
┌───────────────┬─────────┬───────┬─────┐
│ Name          │ Status  │ Ready │ Age │
├───────────────┼─────────┼───────┼─────┤
│ srv-aiagent   │ Running │ 1/1   │ 15s │
│ srv-apiserver │ Running │ 1/1   │ 15s │
│ srv-database  │ Running │ 1/1   │ 24s │
└───────────────┴─────────┴───────┴─────┘
Pods                                                      
┌────────────────────────────────┬─────────┬───────┬─────┐
│ Name                           │ Status  │ Ready │ Age │
├────────────────────────────────┼─────────┼───────┼─────┤
│ srv-aiagent-7476c88484-4klx8   │ Running │ 2/2   │ 15s │
│ srv-apiserver-56bbbb559d-8cnxl │ Running │ 1/1   │ 15s │
│ srv-database-fd4f8f85-dsxcj    │ Running │ 1/1   │ 24s │
└────────────────────────────────┴─────────┴───────┴─────┘
CronJobs                                                            
┌──────────────────┬─────────┬─────────────┬─────────────────┬─────┐
│ Name             │ Status  │ Expression  │ Explanation     │ Age │
├──────────────────┼─────────┼─────────────┼─────────────────┼─────┤
│ srv-aiembeddings │ Running │ */5 * * * * │ Every 5 minutes │ 6s  │
│ srv-aimetadata   │ Running │ */5 * * * * │ Every 5 minutes │ 6s  │
└──────────────────┴─────────┴─────────────┴─────────────────┴─────┘
Jobs                                             
┌────────────────┬──────────┬─────────────┬─────┐
│ Name           │ Status   │ Completions │ Age │
├────────────────┼──────────┼─────────────┼─────┤
│ ini-inspector  │ Complete │ 1/1         │ 16s │
│ ini-venvloader │ Complete │ 1/1         │ 17s │
└────────────────┴──────────┴─────────────┴─────┘

tip

tdkserver commands usually require an --instance flag that specifies the specific instance you want to interact with. If no --instance flag is passed, Tabsdata defaults the instance name to tabsdata

Log in

tdk login --server localhost --user admin --password tabsdata

Or access the UI at http://localhost:2457/login

What is Quickstart

quickstart bundles initializing, creating, and running a server using a default configuration. For custom deployment, do Initialize a Server, Create a Server, and Start a Server.