Skip to content

Commit 3b68f15

Browse files
author
Julien Ruaux
committed
docs: Introduced name variable for Redis SQL Trino
1 parent 198f01c commit 3b68f15

File tree

1 file changed

+18
-18
lines changed

1 file changed

+18
-18
lines changed

README.adoc

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
:linkattrs:
2-
:project-owner: redis-field-engineering
3-
:project-name: redis-sql-trino
4-
:project-group: com.redis
5-
:project-version: 0.2.9
6-
:documentation-url: https://{project-owner}.github.io/{project-name}
2+
:project-owner: redis-field-engineering
3+
:project-name: redis-sql-trino
4+
:project-group: com.redis
5+
:project-version: 0.2.9
6+
:name: Redis SQL Trino
77

88
++++
99
<p align="center">
10-
<img alt="Redis SQL Trino" src=".github/images/redis-sql-trino-banner-lt.png">
10+
<img alt="{name}" src=".github/images/redis-sql-trino-banner-lt.png">
1111
1212
<p align="center">
13-
Redis SQL Trino is a SQL interface for <a href='https://redis.io/docs/stack/'>Redis Stack</a>, <a href='https://redis.com/redis-enterprise-cloud/overview/'>Redis Cloud</a>, and <a href='https://redis.com/redis-enterprise-software/overview/'>Redis Enterprise</a>.
13+
{name} is a SQL interface for <a href='https://redis.io/docs/stack/'>Redis Stack</a>, <a href='https://redis.com/redis-enterprise-cloud/overview/'>Redis Cloud</a>, and <a href='https://redis.com/redis-enterprise-software/overview/'>Redis Enterprise</a>.
1414
</p>
1515
</p>
1616
++++
@@ -20,9 +20,9 @@
2020
image:https://github.com/{project-owner}/{project-name}/actions/workflows/early-access.yml/badge.svg["Build Status", link="https://github.com/{project-owner}/{project-name}/actions/workflows/early-access.yml"]
2121
image:https://codecov.io/gh/{project-owner}/{project-name}/branch/master/graph/badge.svg?token={codecov-token}["Coverage", link="https://codecov.io/gh/{project-owner}/{project-name}"]
2222

23-
Redis SQL Trino lets lets you easily integrate with visualization frameworks — like Tableau and SuperSet — and platforms that support JDBC-compatible databases (e.g., Mulesoft). Query support includes SELECT statements across secondary indexes on both Redis hashes & JSON, aggregations (e.g., count, min, max, avg), ordering, and more.
23+
{name} lets lets you easily integrate with visualization frameworks — like Tableau and SuperSet — and platforms that support JDBC-compatible databases (e.g., Mulesoft). Query support includes SELECT statements across secondary indexes on both Redis hashes & JSON, aggregations (e.g., count, min, max, avg), ordering, and more.
2424

25-
Trino is a distributed SQL engine designed to query large data sets across one or more heterogeneous data sources. Though Trino does support a https://trino.io/docs/current/connector/redis.html[Redis OSS connector], this connector is limited to SCAN and subsequent HGET operations, which do not scale well in high-throughput scenarios. However, that is where Redis SQL Trino shines since it can pushdown the entire query to the data atomically which eliminates the waste of many network hops and subsequent operations.
25+
Trino is a distributed SQL engine designed to query large data sets across one or more heterogeneous data sources. Though Trino does support a https://trino.io/docs/current/connector/redis.html[Redis OSS connector], this connector is limited to SCAN and subsequent HGET operations, which do not scale well in high-throughput scenarios. However, that is where {name} shines since it can pushdown the entire query to the data atomically which eliminates the waste of many network hops and subsequent operations.
2626

2727
== Table of Contents
2828

@@ -37,11 +37,11 @@ Trino is a distributed SQL engine designed to query large data sets across one o
3737

3838
Redis is an in-memory data store designed to serve data with the fastest possible response times. For this reason, Redis is frequently used for caching OLTP-style application queries and as a serving layer in data pipeline architectures (e.g., lambda architectures, online feature stores, etc.). Redis Stack is an extension to Redis that, among other things, lets you index your data on secondary attributes and then efficiently query it using a custom query language.
3939

40-
We built the Redis SQL Trino connector so that you can query Redis using SQL. This is useful for any application compatible with JDBC. For example, Redis SQL Trino lets you query and visualize your Redis data from Tableau.
40+
We built the {name} connector so that you can query Redis using SQL. This is useful for any application compatible with JDBC. For example, {name} lets you query and visualize your Redis data from Tableau.
4141

4242
== Quick start
4343

44-
To understand how Redis SQL Trino works, it's best to try it for yourself. View the screen recording or follow the steps below:
44+
To understand how {name} works, it's best to try it for yourself. View the screen recording or follow the steps below:
4545

4646
image::https://asciinema.org/a/526185.svg[asciicast,link=https://asciinema.org/a/526185]
4747

@@ -102,10 +102,10 @@ trino:default> select * from beers where abv > 3.2 order by abv desc;
102102

103103
== Installation
104104

105-
To run Redis SQL Trino in production, you'll need:
105+
To run {name} in production, you'll need:
106106

107107
* Trino
108-
* A copy of the Redis SQL Trino connector
108+
* A copy of the {name} connector
109109
* A 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] deployment
110110

111111
=== Trino
@@ -114,9 +114,9 @@ First, you'll need a working Trino installation.
114114

115115
See the https://trino.io/docs/current/installation.html[Trino installation and deplyoment guide] for details. Trino recommends a https://trino.io/docs/current/installation/containers.html[container-based deployment] using your orchestration platform of choice. If you run Kubernetes, see the https://trino.io/docs/current/installation/kubernetes.html[Trino Helm chart].
116116

117-
=== Redis SQL Trino Connector
117+
=== {name} Connector
118118

119-
Next, you'll need to install the Redis SQL Trino plugin and configure it. See our documentation for https://{project-owner}.github.io/{project-name}/#redisearch-connector[plugin installation] and https://{project-owner}.github.io/{project-name}/#configuration[plugin configuration].
119+
Next, you'll need to install the {name} plugin and configure it. See our documentation for https://{project-owner}.github.io/{project-name}/#redisearch-connector[plugin installation] and https://{project-owner}.github.io/{project-name}/#configuration[plugin configuration].
120120

121121
=== Redis installation
122122

@@ -126,12 +126,12 @@ For a self-managed deployment, or for testing locally, install https://redis.io/
126126

127127
The example above uses the https://trino.io/docs/current/client/cli.html[Trino CLI] to access your data.
128128

129-
Most real world applications will use the https://trino.io/docs/current/client/jdbc.html[Trino JDBC driver] to issue queries. See the https://{project-owner}.github.io/{project-name}/#clients[Redis SQL Trino] documentation for details.
129+
Most real world applications will use the https://trino.io/docs/current/client/jdbc.html[Trino JDBC driver] to issue queries. See the https://{project-owner}.github.io/{project-name}/#clients[{name}] documentation for details.
130130

131131
== Support
132132

133-
Redis SQL Trino is supported by Redis, Inc. on a good faith effort basis. To report bugs, request features, or receive assistance, please https://github.com/{project-owner}/{project-name}/issues[file an issue].
133+
{name} is supported by Redis, Inc. on a good faith effort basis. To report bugs, request features, or receive assistance, please https://github.com/{project-owner}/{project-name}/issues[file an issue].
134134

135135
== License
136136

137-
Redis SQL is licensed under the MIT License. Copyright (C) 2023 Redis, Inc.
137+
{name} is licensed under the MIT License. Copyright (C) 2023 Redis, Inc.

0 commit comments

Comments
 (0)