API Reference

Reference documentation for the public sql-redis API. Each class and function is generated from the docstrings in the source.

• Translator

  ---

  Turn SQL into a Redis FT.SEARCH or FT.AGGREGATE command without executing it.

• Schema Registries

  ---

  Cache index field types from FT.INFO. Sync and async variants.

• Executor

  ---

  Run a translated query against Redis. Sync and async, with factory helpers.

• SQL Syntax

  ---

  The supported SQL surface: clauses, operators, functions, vector search.