Skip to content

Dataxi is a cross-DBMS server tool with credential management that can help you centralize the data extraction and transfer from different data sources.

License

Notifications You must be signed in to change notification settings

yyccPhil/dataxi

Repository files navigation

Dataxi

Dataxi is a cross-DBMS server tool based on Polars with credential management that can help you centralize the data extraction and transfer from different data sources.

For detailed documentation, please refer to Dataxi Wiki Page.

Highlights

  • Supports multiple data sources: ClickHouse, MySQL, PostgreSQL, SQL Server, Splunk
  • Supports data parsing from multiple formats: pandas, CSV, XLSX, and Parquet
  • Offers credential management with easy access using conn_id
  • Works on Linux/MacOS/Windows

Install

The preferred way to install Dataxi is via pip

pip install dataxi

Basic Usage

Credential Management

Command Line

Initialize to manage your credentials. This will create a hidden .dataxi folder in your $HOME directory to securely store credentials.

cred_mgr
Use the add command to store new credential interactively. It requires a unique conn_id, and supports 3 credential types: Database, Secret and Token.

You will be prompted to choose among the 3 credential types. For each type, provide the following arguments in order:

Database

  • db_type: one of mysql, mssql (or sql_server), clickhouse (or ch), postgresql (or postgres)
  • username
  • password
  • host
  • port
  • database (optional)

Secret

  • username
  • password

Token

  • token

Note: For token credentials, db_type is automatically set to token and does not need to be provided.

cred_mgr add <conn_id>

Display all saved conn_ids, similar to how pip list works. This is helpful for quickly identifying available credentials.

cred_mgr ls
# cred_mgr list

Easily remove credentials you no longer need by specifying their conn_id.

cred_mgr D <conn_id>
# cred_mgr delete <conn_id>

Print the details of a stored credential using its conn_id.

cred_mgr load -id <conn_id>

# Print all stored credentials
cred_mgr load -a
# cred_mgr load --all

(Warning: This action is irreversible!) Use reset to clear all stored credentials in the .dataxi folder.

cred_mgr reset

(Warning: This action is irreversible!) Use clean to completely remove the .dataxi folder.

cred_mgr clean

License

Copyright 2024-2025 Yuan Yuan.

Distributed under the terms of the MIT license.

About

Dataxi is a cross-DBMS server tool with credential management that can help you centralize the data extraction and transfer from different data sources.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published