You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+14-4Lines changed: 14 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
# Yazan - SQLToCIBuilder
1
+
# Yazan - SQL-To-CI-Builder
2
2
SQL to Codeigniter Query Builder, A Converter written in PHP
3
3
4
4
### Features
@@ -81,13 +81,23 @@ Some important options are briefly explained below:
81
81
| single_line | boolean | true | When this argument is true, then converter tries to generate a single command instead of multiple. |
82
82
83
83
### How does it works ?
84
-
Will be explained soon.
84
+
SQL-To-CI-Builder is built on top of <ahref="hhttps://github.com/greenlion/PHP-SQL-Parser">PHP-SQL-Parser</a>. While <ahref="hhttps://github.com/greenlion/PHP-SQL-Parser">PHP-SQL-Parser</a> is responsible for parsing the given SQL Query as input. The result of the <ahref="hhttps://github.com/greenlion/PHP-SQL-Parser">PHP-SQL-Parser</a> is the input of SQL-To-CI-Builder.
85
+
86
+
The structure has three main parts :
87
+
1) Extractors classes - which help to pull out SQL Query parts in a way which are more understandable and processable by Builders.
88
+
2) Builder classes - which help to construct Query Builder methods.
89
+
3) Creator - which orchestrates the process between Extractors and Builders in order to produce parts of Query Builder.
85
90
86
91
### Known issues
87
-
Will be explained soon.
92
+
It is not tested in all cases. They should be added.
93
+
Poor error handling.
94
+
95
+
96
+
### Contributions
97
+
Feel free to contribute. Either on development or testing.
88
98
89
99
### Support
90
-
For general questions about Yazan - SQLToCIBuilder, tweet at @rexshijaku or write me an email on rexhepshijaku@gmail.com.
100
+
For general questions about Yazan - SQL-To-CI-Builder, tweet at @rexshijaku or write me an email on rexhepshijaku@gmail.com.
91
101
To have a quick tutorial check the examples folder provided in the repository.
0 commit comments