Mercurial > vim_plugins > dbtables

annotate doc/dbtables.txt @ 2:c19add1b66a9 default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
updated mappings
author Luka Sitas <lsitas@avatarasoftware.com>
date Wed, 11 Mar 2026 12:03:31 -0400
parents 8530ebeda72c
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
1 *dbtables.txt* Database interaction in Vim
0
238b45cc333b Initial Commit
Luka Sitas <lsitas@avatarasoftware.com>
parents:
diff changeset
2
238b45cc333b Initial Commit
Luka Sitas <lsitas@avatarasoftware.com>
parents:
diff changeset
3 INTRODUCTION *dbtables*
238b45cc333b Initial Commit
Luka Sitas <lsitas@avatarasoftware.com>
parents:
diff changeset
4
1
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
5 dbtables is a small plugin to interact with a database from Vim:
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
6 - Browse tables in a dedicated window
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
7 - Execute SQL from the current buffer (normal and visual mode)
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
8 - Open a DB console
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
9 - Manage query history and snippets
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
10
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
11 It is intended as a lightweight helper for SQL work inside Vim.
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
12
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
13 INSTALLATION *dbtables-install*
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
14
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
15 Using vim-plug, add the following to your vimrc/init.vim:
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
16
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
17 Plug '/home/lsitas/repos/vim_plugins/dbtables'
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
18
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
19 Then run:
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
20
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
21 :PlugInstall
0
238b45cc333b Initial Commit
Luka Sitas <lsitas@avatarasoftware.com>
parents:
diff changeset
22
238b45cc333b Initial Commit
Luka Sitas <lsitas@avatarasoftware.com>
parents:
diff changeset
23 USAGE *dbtables-usage*
238b45cc333b Initial Commit
Luka Sitas <lsitas@avatarasoftware.com>
parents:
diff changeset
24
1
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
25 The plugin defines the following user commands and mappings.
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
26
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
27 COMMANDS *dbtables-commands*
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
28
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
29 *:DBTables*
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
30 :DBTables
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
31 Open the database tables window. Selecting a table can show
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
32 the schema of the table or all the data in the table.
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
33
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
34 *:DBConsole*
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
35 :DBConsole
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
36 Opens a console for interacting with the database.
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
37
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
38 *:ExecuteSQL*
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
39 :ExecuteSQL
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
40 Execute the SQL query from the current buffer. If there are
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
41 query parameters included, the user will be prompted to
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
42 fill them in.
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
43
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
44 Example:
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
45 """
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
46 SELECT
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
47 id,
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
48 name
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
49 FROM
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
50 my_table
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
51 WHERE
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
52 id > :min_id;
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
53 """
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
54
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
55 The user will be prompted for a value for `min_id`
0
238b45cc333b Initial Commit
Luka Sitas <lsitas@avatarasoftware.com>
parents:
diff changeset
56
1
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
57 *:QueryHistory*
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
58 :QueryHistory
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
59 Opens the list of recently ran queries. Selecting a query will
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
60 re-run the query. All parameters are already filled in.
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
61
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
62 *:QuerySnippets*
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
63 :QuerySnippets
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
64 Opens the list of saved query snippets. Selecting a snippet will
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
65 open the snippet in a new tab for modification or execution.
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
66
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
67 MAPPINGS *dbtables-mappings*
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
68
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
69 All mappings use the <Leader> key in normal or visual mode.
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
70
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
71 In NORMAL mode:
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
72
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
73 <Leader>dt
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
74 Same as |:DBTables|. Open the database tables window.
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
75
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
76 <Leader>eq
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
77 Same as |:ExecuteSQL|. Execute SQL from the current buffer.
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
78
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
79 <Leader>db
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
80 Same as |:DBConsole|. Open an interactive DB console.
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
81
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
82 <Leader>qh
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
83 Same as |:QueryHistory|. Open the query history list.
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
84
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
85 <Leader>qs
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
86 Same as |:QuerySnippets|. Open the query snippets list.
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
87
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
88 In VISUAL mode:
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
89
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
90 <Leader>ev
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
91 Call dbtables#ExecuteVisualSQLQuery(). Execute only the
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
92 visually selected SQL text.
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
93
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
94 CONFIGURATION *dbtables-config*
0
238b45cc333b Initial Commit
Luka Sitas <lsitas@avatarasoftware.com>
parents:
diff changeset
95
1
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
96 The plugin exposes several global variables you can set in your
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
97 vimrc/init.vim before the plugin is loaded. Each has a default value
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
98 if you do not define it.
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
99
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
100 *g:snippets_directory*
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
101 g:snippets_directory
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
102 Directory where query snippets are stored and loaded from.
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
103
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
104 Default:
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
105 $HOME/.config/heidisql/Snippets
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
106
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
107 Example:
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
108
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
109 let g:snippets_directory = expand('~/.vim/db_snippets')
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
110
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
111 *g:db_user*
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
112 g:db_user
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
113 Database username used by the plugin when connecting or running
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
114 queries.
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
115
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
116 Default:
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
117 '' (empty string; you must set this to actually connect)
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
118
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
119 Example:
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
120
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
121 let g:db_user = 'myuser'
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
122
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
123 *g:db_password*
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
124 g:db_password
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
125 Database password associated with |g:db_user|.
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
126
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
127 Default:
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
128 '' (empty string; set this if your DB requires a password)
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
129
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
130 Example:
0
238b45cc333b Initial Commit
Luka Sitas <lsitas@avatarasoftware.com>
parents:
diff changeset
131
1
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
132 let g:db_password = 'mypassword'
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
133
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
134 *g:db_name*
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
135 g:db_name
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
136 Default database/schema name to connect to.
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
137
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
138 Default:
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
139 '' (empty string; set this to the DB you want to use)
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
140
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
141 Example:
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
142
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
143 let g:db_name = 'mydatabase'
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
144
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
145 *g:db_host*
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
146 g:db_host
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
147 Hostname or IP address of the database server.
0
238b45cc333b Initial Commit
Luka Sitas <lsitas@avatarasoftware.com>
parents:
diff changeset
148
1
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
149 Default:
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
150 '' (empty string; set this to your DB host, e.g. 'localhost')
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
151
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
152 Example:
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
153
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
154 let g:db_host = 'localhost'
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
155
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
156 NOTES *dbtables-notes*
0
238b45cc333b Initial Commit
Luka Sitas <lsitas@avatarasoftware.com>
parents:
diff changeset
157
1
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
158 - All mappings are defined in the plugin by default. If you prefer
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
159 your own keybindings, you can `:nunmap` or `:xunmap` them and
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
160 create custom mappings to the same functions
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
161 (e.g. dbtables#ExecuteSQLQuery()).
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
162
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
163 - This help file documents only the public interface (commands,
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
164 mappings, and configuration variables). The internal functions
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
165 under the dbtables# namespace are intended to be called by these
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
166 interfaces, but you may also call them directly if you know what
8530ebeda72c Adding actual db tables implementation from original script.
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
167 you are doing.
0
238b45cc333b Initial Commit
Luka Sitas <lsitas@avatarasoftware.com>
parents:
diff changeset
168
238b45cc333b Initial Commit
Luka Sitas <lsitas@avatarasoftware.com>
parents:
diff changeset
169 *dbtables* Main help entry for this plugin.