sqlfix.txt

*sqlfix.txt* SQL pretty print.

Author:  KazuakiM <twitter@NanohaAsOnKai>
License: MIT License.

==============================================================================
CONTENTS					*sqlfix-contents*

INTRODUCTION			|sqlfix-introduction|
INTERFACE			|sqlfix-interface|
  OPTIONS			  |sqlfix-options|
  COMMANDS			  |sqlfix-commands|
  FUNCTIONS			  |sqlfix-functions|

==============================================================================
INTRODUCTION					*sqlfix-introduction*

This Vim plugin is SQL pretty print.
vim-sqlfix's goal is support FrameWork application log format.

==============================================================================
INTERFACE					*sqlfix-interface*

------------------------------------------------------------------------------
OPTIONS						*sqlfix-options*

g:sqlfix#Config = {list}			*g:sqlfix#Config*
	This variable is plugin config variable.
>
	let g:sqlfix#Config = {
		\ 'database': 'postgresql',
		\ 'indent': 2,
		\ 'width': -1,
		\ 'explain': 1,
		\ 'output': 1,
		\ 'direcotry_path': ''}
<
database					*sqlfix-options-database*
		Set useing database, 'mysql' or 'postgresql'.
		Default value is 'mysql'.

indent						*sqlfix-options-indent*
		Set indent spaces. Default value is '4'.

width						*sqlfix-options-width*
		Set line length. This function is invalidated by '-1'.
		Default value is '180'.

explain						*sqlfix-options-explain*
		If you want to set a 'EXPLAIN( ANALYZE)', you set '1'.
		Default value is '0'(disable).

output						*sqlfix-options-output*
		If you want to output at buffer, you set '1'.
		Default value is '1'(enable).

direcotry_path					*sqlfix-options-direcotry_path*
		If you want SQL file or |SqlffixRun|, you set directory
		path. Default value is ''(disable).

------------------------------------------------------------------------------
COMMANDS					*sqlfix-commands*

:Sqlfix						*:Sqlfix*
	Execute |sqlfix#Normal()|.

:'<,'>Sqlfix					*:'<,'>Sqlfix*
	Execute |sqlfix#Visual()|.

:SqlfixFile					*:SqlfixFile*
	Execute |sqlfix#NormalFile()|.

:'<,'>SqlfixFile				*:'<,'>SqlfixFile*
	Execute |sqlfix#VisualFile()|.

:SqlfixRun					*:SqlfixRun*
	Execute |sqlfix#Run()|.

------------------------------------------------------------------------------
FUNCTIONS					*sqlfix-functions*

sqlfix#Normal()					*sqlfix#Normal()*
	The last selected text(SQL) in visual mode is formatted at Buffer.

sqlfix#Visual()					*sqlfix#Visual()*
	Now selected text(SQL) in visual mode is formatted at Buffer.

sqlfix#NormalFile()				*sqlfix#NormalFile()*
	The last selected text(SQL) in visual mode is formatted at File.

sqlfix#VisualFile()				*sqlfix#VisualFile()*
	Now selected text(SQL) in visual mode is formatted at File.

sqlfix#Run()					*sqlfix#Run()*
	This function is depend on |quickrun| and
	|sqlfix-options-direcotry_path|.
MySQL sample
>
	let g:quickrun_config = {
		\ 'sql': {'type': 'sql/mysql'},
		\ 'sql/mysql': {
		\     'cmdopt':
		\         '--user=root --password= --host=localhost '.
		\         '--port=3306 --database=sample --connect-timeout=5'}
<

==============================================================================
vim:tw=78:ts=8:ft=help:norl