OLD | NEW |
1 .\" Hey, EMACS: -*- nroff -*- | 1 .\" Hey, EMACS: -*- nroff -*- |
2 .\" First parameter, NAME, should be all caps | 2 .\" First parameter, NAME, should be all caps |
3 .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection | 3 .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection |
4 .\" other parameters are allowed: see man(7), man(1) | 4 .\" other parameters are allowed: see man(7), man(1) |
5 .TH SQLITE3 1 "Mon Apr 15 23:49:17 2002" | 5 .TH SQLITE3 1 "Mon Jan 31 11:14:00 2014" |
6 .\" Please adjust this date whenever revising the manpage. | 6 .\" Please adjust this date whenever revising the manpage. |
7 .\" | 7 .\" |
8 .\" Some roff macros, for reference: | 8 .\" Some roff macros, for reference: |
9 .\" .nh disable hyphenation | 9 .\" .nh disable hyphenation |
10 .\" .hy enable hyphenation | 10 .\" .hy enable hyphenation |
11 .\" .ad l left justify | 11 .\" .ad l left justify |
12 .\" .ad b justify to both left and right margins | 12 .\" .ad b justify to both left and right margins |
13 .\" .nf disable filling | 13 .\" .nf disable filling |
14 .\" .fi enable filling | 14 .\" .fi enable filling |
15 .\" .br insert line break | 15 .\" .br insert line break |
(...skipping 26 matching lines...) Expand all Loading... |
42 command and optionally provide the name of a database file. If the | 42 command and optionally provide the name of a database file. If the |
43 database file does not exist, it will be created. If the database file | 43 database file does not exist, it will be created. If the database file |
44 does exist, it will be opened. | 44 does exist, it will be opened. |
45 | 45 |
46 For example, to create a new database file named "mydata.db", create | 46 For example, to create a new database file named "mydata.db", create |
47 a table named "memos" and insert a couple of records into that table: | 47 a table named "memos" and insert a couple of records into that table: |
48 .sp | 48 .sp |
49 $ | 49 $ |
50 .B sqlite3 mydata.db | 50 .B sqlite3 mydata.db |
51 .br | 51 .br |
52 SQLite version 3.1.3 | 52 SQLite version 3.8.3 |
53 .br | 53 .br |
54 Enter ".help" for instructions | 54 Enter ".help" for instructions |
55 .br | 55 .br |
56 sqlite> | 56 sqlite> |
57 .B create table memos(text, priority INTEGER); | 57 .B create table memos(text, priority INTEGER); |
58 .br | 58 .br |
59 sqlite> | 59 sqlite> |
60 .B insert into memos values('deliver project description', 10); | 60 .B insert into memos values('deliver project description', 10); |
61 .br | 61 .br |
62 sqlite> | 62 sqlite> |
(...skipping 38 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
101 attached databases (such as rebuilding indices). Meta-commands are | 101 attached databases (such as rebuilding indices). Meta-commands are |
102 always prefixed with a dot (.). | 102 always prefixed with a dot (.). |
103 | 103 |
104 A list of available meta-commands can be viewed at any time by issuing | 104 A list of available meta-commands can be viewed at any time by issuing |
105 the '.help' command. For example: | 105 the '.help' command. For example: |
106 .sp | 106 .sp |
107 sqlite> | 107 sqlite> |
108 .B .help | 108 .B .help |
109 .nf | 109 .nf |
110 .cc | | 110 .cc | |
| 111 .backup ?DB? FILE Backup DB (default "main") to FILE |
| 112 .bail ON|OFF Stop after hitting an error. Default OFF |
111 .databases List names and files of attached databases | 113 .databases List names and files of attached databases |
112 .dump ?TABLE? ... Dump the database in an SQL text format | 114 .dump ?TABLE? ... Dump the database in an SQL text format |
| 115 If TABLE specified, only dump tables matching |
| 116 LIKE pattern TABLE. |
113 .echo ON|OFF Turn command echo on or off | 117 .echo ON|OFF Turn command echo on or off |
114 .exit Exit this program | 118 .exit Exit this program |
115 .explain ON|OFF Turn output mode suitable for EXPLAIN on or off. | 119 .explain ?ON|OFF? Turn output mode suitable for EXPLAIN on or off. |
| 120 With no args, it turns EXPLAIN on. |
116 .header(s) ON|OFF Turn display of headers on or off | 121 .header(s) ON|OFF Turn display of headers on or off |
117 .help Show this message | 122 .help Show this message |
118 .import FILE TABLE Import data from FILE into TABLE | 123 .import FILE TABLE Import data from FILE into TABLE |
119 .indices TABLE Show names of all indices on TABLE | 124 .indices ?TABLE? Show names of all indices |
| 125 If TABLE specified, only show indices for tables |
| 126 matching LIKE pattern TABLE. |
| 127 .load FILE ?ENTRY? Load an extension library |
| 128 .log FILE|off Turn logging on or off. FILE can be stderr/stdout |
120 .mode MODE ?TABLE? Set output mode where MODE is one of: | 129 .mode MODE ?TABLE? Set output mode where MODE is one of: |
121 csv Comma-separated values | 130 csv Comma-separated values |
122 column Left-aligned columns. (See .width) | 131 column Left-aligned columns. (See .width) |
123 html HTML <table> code | 132 html HTML <table> code |
124 insert SQL insert statements for TABLE | 133 insert SQL insert statements for TABLE |
125 line One value per line | 134 line One value per line |
126 list Values delimited by .separator string | 135 list Values delimited by .separator string |
127 tabs Tab-separated values | 136 tabs Tab-separated values |
128 tcl TCL list elements | 137 tcl TCL list elements |
129 .nullvalue STRING Print STRING in place of NULL values | 138 .nullvalue STRING Use STRING in place of NULL values |
| 139 .open ?FILENAME? Close existing database and reopen FILENAME |
130 .output FILENAME Send output to FILENAME | 140 .output FILENAME Send output to FILENAME |
131 .output stdout Send output to the screen | 141 .output stdout Send output to the screen |
| 142 .print STRING... Print literal STRING |
132 .prompt MAIN CONTINUE Replace the standard prompts | 143 .prompt MAIN CONTINUE Replace the standard prompts |
133 .quit Exit this program | 144 .quit Exit this program |
134 .read FILENAME Execute SQL in FILENAME | 145 .read FILENAME Execute SQL in FILENAME |
| 146 .restore ?DB? FILE Restore content of DB (default "main") from FILE |
135 .schema ?TABLE? Show the CREATE statements | 147 .schema ?TABLE? Show the CREATE statements |
| 148 If TABLE specified, only show tables matching |
| 149 LIKE pattern TABLE. |
136 .separator STRING Change separator used by output mode and .import | 150 .separator STRING Change separator used by output mode and .import |
137 .show Show the current values for various settings | 151 .show Show the current values for various settings |
138 .tables ?PATTERN? List names of tables matching a LIKE pattern | 152 .stats ON|OFF Turn stats on or off |
| 153 .tables ?TABLE? List names of tables |
| 154 If TABLE specified, only list tables matching |
| 155 LIKE pattern TABLE. |
139 .timeout MS Try opening locked tables for MS milliseconds | 156 .timeout MS Try opening locked tables for MS milliseconds |
140 .width NUM NUM ... Set column widths for "column" mode | 157 .trace FILE|off Output each SQL statement as it is run |
| 158 .vfsname ?AUX? Print the name of the VFS stack |
| 159 .width NUM1 NUM2 ... Set column widths for "column" mode |
| 160 .timer ON|OFF Turn the CPU timer measurement on or off |
141 sqlite> | 161 sqlite> |
142 |cc . | 162 |cc . |
143 .sp | 163 .sp |
144 .fi | 164 .fi |
145 | |
146 .SH OPTIONS | 165 .SH OPTIONS |
147 .B sqlite3 | 166 .B sqlite3 |
148 has the following options: | 167 has the following options: |
149 .TP | 168 .TP |
150 .BI \-init\ file | 169 .B \-bail |
151 Read and execute commands from | 170 Stop after hitting an error. |
152 .I file | |
153 , which can contain a mix of SQL statements and meta-commands. | |
154 .TP | 171 .TP |
155 .B \-echo | 172 .B \-batch |
156 Print commands before execution. | 173 Force batch I/O. |
157 .TP | |
158 .B \-[no]header | |
159 Turn headers on or off. | |
160 .TP | 174 .TP |
161 .B \-column | 175 .B \-column |
162 Query results will be displayed in a table like form, using | 176 Query results will be displayed in a table like form, using |
163 whitespace characters to separate the columns and align the | 177 whitespace characters to separate the columns and align the |
164 output. | 178 output. |
165 .TP | 179 .TP |
| 180 .BI \-cmd\ command |
| 181 run |
| 182 .I command |
| 183 before reading stdin |
| 184 .TP |
| 185 .B \-csv |
| 186 Set output mode to CSV (comma separated values). |
| 187 .TP |
| 188 .B \-echo |
| 189 Print commands before execution. |
| 190 .TP |
| 191 .BI \-init\ file |
| 192 Read and execute commands from |
| 193 .I file |
| 194 , which can contain a mix of SQL statements and meta-commands. |
| 195 .TP |
| 196 .B \-[no]header |
| 197 Turn headers on or off. |
| 198 .TP |
| 199 .B \-help |
| 200 Show help on options and exit. |
| 201 .TP |
166 .B \-html | 202 .B \-html |
167 Query results will be output as simple HTML tables. | 203 Query results will be output as simple HTML tables. |
168 .TP | 204 .TP |
| 205 .B \-interactive |
| 206 Force interactive I/O. |
| 207 .TP |
169 .B \-line | 208 .B \-line |
170 Query results will be displayed with one value per line, rows | 209 Query results will be displayed with one value per line, rows |
171 separated by a blank line. Designed to be easily parsed by | 210 separated by a blank line. Designed to be easily parsed by |
172 scripts or other programs | 211 scripts or other programs |
173 .TP | 212 .TP |
174 .B \-list | 213 .B \-list |
175 Query results will be displayed with the separator (|, by default) | 214 Query results will be displayed with the separator (|, by default) |
176 character between each field value. The default. | 215 character between each field value. The default. |
177 .TP | 216 .TP |
178 .BI \-separator\ separator | 217 .BI \-mmap\ N |
179 Set output field separator. Default is '|'. | 218 Set default mmap size to |
| 219 .I N |
| 220 \. |
180 .TP | 221 .TP |
181 .BI \-nullvalue\ string | 222 .BI \-nullvalue\ string |
182 Set string used to represent NULL values. Default is '' | 223 Set string used to represent NULL values. Default is '' |
183 (empty string). | 224 (empty string). |
184 .TP | 225 .TP |
| 226 .BI \-separator\ separator |
| 227 Set output field separator. Default is '|'. |
| 228 .TP |
| 229 .B \-stats |
| 230 Print memory stats before each finalize. |
| 231 .TP |
185 .B \-version | 232 .B \-version |
186 Show SQLite version. | 233 Show SQLite version. |
187 .TP | 234 .TP |
188 .B \-help | 235 .BI \-vfs\ name |
189 Show help on options and exit. | 236 Use |
| 237 .I name |
| 238 as the default VFS. |
190 | 239 |
191 | 240 |
192 .SH INIT FILE | 241 .SH INIT FILE |
193 .B sqlite3 | 242 .B sqlite3 |
194 reads an initialization file to set the configuration of the | 243 reads an initialization file to set the configuration of the |
195 interactive environment. Throughout initialization, any previously | 244 interactive environment. Throughout initialization, any previously |
196 specified setting can be overridden. The sequence of initialization is | 245 specified setting can be overridden. The sequence of initialization is |
197 as follows: | 246 as follows: |
198 | 247 |
199 o The default configuration is established as follows: | 248 o The default configuration is established as follows: |
(...skipping 15 matching lines...) Expand all Loading... |
215 can be found in the user's home directory, it is | 264 can be found in the user's home directory, it is |
216 read and processed. It should generally only contain meta-commands. | 265 read and processed. It should generally only contain meta-commands. |
217 | 266 |
218 o If the -init option is present, the specified file is processed. | 267 o If the -init option is present, the specified file is processed. |
219 | 268 |
220 o All other command line options are processed. | 269 o All other command line options are processed. |
221 | 270 |
222 .SH SEE ALSO | 271 .SH SEE ALSO |
223 http://www.sqlite.org/ | 272 http://www.sqlite.org/ |
224 .br | 273 .br |
225 The sqlite-doc package | 274 The sqlite3-doc package. |
226 .SH AUTHOR | 275 .SH AUTHOR |
227 This manual page was originally written by Andreas Rottmann | 276 This manual page was originally written by Andreas Rottmann |
228 <rotty@debian.org>, for the Debian GNU/Linux system (but may be used | 277 <rotty@debian.org>, for the Debian GNU/Linux system (but may be used |
229 by others). It was subsequently revised by Bill Bumgarner <bbum@mac.com>. | 278 by others). It was subsequently revised by Bill Bumgarner <bbum@mac.com> and |
| 279 further updated by Laszlo Boszormenyi <gcs@debian.hu> . |
OLD | NEW |