Skip to content

Latest commit

 

History

History
136 lines (89 loc) · 7.66 KB

README.md

File metadata and controls

136 lines (89 loc) · 7.66 KB
Raw

SQL2API

This project is a Flask-based application designed for executing SQL queries against multiple database types and retrieving the results in various formats.

|---------------|------|-----|-----|-----|------|------|

Database JSON XML YAML CSV TSV XLSX
MySQL ✅ ✅ ✅ ✅ ✅ ✅
Postgres ✅ ✅ ✅ ✅ ✅ ✅
ClickHouse ✅ ✅ ✅ ✅ ✅ ✅
H2 ✅ ✅ ✅ ✅ ✅ ✅

Executing SQL Queries: Users can execute SQL queries by sending POST requests to the '/execute_sql' endpoint of the application. They need to provide the SQL query and the connection name as part of the request body.

Query Parameterization: The application supports query parameterization by allowing users to specify placeholders in their SQL queries. Placeholder values can be provided as part of the request body when executing the query.

Saving and Managing Queries: Users can save SQL queries along with metadata such as author, description, and tags by sending PATCH requests to the '/save_sql_to_file' endpoint. They can also manage saved queries, including editing and deleting them.

Listing Saved Queries: Users can list the saved queries stored in the application by sending GET requests to the '/list_files' endpoint. The endpoint returns a list of filenames along with versioning information and metadata for each saved query.

Connection Management: Users can manage database connections by sending PATCH requests to the '/connections' endpoint. They can add, edit, or delete connection details, including host, port, username, password, and database name.

contributions welcome Tweet Twitter Follow

Built with ❤︎ by Anantha Raju C and contributors

Explore the docs »

Report Bug · Request Feature

Service Badge Badge Badge Badge Badge
GitHub GitHub last commit GitHub pull requests GitHub issues GitHub forks GitHub stars
GitHub GitHub repo size GitHub top language GitHub code size in bytes GitHub tag (latest SemVer) GitHub language count

Reporting Issues/Suggest Improvements

This Project uses GitHub's integrated issue tracking system to record bugs and feature requests. If you want to raise an issue, please follow the recommendations below:

  • Before you log a bug, please search the issue tracker to see if someone has already reported the problem.
  • If the issue doesn't already exist, create a new issue
  • Please provide as much information as possible with the issue report.
  • If you need to paste code, or include a stack trace use Markdown +++```+++ escapes before and after your text.

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

Kindly refer to CONTRIBUTING.md for important Pull Request Process details

  1. In the top-right corner of this page, click Fork.

  2. Clone a copy of your fork on your local, replacing YOUR-USERNAME with your Github username.

    git clone https://github.com/YOUR-USERNAME/SQL2API.git

  3. Create a branch:

    git checkout -b <my-new-feature-or-fix>

  4. Make necessary changes and commit those changes:

    git add .

    git commit -m "new feature or fix"

  5. Push changes, replacing <add-your-branch-name> with the name of the branch you created earlier at step #3. :

    git push origin <add-your-branch-name>

  6. Submit your changes for review. Go to your repository on GitHub, you'll see a Compare & pull request button. Click on that button. Now submit the pull request.

That's it! Soon I'll be merging your changes into the master branch of this project. You will get a notification email once the changes have been merged. Thank you for your contribution.

Kindly follow Conventional Commits to create an explicit commit history. Kindly prefix the commit message with one of the following type's.

build : Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
ci : Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
docs : Documentation only changes
feat : A new feature
fix : A bug fix
perf : A code change that improves performance
refactor: A code change that neither fixes a bug nor adds a feature
style : Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
test : Adding missing tests or correcting existing tests

The End

In the end, I hope you enjoyed the application and find it useful, as I did when I was developing it.

If you would like to enhance, please:

  • Open PRs,

  • Give feedback,

  • Add new suggestions, and

  • Finally, give it a 🌟.

  • Happy Coding ...* 🙂

Contact

Anantha Raju C - @anantharajuc - [email protected]

Project Link: https://github.com/AnanthaRajuC/SQL2API