Skip to content

Frequently Asked Questions (FAQ)

Jump to bottom
Shashank Patil edited this page Jul 26, 2026 · 1 revision

Frequently Asked Questions (FAQ)

This page answers the most common questions about the Generic SQL API Framework.

General

What is the Generic SQL API Framework?

The Generic SQL API Framework is an open-source PHP framework for building dynamic SQL APIs using JSON requests and external SQL files. It separates SQL logic from application code, making APIs easier to maintain and reuse.

Who is this framework for?

The framework is suitable for:

  • Backend Developers
  • Database Developers
  • System Integrators
  • Internal Business Applications
  • Reporting Systems
  • Dashboard Applications

Is the framework open source?

Yes.

The project is open source and licensed under the MIT License.

Database Support

Which databases are supported?

Current support:

  • Microsoft SQL Server

Planned support:

  • MySQL
  • PostgreSQL
  • MariaDB
  • SQLite

Can I use SQL Server Express?

Yes.

The framework works with SQL Server Express, Standard, Enterprise, and Developer editions.

Does it support Windows Authentication?

Yes.

Windows Authentication is supported when properly configured.

Can I use SQL Server Authentication?

Yes.

Both SQL Server Authentication and Windows Authentication are supported.

SQL Queries

Where are SQL queries stored?

SQL queries are stored as individual .sql files inside the queries/ directory.

Example:

queries/
    customers.sql

Can I organize SQL files into folders?

Yes.

Example:

queries/

customers/
orders/
reports/
inventory/

Does the framework support parameterized queries?

Yes.

Parameterized queries are the recommended way to safely pass user input to SQL statements.

Are stored procedures supported?

Yes.

Stored procedures can be executed if your framework version includes stored procedure support.

API

What format does the framework use?

The framework communicates using JSON.

Request:

{
    "query": "customers"
}

Response:

{
    "success": true,
    "data": []
}

Does the framework support pagination?

Yes.

Pagination is supported using the pagination object in the request.

Does it support sorting?

Yes.

Sorting can be configured through the sorting section of the JSON request.

Does it support filtering?

Yes.

Filters can be supplied using the filters object.

Security

Is SQL Injection prevented?

The framework encourages secure development through parameterized queries. Avoid building SQL statements by concatenating user input.

Should I use the sa account?

No.

Use a dedicated SQL Server account with only the permissions required by your application.

Can I expose SQL Server directly to the internet?

No.

Deploy the framework on a web server and keep SQL Server on a protected internal network.

Deployment

Can I run the framework on XAMPP?

Yes.

XAMPP is recommended for local development.

Can I deploy on IIS?

Yes.

The framework is compatible with IIS.

Does it work on Linux?

Experimental support is available, depending on your PHP environment and SQL Server connectivity.

Performance

Can the framework handle large datasets?

Yes.

Use pagination, indexing, and optimized SQL queries for better performance.

Should I use SELECT *?

No.

Select only the columns your application requires.

Contributing

How can I contribute?

You can contribute by:

  • Reporting bugs
  • Suggesting new features
  • Improving documentation
  • Fixing issues
  • Submitting pull requests

See the Contributing guide for details.

Need More Help?

If your question is not answered here:

  • Read the Wiki documentation.
  • Search existing GitHub Issues.
  • Create a new issue with detailed information about your environment and the problem you're experiencing.

Clone this wiki locally