YTsaurus table engine

Table engine that allows importing data from a YTsaurus cluster.

The YTsaurus table engine allows you to import data from a YTsaurus cluster.

Creating a table

    CREATE TABLE [IF NOT EXISTS] [db.]table_name
    (
        name1 [type1],
        name2 [type2], ...
    ) ENGINE = YTsaurus('http_proxy_url', 'cypress_path', 'oauth_token')

This is an experimental feature that may change in backwards-incompatible ways in future releases. Enable usage of the YTsaurus table engine using setting allow_experimental_ytsaurus_table_engine.

You can do so using:

SET allow_experimental_ytsaurus_table_engine = 1.

Engine parameters

• http_proxy_url — URL to the YTsaurus http proxy.
• cypress_path — Cypress path to the data source.
• oauth_token — OAuth token.

Usage example

Shows a query creating the YTsaurus table:

Query

SHOW CREATE TABLE yt_saurus;

Response

CREATE TABLE yt_saurus
(
    `a` UInt32,
    `b` String
)
ENGINE = YTsaurus('http://localhost:8000', '//tmp/table', 'password')

To return the data from the table, run:

Query

SELECT * FROM yt_saurus;

Response

 ┌──a─┬─b──┐
 │ 10 │ 20 │
 └────┴────┘

Data types

Primitive data types

YTsaurus data type	Clickhouse data type
int8	Int8
int16	Int16
int32	Int32
int64	Int64
uint8	UInt8
uint16	UInt16
uint32	UInt32
uint64	UInt64
float	Float32
double	Float64
boolean	Bool
string	String
utf8	String
json	JSON
yson(type_v3)	JSON
uuid	UUID
date32	Date(Not supported yet)
datetime64	Int64
timestamp64	Int64
interval64	Int64
date	Date(Not supported yet)
datetime	DateTime
timestamp	DateTime64(6)
interval	UInt64
any	String
null	Nothing
void	Nothing
T with required = False	Nullable(T)

Composite types

YTsaurus data type	Clickhouse data type
decimal	Decimal
optional	Nullable
list	Array
struct	NamedTuple
tuple	Tuple
variant	Variant
dict	`Array(Tuple(…))
tagged	T

See Also

• ytsaurus table function
• ytsaurus data schema
• ytsaurus data types