Skip to main content
GuideServerConfigure and deploy Tabsdata servers on your machine.TutorialsConfigure data integration workflows within a running Tabsdata server.API ReferenceCLI ReferenceRelease Notes
Version: 2.2.0

Quickstart a Server

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

Start the Tabsdata server​

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

export ANTHROPIC_KEY=<key>
tdkserver quickstart --config anthropic-key=env:ANTHROPIC_KEY
note

If you plan to use the MySQL or PostgreSQL CDC connectors, they need database drivers that Tabsdata cannot redistribute. After the quickstart completes, add them with tdkserver venv update, as described in Installing Third-Party Database Drivers:

tdkserver venv update --instance <TABSDATA_INSTANCE> --name fn --requirements <REQS_FILE>
tdkserver venv update --instance <TABSDATA_INSTANCE> --name ag --requirements <REQS_FILE>

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.2   │ 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.

Settings and cloud providers​

--config sets a value of the instance configuration, as ADDRESS=VALUE or @FILE, and can be repeated. A value that starts with env: is read from an environment variable. Every setting is checked before the instance folder is created.

tdkserver quickstart --config tabsdata:pods.service.resources.memory=8Gi

A custom Python package index is set the same way:

tdkserver quickstart --config tabsdata:pods.global.envs.UV_INDEX=http://localhost:8000/+simple

--provider takes kminus, eks, aks or gke. Without it, quickstart uses the provider set for the session with tdkserver set, and falls back to kminus. A cloud provider needs one of --kubeconfig, --context or --current.

--fill opens the provider's configuration stub in an editor in the terminal before anything is created. Ctrl+Q saves and continues, Ctrl+S saves, and Esc cancels. The filled stub is kept in <instance>/init/fill/stub.yaml.

tdkserver quickstart --provider gke --current --fill

--fill needs an interactive terminal. For an unattended install, copy the stubs into the Tabsdata home folder with tdkserver stubs, fill one in, and pass it with --config @FILE:

tdkserver stubs
tdkserver quickstart --provider gke --context my-gke-context --config @settings.yaml --yes

If quickstart fails on a new instance, the partial instance is moved to trash. A kminus instance is stopped first, and a cloud instance has its cluster resources deleted first.

--anthropic-key, --openai-key and --uv-index still work, with a deprecation warning, and are converted into the matching --config setting. --reqs-td, --reqs-fn and --reqs-ag are no longer accepted; add drivers with tdkserver venv update instead. See tdkserver quickstart for every option.