add download links for 0.1.0
[php-sqllint.git] / README.rst
1 ***********
2 PHP-SQLlint
3 ***********
4
5 Command line tool to validate (syntax check) SQL files.
6 Primarily for MySQL ``.sql`` files.
7
8 Can be used in git pre-commit hooks to catch errors.
9 Use it from your shell, offline and without any SQL server.
10
11 You can also use it to format SQL queries.
12
13
14 =====
15 Usage
16 =====
17 Syntax check::
18
19     $ php-sqllint tests/files/create-missingcomma.sql 
20     Checking SQL syntax of tests/files/create-missingcomma.sql
21      Line 3, col 5 at "pid": A comma or a closing bracket was expected.
22      Line 3, col 13 at "11": Unexpected beginning of statement.
23      Line 3, col 17 at "DEFAULT": Unrecognized statement type.
24
25 Emacs mode::
26
27     $ php-sqllint -r emacs tests/files/create-noname.sql 
28     tests/files/create-noname.sql:1.12:Error: The name of the entity was expected.
29     tests/files/create-noname.sql:1.13:Error: A closing bracket was expected.
30     tests/files/create-noname.sql:1.13:Error: At least one column definition was expected.
31
32
33 Formatting::
34
35     $ php-sqllint --format tests/files/select-unformatted.sql
36     SELECT
37       id,
38       NAME,
39       url
40     FROM
41       users
42     WHERE
43       DATE > NOW() AND id != 0
44     ORDER BY NAME
45     LIMIT 10
46
47
48 Syntax highlighting
49 ===================
50 ANSI colors are applied automatically when not piping; you can use the
51 ``--highlight`` option to override the automatism.
52
53 ``--highlight`` option values:
54
55 ``none``
56   No highlighting. Use it to disable automatic highlighting
57 ``ansi``
58   ANSI escape codes for your shell
59 ``html``
60   HTML tags
61
62
63 ====
64 Bugs
65 ====
66 Does ``php-sqllint`` not detect a syntax error, or doesn't support a certain
67 SQL statement?
68 Then please report a bug at `udan11/sql-parser`__.
69
70 __ https://github.com/udan11/sql-parser
71
72
73 ========
74 Download
75 ========
76 The download files are equipped with all dependencies.
77 Just download and run.
78
79 Version 0.1.0, 2015-12-21
80
81 - `php-sqllint-0.1.0.bz2.phar <http://cweiske.de/download/php-sqllint/php-sqllint-0.1.0.bz2.phar>`__
82
83   - 178 kiB
84   - SHA256: ``d04c62c4516d0d26a4fe84a33690c0ac04b7a8aa98f9a019d5bd911eff8f7fdf``
85 - `php-sqllint-0.1.0.phar <http://cweiske.de/download/php-sqllint/php-sqllint-0.1.0.phar>`__
86
87   - 621 kiB
88   - SHA256: ``b68da880cef475abdbc4bcb0918a2dafc4f893727e3e1290172aad94b9409480``
89
90
91 ============
92 Dependencies
93 ============
94 - PEAR's `Console_Commandline`__
95 - `udan11's SqlParser`__, which is used by `phpMyAdmin`__
96
97 __ http://pear.php.net/package/Console_CommandLine
98 __ https://github.com/udan11/sql-parser
99 __ https://www.phpmyadmin.net/
100
101
102 Dependency installation
103 =======================
104 ::
105
106     $ composer install
107
108 Now you can use ``./bin/php-sqllint`` without building the phar yourself.
109
110
111 ========
112 Building
113 ========
114
115 Preparation
116 ===========
117 1. Write new version number into ``VERSION``
118
119
120 Create the release
121 ==================
122 You'll need `phing`__, the PHP build tool::
123
124     $ phing
125
126 __ https://www.phing.info/
127
128 The result are ``.phar`` files in ``dist/`` directory that you can execute::
129
130     $ ./dist/php-sqllint-0.0.1.phar tests/files/create-noname.sql 
131     Checking SQL syntax of tests/files/create-noname.sql
132      Line 1, col 12 at "(": The name of the entity was expected.
133
134
135 =================
136 About PHP-SQLlint
137 =================
138
139 License
140 =======
141 ``php-sqllint`` is licensed under the `AGPL v3`__ or later.
142
143 __ http://www.gnu.org/licenses/agpl.html
144
145
146 Homepage
147 ========
148 Home page
149    http://cweiske.de/php-sqllint.htm
150 Source code
151    http://git.cweiske.de/php-sqllint.git
152
153    Mirror: https://github.com/cweiske/php-sqllint
154
155
156 Author
157 ======
158 Written by `Christian Weiske`__, cweiske+php-sqllint@cweiske.de
159
160 __ http://cweiske.de/