# sql-redis

> SQL to Redis FT.SEARCH and FT.AGGREGATE translator.

## Concepts

- [Concepts](https://redis-developer.github.io/sql-redis/concepts/index.md)
- [Architecture](https://redis-developer.github.io/sql-redis/concepts/architecture/index.md)
- [Async invariants](https://redis-developer.github.io/sql-redis/concepts/async-invariants/index.md)
- [Parameter substitution](https://redis-developer.github.io/sql-redis/concepts/parameter-substitution/index.md)
- [Result shape](https://redis-developer.github.io/sql-redis/concepts/result-shape/index.md)
- [Schema-aware translation](https://redis-developer.github.io/sql-redis/concepts/schema-aware-translation/index.md)
- [FT.SEARCH vs FT.AGGREGATE](https://redis-developer.github.io/sql-redis/concepts/search-vs-aggregate/index.md)
- [Testing philosophy](https://redis-developer.github.io/sql-redis/concepts/testing-philosophy/index.md)
- [Vector substitution](https://redis-developer.github.io/sql-redis/concepts/vector-substitution/index.md)
- [Why SQL?](https://redis-developer.github.io/sql-redis/concepts/why-sql/index.md)
- [Why sqlglot?](https://redis-developer.github.io/sql-redis/concepts/why-sqlglot/index.md)

## User Guide

- [User Guide](https://redis-developer.github.io/sql-redis/user_guide/index.md)
- [Getting Started](https://redis-developer.github.io/sql-redis/user_guide/getting-started/index.md)
- [Installation](https://redis-developer.github.io/sql-redis/user_guide/installation/index.md)
- [How-To Guides](https://redis-developer.github.io/sql-redis/user_guide/how_to_guides/index.md)
- [Async usage](https://redis-developer.github.io/sql-redis/user_guide/how_to_guides/async-usage/index.md)
- [Date queries](https://redis-developer.github.io/sql-redis/user_guide/how_to_guides/date-queries/index.md)
- [GEO queries](https://redis-developer.github.io/sql-redis/user_guide/how_to_guides/geo-queries/index.md)
- [Lazy vs eager schemas](https://redis-developer.github.io/sql-redis/user_guide/how_to_guides/lazy-vs-eager-schemas/index.md)
- [Missing fields](https://redis-developer.github.io/sql-redis/user_guide/how_to_guides/missing-fields/index.md)
- [Text search](https://redis-developer.github.io/sql-redis/user_guide/how_to_guides/text-search/index.md)
- [Use parameters](https://redis-developer.github.io/sql-redis/user_guide/how_to_guides/use-parameters/index.md)
- [Vector search](https://redis-developer.github.io/sql-redis/user_guide/how_to_guides/vector-search/index.md)

## API Reference

- [API Reference](https://redis-developer.github.io/sql-redis/api/index.md)
- [Executor](https://redis-developer.github.io/sql-redis/api/executor/index.md)
- [Schema](https://redis-developer.github.io/sql-redis/api/schema/index.md)
- [SQL Syntax](https://redis-developer.github.io/sql-redis/api/sql-syntax/index.md)
- [Translator](https://redis-developer.github.io/sql-redis/api/translator/index.md)

## For AI Agents

- [For AI Agents](https://redis-developer.github.io/sql-redis/for-ais-only/index.md)
- [Build and test](https://redis-developer.github.io/sql-redis/for-ais-only/BUILD_AND_TEST/index.md)
- [Failure modes](https://redis-developer.github.io/sql-redis/for-ais-only/FAILURE_MODES/index.md)
- [Repository map](https://redis-developer.github.io/sql-redis/for-ais-only/REPOSITORY_MAP/index.md)