Skip to content

Commit

Permalink
[KYUUBI apache#3082] Add iceberg connector doc for Trino SQL Engine
Browse files Browse the repository at this point in the history
  • Loading branch information
a49a committed Jul 25, 2022
1 parent 5c1ea6e commit 2f11524
Show file tree
Hide file tree
Showing 3 changed files with 119 additions and 0 deletions.
5 changes: 5 additions & 0 deletions docs/connector/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,3 +35,8 @@ This section describes the connectors available for different kyuubi engines to
:maxdepth: 2

hive/index

.. toctree::
:maxdepth: 2

trino/index
92 changes: 92 additions & 0 deletions docs/connector/trino/iceberg.rst
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.
`Iceberg`_
==========

Apache Iceberg is an open table format for huge analytic datasets.
Iceberg adds tables to compute engines including Spark, Trino, PrestoDB, Flink, Hive and Impala
using a high-performance table format that works just like a SQL table.

.. tip::
This article assumes that you have mastered the basic knowledge and operation of `Iceberg`_.
For the knowledge about Iceberg not mentioned in this article,
you can obtain it from its `Official Documentation`_.

By using kyuubi, we can run SQL queries towards Iceberg which is more
convenient, easy to understand, and easy to expand than directly using
Trino to manipulate Iceberg.

Iceberg Integration
-------------------

To enable the integration of kyuubi trino sql engine and Iceberg through Catalog APIs, you need to:

- Setting the Trino extension and catalog :ref:`configurations`

.. _configurations:

Configurations
**************

To activate functionality of Iceberg, we can set the following configurations:

.. code-block:: properties
connector.name=iceberg
hive.metastore.uri=thrift://localhost:9083
Iceberg Operations
------------------

Taking ``CREATE TABLE`` as a example,

.. code-block:: sql
CREATE TABLE orders (
orderkey bigint,
orderstatus varchar,
totalprice double,
orderdate date
) WITH (
format = 'ORC'
);
Taking ``SELECT`` as a example,

.. code-block:: sql
SELECT * FROM new_orders;
Taking ``INSERT`` as a example,

.. code-block:: sql
INSERT INTO cities VALUES (1, 'San Francisco');
Taking ``UPDATE`` as a example,

.. code-block:: sql
UPDATE purchases SET status = 'OVERDUE' WHERE ship_date IS NULL;
Taking ``DELETE FROM`` as a example,

.. code-block:: sql
DELETE FROM lineitem WHERE shipmode = 'AIR';
.. _Iceberg: https://iceberg.apache.org/
.. _Official Documentation: https://trino.io/docs/current/connector/iceberg.html#
22 changes: 22 additions & 0 deletions docs/connector/trino/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
.. 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.
Connectors For Trino SQL Engine
=====================================

.. toctree::
:maxdepth: 2

iceberg

0 comments on commit 2f11524

Please sign in to comment.