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 `phpmyadmin/sql-parser`__.
  69
  70 __ https://github.com/phpmyadmin/sql-parser
  71
  72
  73 ======================
  74 Install using composer
  75 ======================
  76 Run ``composer require cweiske/php-sqllint``, the package is hosted on `packagist <https://packagist.org/packages/cweiske/php-sqllint>`__
  77
  78
  79 ========
  80 Download
  81 ========
  82 The download files are equipped with all dependencies.
  83 Just download and run.
  84
  85 .. LATESTRELEASE
  86
  87 See `php-sqllint downloads page <http://cweiske.de/php-sqllint-download.htm>`_
  88 for all released versions.
  89
  90
  91 ============
  92 Dependencies
  93 ============
  94 - PEAR's `Console_Commandline`__
  95 - `phpMyAdmin's SqlParser`__
  96
  97 __ http://pear.php.net/package/Console_CommandLine
  98 __ https://github.com/phpmyadmin/sql-parser
  99
 100
 101 Dependency installation
 102 =======================
 103 ::
 104
 105     $ composer install
 106
 107 Now you can use ``./bin/php-sqllint`` without building the phar yourself.
 108
 109
 110 ========
 111 Building
 112 ========
 113
 114 Preparation
 115 ===========
 116 1. Write new version number into ``VERSION``
 117
 118
 119 Create the release
 120 ==================
 121 You'll need `phing`__, the PHP build tool::
 122
 123     $ phing
 124
 125 __ https://www.phing.info/
 126
 127 The result are ``.phar`` files in ``dist/`` directory that you can execute::
 128
 129     $ ./dist/php-sqllint-0.0.1.phar tests/files/create-noname.sql
 130     Checking SQL syntax of tests/files/create-noname.sql
 131      Line 1, col 12 at "(": The name of the entity was expected.
 132
 133
 134 =================
 135 About PHP-SQLlint
 136 =================
 137
 138 License
 139 =======
 140 ``php-sqllint`` is licensed under the `AGPL v3`__ or later.
 141
 142 __ http://www.gnu.org/licenses/agpl.html
 143
 144
 145 Homepage
 146 ========
 147 Home page
 148    http://cweiske.de/php-sqllint.htm
 149 Source code
 150    http://git.cweiske.de/php-sqllint.git
 151
 152    Mirror: https://github.com/cweiske/php-sqllint
 153
 154
 155 Author
 156 ======
 157 Written by `Christian Weiske`__, [email protected]
 158
 159 __ http://cweiske.de/