README

• Introduction
• Overview
• Contents
• Additional notes

Introduction

Although ORM exist, using SQL is a valid strategy.

There is no « one size fits all approach ». There are many ways to access data from an application. The three mostly used techniques are : stored procedures, direct SQL within the application’s code, and ORM. Each of these techniques present advantages and drawbacks, depending on the context (the size of the company, the type of projects...). And one should not start using an ORM just because it is the « universally recommended » choice (by the creator of the ORM), or because it is part of the default framework’s distribution.

In many situations, using SQL is a far better solution than using an ORM.

This project is an attempt to make using SQL an even more pragmatic approach by providing a simple way to organise and to document SQL.

What does this is all about ?

This is all about documentation. Please read: why did I write this database access layer? If you access your database through this API, then you can get a SQLite database that organises all information about your SQL requests and your procedures.

• Click here to get the schema for the generated SQLite database.
• You can download an example of the generated database here.
• Click here to have an overview of what you can do with the SQLite database that contains the generated documentation.

Overview

Contents

• Installation notes
• Writing and using SQL requests and procedures
• Documenting SQL requests and procedures
• Using the database interface
• Generating the database's access layer documentation - that is: the SQLite database.
• See this utility to manipulate MySql SQL requests: UtilMySql::developSql()

Additional notes

• Using the Makefile