Skip to content

Commit

Permalink
add the doc of kyuubi trino server
Browse files Browse the repository at this point in the history
  • Loading branch information
iodone committed Feb 18, 2023
1 parent e60855f commit 6f8e314
Show file tree
Hide file tree
Showing 4 changed files with 182 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/client/cli/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,4 @@ Command Line Interface(CLI)s

kyuubi_beeline
hive_beeline
trino_cli
88 changes: 88 additions & 0 deletions docs/client/cli/trino_cli.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
<!--
- Licensed to the Apache Software Foundation (ASF) under one or more
- contributor license agreements. See the NOTICE file distributed with
- this work for additional information regarding copyright ownership.
- The ASF licenses this file to You under the Apache License, Version 2.0
- (the "License"); you may not use this file except in compliance with
- the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License.
-->

# 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.conf`

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

## Install

Download [trino-cli-363-executable.jar](https://repo1.maven.org/maven2/io/trino/trino-jdbc/363/trino-jdbc-363.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/363/trino-jdbc-363.jar
mv trino-jdbc-363.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
1 change: 1 addition & 0 deletions docs/client/jdbc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,5 @@ JDBC Drivers
kyuubi_jdbc
hive_jdbc
mysql_jdbc
trino_jdbc

92 changes: 92 additions & 0 deletions docs/client/jdbc/trino_jdbc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
<!--
- Licensed to the Apache Software Foundation (ASF) under one or more
- contributor license agreements. See the NOTICE file distributed with
- this work for additional information regarding copyright ownership.
- The ASF licenses this file to You under the Apache License, Version 2.0
- (the "License"); you may not use this file except in compliance with
- the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License.
-->

# Trino JDBC Driver

## Instructions

Kyuubi currently supports the Trino connection protocol, so we can use Trino-JDBC to connect to the kyuubi server
and submit SQL to Spark, Trino and other engines for execution.

## Start Kyuubi Trino Server

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

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

## Install Trino JDBC

Download [trino-jdbc-363.jar](https://repo1.maven.org/maven2/io/trino/trino-jdbc/363/trino-jdbc-363.jar) and add it to the classpath of your Java application.

The driver is also available from Maven Central:

```xml
<dependency>
<groupId>io.trino</groupId>
<artifactId>trino-jdbc</artifactId>
<version>363</version>
</dependency>
```

## JDBC URL

When your driver is loaded, registered and configured, you are ready to connect to Trino from your application. The following JDBC URL formats are supported:

```
jdbc:trino://host:port
```

Trino JDBC example

```java
String trinoHost = "localhost";
String trinoPort = "10999";
String trinoUser = "default";
String trinoPassword = null;
Connection connection = null;
ResultSet rs = null;

try {
// Create the connection using the JDBC URL
connection = DriverManager.getConnection("jdbc:trino://" + trinoHost + ":" + trinoPort, trinoUser, trinoPassword);

// Do whatever you need to do with the connection
Statement stmt = connection.createStatement();
rs = stmt.executeQuery("SELECT 1");

while (rs.next()) {
// retrieve data from the ResultSet
}

} catch (Exception e) {
e.printStackTrace();
} finally {
try {
// Close the connection when you're done with it
if (rs != null) rs.close();
if (connection != null) connection.close();
} catch (Exception e) {
e.printStackTrace();
}
}
```

The configuration of the connection parameters can be found in the official trino documentation at: https://trino.io/docs/current/client/jdbc.html#connection-parameters

0 comments on commit 6f8e314

Please sign in to comment.