index.asciidoc 2.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960
  1. [role="xpack"]
  2. [[xpack-sql]]
  3. = SQL
  4. :sql-tests: {xes-repo-dir}/../../plugin/sql/qa/
  5. :sql-specs: {sql-tests}server/src/main/resources/
  6. :jdbc-tests: {sql-tests}jdbc/src/main/java/org/elasticsearch/xpack/sql/qa/jdbc
  7. :security-tests: {sql-tests}server/security/src/test/java/org/elasticsearch/xpack/sql/qa/security
  8. :es-sql: Elasticsearch SQL
  9. [partintro]
  10. --
  11. X-Pack includes a SQL feature to execute SQL queries against {es}
  12. indices and return results in tabular format.
  13. The following chapters aim to cover everything from usage, to syntax and drivers.
  14. Experienced users or those in a hurry might want to jump directly to
  15. the list of SQL <<sql-commands, commands>> and <<sql-functions, functions>>.
  16. <<sql-overview, Overview>>::
  17. Overview of {es-sql} and its features.
  18. <<sql-getting-started, Getting Started>>::
  19. Start using SQL right away in {es}.
  20. <<sql-concepts, Concepts and Terminology>>::
  21. Language conventions across SQL and {es}.
  22. <<sql-security,Security>>::
  23. Secure {es-sql} and {es}.
  24. <<sql-rest,REST API>>::
  25. Execute SQL in JSON format over REST.
  26. <<sql-translate,Translate API>>::
  27. Translate SQL in JSON format to {es} native query.
  28. <<sql-cli,CLI>>::
  29. Command-line application for executing SQL against {es}.
  30. <<sql-jdbc,JDBC>>::
  31. JDBC driver for {es}.
  32. <<sql-odbc,ODBC>>::
  33. ODBC driver for {es}.
  34. <<sql-client-apps,Client Applications>>::
  35. Setup various SQL/BI tools with {es-sql}.
  36. <<sql-spec,SQL Language>>::
  37. Overview of the {es-sql} language, such as supported data types, commands and
  38. syntax.
  39. <<sql-functions,Functions and Operators>>::
  40. List of functions and operators supported.
  41. <<sql-limitations,Limitations>>::
  42. {es-sql} current limitations.
  43. --
  44. include::overview.asciidoc[]
  45. include::getting-started.asciidoc[]
  46. include::concepts.asciidoc[]
  47. include::security.asciidoc[]
  48. include::endpoints/index.asciidoc[]
  49. include::language/index.asciidoc[]
  50. include::functions/index.asciidoc[]
  51. include::appendix/index.asciidoc[]
  52. include::limitations.asciidoc[]
  53. :jdbc-tests!: