Download the PHP package amkt922/ssql without Composer

SSql

The SSql is a simple database access library.
It has two main features:

• build a sql with methods and execute it(Simple Query)
• execute a sql written in a sql-file outside an app(Simple Sql).

The second is inspired by the dbflute outside sql.
dbflute
About OutsideSql

SSqlはシンプルなデータベースアクセスライブラリです。 主に2つの機能があります。

• メソッドチェインによるSQLの構築と実行
• sqlファイルに記述されたSQLの実行

2つ目の機能はdbfluteの外出しSQLに感銘を受けて作りました。
dbflute
dbfluteの外出しSQL

Motive

In the actual project, sometimes we need to access databases with more complex sqls than functions a ORM library has.
When executing them with a ORM, sources are going to be more complicated generally.
I need to embed them in the sources, and I don't know whether they are corrent grammertically.
The dbflute has solved such matters with a function that is called outside sql, however the dbflute is implemented in Java.
I have wanted to such a library in PHP, and then implemented a library that has outside sql feature.

動機

実際の業務では、ORMが持っている機能以上のDBへのアクセス処理を実装する必要が時々あります。
ORMの機能でそのようなSQLを発行する場合、大抵は実際にWebアプリケーションで確認するまで文法的に正しいかはわかりません。
dbfluteはそのような問題を外出しSQLで解決しています。ただdbfluteはJavaで実装されており、PHPでそのようなライブラリが欲しかったため、PHPで外出しSQLを実装したライブラリです。

What is the outside sql?

The outside sql is a function that execute a sql that is written in sql file.
You write a sql with comment that is called a parameter comment.

外出しSQLって？

外出しSQLとはテキストファイルに記載されたSQLを実行する機能です。
パラメータコメントと呼ばれるコメントとともにSQLを記載します。

What is the Parameter comment?

Its example is below.
/*IF */, /*BEGIN*/ and so on are parameter comments.

パラメータコメントって？

機能はdbfluteを模倣しているので、dbfluteの外付けSQLのページでご確認ください。
About OutsideSql

Differences from dbflute as of now.

• dbflute's embedded parameter is written with $, but SSql uses @

現時点でのdbfluteとの相違点

• dbfluteの埋め込み変数は$を使いますが、SSqlでは@を使います

How to install the SSql.

just import SSql.php

SSqlのインストール方法

SSql.phpを読み込むだけです。

Requirements, 環境

• php >= 5.3

Limitation, 制限

Supports Sqlite, Mysql and Postgresql, other databases are not support as of now.

MysqlとSqlite, Postgresqlのみサポートしています。他のデータベースは現時点ではサポートしていません。

Usage

Note: These example are parts of SSql features.
There are many another functions in the SSql, please check test code.
Of course I will set up documents in the future.

Setup

First of all, set up $config like this,

Simple Query

When you want to execute a simple sql, you can use SQueryManager(Simple Query).
* When you don't need to execute complex sql.

1. connect with the config and get a SSql object
2. let it know you use SQueryManager with createSQry method
3. build a sql with some methods, they're Doctrine like
4. execute it, and get a Result

Update, Delete, Insert operations are almost same as above.

They build sqls like below.

Simple Sql

When you want to execute a complicate sql, you can use SSqlManager(Simple Sql).

1. create sql files wherever you want. it's path should be set in $config['sqlDir'].
2. connect with the config and get SSql object(same as Simple Query)
3. execute selectList with sqlfile name(without extension) and parameters for sqlfile

SSql builts a sql below and execute.
The written parameters in the selectUser.sql, 2 of id and 10 of status, are trimmed. This advantage of sql file with parameter comment is that you can build and test sql in Database tool(e.g MySqlWorkbench), and then controll parameters in you application with parameter.

If you don't pass id, AND is removed automatically.

If parameter, paging is false, ELSE line is valid and ORDER is removed.

Others

The SSql has beginTransaction, commit, rollback methods itself.