kyuubi/docs/client/cli/trino_cli.md
swordy_zhao 750a9173c8
[KYUUBI #6000] Modify the incorrect configuration file in the trino-cli documentation
# 🔍 Description
## Issue References 🔗

This pull request fixes #

## Describe Your Solution 🔧

kyuubi conf file is kyuubi-defaults.conf, not kyuubi.conf

## Types of changes 🔖

- [x] Bugfix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to change)

## Test Plan 🧪

#### Behavior Without This Pull Request ⚰️

#### Behavior With This Pull Request 🎉

#### Related Unit Tests

---

# Checklist 📝

- [ ] This patch was not authored or co-authored using [Generative Tooling](https://www.apache.org/legal/generative-tooling.html)

**Be nice. Be informative.**

Closes #6000 from SwordyZhao/trino-cli-doc-cheage.

Closes #6000

95b839ada [swordy_zhao] kyuubi conf file is kyuubi-defaults.conf

Authored-by: swordy_zhao <swordy_work@163.com>
Signed-off-by: Cheng Pan <chengpan@apache.org>
2024-01-19 19:27:05 +08:00

2.7 KiB

Trino command line interface

The Trino CLI provides a terminal-based, interactive shell for running queries. We can use it to connect Kyuubi server now.

Start Kyuubi Trino Server

First we should configure the trino protocol and the service port in the kyuubi-defaults.conf

kyuubi.frontend.protocols TRINO
kyuubi.frontend.trino.bind.port 10999 #default port

Install

Download trino-cli-411-executable.jar, rename it to trino, make it executable with chmod +x, and run it to show the version of the CLI:

wget https://repo1.maven.org/maven2/io/trino/trino-jdbc/411/trino-jdbc-411.jar
mv trino-jdbc-411.jar trino
chmod +x trino
./trino --version

Running the CLI

The minimal command to start the CLI in interactive mode specifies the URL of the kyuubi server with the Trino protocol:

./trino --server http://localhost:10999

If successful, you will get a prompt to execute commands. Use the help command to see a list of supported commands. Use the clear command to clear the terminal. To stop and exit the CLI, run exit or quit.:

trino> help

Supported commands:
QUIT
EXIT
CLEAR
EXPLAIN [ ( option [, ...] ) ] <query>
    options: FORMAT { TEXT | GRAPHVIZ | JSON }
             TYPE { LOGICAL | DISTRIBUTED | VALIDATE | IO }
DESCRIBE <table>
SHOW COLUMNS FROM <table>
SHOW FUNCTIONS
SHOW CATALOGS [LIKE <pattern>]
SHOW SCHEMAS [FROM <catalog>] [LIKE <pattern>]
SHOW TABLES [FROM <schema>] [LIKE <pattern>]
USE [<catalog>.]<schema>

You can now run SQL statements. After processing, the CLI will show results and statistics.

trino> select 1;
 _col0
-------
     1
(1 row)

Query 20230216_125233_00806_examine_6hxus, FINISHED, 1 node
Splits: 1 total, 1 done (100.00%)
0.29 [0 rows, 0B] [0 rows/s, 0B/s]

trino>

Many other options are available to further configure the CLI in interactive mode to refer https://trino.io/docs/current/client/cli.html#running-the-cli