Skip to main content
GuideServerConfigure and deploy Tabsdata servers on your machine.TutorialsConfigure data integration workflows within a running Tabsdata server.Advanced TutorialsBuild end-to-end workflows between two specific systems.API ReferenceCLI ReferenceRelease Notes
Version: 2.0.0

Install Tabsdata

Deploy a Tabsdata Server on your Machine in under 5 minutes.

Tabsdata is published as a python package, installable with pip

Requirements
  • Machine with a supported OS
    • Linux (x86)
    • macOS (Apple Silicon/ARM64)
    • Windows (x86)
  • Python 3.12
  • An LLM API key from Anthropic or OpenAI (Required for AI features)

Create a Python virtual environment​

Using a virtual environment provides a layer of isolation and prevents interference from other python environments on your machine.

conda create -n tabsdata python=3.12 -y
conda activate tabsdata

Temporary installation requirements for 2.0.0​

warning

Tabsdata 2.0.0 is temporarily hosted on the Tabsdata package index rather than PyPI due to an operational upload limit. Until 2.0.0 is available on PyPI, configure pip and uv to use the Tabsdata index and explicitly install version 2.0.0.

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

Keep these environment variables set until the Tabsdata Instance has been created and run successfully. tdkserver quickstart creates a separate Python environment within the Tabsdata server and also needs access to the Tabsdata index.

These additional steps can be removed once Tabsdata 2.0.0 is available on PyPI.

Install Tabsdata​

warning

Until 2.0.0 is fully hosted on pypi, please make sure to specify ==2.0.0 and install tabsdata-agent to enable AI features. Future releases will not have this requirement

uv pip install "tabsdata[all]"==2.0.0 tabsdata-agent==2.0.0

Set LLM key as environment variable in terminal​

export ANTHROPIC_KEY="sk-ant-..."

Start the Tabsdata server​

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

tdkserver quickstart --anthropic-key $ANTHROPIC_KEY
Some Notes on Tabsdata Server Providers

Tabsdata runs on a Kubernetes cluster, and this install uses kminus: a lightweight Kubernetes that runs pods as native processes in your Python environment instead of Docker containers, so it needs no root or admin access. The --provider option allows configuring through Amazon EKS instead. To run Tabsdata on AWS EKS, start with AWS Services Setup, then Install on EKS.

Installing Third-party Database Drivers

If you plan to use the MySQL or PostgreSQL CDC connectors, they need database drivers that Tabsdata cannot redistribute. Please review Installing Third-Party Database Drivers for more information.

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

Next: Connect an AI Agent. Point your LLM at the MCP server, then run your first pipeline.