Skip to content

Commit cfc02d1

Browse files
committed
More cleanup
1 parent 4677c63 commit cfc02d1

File tree

1 file changed

+8
-46
lines changed

1 file changed

+8
-46
lines changed

README.adoc

Lines changed: 8 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,16 @@ image:https://codecov.io/gh/{project-owner}/{project-name}/branch/master/graph/b
1313

1414
Redis SQL is a https://trino.io[Trino] connector for https://redis.io/docs/stack/[Redis Stack], https://redis.com/redis-enterprise-cloud/overview/[Redis Cloud], and https://redis.com/redis-enterprise-software/overview/[Redis Enterprise].
1515

16-
Trino is a distributed SQL engine designed to efficiently query large amounts of data for data warehousing and analytics (OLAP) applications. The Redis SQL Trino connector that lets you use Trino to query your Redis data using SQL. This implementation takes advantage of the indexing and querying capabilites of Redis Stack. As such, this connector generally outperforms the https://trino.io/docs/current/connector/redis.html[standard Redis Trino connector], which cannot take advantage of these indexed queries.
17-
16+
Trino is a distributed SQL engine designed to efficiently query large amounts of data for data warehousing and analytics (OLAP) applications. The Redis SQL Trino connector lets you use Trino to query your Redis data using SQL. This implementation takes advantage of the indexing and querying capabilites of Redis Stack. As such, this connector generally outperforms the https://trino.io/docs/current/connector/redis.html[standard Redis Trino connector], which cannot take advantage of these indexed queries.
1817

1918
== Table of Contents
2019

2120
* link:#background[Background]
21+
* link:#quick-start[Quick start]
22+
* link:#installation[Installation]
23+
* link:#Usage[Usage]
24+
* link:#Support[Support]
25+
* link:#License[License]
2226

2327
== Background
2428

@@ -88,6 +92,8 @@ To use Redis SQL Trino, you'll need a working Trino installation. See the https:
8892

8993
Next, you'll need to install the Redis SQL Trino plugin and configure it. See https://redis-field-engineering.github.io/redis-sql/#redisearch-connector[plugin installation] and https://redis-field-engineering.github.io/redis-sql/#configuration[plugin configuration].
9094

95+
You will also need either https://redis.io/docs/stack/[Redis Stack], https://redis.com/redis-enterprise-cloud/overview/[Redis Cloud], or https://redis.com/redis-enterprise-software/overview/[Redis Enterprise].
96+
9197
== Usage
9298

9399
The example above uses the https://trino.io/docs/current/client/cli.html[Trino CLI] to access your data. Most real world applications will use the https://trino.io/docs/current/client/jdbc.html[Trino JDBC driver] to issue queries. See the https://redis-field-engineering.github.io/redis-sql/#clients[Redis SQL Trino] documentation for details.
@@ -99,47 +105,3 @@ Redis SQL Trino is supported by the Redis Field Engineering team in the good fai
99105
== License
100106

101107
Redis SQL is licensed under the MIT License. Copyright (c) 2023, Redis, Inc.
102-
103-
NOTE: RediSearch 2.0 or later is required.
104-
105-
Complete documentation is available at link:{documentation-url}[{documentation-url}].
106-
107-
== Docker Example
108-
109-
110-
.Clone the project
111-
[source,console,subs="verbatim,attributes"]
112-
----
113-
git clone {project-url}.git
114-
cd {project-name}
115-
----
116-
117-
.Launch the containers
118-
[source,console]
119-
----
120-
docker-compose up
121-
----
122-
123-
.Create a RediSearch index
124-
[source,console]
125-
----
126-
docker exec -it redis /opt/redis-stack/bin/redis-cli FT.CREATE beers ON HASH PREFIX 1 beer: SCHEMA id TAG SORTABLE brewery_id TAG SORTABLE name TEXT SORTABLE abv NUMERIC SORTABLE descript TEXT style_name TAG SORTABLE cat_name TAG SORTABLE
127-
----
128-
129-
.Add documents to the index
130-
[source,console]
131-
----
132-
docker run --add-host=host.docker.internal:host-gateway fieldengineering/riot-file -h host.docker.internal import https://storage.googleapis.com/jrx/beers.json hset --keyspace beer --keys id
133-
----
134-
135-
.Run the Trino CLI
136-
[source,console]
137-
----
138-
docker exec -it trino trino --catalog redisearch --schema default
139-
----
140-
141-
.Run a SQL query
142-
[source,console]
143-
----
144-
trino:default> SELECT * FROM beers;
145-
----

0 commit comments

Comments
 (0)