index.asciidoc 2.0 KB

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