{"id":19542687,"url":"https://github.com/opensearch-project/sql","last_synced_at":"2025-05-15T13:07:21.164Z","repository":{"id":37051966,"uuid":"354129853","full_name":"opensearch-project/sql","owner":"opensearch-project","description":"Query your data using familiar SQL or intuitive Piped Processing Language (PPL)","archived":false,"fork":false,"pushed_at":"2025-05-09T00:10:31.000Z","size":93927,"stargazers_count":140,"open_issues_count":605,"forks_count":154,"subscribers_count":22,"default_branch":"main","last_synced_at":"2025-05-09T01:21:11.771Z","etag":null,"topics":["ppl","sql"],"latest_commit_sha":null,"homepage":"https://opensearch.org/docs/latest/search-plugins/sql/index/","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/opensearch-project.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.txt","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2021-04-02T20:48:31.000Z","updated_at":"2025-05-07T03:57:48.000Z","dependencies_parsed_at":"2023-10-13T06:05:32.193Z","dependency_job_id":"6e1594d1-8fbd-49ed-ad4d-755136f0577f","html_url":"https://github.com/opensearch-project/sql","commit_stats":{"total_commits":1050,"total_committers":95,"mean_commits":"11.052631578947368","dds":0.8361904761904762,"last_synced_commit":"d44cd39c34367d96715731adede370794ac0d95a"},"previous_names":[],"tags_count":88,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opensearch-project%2Fsql","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opensearch-project%2Fsql/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opensearch-project%2Fsql/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opensearch-project%2Fsql/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/opensearch-project","download_url":"https://codeload.github.com/opensearch-project/sql/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254346624,"owners_count":22055808,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ppl","sql"],"created_at":"2024-11-11T03:15:34.893Z","updated_at":"2025-05-15T13:07:16.151Z","avatar_url":"https://github.com/opensearch-project.png","language":"Java","readme":"\u003cimg src=\"https://opensearch.org/assets/brand/SVG/Logo/opensearch_logo_default.svg\" height=\"64px\"/\u003e\n\n- [OpenSearch SQL](#opensearch-sql)\n  - [Code Summary](#code-summary)\n    - [SQL Engine](#sql-engine)\n    - [Repository Checks](#repository-checks)\n    - [Issues](#issues)\n  - [Highlights](#highlights)\n  - [Documentation](#documentation)\n  - [Forum](#forum)\n  - [Contributing](#contributing)\n  - [Attribution](#attribution)\n  - [Code of Conduct](#code-of-conduct)\n  - [Security](#security)\n  - [License](#license)\n  - [Copyright](#copyright)\n\n# OpenSearch SQL\n\nOpenSearch enables you to extract insights out of OpenSearch using the familiar SQL or Piped Processing Language (PPL) query syntax. Use aggregations, group by, and where clauses to investigate your data. Read your data as JSON documents or CSV tables so you have the flexibility to use the format that works best for you.\n\nThe following projects are related to the SQL plugin, but stored in the different repos. Please refer to links below for details. This document will focus on the SQL plugin for OpenSearch.\n\n- [SQL CLI](https://github.com/opensearch-project/sql-cli)\n- [SQL JDBC](https://github.com/opensearch-project/sql-jdbc)\n- [SQL ODBC](https://github.com/opensearch-project/sql-odbc)\n- [Query Workbench](https://github.com/opensearch-project/dashboards-query-workbench)\n\n## Code Summary\n\n### SQL Engine\n\n|                              |                                                                                                                                              |\n| ---------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |\n| Test and build               | [![SQL CI][sql-ci-badge]][sql-ci-link]                                                        |\n| Code coverage                | [![codecov][sql-codecov-badge]][sql-codecov-link]                                                                                         |\n| Distribution build tests     | [![OpenSearch IT tests][opensearch-it-badge]][opensearch-it-link] [![OpenSearch IT code][opensearch-it-code-badge]][opensearch-it-code-link] |\n| Backward compatibility tests | [![BWC tests][bwc-tests-badge]][bwc-tests-link]                                                                                              |\n\n### Repository Checks\n\n|              |                                                                 |\n| ------------ | --------------------------------------------------------------- |\n| DCO Checker  | [![Developer certificate of origin][dco-badge]][dco-badge-link] |\n| Link Checker | [![Link Checker][link-check-badge]][link-check-link]            |\n\n### Issues\n\n|                                                                |\n| -------------------------------------------------------------- |\n| [![good first issues open][good-first-badge]][good-first-link] |\n| [![features open][feature-badge]][feature-link]                |\n| [![enhancements open][enhancement-badge]][enhancement-link]    |\n| [![bugs open][bug-badge]][bug-link]                            |\n| [![untriaged open][untriaged-badge]][untriaged-link]           |\n| [![nolabel open][nolabel-badge]][nolabel-link]                 |\n\n[dco-badge]: https://github.com/opensearch-project/sql/actions/workflows/dco.yml/badge.svg\n[dco-badge-link]: https://github.com/opensearch-project/sql/actions/workflows/dco.yml\n[link-check-badge]: https://github.com/opensearch-project/sql/actions/workflows/link-checker.yml/badge.svg\n[link-check-link]: https://github.com/opensearch-project/sql/actions/workflows/link-checker.yml\n[bwc-tests-badge]: https://img.shields.io/badge/BWC%20tests-in%20progress-yellow\n[bwc-tests-link]: https://github.com/opensearch-project/sql/issues/193\n[good-first-badge]: https://img.shields.io/github/issues/opensearch-project/sql/good%20first%20issue.svg\n[good-first-link]: https://github.com/opensearch-project/sql/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22+\n[feature-badge]: https://img.shields.io/github/issues/opensearch-project/sql/feature.svg\n[feature-link]: https://github.com/opensearch-project/sql/issues?q=is%3Aopen+is%3Aissue+label%3Afeature\n[bug-badge]: https://img.shields.io/github/issues/opensearch-project/sql/bug.svg\n[bug-link]: https://github.com/opensearch-project/sql/issues?q=is%3Aopen+is%3Aissue+label%3Abug+\n[enhancement-badge]: https://img.shields.io/github/issues/opensearch-project/sql/enhancement.svg\n[enhancement-link]: https://github.com/opensearch-project/sql/issues?q=is%3Aopen+is%3Aissue+label%3Aenhancement+\n[untriaged-badge]: https://img.shields.io/github/issues/opensearch-project/sql/untriaged.svg\n[untriaged-link]: https://github.com/opensearch-project/sql/issues?q=is%3Aopen+is%3Aissue+label%3Auntriaged+\n[nolabel-badge]: https://img.shields.io/github/issues-search/opensearch-project/sql?color=yellow\u0026label=no%20label%20issues\u0026query=is%3Aopen%20is%3Aissue%20no%3Alabel\n[nolabel-link]: https://github.com/opensearch-project/sql/issues?q=is%3Aopen+is%3Aissue+no%3Alabel+\n[sql-codecov-badge]: https://codecov.io/gh/opensearch-project/sql/branch/main/graphs/badge.svg?flag=sql-engine\n[sql-codecov-link]: https://codecov.io/gh/opensearch-project/sql\n[opensearch-it-badge]: https://img.shields.io/badge/SQL%20IT%20tests-in%20progress-yellow\n[opensearch-it-link]: https://github.com/opensearch-project/opensearch-build/issues/1124\n[opensearch-it-code-badge]: https://img.shields.io/badge/SQL%20IT%20code-blue\n[opensearch-it-code-link]: https://github.com/opensearch-project/sql/tree/main/integ-test\n\n## Highlights\n\nBesides basic filtering and aggregation, OpenSearch SQL also supports complex queries, such as querying semi-structured data, JOINs, set operations, sub-queries etc. Beyond the standard functions, OpenSearch functions are provided for better analytics and visualization. Please check our [documentation](#documentation) for more details.\n\nRecently we have been actively improving our query engine primarily for better correctness and extensibility. Behind the scene, the new enhanced engine has already supported both SQL and Piped Processing Language. Please find more details in [SQL Engine V2 - Release Notes](./docs/dev/intro-v2-engine.md).\n\n## Documentation\n\nPlease refer to the [SQL Language Reference Manual](./docs/user/index.rst), [Piped Processing Language (PPL) Reference Manual](./docs/user/ppl/index.rst), [OpenSearch SQL/PPL Engine Development Manual](./docs/dev/index.md) and [Technical Documentation](https://opensearch.org/docs/latest/search-plugins/sql/index/) for detailed information on installing and configuring plugin.\n\n## Forum\n\nFor additional help with the plugin, including questions about opening an issue, visit the OpenSearch [Forum](https://forum.opensearch.org/c/plugins/sql/8).\n\n## Contributing\n\nSee [developer guide](DEVELOPER_GUIDE.rst) and [how to contribute to this project](CONTRIBUTING.md).\n\n## Attribution\n\nThis project is based on the Apache 2.0-licensed [elasticsearch-sql](https://github.com/NLPchina/elasticsearch-sql) project. Thank you [eliranmoyal](https://github.com/eliranmoyal), [shi-yuan](https://github.com/shi-yuan), [ansjsun](https://github.com/ansjsun) and everyone else who contributed great code to that project. Read this for more details [Attributions](./docs/attributions.md).\n\n## Code of Conduct\n\nThis project has adopted an [Open Source Code of Conduct](./CODE_OF_CONDUCT.md).\n\n## Security\n\nIf you discover a potential security issue in this project we ask that you notify OpenSearch Security directly via email to security@opensearch.org. Please do **not** create a public GitHub issue.\n\n## License\n\nSee the [LICENSE](./LICENSE.txt) file for our project's licensing. We will ask you to confirm the licensing of your contribution.\n\n## Copyright\n\nCopyright OpenSearch Contributors. See [NOTICE](./NOTICE) for details.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopensearch-project%2Fsql","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopensearch-project%2Fsql","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopensearch-project%2Fsql/lists"}