Skip to content
16.4 Command-Line Tool Reference

16.4 Command-Line Tool Reference

Machbase provides command-line tools for server administration, data import/export, and query execution. This section is a quick reference to their options and usage.

Tools

ToolEditionDescription
machadminStandard / ClusterServer startup/shutdown, database creation/deletion, and license management
machsqlStandard / ClusterInteractive SQL terminal
machloaderStandard / ClusterImport/export of CSV and other text files
csvimport / csvexportStandard / ClusterSimple CSV import/export wrappers
tagmetaimportStandard / ClusterBulk TAG table metadata import
machclusterctlClusterCluster-wide startup, shutdown, and management
machcoordinatoradminClusterCoordinator node management and cluster configuration
machdeployeradminClusterDeployer node management

Common Connection Options

The following connection options apply to machsql. Option names and defaults vary by tool; check the tool’s option dictionary or --help output before using another tool. In particular, distinguish machadmin server administration options from SQL client connection options.

OptionDefaultDescription
-s, --server127.0.0.1Server IP address
-P, --port5656Server port
-u, --userSYSUsername
-p, --passwordMANAGERUser password

Tool Location

Tools included in the installation package are in $MACHBASE_HOME/bin/. Availability depends on the installed edition and package.

ls $MACHBASE_HOME/bin/
# machadmin  machsql  machloader  csvimport  csvexport  tagmetaimport  ...

If $MACHBASE_HOME/bin is in PATH, run each tool by name.

export PATH=$MACHBASE_HOME/bin:$PATH
machadmin -e
Last updated on