4 ** The author disclaims copyright to this source code. In place of
5 ** a legal notice, here is a blessing:
7 ** May you do good and not evil.
8 ** May you find forgiveness for yourself and forgive others.
9 ** May you share freely, never taking more than you give.
11 *************************************************************************
12 ** This file contains code to implement the "sqlite" command line
13 ** utility for accessing SQLite databases.
15 #if (defined(_WIN32) || defined(WIN32)) && !defined(_CRT_SECURE_NO_WARNINGS)
16 /* This needs to come before any includes for MSVC compiler */
17 #define _CRT_SECURE_NO_WARNINGS
19 typedef unsigned int u32
;
20 typedef unsigned short int u16
;
23 ** Optionally #include a user-defined header, whereby compilation options
24 ** may be set prior to where they take effect, but after platform setup.
25 ** If SQLITE_CUSTOM_INCLUDE=? is defined, its value names the #include
26 ** file. Note that this macro has a like effect on sqlite3.c compilation.
28 # define SHELL_STRINGIFY_(f) #f
29 # define SHELL_STRINGIFY(f) SHELL_STRINGIFY_(f)
30 #ifdef SQLITE_CUSTOM_INCLUDE
31 # include SHELL_STRINGIFY(SQLITE_CUSTOM_INCLUDE)
35 ** Determine if we are dealing with WinRT, which provides only a subset of
36 ** the full Win32 API.
38 #if !defined(SQLITE_OS_WINRT)
39 # define SQLITE_OS_WINRT 0
43 ** If SQLITE_SHELL_FIDDLE is defined then the shell is modified
44 ** somewhat for use as a WASM module in a web browser. This flag
45 ** should only be used when building the "fiddle" web application, as
46 ** the browser-mode build has much different user input requirements
47 ** and this build mode rewires the user input subsystem to account for
52 ** Warning pragmas copied from msvc.h in the core.
55 #pragma warning(disable : 4054)
56 #pragma warning(disable : 4055)
57 #pragma warning(disable : 4100)
58 #pragma warning(disable : 4127)
59 #pragma warning(disable : 4130)
60 #pragma warning(disable : 4152)
61 #pragma warning(disable : 4189)
62 #pragma warning(disable : 4206)
63 #pragma warning(disable : 4210)
64 #pragma warning(disable : 4232)
65 #pragma warning(disable : 4244)
66 #pragma warning(disable : 4305)
67 #pragma warning(disable : 4306)
68 #pragma warning(disable : 4702)
69 #pragma warning(disable : 4706)
70 #endif /* defined(_MSC_VER) */
73 ** No support for loadable extensions in VxWorks.
75 #if (defined(__RTP__) || defined(_WRS_KERNEL)) && !SQLITE_OMIT_LOAD_EXTENSION
76 # define SQLITE_OMIT_LOAD_EXTENSION 1
80 ** Enable large-file support for fopen() and friends on unix.
82 #ifndef SQLITE_DISABLE_LFS
83 # define _LARGE_FILE 1
84 # ifndef _FILE_OFFSET_BITS
85 # define _FILE_OFFSET_BITS 64
87 # define _LARGEFILE_SOURCE 1
90 #if defined(SQLITE_SHELL_FIDDLE) && !defined(_POSIX_SOURCE)
92 ** emcc requires _POSIX_SOURCE (or one of several similar defines)
93 ** to expose strdup().
95 # define _POSIX_SOURCE
104 typedef sqlite3_int64 i64
;
105 typedef sqlite3_uint64 u64
;
106 typedef unsigned char u8
;
107 #if SQLITE_USER_AUTHENTICATION
108 # include "sqlite3userauth.h"
113 #if !defined(_WIN32) && !defined(WIN32)
115 # if !defined(__RTP__) && !defined(_WRS_KERNEL) && !defined(SQLITE_WASI)
119 #if (!defined(_WIN32) && !defined(WIN32)) || defined(__MINGW32__)
122 # define GETPID getpid
123 # if defined(__MINGW32__)
124 # define DIRENT dirent
126 # define S_ISLNK(mode) (0)
130 # define GETPID (int)GetCurrentProcessId
132 #include <sys/types.h>
133 #include <sys/stat.h>
136 # include <readline/readline.h>
137 # include <readline/history.h>
141 # include <editline/readline.h>
144 #if HAVE_EDITLINE || HAVE_READLINE
146 # define shell_add_history(X) add_history(X)
147 # define shell_read_history(X) read_history(X)
148 # define shell_write_history(X) write_history(X)
149 # define shell_stifle_history(X) stifle_history(X)
150 # define shell_readline(X) readline(X)
154 # include "linenoise.h"
155 # define shell_add_history(X) linenoiseHistoryAdd(X)
156 # define shell_read_history(X) linenoiseHistoryLoad(X)
157 # define shell_write_history(X) linenoiseHistorySave(X)
158 # define shell_stifle_history(X) linenoiseHistorySetMaxLen(X)
159 # define shell_readline(X) linenoise(X)
163 # define shell_read_history(X)
164 # define shell_write_history(X)
165 # define shell_stifle_history(X)
167 # define SHELL_USE_LOCAL_GETLINE 1
170 #ifndef deliberate_fall_through
171 /* Quiet some compilers about some of our intentional code. */
172 # if defined(GCC_VERSION) && GCC_VERSION>=7000000
173 # define deliberate_fall_through __attribute__((fallthrough));
175 # define deliberate_fall_through
179 #if defined(_WIN32) || defined(WIN32)
181 # define SQLITE_OMIT_POPEN 1
185 # define isatty(h) _isatty(h)
187 # define access(f,m) _access((f),(m))
190 # define unlink _unlink
193 # define strdup _strdup
196 # define popen _popen
198 # define pclose _pclose
201 /* Make sure isatty() has a prototype. */
202 extern int isatty(int);
204 # if !defined(__RTP__) && !defined(_WRS_KERNEL) && !defined(SQLITE_WASI)
205 /* popen and pclose are not C89 functions and so are
206 ** sometimes omitted from the <stdio.h> header */
207 extern FILE *popen(const char*,const char*);
208 extern int pclose(FILE*);
210 # define SQLITE_OMIT_POPEN 1
214 #if defined(_WIN32_WCE)
215 /* Windows CE (arm-wince-mingw32ce-gcc) does not provide isatty()
216 * thus we always assume that we have a console. That can be
217 * overridden with the -batch command line option.
222 /* ctype macros that work with signed characters */
223 #define IsSpace(X) isspace((unsigned char)X)
224 #define IsDigit(X) isdigit((unsigned char)X)
225 #define ToLower(X) (char)tolower((unsigned char)X)
227 #if defined(_WIN32) || defined(WIN32)
231 #undef WIN32_LEAN_AND_MEAN
232 #define WIN32_LEAN_AND_MEAN
235 /* string conversion routines only needed on Win32 */
236 extern char *sqlite3_win32_unicode_to_utf8(LPCWSTR
);
237 extern LPWSTR
sqlite3_win32_utf8_to_unicode(const char *zText
);
240 /* Use console I/O package as a direct INCLUDE. */
241 #define SQLITE_INTERNAL_LINKAGE static
243 #ifdef SQLITE_SHELL_FIDDLE
244 /* Deselect most features from the console I/O package for Fiddle. */
245 # define SQLITE_CIO_NO_REDIRECT
246 # define SQLITE_CIO_NO_CLASSIFY
247 # define SQLITE_CIO_NO_TRANSLATE
248 # define SQLITE_CIO_NO_SETMODE
250 INCLUDE
../ext
/consio
/console_io
.h
251 INCLUDE
../ext
/consio
/console_io
.c
253 #ifndef SQLITE_SHELL_FIDDLE
255 /* From here onward, fgets() is redirected to the console_io library. */
256 # define fgets(b,n,f) fGetsUtf8(b,n,f)
258 * Define macros for emitting output text in various ways:
259 * sputz(s, z) => emit 0-terminated string z to given stream s
260 * sputf(s, f, ...) => emit varargs per format f to given stream s
261 * oputz(z) => emit 0-terminated string z to default stream
262 * oputf(f, ...) => emit varargs per format f to default stream
263 * eputz(z) => emit 0-terminated string z to error stream
264 * eputf(f, ...) => emit varargs per format f to error stream
265 * oputb(b, n) => emit char buffer b[0..n-1] to default stream
267 * Note that the default stream is whatever has been last set via:
268 * setOutputStream(FILE *pf)
269 * This is normally the stream that CLI normal output goes to.
270 * For the stand-alone CLI, it is stdout with no .output redirect.
272 # define sputz(s,z) fPutsUtf8(z,s)
273 # define sputf fPrintfUtf8
274 # define oputz(z) oPutsUtf8(z)
275 # define oputf oPrintfUtf8
276 # define eputz(z) ePutsUtf8(z)
277 # define eputf ePrintfUtf8
278 # define oputb(buf,na) oPutbUtf8(buf,na)
281 /* For Fiddle, all console handling and emit redirection is omitted. */
282 # define sputz(fp,z) fputs(z,fp)
283 # define sputf(fp,fmt, ...) fprintf(fp,fmt,__VA_ARGS__)
284 # define oputz(z) fputs(z,stdout)
285 # define oputf(fmt, ...) printf(fmt,__VA_ARGS__)
286 # define eputz(z) fputs(z,stderr)
287 # define eputf(fmt, ...) fprintf(stderr,fmt,__VA_ARGS__)
288 # define oputb(buf,na) fwrite(buf,1,na,stdout)
291 /* True if the timer is enabled */
292 static int enableTimer
= 0;
294 /* A version of strcmp() that works with NULL values */
295 static int cli_strcmp(const char *a
, const char *b
){
300 static int cli_strncmp(const char *a
, const char *b
, size_t n
){
303 return strncmp(a
,b
,n
);
306 /* Return the current wall-clock time */
307 static sqlite3_int64
timeOfDay(void){
308 static sqlite3_vfs
*clockVfs
= 0;
310 if( clockVfs
==0 ) clockVfs
= sqlite3_vfs_find(0);
311 if( clockVfs
==0 ) return 0; /* Never actually happens */
312 if( clockVfs
->iVersion
>=2 && clockVfs
->xCurrentTimeInt64
!=0 ){
313 clockVfs
->xCurrentTimeInt64(clockVfs
, &t
);
316 clockVfs
->xCurrentTime(clockVfs
, &r
);
317 t
= (sqlite3_int64
)(r
*86400000.0);
322 #if !defined(_WIN32) && !defined(WIN32) && !defined(__minux)
323 #include <sys/time.h>
324 #include <sys/resource.h>
326 /* VxWorks does not support getrusage() as far as we can determine */
327 #if defined(_WRS_KERNEL) || defined(__RTP__)
329 struct timeval ru_utime
; /* user CPU time used */
330 struct timeval ru_stime
; /* system CPU time used */
332 #define getrusage(A,B) memset(B,0,sizeof(*B))
335 /* Saved resource information for the beginning of an operation */
336 static struct rusage sBegin
; /* CPU time at start */
337 static sqlite3_int64 iBegin
; /* Wall-clock time at start */
340 ** Begin timing an operation
342 static void beginTimer(void){
344 getrusage(RUSAGE_SELF
, &sBegin
);
345 iBegin
= timeOfDay();
349 /* Return the difference of two time_structs in seconds */
350 static double timeDiff(struct timeval
*pStart
, struct timeval
*pEnd
){
351 return (pEnd
->tv_usec
- pStart
->tv_usec
)*0.000001 +
352 (double)(pEnd
->tv_sec
- pStart
->tv_sec
);
356 ** Print the timing results.
358 static void endTimer(void){
360 sqlite3_int64 iEnd
= timeOfDay();
362 getrusage(RUSAGE_SELF
, &sEnd
);
363 sputf(stdout
, "Run Time: real %.3f user %f sys %f\n",
364 (iEnd
- iBegin
)*0.001,
365 timeDiff(&sBegin
.ru_utime
, &sEnd
.ru_utime
),
366 timeDiff(&sBegin
.ru_stime
, &sEnd
.ru_stime
));
370 #define BEGIN_TIMER beginTimer()
371 #define END_TIMER endTimer()
374 #elif (defined(_WIN32) || defined(WIN32))
376 /* Saved resource information for the beginning of an operation */
377 static HANDLE hProcess
;
378 static FILETIME ftKernelBegin
;
379 static FILETIME ftUserBegin
;
380 static sqlite3_int64 ftWallBegin
;
381 typedef BOOL (WINAPI
*GETPROCTIMES
)(HANDLE
, LPFILETIME
, LPFILETIME
,
382 LPFILETIME
, LPFILETIME
);
383 static GETPROCTIMES getProcessTimesAddr
= NULL
;
386 ** Check to see if we have timer support. Return 1 if necessary
387 ** support found (or found previously).
389 static int hasTimer(void){
390 if( getProcessTimesAddr
){
394 /* GetProcessTimes() isn't supported in WIN95 and some other Windows
395 ** versions. See if the version we are running on has it, and if it
396 ** does, save off a pointer to it and the current process handle.
398 hProcess
= GetCurrentProcess();
400 HINSTANCE hinstLib
= LoadLibrary(TEXT("Kernel32.dll"));
401 if( NULL
!= hinstLib
){
402 getProcessTimesAddr
=
403 (GETPROCTIMES
) GetProcAddress(hinstLib
, "GetProcessTimes");
404 if( NULL
!= getProcessTimesAddr
){
407 FreeLibrary(hinstLib
);
416 ** Begin timing an operation
418 static void beginTimer(void){
419 if( enableTimer
&& getProcessTimesAddr
){
420 FILETIME ftCreation
, ftExit
;
421 getProcessTimesAddr(hProcess
,&ftCreation
,&ftExit
,
422 &ftKernelBegin
,&ftUserBegin
);
423 ftWallBegin
= timeOfDay();
427 /* Return the difference of two FILETIME structs in seconds */
428 static double timeDiff(FILETIME
*pStart
, FILETIME
*pEnd
){
429 sqlite_int64 i64Start
= *((sqlite_int64
*) pStart
);
430 sqlite_int64 i64End
= *((sqlite_int64
*) pEnd
);
431 return (double) ((i64End
- i64Start
) / 10000000.0);
435 ** Print the timing results.
437 static void endTimer(void){
438 if( enableTimer
&& getProcessTimesAddr
){
439 FILETIME ftCreation
, ftExit
, ftKernelEnd
, ftUserEnd
;
440 sqlite3_int64 ftWallEnd
= timeOfDay();
441 getProcessTimesAddr(hProcess
,&ftCreation
,&ftExit
,&ftKernelEnd
,&ftUserEnd
);
442 sputf(stdout
, "Run Time: real %.3f user %f sys %f\n",
443 (ftWallEnd
- ftWallBegin
)*0.001,
444 timeDiff(&ftUserBegin
, &ftUserEnd
),
445 timeDiff(&ftKernelBegin
, &ftKernelEnd
));
449 #define BEGIN_TIMER beginTimer()
450 #define END_TIMER endTimer()
451 #define HAS_TIMER hasTimer()
460 ** Used to prevent warnings about unused parameters
462 #define UNUSED_PARAMETER(x) (void)(x)
465 ** Number of elements in an array
467 #define ArraySize(X) (int)(sizeof(X)/sizeof(X[0]))
470 ** If the following flag is set, then command execution stops
471 ** at an error if we are not interactive.
473 static int bail_on_error
= 0;
476 ** Treat stdin as an interactive input if the following variable
477 ** is true. Otherwise, assume stdin is connected to a file or pipe.
479 static int stdin_is_interactive
= 1;
482 ** On Windows systems we need to know if standard output is a console
483 ** in order to show that UTF-16 translation is done in the sign-on
484 ** banner. The following variable is true if it is the console.
486 static int stdout_is_console
= 1;
489 ** The following is the open SQLite database. We make a pointer
490 ** to this database a static variable so that it can be accessed
491 ** by the SIGINT handler to interrupt database processing.
493 static sqlite3
*globalDb
= 0;
496 ** True if an interrupt (Control-C) has been received.
498 static volatile int seenInterrupt
= 0;
501 ** This is the name of our program. It is set in main(), used
502 ** in a number of other places, mostly for error messages.
507 ** Prompt strings. Initialized in main. Settable with
508 ** .prompt main continue
510 #define PROMPT_LEN_MAX 20
511 /* First line prompt. default: "sqlite> " */
512 static char mainPrompt
[PROMPT_LEN_MAX
];
513 /* Continuation prompt. default: " ...> " */
514 static char continuePrompt
[PROMPT_LEN_MAX
];
516 /* This is variant of the standard-library strncpy() routine with the
517 ** one change that the destination string is always zero-terminated, even
518 ** if there is no zero-terminator in the first n-1 characters of the source
521 static char *shell_strncpy(char *dest
, const char *src
, size_t n
){
523 for(i
=0; i
<n
-1 && src
[i
]!=0; i
++) dest
[i
] = src
[i
];
529 ** Optionally disable dynamic continuation prompt.
530 ** Unless disabled, the continuation prompt shows open SQL lexemes if any,
531 ** or open parentheses level if non-zero, or continuation prompt as set.
532 ** This facility interacts with the scanner and process_input() where the
533 ** below 5 macros are used.
535 #ifdef SQLITE_OMIT_DYNAPROMPT
536 # define CONTINUATION_PROMPT continuePrompt
537 # define CONTINUE_PROMPT_RESET
538 # define CONTINUE_PROMPT_AWAITS(p,s)
539 # define CONTINUE_PROMPT_AWAITC(p,c)
540 # define CONTINUE_PAREN_INCR(p,n)
541 # define CONTINUE_PROMPT_PSTATE 0
542 typedef void *t_NoDynaPrompt
;
543 # define SCAN_TRACKER_REFTYPE t_NoDynaPrompt
545 # define CONTINUATION_PROMPT dynamicContinuePrompt()
546 # define CONTINUE_PROMPT_RESET \
547 do {setLexemeOpen(&dynPrompt,0,0); trackParenLevel(&dynPrompt,0);} while(0)
548 # define CONTINUE_PROMPT_AWAITS(p,s) \
549 if(p && stdin_is_interactive) setLexemeOpen(p, s, 0)
550 # define CONTINUE_PROMPT_AWAITC(p,c) \
551 if(p && stdin_is_interactive) setLexemeOpen(p, 0, c)
552 # define CONTINUE_PAREN_INCR(p,n) \
553 if(p && stdin_is_interactive) (trackParenLevel(p,n))
554 # define CONTINUE_PROMPT_PSTATE (&dynPrompt)
555 typedef struct DynaPrompt
*t_DynaPromptRef
;
556 # define SCAN_TRACKER_REFTYPE t_DynaPromptRef
558 static struct DynaPrompt
{
559 char dynamicPrompt
[PROMPT_LEN_MAX
];
562 char *zScannerAwaits
;
563 } dynPrompt
= { {0}, {0}, 0, 0 };
565 /* Record parenthesis nesting level change, or force level to 0. */
566 static void trackParenLevel(struct DynaPrompt
*p
, int ni
){
567 p
->inParenLevel
+= ni
;
568 if( ni
==0 ) p
->inParenLevel
= 0;
569 p
->zScannerAwaits
= 0;
572 /* Record that a lexeme is opened, or closed with args==0. */
573 static void setLexemeOpen(struct DynaPrompt
*p
, char *s
, char c
){
575 p
->zScannerAwaits
= s
;
579 p
->zScannerAwaits
= p
->acAwait
;
583 /* Upon demand, derive the continuation prompt to display. */
584 static char *dynamicContinuePrompt(void){
585 if( continuePrompt
[0]==0
586 || (dynPrompt
.zScannerAwaits
==0 && dynPrompt
.inParenLevel
== 0) ){
587 return continuePrompt
;
589 if( dynPrompt
.zScannerAwaits
){
590 size_t ncp
= strlen(continuePrompt
);
591 size_t ndp
= strlen(dynPrompt
.zScannerAwaits
);
592 if( ndp
> ncp
-3 ) return continuePrompt
;
593 strcpy(dynPrompt
.dynamicPrompt
, dynPrompt
.zScannerAwaits
);
594 while( ndp
<3 ) dynPrompt
.dynamicPrompt
[ndp
++] = ' ';
595 shell_strncpy(dynPrompt
.dynamicPrompt
+3, continuePrompt
+3,
598 if( dynPrompt
.inParenLevel
>9 ){
599 shell_strncpy(dynPrompt
.dynamicPrompt
, "(..", 4);
600 }else if( dynPrompt
.inParenLevel
<0 ){
601 shell_strncpy(dynPrompt
.dynamicPrompt
, ")x!", 4);
603 shell_strncpy(dynPrompt
.dynamicPrompt
, "(x.", 4);
604 dynPrompt
.dynamicPrompt
[2] = (char)('0'+dynPrompt
.inParenLevel
);
606 shell_strncpy(dynPrompt
.dynamicPrompt
+3, continuePrompt
+3,
610 return dynPrompt
.dynamicPrompt
;
612 #endif /* !defined(SQLITE_OMIT_DYNAPROMPT) */
614 /* Indicate out-of-memory and exit. */
615 static void shell_out_of_memory(void){
616 eputz("Error: out of memory\n");
620 /* Check a pointer to see if it is NULL. If it is NULL, exit with an
621 ** out-of-memory error.
623 static void shell_check_oom(const void *p
){
624 if( p
==0 ) shell_out_of_memory();
628 ** Write I/O traces to the following stream.
630 #ifdef SQLITE_ENABLE_IOTRACE
631 static FILE *iotrace
= 0;
635 ** This routine works like printf in that its first argument is a
636 ** format string and subsequent arguments are values to be substituted
637 ** in place of % fields. The result of formatting this string
638 ** is written to iotrace.
640 #ifdef SQLITE_ENABLE_IOTRACE
641 static void SQLITE_CDECL
iotracePrintf(const char *zFormat
, ...){
644 if( iotrace
==0 ) return;
645 va_start(ap
, zFormat
);
646 z
= sqlite3_vmprintf(zFormat
, ap
);
648 sputf(iotrace
, "%s", z
);
654 ** Output string zUtf to Out stream as w characters. If w is negative,
655 ** then right-justify the text. W is the width in UTF-8 characters, not
656 ** in bytes. This is different from the %*.*s specification in printf
657 ** since with %*.*s the width is measured in bytes, not characters.
659 static void utf8_width_print(int w
, const char *zUtf
){
662 int aw
= w
<0 ? -w
: w
;
663 if( zUtf
==0 ) zUtf
= "";
664 for(i
=n
=0; zUtf
[i
]; i
++){
665 if( (zUtf
[i
]&0xc0)!=0x80 ){
668 do{ i
++; }while( (zUtf
[i
]&0xc0)==0x80 );
674 oputf("%.*s", i
, zUtf
);
676 oputf("%*s%s", aw
-n
, "", zUtf
);
678 oputf("%s%*s", zUtf
, aw
-n
, "");
684 ** Determines if a string is a number of not.
686 static int isNumber(const char *z
, int *realnum
){
687 if( *z
=='-' || *z
=='+' ) z
++;
692 if( realnum
) *realnum
= 0;
693 while( IsDigit(*z
) ){ z
++; }
696 if( !IsDigit(*z
) ) return 0;
697 while( IsDigit(*z
) ){ z
++; }
698 if( realnum
) *realnum
= 1;
700 if( *z
=='e' || *z
=='E' ){
702 if( *z
=='+' || *z
=='-' ) z
++;
703 if( !IsDigit(*z
) ) return 0;
704 while( IsDigit(*z
) ){ z
++; }
705 if( realnum
) *realnum
= 1;
711 ** Compute a string length that is limited to what can be stored in
712 ** lower 30 bits of a 32-bit signed integer.
714 static int strlen30(const char *z
){
716 while( *z2
){ z2
++; }
717 return 0x3fffffff & (int)(z2
- z
);
721 ** Return the length of a string in characters. Multibyte UTF8 characters
722 ** count as a single character.
724 static int strlenChar(const char *z
){
727 if( (0xc0&*(z
++))!=0x80 ) n
++;
733 ** Return open FILE * if zFile exists, can be opened for read
734 ** and is an ordinary file or a character stream source.
735 ** Otherwise return 0.
737 static FILE * openChrSource(const char *zFile
){
738 #if defined(_WIN32) || defined(WIN32)
739 struct __stat64 x
= {0};
740 # define STAT_CHR_SRC(mode) ((mode & (_S_IFCHR|_S_IFIFO|_S_IFREG))!=0)
741 /* On Windows, open first, then check the stream nature. This order
742 ** is necessary because _stat() and sibs, when checking a named pipe,
743 ** effectively break the pipe as its supplier sees it. */
744 FILE *rv
= fopen(zFile
, "rb");
745 if( rv
==0 ) return 0;
746 if( _fstat64(_fileno(rv
), &x
) != 0
747 || !STAT_CHR_SRC(x
.st_mode
)){
754 int rc
= stat(zFile
, &x
);
755 # define STAT_CHR_SRC(mode) (S_ISREG(mode)||S_ISFIFO(mode)||S_ISCHR(mode))
756 if( rc
!=0 ) return 0;
757 if( STAT_CHR_SRC(x
.st_mode
) ){
758 return fopen(zFile
, "rb");
767 ** This routine reads a line of text from FILE in, stores
768 ** the text in memory obtained from malloc() and returns a pointer
769 ** to the text. NULL is returned at end of file, or if malloc()
772 ** If zLine is not NULL then it is a malloced buffer returned from
773 ** a previous call to this routine that may be reused.
775 static char *local_getline(char *zLine
, FILE *in
){
776 int nLine
= zLine
==0 ? 0 : 100;
781 nLine
= nLine
*2 + 100;
782 zLine
= realloc(zLine
, nLine
);
783 shell_check_oom(zLine
);
785 if( fgets(&zLine
[n
], nLine
- n
, in
)==0 ){
793 while( zLine
[n
] ) n
++;
794 if( n
>0 && zLine
[n
-1]=='\n' ){
796 if( n
>0 && zLine
[n
-1]=='\r' ) n
--;
805 ** Retrieve a single line of input text.
807 ** If in==0 then read from standard input and prompt before each line.
808 ** If isContinuation is true, then a continuation prompt is appropriate.
809 ** If isContinuation is zero, then the main prompt should be used.
811 ** If zPrior is not NULL then it is a buffer from a prior call to this
812 ** routine that can be reused.
814 ** The result is stored in space obtained from malloc() and must either
815 ** be freed by the caller or else passed back into this routine via the
816 ** zPrior argument for reuse.
818 #ifndef SQLITE_SHELL_FIDDLE
819 static char *one_input_line(FILE *in
, char *zPrior
, int isContinuation
){
823 zResult
= local_getline(zPrior
, in
);
825 zPrompt
= isContinuation
? CONTINUATION_PROMPT
: mainPrompt
;
826 #if SHELL_USE_LOCAL_GETLINE
827 sputz(stdout
, zPrompt
);
830 zResult
= local_getline(zPrior
, stdin
);
832 /* ^C trap creates a false EOF, so let "interrupt" thread catch up. */
833 if( zResult
==0 ) sqlite3_sleep(50);
834 }while( zResult
==0 && seenInterrupt
>0 );
837 zResult
= shell_readline(zPrompt
);
839 /* ^C trap creates a false EOF, so let "interrupt" thread catch up. */
841 if( seenInterrupt
==0 ) break;
842 zResult
= shell_readline("");
844 /* BEGIN SQLCIPHER */
845 #ifdef SQLITE_HAS_CODEC
846 /* Simplistic filtering of input lines to prevent PRAGKA key and
847 PRAGMA rekey statements from being stored in readline history.
848 Note that this will only prevent single line statements, but that
849 will be sufficient for common cases. */
850 if(zResult
&& *zResult
&& (
851 sqlite3_strlike("%pragma%key%=%", zResult
, 0)==0 ||
852 sqlite3_strlike("%attach%database%as%key%", zResult
, 0)==0
857 if( zResult
&& *zResult
) shell_add_history(zResult
);
862 #endif /* !SQLITE_SHELL_FIDDLE */
865 ** Return the value of a hexadecimal digit. Return -1 if the input
866 ** is not a hex digit.
868 static int hexDigitValue(char c
){
869 if( c
>='0' && c
<='9' ) return c
- '0';
870 if( c
>='a' && c
<='f' ) return c
- 'a' + 10;
871 if( c
>='A' && c
<='F' ) return c
- 'A' + 10;
876 ** Interpret zArg as an integer value, possibly with suffixes.
878 static sqlite3_int64
integerValue(const char *zArg
){
880 static const struct { char *zSuffix
; int iMult
; } aMult
[] = {
882 { "MiB", 1024*1024 },
883 { "GiB", 1024*1024*1024 },
886 { "GB", 1000000000 },
896 }else if( zArg
[0]=='+' ){
899 if( zArg
[0]=='0' && zArg
[1]=='x' ){
902 while( (x
= hexDigitValue(zArg
[0]))>=0 ){
907 while( IsDigit(zArg
[0]) ){
908 v
= v
*10 + zArg
[0] - '0';
912 for(i
=0; i
<ArraySize(aMult
); i
++){
913 if( sqlite3_stricmp(aMult
[i
].zSuffix
, zArg
)==0 ){
918 return isNeg
? -v
: v
;
922 ** A variable length string to which one can append text.
924 typedef struct ShellText ShellText
;
932 ** Initialize and destroy a ShellText object
934 static void initText(ShellText
*p
){
935 memset(p
, 0, sizeof(*p
));
937 static void freeText(ShellText
*p
){
942 /* zIn is either a pointer to a NULL-terminated string in memory obtained
943 ** from malloc(), or a NULL pointer. The string pointed to by zAppend is
944 ** added to zIn, and the result returned in memory obtained from malloc().
945 ** zIn, if it was not NULL, is freed.
947 ** If the third argument, quote, is not '\0', then it is used as a
948 ** quote character for zAppend.
950 static void appendText(ShellText
*p
, const char *zAppend
, char quote
){
953 i64 nAppend
= strlen30(zAppend
);
955 len
= nAppend
+p
->n
+1;
958 for(i
=0; i
<nAppend
; i
++){
959 if( zAppend
[i
]==quote
) len
++;
963 if( p
->z
==0 || p
->n
+len
>=p
->nAlloc
){
964 p
->nAlloc
= p
->nAlloc
*2 + len
+ 20;
965 p
->z
= realloc(p
->z
, p
->nAlloc
);
966 shell_check_oom(p
->z
);
970 char *zCsr
= p
->z
+p
->n
;
972 for(i
=0; i
<nAppend
; i
++){
973 *zCsr
++ = zAppend
[i
];
974 if( zAppend
[i
]==quote
) *zCsr
++ = quote
;
977 p
->n
= (int)(zCsr
- p
->z
);
980 memcpy(p
->z
+p
->n
, zAppend
, nAppend
);
987 ** Attempt to determine if identifier zName needs to be quoted, either
988 ** because it contains non-alphanumeric characters, or because it is an
989 ** SQLite keyword. Be conservative in this estimate: When in doubt assume
990 ** that quoting is required.
992 ** Return '"' if quoting is required. Return 0 if no quoting is required.
994 static char quoteChar(const char *zName
){
996 if( zName
==0 ) return '"';
997 if( !isalpha((unsigned char)zName
[0]) && zName
[0]!='_' ) return '"';
998 for(i
=0; zName
[i
]; i
++){
999 if( !isalnum((unsigned char)zName
[i
]) && zName
[i
]!='_' ) return '"';
1001 return sqlite3_keyword_check(zName
, i
) ? '"' : 0;
1005 ** Construct a fake object name and column list to describe the structure
1006 ** of the view, virtual table, or table valued function zSchema.zName.
1008 static char *shellFakeSchema(
1009 sqlite3
*db
, /* The database connection containing the vtab */
1010 const char *zSchema
, /* Schema of the database holding the vtab */
1011 const char *zName
/* The name of the virtual table */
1013 sqlite3_stmt
*pStmt
= 0;
1020 zSql
= sqlite3_mprintf("PRAGMA \"%w\".table_info=%Q;",
1021 zSchema
? zSchema
: "main", zName
);
1022 shell_check_oom(zSql
);
1023 sqlite3_prepare_v2(db
, zSql
, -1, &pStmt
, 0);
1027 cQuote
= quoteChar(zSchema
);
1028 if( cQuote
&& sqlite3_stricmp(zSchema
,"temp")==0 ) cQuote
= 0;
1029 appendText(&s
, zSchema
, cQuote
);
1030 appendText(&s
, ".", 0);
1032 cQuote
= quoteChar(zName
);
1033 appendText(&s
, zName
, cQuote
);
1034 while( sqlite3_step(pStmt
)==SQLITE_ROW
){
1035 const char *zCol
= (const char*)sqlite3_column_text(pStmt
, 1);
1037 appendText(&s
, zDiv
, 0);
1039 if( zCol
==0 ) zCol
= "";
1040 cQuote
= quoteChar(zCol
);
1041 appendText(&s
, zCol
, cQuote
);
1043 appendText(&s
, ")", 0);
1044 sqlite3_finalize(pStmt
);
1053 ** SQL function: strtod(X)
1055 ** Use the C-library strtod() function to convert string X into a double.
1056 ** Used for comparing the accuracy of SQLite's internal text-to-float conversion
1057 ** routines against the C-library.
1059 static void shellStrtod(
1060 sqlite3_context
*pCtx
,
1062 sqlite3_value
**apVal
1064 char *z
= (char*)sqlite3_value_text(apVal
[0]);
1065 UNUSED_PARAMETER(nVal
);
1067 sqlite3_result_double(pCtx
, strtod(z
,0));
1071 ** SQL function: dtostr(X)
1073 ** Use the C-library printf() function to convert real value X into a string.
1074 ** Used for comparing the accuracy of SQLite's internal float-to-text conversion
1075 ** routines against the C-library.
1077 static void shellDtostr(
1078 sqlite3_context
*pCtx
,
1080 sqlite3_value
**apVal
1082 double r
= sqlite3_value_double(apVal
[0]);
1083 int n
= nVal
>=2 ? sqlite3_value_int(apVal
[1]) : 26;
1086 if( n
>350 ) n
= 350;
1087 sqlite3_snprintf(sizeof(z
), z
, "%#+.*e", n
, r
);
1088 sqlite3_result_text(pCtx
, z
, -1, SQLITE_TRANSIENT
);
1093 ** SQL function: shell_module_schema(X)
1095 ** Return a fake schema for the table-valued function or eponymous virtual
1098 static void shellModuleSchema(
1099 sqlite3_context
*pCtx
,
1101 sqlite3_value
**apVal
1105 UNUSED_PARAMETER(nVal
);
1106 zName
= (const char*)sqlite3_value_text(apVal
[0]);
1107 zFake
= zName
? shellFakeSchema(sqlite3_context_db_handle(pCtx
), 0, zName
) : 0;
1109 sqlite3_result_text(pCtx
, sqlite3_mprintf("/* %s */", zFake
),
1116 ** SQL function: shell_add_schema(S,X)
1118 ** Add the schema name X to the CREATE statement in S and return the result.
1121 ** CREATE TABLE t1(x) -> CREATE TABLE xyz.t1(x);
1126 ** CREATE UNIQUE INDEX
1129 ** CREATE VIRTUAL TABLE
1131 ** This UDF is used by the .schema command to insert the schema name of
1132 ** attached databases into the middle of the sqlite_schema.sql field.
1134 static void shellAddSchemaName(
1135 sqlite3_context
*pCtx
,
1137 sqlite3_value
**apVal
1139 static const char *aPrefix
[] = {
1148 const char *zIn
= (const char*)sqlite3_value_text(apVal
[0]);
1149 const char *zSchema
= (const char*)sqlite3_value_text(apVal
[1]);
1150 const char *zName
= (const char*)sqlite3_value_text(apVal
[2]);
1151 sqlite3
*db
= sqlite3_context_db_handle(pCtx
);
1152 UNUSED_PARAMETER(nVal
);
1153 if( zIn
!=0 && cli_strncmp(zIn
, "CREATE ", 7)==0 ){
1154 for(i
=0; i
<ArraySize(aPrefix
); i
++){
1155 int n
= strlen30(aPrefix
[i
]);
1156 if( cli_strncmp(zIn
+7, aPrefix
[i
], n
)==0 && zIn
[n
+7]==' ' ){
1160 char cQuote
= quoteChar(zSchema
);
1161 if( cQuote
&& sqlite3_stricmp(zSchema
,"temp")!=0 ){
1162 z
= sqlite3_mprintf("%.*s \"%w\".%s", n
+7, zIn
, zSchema
, zIn
+n
+8);
1164 z
= sqlite3_mprintf("%.*s %s.%s", n
+7, zIn
, zSchema
, zIn
+n
+8);
1168 && aPrefix
[i
][0]=='V'
1169 && (zFake
= shellFakeSchema(db
, zSchema
, zName
))!=0
1172 z
= sqlite3_mprintf("%s\n/* %s */", zIn
, zFake
);
1174 z
= sqlite3_mprintf("%z\n/* %s */", z
, zFake
);
1179 sqlite3_result_text(pCtx
, z
, -1, sqlite3_free
);
1185 sqlite3_result_value(pCtx
, apVal
[0]);
1189 ** The source code for several run-time loadable extensions is inserted
1190 ** below by the ../tool/mkshellc.tcl script. Before processing that included
1191 ** code, we need to override some macros to make the included program code
1192 ** work here in the middle of this regular program.
1194 #define SQLITE_EXTENSION_INIT1
1195 #define SQLITE_EXTENSION_INIT2(X) (void)(X)
1197 #if defined(_WIN32) && defined(_MSC_VER)
1198 INCLUDE test_windirent
.h
1199 INCLUDE test_windirent
.c
1200 #define dirent DIRENT
1202 INCLUDE
../ext
/misc
/memtrace
.c
1203 INCLUDE
../ext
/misc
/pcachetrace
.c
1204 INCLUDE
../ext
/misc
/shathree
.c
1205 INCLUDE
../ext
/misc
/uint
.c
1206 INCLUDE
../ext
/misc
/decimal
.c
1207 #undef sqlite3_base_init
1208 #define sqlite3_base_init sqlite3_base64_init
1209 INCLUDE
../ext
/misc
/base64
.c
1210 #undef sqlite3_base_init
1211 #define sqlite3_base_init sqlite3_base85_init
1212 #define OMIT_BASE85_CHECKER
1213 INCLUDE
../ext
/misc
/base85
.c
1214 INCLUDE
../ext
/misc
/ieee754
.c
1215 INCLUDE
../ext
/misc
/series
.c
1216 INCLUDE
../ext
/misc
/regexp
.c
1217 #ifndef SQLITE_SHELL_FIDDLE
1218 INCLUDE
../ext
/misc
/fileio
.c
1219 INCLUDE
../ext
/misc
/completion
.c
1220 INCLUDE
../ext
/misc
/appendvfs
.c
1222 #ifdef SQLITE_HAVE_ZLIB
1223 INCLUDE
../ext
/misc
/zipfile
.c
1224 INCLUDE
../ext
/misc
/sqlar
.c
1226 INCLUDE
../ext
/expert
/sqlite3expert
.h
1227 INCLUDE
../ext
/expert
/sqlite3expert
.c
1229 #if !defined(SQLITE_OMIT_VIRTUALTABLE) && defined(SQLITE_ENABLE_DBPAGE_VTAB)
1230 #define SQLITE_SHELL_HAVE_RECOVER 1
1232 #define SQLITE_SHELL_HAVE_RECOVER 0
1234 #if SQLITE_SHELL_HAVE_RECOVER
1235 INCLUDE
../ext
/recover
/sqlite3recover
.h
1236 # ifndef SQLITE_HAVE_SQLITE3R
1237 INCLUDE
../ext
/recover
/dbdata
.c
1238 INCLUDE
../ext
/recover
/sqlite3recover
.c
1239 # endif /* SQLITE_HAVE_SQLITE3R */
1241 #ifdef SQLITE_SHELL_EXTSRC
1242 # include SHELL_STRINGIFY(SQLITE_SHELL_EXTSRC)
1245 #if defined(SQLITE_ENABLE_SESSION)
1247 ** State information for a single open session
1249 typedef struct OpenSession OpenSession
;
1250 struct OpenSession
{
1251 char *zName
; /* Symbolic name for this session */
1252 int nFilter
; /* Number of xFilter rejection GLOB patterns */
1253 char **azFilter
; /* Array of xFilter rejection GLOB patterns */
1254 sqlite3_session
*p
; /* The open session */
1258 typedef struct ExpertInfo ExpertInfo
;
1260 sqlite3expert
*pExpert
;
1264 /* A single line in the EQP output */
1265 typedef struct EQPGraphRow EQPGraphRow
;
1266 struct EQPGraphRow
{
1267 int iEqpId
; /* ID for this row */
1268 int iParentId
; /* ID of the parent row */
1269 EQPGraphRow
*pNext
; /* Next row in sequence */
1270 char zText
[1]; /* Text to display for this row */
1273 /* All EQP output is collected into an instance of the following */
1274 typedef struct EQPGraph EQPGraph
;
1276 EQPGraphRow
*pRow
; /* Linked list of all rows of the EQP output */
1277 EQPGraphRow
*pLast
; /* Last element of the pRow list */
1278 char zPrefix
[100]; /* Graph prefix */
1281 /* Parameters affecting columnar mode result display (defaulting together) */
1282 typedef struct ColModeOpts
{
1283 int iWrap
; /* In columnar modes, wrap lines reaching this limit */
1284 u8 bQuote
; /* Quote results for .mode box and table */
1285 u8 bWordWrap
; /* In columnar modes, wrap at word boundaries */
1287 #define ColModeOpts_default { 60, 0, 0 }
1288 #define ColModeOpts_default_qbox { 60, 1, 0 }
1291 ** State information about the database connection is contained in an
1292 ** instance of the following structure.
1294 typedef struct ShellState ShellState
;
1296 sqlite3
*db
; /* The database */
1297 u8 autoExplain
; /* Automatically turn on .explain mode */
1298 u8 autoEQP
; /* Run EXPLAIN QUERY PLAN prior to each SQL stmt */
1299 u8 autoEQPtest
; /* autoEQP is in test mode */
1300 u8 autoEQPtrace
; /* autoEQP is in trace mode */
1301 u8 scanstatsOn
; /* True to display scan stats before each finalize */
1302 u8 openMode
; /* SHELL_OPEN_NORMAL, _APPENDVFS, or _ZIPFILE */
1303 u8 doXdgOpen
; /* Invoke start/open/xdg-open in output_reset() */
1304 u8 nEqpLevel
; /* Depth of the EQP output graph */
1305 u8 eTraceType
; /* SHELL_TRACE_* value for type of trace */
1306 u8 bSafeMode
; /* True to prohibit unsafe operations */
1307 u8 bSafeModePersist
; /* The long-term value of bSafeMode */
1308 u8 eRestoreState
; /* See comments above doAutoDetectRestore() */
1309 ColModeOpts cmOpts
; /* Option values affecting columnar mode output */
1310 unsigned statsOn
; /* True to display memory stats before each finalize */
1311 unsigned mEqpLines
; /* Mask of vertical lines in the EQP output graph */
1312 int inputNesting
; /* Track nesting level of .read and other redirects */
1313 int outCount
; /* Revert to stdout when reaching zero */
1314 int cnt
; /* Number of records displayed so far */
1315 int lineno
; /* Line number of last line read from in */
1316 int openFlags
; /* Additional flags to open. (SQLITE_OPEN_NOFOLLOW) */
1317 FILE *in
; /* Read commands from this stream */
1318 FILE *out
; /* Write results here */
1319 FILE *traceOut
; /* Output for sqlite3_trace() */
1320 int nErr
; /* Number of errors seen */
1321 int mode
; /* An output mode setting */
1322 int modePrior
; /* Saved mode */
1323 int cMode
; /* temporary output mode for the current query */
1324 int normalMode
; /* Output mode before ".explain on" */
1325 int writableSchema
; /* True if PRAGMA writable_schema=ON */
1326 int showHeader
; /* True to show column names in List or Column mode */
1327 int nCheck
; /* Number of ".check" commands run */
1328 unsigned nProgress
; /* Number of progress callbacks encountered */
1329 unsigned mxProgress
; /* Maximum progress callbacks before failing */
1330 unsigned flgProgress
; /* Flags for the progress callback */
1331 unsigned shellFlgs
; /* Various flags */
1332 unsigned priorShFlgs
; /* Saved copy of flags */
1333 sqlite3_int64 szMax
; /* --maxsize argument to .open */
1334 char *zDestTable
; /* Name of destination table when MODE_Insert */
1335 char *zTempFile
; /* Temporary file that might need deleting */
1336 char zTestcase
[30]; /* Name of current test case */
1337 char colSeparator
[20]; /* Column separator character for several modes */
1338 char rowSeparator
[20]; /* Row separator character for MODE_Ascii */
1339 char colSepPrior
[20]; /* Saved column separator */
1340 char rowSepPrior
[20]; /* Saved row separator */
1341 int *colWidth
; /* Requested width of each column in columnar modes */
1342 int *actualWidth
; /* Actual width of each column */
1343 int nWidth
; /* Number of slots in colWidth[] and actualWidth[] */
1344 char nullValue
[20]; /* The text to print when a NULL comes back from
1346 char outfile
[FILENAME_MAX
]; /* Filename for *out */
1347 sqlite3_stmt
*pStmt
; /* Current statement if any. */
1348 FILE *pLog
; /* Write log output here */
1349 struct AuxDb
{ /* Storage space for auxiliary database connections */
1350 sqlite3
*db
; /* Connection pointer */
1351 const char *zDbFilename
; /* Filename used to open the connection */
1352 char *zFreeOnClose
; /* Free this memory allocation on close */
1353 #if defined(SQLITE_ENABLE_SESSION)
1354 int nSession
; /* Number of active sessions */
1355 OpenSession aSession
[4]; /* Array of sessions. [0] is in focus. */
1357 } aAuxDb
[5], /* Array of all database connections */
1358 *pAuxDb
; /* Currently active database connection */
1359 int *aiIndent
; /* Array of indents used in MODE_Explain */
1360 int nIndent
; /* Size of array aiIndent[] */
1361 int iIndent
; /* Index of current op in aiIndent[] */
1362 char *zNonce
; /* Nonce for temporary safe-mode escapes */
1363 EQPGraph sGraph
; /* Information for the graphical EXPLAIN QUERY PLAN */
1364 ExpertInfo expert
; /* Valid if previous command was ".expert OPT..." */
1365 #ifdef SQLITE_SHELL_FIDDLE
1367 const char * zInput
; /* Input string from wasm/JS proxy */
1368 const char * zPos
; /* Cursor pos into zInput */
1369 const char * zDefaultDbName
; /* Default name for db file */
1374 #ifdef SQLITE_SHELL_FIDDLE
1375 static ShellState shellState
;
1379 /* Allowed values for ShellState.autoEQP
1381 #define AUTOEQP_off 0 /* Automatic EXPLAIN QUERY PLAN is off */
1382 #define AUTOEQP_on 1 /* Automatic EQP is on */
1383 #define AUTOEQP_trigger 2 /* On and also show plans for triggers */
1384 #define AUTOEQP_full 3 /* Show full EXPLAIN */
1386 /* Allowed values for ShellState.openMode
1388 #define SHELL_OPEN_UNSPEC 0 /* No open-mode specified */
1389 #define SHELL_OPEN_NORMAL 1 /* Normal database file */
1390 #define SHELL_OPEN_APPENDVFS 2 /* Use appendvfs */
1391 #define SHELL_OPEN_ZIPFILE 3 /* Use the zipfile virtual table */
1392 #define SHELL_OPEN_READONLY 4 /* Open a normal database read-only */
1393 #define SHELL_OPEN_DESERIALIZE 5 /* Open using sqlite3_deserialize() */
1394 #define SHELL_OPEN_HEXDB 6 /* Use "dbtotxt" output as data source */
1396 /* Allowed values for ShellState.eTraceType
1398 #define SHELL_TRACE_PLAIN 0 /* Show input SQL text */
1399 #define SHELL_TRACE_EXPANDED 1 /* Show expanded SQL text */
1400 #define SHELL_TRACE_NORMALIZED 2 /* Show normalized SQL text */
1402 /* Bits in the ShellState.flgProgress variable */
1403 #define SHELL_PROGRESS_QUIET 0x01 /* Omit announcing every progress callback */
1404 #define SHELL_PROGRESS_RESET 0x02 /* Reset the count when the progress
1405 ** callback limit is reached, and for each
1406 ** top-level SQL statement */
1407 #define SHELL_PROGRESS_ONCE 0x04 /* Cancel the --limit after firing once */
1410 ** These are the allowed shellFlgs values
1412 #define SHFLG_Pagecache 0x00000001 /* The --pagecache option is used */
1413 #define SHFLG_Lookaside 0x00000002 /* Lookaside memory is used */
1414 #define SHFLG_Backslash 0x00000004 /* The --backslash option is used */
1415 #define SHFLG_PreserveRowid 0x00000008 /* .dump preserves rowid values */
1416 #define SHFLG_Newlines 0x00000010 /* .dump --newline flag */
1417 #define SHFLG_CountChanges 0x00000020 /* .changes setting */
1418 #define SHFLG_Echo 0x00000040 /* .echo on/off, or --echo setting */
1419 #define SHFLG_HeaderSet 0x00000080 /* showHeader has been specified */
1420 #define SHFLG_DumpDataOnly 0x00000100 /* .dump show data only */
1421 #define SHFLG_DumpNoSys 0x00000200 /* .dump omits system tables */
1422 #define SHFLG_TestingMode 0x00000400 /* allow unsafe testing features */
1425 ** Macros for testing and setting shellFlgs
1427 #define ShellHasFlag(P,X) (((P)->shellFlgs & (X))!=0)
1428 #define ShellSetFlag(P,X) ((P)->shellFlgs|=(X))
1429 #define ShellClearFlag(P,X) ((P)->shellFlgs&=(~(X)))
1432 ** These are the allowed modes.
1434 #define MODE_Line 0 /* One column per line. Blank line between records */
1435 #define MODE_Column 1 /* One record per line in neat columns */
1436 #define MODE_List 2 /* One record per line with a separator */
1437 #define MODE_Semi 3 /* Same as MODE_List but append ";" to each line */
1438 #define MODE_Html 4 /* Generate an XHTML table */
1439 #define MODE_Insert 5 /* Generate SQL "insert" statements */
1440 #define MODE_Quote 6 /* Quote values as for SQL */
1441 #define MODE_Tcl 7 /* Generate ANSI-C or TCL quoted elements */
1442 #define MODE_Csv 8 /* Quote strings, numbers are plain */
1443 #define MODE_Explain 9 /* Like MODE_Column, but do not truncate data */
1444 #define MODE_Ascii 10 /* Use ASCII unit and record separators (0x1F/0x1E) */
1445 #define MODE_Pretty 11 /* Pretty-print schemas */
1446 #define MODE_EQP 12 /* Converts EXPLAIN QUERY PLAN output into a graph */
1447 #define MODE_Json 13 /* Output JSON */
1448 #define MODE_Markdown 14 /* Markdown formatting */
1449 #define MODE_Table 15 /* MySQL-style table formatting */
1450 #define MODE_Box 16 /* Unicode box-drawing characters */
1451 #define MODE_Count 17 /* Output only a count of the rows of output */
1452 #define MODE_Off 18 /* No query output shown */
1453 #define MODE_ScanExp 19 /* Like MODE_Explain, but for ".scanstats vm" */
1455 static const char *modeDescr
[] = {
1478 ** These are the column/row/line separators used by the various
1479 ** import/export modes.
1481 #define SEP_Column "|"
1482 #define SEP_Row "\n"
1483 #define SEP_Tab "\t"
1484 #define SEP_Space " "
1485 #define SEP_Comma ","
1486 #define SEP_CrLf "\r\n"
1487 #define SEP_Unit "\x1F"
1488 #define SEP_Record "\x1E"
1491 ** Limit input nesting via .read or any other input redirect.
1492 ** It's not too expensive, so a generous allowance can be made.
1494 #define MAX_INPUT_NESTING 25
1497 ** A callback for the sqlite3_log() interface.
1499 static void shellLog(void *pArg
, int iErrCode
, const char *zMsg
){
1500 ShellState
*p
= (ShellState
*)pArg
;
1501 if( p
->pLog
==0 ) return;
1502 sputf(p
->pLog
, "(%d) %s\n", iErrCode
, zMsg
);
1507 ** SQL function: shell_putsnl(X)
1509 ** Write the text X to the screen (or whatever output is being directed)
1510 ** adding a newline at the end, and then return X.
1512 static void shellPutsFunc(
1513 sqlite3_context
*pCtx
,
1515 sqlite3_value
**apVal
1517 /* Unused: (ShellState*)sqlite3_user_data(pCtx); */
1519 oputf("%s\n", sqlite3_value_text(apVal
[0]));
1520 sqlite3_result_value(pCtx
, apVal
[0]);
1524 ** If in safe mode, print an error message described by the arguments
1525 ** and exit immediately.
1527 static void failIfSafeMode(
1529 const char *zErrMsg
,
1535 va_start(ap
, zErrMsg
);
1536 zMsg
= sqlite3_vmprintf(zErrMsg
, ap
);
1538 eputf("line %d: %s\n", p
->lineno
, zMsg
);
1544 ** SQL function: edit(VALUE)
1545 ** edit(VALUE,EDITOR)
1549 ** (1) Write VALUE into a temporary file.
1550 ** (2) Run program EDITOR on that temporary file.
1551 ** (3) Read the temporary file back and return its content as the result.
1552 ** (4) Delete the temporary file
1554 ** If the EDITOR argument is omitted, use the value in the VISUAL
1555 ** environment variable. If still there is no EDITOR, through an error.
1557 ** Also throw an error if the EDITOR program returns a non-zero exit code.
1559 #ifndef SQLITE_NOHAVE_SYSTEM
1560 static void editFunc(
1561 sqlite3_context
*context
,
1563 sqlite3_value
**argv
1565 const char *zEditor
;
1566 char *zTempFile
= 0;
1575 unsigned char *p
= 0;
1578 zEditor
= (const char*)sqlite3_value_text(argv
[1]);
1580 zEditor
= getenv("VISUAL");
1583 sqlite3_result_error(context
, "no editor for edit()", -1);
1586 if( sqlite3_value_type(argv
[0])==SQLITE_NULL
){
1587 sqlite3_result_error(context
, "NULL input to edit()", -1);
1590 db
= sqlite3_context_db_handle(context
);
1592 sqlite3_file_control(db
, 0, SQLITE_FCNTL_TEMPFILENAME
, &zTempFile
);
1594 sqlite3_uint64 r
= 0;
1595 sqlite3_randomness(sizeof(r
), &r
);
1596 zTempFile
= sqlite3_mprintf("temp%llx", r
);
1598 sqlite3_result_error_nomem(context
);
1602 bBin
= sqlite3_value_type(argv
[0])==SQLITE_BLOB
;
1603 /* When writing the file to be edited, do \n to \r\n conversions on systems
1604 ** that want \r\n line endings */
1605 f
= fopen(zTempFile
, bBin
? "wb" : "w");
1607 sqlite3_result_error(context
, "edit() cannot open temp file", -1);
1610 sz
= sqlite3_value_bytes(argv
[0]);
1612 x
= fwrite(sqlite3_value_blob(argv
[0]), 1, (size_t)sz
, f
);
1614 const char *z
= (const char*)sqlite3_value_text(argv
[0]);
1615 /* Remember whether or not the value originally contained \r\n */
1616 if( z
&& strstr(z
,"\r\n")!=0 ) hasCRNL
= 1;
1617 x
= fwrite(sqlite3_value_text(argv
[0]), 1, (size_t)sz
, f
);
1622 sqlite3_result_error(context
, "edit() could not write the whole file", -1);
1625 zCmd
= sqlite3_mprintf("%s \"%s\"", zEditor
, zTempFile
);
1627 sqlite3_result_error_nomem(context
);
1633 sqlite3_result_error(context
, "EDITOR returned non-zero", -1);
1636 f
= fopen(zTempFile
, "rb");
1638 sqlite3_result_error(context
,
1639 "edit() cannot reopen temp file after edit", -1);
1642 fseek(f
, 0, SEEK_END
);
1645 p
= sqlite3_malloc64( sz
+1 );
1647 sqlite3_result_error_nomem(context
);
1650 x
= fread(p
, 1, (size_t)sz
, f
);
1654 sqlite3_result_error(context
, "could not read back the whole file", -1);
1658 sqlite3_result_blob64(context
, p
, sz
, sqlite3_free
);
1662 /* If the original contains \r\n then do no conversions back to \n */
1664 /* If the file did not originally contain \r\n then convert any new
1665 ** \r\n back into \n */
1667 for(i
=j
=0; i
<sz
; i
++){
1668 if( p
[i
]=='\r' && p
[i
+1]=='\n' ) i
++;
1674 sqlite3_result_text64(context
, (const char*)p
, sz
,
1675 sqlite3_free
, SQLITE_UTF8
);
1682 sqlite3_free(zTempFile
);
1685 #endif /* SQLITE_NOHAVE_SYSTEM */
1688 ** Save or restore the current output mode
1690 static void outputModePush(ShellState
*p
){
1691 p
->modePrior
= p
->mode
;
1692 p
->priorShFlgs
= p
->shellFlgs
;
1693 memcpy(p
->colSepPrior
, p
->colSeparator
, sizeof(p
->colSeparator
));
1694 memcpy(p
->rowSepPrior
, p
->rowSeparator
, sizeof(p
->rowSeparator
));
1696 static void outputModePop(ShellState
*p
){
1697 p
->mode
= p
->modePrior
;
1698 p
->shellFlgs
= p
->priorShFlgs
;
1699 memcpy(p
->colSeparator
, p
->colSepPrior
, sizeof(p
->colSeparator
));
1700 memcpy(p
->rowSeparator
, p
->rowSepPrior
, sizeof(p
->rowSeparator
));
1704 ** Output the given string as a hex-encoded blob (eg. X'1234' )
1706 static void output_hex_blob(const void *pBlob
, int nBlob
){
1708 unsigned char *aBlob
= (unsigned char*)pBlob
;
1710 char *zStr
= sqlite3_malloc(nBlob
*2 + 1);
1711 shell_check_oom(zStr
);
1713 for(i
=0; i
<nBlob
; i
++){
1714 static const char aHex
[] = {
1715 '0', '1', '2', '3', '4', '5', '6', '7',
1716 '8', '9', 'a', 'b', 'c', 'd', 'e', 'f'
1718 zStr
[i
*2] = aHex
[ (aBlob
[i
] >> 4) ];
1719 zStr
[i
*2+1] = aHex
[ (aBlob
[i
] & 0x0F) ];
1723 oputf("X'%s'", zStr
);
1728 ** Find a string that is not found anywhere in z[]. Return a pointer
1731 ** Try to use zA and zB first. If both of those are already found in z[]
1732 ** then make up some string and store it in the buffer zBuf.
1734 static const char *unused_string(
1735 const char *z
, /* Result must not appear anywhere in z */
1736 const char *zA
, const char *zB
, /* Try these first */
1737 char *zBuf
/* Space to store a generated string */
1740 if( strstr(z
, zA
)==0 ) return zA
;
1741 if( strstr(z
, zB
)==0 ) return zB
;
1743 sqlite3_snprintf(20,zBuf
,"(%s%u)", zA
, i
++);
1744 }while( strstr(z
,zBuf
)!=0 );
1749 ** Output the given string as a quoted string using SQL quoting conventions.
1751 ** See also: output_quoted_escaped_string()
1753 static void output_quoted_string(const char *z
){
1756 #ifndef SQLITE_SHELL_FIDDLE
1757 FILE *pfO
= setOutputStream(invalidFileStream
);
1758 setBinaryMode(pfO
, 1);
1761 for(i
=0; (c
= z
[i
])!=0 && c
!='\''; i
++){}
1767 for(i
=0; (c
= z
[i
])!=0 && c
!='\''; i
++){}
1770 oputf("%.*s", i
, z
);
1784 #ifndef SQLITE_SHELL_FIDDLE
1785 setTextMode(pfO
, 1);
1787 setTextMode(stdout
, 1);
1792 ** Output the given string as a quoted string using SQL quoting conventions.
1793 ** Additionallly , escape the "\n" and "\r" characters so that they do not
1794 ** get corrupted by end-of-line translation facilities in some operating
1797 ** This is like output_quoted_string() but with the addition of the \r\n
1798 ** escape mechanism.
1800 static void output_quoted_escaped_string(const char *z
){
1803 #ifndef SQLITE_SHELL_FIDDLE
1804 FILE *pfO
= setOutputStream(invalidFileStream
);
1805 setBinaryMode(pfO
, 1);
1807 for(i
=0; (c
= z
[i
])!=0 && c
!='\'' && c
!='\n' && c
!='\r'; i
++){}
1811 const char *zNL
= 0;
1812 const char *zCR
= 0;
1815 char zBuf1
[20], zBuf2
[20];
1816 for(i
=0; z
[i
]; i
++){
1817 if( z
[i
]=='\n' ) nNL
++;
1818 if( z
[i
]=='\r' ) nCR
++;
1822 zNL
= unused_string(z
, "\\n", "\\012", zBuf1
);
1826 zCR
= unused_string(z
, "\\r", "\\015", zBuf2
);
1830 for(i
=0; (c
= z
[i
])!=0 && c
!='\n' && c
!='\r' && c
!='\''; i
++){}
1833 oputf("%.*s", i
, z
);
1852 oputf(",'%s',char(13))", zCR
);
1855 oputf(",'%s',char(10))", zNL
);
1858 #ifndef SQLITE_SHELL_FIDDLE
1859 setTextMode(pfO
, 1);
1861 setTextMode(stdout
, 1);
1866 ** Find earliest of chars within s specified in zAny.
1867 ** With ns == ~0, is like strpbrk(s,zAny) and s must be 0-terminated.
1869 static const char *anyOfInStr(const char *s
, const char *zAny
, size_t ns
){
1870 const char *pcFirst
= 0;
1871 if( ns
== ~(size_t)0 ) ns
= strlen(s
);
1873 const char *pc
= (const char*)memchr(s
, *zAny
&0xff, ns
);
1883 ** Output the given string as a quoted according to C or TCL quoting rules.
1885 static void output_c_string(const char *z
){
1887 static const char *zq
= "\"";
1888 static long ctrlMask
= ~0L;
1889 static const char *zDQBSRO
= "\"\\\x7f"; /* double-quote, backslash, rubout */
1890 char ace
[3] = "\\?";
1894 const char *pcDQBSRO
= anyOfInStr(z
, zDQBSRO
, ~(size_t)0);
1895 const char *pcPast
= zSkipValidUtf8(z
, INT_MAX
, ctrlMask
);
1896 const char *pcEnd
= (pcDQBSRO
&& pcDQBSRO
< pcPast
)? pcDQBSRO
: pcPast
;
1897 if( pcEnd
> z
) oputb(z
, (int)(pcEnd
-z
));
1898 if( (c
= *pcEnd
)==0 ) break;
1901 case '\\': case '"':
1904 case '\t': cbsSay
= 't'; break;
1905 case '\n': cbsSay
= 'n'; break;
1906 case '\r': cbsSay
= 'r'; break;
1907 case '\f': cbsSay
= 'f'; break;
1908 default: cbsSay
= 0; break;
1913 }else if( !isprint(c
&0xff) ){
1914 oputf("\\%03o", c
&0xff);
1925 ** Output the given string as a quoted according to JSON quoting rules.
1927 static void output_json_string(const char *z
, i64 n
){
1929 static const char *zq
= "\"";
1930 static long ctrlMask
= ~0L;
1931 static const char *zDQBS
= "\"\\";
1932 const char *pcLimit
;
1933 char ace
[3] = "\\?";
1937 pcLimit
= z
+ ((n
<0)? strlen(z
) : (size_t)n
);
1939 while( z
< pcLimit
){
1940 const char *pcDQBS
= anyOfInStr(z
, zDQBS
, pcLimit
-z
);
1941 const char *pcPast
= zSkipValidUtf8(z
, (int)(pcLimit
-z
), ctrlMask
);
1942 const char *pcEnd
= (pcDQBS
&& pcDQBS
< pcPast
)? pcDQBS
: pcPast
;
1944 oputb(z
, (int)(pcEnd
-z
));
1947 if( z
>= pcLimit
) break;
1950 case '"': case '\\':
1953 case '\b': cbsSay
= 'b'; break;
1954 case '\f': cbsSay
= 'f'; break;
1955 case '\n': cbsSay
= 'n'; break;
1956 case '\r': cbsSay
= 'r'; break;
1957 case '\t': cbsSay
= 't'; break;
1958 default: cbsSay
= 0; break;
1963 }else if( c
<=0x1f ){
1974 ** Output the given string with characters that are special to
1977 static void output_html_string(const char *z
){
1993 }else if( z
[i
]=='&' ){
1995 }else if( z
[i
]=='>' ){
1997 }else if( z
[i
]=='\"' ){
1999 }else if( z
[i
]=='\'' ){
2009 ** If a field contains any character identified by a 1 in the following
2010 ** array, then the string must be quoted for CSV.
2012 static const char needCsvQuote
[] = {
2013 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
2014 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
2015 1, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0,
2016 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
2017 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
2018 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
2019 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
2020 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1,
2021 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
2022 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
2023 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
2024 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
2025 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
2026 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
2027 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
2028 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
2032 ** Output a single term of CSV. Actually, p->colSeparator is used for
2033 ** the separator, which may or may not be a comma. p->nullValue is
2034 ** the null value. Strings are quoted if necessary. The separator
2035 ** is only issued if bSep is true.
2037 static void output_csv(ShellState
*p
, const char *z
, int bSep
){
2039 oputf("%s",p
->nullValue
);
2042 for(i
=0; z
[i
]; i
++){
2043 if( needCsvQuote
[((unsigned char*)z
)[i
]] ){
2048 if( i
==0 || strstr(z
, p
->colSeparator
)!=0 ){
2049 char *zQuoted
= sqlite3_mprintf("\"%w\"", z
);
2050 shell_check_oom(zQuoted
);
2052 sqlite3_free(zQuoted
);
2058 oputz(p
->colSeparator
);
2063 ** This routine runs when the user presses Ctrl-C
2065 static void interrupt_handler(int NotUsed
){
2066 UNUSED_PARAMETER(NotUsed
);
2067 if( ++seenInterrupt
>1 ) exit(1);
2068 if( globalDb
) sqlite3_interrupt(globalDb
);
2071 #if (defined(_WIN32) || defined(WIN32)) && !defined(_WIN32_WCE)
2073 ** This routine runs for console events (e.g. Ctrl-C) on Win32
2075 static BOOL WINAPI
ConsoleCtrlHandler(
2076 DWORD dwCtrlType
/* One of the CTRL_*_EVENT constants */
2078 if( dwCtrlType
==CTRL_C_EVENT
){
2079 interrupt_handler(0);
2086 #ifndef SQLITE_OMIT_AUTHORIZATION
2088 ** This authorizer runs in safe mode.
2090 static int safeModeAuth(
2098 ShellState
*p
= (ShellState
*)pClientData
;
2099 static const char *azProhibitedFunctions
[] = {
2108 UNUSED_PARAMETER(zA1
);
2109 UNUSED_PARAMETER(zA3
);
2110 UNUSED_PARAMETER(zA4
);
2112 case SQLITE_ATTACH
: {
2113 #ifndef SQLITE_SHELL_FIDDLE
2114 /* In WASM builds the filesystem is a virtual sandbox, so
2115 ** there's no harm in using ATTACH. */
2116 failIfSafeMode(p
, "cannot run ATTACH in safe mode");
2120 case SQLITE_FUNCTION
: {
2122 for(i
=0; i
<ArraySize(azProhibitedFunctions
); i
++){
2123 if( sqlite3_stricmp(zA2
, azProhibitedFunctions
[i
])==0 ){
2124 failIfSafeMode(p
, "cannot use the %s() function in safe mode",
2125 azProhibitedFunctions
[i
]);
2135 ** When the ".auth ON" is set, the following authorizer callback is
2136 ** invoked. It always returns SQLITE_OK.
2138 static int shellAuth(
2146 ShellState
*p
= (ShellState
*)pClientData
;
2147 static const char *azAction
[] = { 0,
2148 "CREATE_INDEX", "CREATE_TABLE", "CREATE_TEMP_INDEX",
2149 "CREATE_TEMP_TABLE", "CREATE_TEMP_TRIGGER", "CREATE_TEMP_VIEW",
2150 "CREATE_TRIGGER", "CREATE_VIEW", "DELETE",
2151 "DROP_INDEX", "DROP_TABLE", "DROP_TEMP_INDEX",
2152 "DROP_TEMP_TABLE", "DROP_TEMP_TRIGGER", "DROP_TEMP_VIEW",
2153 "DROP_TRIGGER", "DROP_VIEW", "INSERT",
2154 "PRAGMA", "READ", "SELECT",
2155 "TRANSACTION", "UPDATE", "ATTACH",
2156 "DETACH", "ALTER_TABLE", "REINDEX",
2157 "ANALYZE", "CREATE_VTABLE", "DROP_VTABLE",
2158 "FUNCTION", "SAVEPOINT", "RECURSIVE"
2166 oputf("authorizer: %s", azAction
[op
]);
2170 output_c_string(az
[i
]);
2176 if( p
->bSafeMode
) (void)safeModeAuth(pClientData
, op
, zA1
, zA2
, zA3
, zA4
);
2182 ** Print a schema statement. Part of MODE_Semi and MODE_Pretty output.
2184 ** This routine converts some CREATE TABLE statements for shadow tables
2185 ** in FTS3/4/5 into CREATE TABLE IF NOT EXISTS statements.
2187 ** If the schema statement in z[] contains a start-of-comment and if
2188 ** sqlite3_complete() returns false, try to terminate the comment before
2189 ** printing the result. https://sqlite.org/forum/forumpost/d7be961c5c
2191 static void printSchemaLine(const char *z
, const char *zTail
){
2194 if( zTail
==0 ) return;
2195 if( zTail
[0]==';' && (strstr(z
, "/*")!=0 || strstr(z
,"--")!=0) ){
2196 const char *zOrig
= z
;
2197 static const char *azTerm
[] = { "", "*/", "\n" };
2199 for(i
=0; i
<ArraySize(azTerm
); i
++){
2200 char *zNew
= sqlite3_mprintf("%s%s;", zOrig
, azTerm
[i
]);
2201 shell_check_oom(zNew
);
2202 if( sqlite3_complete(zNew
) ){
2203 size_t n
= strlen(zNew
);
2212 if( sqlite3_strglob("CREATE TABLE ['\"]*", z
)==0 ){
2213 oputf("CREATE TABLE IF NOT EXISTS %s%s", z
+13, zTail
);
2215 oputf("%s%s", z
, zTail
);
2217 sqlite3_free(zToFree
);
2219 static void printSchemaLineN(char *z
, int n
, const char *zTail
){
2222 printSchemaLine(z
, zTail
);
2227 ** Return true if string z[] has nothing but whitespace and comments to the
2228 ** end of the first line.
2230 static int wsToEol(const char *z
){
2232 for(i
=0; z
[i
]; i
++){
2233 if( z
[i
]=='\n' ) return 1;
2234 if( IsSpace(z
[i
]) ) continue;
2235 if( z
[i
]=='-' && z
[i
+1]=='-' ) return 1;
2242 ** Add a new entry to the EXPLAIN QUERY PLAN data
2244 static void eqp_append(ShellState
*p
, int iEqpId
, int p2
, const char *zText
){
2247 if( zText
==0 ) return;
2248 nText
= strlen(zText
);
2249 if( p
->autoEQPtest
){
2250 oputf("%d,%d,%s\n", iEqpId
, p2
, zText
);
2252 pNew
= sqlite3_malloc64( sizeof(*pNew
) + nText
);
2253 shell_check_oom(pNew
);
2254 pNew
->iEqpId
= iEqpId
;
2255 pNew
->iParentId
= p2
;
2256 memcpy(pNew
->zText
, zText
, nText
+1);
2258 if( p
->sGraph
.pLast
){
2259 p
->sGraph
.pLast
->pNext
= pNew
;
2261 p
->sGraph
.pRow
= pNew
;
2263 p
->sGraph
.pLast
= pNew
;
2267 ** Free and reset the EXPLAIN QUERY PLAN data that has been collected
2270 static void eqp_reset(ShellState
*p
){
2271 EQPGraphRow
*pRow
, *pNext
;
2272 for(pRow
= p
->sGraph
.pRow
; pRow
; pRow
= pNext
){
2273 pNext
= pRow
->pNext
;
2276 memset(&p
->sGraph
, 0, sizeof(p
->sGraph
));
2279 /* Return the next EXPLAIN QUERY PLAN line with iEqpId that occurs after
2280 ** pOld, or return the first such line if pOld is NULL
2282 static EQPGraphRow
*eqp_next_row(ShellState
*p
, int iEqpId
, EQPGraphRow
*pOld
){
2283 EQPGraphRow
*pRow
= pOld
? pOld
->pNext
: p
->sGraph
.pRow
;
2284 while( pRow
&& pRow
->iParentId
!=iEqpId
) pRow
= pRow
->pNext
;
2288 /* Render a single level of the graph that has iEqpId as its parent. Called
2289 ** recursively to render sublevels.
2291 static void eqp_render_level(ShellState
*p
, int iEqpId
){
2292 EQPGraphRow
*pRow
, *pNext
;
2293 i64 n
= strlen(p
->sGraph
.zPrefix
);
2295 for(pRow
= eqp_next_row(p
, iEqpId
, 0); pRow
; pRow
= pNext
){
2296 pNext
= eqp_next_row(p
, iEqpId
, pRow
);
2298 oputf("%s%s%s\n", p
->sGraph
.zPrefix
, pNext
? "|--" : "`--", z
);
2299 if( n
<(i64
)sizeof(p
->sGraph
.zPrefix
)-7 ){
2300 memcpy(&p
->sGraph
.zPrefix
[n
], pNext
? "| " : " ", 4);
2301 eqp_render_level(p
, pRow
->iEqpId
);
2302 p
->sGraph
.zPrefix
[n
] = 0;
2308 ** Display and reset the EXPLAIN QUERY PLAN data
2310 static void eqp_render(ShellState
*p
, i64 nCycle
){
2311 EQPGraphRow
*pRow
= p
->sGraph
.pRow
;
2313 if( pRow
->zText
[0]=='-' ){
2314 if( pRow
->pNext
==0 ){
2318 oputf("%s\n", pRow
->zText
+3);
2319 p
->sGraph
.pRow
= pRow
->pNext
;
2321 }else if( nCycle
>0 ){
2322 oputf("QUERY PLAN (cycles=%lld [100%%])\n", nCycle
);
2324 oputz("QUERY PLAN\n");
2326 p
->sGraph
.zPrefix
[0] = 0;
2327 eqp_render_level(p
, 0);
2332 #ifndef SQLITE_OMIT_PROGRESS_CALLBACK
2334 ** Progress handler callback.
2336 static int progress_handler(void *pClientData
) {
2337 ShellState
*p
= (ShellState
*)pClientData
;
2339 if( p
->nProgress
>=p
->mxProgress
&& p
->mxProgress
>0 ){
2340 oputf("Progress limit reached (%u)\n", p
->nProgress
);
2341 if( p
->flgProgress
& SHELL_PROGRESS_RESET
) p
->nProgress
= 0;
2342 if( p
->flgProgress
& SHELL_PROGRESS_ONCE
) p
->mxProgress
= 0;
2345 if( (p
->flgProgress
& SHELL_PROGRESS_QUIET
)==0 ){
2346 oputf("Progress %u\n", p
->nProgress
);
2350 #endif /* SQLITE_OMIT_PROGRESS_CALLBACK */
2355 static void print_dashes(int N
){
2356 const char zDash
[] = "--------------------------------------------------";
2357 const int nDash
= sizeof(zDash
) - 1;
2362 oputf("%.*s", N
, zDash
);
2366 ** Print a markdown or table-style row separator using ascii-art
2368 static void print_row_separator(
2376 print_dashes(p
->actualWidth
[0]+2);
2377 for(i
=1; i
<nArg
; i
++){
2379 print_dashes(p
->actualWidth
[i
]+2);
2387 ** This is the callback routine that the shell
2388 ** invokes for each row of a query result.
2390 static int shell_callback(
2392 int nArg
, /* Number of result columns */
2393 char **azArg
, /* Text of each result column */
2394 char **azCol
, /* Column names */
2395 int *aiType
/* Column types. Might be NULL */
2398 ShellState
*p
= (ShellState
*)pArg
;
2400 if( azArg
==0 ) return 0;
2408 if( azArg
==0 ) break;
2409 for(i
=0; i
<nArg
; i
++){
2410 int len
= strlen30(azCol
[i
] ? azCol
[i
] : "");
2411 if( len
>w
) w
= len
;
2413 if( p
->cnt
++>0 ) oputz(p
->rowSeparator
);
2414 for(i
=0; i
<nArg
; i
++){
2415 oputf("%*s = %s%s", w
, azCol
[i
],
2416 azArg
[i
] ? azArg
[i
] : p
->nullValue
, p
->rowSeparator
);
2421 case MODE_Explain
: {
2422 static const int aExplainWidth
[] = {4, 13, 4, 4, 4, 13, 2, 13};
2423 static const int aExplainMap
[] = {0, 1, 2, 3, 4, 5, 6, 7 };
2424 static const int aScanExpWidth
[] = {4, 6, 6, 13, 4, 4, 4, 13, 2, 13};
2425 static const int aScanExpMap
[] = {0, 9, 8, 1, 2, 3, 4, 5, 6, 7 };
2427 const int *aWidth
= aExplainWidth
;
2428 const int *aMap
= aExplainMap
;
2429 int nWidth
= ArraySize(aExplainWidth
);
2432 if( p
->cMode
==MODE_ScanExp
){
2433 aWidth
= aScanExpWidth
;
2435 nWidth
= ArraySize(aScanExpWidth
);
2438 if( nArg
>nWidth
) nArg
= nWidth
;
2440 /* If this is the first row seen, print out the headers */
2442 for(i
=0; i
<nArg
; i
++){
2443 utf8_width_print(aWidth
[i
], azCol
[ aMap
[i
] ]);
2444 oputz(i
==nArg
-1 ? "\n" : " ");
2446 for(i
=0; i
<nArg
; i
++){
2447 print_dashes(aWidth
[i
]);
2448 oputz(i
==nArg
-1 ? "\n" : " ");
2452 /* If there is no data, exit early. */
2453 if( azArg
==0 ) break;
2455 for(i
=0; i
<nArg
; i
++){
2456 const char *zSep
= " ";
2458 const char *zVal
= azArg
[ aMap
[i
] ];
2459 if( i
==nArg
-1 ) w
= 0;
2460 if( zVal
&& strlenChar(zVal
)>w
){
2461 w
= strlenChar(zVal
);
2464 if( i
==iIndent
&& p
->aiIndent
&& p
->pStmt
){
2465 if( p
->iIndent
<p
->nIndent
){
2466 oputf("%*.s", p
->aiIndent
[p
->iIndent
], "");
2470 utf8_width_print(w
, zVal
? zVal
: p
->nullValue
);
2471 oputz(i
==nArg
-1 ? "\n" : zSep
);
2475 case MODE_Semi
: { /* .schema and .fullschema output */
2476 printSchemaLine(azArg
[0], ";\n");
2479 case MODE_Pretty
: { /* .schema and .fullschema with --indent */
2487 if( azArg
[0]==0 ) break;
2488 if( sqlite3_strlike("CREATE VIEW%", azArg
[0], 0)==0
2489 || sqlite3_strlike("CREATE TRIG%", azArg
[0], 0)==0
2491 oputf("%s;\n", azArg
[0]);
2494 z
= sqlite3_mprintf("%s", azArg
[0]);
2497 for(i
=0; IsSpace(z
[i
]); i
++){}
2498 for(; (c
= z
[i
])!=0; i
++){
2500 if( z
[j
-1]=='\r' ) z
[j
-1] = '\n';
2501 if( IsSpace(z
[j
-1]) || z
[j
-1]=='(' ) continue;
2502 }else if( (c
=='(' || c
==')') && j
>0 && IsSpace(z
[j
-1]) ){
2507 while( j
>0 && IsSpace(z
[j
-1]) ){ j
--; }
2509 if( strlen30(z
)>=79 ){
2510 for(i
=j
=0; (c
= z
[i
])!=0; i
++){ /* Copy from z[i] back to z[j] */
2513 }else if( c
=='"' || c
=='\'' || c
=='`' ){
2517 }else if( c
=='-' && z
[i
+1]=='-' ){
2523 if( nLine
>0 && nParen
==0 && j
>0 ){
2524 printSchemaLineN(z
, j
, "\n");
2529 if( nParen
==1 && cEnd
==0
2530 && (c
=='(' || c
=='\n' || (c
==',' && !wsToEol(z
+i
+1)))
2533 printSchemaLineN(z
, j
, "\n ");
2536 while( IsSpace(z
[i
+1]) ){ i
++; }
2541 printSchemaLine(z
, ";\n");
2546 if( p
->cnt
++==0 && p
->showHeader
){
2547 for(i
=0; i
<nArg
; i
++){
2548 oputf("%s%s",azCol
[i
], i
==nArg
-1 ? p
->rowSeparator
: p
->colSeparator
);
2551 if( azArg
==0 ) break;
2552 for(i
=0; i
<nArg
; i
++){
2554 if( z
==0 ) z
= p
->nullValue
;
2556 oputz((i
<nArg
-1)? p
->colSeparator
: p
->rowSeparator
);
2561 if( p
->cnt
++==0 && p
->showHeader
){
2563 for(i
=0; i
<nArg
; i
++){
2565 output_html_string(azCol
[i
]);
2570 if( azArg
==0 ) break;
2572 for(i
=0; i
<nArg
; i
++){
2574 output_html_string(azArg
[i
] ? azArg
[i
] : p
->nullValue
);
2581 if( p
->cnt
++==0 && p
->showHeader
){
2582 for(i
=0; i
<nArg
; i
++){
2583 output_c_string(azCol
[i
] ? azCol
[i
] : "");
2584 if(i
<nArg
-1) oputz(p
->colSeparator
);
2586 oputz(p
->rowSeparator
);
2588 if( azArg
==0 ) break;
2589 for(i
=0; i
<nArg
; i
++){
2590 output_c_string(azArg
[i
] ? azArg
[i
] : p
->nullValue
);
2591 if(i
<nArg
-1) oputz(p
->colSeparator
);
2593 oputz(p
->rowSeparator
);
2597 setBinaryMode(p
->out
, 1);
2598 if( p
->cnt
++==0 && p
->showHeader
){
2599 for(i
=0; i
<nArg
; i
++){
2600 output_csv(p
, azCol
[i
] ? azCol
[i
] : "", i
<nArg
-1);
2602 oputz(p
->rowSeparator
);
2605 for(i
=0; i
<nArg
; i
++){
2606 output_csv(p
, azArg
[i
], i
<nArg
-1);
2608 oputz(p
->rowSeparator
);
2610 setTextMode(p
->out
, 1);
2614 if( azArg
==0 ) break;
2615 oputf("INSERT INTO %s",p
->zDestTable
);
2616 if( p
->showHeader
){
2618 for(i
=0; i
<nArg
; i
++){
2619 if( i
>0 ) oputz(",");
2620 if( quoteChar(azCol
[i
]) ){
2621 char *z
= sqlite3_mprintf("\"%w\"", azCol
[i
]);
2626 oputf("%s", azCol
[i
]);
2632 for(i
=0; i
<nArg
; i
++){
2633 oputz(i
>0 ? "," : " VALUES(");
2634 if( (azArg
[i
]==0) || (aiType
&& aiType
[i
]==SQLITE_NULL
) ){
2636 }else if( aiType
&& aiType
[i
]==SQLITE_TEXT
){
2637 if( ShellHasFlag(p
, SHFLG_Newlines
) ){
2638 output_quoted_string(azArg
[i
]);
2640 output_quoted_escaped_string(azArg
[i
]);
2642 }else if( aiType
&& aiType
[i
]==SQLITE_INTEGER
){
2644 }else if( aiType
&& aiType
[i
]==SQLITE_FLOAT
){
2646 double r
= sqlite3_column_double(p
->pStmt
, i
);
2648 memcpy(&ur
,&r
,sizeof(r
));
2649 if( ur
==0x7ff0000000000000LL
){
2651 }else if( ur
==0xfff0000000000000LL
){
2654 sqlite3_int64 ir
= (sqlite3_int64
)r
;
2655 if( r
==(double)ir
){
2656 sqlite3_snprintf(50,z
,"%lld.0", ir
);
2658 sqlite3_snprintf(50,z
,"%!.20g", r
);
2662 }else if( aiType
&& aiType
[i
]==SQLITE_BLOB
&& p
->pStmt
){
2663 const void *pBlob
= sqlite3_column_blob(p
->pStmt
, i
);
2664 int nBlob
= sqlite3_column_bytes(p
->pStmt
, i
);
2665 output_hex_blob(pBlob
, nBlob
);
2666 }else if( isNumber(azArg
[i
], 0) ){
2668 }else if( ShellHasFlag(p
, SHFLG_Newlines
) ){
2669 output_quoted_string(azArg
[i
]);
2671 output_quoted_escaped_string(azArg
[i
]);
2678 if( azArg
==0 ) break;
2680 fputs("[{", p
->out
);
2682 fputs(",\n{", p
->out
);
2685 for(i
=0; i
<nArg
; i
++){
2686 output_json_string(azCol
[i
], -1);
2688 if( (azArg
[i
]==0) || (aiType
&& aiType
[i
]==SQLITE_NULL
) ){
2690 }else if( aiType
&& aiType
[i
]==SQLITE_FLOAT
){
2692 double r
= sqlite3_column_double(p
->pStmt
, i
);
2694 memcpy(&ur
,&r
,sizeof(r
));
2695 if( ur
==0x7ff0000000000000LL
){
2697 }else if( ur
==0xfff0000000000000LL
){
2700 sqlite3_snprintf(50,z
,"%!.20g", r
);
2703 }else if( aiType
&& aiType
[i
]==SQLITE_BLOB
&& p
->pStmt
){
2704 const void *pBlob
= sqlite3_column_blob(p
->pStmt
, i
);
2705 int nBlob
= sqlite3_column_bytes(p
->pStmt
, i
);
2706 output_json_string(pBlob
, nBlob
);
2707 }else if( aiType
&& aiType
[i
]==SQLITE_TEXT
){
2708 output_json_string(azArg
[i
], -1);
2720 if( azArg
==0 ) break;
2721 if( p
->cnt
==0 && p
->showHeader
){
2722 for(i
=0; i
<nArg
; i
++){
2723 if( i
>0 ) fputs(p
->colSeparator
, p
->out
);
2724 output_quoted_string(azCol
[i
]);
2726 fputs(p
->rowSeparator
, p
->out
);
2729 for(i
=0; i
<nArg
; i
++){
2730 if( i
>0 ) fputs(p
->colSeparator
, p
->out
);
2731 if( (azArg
[i
]==0) || (aiType
&& aiType
[i
]==SQLITE_NULL
) ){
2733 }else if( aiType
&& aiType
[i
]==SQLITE_TEXT
){
2734 output_quoted_string(azArg
[i
]);
2735 }else if( aiType
&& aiType
[i
]==SQLITE_INTEGER
){
2737 }else if( aiType
&& aiType
[i
]==SQLITE_FLOAT
){
2739 double r
= sqlite3_column_double(p
->pStmt
, i
);
2740 sqlite3_snprintf(50,z
,"%!.20g", r
);
2742 }else if( aiType
&& aiType
[i
]==SQLITE_BLOB
&& p
->pStmt
){
2743 const void *pBlob
= sqlite3_column_blob(p
->pStmt
, i
);
2744 int nBlob
= sqlite3_column_bytes(p
->pStmt
, i
);
2745 output_hex_blob(pBlob
, nBlob
);
2746 }else if( isNumber(azArg
[i
], 0) ){
2749 output_quoted_string(azArg
[i
]);
2752 fputs(p
->rowSeparator
, p
->out
);
2756 if( p
->cnt
++==0 && p
->showHeader
){
2757 for(i
=0; i
<nArg
; i
++){
2758 if( i
>0 ) oputz(p
->colSeparator
);
2759 oputz(azCol
[i
] ? azCol
[i
] : "");
2761 oputz(p
->rowSeparator
);
2763 if( azArg
==0 ) break;
2764 for(i
=0; i
<nArg
; i
++){
2765 if( i
>0 ) oputz(p
->colSeparator
);
2766 oputz(azArg
[i
] ? azArg
[i
] : p
->nullValue
);
2768 oputz(p
->rowSeparator
);
2772 eqp_append(p
, atoi(azArg
[0]), atoi(azArg
[1]), azArg
[3]);
2780 ** This is the callback routine that the SQLite library
2781 ** invokes for each row of a query result.
2783 static int callback(void *pArg
, int nArg
, char **azArg
, char **azCol
){
2784 /* since we don't have type info, call the shell_callback with a NULL value */
2785 return shell_callback(pArg
, nArg
, azArg
, azCol
, NULL
);
2789 ** This is the callback routine from sqlite3_exec() that appends all
2790 ** output onto the end of a ShellText object.
2792 static int captureOutputCallback(void *pArg
, int nArg
, char **azArg
, char **az
){
2793 ShellText
*p
= (ShellText
*)pArg
;
2795 UNUSED_PARAMETER(az
);
2796 if( azArg
==0 ) return 0;
2797 if( p
->n
) appendText(p
, "|", 0);
2798 for(i
=0; i
<nArg
; i
++){
2799 if( i
) appendText(p
, ",", 0);
2800 if( azArg
[i
] ) appendText(p
, azArg
[i
], 0);
2806 ** Generate an appropriate SELFTEST table in the main database.
2808 static void createSelftestTable(ShellState
*p
){
2811 "SAVEPOINT selftest_init;\n"
2812 "CREATE TABLE IF NOT EXISTS selftest(\n"
2813 " tno INTEGER PRIMARY KEY,\n" /* Test number */
2814 " op TEXT,\n" /* Operator: memo run */
2815 " cmd TEXT,\n" /* Command text */
2816 " ans TEXT\n" /* Desired answer */
2818 "CREATE TEMP TABLE [_shell$self](op,cmd,ans);\n"
2819 "INSERT INTO [_shell$self](rowid,op,cmd)\n"
2820 " VALUES(coalesce((SELECT (max(tno)+100)/10 FROM selftest),10),\n"
2821 " 'memo','Tests generated by --init');\n"
2822 "INSERT INTO [_shell$self]\n"
2824 " 'SELECT hex(sha3_query(''SELECT type,name,tbl_name,sql "
2825 "FROM sqlite_schema ORDER BY 2'',224))',\n"
2826 " hex(sha3_query('SELECT type,name,tbl_name,sql "
2827 "FROM sqlite_schema ORDER BY 2',224));\n"
2828 "INSERT INTO [_shell$self]\n"
2830 " 'SELECT hex(sha3_query(''SELECT * FROM \"' ||"
2831 " printf('%w',name) || '\" NOT INDEXED'',224))',\n"
2832 " hex(sha3_query(printf('SELECT * FROM \"%w\" NOT INDEXED',name),224))\n"
2834 " SELECT name FROM sqlite_schema\n"
2835 " WHERE type='table'\n"
2836 " AND name<>'selftest'\n"
2837 " AND coalesce(rootpage,0)>0\n"
2840 "INSERT INTO [_shell$self]\n"
2841 " VALUES('run','PRAGMA integrity_check','ok');\n"
2842 "INSERT INTO selftest(tno,op,cmd,ans)"
2843 " SELECT rowid*10,op,cmd,ans FROM [_shell$self];\n"
2844 "DROP TABLE [_shell$self];"
2847 eputf("SELFTEST initialization failure: %s\n", zErrMsg
);
2848 sqlite3_free(zErrMsg
);
2850 sqlite3_exec(p
->db
, "RELEASE selftest_init",0,0,0);
2855 ** Set the destination table field of the ShellState structure to
2856 ** the name of the table given. Escape any quote characters in the
2859 static void set_table_name(ShellState
*p
, const char *zName
){
2864 if( p
->zDestTable
){
2865 free(p
->zDestTable
);
2868 if( zName
==0 ) return;
2869 cQuote
= quoteChar(zName
);
2870 n
= strlen30(zName
);
2871 if( cQuote
) n
+= n
+2;
2872 z
= p
->zDestTable
= malloc( n
+1 );
2875 if( cQuote
) z
[n
++] = cQuote
;
2876 for(i
=0; zName
[i
]; i
++){
2878 if( zName
[i
]==cQuote
) z
[n
++] = cQuote
;
2880 if( cQuote
) z
[n
++] = cQuote
;
2885 ** Maybe construct two lines of text that point out the position of a
2886 ** syntax error. Return a pointer to the text, in memory obtained from
2887 ** sqlite3_malloc(). Or, if the most recent error does not involve a
2888 ** specific token that we can point to, return an empty string.
2890 ** In all cases, the memory returned is obtained from sqlite3_malloc64()
2891 ** and should be released by the caller invoking sqlite3_free().
2893 static char *shell_error_context(const char *zSql
, sqlite3
*db
){
2901 || (iOffset
= sqlite3_error_offset(db
))<0
2902 || iOffset
>=(int)strlen(zSql
)
2904 return sqlite3_mprintf("");
2906 while( iOffset
>50 ){
2909 while( (zSql
[0]&0xc0)==0x80 ){ zSql
++; iOffset
--; }
2914 while( len
>0 && (zSql
[len
]&0xc0)==0x80 ) len
--;
2916 zCode
= sqlite3_mprintf("%.*s", len
, zSql
);
2917 shell_check_oom(zCode
);
2918 for(i
=0; zCode
[i
]; i
++){ if( IsSpace(zSql
[i
]) ) zCode
[i
] = ' '; }
2920 zMsg
= sqlite3_mprintf("\n %z\n %*s^--- error here", zCode
,iOffset
,"");
2922 zMsg
= sqlite3_mprintf("\n %z\n %*serror here ---^", zCode
,iOffset
-14,"");
2929 ** Execute a query statement that will generate SQL output. Print
2930 ** the result columns, comma-separated, on a line and then add a
2931 ** semicolon terminator to the end of that line.
2933 ** If the number of columns is 1 and that column contains text "--"
2934 ** then write the semicolon on a separate line. That way, if a
2935 ** "--" comment occurs at the end of the statement, the comment
2936 ** won't consume the semicolon terminator.
2938 static int run_table_dump_query(
2939 ShellState
*p
, /* Query context */
2940 const char *zSelect
/* SELECT statement to extract content */
2942 sqlite3_stmt
*pSelect
;
2947 rc
= sqlite3_prepare_v2(p
->db
, zSelect
, -1, &pSelect
, 0);
2948 if( rc
!=SQLITE_OK
|| !pSelect
){
2949 char *zContext
= shell_error_context(zSelect
, p
->db
);
2950 oputf("/**** ERROR: (%d) %s *****/\n%s",
2951 rc
, sqlite3_errmsg(p
->db
), zContext
);
2952 sqlite3_free(zContext
);
2953 if( (rc
&0xff)!=SQLITE_CORRUPT
) p
->nErr
++;
2956 rc
= sqlite3_step(pSelect
);
2957 nResult
= sqlite3_column_count(pSelect
);
2958 while( rc
==SQLITE_ROW
){
2959 z
= (const char*)sqlite3_column_text(pSelect
, 0);
2961 for(i
=1; i
<nResult
; i
++){
2962 oputf(",%s", sqlite3_column_text(pSelect
, i
));
2965 while( z
[0] && (z
[0]!='-' || z
[1]!='-') ) z
++;
2971 rc
= sqlite3_step(pSelect
);
2973 rc
= sqlite3_finalize(pSelect
);
2974 if( rc
!=SQLITE_OK
){
2975 oputf("/**** ERROR: (%d) %s *****/\n", rc
, sqlite3_errmsg(p
->db
));
2976 if( (rc
&0xff)!=SQLITE_CORRUPT
) p
->nErr
++;
2982 ** Allocate space and save off string indicating current error.
2984 static char *save_err_msg(
2985 sqlite3
*db
, /* Database to query */
2986 const char *zPhase
, /* When the error occurs */
2987 int rc
, /* Error code returned from API */
2988 const char *zSql
/* SQL string, or NULL */
2992 sqlite3_str
*pStr
= sqlite3_str_new(0);
2993 sqlite3_str_appendf(pStr
, "%s, %s", zPhase
, sqlite3_errmsg(db
));
2995 sqlite3_str_appendf(pStr
, " (%d)", rc
);
2997 zContext
= shell_error_context(zSql
, db
);
2999 sqlite3_str_appendall(pStr
, zContext
);
3000 sqlite3_free(zContext
);
3002 zErr
= sqlite3_str_finish(pStr
);
3003 shell_check_oom(zErr
);
3009 ** Attempt to display I/O stats on Linux using /proc/PID/io
3011 static void displayLinuxIoStats(void){
3014 sqlite3_snprintf(sizeof(z
), z
, "/proc/%d/io", getpid());
3015 in
= fopen(z
, "rb");
3017 while( fgets(z
, sizeof(z
), in
)!=0 ){
3018 static const struct {
3019 const char *zPattern
;
3022 { "rchar: ", "Bytes received by read():" },
3023 { "wchar: ", "Bytes sent to write():" },
3024 { "syscr: ", "Read() system calls:" },
3025 { "syscw: ", "Write() system calls:" },
3026 { "read_bytes: ", "Bytes read from storage:" },
3027 { "write_bytes: ", "Bytes written to storage:" },
3028 { "cancelled_write_bytes: ", "Cancelled write bytes:" },
3031 for(i
=0; i
<ArraySize(aTrans
); i
++){
3032 int n
= strlen30(aTrans
[i
].zPattern
);
3033 if( cli_strncmp(aTrans
[i
].zPattern
, z
, n
)==0 ){
3034 oputf("%-36s %s", aTrans
[i
].zDesc
, &z
[n
]);
3044 ** Display a single line of status using 64-bit values.
3046 static void displayStatLine(
3047 char *zLabel
, /* Label for this one line */
3048 char *zFormat
, /* Format for the result */
3049 int iStatusCtrl
, /* Which status to display */
3050 int bReset
/* True to reset the stats */
3052 sqlite3_int64 iCur
= -1;
3053 sqlite3_int64 iHiwtr
= -1;
3056 sqlite3_status64(iStatusCtrl
, &iCur
, &iHiwtr
, bReset
);
3057 for(i
=0, nPercent
=0; zFormat
[i
]; i
++){
3058 if( zFormat
[i
]=='%' ) nPercent
++;
3061 sqlite3_snprintf(sizeof(zLine
), zLine
, zFormat
, iCur
, iHiwtr
);
3063 sqlite3_snprintf(sizeof(zLine
), zLine
, zFormat
, iHiwtr
);
3065 oputf("%-36s %s\n", zLabel
, zLine
);
3069 ** Display memory stats.
3071 static int display_stats(
3072 sqlite3
*db
, /* Database to query */
3073 ShellState
*pArg
, /* Pointer to ShellState */
3074 int bReset
/* True to reset the stats */
3078 if( pArg
==0 || pArg
->out
==0 ) return 0;
3080 if( pArg
->pStmt
&& pArg
->statsOn
==2 ){
3082 sqlite3_stmt
*pStmt
= pArg
->pStmt
;
3084 nCol
= sqlite3_column_count(pStmt
);
3085 oputf("%-36s %d\n", "Number of output columns:", nCol
);
3086 for(i
=0; i
<nCol
; i
++){
3087 sqlite3_snprintf(sizeof(z
),z
,"Column %d %nname:", i
, &x
);
3088 oputf("%-36s %s\n", z
, sqlite3_column_name(pStmt
,i
));
3089 #ifndef SQLITE_OMIT_DECLTYPE
3090 sqlite3_snprintf(30, z
+x
, "declared type:");
3091 oputf("%-36s %s\n", z
, sqlite3_column_decltype(pStmt
, i
));
3093 #ifdef SQLITE_ENABLE_COLUMN_METADATA
3094 sqlite3_snprintf(30, z
+x
, "database name:");
3095 oputf("%-36s %s\n", z
, sqlite3_column_database_name(pStmt
,i
));
3096 sqlite3_snprintf(30, z
+x
, "table name:");
3097 oputf("%-36s %s\n", z
, sqlite3_column_table_name(pStmt
,i
));
3098 sqlite3_snprintf(30, z
+x
, "origin name:");
3099 oputf("%-36s %s\n", z
, sqlite3_column_origin_name(pStmt
,i
));
3104 if( pArg
->statsOn
==3 ){
3106 iCur
= sqlite3_stmt_status(pArg
->pStmt
, SQLITE_STMTSTATUS_VM_STEP
,bReset
);
3107 oputf("VM-steps: %d\n", iCur
);
3112 displayStatLine("Memory Used:",
3113 "%lld (max %lld) bytes", SQLITE_STATUS_MEMORY_USED
, bReset
);
3114 displayStatLine("Number of Outstanding Allocations:",
3115 "%lld (max %lld)", SQLITE_STATUS_MALLOC_COUNT
, bReset
);
3116 if( pArg
->shellFlgs
& SHFLG_Pagecache
){
3117 displayStatLine("Number of Pcache Pages Used:",
3118 "%lld (max %lld) pages", SQLITE_STATUS_PAGECACHE_USED
, bReset
);
3120 displayStatLine("Number of Pcache Overflow Bytes:",
3121 "%lld (max %lld) bytes", SQLITE_STATUS_PAGECACHE_OVERFLOW
, bReset
);
3122 displayStatLine("Largest Allocation:",
3123 "%lld bytes", SQLITE_STATUS_MALLOC_SIZE
, bReset
);
3124 displayStatLine("Largest Pcache Allocation:",
3125 "%lld bytes", SQLITE_STATUS_PAGECACHE_SIZE
, bReset
);
3126 #ifdef YYTRACKMAXSTACKDEPTH
3127 displayStatLine("Deepest Parser Stack:",
3128 "%lld (max %lld)", SQLITE_STATUS_PARSER_STACK
, bReset
);
3132 if( pArg
->shellFlgs
& SHFLG_Lookaside
){
3134 sqlite3_db_status(db
, SQLITE_DBSTATUS_LOOKASIDE_USED
,
3135 &iCur
, &iHiwtr
, bReset
);
3136 oputf("Lookaside Slots Used: %d (max %d)\n", iCur
, iHiwtr
);
3137 sqlite3_db_status(db
, SQLITE_DBSTATUS_LOOKASIDE_HIT
,
3138 &iCur
, &iHiwtr
, bReset
);
3139 oputf("Successful lookaside attempts: %d\n", iHiwtr
);
3140 sqlite3_db_status(db
, SQLITE_DBSTATUS_LOOKASIDE_MISS_SIZE
,
3141 &iCur
, &iHiwtr
, bReset
);
3142 oputf("Lookaside failures due to size: %d\n", iHiwtr
);
3143 sqlite3_db_status(db
, SQLITE_DBSTATUS_LOOKASIDE_MISS_FULL
,
3144 &iCur
, &iHiwtr
, bReset
);
3145 oputf("Lookaside failures due to OOM: %d\n", iHiwtr
);
3148 sqlite3_db_status(db
, SQLITE_DBSTATUS_CACHE_USED
, &iCur
, &iHiwtr
, bReset
);
3149 oputf("Pager Heap Usage: %d bytes\n", iCur
);
3151 sqlite3_db_status(db
, SQLITE_DBSTATUS_CACHE_HIT
, &iCur
, &iHiwtr
, 1);
3152 oputf("Page cache hits: %d\n", iCur
);
3154 sqlite3_db_status(db
, SQLITE_DBSTATUS_CACHE_MISS
, &iCur
, &iHiwtr
, 1);
3155 oputf("Page cache misses: %d\n", iCur
);
3157 sqlite3_db_status(db
, SQLITE_DBSTATUS_CACHE_WRITE
, &iCur
, &iHiwtr
, 1);
3158 oputf("Page cache writes: %d\n", iCur
);
3160 sqlite3_db_status(db
, SQLITE_DBSTATUS_CACHE_SPILL
, &iCur
, &iHiwtr
, 1);
3161 oputf("Page cache spills: %d\n", iCur
);
3163 sqlite3_db_status(db
, SQLITE_DBSTATUS_SCHEMA_USED
, &iCur
, &iHiwtr
, bReset
);
3164 oputf("Schema Heap Usage: %d bytes\n", iCur
);
3166 sqlite3_db_status(db
, SQLITE_DBSTATUS_STMT_USED
, &iCur
, &iHiwtr
, bReset
);
3167 oputf("Statement Heap/Lookaside Usage: %d bytes\n", iCur
);
3172 iCur
= sqlite3_stmt_status(pArg
->pStmt
, SQLITE_STMTSTATUS_FULLSCAN_STEP
,
3174 oputf("Fullscan Steps: %d\n", iCur
);
3175 iCur
= sqlite3_stmt_status(pArg
->pStmt
, SQLITE_STMTSTATUS_SORT
, bReset
);
3176 oputf("Sort Operations: %d\n", iCur
);
3177 iCur
= sqlite3_stmt_status(pArg
->pStmt
, SQLITE_STMTSTATUS_AUTOINDEX
,bReset
);
3178 oputf("Autoindex Inserts: %d\n", iCur
);
3179 iHit
= sqlite3_stmt_status(pArg
->pStmt
, SQLITE_STMTSTATUS_FILTER_HIT
,
3181 iMiss
= sqlite3_stmt_status(pArg
->pStmt
, SQLITE_STMTSTATUS_FILTER_MISS
,
3183 if( iHit
|| iMiss
){
3184 oputf("Bloom filter bypass taken: %d/%d\n", iHit
, iHit
+iMiss
);
3186 iCur
= sqlite3_stmt_status(pArg
->pStmt
, SQLITE_STMTSTATUS_VM_STEP
, bReset
);
3187 oputf("Virtual Machine Steps: %d\n", iCur
);
3188 iCur
= sqlite3_stmt_status(pArg
->pStmt
, SQLITE_STMTSTATUS_REPREPARE
,bReset
);
3189 oputf("Reprepare operations: %d\n", iCur
);
3190 iCur
= sqlite3_stmt_status(pArg
->pStmt
, SQLITE_STMTSTATUS_RUN
, bReset
);
3191 oputf("Number of times run: %d\n", iCur
);
3192 iCur
= sqlite3_stmt_status(pArg
->pStmt
, SQLITE_STMTSTATUS_MEMUSED
, bReset
);
3193 oputf("Memory used by prepared stmt: %d\n", iCur
);
3197 displayLinuxIoStats();
3200 /* Do not remove this machine readable comment: extra-stats-output-here */
3206 #ifdef SQLITE_ENABLE_STMT_SCANSTATUS
3207 static int scanStatsHeight(sqlite3_stmt
*p
, int iEntry
){
3210 sqlite3_stmt_scanstatus_v2(p
, iEntry
,
3211 SQLITE_SCANSTAT_SELECTID
, SQLITE_SCANSTAT_COMPLEX
, (void*)&iPid
3218 res
= sqlite3_stmt_scanstatus_v2(p
, ii
,
3219 SQLITE_SCANSTAT_SELECTID
, SQLITE_SCANSTAT_COMPLEX
, (void*)&iId
3223 sqlite3_stmt_scanstatus_v2(p
, ii
,
3224 SQLITE_SCANSTAT_PARENTID
, SQLITE_SCANSTAT_COMPLEX
, (void*)&iPid
3234 #ifdef SQLITE_ENABLE_STMT_SCANSTATUS
3235 static void display_explain_scanstats(
3236 sqlite3
*db
, /* Database to query */
3237 ShellState
*pArg
/* Pointer to ShellState */
3239 static const int f
= SQLITE_SCANSTAT_COMPLEX
;
3240 sqlite3_stmt
*p
= pArg
->pStmt
;
3249 if( sqlite3_stmt_scanstatus_v2(p
,ii
,SQLITE_SCANSTAT_EXPLAIN
,f
,(void*)&z
) ){
3252 n
= (int)strlen(z
) + scanStatsHeight(p
, ii
)*3;
3253 if( n
>nWidth
) nWidth
= n
;
3257 sqlite3_stmt_scanstatus_v2(p
, -1, SQLITE_SCANSTAT_NCYCLE
, f
, (void*)&nTotal
);
3265 const char *zName
= 0;
3269 if( sqlite3_stmt_scanstatus_v2(p
,ii
,SQLITE_SCANSTAT_EXPLAIN
,f
,(void*)&zo
) ){
3272 sqlite3_stmt_scanstatus_v2(p
, ii
, SQLITE_SCANSTAT_EST
,f
,(void*)&rEst
);
3273 sqlite3_stmt_scanstatus_v2(p
, ii
, SQLITE_SCANSTAT_NLOOP
,f
,(void*)&nLoop
);
3274 sqlite3_stmt_scanstatus_v2(p
, ii
, SQLITE_SCANSTAT_NVISIT
,f
,(void*)&nRow
);
3275 sqlite3_stmt_scanstatus_v2(p
, ii
, SQLITE_SCANSTAT_NCYCLE
,f
,(void*)&nCycle
);
3276 sqlite3_stmt_scanstatus_v2(p
, ii
, SQLITE_SCANSTAT_SELECTID
,f
,(void*)&iId
);
3277 sqlite3_stmt_scanstatus_v2(p
, ii
, SQLITE_SCANSTAT_PARENTID
,f
,(void*)&iPid
);
3278 sqlite3_stmt_scanstatus_v2(p
, ii
, SQLITE_SCANSTAT_NAME
,f
,(void*)&zName
);
3280 zText
= sqlite3_mprintf("%s", zo
);
3281 if( nCycle
>=0 || nLoop
>=0 || nRow
>=0 ){
3283 if( nCycle
>=0 && nTotal
>0 ){
3284 z
= sqlite3_mprintf("%zcycles=%lld [%d%%]", z
,
3285 nCycle
, ((nCycle
*100)+nTotal
/2) / nTotal
3289 z
= sqlite3_mprintf("%z%sloops=%lld", z
, z
? " " : "", nLoop
);
3292 z
= sqlite3_mprintf("%z%srows=%lld", z
, z
? " " : "", nRow
);
3295 if( zName
&& pArg
->scanstatsOn
>1 ){
3296 double rpl
= (double)nRow
/ (double)nLoop
;
3297 z
= sqlite3_mprintf("%z rpl=%.1f est=%.1f", z
, rpl
, rEst
);
3300 zText
= sqlite3_mprintf(
3301 "% *z (%z)", -1*(nWidth
-scanStatsHeight(p
, ii
)*3), zText
, z
3305 eqp_append(pArg
, iId
, iPid
, zText
);
3306 sqlite3_free(zText
);
3309 eqp_render(pArg
, nTotal
);
3315 ** Parameter azArray points to a zero-terminated array of strings. zStr
3316 ** points to a single nul-terminated string. Return non-zero if zStr
3317 ** is equal, according to strcmp(), to any of the strings in the array.
3318 ** Otherwise, return zero.
3320 static int str_in_array(const char *zStr
, const char **azArray
){
3322 for(i
=0; azArray
[i
]; i
++){
3323 if( 0==cli_strcmp(zStr
, azArray
[i
]) ) return 1;
3329 ** If compiled statement pSql appears to be an EXPLAIN statement, allocate
3330 ** and populate the ShellState.aiIndent[] array with the number of
3331 ** spaces each opcode should be indented before it is output.
3333 ** The indenting rules are:
3335 ** * For each "Next", "Prev", "VNext" or "VPrev" instruction, indent
3336 ** all opcodes that occur between the p2 jump destination and the opcode
3337 ** itself by 2 spaces.
3339 ** * Do the previous for "Return" instructions for when P2 is positive.
3340 ** See tag-20220407a in wherecode.c and vdbe.c.
3342 ** * For each "Goto", if the jump destination is earlier in the program
3343 ** and ends on one of:
3344 ** Yield SeekGt SeekLt RowSetRead Rewind
3345 ** or if the P1 parameter is one instead of zero,
3346 ** then indent all opcodes between the earlier instruction
3347 ** and "Goto" by 2 spaces.
3349 static void explain_data_prepare(ShellState
*p
, sqlite3_stmt
*pSql
){
3350 int *abYield
= 0; /* True if op is an OP_Yield */
3351 int nAlloc
= 0; /* Allocated size of p->aiIndent[], abYield */
3352 int iOp
; /* Index of operation in p->aiIndent[] */
3354 const char *azNext
[] = { "Next", "Prev", "VPrev", "VNext", "SorterNext",
3356 const char *azYield
[] = { "Yield", "SeekLT", "SeekGT", "RowSetRead",
3358 const char *azGoto
[] = { "Goto", 0 };
3360 /* The caller guarantees that the leftmost 4 columns of the statement
3361 ** passed to this function are equivalent to the leftmost 4 columns
3362 ** of EXPLAIN statement output. In practice the statement may be
3363 ** an EXPLAIN, or it may be a query on the bytecode() virtual table. */
3364 assert( sqlite3_column_count(pSql
)>=4 );
3365 assert( 0==sqlite3_stricmp( sqlite3_column_name(pSql
, 0), "addr" ) );
3366 assert( 0==sqlite3_stricmp( sqlite3_column_name(pSql
, 1), "opcode" ) );
3367 assert( 0==sqlite3_stricmp( sqlite3_column_name(pSql
, 2), "p1" ) );
3368 assert( 0==sqlite3_stricmp( sqlite3_column_name(pSql
, 3), "p2" ) );
3370 for(iOp
=0; SQLITE_ROW
==sqlite3_step(pSql
); iOp
++){
3372 int iAddr
= sqlite3_column_int(pSql
, 0);
3373 const char *zOp
= (const char*)sqlite3_column_text(pSql
, 1);
3374 int p1
= sqlite3_column_int(pSql
, 2);
3375 int p2
= sqlite3_column_int(pSql
, 3);
3377 /* Assuming that p2 is an instruction address, set variable p2op to the
3378 ** index of that instruction in the aiIndent[] array. p2 and p2op may be
3379 ** different if the current instruction is part of a sub-program generated
3380 ** by an SQL trigger or foreign key. */
3381 int p2op
= (p2
+ (iOp
-iAddr
));
3383 /* Grow the p->aiIndent array as required */
3386 p
->aiIndent
= (int*)sqlite3_realloc64(p
->aiIndent
, nAlloc
*sizeof(int));
3387 shell_check_oom(p
->aiIndent
);
3388 abYield
= (int*)sqlite3_realloc64(abYield
, nAlloc
*sizeof(int));
3389 shell_check_oom(abYield
);
3392 abYield
[iOp
] = str_in_array(zOp
, azYield
);
3393 p
->aiIndent
[iOp
] = 0;
3395 if( str_in_array(zOp
, azNext
) && p2op
>0 ){
3396 for(i
=p2op
; i
<iOp
; i
++) p
->aiIndent
[i
] += 2;
3398 if( str_in_array(zOp
, azGoto
) && p2op
<iOp
&& (abYield
[p2op
] || p1
) ){
3399 for(i
=p2op
; i
<iOp
; i
++) p
->aiIndent
[i
] += 2;
3404 sqlite3_free(abYield
);
3405 sqlite3_reset(pSql
);
3409 ** Free the array allocated by explain_data_prepare().
3411 static void explain_data_delete(ShellState
*p
){
3412 sqlite3_free(p
->aiIndent
);
3418 static void exec_prepared_stmt(ShellState
*, sqlite3_stmt
*);
3421 ** Display scan stats.
3423 static void display_scanstats(
3424 sqlite3
*db
, /* Database to query */
3425 ShellState
*pArg
/* Pointer to ShellState */
3427 #ifndef SQLITE_ENABLE_STMT_SCANSTATUS
3428 UNUSED_PARAMETER(db
);
3429 UNUSED_PARAMETER(pArg
);
3431 if( pArg
->scanstatsOn
==3 ){
3433 " SELECT addr, opcode, p1, p2, p3, p4, p5, comment, nexec,"
3434 " round(ncycle*100.0 / (sum(ncycle) OVER ()), 2)||'%' AS cycles"
3435 " FROM bytecode(?)";
3438 sqlite3_stmt
*pStmt
= 0;
3439 rc
= sqlite3_prepare_v2(db
, zSql
, -1, &pStmt
, 0);
3440 if( rc
==SQLITE_OK
){
3441 sqlite3_stmt
*pSave
= pArg
->pStmt
;
3442 pArg
->pStmt
= pStmt
;
3443 sqlite3_bind_pointer(pStmt
, 1, pSave
, "stmt-pointer", 0);
3446 pArg
->cMode
= MODE_ScanExp
;
3447 explain_data_prepare(pArg
, pStmt
);
3448 exec_prepared_stmt(pArg
, pStmt
);
3449 explain_data_delete(pArg
);
3451 sqlite3_finalize(pStmt
);
3452 pArg
->pStmt
= pSave
;
3455 display_explain_scanstats(db
, pArg
);
3461 ** Disable and restore .wheretrace and .treetrace/.selecttrace settings.
3463 static unsigned int savedSelectTrace
;
3464 static unsigned int savedWhereTrace
;
3465 static void disable_debug_trace_modes(void){
3466 unsigned int zero
= 0;
3467 sqlite3_test_control(SQLITE_TESTCTRL_TRACEFLAGS
, 0, &savedSelectTrace
);
3468 sqlite3_test_control(SQLITE_TESTCTRL_TRACEFLAGS
, 1, &zero
);
3469 sqlite3_test_control(SQLITE_TESTCTRL_TRACEFLAGS
, 2, &savedWhereTrace
);
3470 sqlite3_test_control(SQLITE_TESTCTRL_TRACEFLAGS
, 3, &zero
);
3472 static void restore_debug_trace_modes(void){
3473 sqlite3_test_control(SQLITE_TESTCTRL_TRACEFLAGS
, 1, &savedSelectTrace
);
3474 sqlite3_test_control(SQLITE_TESTCTRL_TRACEFLAGS
, 3, &savedWhereTrace
);
3477 /* Create the TEMP table used to store parameter bindings */
3478 static void bind_table_init(ShellState
*p
){
3480 int defensiveMode
= 0;
3481 sqlite3_db_config(p
->db
, SQLITE_DBCONFIG_DEFENSIVE
, -1, &defensiveMode
);
3482 sqlite3_db_config(p
->db
, SQLITE_DBCONFIG_DEFENSIVE
, 0, 0);
3483 sqlite3_db_config(p
->db
, SQLITE_DBCONFIG_WRITABLE_SCHEMA
, -1, &wrSchema
);
3484 sqlite3_db_config(p
->db
, SQLITE_DBCONFIG_WRITABLE_SCHEMA
, 1, 0);
3486 "CREATE TABLE IF NOT EXISTS temp.sqlite_parameters(\n"
3487 " key TEXT PRIMARY KEY,\n"
3491 sqlite3_db_config(p
->db
, SQLITE_DBCONFIG_WRITABLE_SCHEMA
, wrSchema
, 0);
3492 sqlite3_db_config(p
->db
, SQLITE_DBCONFIG_DEFENSIVE
, defensiveMode
, 0);
3496 ** Bind parameters on a prepared statement.
3498 ** Parameter bindings are taken from a TEMP table of the form:
3500 ** CREATE TEMP TABLE sqlite_parameters(key TEXT PRIMARY KEY, value)
3503 ** No bindings occur if this table does not exist. The name of the table
3504 ** begins with "sqlite_" so that it will not collide with ordinary application
3505 ** tables. The table must be in the TEMP schema.
3507 static void bind_prepared_stmt(ShellState
*pArg
, sqlite3_stmt
*pStmt
){
3511 sqlite3_stmt
*pQ
= 0;
3513 nVar
= sqlite3_bind_parameter_count(pStmt
);
3514 if( nVar
==0 ) return; /* Nothing to do */
3515 if( sqlite3_table_column_metadata(pArg
->db
, "TEMP", "sqlite_parameters",
3516 "key", 0, 0, 0, 0, 0)!=SQLITE_OK
){
3517 rc
= SQLITE_NOTFOUND
;
3520 rc
= sqlite3_prepare_v2(pArg
->db
,
3521 "SELECT value FROM temp.sqlite_parameters"
3522 " WHERE key=?1", -1, &pQ
, 0);
3524 for(i
=1; i
<=nVar
; i
++){
3526 const char *zVar
= sqlite3_bind_parameter_name(pStmt
, i
);
3528 sqlite3_snprintf(sizeof(zNum
),zNum
,"?%d",i
);
3531 sqlite3_bind_text(pQ
, 1, zVar
, -1, SQLITE_STATIC
);
3532 if( rc
==SQLITE_OK
&& pQ
&& sqlite3_step(pQ
)==SQLITE_ROW
){
3533 sqlite3_bind_value(pStmt
, i
, sqlite3_column_value(pQ
, 0));
3535 }else if( sqlite3_strlike("_NAN", zVar
, 0)==0 ){
3536 sqlite3_bind_double(pStmt
, i
, NAN
);
3539 }else if( sqlite3_strlike("_INF", zVar
, 0)==0 ){
3540 sqlite3_bind_double(pStmt
, i
, INFINITY
);
3543 sqlite3_bind_null(pStmt
, i
);
3547 sqlite3_finalize(pQ
);
3551 ** UTF8 box-drawing characters. Imagine box lines like this:
3559 ** Each box characters has between 2 and 4 of the lines leading from
3560 ** the center. The characters are here identified by the numbers of
3561 ** their corresponding lines.
3563 #define BOX_24 "\342\224\200" /* U+2500 --- */
3564 #define BOX_13 "\342\224\202" /* U+2502 | */
3565 #define BOX_23 "\342\224\214" /* U+250c ,- */
3566 #define BOX_34 "\342\224\220" /* U+2510 -, */
3567 #define BOX_12 "\342\224\224" /* U+2514 '- */
3568 #define BOX_14 "\342\224\230" /* U+2518 -' */
3569 #define BOX_123 "\342\224\234" /* U+251c |- */
3570 #define BOX_134 "\342\224\244" /* U+2524 -| */
3571 #define BOX_234 "\342\224\254" /* U+252c -,- */
3572 #define BOX_124 "\342\224\264" /* U+2534 -'- */
3573 #define BOX_1234 "\342\224\274" /* U+253c -|- */
3575 /* Draw horizontal line N characters long using unicode box
3578 static void print_box_line(int N
){
3579 const char zDash
[] =
3580 BOX_24 BOX_24 BOX_24 BOX_24 BOX_24 BOX_24 BOX_24 BOX_24 BOX_24 BOX_24
3581 BOX_24 BOX_24 BOX_24 BOX_24 BOX_24 BOX_24 BOX_24 BOX_24 BOX_24 BOX_24
;
3582 const int nDash
= sizeof(zDash
) - 1;
3588 oputf("%.*s", N
, zDash
);
3592 ** Draw a horizontal separator for a MODE_Box table.
3594 static void print_box_row_separator(
3604 print_box_line(p
->actualWidth
[0]+2);
3605 for(i
=1; i
<nArg
; i
++){
3607 print_box_line(p
->actualWidth
[i
]+2);
3615 ** z[] is a line of text that is to be displayed the .mode box or table or
3616 ** similar tabular formats. z[] might contain control characters such
3617 ** as \n, \t, \f, or \r.
3619 ** Compute characters to display on the first line of z[]. Stop at the
3620 ** first \r, \n, or \f. Expand \t into spaces. Return a copy (obtained
3621 ** from malloc()) of that first line, which caller should free sometime.
3622 ** Write anything to display on the next line into *pzTail. If this is
3623 ** the last line, write a NULL into *pzTail. (*pzTail is not allocated.)
3625 static char *translateForDisplayAndDup(
3626 const unsigned char *z
, /* Input text to be transformed */
3627 const unsigned char **pzTail
, /* OUT: Tail of the input for next line */
3628 int mxWidth
, /* Max width. 0 means no limit */
3629 u8 bWordWrap
/* If true, avoid breaking mid-word */
3631 int i
; /* Input bytes consumed */
3632 int j
; /* Output bytes generated */
3633 int k
; /* Input bytes to be displayed */
3634 int n
; /* Output column number */
3635 unsigned char *zOut
; /* Output text */
3641 if( mxWidth
<0 ) mxWidth
= -mxWidth
;
3642 if( mxWidth
==0 ) mxWidth
= 1000000;
3647 do{ i
++; j
++; }while( (z
[i
]&0xc0)==0x80 );
3654 }while( (n
&7)!=0 && n
<mxWidth
);
3660 if( n
>=mxWidth
&& bWordWrap
){
3661 /* Perhaps try to back up to a better place to break the line */
3662 for(k
=i
; k
>i
/2; k
--){
3663 if( isspace(z
[k
-1]) ) break;
3666 for(k
=i
; k
>i
/2; k
--){
3667 if( isalnum(z
[k
-1])!=isalnum(z
[k
]) && (z
[k
]&0xc0)!=0x80 ) break;
3674 while( z
[i
]==' ' ) i
++;
3679 if( n
>=mxWidth
&& z
[i
]>=' ' ){
3681 }else if( z
[i
]=='\r' && z
[i
+1]=='\n' ){
3682 *pzTail
= z
[i
+2] ? &z
[i
+2] : 0;
3683 }else if( z
[i
]==0 || z
[i
+1]==0 ){
3688 zOut
= malloc( j
+1 );
3689 shell_check_oom(zOut
);
3694 do{ zOut
[j
++] = z
[i
++]; }while( (z
[i
]&0xc0)==0x80 );
3701 }while( (n
&7)!=0 && n
<mxWidth
);
3711 /* Extract the value of the i-th current column for pStmt as an SQL literal
3712 ** value. Memory is obtained from sqlite3_malloc64() and must be freed by
3715 static char *quoted_column(sqlite3_stmt
*pStmt
, int i
){
3716 switch( sqlite3_column_type(pStmt
, i
) ){
3718 return sqlite3_mprintf("NULL");
3720 case SQLITE_INTEGER
:
3721 case SQLITE_FLOAT
: {
3722 return sqlite3_mprintf("%s",sqlite3_column_text(pStmt
,i
));
3725 return sqlite3_mprintf("%Q",sqlite3_column_text(pStmt
,i
));
3729 sqlite3_str
*pStr
= sqlite3_str_new(0);
3730 const unsigned char *a
= sqlite3_column_blob(pStmt
,i
);
3731 int n
= sqlite3_column_bytes(pStmt
,i
);
3732 sqlite3_str_append(pStr
, "x'", 2);
3734 sqlite3_str_appendf(pStr
, "%02x", a
[j
]);
3736 sqlite3_str_append(pStr
, "'", 1);
3737 return sqlite3_str_finish(pStr
);
3740 return 0; /* Not reached */
3744 ** Run a prepared statement and output the result in one of the
3745 ** table-oriented formats: MODE_Column, MODE_Markdown, MODE_Table,
3748 ** This is different from ordinary exec_prepared_stmt() in that
3749 ** it has to run the entire query and gather the results into memory
3750 ** first, in order to determine column widths, before providing
3753 static void exec_prepared_stmt_columnar(
3754 ShellState
*p
, /* Pointer to ShellState */
3755 sqlite3_stmt
*pStmt
/* Statement to run */
3757 sqlite3_int64 nRow
= 0;
3760 sqlite3_int64 nAlloc
= 0;
3762 const unsigned char *uz
;
3764 char **azQuoted
= 0;
3766 sqlite3_int64 i
, nData
;
3767 int j
, nTotal
, w
, n
;
3768 const char *colSep
= 0;
3769 const char *rowSep
= 0;
3770 const unsigned char **azNextLine
= 0;
3772 int bMultiLineRowExists
= 0;
3773 int bw
= p
->cmOpts
.bWordWrap
;
3774 const char *zEmpty
= "";
3775 const char *zShowNull
= p
->nullValue
;
3777 rc
= sqlite3_step(pStmt
);
3778 if( rc
!=SQLITE_ROW
) return;
3779 nColumn
= sqlite3_column_count(pStmt
);
3780 if( nColumn
==0 ) goto columnar_end
;
3782 if( nAlloc
<=0 ) nAlloc
= 1;
3783 azData
= sqlite3_malloc64( nAlloc
*sizeof(char*) );
3784 shell_check_oom(azData
);
3785 azNextLine
= sqlite3_malloc64( nColumn
*sizeof(char*) );
3786 shell_check_oom(azNextLine
);
3787 memset((void*)azNextLine
, 0, nColumn
*sizeof(char*) );
3788 if( p
->cmOpts
.bQuote
){
3789 azQuoted
= sqlite3_malloc64( nColumn
*sizeof(char*) );
3790 shell_check_oom(azQuoted
);
3791 memset(azQuoted
, 0, nColumn
*sizeof(char*) );
3793 abRowDiv
= sqlite3_malloc64( nAlloc
/nColumn
);
3794 shell_check_oom(abRowDiv
);
3795 if( nColumn
>p
->nWidth
){
3796 p
->colWidth
= realloc(p
->colWidth
, (nColumn
+1)*2*sizeof(int));
3797 shell_check_oom(p
->colWidth
);
3798 for(i
=p
->nWidth
; i
<nColumn
; i
++) p
->colWidth
[i
] = 0;
3799 p
->nWidth
= nColumn
;
3800 p
->actualWidth
= &p
->colWidth
[nColumn
];
3802 memset(p
->actualWidth
, 0, nColumn
*sizeof(int));
3803 for(i
=0; i
<nColumn
; i
++){
3806 p
->actualWidth
[i
] = w
;
3808 for(i
=0; i
<nColumn
; i
++){
3809 const unsigned char *zNotUsed
;
3810 int wx
= p
->colWidth
[i
];
3812 wx
= p
->cmOpts
.iWrap
;
3814 if( wx
<0 ) wx
= -wx
;
3815 uz
= (const unsigned char*)sqlite3_column_name(pStmt
,i
);
3816 if( uz
==0 ) uz
= (u8
*)"";
3817 azData
[i
] = translateForDisplayAndDup(uz
, &zNotUsed
, wx
, bw
);
3820 int useNextLine
= bNextLine
;
3822 if( (nRow
+2)*nColumn
>= nAlloc
){
3824 azData
= sqlite3_realloc64(azData
, nAlloc
*sizeof(char*));
3825 shell_check_oom(azData
);
3826 abRowDiv
= sqlite3_realloc64(abRowDiv
, nAlloc
/nColumn
);
3827 shell_check_oom(abRowDiv
);
3831 for(i
=0; i
<nColumn
; i
++){
3832 int wx
= p
->colWidth
[i
];
3834 wx
= p
->cmOpts
.iWrap
;
3836 if( wx
<0 ) wx
= -wx
;
3839 if( uz
==0 ) uz
= (u8
*)zEmpty
;
3840 }else if( p
->cmOpts
.bQuote
){
3841 sqlite3_free(azQuoted
[i
]);
3842 azQuoted
[i
] = quoted_column(pStmt
,i
);
3843 uz
= (const unsigned char*)azQuoted
[i
];
3845 uz
= (const unsigned char*)sqlite3_column_text(pStmt
,i
);
3846 if( uz
==0 ) uz
= (u8
*)zShowNull
;
3848 azData
[nRow
*nColumn
+ i
]
3849 = translateForDisplayAndDup(uz
, &azNextLine
[i
], wx
, bw
);
3850 if( azNextLine
[i
] ){
3852 abRowDiv
[nRow
-1] = 0;
3853 bMultiLineRowExists
= 1;
3856 }while( bNextLine
|| sqlite3_step(pStmt
)==SQLITE_ROW
);
3857 nTotal
= nColumn
*(nRow
+1);
3858 for(i
=0; i
<nTotal
; i
++){
3860 if( z
==0 ) z
= (char*)zEmpty
;
3863 if( n
>p
->actualWidth
[j
] ) p
->actualWidth
[j
] = n
;
3865 if( seenInterrupt
) goto columnar_end
;
3870 if( p
->showHeader
){
3871 for(i
=0; i
<nColumn
; i
++){
3872 w
= p
->actualWidth
[i
];
3873 if( p
->colWidth
[i
]<0 ) w
= -w
;
3874 utf8_width_print(w
, azData
[i
]);
3875 fputs(i
==nColumn
-1?"\n":" ", p
->out
);
3877 for(i
=0; i
<nColumn
; i
++){
3878 print_dashes(p
->actualWidth
[i
]);
3879 fputs(i
==nColumn
-1?"\n":" ", p
->out
);
3887 print_row_separator(p
, nColumn
, "+");
3888 fputs("| ", p
->out
);
3889 for(i
=0; i
<nColumn
; i
++){
3890 w
= p
->actualWidth
[i
];
3891 n
= strlenChar(azData
[i
]);
3892 oputf("%*s%s%*s", (w
-n
)/2, "", azData
[i
], (w
-n
+1)/2, "");
3893 oputz(i
==nColumn
-1?" |\n":" | ");
3895 print_row_separator(p
, nColumn
, "+");
3898 case MODE_Markdown
: {
3901 fputs("| ", p
->out
);
3902 for(i
=0; i
<nColumn
; i
++){
3903 w
= p
->actualWidth
[i
];
3904 n
= strlenChar(azData
[i
]);
3905 oputf("%*s%s%*s", (w
-n
)/2, "", azData
[i
], (w
-n
+1)/2, "");
3906 oputz(i
==nColumn
-1?" |\n":" | ");
3908 print_row_separator(p
, nColumn
, "|");
3912 colSep
= " " BOX_13
" ";
3913 rowSep
= " " BOX_13
"\n";
3914 print_box_row_separator(p
, nColumn
, BOX_23
, BOX_234
, BOX_34
);
3916 for(i
=0; i
<nColumn
; i
++){
3917 w
= p
->actualWidth
[i
];
3918 n
= strlenChar(azData
[i
]);
3920 (w
-n
)/2, "", azData
[i
], (w
-n
+1)/2, "",
3921 i
==nColumn
-1?" "BOX_13
"\n":" "BOX_13
" ");
3923 print_box_row_separator(p
, nColumn
, BOX_123
, BOX_1234
, BOX_134
);
3927 for(i
=nColumn
, j
=0; i
<nTotal
; i
++, j
++){
3928 if( j
==0 && p
->cMode
!=MODE_Column
){
3929 oputz(p
->cMode
==MODE_Box
?BOX_13
" ":"| ");
3932 if( z
==0 ) z
= p
->nullValue
;
3933 w
= p
->actualWidth
[j
];
3934 if( p
->colWidth
[j
]<0 ) w
= -w
;
3935 utf8_width_print(w
, z
);
3938 if( bMultiLineRowExists
&& abRowDiv
[i
/nColumn
-1] && i
+1<nTotal
){
3939 if( p
->cMode
==MODE_Table
){
3940 print_row_separator(p
, nColumn
, "+");
3941 }else if( p
->cMode
==MODE_Box
){
3942 print_box_row_separator(p
, nColumn
, BOX_123
, BOX_1234
, BOX_134
);
3943 }else if( p
->cMode
==MODE_Column
){
3948 if( seenInterrupt
) goto columnar_end
;
3953 if( p
->cMode
==MODE_Table
){
3954 print_row_separator(p
, nColumn
, "+");
3955 }else if( p
->cMode
==MODE_Box
){
3956 print_box_row_separator(p
, nColumn
, BOX_12
, BOX_124
, BOX_14
);
3959 if( seenInterrupt
){
3960 oputz("Interrupt\n");
3962 nData
= (nRow
+1)*nColumn
;
3963 for(i
=0; i
<nData
; i
++){
3965 if( z
!=zEmpty
&& z
!=zShowNull
) free(azData
[i
]);
3967 sqlite3_free(azData
);
3968 sqlite3_free((void*)azNextLine
);
3969 sqlite3_free(abRowDiv
);
3971 for(i
=0; i
<nColumn
; i
++) sqlite3_free(azQuoted
[i
]);
3972 sqlite3_free(azQuoted
);
3977 ** Run a prepared statement
3979 static void exec_prepared_stmt(
3980 ShellState
*pArg
, /* Pointer to ShellState */
3981 sqlite3_stmt
*pStmt
/* Statement to run */
3984 sqlite3_uint64 nRow
= 0;
3986 if( pArg
->cMode
==MODE_Column
3987 || pArg
->cMode
==MODE_Table
3988 || pArg
->cMode
==MODE_Box
3989 || pArg
->cMode
==MODE_Markdown
3991 exec_prepared_stmt_columnar(pArg
, pStmt
);
3995 /* perform the first step. this will tell us if we
3996 ** have a result set or not and how wide it is.
3998 rc
= sqlite3_step(pStmt
);
3999 /* if we have a result set... */
4000 if( SQLITE_ROW
== rc
){
4001 /* allocate space for col name ptr, value ptr, and type */
4002 int nCol
= sqlite3_column_count(pStmt
);
4003 void *pData
= sqlite3_malloc64(3*nCol
*sizeof(const char*) + 1);
4005 shell_out_of_memory();
4007 char **azCols
= (char **)pData
; /* Names of result columns */
4008 char **azVals
= &azCols
[nCol
]; /* Results */
4009 int *aiTypes
= (int *)&azVals
[nCol
]; /* Result types */
4011 assert(sizeof(int) <= sizeof(char *));
4012 /* save off ptrs to column names */
4013 for(i
=0; i
<nCol
; i
++){
4014 azCols
[i
] = (char *)sqlite3_column_name(pStmt
, i
);
4018 /* extract the data and data types */
4019 for(i
=0; i
<nCol
; i
++){
4020 aiTypes
[i
] = x
= sqlite3_column_type(pStmt
, i
);
4023 && (pArg
->cMode
==MODE_Insert
|| pArg
->cMode
==MODE_Quote
)
4027 azVals
[i
] = (char*)sqlite3_column_text(pStmt
, i
);
4029 if( !azVals
[i
] && (aiTypes
[i
]!=SQLITE_NULL
) ){
4031 break; /* from for */
4035 /* if data and types extracted successfully... */
4036 if( SQLITE_ROW
== rc
){
4037 /* call the supplied callback with the result row data */
4038 if( shell_callback(pArg
, nCol
, azVals
, azCols
, aiTypes
) ){
4041 rc
= sqlite3_step(pStmt
);
4044 } while( SQLITE_ROW
== rc
);
4045 sqlite3_free(pData
);
4046 if( pArg
->cMode
==MODE_Json
){
4047 fputs("]\n", pArg
->out
);
4048 }else if( pArg
->cMode
==MODE_Count
){
4050 sqlite3_snprintf(sizeof(zBuf
), zBuf
, "%llu row%s\n",
4051 nRow
, nRow
!=1 ? "s" : "");
4058 #ifndef SQLITE_OMIT_VIRTUALTABLE
4060 ** This function is called to process SQL if the previous shell command
4061 ** was ".expert". It passes the SQL in the second argument directly to
4062 ** the sqlite3expert object.
4064 ** If successful, SQLITE_OK is returned. Otherwise, an SQLite error
4065 ** code. In this case, (*pzErr) may be set to point to a buffer containing
4066 ** an English language error message. It is the responsibility of the
4067 ** caller to eventually free this buffer using sqlite3_free().
4069 static int expertHandleSQL(
4074 assert( pState
->expert
.pExpert
);
4075 assert( pzErr
==0 || *pzErr
==0 );
4076 return sqlite3_expert_sql(pState
->expert
.pExpert
, zSql
, pzErr
);
4080 ** This function is called either to silently clean up the object
4081 ** created by the ".expert" command (if bCancel==1), or to generate a
4082 ** report from it and then clean it up (if bCancel==0).
4084 ** If successful, SQLITE_OK is returned. Otherwise, an SQLite error
4085 ** code. In this case, (*pzErr) may be set to point to a buffer containing
4086 ** an English language error message. It is the responsibility of the
4087 ** caller to eventually free this buffer using sqlite3_free().
4089 static int expertFinish(
4095 sqlite3expert
*p
= pState
->expert
.pExpert
;
4097 assert( bCancel
|| pzErr
==0 || *pzErr
==0 );
4099 int bVerbose
= pState
->expert
.bVerbose
;
4101 rc
= sqlite3_expert_analyze(p
, pzErr
);
4102 if( rc
==SQLITE_OK
){
4103 int nQuery
= sqlite3_expert_count(p
);
4107 const char *zCand
= sqlite3_expert_report(p
,0,EXPERT_REPORT_CANDIDATES
);
4108 oputz("-- Candidates -----------------------------\n");
4109 oputf("%s\n", zCand
);
4111 for(i
=0; i
<nQuery
; i
++){
4112 const char *zSql
= sqlite3_expert_report(p
, i
, EXPERT_REPORT_SQL
);
4113 const char *zIdx
= sqlite3_expert_report(p
, i
, EXPERT_REPORT_INDEXES
);
4114 const char *zEQP
= sqlite3_expert_report(p
, i
, EXPERT_REPORT_PLAN
);
4115 if( zIdx
==0 ) zIdx
= "(no new indexes)\n";
4117 oputf("-- Query %d --------------------------------\n",i
+1);
4118 oputf("%s\n\n", zSql
);
4120 oputf("%s\n", zIdx
);
4121 oputf("%s\n", zEQP
);
4125 sqlite3_expert_destroy(p
);
4126 pState
->expert
.pExpert
= 0;
4131 ** Implementation of ".expert" dot command.
4133 static int expertDotCommand(
4134 ShellState
*pState
, /* Current shell tool state */
4135 char **azArg
, /* Array of arguments passed to dot command */
4136 int nArg
/* Number of entries in azArg[] */
4143 assert( pState
->expert
.pExpert
==0 );
4144 memset(&pState
->expert
, 0, sizeof(ExpertInfo
));
4146 for(i
=1; rc
==SQLITE_OK
&& i
<nArg
; i
++){
4149 if( z
[0]=='-' && z
[1]=='-' ) z
++;
4151 if( n
>=2 && 0==cli_strncmp(z
, "-verbose", n
) ){
4152 pState
->expert
.bVerbose
= 1;
4154 else if( n
>=2 && 0==cli_strncmp(z
, "-sample", n
) ){
4156 eputf("option requires an argument: %s\n", z
);
4159 iSample
= (int)integerValue(azArg
[++i
]);
4160 if( iSample
<0 || iSample
>100 ){
4161 eputf("value out of range: %s\n", azArg
[i
]);
4167 eputf("unknown option: %s\n", z
);
4172 if( rc
==SQLITE_OK
){
4173 pState
->expert
.pExpert
= sqlite3_expert_new(pState
->db
, &zErr
);
4174 if( pState
->expert
.pExpert
==0 ){
4175 eputf("sqlite3_expert_new: %s\n", zErr
? zErr
: "out of memory");
4178 sqlite3_expert_config(
4179 pState
->expert
.pExpert
, EXPERT_CONFIG_SAMPLE
, iSample
4187 #endif /* ifndef SQLITE_OMIT_VIRTUALTABLE */
4190 ** Execute a statement or set of statements. Print
4191 ** any result rows/columns depending on the current mode
4192 ** set via the supplied callback.
4194 ** This is very similar to SQLite's built-in sqlite3_exec()
4195 ** function except it takes a slightly different callback
4196 ** and callback data argument.
4198 static int shell_exec(
4199 ShellState
*pArg
, /* Pointer to ShellState */
4200 const char *zSql
, /* SQL to be evaluated */
4201 char **pzErrMsg
/* Error msg written here */
4203 sqlite3_stmt
*pStmt
= NULL
; /* Statement to execute. */
4204 int rc
= SQLITE_OK
; /* Return Code */
4206 const char *zLeftover
; /* Tail of unprocessed SQL */
4207 sqlite3
*db
= pArg
->db
;
4213 #ifndef SQLITE_OMIT_VIRTUALTABLE
4214 if( pArg
->expert
.pExpert
){
4215 rc
= expertHandleSQL(pArg
, zSql
, pzErrMsg
);
4216 return expertFinish(pArg
, (rc
!=SQLITE_OK
), pzErrMsg
);
4220 while( zSql
[0] && (SQLITE_OK
== rc
) ){
4221 static const char *zStmtSql
;
4222 rc
= sqlite3_prepare_v2(db
, zSql
, -1, &pStmt
, &zLeftover
);
4223 if( SQLITE_OK
!= rc
){
4225 *pzErrMsg
= save_err_msg(db
, "in prepare", rc
, zSql
);
4229 /* this happens for a comment or white-space */
4231 while( IsSpace(zSql
[0]) ) zSql
++;
4234 zStmtSql
= sqlite3_sql(pStmt
);
4235 if( zStmtSql
==0 ) zStmtSql
= "";
4236 while( IsSpace(zStmtSql
[0]) ) zStmtSql
++;
4238 /* save off the prepared statement handle and reset row count */
4240 pArg
->pStmt
= pStmt
;
4244 /* Show the EXPLAIN QUERY PLAN if .eqp is on */
4245 if( pArg
&& pArg
->autoEQP
&& sqlite3_stmt_isexplain(pStmt
)==0 ){
4246 sqlite3_stmt
*pExplain
;
4248 disable_debug_trace_modes();
4249 sqlite3_db_config(db
, SQLITE_DBCONFIG_TRIGGER_EQP
, -1, &triggerEQP
);
4250 if( pArg
->autoEQP
>=AUTOEQP_trigger
){
4251 sqlite3_db_config(db
, SQLITE_DBCONFIG_TRIGGER_EQP
, 1, 0);
4254 sqlite3_reset(pExplain
);
4255 rc
= sqlite3_stmt_explain(pExplain
, 2);
4256 if( rc
==SQLITE_OK
){
4257 while( sqlite3_step(pExplain
)==SQLITE_ROW
){
4258 const char *zEQPLine
= (const char*)sqlite3_column_text(pExplain
,3);
4259 int iEqpId
= sqlite3_column_int(pExplain
, 0);
4260 int iParentId
= sqlite3_column_int(pExplain
, 1);
4261 if( zEQPLine
==0 ) zEQPLine
= "";
4262 if( zEQPLine
[0]=='-' ) eqp_render(pArg
, 0);
4263 eqp_append(pArg
, iEqpId
, iParentId
, zEQPLine
);
4265 eqp_render(pArg
, 0);
4267 if( pArg
->autoEQP
>=AUTOEQP_full
){
4268 /* Also do an EXPLAIN for ".eqp full" mode */
4269 sqlite3_reset(pExplain
);
4270 rc
= sqlite3_stmt_explain(pExplain
, 1);
4271 if( rc
==SQLITE_OK
){
4272 pArg
->cMode
= MODE_Explain
;
4273 assert( sqlite3_stmt_isexplain(pExplain
)==1 );
4274 explain_data_prepare(pArg
, pExplain
);
4275 exec_prepared_stmt(pArg
, pExplain
);
4276 explain_data_delete(pArg
);
4279 if( pArg
->autoEQP
>=AUTOEQP_trigger
&& triggerEQP
==0 ){
4280 sqlite3_db_config(db
, SQLITE_DBCONFIG_TRIGGER_EQP
, 0, 0);
4282 sqlite3_reset(pStmt
);
4283 sqlite3_stmt_explain(pStmt
, 0);
4284 restore_debug_trace_modes();
4288 int bIsExplain
= (sqlite3_stmt_isexplain(pStmt
)==1);
4289 pArg
->cMode
= pArg
->mode
;
4290 if( pArg
->autoExplain
){
4292 pArg
->cMode
= MODE_Explain
;
4294 if( sqlite3_stmt_isexplain(pStmt
)==2 ){
4295 pArg
->cMode
= MODE_EQP
;
4299 /* If the shell is currently in ".explain" mode, gather the extra
4300 ** data required to add indents to the output.*/
4301 if( pArg
->cMode
==MODE_Explain
&& bIsExplain
){
4302 explain_data_prepare(pArg
, pStmt
);
4306 bind_prepared_stmt(pArg
, pStmt
);
4307 exec_prepared_stmt(pArg
, pStmt
);
4308 explain_data_delete(pArg
);
4309 eqp_render(pArg
, 0);
4311 /* print usage stats if stats on */
4312 if( pArg
&& pArg
->statsOn
){
4313 display_stats(db
, pArg
, 0);
4316 /* print loop-counters if required */
4317 if( pArg
&& pArg
->scanstatsOn
){
4318 display_scanstats(db
, pArg
);
4321 /* Finalize the statement just executed. If this fails, save a
4322 ** copy of the error message. Otherwise, set zSql to point to the
4323 ** next statement to execute. */
4324 rc2
= sqlite3_finalize(pStmt
);
4325 if( rc
!=SQLITE_NOMEM
) rc
= rc2
;
4326 if( rc
==SQLITE_OK
){
4328 while( IsSpace(zSql
[0]) ) zSql
++;
4329 }else if( pzErrMsg
){
4330 *pzErrMsg
= save_err_msg(db
, "stepping", rc
, 0);
4333 /* clear saved stmt handle */
4344 ** Release memory previously allocated by tableColumnList().
4346 static void freeColumnList(char **azCol
){
4348 for(i
=1; azCol
[i
]; i
++){
4349 sqlite3_free(azCol
[i
]);
4351 /* azCol[0] is a static string */
4352 sqlite3_free(azCol
);
4356 ** Return a list of pointers to strings which are the names of all
4357 ** columns in table zTab. The memory to hold the names is dynamically
4358 ** allocated and must be released by the caller using a subsequent call
4359 ** to freeColumnList().
4361 ** The azCol[0] entry is usually NULL. However, if zTab contains a rowid
4362 ** value that needs to be preserved, then azCol[0] is filled in with the
4363 ** name of the rowid column.
4365 ** The first regular column in the table is azCol[1]. The list is terminated
4366 ** by an entry with azCol[i]==0.
4368 static char **tableColumnList(ShellState
*p
, const char *zTab
){
4370 sqlite3_stmt
*pStmt
;
4374 int nPK
= 0; /* Number of PRIMARY KEY columns seen */
4375 int isIPK
= 0; /* True if one PRIMARY KEY column of type INTEGER */
4376 int preserveRowid
= ShellHasFlag(p
, SHFLG_PreserveRowid
);
4379 zSql
= sqlite3_mprintf("PRAGMA table_info=%Q", zTab
);
4380 shell_check_oom(zSql
);
4381 rc
= sqlite3_prepare_v2(p
->db
, zSql
, -1, &pStmt
, 0);
4384 while( sqlite3_step(pStmt
)==SQLITE_ROW
){
4385 if( nCol
>=nAlloc
-2 ){
4386 nAlloc
= nAlloc
*2 + nCol
+ 10;
4387 azCol
= sqlite3_realloc(azCol
, nAlloc
*sizeof(azCol
[0]));
4388 shell_check_oom(azCol
);
4390 azCol
[++nCol
] = sqlite3_mprintf("%s", sqlite3_column_text(pStmt
, 1));
4391 shell_check_oom(azCol
[nCol
]);
4392 if( sqlite3_column_int(pStmt
, 5) ){
4395 && sqlite3_stricmp((const char*)sqlite3_column_text(pStmt
,2),
4404 sqlite3_finalize(pStmt
);
4405 if( azCol
==0 ) return 0;
4409 /* The decision of whether or not a rowid really needs to be preserved
4410 ** is tricky. We never need to preserve a rowid for a WITHOUT ROWID table
4411 ** or a table with an INTEGER PRIMARY KEY. We are unable to preserve
4412 ** rowids on tables where the rowid is inaccessible because there are other
4413 ** columns in the table named "rowid", "_rowid_", and "oid".
4415 if( preserveRowid
&& isIPK
){
4416 /* If a single PRIMARY KEY column with type INTEGER was seen, then it
4417 ** might be an alias for the ROWID. But it might also be a WITHOUT ROWID
4418 ** table or a INTEGER PRIMARY KEY DESC column, neither of which are
4419 ** ROWID aliases. To distinguish these cases, check to see if
4420 ** there is a "pk" entry in "PRAGMA index_list". There will be
4421 ** no "pk" index if the PRIMARY KEY really is an alias for the ROWID.
4423 zSql
= sqlite3_mprintf("SELECT 1 FROM pragma_index_list(%Q)"
4424 " WHERE origin='pk'", zTab
);
4425 shell_check_oom(zSql
);
4426 rc
= sqlite3_prepare_v2(p
->db
, zSql
, -1, &pStmt
, 0);
4429 freeColumnList(azCol
);
4432 rc
= sqlite3_step(pStmt
);
4433 sqlite3_finalize(pStmt
);
4434 preserveRowid
= rc
==SQLITE_ROW
;
4436 if( preserveRowid
){
4437 /* Only preserve the rowid if we can find a name to use for the
4439 static char *azRowid
[] = { "rowid", "_rowid_", "oid" };
4442 for(i
=1; i
<=nCol
; i
++){
4443 if( sqlite3_stricmp(azRowid
[j
],azCol
[i
])==0 ) break;
4446 /* At this point, we know that azRowid[j] is not the name of any
4447 ** ordinary column in the table. Verify that azRowid[j] is a valid
4448 ** name for the rowid before adding it to azCol[0]. WITHOUT ROWID
4449 ** tables will fail this last check */
4450 rc
= sqlite3_table_column_metadata(p
->db
,0,zTab
,azRowid
[j
],0,0,0,0,0);
4451 if( rc
==SQLITE_OK
) azCol
[0] = azRowid
[j
];
4460 ** Toggle the reverse_unordered_selects setting.
4462 static void toggleSelectOrder(sqlite3
*db
){
4463 sqlite3_stmt
*pStmt
= 0;
4466 sqlite3_prepare_v2(db
, "PRAGMA reverse_unordered_selects", -1, &pStmt
, 0);
4467 if( sqlite3_step(pStmt
)==SQLITE_ROW
){
4468 iSetting
= sqlite3_column_int(pStmt
, 0);
4470 sqlite3_finalize(pStmt
);
4471 sqlite3_snprintf(sizeof(zStmt
), zStmt
,
4472 "PRAGMA reverse_unordered_selects(%d)", !iSetting
);
4473 sqlite3_exec(db
, zStmt
, 0, 0, 0);
4477 ** This is a different callback routine used for dumping the database.
4478 ** Each row received by this callback consists of a table name,
4479 ** the table type ("index" or "table") and SQL to create the table.
4480 ** This routine should print text sufficient to recreate the table.
4482 static int dump_callback(void *pArg
, int nArg
, char **azArg
, char **azNotUsed
){
4487 ShellState
*p
= (ShellState
*)pArg
;
4491 UNUSED_PARAMETER(azNotUsed
);
4492 if( nArg
!=3 || azArg
==0 ) return 0;
4496 if( zTable
==0 ) return 0;
4497 if( zType
==0 ) return 0;
4498 dataOnly
= (p
->shellFlgs
& SHFLG_DumpDataOnly
)!=0;
4499 noSys
= (p
->shellFlgs
& SHFLG_DumpNoSys
)!=0;
4501 if( cli_strcmp(zTable
, "sqlite_sequence")==0 && !noSys
){
4502 if( !dataOnly
) oputz("DELETE FROM sqlite_sequence;\n");
4503 }else if( sqlite3_strglob("sqlite_stat?", zTable
)==0 && !noSys
){
4504 if( !dataOnly
) oputz("ANALYZE sqlite_schema;\n");
4505 }else if( cli_strncmp(zTable
, "sqlite_", 7)==0 ){
4507 }else if( dataOnly
){
4509 }else if( cli_strncmp(zSql
, "CREATE VIRTUAL TABLE", 20)==0 ){
4511 if( !p
->writableSchema
){
4512 oputz("PRAGMA writable_schema=ON;\n");
4513 p
->writableSchema
= 1;
4515 zIns
= sqlite3_mprintf(
4516 "INSERT INTO sqlite_schema(type,name,tbl_name,rootpage,sql)"
4517 "VALUES('table','%q','%q',0,'%q');",
4518 zTable
, zTable
, zSql
);
4519 shell_check_oom(zIns
);
4520 oputf("%s\n", zIns
);
4524 printSchemaLine(zSql
, ";\n");
4527 if( cli_strcmp(zType
, "table")==0 ){
4532 char *savedDestTable
;
4535 azCol
= tableColumnList(p
, zTable
);
4541 /* Always quote the table name, even if it appears to be pure ascii,
4542 ** in case it is a keyword. Ex: INSERT INTO "table" ... */
4544 appendText(&sTable
, zTable
, quoteChar(zTable
));
4545 /* If preserving the rowid, add a column list after the table name.
4546 ** In other words: "INSERT INTO tab(rowid,a,b,c,...) VALUES(...)"
4547 ** instead of the usual "INSERT INTO tab VALUES(...)".
4550 appendText(&sTable
, "(", 0);
4551 appendText(&sTable
, azCol
[0], 0);
4552 for(i
=1; azCol
[i
]; i
++){
4553 appendText(&sTable
, ",", 0);
4554 appendText(&sTable
, azCol
[i
], quoteChar(azCol
[i
]));
4556 appendText(&sTable
, ")", 0);
4559 /* Build an appropriate SELECT statement */
4561 appendText(&sSelect
, "SELECT ", 0);
4563 appendText(&sSelect
, azCol
[0], 0);
4564 appendText(&sSelect
, ",", 0);
4566 for(i
=1; azCol
[i
]; i
++){
4567 appendText(&sSelect
, azCol
[i
], quoteChar(azCol
[i
]));
4569 appendText(&sSelect
, ",", 0);
4572 freeColumnList(azCol
);
4573 appendText(&sSelect
, " FROM ", 0);
4574 appendText(&sSelect
, zTable
, quoteChar(zTable
));
4576 savedDestTable
= p
->zDestTable
;
4577 savedMode
= p
->mode
;
4578 p
->zDestTable
= sTable
.z
;
4579 p
->mode
= p
->cMode
= MODE_Insert
;
4580 rc
= shell_exec(p
, sSelect
.z
, 0);
4581 if( (rc
&0xff)==SQLITE_CORRUPT
){
4582 oputz("/****** CORRUPTION ERROR *******/\n");
4583 toggleSelectOrder(p
->db
);
4584 shell_exec(p
, sSelect
.z
, 0);
4585 toggleSelectOrder(p
->db
);
4587 p
->zDestTable
= savedDestTable
;
4588 p
->mode
= savedMode
;
4597 ** Run zQuery. Use dump_callback() as the callback routine so that
4598 ** the contents of the query are output as SQL statements.
4600 ** If we get a SQLITE_CORRUPT error, rerun the query after appending
4601 ** "ORDER BY rowid DESC" to the end.
4603 static int run_schema_dump_query(
4609 rc
= sqlite3_exec(p
->db
, zQuery
, dump_callback
, p
, &zErr
);
4610 if( rc
==SQLITE_CORRUPT
){
4612 int len
= strlen30(zQuery
);
4613 oputz("/****** CORRUPTION ERROR *******/\n");
4615 oputf("/****** %s ******/\n", zErr
);
4619 zQ2
= malloc( len
+100 );
4620 if( zQ2
==0 ) return rc
;
4621 sqlite3_snprintf(len
+100, zQ2
, "%s ORDER BY rowid DESC", zQuery
);
4622 rc
= sqlite3_exec(p
->db
, zQ2
, dump_callback
, p
, &zErr
);
4624 oputf("/****** ERROR: %s ******/\n", zErr
);
4626 rc
= SQLITE_CORRUPT
;
4635 ** Text of help messages.
4637 ** The help text for each individual command begins with a line that starts
4638 ** with ".". Subsequent lines are supplemental information.
4640 ** There must be two or more spaces between the end of the command and the
4641 ** start of the description of what that command does.
4643 static const char *(azHelp
[]) = {
4644 #if defined(SQLITE_HAVE_ZLIB) && !defined(SQLITE_OMIT_VIRTUALTABLE) \
4645 && !defined(SQLITE_SHELL_FIDDLE)
4646 ".archive ... Manage SQL archives",
4647 " Each command must have exactly one of the following options:",
4648 " -c, --create Create a new archive",
4649 " -u, --update Add or update files with changed mtime",
4650 " -i, --insert Like -u but always add even if unchanged",
4651 " -r, --remove Remove files from archive",
4652 " -t, --list List contents of archive",
4653 " -x, --extract Extract files from archive",
4654 " Optional arguments:",
4655 " -v, --verbose Print each filename as it is processed",
4656 " -f FILE, --file FILE Use archive FILE (default is current db)",
4657 " -a FILE, --append FILE Open FILE using the apndvfs VFS",
4658 " -C DIR, --directory DIR Read/extract files from directory DIR",
4659 " -g, --glob Use glob matching for names in archive",
4660 " -n, --dryrun Show the SQL that would have occurred",
4662 " .ar -cf ARCHIVE foo bar # Create ARCHIVE from files foo and bar",
4663 " .ar -tf ARCHIVE # List members of ARCHIVE",
4664 " .ar -xvf ARCHIVE # Verbosely extract files from ARCHIVE",
4666 " http://sqlite.org/cli.html#sqlite_archive_support",
4668 #ifndef SQLITE_OMIT_AUTHORIZATION
4669 ".auth ON|OFF Show authorizer callbacks",
4671 #ifndef SQLITE_SHELL_FIDDLE
4672 ".backup ?DB? FILE Backup DB (default \"main\") to FILE",
4674 " --append Use the appendvfs",
4675 " --async Write to FILE without journal and fsync()",
4677 ".bail on|off Stop after hitting an error. Default OFF",
4678 #ifndef SQLITE_SHELL_FIDDLE
4679 ".cd DIRECTORY Change the working directory to DIRECTORY",
4681 ".changes on|off Show number of rows changed by SQL",
4682 #ifndef SQLITE_SHELL_FIDDLE
4683 ".check GLOB Fail if output since .testcase does not match",
4684 ".clone NEWDB Clone data into NEWDB from the existing database",
4686 ".connection [close] [#] Open or close an auxiliary database connection",
4687 #if defined(_WIN32) || defined(WIN32)
4688 ".crnl on|off Translate \\n to \\r\\n. Default ON",
4690 ".databases List names and files of attached databases",
4691 ".dbconfig ?op? ?val? List or change sqlite3_db_config() options",
4692 #if SQLITE_SHELL_HAVE_RECOVER
4693 ".dbinfo ?DB? Show status information about the database",
4695 ".dump ?OBJECTS? Render database content as SQL",
4697 " --data-only Output only INSERT statements",
4698 " --newlines Allow unescaped newline characters in output",
4699 " --nosys Omit system tables (ex: \"sqlite_stat1\")",
4700 " --preserve-rowids Include ROWID values in the output",
4701 " OBJECTS is a LIKE pattern for tables, indexes, triggers or views to dump",
4702 " Additional LIKE patterns can be given in subsequent arguments",
4703 ".echo on|off Turn command echo on or off",
4704 ".eqp on|off|full|... Enable or disable automatic EXPLAIN QUERY PLAN",
4707 " test Show raw EXPLAIN QUERY PLAN output",
4708 " trace Like \"full\" but enable \"PRAGMA vdbe_trace\"",
4710 " trigger Like \"full\" but also show trigger bytecode",
4711 #ifndef SQLITE_SHELL_FIDDLE
4712 ".excel Display the output of next command in spreadsheet",
4713 " --bom Put a UTF8 byte-order mark on intermediate file",
4715 #ifndef SQLITE_SHELL_FIDDLE
4716 ".exit ?CODE? Exit this program with return-code CODE",
4718 ".expert EXPERIMENTAL. Suggest indexes for queries",
4719 ".explain ?on|off|auto? Change the EXPLAIN formatting mode. Default: auto",
4720 ".filectrl CMD ... Run various sqlite3_file_control() operations",
4721 " --schema SCHEMA Use SCHEMA instead of \"main\"",
4722 " --help Show CMD details",
4723 ".fullschema ?--indent? Show schema and the content of sqlite_stat tables",
4724 ".headers on|off Turn display of headers on or off",
4725 ".help ?-all? ?PATTERN? Show help text for PATTERN",
4726 #ifndef SQLITE_SHELL_FIDDLE
4727 ".import FILE TABLE Import data from FILE into TABLE",
4729 " --ascii Use \\037 and \\036 as column and row separators",
4730 " --csv Use , and \\n as column and row separators",
4731 " --skip N Skip the first N rows of input",
4732 " --schema S Target table to be S.TABLE",
4733 " -v \"Verbose\" - increase auxiliary output",
4735 " * If TABLE does not exist, it is created. The first row of input",
4736 " determines the column names.",
4737 " * If neither --csv or --ascii are used, the input mode is derived",
4738 " from the \".mode\" output mode",
4739 " * If FILE begins with \"|\" then it is a command that generates the",
4742 #ifndef SQLITE_OMIT_TEST_CONTROL
4743 ",imposter INDEX TABLE Create imposter table TABLE on index INDEX",
4745 ".indexes ?TABLE? Show names of indexes",
4746 " If TABLE is specified, only show indexes for",
4747 " tables matching TABLE using the LIKE operator.",
4748 #ifdef SQLITE_ENABLE_IOTRACE
4749 ",iotrace FILE Enable I/O diagnostic logging to FILE",
4751 ".limit ?LIMIT? ?VAL? Display or change the value of an SQLITE_LIMIT",
4752 ".lint OPTIONS Report potential schema issues.",
4754 " fkey-indexes Find missing foreign key indexes",
4755 #if !defined(SQLITE_OMIT_LOAD_EXTENSION) && !defined(SQLITE_SHELL_FIDDLE)
4756 ".load FILE ?ENTRY? Load an extension library",
4758 #if !defined(SQLITE_SHELL_FIDDLE)
4759 ".log FILE|on|off Turn logging on or off. FILE can be stderr/stdout",
4761 ".log on|off Turn logging on or off.",
4763 ".mode MODE ?OPTIONS? Set output mode",
4765 " ascii Columns/rows delimited by 0x1F and 0x1E",
4766 " box Tables using unicode box-drawing characters",
4767 " csv Comma-separated values",
4768 " column Output in columns. (See .width)",
4769 " html HTML <table> code",
4770 " insert SQL insert statements for TABLE",
4771 " json Results in a JSON array",
4772 " line One value per line",
4773 " list Values delimited by \"|\"",
4774 " markdown Markdown table format",
4775 " qbox Shorthand for \"box --wrap 60 --quote\"",
4776 " quote Escape answers as for SQL",
4777 " table ASCII-art table",
4778 " tabs Tab-separated values",
4779 " tcl TCL list elements",
4780 " OPTIONS: (for columnar modes or insert mode):",
4781 " --wrap N Wrap output lines to no longer than N characters",
4782 " --wordwrap B Wrap or not at word boundaries per B (on/off)",
4783 " --ww Shorthand for \"--wordwrap 1\"",
4784 " --quote Quote output text as SQL literals",
4785 " --noquote Do not quote output text",
4786 " TABLE The name of SQL table used for \"insert\" mode",
4787 #ifndef SQLITE_SHELL_FIDDLE
4788 ".nonce STRING Suspend safe mode for one command if nonce matches",
4790 ".nullvalue STRING Use STRING in place of NULL values",
4791 #ifndef SQLITE_SHELL_FIDDLE
4792 ".once ?OPTIONS? ?FILE? Output for the next SQL command only to FILE",
4793 " If FILE begins with '|' then open as a pipe",
4794 " --bom Put a UTF8 byte-order mark at the beginning",
4795 " -e Send output to the system text editor",
4796 " -x Send output as CSV to a spreadsheet (same as \".excel\")",
4797 /* Note that .open is (partially) available in WASM builds but is
4798 ** currently only intended to be used by the fiddle tool, not
4799 ** end users, so is "undocumented." */
4800 ".open ?OPTIONS? ?FILE? Close existing database and reopen FILE",
4802 " --append Use appendvfs to append database to the end of FILE",
4804 #ifndef SQLITE_OMIT_DESERIALIZE
4805 " --deserialize Load into memory using sqlite3_deserialize()",
4806 " --hexdb Load the output of \"dbtotxt\" as an in-memory db",
4807 " --maxsize N Maximum size for --hexdb or --deserialized database",
4809 " --new Initialize FILE to an empty database",
4810 " --nofollow Do not follow symbolic links",
4811 " --readonly Open FILE readonly",
4812 " --zip FILE is a ZIP archive",
4813 #ifndef SQLITE_SHELL_FIDDLE
4814 ".output ?FILE? Send output to FILE or stdout if FILE is omitted",
4815 " If FILE begins with '|' then open it as a pipe.",
4817 " --bom Prefix output with a UTF8 byte-order mark",
4818 " -e Send output to the system text editor",
4819 " -x Send output as CSV to a spreadsheet",
4821 ".parameter CMD ... Manage SQL parameter bindings",
4822 " clear Erase all bindings",
4823 " init Initialize the TEMP table that holds bindings",
4824 " list List the current parameter bindings",
4825 " set PARAMETER VALUE Given SQL parameter PARAMETER a value of VALUE",
4826 " PARAMETER should start with one of: $ : @ ?",
4827 " unset PARAMETER Remove PARAMETER from the binding table",
4828 ".print STRING... Print literal STRING",
4829 #ifndef SQLITE_OMIT_PROGRESS_CALLBACK
4830 ".progress N Invoke progress handler after every N opcodes",
4831 " --limit N Interrupt after N progress callbacks",
4832 " --once Do no more than one progress interrupt",
4833 " --quiet|-q No output except at interrupts",
4834 " --reset Reset the count for each input and interrupt",
4836 ".prompt MAIN CONTINUE Replace the standard prompts",
4837 #ifndef SQLITE_SHELL_FIDDLE
4838 ".quit Stop interpreting input stream, exit if primary.",
4839 ".read FILE Read input from FILE or command output",
4840 " If FILE begins with \"|\", it is a command that generates the input.",
4842 #if SQLITE_SHELL_HAVE_RECOVER
4843 ".recover Recover as much data as possible from corrupt db.",
4844 " --ignore-freelist Ignore pages that appear to be on db freelist",
4845 " --lost-and-found TABLE Alternative name for the lost-and-found table",
4846 " --no-rowids Do not attempt to recover rowid values",
4847 " that are not also INTEGER PRIMARY KEYs",
4849 #ifndef SQLITE_SHELL_FIDDLE
4850 ".restore ?DB? FILE Restore content of DB (default \"main\") from FILE",
4851 ".save ?OPTIONS? FILE Write database to FILE (an alias for .backup ...)",
4853 ".scanstats on|off|est Turn sqlite3_stmt_scanstatus() metrics on or off",
4854 ".schema ?PATTERN? Show the CREATE statements matching PATTERN",
4856 " --indent Try to pretty-print the schema",
4857 " --nosys Omit objects whose names start with \"sqlite_\"",
4858 ",selftest ?OPTIONS? Run tests defined in the SELFTEST table",
4860 " --init Create a new SELFTEST table",
4861 " -v Verbose output",
4862 ".separator COL ?ROW? Change the column and row separators",
4863 #if defined(SQLITE_ENABLE_SESSION)
4864 ".session ?NAME? CMD ... Create or control sessions",
4866 " attach TABLE Attach TABLE",
4867 " changeset FILE Write a changeset into FILE",
4868 " close Close one session",
4869 " enable ?BOOLEAN? Set or query the enable bit",
4870 " filter GLOB... Reject tables matching GLOBs",
4871 " indirect ?BOOLEAN? Mark or query the indirect status",
4872 " isempty Query whether the session is empty",
4873 " list List currently open session names",
4874 " open DB NAME Open a new session on DB",
4875 " patchset FILE Write a patchset into FILE",
4876 " If ?NAME? is omitted, the first defined session is used.",
4878 ".sha3sum ... Compute a SHA3 hash of database content",
4880 " --schema Also hash the sqlite_schema table",
4881 " --sha3-224 Use the sha3-224 algorithm",
4882 " --sha3-256 Use the sha3-256 algorithm (default)",
4883 " --sha3-384 Use the sha3-384 algorithm",
4884 " --sha3-512 Use the sha3-512 algorithm",
4885 " Any other argument is a LIKE pattern for tables to hash",
4886 #if !defined(SQLITE_NOHAVE_SYSTEM) && !defined(SQLITE_SHELL_FIDDLE)
4887 ".shell CMD ARGS... Run CMD ARGS... in a system shell",
4889 ".show Show the current values for various settings",
4890 ".stats ?ARG? Show stats or turn stats on or off",
4891 " off Turn off automatic stat display",
4892 " on Turn on automatic stat display",
4893 " stmt Show statement stats",
4894 " vmstep Show the virtual machine step count only",
4895 #if !defined(SQLITE_NOHAVE_SYSTEM) && !defined(SQLITE_SHELL_FIDDLE)
4896 ".system CMD ARGS... Run CMD ARGS... in a system shell",
4898 ".tables ?TABLE? List names of tables matching LIKE pattern TABLE",
4899 #ifndef SQLITE_SHELL_FIDDLE
4900 ",testcase NAME Begin redirecting output to 'testcase-out.txt'",
4902 ",testctrl CMD ... Run various sqlite3_test_control() operations",
4903 " Run \".testctrl\" with no arguments for details",
4904 ".timeout MS Try opening locked tables for MS milliseconds",
4905 ".timer on|off Turn SQL timer on or off",
4906 #ifndef SQLITE_OMIT_TRACE
4907 ".trace ?OPTIONS? Output each SQL statement as it is run",
4908 " FILE Send output to FILE",
4909 " stdout Send output to stdout",
4910 " stderr Send output to stderr",
4911 " off Disable tracing",
4912 " --expanded Expand query parameters",
4913 #ifdef SQLITE_ENABLE_NORMALIZE
4914 " --normalized Normal the SQL statements",
4916 " --plain Show SQL as it is input",
4917 " --stmt Trace statement execution (SQLITE_TRACE_STMT)",
4918 " --profile Profile statements (SQLITE_TRACE_PROFILE)",
4919 " --row Trace each row (SQLITE_TRACE_ROW)",
4920 " --close Trace connection close (SQLITE_TRACE_CLOSE)",
4921 #endif /* SQLITE_OMIT_TRACE */
4923 ".unmodule NAME ... Unregister virtual table modules",
4924 " --allexcept Unregister everything except those named",
4926 ".version Show source, library and compiler versions",
4927 ".vfsinfo ?AUX? Information about the top-level VFS",
4928 ".vfslist List all available VFSes",
4929 ".vfsname ?AUX? Print the name of the VFS stack",
4930 ".width NUM1 NUM2 ... Set minimum column widths for columnar output",
4931 " Negative values right-justify",
4935 ** Output help text.
4937 ** zPattern describes the set of commands for which help text is provided.
4938 ** If zPattern is NULL, then show all commands, but only give a one-line
4939 ** description of each.
4941 ** Return the number of matches.
4943 static int showHelp(FILE *out
, const char *zPattern
){
4950 || cli_strcmp(zPattern
,"-a")==0
4951 || cli_strcmp(zPattern
,"-all")==0
4952 || cli_strcmp(zPattern
,"--all")==0
4954 enum HelpWanted
{ HW_NoCull
= 0, HW_SummaryOnly
= 1, HW_Undoc
= 2 };
4955 enum HelpHave
{ HH_Undoc
= 2, HH_Summary
= 1, HH_More
= 0 };
4956 /* Show all or most commands
4957 ** *zPattern==0 => summary of documented commands only
4958 ** *zPattern=='0' => whole help for undocumented commands
4959 ** Otherwise => whole help for documented commands
4961 enum HelpWanted hw
= HW_SummaryOnly
;
4962 enum HelpHave hh
= HH_More
;
4964 hw
= (*zPattern
=='0')? HW_NoCull
|HW_Undoc
: HW_NoCull
;
4966 for(i
=0; i
<ArraySize(azHelp
); i
++){
4967 switch( azHelp
[i
][0] ){
4969 hh
= HH_Summary
|HH_Undoc
;
4978 if( ((hw
^hh
)&HH_Undoc
)==0 ){
4979 if( (hh
&HH_Summary
)!=0 ){
4980 sputf(out
, ".%s\n", azHelp
[i
]+1);
4982 }else if( (hw
&HW_SummaryOnly
)==0 ){
4983 sputf(out
, "%s\n", azHelp
[i
]);
4988 /* Seek documented commands for which zPattern is an exact prefix */
4989 zPat
= sqlite3_mprintf(".%s*", zPattern
);
4990 shell_check_oom(zPat
);
4991 for(i
=0; i
<ArraySize(azHelp
); i
++){
4992 if( sqlite3_strglob(zPat
, azHelp
[i
])==0 ){
4993 sputf(out
, "%s\n", azHelp
[i
]);
5001 /* when zPattern is a prefix of exactly one command, then include
5002 ** the details of that command, which should begin at offset j */
5003 while( j
<ArraySize(azHelp
)-1 && azHelp
[j
][0]==' ' ){
5004 sputf(out
, "%s\n", azHelp
[j
]);
5010 /* Look for documented commands that contain zPattern anywhere.
5011 ** Show complete text of all documented commands that match. */
5012 zPat
= sqlite3_mprintf("%%%s%%", zPattern
);
5013 shell_check_oom(zPat
);
5014 for(i
=0; i
<ArraySize(azHelp
); i
++){
5015 if( azHelp
[i
][0]==',' ){
5016 while( i
<ArraySize(azHelp
)-1 && azHelp
[i
+1][0]==' ' ) ++i
;
5019 if( azHelp
[i
][0]=='.' ) j
= i
;
5020 if( sqlite3_strlike(zPat
, azHelp
[i
], 0)==0 ){
5021 sputf(out
, "%s\n", azHelp
[j
]);
5022 while( j
<ArraySize(azHelp
)-1 && azHelp
[j
+1][0]==' ' ){
5024 sputf(out
, "%s\n", azHelp
[j
]);
5035 /* Forward reference */
5036 static int process_input(ShellState
*p
);
5039 ** Read the content of file zName into memory obtained from sqlite3_malloc64()
5040 ** and return a pointer to the buffer. The caller is responsible for freeing
5043 ** If parameter pnByte is not NULL, (*pnByte) is set to the number of bytes
5046 ** For convenience, a nul-terminator byte is always appended to the data read
5047 ** from the file before the buffer is returned. This byte is not included in
5048 ** the final value of (*pnByte), if applicable.
5050 ** NULL is returned if any error is encountered. The final value of *pnByte
5051 ** is undefined in this case.
5053 static char *readFile(const char *zName
, int *pnByte
){
5054 FILE *in
= fopen(zName
, "rb");
5059 if( in
==0 ) return 0;
5060 rc
= fseek(in
, 0, SEEK_END
);
5062 eputf("Error: '%s' not seekable\n", zName
);
5068 pBuf
= sqlite3_malloc64( nIn
+1 );
5070 eputz("Error: out of memory\n");
5074 nRead
= fread(pBuf
, nIn
, 1, in
);
5078 eputf("Error: cannot read '%s'\n", zName
);
5082 if( pnByte
) *pnByte
= nIn
;
5086 #if defined(SQLITE_ENABLE_SESSION)
5088 ** Close a single OpenSession object and release all of its associated
5091 static void session_close(OpenSession
*pSession
){
5093 sqlite3session_delete(pSession
->p
);
5094 sqlite3_free(pSession
->zName
);
5095 for(i
=0; i
<pSession
->nFilter
; i
++){
5096 sqlite3_free(pSession
->azFilter
[i
]);
5098 sqlite3_free(pSession
->azFilter
);
5099 memset(pSession
, 0, sizeof(OpenSession
));
5104 ** Close all OpenSession objects and release all associated resources.
5106 #if defined(SQLITE_ENABLE_SESSION)
5107 static void session_close_all(ShellState
*p
, int i
){
5109 struct AuxDb
*pAuxDb
= i
<0 ? p
->pAuxDb
: &p
->aAuxDb
[i
];
5110 for(j
=0; j
<pAuxDb
->nSession
; j
++){
5111 session_close(&pAuxDb
->aSession
[j
]);
5113 pAuxDb
->nSession
= 0;
5116 # define session_close_all(X,Y)
5120 ** Implementation of the xFilter function for an open session. Omit
5121 ** any tables named by ".session filter" but let all other table through.
5123 #if defined(SQLITE_ENABLE_SESSION)
5124 static int session_filter(void *pCtx
, const char *zTab
){
5125 OpenSession
*pSession
= (OpenSession
*)pCtx
;
5127 for(i
=0; i
<pSession
->nFilter
; i
++){
5128 if( sqlite3_strglob(pSession
->azFilter
[i
], zTab
)==0 ) return 0;
5135 ** Try to deduce the type of file for zName based on its content. Return
5136 ** one of the SHELL_OPEN_* constants.
5138 ** If the file does not exist or is empty but its name looks like a ZIP
5139 ** archive and the dfltZip flag is true, then assume it is a ZIP archive.
5140 ** Otherwise, assume an ordinary database regardless of the filename if
5141 ** the type cannot be determined from content.
5143 int deduceDatabaseType(const char *zName
, int dfltZip
){
5144 FILE *f
= fopen(zName
, "rb");
5146 int rc
= SHELL_OPEN_UNSPEC
;
5149 if( dfltZip
&& sqlite3_strlike("%.zip",zName
,0)==0 ){
5150 return SHELL_OPEN_ZIPFILE
;
5152 return SHELL_OPEN_NORMAL
;
5155 n
= fread(zBuf
, 16, 1, f
);
5156 if( n
==1 && memcmp(zBuf
, "SQLite format 3", 16)==0 ){
5158 return SHELL_OPEN_NORMAL
;
5160 fseek(f
, -25, SEEK_END
);
5161 n
= fread(zBuf
, 25, 1, f
);
5162 if( n
==1 && memcmp(zBuf
, "Start-Of-SQLite3-", 17)==0 ){
5163 rc
= SHELL_OPEN_APPENDVFS
;
5165 fseek(f
, -22, SEEK_END
);
5166 n
= fread(zBuf
, 22, 1, f
);
5167 if( n
==1 && zBuf
[0]==0x50 && zBuf
[1]==0x4b && zBuf
[2]==0x05
5169 rc
= SHELL_OPEN_ZIPFILE
;
5170 }else if( n
==0 && dfltZip
&& sqlite3_strlike("%.zip",zName
,0)==0 ){
5171 rc
= SHELL_OPEN_ZIPFILE
;
5178 #ifndef SQLITE_OMIT_DESERIALIZE
5180 ** Reconstruct an in-memory database using the output from the "dbtotxt"
5181 ** program. Read content from the file in p->aAuxDb[].zDbFilename.
5182 ** If p->aAuxDb[].zDbFilename is 0, then read from standard input.
5184 static unsigned char *readHexDb(ShellState
*p
, int *pnData
){
5185 unsigned char *a
= 0;
5193 const char *zDbFilename
= p
->pAuxDb
->zDbFilename
;
5197 in
= fopen(zDbFilename
, "r");
5199 eputf("cannot open \"%s\" for reading\n", zDbFilename
);
5206 if( in
==0 ) in
= stdin
;
5210 if( fgets(zLine
, sizeof(zLine
), in
)==0 ) goto readHexDb_error
;
5211 rc
= sscanf(zLine
, "| size %d pagesize %d", &n
, &pgsz
);
5212 if( rc
!=2 ) goto readHexDb_error
;
5213 if( n
<0 ) goto readHexDb_error
;
5214 if( pgsz
<512 || pgsz
>65536 || (pgsz
&(pgsz
-1))!=0 ) goto readHexDb_error
;
5215 n
= (n
+pgsz
-1)&~(pgsz
-1); /* Round n up to the next multiple of pgsz */
5216 a
= sqlite3_malloc( n
? n
: 1 );
5219 if( pgsz
<512 || pgsz
>65536 || (pgsz
& (pgsz
-1))!=0 ){
5220 eputz("invalid pagesize\n");
5221 goto readHexDb_error
;
5223 for(nLine
++; fgets(zLine
, sizeof(zLine
), in
)!=0; nLine
++){
5224 rc
= sscanf(zLine
, "| page %d offset %d", &j
, &k
);
5229 if( cli_strncmp(zLine
, "| end ", 6)==0 ){
5232 rc
= sscanf(zLine
,"| %d: %x %x %x %x %x %x %x %x %x %x %x %x %x %x %x %x",
5233 &j
, &x
[0], &x
[1], &x
[2], &x
[3], &x
[4], &x
[5], &x
[6], &x
[7],
5234 &x
[8], &x
[9], &x
[10], &x
[11], &x
[12], &x
[13], &x
[14], &x
[15]);
5237 if( k
+16<=n
&& k
>=0 ){
5239 for(ii
=0; ii
<16; ii
++) a
[k
+ii
] = x
[ii
]&0xff;
5255 while( fgets(zLine
, sizeof(zLine
), p
->in
)!=0 ){
5257 if(cli_strncmp(zLine
, "| end ", 6)==0 ) break;
5262 eputf("Error on line %d of --hexdb input\n", nLine
);
5265 #endif /* SQLITE_OMIT_DESERIALIZE */
5268 ** Scalar function "usleep(X)" invokes sqlite3_sleep(X) and returns X.
5270 static void shellUSleepFunc(
5271 sqlite3_context
*context
,
5273 sqlite3_value
**argv
5275 int sleep
= sqlite3_value_int(argv
[0]);
5277 sqlite3_sleep(sleep
/1000);
5278 sqlite3_result_int(context
, sleep
);
5281 /* Flags for open_db().
5283 ** The default behavior of open_db() is to exit(1) if the database fails to
5284 ** open. The OPEN_DB_KEEPALIVE flag changes that so that it prints an error
5285 ** but still returns without calling exit.
5287 ** The OPEN_DB_ZIPFILE flag causes open_db() to prefer to open files as a
5288 ** ZIP archive if the file does not exist or is empty and its name matches
5289 ** the *.zip pattern.
5291 #define OPEN_DB_KEEPALIVE 0x001 /* Return after error if true */
5292 #define OPEN_DB_ZIPFILE 0x002 /* Open as ZIP if name matches *.zip */
5295 ** Make sure the database is open. If it is not, then open it. If
5296 ** the database fails to open, print an error message and exit.
5298 static void open_db(ShellState
*p
, int openFlags
){
5300 const char *zDbFilename
= p
->pAuxDb
->zDbFilename
;
5301 if( p
->openMode
==SHELL_OPEN_UNSPEC
){
5302 if( zDbFilename
==0 || zDbFilename
[0]==0 ){
5303 p
->openMode
= SHELL_OPEN_NORMAL
;
5305 p
->openMode
= (u8
)deduceDatabaseType(zDbFilename
,
5306 (openFlags
& OPEN_DB_ZIPFILE
)!=0);
5309 switch( p
->openMode
){
5310 case SHELL_OPEN_APPENDVFS
: {
5311 sqlite3_open_v2(zDbFilename
, &p
->db
,
5312 SQLITE_OPEN_READWRITE
|SQLITE_OPEN_CREATE
|p
->openFlags
, "apndvfs");
5315 case SHELL_OPEN_HEXDB
:
5316 case SHELL_OPEN_DESERIALIZE
: {
5317 sqlite3_open(0, &p
->db
);
5320 case SHELL_OPEN_ZIPFILE
: {
5321 sqlite3_open(":memory:", &p
->db
);
5324 case SHELL_OPEN_READONLY
: {
5325 sqlite3_open_v2(zDbFilename
, &p
->db
,
5326 SQLITE_OPEN_READONLY
|p
->openFlags
, 0);
5329 case SHELL_OPEN_UNSPEC
:
5330 case SHELL_OPEN_NORMAL
: {
5331 sqlite3_open_v2(zDbFilename
, &p
->db
,
5332 SQLITE_OPEN_READWRITE
|SQLITE_OPEN_CREATE
|p
->openFlags
, 0);
5336 if( p
->db
==0 || SQLITE_OK
!=sqlite3_errcode(p
->db
) ){
5337 eputf("Error: unable to open database \"%s\": %s\n",
5338 zDbFilename
, sqlite3_errmsg(p
->db
));
5339 if( (openFlags
& OPEN_DB_KEEPALIVE
)==0 ){
5342 sqlite3_close(p
->db
);
5343 sqlite3_open(":memory:", &p
->db
);
5344 if( p
->db
==0 || SQLITE_OK
!=sqlite3_errcode(p
->db
) ){
5345 eputz("Also: unable to open substitute in-memory database.\n");
5348 eputf("Notice: using substitute in-memory database instead of \"%s\"\n",
5353 sqlite3_db_config(p
->db
, SQLITE_DBCONFIG_STMT_SCANSTATUS
, (int)0, (int*)0);
5355 /* Reflect the use or absence of --unsafe-testing invocation. */
5357 int testmode_on
= ShellHasFlag(p
,SHFLG_TestingMode
);
5358 sqlite3_db_config(p
->db
, SQLITE_DBCONFIG_TRUSTED_SCHEMA
, testmode_on
,0);
5359 sqlite3_db_config(p
->db
, SQLITE_DBCONFIG_DEFENSIVE
, !testmode_on
,0);
5362 #ifndef SQLITE_OMIT_LOAD_EXTENSION
5363 sqlite3_enable_load_extension(p
->db
, 1);
5365 sqlite3_shathree_init(p
->db
, 0, 0);
5366 sqlite3_uint_init(p
->db
, 0, 0);
5367 sqlite3_decimal_init(p
->db
, 0, 0);
5368 sqlite3_base64_init(p
->db
, 0, 0);
5369 sqlite3_base85_init(p
->db
, 0, 0);
5370 sqlite3_regexp_init(p
->db
, 0, 0);
5371 sqlite3_ieee_init(p
->db
, 0, 0);
5372 sqlite3_series_init(p
->db
, 0, 0);
5373 #ifndef SQLITE_SHELL_FIDDLE
5374 sqlite3_fileio_init(p
->db
, 0, 0);
5375 sqlite3_completion_init(p
->db
, 0, 0);
5377 #ifdef SQLITE_HAVE_ZLIB
5378 if( !p
->bSafeModePersist
){
5379 sqlite3_zipfile_init(p
->db
, 0, 0);
5380 sqlite3_sqlar_init(p
->db
, 0, 0);
5383 #ifdef SQLITE_SHELL_EXTFUNCS
5384 /* Create a preprocessing mechanism for extensions to make
5385 * their own provisions for being built into the shell.
5386 * This is a short-span macro. See further below for usage.
5388 #define SHELL_SUB_MACRO(base, variant) base ## _ ## variant
5389 #define SHELL_SUBMACRO(base, variant) SHELL_SUB_MACRO(base, variant)
5390 /* Let custom-included extensions get their ..._init() called.
5391 * The WHATEVER_INIT( db, pzErrorMsg, pApi ) macro should cause
5392 * the extension's sqlite3_*_init( db, pzErrorMsg, pApi )
5393 * initialization routine to be called.
5396 int irc
= SHELL_SUBMACRO(SQLITE_SHELL_EXTFUNCS
, INIT
)(p
->db
);
5397 /* Let custom-included extensions expose their functionality.
5398 * The WHATEVER_EXPOSE( db, pzErrorMsg ) macro should cause
5399 * the SQL functions, virtual tables, collating sequences or
5400 * VFS's implemented by the extension to be registered.
5403 || irc
==SQLITE_OK_LOAD_PERMANENTLY
){
5404 SHELL_SUBMACRO(SQLITE_SHELL_EXTFUNCS
, EXPOSE
)(p
->db
, 0);
5406 #undef SHELL_SUB_MACRO
5407 #undef SHELL_SUBMACRO
5411 sqlite3_create_function(p
->db
, "strtod", 1, SQLITE_UTF8
, 0,
5413 sqlite3_create_function(p
->db
, "dtostr", 1, SQLITE_UTF8
, 0,
5415 sqlite3_create_function(p
->db
, "dtostr", 2, SQLITE_UTF8
, 0,
5417 sqlite3_create_function(p
->db
, "shell_add_schema", 3, SQLITE_UTF8
, 0,
5418 shellAddSchemaName
, 0, 0);
5419 sqlite3_create_function(p
->db
, "shell_module_schema", 1, SQLITE_UTF8
, 0,
5420 shellModuleSchema
, 0, 0);
5421 sqlite3_create_function(p
->db
, "shell_putsnl", 1, SQLITE_UTF8
, p
,
5422 shellPutsFunc
, 0, 0);
5423 sqlite3_create_function(p
->db
, "usleep",1,SQLITE_UTF8
,0,
5424 shellUSleepFunc
, 0, 0);
5425 #ifndef SQLITE_NOHAVE_SYSTEM
5426 sqlite3_create_function(p
->db
, "edit", 1, SQLITE_UTF8
, 0,
5428 sqlite3_create_function(p
->db
, "edit", 2, SQLITE_UTF8
, 0,
5432 if( p
->openMode
==SHELL_OPEN_ZIPFILE
){
5433 char *zSql
= sqlite3_mprintf(
5434 "CREATE VIRTUAL TABLE zip USING zipfile(%Q);", zDbFilename
);
5435 shell_check_oom(zSql
);
5436 sqlite3_exec(p
->db
, zSql
, 0, 0, 0);
5439 #ifndef SQLITE_OMIT_DESERIALIZE
5441 if( p
->openMode
==SHELL_OPEN_DESERIALIZE
|| p
->openMode
==SHELL_OPEN_HEXDB
){
5444 unsigned char *aData
;
5445 if( p
->openMode
==SHELL_OPEN_DESERIALIZE
){
5446 aData
= (unsigned char*)readFile(zDbFilename
, &nData
);
5448 aData
= readHexDb(p
, &nData
);
5453 rc
= sqlite3_deserialize(p
->db
, "main", aData
, nData
, nData
,
5454 SQLITE_DESERIALIZE_RESIZEABLE
|
5455 SQLITE_DESERIALIZE_FREEONCLOSE
);
5457 eputf("Error: sqlite3_deserialize() returns %d\n", rc
);
5460 sqlite3_file_control(p
->db
, "main", SQLITE_FCNTL_SIZE_LIMIT
, &p
->szMax
);
5466 if( p
->bSafeModePersist
){
5467 sqlite3_set_authorizer(p
->db
, safeModeAuth
, p
);
5470 p
->db
, SQLITE_DBCONFIG_STMT_SCANSTATUS
, p
->scanstatsOn
, (int*)0
5476 ** Attempt to close the database connection. Report errors.
5478 void close_db(sqlite3
*db
){
5479 int rc
= sqlite3_close(db
);
5481 eputf("Error: sqlite3_close() returns %d: %s\n", rc
, sqlite3_errmsg(db
));
5485 #if HAVE_READLINE || HAVE_EDITLINE
5487 ** Readline completion callbacks
5489 static char *readline_completion_generator(const char *text
, int state
){
5490 static sqlite3_stmt
*pStmt
= 0;
5494 sqlite3_finalize(pStmt
);
5495 zSql
= sqlite3_mprintf("SELECT DISTINCT candidate COLLATE nocase"
5496 " FROM completion(%Q) ORDER BY 1", text
);
5497 shell_check_oom(zSql
);
5498 sqlite3_prepare_v2(globalDb
, zSql
, -1, &pStmt
, 0);
5501 if( sqlite3_step(pStmt
)==SQLITE_ROW
){
5502 const char *z
= (const char*)sqlite3_column_text(pStmt
,0);
5503 zRet
= z
? strdup(z
) : 0;
5505 sqlite3_finalize(pStmt
);
5511 static char **readline_completion(const char *zText
, int iStart
, int iEnd
){
5514 rl_attempted_completion_over
= 1;
5515 return rl_completion_matches(zText
, readline_completion_generator
);
5518 #elif HAVE_LINENOISE
5520 ** Linenoise completion callback
5522 static void linenoise_completion(const char *zLine
, linenoiseCompletions
*lc
){
5523 i64 nLine
= strlen(zLine
);
5525 sqlite3_stmt
*pStmt
= 0;
5529 if( nLine
>(i64
)sizeof(zBuf
)-30 ) return;
5530 if( zLine
[0]=='.' || zLine
[0]=='#') return;
5531 for(i
=nLine
-1; i
>=0 && (isalnum(zLine
[i
]) || zLine
[i
]=='_'); i
--){}
5532 if( i
==nLine
-1 ) return;
5534 memcpy(zBuf
, zLine
, iStart
);
5535 zSql
= sqlite3_mprintf("SELECT DISTINCT candidate COLLATE nocase"
5536 " FROM completion(%Q,%Q) ORDER BY 1",
5537 &zLine
[iStart
], zLine
);
5538 shell_check_oom(zSql
);
5539 sqlite3_prepare_v2(globalDb
, zSql
, -1, &pStmt
, 0);
5541 sqlite3_exec(globalDb
, "PRAGMA page_count", 0, 0, 0); /* Load the schema */
5542 while( sqlite3_step(pStmt
)==SQLITE_ROW
){
5543 const char *zCompletion
= (const char*)sqlite3_column_text(pStmt
, 0);
5544 int nCompletion
= sqlite3_column_bytes(pStmt
, 0);
5545 if( iStart
+nCompletion
< (i64
)sizeof(zBuf
)-1 && zCompletion
){
5546 memcpy(zBuf
+iStart
, zCompletion
, nCompletion
+1);
5547 linenoiseAddCompletion(lc
, zBuf
);
5550 sqlite3_finalize(pStmt
);
5555 ** Do C-language style dequoting.
5561 ** \v -> vertical tab
5563 ** \r -> carriage return
5568 ** \NNN -> ascii character NNN in octal
5569 ** \xHH -> ascii character HH in hexadecimal
5571 static void resolve_backslashes(char *z
){
5574 while( *z
&& *z
!='\\' ) z
++;
5575 for(i
=j
=0; (c
= z
[i
])!=0; i
++, j
++){
5576 if( c
=='\\' && z
[i
+1]!=0 ){
5594 }else if( c
=='\'' ){
5596 }else if( c
=='\\' ){
5601 while( nhd
<2 && (c
=z
[i
+1+nhd
])!=0 && (hdv
=hexDigitValue(c
))>=0 ){
5602 hv
= (u8
)((hv
<<4)|hdv
);
5607 }else if( c
>='0' && c
<='7' ){
5609 if( z
[i
+1]>='0' && z
[i
+1]<='7' ){
5611 c
= (c
<<3) + z
[i
] - '0';
5612 if( z
[i
+1]>='0' && z
[i
+1]<='7' ){
5614 c
= (c
<<3) + z
[i
] - '0';
5625 ** Interpret zArg as either an integer or a boolean value. Return 1 or 0
5626 ** for TRUE and FALSE. Return the integer value if appropriate.
5628 static int booleanValue(const char *zArg
){
5630 if( zArg
[0]=='0' && zArg
[1]=='x' ){
5631 for(i
=2; hexDigitValue(zArg
[i
])>=0; i
++){}
5633 for(i
=0; zArg
[i
]>='0' && zArg
[i
]<='9'; i
++){}
5635 if( i
>0 && zArg
[i
]==0 ) return (int)(integerValue(zArg
) & 0xffffffff);
5636 if( sqlite3_stricmp(zArg
, "on")==0 || sqlite3_stricmp(zArg
,"yes")==0 ){
5639 if( sqlite3_stricmp(zArg
, "off")==0 || sqlite3_stricmp(zArg
,"no")==0 ){
5642 eputf("ERROR: Not a boolean value: \"%s\". Assuming \"no\".\n", zArg
);
5647 ** Set or clear a shell flag according to a boolean value.
5649 static void setOrClearFlag(ShellState
*p
, unsigned mFlag
, const char *zArg
){
5650 if( booleanValue(zArg
) ){
5651 ShellSetFlag(p
, mFlag
);
5653 ShellClearFlag(p
, mFlag
);
5658 ** Close an output file, assuming it is not stderr or stdout
5660 static void output_file_close(FILE *f
){
5661 if( f
&& f
!=stdout
&& f
!=stderr
) fclose(f
);
5665 ** Try to open an output file. The names "stdout" and "stderr" are
5666 ** recognized and do the right thing. NULL is returned if the output
5667 ** filename is "off".
5669 static FILE *output_file_open(const char *zFile
, int bTextMode
){
5671 if( cli_strcmp(zFile
,"stdout")==0 ){
5673 }else if( cli_strcmp(zFile
, "stderr")==0 ){
5675 }else if( cli_strcmp(zFile
, "off")==0 ){
5678 f
= fopen(zFile
, bTextMode
? "w" : "wb");
5680 eputf("Error: cannot open \"%s\"\n", zFile
);
5686 #ifndef SQLITE_OMIT_TRACE
5688 ** A routine for handling output from sqlite3_trace().
5690 static int sql_trace_callback(
5691 unsigned mType
, /* The trace type */
5692 void *pArg
, /* The ShellState pointer */
5693 void *pP
, /* Usually a pointer to sqlite_stmt */
5694 void *pX
/* Auxiliary output */
5696 ShellState
*p
= (ShellState
*)pArg
;
5697 sqlite3_stmt
*pStmt
;
5700 if( p
->traceOut
==0 ) return 0;
5701 if( mType
==SQLITE_TRACE_CLOSE
){
5702 sputz(p
->traceOut
, "-- closing database connection\n");
5705 if( mType
!=SQLITE_TRACE_ROW
&& pX
!=0 && ((const char*)pX
)[0]=='-' ){
5706 zSql
= (const char*)pX
;
5708 pStmt
= (sqlite3_stmt
*)pP
;
5709 switch( p
->eTraceType
){
5710 case SHELL_TRACE_EXPANDED
: {
5711 zSql
= sqlite3_expanded_sql(pStmt
);
5714 #ifdef SQLITE_ENABLE_NORMALIZE
5715 case SHELL_TRACE_NORMALIZED
: {
5716 zSql
= sqlite3_normalized_sql(pStmt
);
5721 zSql
= sqlite3_sql(pStmt
);
5726 if( zSql
==0 ) return 0;
5727 nSql
= strlen(zSql
);
5728 if( nSql
>1000000000 ) nSql
= 1000000000;
5729 while( nSql
>0 && zSql
[nSql
-1]==';' ){ nSql
--; }
5731 case SQLITE_TRACE_ROW
:
5732 case SQLITE_TRACE_STMT
: {
5733 sputf(p
->traceOut
, "%.*s;\n", (int)nSql
, zSql
);
5736 case SQLITE_TRACE_PROFILE
: {
5737 sqlite3_int64 nNanosec
= pX
? *(sqlite3_int64
*)pX
: 0;
5738 sputf(p
->traceOut
, "%.*s; -- %lld ns\n", (int)nSql
, zSql
, nNanosec
);
5747 ** A no-op routine that runs with the ".breakpoint" doc-command. This is
5748 ** a useful spot to set a debugger breakpoint.
5750 ** This routine does not do anything practical. The code are there simply
5751 ** to prevent the compiler from optimizing this routine out.
5753 static void test_breakpoint(void){
5754 static unsigned int nCall
= 0;
5755 if( (nCall
++)==0xffffffff ) printf("Many .breakpoints have run\n");
5759 ** An object used to read a CSV and other files for import.
5761 typedef struct ImportCtx ImportCtx
;
5763 const char *zFile
; /* Name of the input file */
5764 FILE *in
; /* Read the CSV text from this input stream */
5765 int (SQLITE_CDECL
*xCloser
)(FILE*); /* Func to close in */
5766 char *z
; /* Accumulated text for a field */
5767 int n
; /* Number of bytes in z */
5768 int nAlloc
; /* Space allocated for z[] */
5769 int nLine
; /* Current line number */
5770 int nRow
; /* Number of rows imported */
5771 int nErr
; /* Number of errors encountered */
5772 int bNotFirst
; /* True if one or more bytes already read */
5773 int cTerm
; /* Character that terminated the most recent field */
5774 int cColSep
; /* The column separator character. (Usually ",") */
5775 int cRowSep
; /* The row separator character. (Usually "\n") */
5778 /* Clean up resourced used by an ImportCtx */
5779 static void import_cleanup(ImportCtx
*p
){
5780 if( p
->in
!=0 && p
->xCloser
!=0 ){
5788 /* Append a single byte to z[] */
5789 static void import_append_char(ImportCtx
*p
, int c
){
5790 if( p
->n
+1>=p
->nAlloc
){
5791 p
->nAlloc
+= p
->nAlloc
+ 100;
5792 p
->z
= sqlite3_realloc64(p
->z
, p
->nAlloc
);
5793 shell_check_oom(p
->z
);
5795 p
->z
[p
->n
++] = (char)c
;
5798 /* Read a single field of CSV text. Compatible with rfc4180 and extended
5799 ** with the option of having a separator other than ",".
5801 ** + Input comes from p->in.
5802 ** + Store results in p->z of length p->n. Space to hold p->z comes
5803 ** from sqlite3_malloc64().
5804 ** + Use p->cSep as the column separator. The default is ",".
5805 ** + Use p->rSep as the row separator. The default is "\n".
5806 ** + Keep track of the line number in p->nLine.
5807 ** + Store the character that terminates the field in p->cTerm. Store
5808 ** EOF on end-of-file.
5809 ** + Report syntax errors on stderr
5811 static char *SQLITE_CDECL
csv_read_one_field(ImportCtx
*p
){
5813 int cSep
= (u8
)p
->cColSep
;
5814 int rSep
= (u8
)p
->cRowSep
;
5817 if( c
==EOF
|| seenInterrupt
){
5823 int startLine
= p
->nLine
;
5828 if( c
==rSep
) p
->nLine
++;
5835 if( (c
==cSep
&& pc
==cQuote
)
5836 || (c
==rSep
&& pc
==cQuote
)
5837 || (c
==rSep
&& pc
=='\r' && ppc
==cQuote
)
5838 || (c
==EOF
&& pc
==cQuote
)
5840 do{ p
->n
--; }while( p
->z
[p
->n
]!=cQuote
);
5844 if( pc
==cQuote
&& c
!='\r' ){
5845 eputf("%s:%d: unescaped %c character\n", p
->zFile
, p
->nLine
, cQuote
);
5848 eputf("%s:%d: unterminated %c-quoted field\n",
5849 p
->zFile
, startLine
, cQuote
);
5853 import_append_char(p
, c
);
5858 /* If this is the first field being parsed and it begins with the
5859 ** UTF-8 BOM (0xEF BB BF) then skip the BOM */
5860 if( (c
&0xff)==0xef && p
->bNotFirst
==0 ){
5861 import_append_char(p
, c
);
5863 if( (c
&0xff)==0xbb ){
5864 import_append_char(p
, c
);
5866 if( (c
&0xff)==0xbf ){
5869 return csv_read_one_field(p
);
5873 while( c
!=EOF
&& c
!=cSep
&& c
!=rSep
){
5874 import_append_char(p
, c
);
5879 if( p
->n
>0 && p
->z
[p
->n
-1]=='\r' ) p
->n
--;
5883 if( p
->z
) p
->z
[p
->n
] = 0;
5888 /* Read a single field of ASCII delimited text.
5890 ** + Input comes from p->in.
5891 ** + Store results in p->z of length p->n. Space to hold p->z comes
5892 ** from sqlite3_malloc64().
5893 ** + Use p->cSep as the column separator. The default is "\x1F".
5894 ** + Use p->rSep as the row separator. The default is "\x1E".
5895 ** + Keep track of the row number in p->nLine.
5896 ** + Store the character that terminates the field in p->cTerm. Store
5897 ** EOF on end-of-file.
5898 ** + Report syntax errors on stderr
5900 static char *SQLITE_CDECL
ascii_read_one_field(ImportCtx
*p
){
5902 int cSep
= (u8
)p
->cColSep
;
5903 int rSep
= (u8
)p
->cRowSep
;
5906 if( c
==EOF
|| seenInterrupt
){
5910 while( c
!=EOF
&& c
!=cSep
&& c
!=rSep
){
5911 import_append_char(p
, c
);
5918 if( p
->z
) p
->z
[p
->n
] = 0;
5923 ** Try to transfer data for table zTable. If an error is seen while
5924 ** moving forward, try to go backwards. The backwards movement won't
5925 ** work for WITHOUT ROWID tables.
5927 static void tryToCloneData(
5932 sqlite3_stmt
*pQuery
= 0;
5933 sqlite3_stmt
*pInsert
= 0;
5938 int nTable
= strlen30(zTable
);
5941 const int spinRate
= 10000;
5943 zQuery
= sqlite3_mprintf("SELECT * FROM \"%w\"", zTable
);
5944 shell_check_oom(zQuery
);
5945 rc
= sqlite3_prepare_v2(p
->db
, zQuery
, -1, &pQuery
, 0);
5947 eputf("Error %d: %s on [%s]\n",
5948 sqlite3_extended_errcode(p
->db
), sqlite3_errmsg(p
->db
), zQuery
);
5951 n
= sqlite3_column_count(pQuery
);
5952 zInsert
= sqlite3_malloc64(200 + nTable
+ n
*3);
5953 shell_check_oom(zInsert
);
5954 sqlite3_snprintf(200+nTable
,zInsert
,
5955 "INSERT OR IGNORE INTO \"%s\" VALUES(?", zTable
);
5956 i
= strlen30(zInsert
);
5958 memcpy(zInsert
+i
, ",?", 2);
5961 memcpy(zInsert
+i
, ");", 3);
5962 rc
= sqlite3_prepare_v2(newDb
, zInsert
, -1, &pInsert
, 0);
5964 eputf("Error %d: %s on [%s]\n",
5965 sqlite3_extended_errcode(newDb
), sqlite3_errmsg(newDb
), zInsert
);
5969 while( (rc
= sqlite3_step(pQuery
))==SQLITE_ROW
){
5971 switch( sqlite3_column_type(pQuery
, i
) ){
5973 sqlite3_bind_null(pInsert
, i
+1);
5976 case SQLITE_INTEGER
: {
5977 sqlite3_bind_int64(pInsert
, i
+1, sqlite3_column_int64(pQuery
,i
));
5980 case SQLITE_FLOAT
: {
5981 sqlite3_bind_double(pInsert
, i
+1, sqlite3_column_double(pQuery
,i
));
5985 sqlite3_bind_text(pInsert
, i
+1,
5986 (const char*)sqlite3_column_text(pQuery
,i
),
5991 sqlite3_bind_blob(pInsert
, i
+1, sqlite3_column_blob(pQuery
,i
),
5992 sqlite3_column_bytes(pQuery
,i
),
5998 rc
= sqlite3_step(pInsert
);
5999 if( rc
!=SQLITE_OK
&& rc
!=SQLITE_ROW
&& rc
!=SQLITE_DONE
){
6000 eputf("Error %d: %s\n",
6001 sqlite3_extended_errcode(newDb
), sqlite3_errmsg(newDb
));
6003 sqlite3_reset(pInsert
);
6005 if( (cnt
%spinRate
)==0 ){
6006 printf("%c\b", "|/-\\"[(cnt
/spinRate
)%4]);
6010 if( rc
==SQLITE_DONE
) break;
6011 sqlite3_finalize(pQuery
);
6012 sqlite3_free(zQuery
);
6013 zQuery
= sqlite3_mprintf("SELECT * FROM \"%w\" ORDER BY rowid DESC;",
6015 shell_check_oom(zQuery
);
6016 rc
= sqlite3_prepare_v2(p
->db
, zQuery
, -1, &pQuery
, 0);
6018 eputf("Warning: cannot step \"%s\" backwards", zTable
);
6021 } /* End for(k=0...) */
6024 sqlite3_finalize(pQuery
);
6025 sqlite3_finalize(pInsert
);
6026 sqlite3_free(zQuery
);
6027 sqlite3_free(zInsert
);
6032 ** Try to transfer all rows of the schema that match zWhere. For
6033 ** each row, invoke xForEach() on the object defined by that row.
6034 ** If an error is encountered while moving forward through the
6035 ** sqlite_schema table, try again moving backwards.
6037 static void tryToCloneSchema(
6041 void (*xForEach
)(ShellState
*,sqlite3
*,const char*)
6043 sqlite3_stmt
*pQuery
= 0;
6046 const unsigned char *zName
;
6047 const unsigned char *zSql
;
6050 zQuery
= sqlite3_mprintf("SELECT name, sql FROM sqlite_schema"
6051 " WHERE %s ORDER BY rowid ASC", zWhere
);
6052 shell_check_oom(zQuery
);
6053 rc
= sqlite3_prepare_v2(p
->db
, zQuery
, -1, &pQuery
, 0);
6055 eputf("Error: (%d) %s on [%s]\n", sqlite3_extended_errcode(p
->db
),
6056 sqlite3_errmsg(p
->db
), zQuery
);
6057 goto end_schema_xfer
;
6059 while( (rc
= sqlite3_step(pQuery
))==SQLITE_ROW
){
6060 zName
= sqlite3_column_text(pQuery
, 0);
6061 zSql
= sqlite3_column_text(pQuery
, 1);
6062 if( zName
==0 || zSql
==0 ) continue;
6063 if( sqlite3_stricmp((char*)zName
, "sqlite_sequence")!=0 ){
6064 sputf(stdout
, "%s... ", zName
); fflush(stdout
);
6065 sqlite3_exec(newDb
, (const char*)zSql
, 0, 0, &zErrMsg
);
6067 eputf("Error: %s\nSQL: [%s]\n", zErrMsg
, zSql
);
6068 sqlite3_free(zErrMsg
);
6073 xForEach(p
, newDb
, (const char*)zName
);
6075 sputz(stdout
, "done\n");
6077 if( rc
!=SQLITE_DONE
){
6078 sqlite3_finalize(pQuery
);
6079 sqlite3_free(zQuery
);
6080 zQuery
= sqlite3_mprintf("SELECT name, sql FROM sqlite_schema"
6081 " WHERE %s ORDER BY rowid DESC", zWhere
);
6082 shell_check_oom(zQuery
);
6083 rc
= sqlite3_prepare_v2(p
->db
, zQuery
, -1, &pQuery
, 0);
6085 eputf("Error: (%d) %s on [%s]\n",
6086 sqlite3_extended_errcode(p
->db
), sqlite3_errmsg(p
->db
), zQuery
);
6087 goto end_schema_xfer
;
6089 while( sqlite3_step(pQuery
)==SQLITE_ROW
){
6090 zName
= sqlite3_column_text(pQuery
, 0);
6091 zSql
= sqlite3_column_text(pQuery
, 1);
6092 if( zName
==0 || zSql
==0 ) continue;
6093 if( sqlite3_stricmp((char*)zName
, "sqlite_sequence")==0 ) continue;
6094 sputf(stdout
, "%s... ", zName
); fflush(stdout
);
6095 sqlite3_exec(newDb
, (const char*)zSql
, 0, 0, &zErrMsg
);
6097 eputf("Error: %s\nSQL: [%s]\n", zErrMsg
, zSql
);
6098 sqlite3_free(zErrMsg
);
6102 xForEach(p
, newDb
, (const char*)zName
);
6104 sputz(stdout
, "done\n");
6108 sqlite3_finalize(pQuery
);
6109 sqlite3_free(zQuery
);
6113 ** Open a new database file named "zNewDb". Try to recover as much information
6114 ** as possible out of the main database (which might be corrupt) and write it
6117 static void tryToClone(ShellState
*p
, const char *zNewDb
){
6120 if( access(zNewDb
,0)==0 ){
6121 eputf("File \"%s\" already exists.\n", zNewDb
);
6124 rc
= sqlite3_open(zNewDb
, &newDb
);
6126 eputf("Cannot create output database: %s\n", sqlite3_errmsg(newDb
));
6128 sqlite3_exec(p
->db
, "PRAGMA writable_schema=ON;", 0, 0, 0);
6129 sqlite3_exec(newDb
, "BEGIN EXCLUSIVE;", 0, 0, 0);
6130 tryToCloneSchema(p
, newDb
, "type='table'", tryToCloneData
);
6131 tryToCloneSchema(p
, newDb
, "type!='table'", 0);
6132 sqlite3_exec(newDb
, "COMMIT;", 0, 0, 0);
6133 sqlite3_exec(p
->db
, "PRAGMA writable_schema=OFF;", 0, 0, 0);
6138 #ifndef SQLITE_SHELL_FIDDLE
6140 ** Change the output stream (file or pipe or console) to something else.
6142 static void output_redir(ShellState
*p
, FILE *pfNew
){
6143 if( p
->out
!= stdout
) eputz("Output already redirected.\n");
6146 setOutputStream(pfNew
);
6151 ** Change the output file back to stdout.
6153 ** If the p->doXdgOpen flag is set, that means the output was being
6154 ** redirected to a temporary file named by p->zTempFile. In that case,
6155 ** launch start/open/xdg-open on that temporary file.
6157 static void output_reset(ShellState
*p
){
6158 if( p
->outfile
[0]=='|' ){
6159 #ifndef SQLITE_OMIT_POPEN
6163 output_file_close(p
->out
);
6164 #ifndef SQLITE_NOHAVE_SYSTEM
6166 const char *zXdgOpenCmd
=
6169 #elif defined(__APPLE__)
6175 zCmd
= sqlite3_mprintf("%s %s", zXdgOpenCmd
, p
->zTempFile
);
6177 eputf("Failed: [%s]\n", zCmd
);
6179 /* Give the start/open/xdg-open command some time to get
6180 ** going before we continue, and potential delete the
6181 ** p->zTempFile data file out from under it */
6182 sqlite3_sleep(2000);
6188 #endif /* !defined(SQLITE_NOHAVE_SYSTEM) */
6192 setOutputStream(stdout
);
6195 # define output_redir(SS,pfO)
6196 # define output_reset(SS)
6200 ** Run an SQL command and return the single integer result.
6202 static int db_int(sqlite3
*db
, const char *zSql
){
6203 sqlite3_stmt
*pStmt
;
6205 sqlite3_prepare_v2(db
, zSql
, -1, &pStmt
, 0);
6206 if( pStmt
&& sqlite3_step(pStmt
)==SQLITE_ROW
){
6207 res
= sqlite3_column_int(pStmt
,0);
6209 sqlite3_finalize(pStmt
);
6213 #if SQLITE_SHELL_HAVE_RECOVER
6215 ** Convert a 2-byte or 4-byte big-endian integer into a native integer
6217 static unsigned int get2byteInt(unsigned char *a
){
6218 return (a
[0]<<8) + a
[1];
6220 static unsigned int get4byteInt(unsigned char *a
){
6221 return (a
[0]<<24) + (a
[1]<<16) + (a
[2]<<8) + a
[3];
6225 ** Implementation of the ".dbinfo" command.
6227 ** Return 1 on error, 2 to exit, and 0 otherwise.
6229 static int shell_dbinfo_command(ShellState
*p
, int nArg
, char **azArg
){
6230 static const struct { const char *zName
; int ofst
; } aField
[] = {
6231 { "file change counter:", 24 },
6232 { "database page count:", 28 },
6233 { "freelist page count:", 36 },
6234 { "schema cookie:", 40 },
6235 { "schema format:", 44 },
6236 { "default cache size:", 48 },
6237 { "autovacuum top root:", 52 },
6238 { "incremental vacuum:", 64 },
6239 { "text encoding:", 56 },
6240 { "user version:", 60 },
6241 { "application id:", 68 },
6242 { "software version:", 96 },
6244 static const struct { const char *zName
; const char *zSql
; } aQuery
[] = {
6245 { "number of tables:",
6246 "SELECT count(*) FROM %s WHERE type='table'" },
6247 { "number of indexes:",
6248 "SELECT count(*) FROM %s WHERE type='index'" },
6249 { "number of triggers:",
6250 "SELECT count(*) FROM %s WHERE type='trigger'" },
6251 { "number of views:",
6252 "SELECT count(*) FROM %s WHERE type='view'" },
6254 "SELECT total(length(sql)) FROM %s" },
6257 unsigned iDataVersion
;
6259 char *zDb
= nArg
>=2 ? azArg
[1] : "main";
6260 sqlite3_stmt
*pStmt
= 0;
6261 unsigned char aHdr
[100];
6263 if( p
->db
==0 ) return 1;
6264 rc
= sqlite3_prepare_v2(p
->db
,
6265 "SELECT data FROM sqlite_dbpage(?1) WHERE pgno=1",
6268 eputf("error: %s\n", sqlite3_errmsg(p
->db
));
6269 sqlite3_finalize(pStmt
);
6272 sqlite3_bind_text(pStmt
, 1, zDb
, -1, SQLITE_STATIC
);
6273 if( sqlite3_step(pStmt
)==SQLITE_ROW
6274 && sqlite3_column_bytes(pStmt
,0)>100
6276 const u8
*pb
= sqlite3_column_blob(pStmt
,0);
6277 shell_check_oom(pb
);
6278 memcpy(aHdr
, pb
, 100);
6279 sqlite3_finalize(pStmt
);
6281 eputz("unable to read database header\n");
6282 sqlite3_finalize(pStmt
);
6285 i
= get2byteInt(aHdr
+16);
6286 if( i
==1 ) i
= 65536;
6287 oputf("%-20s %d\n", "database page size:", i
);
6288 oputf("%-20s %d\n", "write format:", aHdr
[18]);
6289 oputf("%-20s %d\n", "read format:", aHdr
[19]);
6290 oputf("%-20s %d\n", "reserved bytes:", aHdr
[20]);
6291 for(i
=0; i
<ArraySize(aField
); i
++){
6292 int ofst
= aField
[i
].ofst
;
6293 unsigned int val
= get4byteInt(aHdr
+ ofst
);
6294 oputf("%-20s %u", aField
[i
].zName
, val
);
6297 if( val
==1 ) oputz(" (utf8)");
6298 if( val
==2 ) oputz(" (utf16le)");
6299 if( val
==3 ) oputz(" (utf16be)");
6305 zSchemaTab
= sqlite3_mprintf("main.sqlite_schema");
6306 }else if( cli_strcmp(zDb
,"temp")==0 ){
6307 zSchemaTab
= sqlite3_mprintf("%s", "sqlite_temp_schema");
6309 zSchemaTab
= sqlite3_mprintf("\"%w\".sqlite_schema", zDb
);
6311 for(i
=0; i
<ArraySize(aQuery
); i
++){
6312 char *zSql
= sqlite3_mprintf(aQuery
[i
].zSql
, zSchemaTab
);
6313 int val
= db_int(p
->db
, zSql
);
6315 oputf("%-20s %d\n", aQuery
[i
].zName
, val
);
6317 sqlite3_free(zSchemaTab
);
6318 sqlite3_file_control(p
->db
, zDb
, SQLITE_FCNTL_DATA_VERSION
, &iDataVersion
);
6319 oputf("%-20s %u\n", "data version", iDataVersion
);
6322 #endif /* SQLITE_SHELL_HAVE_RECOVER */
6325 ** Print the current sqlite3_errmsg() value to stderr and return 1.
6327 static int shellDatabaseError(sqlite3
*db
){
6328 const char *zErr
= sqlite3_errmsg(db
);
6329 eputf("Error: %s\n", zErr
);
6334 ** Compare the pattern in zGlob[] against the text in z[]. Return TRUE
6335 ** if they match and FALSE (0) if they do not match.
6339 ** '*' Matches any sequence of zero or more characters.
6341 ** '?' Matches exactly one character.
6343 ** [...] Matches one character from the enclosed list of
6346 ** [^...] Matches one character not in the enclosed list.
6348 ** '#' Matches any sequence of one or more digits with an
6349 ** optional + or - sign in front
6351 ** ' ' Any span of whitespace matches any other span of
6354 ** Extra whitespace at the end of z[] is ignored.
6356 static int testcase_glob(const char *zGlob
, const char *z
){
6361 while( (c
= (*(zGlob
++)))!=0 ){
6363 if( !IsSpace(*z
) ) return 0;
6364 while( IsSpace(*zGlob
) ) zGlob
++;
6365 while( IsSpace(*z
) ) z
++;
6367 while( (c
=(*(zGlob
++))) == '*' || c
=='?' ){
6368 if( c
=='?' && (*(z
++))==0 ) return 0;
6373 while( *z
&& testcase_glob(zGlob
-1,z
)==0 ){
6378 while( (c2
= (*(z
++)))!=0 ){
6381 if( c2
==0 ) return 0;
6383 if( testcase_glob(zGlob
,z
) ) return 1;
6387 if( (*(z
++))==0 ) return 0;
6393 if( c
==0 ) return 0;
6400 if( c
==']' ) seen
= 1;
6403 while( c2
&& c2
!=']' ){
6404 if( c2
=='-' && zGlob
[0]!=']' && zGlob
[0]!=0 && prior_c
>0 ){
6406 if( c
>=prior_c
&& c
<=c2
) seen
= 1;
6416 if( c2
==0 || (seen
^ invert
)==0 ) return 0;
6418 if( (z
[0]=='-' || z
[0]=='+') && IsDigit(z
[1]) ) z
++;
6419 if( !IsDigit(z
[0]) ) return 0;
6421 while( IsDigit(z
[0]) ){ z
++; }
6423 if( c
!=(*(z
++)) ) return 0;
6426 while( IsSpace(*z
) ){ z
++; }
6432 ** Compare the string as a command-line option with either one or two
6433 ** initial "-" characters.
6435 static int optionMatch(const char *zStr
, const char *zOpt
){
6436 if( zStr
[0]!='-' ) return 0;
6438 if( zStr
[0]=='-' ) zStr
++;
6439 return cli_strcmp(zStr
, zOpt
)==0;
6445 int shellDeleteFile(const char *zFilename
){
6448 wchar_t *z
= sqlite3_win32_utf8_to_unicode(zFilename
);
6452 rc
= unlink(zFilename
);
6458 ** Try to delete the temporary file (if there is one) and free the
6459 ** memory used to hold the name of the temp file.
6461 static void clearTempFile(ShellState
*p
){
6462 if( p
->zTempFile
==0 ) return;
6463 if( p
->doXdgOpen
) return;
6464 if( shellDeleteFile(p
->zTempFile
) ) return;
6465 sqlite3_free(p
->zTempFile
);
6470 ** Create a new temp file name with the given suffix.
6472 static void newTempFile(ShellState
*p
, const char *zSuffix
){
6474 sqlite3_free(p
->zTempFile
);
6477 sqlite3_file_control(p
->db
, 0, SQLITE_FCNTL_TEMPFILENAME
, &p
->zTempFile
);
6479 if( p
->zTempFile
==0 ){
6480 /* If p->db is an in-memory database then the TEMPFILENAME file-control
6481 ** will not work and we will need to fallback to guessing */
6484 sqlite3_randomness(sizeof(r
), &r
);
6485 zTemp
= getenv("TEMP");
6486 if( zTemp
==0 ) zTemp
= getenv("TMP");
6494 p
->zTempFile
= sqlite3_mprintf("%s/temp%llx.%s", zTemp
, r
, zSuffix
);
6496 p
->zTempFile
= sqlite3_mprintf("%z.%s", p
->zTempFile
, zSuffix
);
6498 shell_check_oom(p
->zTempFile
);
6503 ** The implementation of SQL scalar function fkey_collate_clause(), used
6504 ** by the ".lint fkey-indexes" command. This scalar function is always
6505 ** called with four arguments - the parent table name, the parent column name,
6506 ** the child table name and the child column name.
6508 ** fkey_collate_clause('parent-tab', 'parent-col', 'child-tab', 'child-col')
6510 ** If either of the named tables or columns do not exist, this function
6511 ** returns an empty string. An empty string is also returned if both tables
6512 ** and columns exist but have the same default collation sequence. Or,
6513 ** if both exist but the default collation sequences are different, this
6514 ** function returns the string " COLLATE <parent-collation>", where
6515 ** <parent-collation> is the default collation sequence of the parent column.
6517 static void shellFkeyCollateClause(
6518 sqlite3_context
*pCtx
,
6520 sqlite3_value
**apVal
6522 sqlite3
*db
= sqlite3_context_db_handle(pCtx
);
6523 const char *zParent
;
6524 const char *zParentCol
;
6525 const char *zParentSeq
;
6527 const char *zChildCol
;
6528 const char *zChildSeq
= 0; /* Initialize to avoid false-positive warning */
6532 zParent
= (const char*)sqlite3_value_text(apVal
[0]);
6533 zParentCol
= (const char*)sqlite3_value_text(apVal
[1]);
6534 zChild
= (const char*)sqlite3_value_text(apVal
[2]);
6535 zChildCol
= (const char*)sqlite3_value_text(apVal
[3]);
6537 sqlite3_result_text(pCtx
, "", -1, SQLITE_STATIC
);
6538 rc
= sqlite3_table_column_metadata(
6539 db
, "main", zParent
, zParentCol
, 0, &zParentSeq
, 0, 0, 0
6541 if( rc
==SQLITE_OK
){
6542 rc
= sqlite3_table_column_metadata(
6543 db
, "main", zChild
, zChildCol
, 0, &zChildSeq
, 0, 0, 0
6547 if( rc
==SQLITE_OK
&& sqlite3_stricmp(zParentSeq
, zChildSeq
) ){
6548 char *z
= sqlite3_mprintf(" COLLATE %s", zParentSeq
);
6549 sqlite3_result_text(pCtx
, z
, -1, SQLITE_TRANSIENT
);
6556 ** The implementation of dot-command ".lint fkey-indexes".
6558 static int lintFkeyIndexes(
6559 ShellState
*pState
, /* Current shell tool state */
6560 char **azArg
, /* Array of arguments passed to dot command */
6561 int nArg
/* Number of entries in azArg[] */
6563 sqlite3
*db
= pState
->db
; /* Database handle to query "main" db of */
6564 int bVerbose
= 0; /* If -verbose is present */
6565 int bGroupByParent
= 0; /* If -groupbyparent is present */
6566 int i
; /* To iterate through azArg[] */
6567 const char *zIndent
= ""; /* How much to indent CREATE INDEX by */
6568 int rc
; /* Return code */
6569 sqlite3_stmt
*pSql
= 0; /* Compiled version of SQL statement below */
6572 ** This SELECT statement returns one row for each foreign key constraint
6573 ** in the schema of the main database. The column values are:
6575 ** 0. The text of an SQL statement similar to:
6577 ** "EXPLAIN QUERY PLAN SELECT 1 FROM child_table WHERE child_key=?"
6579 ** This SELECT is similar to the one that the foreign keys implementation
6580 ** needs to run internally on child tables. If there is an index that can
6581 ** be used to optimize this query, then it can also be used by the FK
6582 ** implementation to optimize DELETE or UPDATE statements on the parent
6585 ** 1. A GLOB pattern suitable for sqlite3_strglob(). If the plan output by
6586 ** the EXPLAIN QUERY PLAN command matches this pattern, then the schema
6587 ** contains an index that can be used to optimize the query.
6589 ** 2. Human readable text that describes the child table and columns. e.g.
6591 ** "child_table(child_key1, child_key2)"
6593 ** 3. Human readable text that describes the parent table and columns. e.g.
6595 ** "parent_table(parent_key1, parent_key2)"
6597 ** 4. A full CREATE INDEX statement for an index that could be used to
6598 ** optimize DELETE or UPDATE statements on the parent table. e.g.
6600 ** "CREATE INDEX child_table_child_key ON child_table(child_key)"
6602 ** 5. The name of the parent table.
6604 ** These six values are used by the C logic below to generate the report.
6608 " 'EXPLAIN QUERY PLAN SELECT 1 FROM ' || quote(s.name) || ' WHERE '"
6609 " || group_concat(quote(s.name) || '.' || quote(f.[from]) || '=?' "
6610 " || fkey_collate_clause("
6611 " f.[table], COALESCE(f.[to], p.[name]), s.name, f.[from]),' AND ')"
6613 " 'SEARCH ' || s.name || ' USING COVERING INDEX*('"
6614 " || group_concat('*=?', ' AND ') || ')'"
6616 " s.name || '(' || group_concat(f.[from], ', ') || ')'"
6618 " f.[table] || '(' || group_concat(COALESCE(f.[to], p.[name])) || ')'"
6620 " 'CREATE INDEX ' || quote(s.name ||'_'|| group_concat(f.[from], '_'))"
6621 " || ' ON ' || quote(s.name) || '('"
6622 " || group_concat(quote(f.[from]) ||"
6623 " fkey_collate_clause("
6624 " f.[table], COALESCE(f.[to], p.[name]), s.name, f.[from]), ', ')"
6628 "FROM sqlite_schema AS s, pragma_foreign_key_list(s.name) AS f "
6629 "LEFT JOIN pragma_table_info AS p ON (pk-1=seq AND p.arg=f.[table]) "
6630 "GROUP BY s.name, f.id "
6631 "ORDER BY (CASE WHEN ? THEN f.[table] ELSE s.name END)"
6633 const char *zGlobIPK
= "SEARCH * USING INTEGER PRIMARY KEY (rowid=?)";
6635 for(i
=2; i
<nArg
; i
++){
6636 int n
= strlen30(azArg
[i
]);
6637 if( n
>1 && sqlite3_strnicmp("-verbose", azArg
[i
], n
)==0 ){
6640 else if( n
>1 && sqlite3_strnicmp("-groupbyparent", azArg
[i
], n
)==0 ){
6645 eputf("Usage: %s %s ?-verbose? ?-groupbyparent?\n", azArg
[0], azArg
[1]);
6646 return SQLITE_ERROR
;
6650 /* Register the fkey_collate_clause() SQL function */
6651 rc
= sqlite3_create_function(db
, "fkey_collate_clause", 4, SQLITE_UTF8
,
6652 0, shellFkeyCollateClause
, 0, 0
6656 if( rc
==SQLITE_OK
){
6657 rc
= sqlite3_prepare_v2(db
, zSql
, -1, &pSql
, 0);
6659 if( rc
==SQLITE_OK
){
6660 sqlite3_bind_int(pSql
, 1, bGroupByParent
);
6663 if( rc
==SQLITE_OK
){
6666 while( SQLITE_ROW
==sqlite3_step(pSql
) ){
6668 sqlite3_stmt
*pExplain
= 0;
6669 const char *zEQP
= (const char*)sqlite3_column_text(pSql
, 0);
6670 const char *zGlob
= (const char*)sqlite3_column_text(pSql
, 1);
6671 const char *zFrom
= (const char*)sqlite3_column_text(pSql
, 2);
6672 const char *zTarget
= (const char*)sqlite3_column_text(pSql
, 3);
6673 const char *zCI
= (const char*)sqlite3_column_text(pSql
, 4);
6674 const char *zParent
= (const char*)sqlite3_column_text(pSql
, 5);
6676 if( zEQP
==0 ) continue;
6677 if( zGlob
==0 ) continue;
6678 rc
= sqlite3_prepare_v2(db
, zEQP
, -1, &pExplain
, 0);
6679 if( rc
!=SQLITE_OK
) break;
6680 if( SQLITE_ROW
==sqlite3_step(pExplain
) ){
6681 const char *zPlan
= (const char*)sqlite3_column_text(pExplain
, 3);
6682 res
= zPlan
!=0 && ( 0==sqlite3_strglob(zGlob
, zPlan
)
6683 || 0==sqlite3_strglob(zGlobIPK
, zPlan
));
6685 rc
= sqlite3_finalize(pExplain
);
6686 if( rc
!=SQLITE_OK
) break;
6689 eputz("Error: internal error");
6693 && (bVerbose
|| res
==0)
6694 && (zPrev
==0 || sqlite3_stricmp(zParent
, zPrev
))
6696 oputf("-- Parent table %s\n", zParent
);
6697 sqlite3_free(zPrev
);
6698 zPrev
= sqlite3_mprintf("%s", zParent
);
6702 oputf("%s%s --> %s\n", zIndent
, zCI
, zTarget
);
6703 }else if( bVerbose
){
6704 oputf("%s/* no extra indexes required for %s -> %s */\n",
6705 zIndent
, zFrom
, zTarget
6710 sqlite3_free(zPrev
);
6712 if( rc
!=SQLITE_OK
){
6713 eputf("%s\n", sqlite3_errmsg(db
));
6716 rc2
= sqlite3_finalize(pSql
);
6717 if( rc
==SQLITE_OK
&& rc2
!=SQLITE_OK
){
6719 eputf("%s\n", sqlite3_errmsg(db
));
6722 eputf("%s\n", sqlite3_errmsg(db
));
6729 ** Implementation of ".lint" dot command.
6731 static int lintDotCommand(
6732 ShellState
*pState
, /* Current shell tool state */
6733 char **azArg
, /* Array of arguments passed to dot command */
6734 int nArg
/* Number of entries in azArg[] */
6737 n
= (nArg
>=2 ? strlen30(azArg
[1]) : 0);
6738 if( n
<1 || sqlite3_strnicmp(azArg
[1], "fkey-indexes", n
) ) goto usage
;
6739 return lintFkeyIndexes(pState
, azArg
, nArg
);
6742 eputf("Usage %s sub-command ?switches...?\n", azArg
[0]);
6743 eputz("Where sub-commands are:\n");
6744 eputz(" fkey-indexes\n");
6745 return SQLITE_ERROR
;
6748 static void shellPrepare(
6752 sqlite3_stmt
**ppStmt
6755 if( *pRc
==SQLITE_OK
){
6756 int rc
= sqlite3_prepare_v2(db
, zSql
, -1, ppStmt
, 0);
6757 if( rc
!=SQLITE_OK
){
6758 eputf("sql error: %s (%d)\n", sqlite3_errmsg(db
), sqlite3_errcode(db
));
6765 ** Create a prepared statement using printf-style arguments for the SQL.
6767 static void shellPreparePrintf(
6770 sqlite3_stmt
**ppStmt
,
6775 if( *pRc
==SQLITE_OK
){
6779 z
= sqlite3_vmprintf(zFmt
, ap
);
6782 *pRc
= SQLITE_NOMEM
;
6784 shellPrepare(db
, pRc
, z
, ppStmt
);
6791 ** Finalize the prepared statement created using shellPreparePrintf().
6793 static void shellFinalize(
6798 sqlite3
*db
= sqlite3_db_handle(pStmt
);
6799 int rc
= sqlite3_finalize(pStmt
);
6800 if( *pRc
==SQLITE_OK
){
6801 if( rc
!=SQLITE_OK
){
6802 eputf("SQL error: %s\n", sqlite3_errmsg(db
));
6809 #if !defined SQLITE_OMIT_VIRTUALTABLE
6810 /* Reset the prepared statement created using shellPreparePrintf().
6812 ** This routine is could be marked "static". But it is not always used,
6813 ** depending on compile-time options. By omitting the "static", we avoid
6814 ** nuisance compiler warnings about "defined but not used".
6820 int rc
= sqlite3_reset(pStmt
);
6821 if( *pRc
==SQLITE_OK
){
6822 if( rc
!=SQLITE_OK
){
6823 sqlite3
*db
= sqlite3_db_handle(pStmt
);
6824 eputf("SQL error: %s\n", sqlite3_errmsg(db
));
6829 #endif /* !defined SQLITE_OMIT_VIRTUALTABLE */
6831 #if !defined(SQLITE_OMIT_VIRTUALTABLE) && defined(SQLITE_HAVE_ZLIB)
6832 /******************************************************************************
6833 ** The ".archive" or ".ar" command.
6836 ** Structure representing a single ".ar" command.
6838 typedef struct ArCommand ArCommand
;
6840 u8 eCmd
; /* An AR_CMD_* value */
6841 u8 bVerbose
; /* True if --verbose */
6842 u8 bZip
; /* True if the archive is a ZIP */
6843 u8 bDryRun
; /* True if --dry-run */
6844 u8 bAppend
; /* True if --append */
6845 u8 bGlob
; /* True if --glob */
6846 u8 fromCmdLine
; /* Run from -A instead of .archive */
6847 int nArg
; /* Number of command arguments */
6848 char *zSrcTable
; /* "sqlar", "zipfile($file)" or "zip" */
6849 const char *zFile
; /* --file argument, or NULL */
6850 const char *zDir
; /* --directory argument, or NULL */
6851 char **azArg
; /* Array of command arguments */
6852 ShellState
*p
; /* Shell state */
6853 sqlite3
*db
; /* Database containing the archive */
6857 ** Print a usage message for the .ar command to stderr and return SQLITE_ERROR.
6859 static int arUsage(FILE *f
){
6860 showHelp(f
,"archive");
6861 return SQLITE_ERROR
;
6865 ** Print an error message for the .ar command to stderr and return
6868 static int arErrorMsg(ArCommand
*pAr
, const char *zFmt
, ...){
6872 z
= sqlite3_vmprintf(zFmt
, ap
);
6874 eputf("Error: %s\n", z
);
6875 if( pAr
->fromCmdLine
){
6876 eputz("Use \"-A\" for more help\n");
6878 eputz("Use \".archive --help\" for more help\n");
6881 return SQLITE_ERROR
;
6885 ** Values for ArCommand.eCmd.
6887 #define AR_CMD_CREATE 1
6888 #define AR_CMD_UPDATE 2
6889 #define AR_CMD_INSERT 3
6890 #define AR_CMD_EXTRACT 4
6891 #define AR_CMD_LIST 5
6892 #define AR_CMD_HELP 6
6893 #define AR_CMD_REMOVE 7
6896 ** Other (non-command) switches.
6898 #define AR_SWITCH_VERBOSE 8
6899 #define AR_SWITCH_FILE 9
6900 #define AR_SWITCH_DIRECTORY 10
6901 #define AR_SWITCH_APPEND 11
6902 #define AR_SWITCH_DRYRUN 12
6903 #define AR_SWITCH_GLOB 13
6905 static int arProcessSwitch(ArCommand
*pAr
, int eSwitch
, const char *zArg
){
6908 case AR_CMD_EXTRACT
:
6915 return arErrorMsg(pAr
, "multiple command options");
6917 pAr
->eCmd
= eSwitch
;
6920 case AR_SWITCH_DRYRUN
:
6923 case AR_SWITCH_GLOB
:
6926 case AR_SWITCH_VERBOSE
:
6929 case AR_SWITCH_APPEND
:
6931 deliberate_fall_through
;
6932 case AR_SWITCH_FILE
:
6935 case AR_SWITCH_DIRECTORY
:
6944 ** Parse the command line for an ".ar" command. The results are written into
6945 ** structure (*pAr). SQLITE_OK is returned if the command line is parsed
6946 ** successfully, otherwise an error message is written to stderr and
6947 ** SQLITE_ERROR returned.
6949 static int arParseCommand(
6950 char **azArg
, /* Array of arguments passed to dot command */
6951 int nArg
, /* Number of entries in azArg[] */
6952 ArCommand
*pAr
/* Populate this object */
6960 { "create", 'c', AR_CMD_CREATE
, 0 },
6961 { "extract", 'x', AR_CMD_EXTRACT
, 0 },
6962 { "insert", 'i', AR_CMD_INSERT
, 0 },
6963 { "list", 't', AR_CMD_LIST
, 0 },
6964 { "remove", 'r', AR_CMD_REMOVE
, 0 },
6965 { "update", 'u', AR_CMD_UPDATE
, 0 },
6966 { "help", 'h', AR_CMD_HELP
, 0 },
6967 { "verbose", 'v', AR_SWITCH_VERBOSE
, 0 },
6968 { "file", 'f', AR_SWITCH_FILE
, 1 },
6969 { "append", 'a', AR_SWITCH_APPEND
, 1 },
6970 { "directory", 'C', AR_SWITCH_DIRECTORY
, 1 },
6971 { "dryrun", 'n', AR_SWITCH_DRYRUN
, 0 },
6972 { "glob", 'g', AR_SWITCH_GLOB
, 0 },
6974 int nSwitch
= sizeof(aSwitch
) / sizeof(struct ArSwitch
);
6975 struct ArSwitch
*pEnd
= &aSwitch
[nSwitch
];
6978 eputz("Wrong number of arguments. Usage:\n");
6979 return arUsage(stderr
);
6983 /* Traditional style [tar] invocation */
6986 for(i
=0; z
[i
]; i
++){
6987 const char *zArg
= 0;
6988 struct ArSwitch
*pOpt
;
6989 for(pOpt
=&aSwitch
[0]; pOpt
<pEnd
; pOpt
++){
6990 if( z
[i
]==pOpt
->cShort
) break;
6993 return arErrorMsg(pAr
, "unrecognized option: %c", z
[i
]);
6997 return arErrorMsg(pAr
, "option requires an argument: %c",z
[i
]);
6999 zArg
= azArg
[iArg
++];
7001 if( arProcessSwitch(pAr
, pOpt
->eSwitch
, zArg
) ) return SQLITE_ERROR
;
7003 pAr
->nArg
= nArg
-iArg
;
7005 pAr
->azArg
= &azArg
[iArg
];
7008 /* Non-traditional invocation */
7010 for(iArg
=1; iArg
<nArg
; iArg
++){
7014 /* All remaining command line words are command arguments. */
7015 pAr
->azArg
= &azArg
[iArg
];
7016 pAr
->nArg
= nArg
-iArg
;
7023 /* One or more short options */
7025 const char *zArg
= 0;
7026 struct ArSwitch
*pOpt
;
7027 for(pOpt
=&aSwitch
[0]; pOpt
<pEnd
; pOpt
++){
7028 if( z
[i
]==pOpt
->cShort
) break;
7031 return arErrorMsg(pAr
, "unrecognized option: %c", z
[i
]);
7038 if( iArg
>=(nArg
-1) ){
7039 return arErrorMsg(pAr
, "option requires an argument: %c",
7042 zArg
= azArg
[++iArg
];
7045 if( arProcessSwitch(pAr
, pOpt
->eSwitch
, zArg
) ) return SQLITE_ERROR
;
7047 }else if( z
[2]=='\0' ){
7048 /* A -- option, indicating that all remaining command line words
7049 ** are command arguments. */
7050 pAr
->azArg
= &azArg
[iArg
+1];
7051 pAr
->nArg
= nArg
-iArg
-1;
7055 const char *zArg
= 0; /* Argument for option, if any */
7056 struct ArSwitch
*pMatch
= 0; /* Matching option */
7057 struct ArSwitch
*pOpt
; /* Iterator */
7058 for(pOpt
=&aSwitch
[0]; pOpt
<pEnd
; pOpt
++){
7059 const char *zLong
= pOpt
->zLong
;
7060 if( (n
-2)<=strlen30(zLong
) && 0==memcmp(&z
[2], zLong
, n
-2) ){
7062 return arErrorMsg(pAr
, "ambiguous option: %s",z
);
7070 return arErrorMsg(pAr
, "unrecognized option: %s", z
);
7073 if( iArg
>=(nArg
-1) ){
7074 return arErrorMsg(pAr
, "option requires an argument: %s", z
);
7076 zArg
= azArg
[++iArg
];
7078 if( arProcessSwitch(pAr
, pMatch
->eSwitch
, zArg
) ) return SQLITE_ERROR
;
7084 eputz("Required argument missing. Usage:\n");
7085 return arUsage(stderr
);
7091 ** This function assumes that all arguments within the ArCommand.azArg[]
7092 ** array refer to archive members, as for the --extract, --list or --remove
7093 ** commands. It checks that each of them are "present". If any specified
7094 ** file is not present in the archive, an error is printed to stderr and an
7095 ** error code returned. Otherwise, if all specified arguments are present
7096 ** in the archive, SQLITE_OK is returned. Here, "present" means either an
7097 ** exact equality when pAr->bGlob is false or a "name GLOB pattern" match
7098 ** when pAr->bGlob is true.
7100 ** This function strips any trailing '/' characters from each argument.
7101 ** This is consistent with the way the [tar] command seems to work on
7104 static int arCheckEntries(ArCommand
*pAr
){
7108 sqlite3_stmt
*pTest
= 0;
7109 const char *zSel
= (pAr
->bGlob
)
7110 ? "SELECT name FROM %s WHERE glob($name,name)"
7111 : "SELECT name FROM %s WHERE name=$name";
7113 shellPreparePrintf(pAr
->db
, &rc
, &pTest
, zSel
, pAr
->zSrcTable
);
7114 j
= sqlite3_bind_parameter_index(pTest
, "$name");
7115 for(i
=0; i
<pAr
->nArg
&& rc
==SQLITE_OK
; i
++){
7116 char *z
= pAr
->azArg
[i
];
7117 int n
= strlen30(z
);
7119 while( n
>0 && z
[n
-1]=='/' ) n
--;
7121 sqlite3_bind_text(pTest
, j
, z
, -1, SQLITE_STATIC
);
7122 if( SQLITE_ROW
==sqlite3_step(pTest
) ){
7125 shellReset(&rc
, pTest
);
7126 if( rc
==SQLITE_OK
&& bOk
==0 ){
7127 eputf("not found in archive: %s\n", z
);
7131 shellFinalize(&rc
, pTest
);
7137 ** Format a WHERE clause that can be used against the "sqlar" table to
7138 ** identify all archive members that match the command arguments held
7139 ** in (*pAr). Leave this WHERE clause in (*pzWhere) before returning.
7140 ** The caller is responsible for eventually calling sqlite3_free() on
7141 ** any non-NULL (*pzWhere) value. Here, "match" means strict equality
7142 ** when pAr->bGlob is false and GLOB match when pAr->bGlob is true.
7144 static void arWhereClause(
7147 char **pzWhere
/* OUT: New WHERE clause */
7150 const char *zSameOp
= (pAr
->bGlob
)? "GLOB" : "=";
7151 if( *pRc
==SQLITE_OK
){
7153 zWhere
= sqlite3_mprintf("1");
7156 const char *zSep
= "";
7157 for(i
=0; i
<pAr
->nArg
; i
++){
7158 const char *z
= pAr
->azArg
[i
];
7159 zWhere
= sqlite3_mprintf(
7160 "%z%s name %s '%q' OR substr(name,1,%d) %s '%q/'",
7161 zWhere
, zSep
, zSameOp
, z
, strlen30(z
)+1, zSameOp
, z
7164 *pRc
= SQLITE_NOMEM
;
7175 ** Implementation of .ar "lisT" command.
7177 static int arListCommand(ArCommand
*pAr
){
7178 const char *zSql
= "SELECT %s FROM %s WHERE %s";
7179 const char *azCols
[] = {
7181 "lsmode(mode), sz, datetime(mtime, 'unixepoch'), name"
7185 sqlite3_stmt
*pSql
= 0;
7188 rc
= arCheckEntries(pAr
);
7189 arWhereClause(&rc
, pAr
, &zWhere
);
7191 shellPreparePrintf(pAr
->db
, &rc
, &pSql
, zSql
, azCols
[pAr
->bVerbose
],
7192 pAr
->zSrcTable
, zWhere
);
7194 oputf("%s\n", sqlite3_sql(pSql
));
7196 while( rc
==SQLITE_OK
&& SQLITE_ROW
==sqlite3_step(pSql
) ){
7197 if( pAr
->bVerbose
){
7198 oputf("%s % 10d %s %s\n",
7199 sqlite3_column_text(pSql
, 0), sqlite3_column_int(pSql
, 1),
7200 sqlite3_column_text(pSql
, 2),sqlite3_column_text(pSql
, 3));
7202 oputf("%s\n", sqlite3_column_text(pSql
, 0));
7206 shellFinalize(&rc
, pSql
);
7207 sqlite3_free(zWhere
);
7212 ** Implementation of .ar "Remove" command.
7214 static int arRemoveCommand(ArCommand
*pAr
){
7220 /* Verify that args actually exist within the archive before proceeding.
7221 ** And formulate a WHERE clause to match them. */
7222 rc
= arCheckEntries(pAr
);
7223 arWhereClause(&rc
, pAr
, &zWhere
);
7225 if( rc
==SQLITE_OK
){
7226 zSql
= sqlite3_mprintf("DELETE FROM %s WHERE %s;",
7227 pAr
->zSrcTable
, zWhere
);
7229 oputf("%s\n", zSql
);
7232 rc
= sqlite3_exec(pAr
->db
, "SAVEPOINT ar;", 0, 0, 0);
7233 if( rc
==SQLITE_OK
){
7234 rc
= sqlite3_exec(pAr
->db
, zSql
, 0, 0, &zErr
);
7235 if( rc
!=SQLITE_OK
){
7236 sqlite3_exec(pAr
->db
, "ROLLBACK TO ar; RELEASE ar;", 0, 0, 0);
7238 rc
= sqlite3_exec(pAr
->db
, "RELEASE ar;", 0, 0, 0);
7242 sputf(stdout
, "ERROR: %s\n", zErr
); /* stdout? */
7247 sqlite3_free(zWhere
);
7253 ** Implementation of .ar "eXtract" command.
7255 static int arExtractCommand(ArCommand
*pAr
){
7259 " writefile(($dir || name), %s, mode, mtime) "
7260 "FROM %s WHERE (%s) AND (data IS NULL OR $dirOnly = 0)"
7261 " AND name NOT GLOB '*..[/\\]*'";
7263 const char *azExtraArg
[] = {
7264 "sqlar_uncompress(data, sz)",
7268 sqlite3_stmt
*pSql
= 0;
7274 /* If arguments are specified, check that they actually exist within
7275 ** the archive before proceeding. And formulate a WHERE clause to
7277 rc
= arCheckEntries(pAr
);
7278 arWhereClause(&rc
, pAr
, &zWhere
);
7280 if( rc
==SQLITE_OK
){
7282 zDir
= sqlite3_mprintf("%s/", pAr
->zDir
);
7284 zDir
= sqlite3_mprintf("");
7286 if( zDir
==0 ) rc
= SQLITE_NOMEM
;
7289 shellPreparePrintf(pAr
->db
, &rc
, &pSql
, zSql1
,
7290 azExtraArg
[pAr
->bZip
], pAr
->zSrcTable
, zWhere
7293 if( rc
==SQLITE_OK
){
7294 j
= sqlite3_bind_parameter_index(pSql
, "$dir");
7295 sqlite3_bind_text(pSql
, j
, zDir
, -1, SQLITE_STATIC
);
7297 /* Run the SELECT statement twice. The first time, writefile() is called
7298 ** for all archive members that should be extracted. The second time,
7299 ** only for the directories. This is because the timestamps for
7300 ** extracted directories must be reset after they are populated (as
7301 ** populating them changes the timestamp). */
7303 j
= sqlite3_bind_parameter_index(pSql
, "$dirOnly");
7304 sqlite3_bind_int(pSql
, j
, i
);
7306 oputf("%s\n", sqlite3_sql(pSql
));
7308 while( rc
==SQLITE_OK
&& SQLITE_ROW
==sqlite3_step(pSql
) ){
7309 if( i
==0 && pAr
->bVerbose
){
7310 oputf("%s\n", sqlite3_column_text(pSql
, 0));
7314 shellReset(&rc
, pSql
);
7316 shellFinalize(&rc
, pSql
);
7320 sqlite3_free(zWhere
);
7325 ** Run the SQL statement in zSql. Or if doing a --dryrun, merely print it out.
7327 static int arExecSql(ArCommand
*pAr
, const char *zSql
){
7330 oputf("%s\n", zSql
);
7334 rc
= sqlite3_exec(pAr
->db
, zSql
, 0, 0, &zErr
);
7336 sputf(stdout
, "ERROR: %s\n", zErr
);
7345 ** Implementation of .ar "create", "insert", and "update" commands.
7347 ** create -> Create a new SQL archive
7348 ** insert -> Insert or reinsert all files listed
7349 ** update -> Insert files that have changed or that were not
7350 ** previously in the archive
7352 ** Create the "sqlar" table in the database if it does not already exist.
7353 ** Then add each file in the azFile[] array to the archive. Directories
7354 ** are added recursively. If argument bVerbose is non-zero, a message is
7355 ** printed on stdout for each file archived.
7357 ** The create command is the same as update, except that it drops
7358 ** any existing "sqlar" table before beginning. The "insert" command
7359 ** always overwrites every file named on the command-line, where as
7360 ** "update" only overwrites if the size or mtime or mode has changed.
7362 static int arCreateOrUpdateCommand(
7363 ArCommand
*pAr
, /* Command arguments and options */
7364 int bUpdate
, /* true for a --create. */
7365 int bOnlyIfChanged
/* Only update if file has changed */
7367 const char *zCreate
=
7368 "CREATE TABLE IF NOT EXISTS sqlar(\n"
7369 " name TEXT PRIMARY KEY, -- name of the file\n"
7370 " mode INT, -- access permissions\n"
7371 " mtime INT, -- last modification time\n"
7372 " sz INT, -- original file size\n"
7373 " data BLOB -- compressed content\n"
7375 const char *zDrop
= "DROP TABLE IF EXISTS sqlar";
7376 const char *zInsertFmt
[2] = {
7377 "REPLACE INTO %s(name,mode,mtime,sz,data)\n"
7382 " CASE substr(lsmode(mode),1,1)\n"
7383 " WHEN '-' THEN length(data)\n"
7384 " WHEN 'd' THEN 0\n"
7386 " sqlar_compress(data)\n"
7387 " FROM fsdir(%Q,%Q) AS disk\n"
7388 " WHERE lsmode(mode) NOT LIKE '?%%'%s;"
7390 "REPLACE INTO %s(name,mode,mtime,data)\n"
7396 " FROM fsdir(%Q,%Q) AS disk\n"
7397 " WHERE lsmode(mode) NOT LIKE '?%%'%s;"
7399 int i
; /* For iterating through azFile[] */
7400 int rc
; /* Return code */
7401 const char *zTab
= 0; /* SQL table into which to insert */
7406 arExecSql(pAr
, "PRAGMA page_size=512");
7407 rc
= arExecSql(pAr
, "SAVEPOINT ar;");
7408 if( rc
!=SQLITE_OK
) return rc
;
7411 /* Initialize the zipfile virtual table, if necessary */
7414 sqlite3_randomness(sizeof(r
),&r
);
7415 sqlite3_snprintf(sizeof(zTemp
),zTemp
,"zip%016llx",r
);
7417 zSql
= sqlite3_mprintf(
7418 "CREATE VIRTUAL TABLE temp.%s USING zipfile(%Q)",
7421 rc
= arExecSql(pAr
, zSql
);
7427 /* Initialize the table for an SQLAR */
7430 rc
= arExecSql(pAr
, zDrop
);
7431 if( rc
!=SQLITE_OK
) goto end_ar_transaction
;
7433 rc
= arExecSql(pAr
, zCreate
);
7435 if( bOnlyIfChanged
){
7436 zExists
= sqlite3_mprintf(
7438 "SELECT 1 FROM %s AS mem"
7439 " WHERE mem.name=disk.name"
7440 " AND mem.mtime=disk.mtime"
7441 " AND mem.mode=disk.mode)", zTab
);
7443 zExists
= sqlite3_mprintf("");
7445 if( zExists
==0 ) rc
= SQLITE_NOMEM
;
7446 for(i
=0; i
<pAr
->nArg
&& rc
==SQLITE_OK
; i
++){
7447 char *zSql2
= sqlite3_mprintf(zInsertFmt
[pAr
->bZip
], zTab
,
7448 pAr
->bVerbose
? "shell_putsnl(name)" : "name",
7449 pAr
->azArg
[i
], pAr
->zDir
, zExists
);
7450 rc
= arExecSql(pAr
, zSql2
);
7451 sqlite3_free(zSql2
);
7454 if( rc
!=SQLITE_OK
){
7455 sqlite3_exec(pAr
->db
, "ROLLBACK TO ar; RELEASE ar;", 0, 0, 0);
7457 rc
= arExecSql(pAr
, "RELEASE ar;");
7458 if( pAr
->bZip
&& pAr
->zFile
){
7459 zSql
= sqlite3_mprintf("DROP TABLE %s", zTemp
);
7460 arExecSql(pAr
, zSql
);
7464 sqlite3_free(zExists
);
7469 ** Implementation of ".ar" dot command.
7471 static int arDotCommand(
7472 ShellState
*pState
, /* Current shell tool state */
7473 int fromCmdLine
, /* True if -A command-line option, not .ar cmd */
7474 char **azArg
, /* Array of arguments passed to dot command */
7475 int nArg
/* Number of entries in azArg[] */
7479 memset(&cmd
, 0, sizeof(cmd
));
7480 cmd
.fromCmdLine
= fromCmdLine
;
7481 rc
= arParseCommand(azArg
, nArg
, &cmd
);
7482 if( rc
==SQLITE_OK
){
7483 int eDbType
= SHELL_OPEN_UNSPEC
;
7485 cmd
.db
= pState
->db
;
7487 eDbType
= deduceDatabaseType(cmd
.zFile
, 1);
7489 eDbType
= pState
->openMode
;
7491 if( eDbType
==SHELL_OPEN_ZIPFILE
){
7492 if( cmd
.eCmd
==AR_CMD_EXTRACT
|| cmd
.eCmd
==AR_CMD_LIST
){
7494 cmd
.zSrcTable
= sqlite3_mprintf("zip");
7496 cmd
.zSrcTable
= sqlite3_mprintf("zipfile(%Q)", cmd
.zFile
);
7500 }else if( cmd
.zFile
){
7502 if( cmd
.bAppend
) eDbType
= SHELL_OPEN_APPENDVFS
;
7503 if( cmd
.eCmd
==AR_CMD_CREATE
|| cmd
.eCmd
==AR_CMD_INSERT
7504 || cmd
.eCmd
==AR_CMD_REMOVE
|| cmd
.eCmd
==AR_CMD_UPDATE
){
7505 flags
= SQLITE_OPEN_READWRITE
|SQLITE_OPEN_CREATE
;
7507 flags
= SQLITE_OPEN_READONLY
;
7511 oputf("-- open database '%s'%s\n", cmd
.zFile
,
7512 eDbType
==SHELL_OPEN_APPENDVFS
? " using 'apndvfs'" : "");
7514 rc
= sqlite3_open_v2(cmd
.zFile
, &cmd
.db
, flags
,
7515 eDbType
==SHELL_OPEN_APPENDVFS
? "apndvfs" : 0);
7516 if( rc
!=SQLITE_OK
){
7517 eputf("cannot open file: %s (%s)\n", cmd
.zFile
, sqlite3_errmsg(cmd
.db
));
7518 goto end_ar_command
;
7520 sqlite3_fileio_init(cmd
.db
, 0, 0);
7521 sqlite3_sqlar_init(cmd
.db
, 0, 0);
7522 sqlite3_create_function(cmd
.db
, "shell_putsnl", 1, SQLITE_UTF8
, cmd
.p
,
7523 shellPutsFunc
, 0, 0);
7526 if( cmd
.zSrcTable
==0 && cmd
.bZip
==0 && cmd
.eCmd
!=AR_CMD_HELP
){
7527 if( cmd
.eCmd
!=AR_CMD_CREATE
7528 && sqlite3_table_column_metadata(cmd
.db
,0,"sqlar","name",0,0,0,0,0)
7530 eputz("database does not contain an 'sqlar' table\n");
7532 goto end_ar_command
;
7534 cmd
.zSrcTable
= sqlite3_mprintf("sqlar");
7539 rc
= arCreateOrUpdateCommand(&cmd
, 0, 0);
7542 case AR_CMD_EXTRACT
:
7543 rc
= arExtractCommand(&cmd
);
7547 rc
= arListCommand(&cmd
);
7551 arUsage(pState
->out
);
7555 rc
= arCreateOrUpdateCommand(&cmd
, 1, 0);
7559 rc
= arRemoveCommand(&cmd
);
7563 assert( cmd
.eCmd
==AR_CMD_UPDATE
);
7564 rc
= arCreateOrUpdateCommand(&cmd
, 1, 1);
7569 if( cmd
.db
!=pState
->db
){
7572 sqlite3_free(cmd
.zSrcTable
);
7576 /* End of the ".archive" or ".ar" command logic
7577 *******************************************************************************/
7578 #endif /* !defined(SQLITE_OMIT_VIRTUALTABLE) && defined(SQLITE_HAVE_ZLIB) */
7580 #if SQLITE_SHELL_HAVE_RECOVER
7583 ** This function is used as a callback by the recover extension. Simply
7584 ** print the supplied SQL statement to stdout.
7586 static int recoverSqlCb(void *pCtx
, const char *zSql
){
7587 ShellState
*pState
= (ShellState
*)pCtx
;
7588 sputf(pState
->out
, "%s;\n", zSql
);
7593 ** This function is called to recover data from the database. A script
7594 ** to construct a new database containing all recovered data is output
7595 ** on stream pState->out.
7597 static int recoverDatabaseCmd(ShellState
*pState
, int nArg
, char **azArg
){
7599 const char *zRecoveryDb
= ""; /* Name of "recovery" database. Debug only */
7600 const char *zLAF
= "lost_and_found";
7601 int bFreelist
= 1; /* 0 if --ignore-freelist is specified */
7602 int bRowids
= 1; /* 0 if --no-rowids */
7603 sqlite3_recover
*p
= 0;
7606 for(i
=1; i
<nArg
; i
++){
7609 if( z
[0]=='-' && z
[1]=='-' ) z
++;
7611 if( n
<=17 && memcmp("-ignore-freelist", z
, n
)==0 ){
7614 if( n
<=12 && memcmp("-recovery-db", z
, n
)==0 && i
<(nArg
-1) ){
7615 /* This option determines the name of the ATTACH-ed database used
7616 ** internally by the recovery extension. The default is "" which
7617 ** means to use a temporary database that is automatically deleted
7618 ** when closed. This option is undocumented and might disappear at
7621 zRecoveryDb
= azArg
[i
];
7623 if( n
<=15 && memcmp("-lost-and-found", z
, n
)==0 && i
<(nArg
-1) ){
7627 if( n
<=10 && memcmp("-no-rowids", z
, n
)==0 ){
7631 eputf("unexpected option: %s\n", azArg
[i
]);
7632 showHelp(pState
->out
, azArg
[0]);
7637 p
= sqlite3_recover_init_sql(
7638 pState
->db
, "main", recoverSqlCb
, (void*)pState
7641 sqlite3_recover_config(p
, 789, (void*)zRecoveryDb
); /* Debug use only */
7642 sqlite3_recover_config(p
, SQLITE_RECOVER_LOST_AND_FOUND
, (void*)zLAF
);
7643 sqlite3_recover_config(p
, SQLITE_RECOVER_ROWIDS
, (void*)&bRowids
);
7644 sqlite3_recover_config(p
, SQLITE_RECOVER_FREELIST_CORRUPT
,(void*)&bFreelist
);
7646 sqlite3_recover_run(p
);
7647 if( sqlite3_recover_errcode(p
)!=SQLITE_OK
){
7648 const char *zErr
= sqlite3_recover_errmsg(p
);
7649 int errCode
= sqlite3_recover_errcode(p
);
7650 eputf("sql error: %s (%d)\n", zErr
, errCode
);
7652 rc
= sqlite3_recover_finish(p
);
7655 #endif /* SQLITE_SHELL_HAVE_RECOVER */
7659 * zAutoColumn(zCol, &db, ?) => Maybe init db, add column zCol to it.
7660 * zAutoColumn(0, &db, ?) => (db!=0) Form columns spec for CREATE TABLE,
7661 * close db and set it to 0, and return the columns spec, to later
7662 * be sqlite3_free()'ed by the caller.
7663 * The return is 0 when either:
7664 * (a) The db was not initialized and zCol==0 (There are no columns.)
7665 * (b) zCol!=0 (Column was added, db initialized as needed.)
7666 * The 3rd argument, pRenamed, references an out parameter. If the
7667 * pointer is non-zero, its referent will be set to a summary of renames
7668 * done if renaming was necessary, or set to 0 if none was done. The out
7669 * string (if any) must be sqlite3_free()'ed by the caller.
7672 #define rc_err_oom_die(rc) \
7673 if( rc==SQLITE_NOMEM ) shell_check_oom(0); \
7674 else if(!(rc==SQLITE_OK||rc==SQLITE_DONE)) \
7675 eputf("E:%d\n",rc), assert(0)
7677 static void rc_err_oom_die(int rc
){
7678 if( rc
==SQLITE_NOMEM
) shell_check_oom(0);
7679 assert(rc
==SQLITE_OK
||rc
==SQLITE_DONE
);
7683 #ifdef SHELL_COLFIX_DB /* If this is set, the DB can be in a file. */
7684 static char zCOL_DB
[] = SHELL_STRINGIFY(SHELL_COLFIX_DB
);
7685 #else /* Otherwise, memory is faster/better for the transient DB. */
7686 static const char *zCOL_DB
= ":memory:";
7689 /* Define character (as C string) to separate generated column ordinal
7690 * from protected part of incoming column names. This defaults to "_"
7691 * so that incoming column identifiers that did not need not be quoted
7692 * remain usable without being quoted. It must be one character.
7694 #ifndef SHELL_AUTOCOLUMN_SEP
7695 # define AUTOCOLUMN_SEP "_"
7697 # define AUTOCOLUMN_SEP SHELL_STRINGIFY(SHELL_AUTOCOLUMN_SEP)
7700 static char *zAutoColumn(const char *zColNew
, sqlite3
**pDb
, char **pzRenamed
){
7701 /* Queries and D{D,M}L used here */
7702 static const char * const zTabMake
= "\
7703 CREATE TABLE ColNames(\
7704 cpos INTEGER PRIMARY KEY,\
7705 name TEXT, nlen INT, chop INT, reps INT, suff TEXT);\
7706 CREATE VIEW RepeatedNames AS \
7707 SELECT DISTINCT t.name FROM ColNames t \
7708 WHERE t.name COLLATE NOCASE IN (\
7709 SELECT o.name FROM ColNames o WHERE o.cpos<>t.cpos\
7712 static const char * const zTabFill
= "\
7713 INSERT INTO ColNames(name,nlen,chop,reps,suff)\
7714 VALUES(iif(length(?1)>0,?1,'?'),max(length(?1),1),0,0,'')\
7716 static const char * const zHasDupes
= "\
7717 SELECT count(DISTINCT (substring(name,1,nlen-chop)||suff) COLLATE NOCASE)\
7718 <count(name) FROM ColNames\
7720 #ifdef SHELL_COLUMN_RENAME_CLEAN
7721 static const char * const zDedoctor
= "\
7722 UPDATE ColNames SET chop=iif(\
7723 (substring(name,nlen,1) BETWEEN '0' AND '9')\
7724 AND (rtrim(name,'0123456790') glob '*"AUTOCOLUMN_SEP
"'),\
7725 nlen-length(rtrim(name, '"AUTOCOLUMN_SEP
"0123456789')),\
7730 static const char * const zSetReps
= "\
7731 UPDATE ColNames AS t SET reps=\
7732 (SELECT count(*) FROM ColNames d \
7733 WHERE substring(t.name,1,t.nlen-t.chop)=substring(d.name,1,d.nlen-d.chop)\
7737 #ifdef SQLITE_ENABLE_MATH_FUNCTIONS
7738 static const char * const zColDigits
= "\
7739 SELECT CAST(ceil(log(count(*)+0.5)) AS INT) FROM ColNames \
7742 /* Counting on SQLITE_MAX_COLUMN < 100,000 here. (32767 is the hard limit.) */
7743 static const char * const zColDigits
= "\
7744 SELECT CASE WHEN (nc < 10) THEN 1 WHEN (nc < 100) THEN 2 \
7745 WHEN (nc < 1000) THEN 3 WHEN (nc < 10000) THEN 4 \
7746 ELSE 5 FROM (SELECT count(*) AS nc FROM ColNames) \
7749 static const char * const zRenameRank
=
7750 #ifdef SHELL_COLUMN_RENAME_CLEAN
7751 "UPDATE ColNames AS t SET suff="
7752 "iif(reps>1, printf('%c%0*d', '"AUTOCOLUMN_SEP
"', $1, cpos), '')"
7753 #else /* ...RENAME_MINIMAL_ONE_PASS */
7754 "WITH Lzn(nlz) AS (" /* Find minimum extraneous leading 0's for uniqueness */
7757 " SELECT nlz+1 AS nlz FROM Lzn"
7760 " FROM ColNames t, ColNames o"
7762 " iif(t.name IN (SELECT * FROM RepeatedNames),"
7763 " printf('%s"AUTOCOLUMN_SEP
"%s',"
7764 " t.name, substring(printf('%.*c%0.*d',nlz+1,'0',$1,t.cpos),2)),"
7768 " iif(o.name IN (SELECT * FROM RepeatedNames),"
7769 " printf('%s"AUTOCOLUMN_SEP
"%s',"
7770 " o.name, substring(printf('%.*c%0.*d',nlz+1,'0',$1,o.cpos),2)),"
7774 " AND o.cpos<>t.cpos"
7777 ") UPDATE Colnames AS t SET"
7778 " chop = 0," /* No chopping, never touch incoming names. */
7779 " suff = iif(name IN (SELECT * FROM RepeatedNames),"
7780 " printf('"AUTOCOLUMN_SEP
"%s', substring("
7781 " printf('%.*c%0.*d',(SELECT max(nlz) FROM Lzn)+1,'0',1,t.cpos),2)),"
7786 static const char * const zCollectVar
= "\
7791 ','||iif((cpos-1)%4>0, ' ', x'0a'||' '))\
7794 SELECT cpos, printf('\"%w\"',printf('%!.*s%s', nlen-chop,name,suff)) AS cname \
7795 FROM ColNames ORDER BY cpos\
7797 static const char * const zRenamesDone
=
7798 "SELECT group_concat("
7799 " printf('\"%w\" to \"%w\"',name,printf('%!.*s%s', nlen-chop, name, suff)),"
7801 "FROM ColNames WHERE suff<>'' OR chop!=0"
7804 sqlite3_stmt
*pStmt
= 0;
7807 /* Add initial or additional column. Init db if necessary. */
7809 if( SQLITE_OK
!=sqlite3_open(zCOL_DB
, pDb
) ) return 0;
7810 #ifdef SHELL_COLFIX_DB
7812 sqlite3_exec(*pDb
,"drop table if exists ColNames;"
7813 "drop view if exists RepeatedNames;",0,0,0);
7815 #undef SHELL_COLFIX_DB
7816 rc
= sqlite3_exec(*pDb
, zTabMake
, 0, 0, 0);
7820 rc
= sqlite3_prepare_v2(*pDb
, zTabFill
, -1, &pStmt
, 0);
7822 rc
= sqlite3_bind_text(pStmt
, 1, zColNew
, -1, 0);
7824 rc
= sqlite3_step(pStmt
);
7826 sqlite3_finalize(pStmt
);
7828 }else if( *pDb
==0 ){
7831 /* Formulate the columns spec, close the DB, zero *pDb. */
7832 char *zColsSpec
= 0;
7833 int hasDupes
= db_int(*pDb
, zHasDupes
);
7834 int nDigits
= (hasDupes
)? db_int(*pDb
, zColDigits
) : 0;
7836 #ifdef SHELL_COLUMN_RENAME_CLEAN
7837 rc
= sqlite3_exec(*pDb
, zDedoctor
, 0, 0, 0);
7840 rc
= sqlite3_exec(*pDb
, zSetReps
, 0, 0, 0);
7842 rc
= sqlite3_prepare_v2(*pDb
, zRenameRank
, -1, &pStmt
, 0);
7844 sqlite3_bind_int(pStmt
, 1, nDigits
);
7845 rc
= sqlite3_step(pStmt
);
7846 sqlite3_finalize(pStmt
);
7847 if( rc
!=SQLITE_DONE
) rc_err_oom_die(SQLITE_NOMEM
);
7849 assert(db_int(*pDb
, zHasDupes
)==0); /* Consider: remove this */
7850 rc
= sqlite3_prepare_v2(*pDb
, zCollectVar
, -1, &pStmt
, 0);
7852 rc
= sqlite3_step(pStmt
);
7853 if( rc
==SQLITE_ROW
){
7854 zColsSpec
= sqlite3_mprintf("%s", sqlite3_column_text(pStmt
, 0));
7859 if( !hasDupes
) *pzRenamed
= 0;
7861 sqlite3_finalize(pStmt
);
7862 if( SQLITE_OK
==sqlite3_prepare_v2(*pDb
, zRenamesDone
, -1, &pStmt
, 0)
7863 && SQLITE_ROW
==sqlite3_step(pStmt
) ){
7864 *pzRenamed
= sqlite3_mprintf("%s", sqlite3_column_text(pStmt
, 0));
7869 sqlite3_finalize(pStmt
);
7870 sqlite3_close(*pDb
);
7877 ** Check if the sqlite_schema table contains one or more virtual tables. If
7878 ** parameter zLike is not NULL, then it is an SQL expression that the
7879 ** sqlite_schema row must also match. If one or more such rows are found,
7880 ** print the following warning to the output:
7882 ** WARNING: Script requires that SQLITE_DBCONFIG_DEFENSIVE be disabled
7884 static int outputDumpWarning(ShellState
*p
, const char *zLike
){
7886 sqlite3_stmt
*pStmt
= 0;
7887 shellPreparePrintf(p
->db
, &rc
, &pStmt
,
7888 "SELECT 1 FROM sqlite_schema o WHERE "
7889 "sql LIKE 'CREATE VIRTUAL TABLE%%' AND %s", zLike
? zLike
: "true"
7891 if( rc
==SQLITE_OK
&& sqlite3_step(pStmt
)==SQLITE_ROW
){
7892 oputz("/* WARNING: "
7893 "Script requires that SQLITE_DBCONFIG_DEFENSIVE be disabled */\n"
7896 shellFinalize(&rc
, pStmt
);
7901 ** If an input line begins with "." then invoke this routine to
7902 ** process that line.
7904 ** Return 1 on error, 2 to exit, and 0 otherwise.
7906 static int do_meta_command(char *zLine
, ShellState
*p
){
7913 #ifndef SQLITE_OMIT_VIRTUALTABLE
7914 if( p
->expert
.pExpert
){
7915 expertFinish(p
, 1, 0);
7919 /* Parse the input line into tokens.
7921 while( zLine
[h
] && nArg
<ArraySize(azArg
)-1 ){
7922 while( IsSpace(zLine
[h
]) ){ h
++; }
7923 if( zLine
[h
]==0 ) break;
7924 if( zLine
[h
]=='\'' || zLine
[h
]=='"' ){
7925 int delim
= zLine
[h
++];
7926 azArg
[nArg
++] = &zLine
[h
];
7927 while( zLine
[h
] && zLine
[h
]!=delim
){
7928 if( zLine
[h
]=='\\' && delim
=='"' && zLine
[h
+1]!=0 ) h
++;
7931 if( zLine
[h
]==delim
){
7934 if( delim
=='"' ) resolve_backslashes(azArg
[nArg
-1]);
7936 azArg
[nArg
++] = &zLine
[h
];
7937 while( zLine
[h
] && !IsSpace(zLine
[h
]) ){ h
++; }
7938 if( zLine
[h
] ) zLine
[h
++] = 0;
7943 /* Process the input line.
7945 if( nArg
==0 ) return 0; /* no tokens, no error */
7946 n
= strlen30(azArg
[0]);
7950 #ifndef SQLITE_OMIT_AUTHORIZATION
7951 if( c
=='a' && cli_strncmp(azArg
[0], "auth", n
)==0 ){
7953 eputz("Usage: .auth ON|OFF\n");
7955 goto meta_command_exit
;
7958 if( booleanValue(azArg
[1]) ){
7959 sqlite3_set_authorizer(p
->db
, shellAuth
, p
);
7960 }else if( p
->bSafeModePersist
){
7961 sqlite3_set_authorizer(p
->db
, safeModeAuth
, p
);
7963 sqlite3_set_authorizer(p
->db
, 0, 0);
7968 #if !defined(SQLITE_OMIT_VIRTUALTABLE) && defined(SQLITE_HAVE_ZLIB) \
7969 && !defined(SQLITE_SHELL_FIDDLE)
7970 if( c
=='a' && cli_strncmp(azArg
[0], "archive", n
)==0 ){
7972 failIfSafeMode(p
, "cannot run .archive in safe mode");
7973 rc
= arDotCommand(p
, 0, azArg
, nArg
);
7977 #ifndef SQLITE_SHELL_FIDDLE
7978 if( (c
=='b' && n
>=3 && cli_strncmp(azArg
[0], "backup", n
)==0)
7979 || (c
=='s' && n
>=3 && cli_strncmp(azArg
[0], "save", n
)==0)
7981 const char *zDestFile
= 0;
7982 const char *zDb
= 0;
7984 sqlite3_backup
*pBackup
;
7987 const char *zVfs
= 0;
7988 failIfSafeMode(p
, "cannot run .%s in safe mode", azArg
[0]);
7989 for(j
=1; j
<nArg
; j
++){
7990 const char *z
= azArg
[j
];
7992 if( z
[1]=='-' ) z
++;
7993 if( cli_strcmp(z
, "-append")==0 ){
7996 if( cli_strcmp(z
, "-async")==0 ){
8000 eputf("unknown option: %s\n", azArg
[j
]);
8003 }else if( zDestFile
==0 ){
8004 zDestFile
= azArg
[j
];
8007 zDestFile
= azArg
[j
];
8009 eputz("Usage: .backup ?DB? ?OPTIONS? FILENAME\n");
8014 eputz("missing FILENAME argument on .backup\n");
8017 if( zDb
==0 ) zDb
= "main";
8018 rc
= sqlite3_open_v2(zDestFile
, &pDest
,
8019 SQLITE_OPEN_READWRITE
|SQLITE_OPEN_CREATE
, zVfs
);
8020 if( rc
!=SQLITE_OK
){
8021 eputf("Error: cannot open \"%s\"\n", zDestFile
);
8026 sqlite3_exec(pDest
, "PRAGMA synchronous=OFF; PRAGMA journal_mode=OFF;",
8030 pBackup
= sqlite3_backup_init(pDest
, "main", p
->db
, zDb
);
8032 eputf("Error: %s\n", sqlite3_errmsg(pDest
));
8036 while( (rc
= sqlite3_backup_step(pBackup
,100))==SQLITE_OK
){}
8037 sqlite3_backup_finish(pBackup
);
8038 if( rc
==SQLITE_DONE
){
8041 eputf("Error: %s\n", sqlite3_errmsg(pDest
));
8046 #endif /* !defined(SQLITE_SHELL_FIDDLE) */
8048 if( c
=='b' && n
>=3 && cli_strncmp(azArg
[0], "bail", n
)==0 ){
8050 bail_on_error
= booleanValue(azArg
[1]);
8052 eputz("Usage: .bail on|off\n");
8057 /* Undocumented. Legacy only. See "crnl" below */
8058 if( c
=='b' && n
>=3 && cli_strncmp(azArg
[0], "binary", n
)==0 ){
8060 if( booleanValue(azArg
[1]) ){
8061 setBinaryMode(p
->out
, 1);
8063 setTextMode(p
->out
, 1);
8066 eputz("The \".binary\" command is deprecated. Use \".crnl\" instead.\n"
8067 "Usage: .binary on|off\n");
8072 /* The undocumented ".breakpoint" command causes a call to the no-op
8073 ** routine named test_breakpoint().
8075 if( c
=='b' && n
>=3 && cli_strncmp(azArg
[0], "breakpoint", n
)==0 ){
8079 #ifndef SQLITE_SHELL_FIDDLE
8080 if( c
=='c' && cli_strcmp(azArg
[0],"cd")==0 ){
8081 failIfSafeMode(p
, "cannot run .cd in safe mode");
8083 #if defined(_WIN32) || defined(WIN32)
8084 wchar_t *z
= sqlite3_win32_utf8_to_unicode(azArg
[1]);
8085 rc
= !SetCurrentDirectoryW(z
);
8088 rc
= chdir(azArg
[1]);
8091 eputf("Cannot change to directory \"%s\"\n", azArg
[1]);
8095 eputz("Usage: .cd DIRECTORY\n");
8099 #endif /* !defined(SQLITE_SHELL_FIDDLE) */
8101 if( c
=='c' && n
>=3 && cli_strncmp(azArg
[0], "changes", n
)==0 ){
8103 setOrClearFlag(p
, SHFLG_CountChanges
, azArg
[1]);
8105 eputz("Usage: .changes on|off\n");
8110 #ifndef SQLITE_SHELL_FIDDLE
8111 /* Cancel output redirection, if it is currently set (by .testcase)
8112 ** Then read the content of the testcase-out.txt file and compare against
8113 ** azArg[1]. If there are differences, report an error and exit.
8115 if( c
=='c' && n
>=3 && cli_strncmp(azArg
[0], "check", n
)==0 ){
8119 eputz("Usage: .check GLOB-PATTERN\n");
8121 }else if( (zRes
= readFile("testcase-out.txt", 0))==0 ){
8123 }else if( testcase_glob(azArg
[1],zRes
)==0 ){
8124 eputf("testcase-%s FAILED\n Expected: [%s]\n Got: [%s]\n",
8125 p
->zTestcase
, azArg
[1], zRes
);
8128 oputf("testcase-%s ok\n", p
->zTestcase
);
8133 #endif /* !defined(SQLITE_SHELL_FIDDLE) */
8135 #ifndef SQLITE_SHELL_FIDDLE
8136 if( c
=='c' && cli_strncmp(azArg
[0], "clone", n
)==0 ){
8137 failIfSafeMode(p
, "cannot run .clone in safe mode");
8139 tryToClone(p
, azArg
[1]);
8141 eputz("Usage: .clone FILENAME\n");
8145 #endif /* !defined(SQLITE_SHELL_FIDDLE) */
8147 if( c
=='c' && cli_strncmp(azArg
[0], "connection", n
)==0 ){
8149 /* List available connections */
8151 for(i
=0; i
<ArraySize(p
->aAuxDb
); i
++){
8152 const char *zFile
= p
->aAuxDb
[i
].zDbFilename
;
8153 if( p
->aAuxDb
[i
].db
==0 && p
->pAuxDb
!=&p
->aAuxDb
[i
] ){
8154 zFile
= "(not open)";
8155 }else if( zFile
==0 ){
8157 }else if( zFile
[0]==0 ){
8158 zFile
= "(temporary-file)";
8160 if( p
->pAuxDb
== &p
->aAuxDb
[i
] ){
8161 sputf(stdout
, "ACTIVE %d: %s\n", i
, zFile
);
8162 }else if( p
->aAuxDb
[i
].db
!=0 ){
8163 sputf(stdout
, " %d: %s\n", i
, zFile
);
8166 }else if( nArg
==2 && IsDigit(azArg
[1][0]) && azArg
[1][1]==0 ){
8167 int i
= azArg
[1][0] - '0';
8168 if( p
->pAuxDb
!= &p
->aAuxDb
[i
] && i
>=0 && i
<ArraySize(p
->aAuxDb
) ){
8169 p
->pAuxDb
->db
= p
->db
;
8170 p
->pAuxDb
= &p
->aAuxDb
[i
];
8171 globalDb
= p
->db
= p
->pAuxDb
->db
;
8174 }else if( nArg
==3 && cli_strcmp(azArg
[1], "close")==0
8175 && IsDigit(azArg
[2][0]) && azArg
[2][1]==0 ){
8176 int i
= azArg
[2][0] - '0';
8177 if( i
<0 || i
>=ArraySize(p
->aAuxDb
) ){
8179 }else if( p
->pAuxDb
== &p
->aAuxDb
[i
] ){
8180 eputz("cannot close the active database connection\n");
8182 }else if( p
->aAuxDb
[i
].db
){
8183 session_close_all(p
, i
);
8184 close_db(p
->aAuxDb
[i
].db
);
8185 p
->aAuxDb
[i
].db
= 0;
8188 eputz("Usage: .connection [close] [CONNECTION-NUMBER]\n");
8193 if( c
=='c' && n
==4 && cli_strncmp(azArg
[0], "crnl", n
)==0 ){
8195 if( booleanValue(azArg
[1]) ){
8196 setTextMode(p
->out
, 1);
8198 setBinaryMode(p
->out
, 1);
8201 #if !defined(_WIN32) && !defined(WIN32)
8202 eputz("The \".crnl\" is a no-op on non-Windows machines.\n");
8204 eputz("Usage: .crnl on|off\n");
8209 if( c
=='d' && n
>1 && cli_strncmp(azArg
[0], "databases", n
)==0 ){
8212 sqlite3_stmt
*pStmt
;
8215 rc
= sqlite3_prepare_v2(p
->db
, "PRAGMA database_list", -1, &pStmt
, 0);
8217 eputf("Error: %s\n", sqlite3_errmsg(p
->db
));
8220 while( sqlite3_step(pStmt
)==SQLITE_ROW
){
8221 const char *zSchema
= (const char *)sqlite3_column_text(pStmt
,1);
8222 const char *zFile
= (const char*)sqlite3_column_text(pStmt
,2);
8223 if( zSchema
==0 || zFile
==0 ) continue;
8224 azName
= sqlite3_realloc(azName
, (nName
+1)*2*sizeof(char*));
8225 shell_check_oom(azName
);
8226 azName
[nName
*2] = strdup(zSchema
);
8227 azName
[nName
*2+1] = strdup(zFile
);
8231 sqlite3_finalize(pStmt
);
8232 for(i
=0; i
<nName
; i
++){
8233 int eTxn
= sqlite3_txn_state(p
->db
, azName
[i
*2]);
8234 int bRdonly
= sqlite3_db_readonly(p
->db
, azName
[i
*2]);
8235 const char *z
= azName
[i
*2+1];
8236 oputf("%s: %s %s%s\n",
8237 azName
[i
*2], z
&& z
[0] ? z
: "\"\"", bRdonly
? "r/o" : "r/w",
8238 eTxn
==SQLITE_TXN_NONE
? "" :
8239 eTxn
==SQLITE_TXN_READ
? " read-txn" : " write-txn");
8241 free(azName
[i
*2+1]);
8243 sqlite3_free(azName
);
8246 if( c
=='d' && n
>=3 && cli_strncmp(azArg
[0], "dbconfig", n
)==0 ){
8247 static const struct DbConfigChoices
{
8251 { "defensive", SQLITE_DBCONFIG_DEFENSIVE
},
8252 { "dqs_ddl", SQLITE_DBCONFIG_DQS_DDL
},
8253 { "dqs_dml", SQLITE_DBCONFIG_DQS_DML
},
8254 { "enable_fkey", SQLITE_DBCONFIG_ENABLE_FKEY
},
8255 { "enable_qpsg", SQLITE_DBCONFIG_ENABLE_QPSG
},
8256 { "enable_trigger", SQLITE_DBCONFIG_ENABLE_TRIGGER
},
8257 { "enable_view", SQLITE_DBCONFIG_ENABLE_VIEW
},
8258 { "fts3_tokenizer", SQLITE_DBCONFIG_ENABLE_FTS3_TOKENIZER
},
8259 { "legacy_alter_table", SQLITE_DBCONFIG_LEGACY_ALTER_TABLE
},
8260 { "legacy_file_format", SQLITE_DBCONFIG_LEGACY_FILE_FORMAT
},
8261 { "load_extension", SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION
},
8262 { "no_ckpt_on_close", SQLITE_DBCONFIG_NO_CKPT_ON_CLOSE
},
8263 { "reset_database", SQLITE_DBCONFIG_RESET_DATABASE
},
8264 { "reverse_scanorder", SQLITE_DBCONFIG_REVERSE_SCANORDER
},
8265 { "stmt_scanstatus", SQLITE_DBCONFIG_STMT_SCANSTATUS
},
8266 { "trigger_eqp", SQLITE_DBCONFIG_TRIGGER_EQP
},
8267 { "trusted_schema", SQLITE_DBCONFIG_TRUSTED_SCHEMA
},
8268 { "writable_schema", SQLITE_DBCONFIG_WRITABLE_SCHEMA
},
8272 for(ii
=0; ii
<ArraySize(aDbConfig
); ii
++){
8273 if( nArg
>1 && cli_strcmp(azArg
[1], aDbConfig
[ii
].zName
)!=0 ) continue;
8275 sqlite3_db_config(p
->db
, aDbConfig
[ii
].op
, booleanValue(azArg
[2]), 0);
8277 sqlite3_db_config(p
->db
, aDbConfig
[ii
].op
, -1, &v
);
8278 oputf("%19s %s\n", aDbConfig
[ii
].zName
, v
? "on" : "off");
8281 if( nArg
>1 && ii
==ArraySize(aDbConfig
) ){
8282 eputf("Error: unknown dbconfig \"%s\"\n", azArg
[1]);
8283 eputz("Enter \".dbconfig\" with no arguments for a list\n");
8287 #if SQLITE_SHELL_HAVE_RECOVER
8288 if( c
=='d' && n
>=3 && cli_strncmp(azArg
[0], "dbinfo", n
)==0 ){
8289 rc
= shell_dbinfo_command(p
, nArg
, azArg
);
8292 if( c
=='r' && cli_strncmp(azArg
[0], "recover", n
)==0 ){
8294 rc
= recoverDatabaseCmd(p
, nArg
, azArg
);
8296 #endif /* SQLITE_SHELL_HAVE_RECOVER */
8298 if( c
=='d' && cli_strncmp(azArg
[0], "dump", n
)==0 ){
8302 int savedShowHeader
= p
->showHeader
;
8303 int savedShellFlags
= p
->shellFlgs
;
8305 SHFLG_PreserveRowid
|SHFLG_Newlines
|SHFLG_Echo
8306 |SHFLG_DumpDataOnly
|SHFLG_DumpNoSys
);
8307 for(i
=1; i
<nArg
; i
++){
8308 if( azArg
[i
][0]=='-' ){
8309 const char *z
= azArg
[i
]+1;
8310 if( z
[0]=='-' ) z
++;
8311 if( cli_strcmp(z
,"preserve-rowids")==0 ){
8312 #ifdef SQLITE_OMIT_VIRTUALTABLE
8313 eputz("The --preserve-rowids option is not compatible"
8314 " with SQLITE_OMIT_VIRTUALTABLE\n");
8316 sqlite3_free(zLike
);
8317 goto meta_command_exit
;
8319 ShellSetFlag(p
, SHFLG_PreserveRowid
);
8322 if( cli_strcmp(z
,"newlines")==0 ){
8323 ShellSetFlag(p
, SHFLG_Newlines
);
8325 if( cli_strcmp(z
,"data-only")==0 ){
8326 ShellSetFlag(p
, SHFLG_DumpDataOnly
);
8328 if( cli_strcmp(z
,"nosys")==0 ){
8329 ShellSetFlag(p
, SHFLG_DumpNoSys
);
8332 eputf("Unknown option \"%s\" on \".dump\"\n", azArg
[i
]);
8334 sqlite3_free(zLike
);
8335 goto meta_command_exit
;
8338 /* azArg[i] contains a LIKE pattern. This ".dump" request should
8339 ** only dump data for tables for which either the table name matches
8340 ** the LIKE pattern, or the table appears to be a shadow table of
8341 ** a virtual table for which the name matches the LIKE pattern.
8343 char *zExpr
= sqlite3_mprintf(
8344 "name LIKE %Q ESCAPE '\\' OR EXISTS ("
8345 " SELECT 1 FROM sqlite_schema WHERE "
8346 " name LIKE %Q ESCAPE '\\' AND"
8347 " sql LIKE 'CREATE VIRTUAL TABLE%%' AND"
8348 " substr(o.name, 1, length(name)+1) == (name||'_')"
8349 ")", azArg
[i
], azArg
[i
]
8353 zLike
= sqlite3_mprintf("%z OR %z", zLike
, zExpr
);
8362 outputDumpWarning(p
, zLike
);
8363 if( (p
->shellFlgs
& SHFLG_DumpDataOnly
)==0 ){
8364 /* When playing back a "dump", the content might appear in an order
8365 ** which causes immediate foreign key constraints to be violated.
8366 ** So disable foreign-key constraint enforcement to prevent problems. */
8367 oputz("PRAGMA foreign_keys=OFF;\n");
8368 oputz("BEGIN TRANSACTION;\n");
8370 p
->writableSchema
= 0;
8372 /* Set writable_schema=ON since doing so forces SQLite to initialize
8373 ** as much of the schema as it can even if the sqlite_schema table is
8375 sqlite3_exec(p
->db
, "SAVEPOINT dump; PRAGMA writable_schema=ON", 0, 0, 0);
8377 if( zLike
==0 ) zLike
= sqlite3_mprintf("true");
8378 zSql
= sqlite3_mprintf(
8379 "SELECT name, type, sql FROM sqlite_schema AS o "
8380 "WHERE (%s) AND type=='table'"
8382 " ORDER BY tbl_name='sqlite_sequence', rowid",
8385 run_schema_dump_query(p
,zSql
);
8387 if( (p
->shellFlgs
& SHFLG_DumpDataOnly
)==0 ){
8388 zSql
= sqlite3_mprintf(
8389 "SELECT sql FROM sqlite_schema AS o "
8390 "WHERE (%s) AND sql NOT NULL"
8391 " AND type IN ('index','trigger','view')",
8394 run_table_dump_query(p
, zSql
);
8397 sqlite3_free(zLike
);
8398 if( p
->writableSchema
){
8399 oputz("PRAGMA writable_schema=OFF;\n");
8400 p
->writableSchema
= 0;
8402 sqlite3_exec(p
->db
, "PRAGMA writable_schema=OFF;", 0, 0, 0);
8403 sqlite3_exec(p
->db
, "RELEASE dump;", 0, 0, 0);
8404 if( (p
->shellFlgs
& SHFLG_DumpDataOnly
)==0 ){
8405 oputz(p
->nErr
?"ROLLBACK; -- due to errors\n":"COMMIT;\n");
8407 p
->showHeader
= savedShowHeader
;
8408 p
->shellFlgs
= savedShellFlags
;
8411 if( c
=='e' && cli_strncmp(azArg
[0], "echo", n
)==0 ){
8413 setOrClearFlag(p
, SHFLG_Echo
, azArg
[1]);
8415 eputz("Usage: .echo on|off\n");
8420 if( c
=='e' && cli_strncmp(azArg
[0], "eqp", n
)==0 ){
8423 if( p
->autoEQPtrace
){
8424 if( p
->db
) sqlite3_exec(p
->db
, "PRAGMA vdbe_trace=OFF;", 0, 0, 0);
8425 p
->autoEQPtrace
= 0;
8427 if( cli_strcmp(azArg
[1],"full")==0 ){
8428 p
->autoEQP
= AUTOEQP_full
;
8429 }else if( cli_strcmp(azArg
[1],"trigger")==0 ){
8430 p
->autoEQP
= AUTOEQP_trigger
;
8432 }else if( cli_strcmp(azArg
[1],"test")==0 ){
8433 p
->autoEQP
= AUTOEQP_on
;
8435 }else if( cli_strcmp(azArg
[1],"trace")==0 ){
8436 p
->autoEQP
= AUTOEQP_full
;
8437 p
->autoEQPtrace
= 1;
8439 sqlite3_exec(p
->db
, "SELECT name FROM sqlite_schema LIMIT 1", 0, 0, 0);
8440 sqlite3_exec(p
->db
, "PRAGMA vdbe_trace=ON;", 0, 0, 0);
8443 p
->autoEQP
= (u8
)booleanValue(azArg
[1]);
8446 eputz("Usage: .eqp off|on|trace|trigger|full\n");
8451 #ifndef SQLITE_SHELL_FIDDLE
8452 if( c
=='e' && cli_strncmp(azArg
[0], "exit", n
)==0 ){
8453 if( nArg
>1 && (rc
= (int)integerValue(azArg
[1]))!=0 ) exit(rc
);
8458 /* The ".explain" command is automatic now. It is largely pointless. It
8459 ** retained purely for backwards compatibility */
8460 if( c
=='e' && cli_strncmp(azArg
[0], "explain", n
)==0 ){
8463 if( cli_strcmp(azArg
[1],"auto")==0 ){
8466 val
= booleanValue(azArg
[1]);
8469 if( val
==1 && p
->mode
!=MODE_Explain
){
8470 p
->normalMode
= p
->mode
;
8471 p
->mode
= MODE_Explain
;
8474 if( p
->mode
==MODE_Explain
) p
->mode
= p
->normalMode
;
8476 }else if( val
==99 ){
8477 if( p
->mode
==MODE_Explain
) p
->mode
= p
->normalMode
;
8482 #ifndef SQLITE_OMIT_VIRTUALTABLE
8483 if( c
=='e' && cli_strncmp(azArg
[0], "expert", n
)==0 ){
8485 eputf("Cannot run experimental commands such as \"%s\" in safe mode\n",
8490 expertDotCommand(p
, azArg
, nArg
);
8495 if( c
=='f' && cli_strncmp(azArg
[0], "filectrl", n
)==0 ){
8496 static const struct {
8497 const char *zCtrlName
; /* Name of a test-control option */
8498 int ctrlCode
; /* Integer code for that option */
8499 const char *zUsage
; /* Usage notes */
8501 { "chunk_size", SQLITE_FCNTL_CHUNK_SIZE
, "SIZE" },
8502 { "data_version", SQLITE_FCNTL_DATA_VERSION
, "" },
8503 { "has_moved", SQLITE_FCNTL_HAS_MOVED
, "" },
8504 { "lock_timeout", SQLITE_FCNTL_LOCK_TIMEOUT
, "MILLISEC" },
8505 { "persist_wal", SQLITE_FCNTL_PERSIST_WAL
, "[BOOLEAN]" },
8506 /* { "pragma", SQLITE_FCNTL_PRAGMA, "NAME ARG" },*/
8507 { "psow", SQLITE_FCNTL_POWERSAFE_OVERWRITE
, "[BOOLEAN]" },
8508 { "reserve_bytes", SQLITE_FCNTL_RESERVE_BYTES
, "[N]" },
8509 { "size_limit", SQLITE_FCNTL_SIZE_LIMIT
, "[LIMIT]" },
8510 { "tempfilename", SQLITE_FCNTL_TEMPFILENAME
, "" },
8511 /* { "win32_av_retry", SQLITE_FCNTL_WIN32_AV_RETRY, "COUNT DELAY" },*/
8515 sqlite3_int64 iRes
= 0; /* Integer result to display if rc2==1 */
8516 int isOk
= 0; /* 0: usage 1: %lld 2: no-result */
8518 const char *zCmd
= 0;
8519 const char *zSchema
= 0;
8522 zCmd
= nArg
>=2 ? azArg
[1] : "help";
8525 && (cli_strcmp(zCmd
,"--schema")==0 || cli_strcmp(zCmd
,"-schema")==0)
8529 for(i
=3; i
<nArg
; i
++) azArg
[i
-2] = azArg
[i
];
8534 /* The argument can optionally begin with "-" or "--" */
8535 if( zCmd
[0]=='-' && zCmd
[1] ){
8537 if( zCmd
[0]=='-' && zCmd
[1] ) zCmd
++;
8540 /* --help lists all file-controls */
8541 if( cli_strcmp(zCmd
,"help")==0 ){
8542 oputz("Available file-controls:\n");
8543 for(i
=0; i
<ArraySize(aCtrl
); i
++){
8544 oputf(" .filectrl %s %s\n", aCtrl
[i
].zCtrlName
, aCtrl
[i
].zUsage
);
8547 goto meta_command_exit
;
8550 /* convert filectrl text option to value. allow any unique prefix
8551 ** of the option name, or a numerical value. */
8552 n2
= strlen30(zCmd
);
8553 for(i
=0; i
<ArraySize(aCtrl
); i
++){
8554 if( cli_strncmp(zCmd
, aCtrl
[i
].zCtrlName
, n2
)==0 ){
8556 filectrl
= aCtrl
[i
].ctrlCode
;
8559 eputf("Error: ambiguous file-control: \"%s\"\n"
8560 "Use \".filectrl --help\" for help\n", zCmd
);
8562 goto meta_command_exit
;
8567 eputf("Error: unknown file-control: %s\n"
8568 "Use \".filectrl --help\" for help\n", zCmd
);
8571 case SQLITE_FCNTL_SIZE_LIMIT
: {
8572 if( nArg
!=2 && nArg
!=3 ) break;
8573 iRes
= nArg
==3 ? integerValue(azArg
[2]) : -1;
8574 sqlite3_file_control(p
->db
, zSchema
, SQLITE_FCNTL_SIZE_LIMIT
, &iRes
);
8578 case SQLITE_FCNTL_LOCK_TIMEOUT
:
8579 case SQLITE_FCNTL_CHUNK_SIZE
: {
8581 if( nArg
!=3 ) break;
8582 x
= (int)integerValue(azArg
[2]);
8583 sqlite3_file_control(p
->db
, zSchema
, filectrl
, &x
);
8587 case SQLITE_FCNTL_PERSIST_WAL
:
8588 case SQLITE_FCNTL_POWERSAFE_OVERWRITE
: {
8590 if( nArg
!=2 && nArg
!=3 ) break;
8591 x
= nArg
==3 ? booleanValue(azArg
[2]) : -1;
8592 sqlite3_file_control(p
->db
, zSchema
, filectrl
, &x
);
8597 case SQLITE_FCNTL_DATA_VERSION
:
8598 case SQLITE_FCNTL_HAS_MOVED
: {
8600 if( nArg
!=2 ) break;
8601 sqlite3_file_control(p
->db
, zSchema
, filectrl
, &x
);
8606 case SQLITE_FCNTL_TEMPFILENAME
: {
8608 if( nArg
!=2 ) break;
8609 sqlite3_file_control(p
->db
, zSchema
, filectrl
, &z
);
8617 case SQLITE_FCNTL_RESERVE_BYTES
: {
8621 sqlite3_file_control(p
->db
, zSchema
, filectrl
, &x
);
8624 sqlite3_file_control(p
->db
, zSchema
, filectrl
, &x
);
8631 if( isOk
==0 && iCtrl
>=0 ){
8632 oputf("Usage: .filectrl %s %s\n", zCmd
,aCtrl
[iCtrl
].zUsage
);
8634 }else if( isOk
==1 ){
8636 sqlite3_snprintf(sizeof(zBuf
), zBuf
, "%lld", iRes
);
8637 oputf("%s\n", zBuf
);
8641 if( c
=='f' && cli_strncmp(azArg
[0], "fullschema", n
)==0 ){
8644 memcpy(&data
, p
, sizeof(data
));
8645 data
.showHeader
= 0;
8646 data
.cMode
= data
.mode
= MODE_Semi
;
8647 if( nArg
==2 && optionMatch(azArg
[1], "indent") ){
8648 data
.cMode
= data
.mode
= MODE_Pretty
;
8652 eputz("Usage: .fullschema ?--indent?\n");
8654 goto meta_command_exit
;
8657 rc
= sqlite3_exec(p
->db
,
8659 " (SELECT sql sql, type type, tbl_name tbl_name, name name, rowid x"
8660 " FROM sqlite_schema UNION ALL"
8661 " SELECT sql, type, tbl_name, name, rowid FROM sqlite_temp_schema) "
8662 "WHERE type!='meta' AND sql NOTNULL AND name NOT LIKE 'sqlite_%' "
8666 if( rc
==SQLITE_OK
){
8667 sqlite3_stmt
*pStmt
;
8668 rc
= sqlite3_prepare_v2(p
->db
,
8669 "SELECT rowid FROM sqlite_schema"
8670 " WHERE name GLOB 'sqlite_stat[134]'",
8672 if( rc
==SQLITE_OK
){
8673 doStats
= sqlite3_step(pStmt
)==SQLITE_ROW
;
8674 sqlite3_finalize(pStmt
);
8678 oputz("/* No STAT tables available */\n");
8680 oputz("ANALYZE sqlite_schema;\n");
8681 data
.cMode
= data
.mode
= MODE_Insert
;
8682 data
.zDestTable
= "sqlite_stat1";
8683 shell_exec(&data
, "SELECT * FROM sqlite_stat1", 0);
8684 data
.zDestTable
= "sqlite_stat4";
8685 shell_exec(&data
, "SELECT * FROM sqlite_stat4", 0);
8686 oputz("ANALYZE sqlite_schema;\n");
8690 if( c
=='h' && cli_strncmp(azArg
[0], "headers", n
)==0 ){
8692 p
->showHeader
= booleanValue(azArg
[1]);
8693 p
->shellFlgs
|= SHFLG_HeaderSet
;
8695 eputz("Usage: .headers on|off\n");
8700 if( c
=='h' && cli_strncmp(azArg
[0], "help", n
)==0 ){
8702 n
= showHelp(p
->out
, azArg
[1]);
8704 oputf("Nothing matches '%s'\n", azArg
[1]);
8707 showHelp(p
->out
, 0);
8711 #ifndef SQLITE_SHELL_FIDDLE
8712 if( c
=='i' && cli_strncmp(azArg
[0], "import", n
)==0 ){
8713 char *zTable
= 0; /* Insert data into this table */
8714 char *zSchema
= 0; /* Schema of zTable */
8715 char *zFile
= 0; /* Name of file to extra content from */
8716 sqlite3_stmt
*pStmt
= NULL
; /* A statement */
8717 int nCol
; /* Number of columns in the table */
8718 i64 nByte
; /* Number of bytes in an SQL string */
8719 int i
, j
; /* Loop counters */
8720 int needCommit
; /* True to COMMIT or ROLLBACK at end */
8721 int nSep
; /* Number of bytes in p->colSeparator[] */
8722 char *zSql
= 0; /* An SQL statement */
8723 ImportCtx sCtx
; /* Reader context */
8724 char *(SQLITE_CDECL
*xRead
)(ImportCtx
*); /* Func to read one value */
8725 int eVerbose
= 0; /* Larger for more console output */
8726 int nSkip
= 0; /* Initial lines to skip */
8727 int useOutputMode
= 1; /* Use output mode to determine separators */
8728 char *zCreate
= 0; /* CREATE TABLE statement text */
8730 failIfSafeMode(p
, "cannot run .import in safe mode");
8731 memset(&sCtx
, 0, sizeof(sCtx
));
8732 if( p
->mode
==MODE_Ascii
){
8733 xRead
= ascii_read_one_field
;
8735 xRead
= csv_read_one_field
;
8738 for(i
=1; i
<nArg
; i
++){
8740 if( z
[0]=='-' && z
[1]=='-' ) z
++;
8744 }else if( zTable
==0 ){
8747 oputf("ERROR: extra argument: \"%s\". Usage:\n", z
);
8748 showHelp(p
->out
, "import");
8749 goto meta_command_exit
;
8751 }else if( cli_strcmp(z
,"-v")==0 ){
8753 }else if( cli_strcmp(z
,"-schema")==0 && i
<nArg
-1 ){
8754 zSchema
= azArg
[++i
];
8755 }else if( cli_strcmp(z
,"-skip")==0 && i
<nArg
-1 ){
8756 nSkip
= integerValue(azArg
[++i
]);
8757 }else if( cli_strcmp(z
,"-ascii")==0 ){
8758 sCtx
.cColSep
= SEP_Unit
[0];
8759 sCtx
.cRowSep
= SEP_Record
[0];
8760 xRead
= ascii_read_one_field
;
8762 }else if( cli_strcmp(z
,"-csv")==0 ){
8764 sCtx
.cRowSep
= '\n';
8765 xRead
= csv_read_one_field
;
8768 oputf("ERROR: unknown option: \"%s\". Usage:\n", z
);
8769 showHelp(p
->out
, "import");
8770 goto meta_command_exit
;
8774 oputf("ERROR: missing %s argument. Usage:\n",
8775 zFile
==0 ? "FILE" : "TABLE");
8776 showHelp(p
->out
, "import");
8777 goto meta_command_exit
;
8781 if( useOutputMode
){
8782 /* If neither the --csv or --ascii options are specified, then set
8783 ** the column and row separator characters from the output mode. */
8784 nSep
= strlen30(p
->colSeparator
);
8786 eputz("Error: non-null column separator required for import\n");
8787 goto meta_command_exit
;
8790 eputz("Error: multi-character column separators not allowed"
8792 goto meta_command_exit
;
8794 nSep
= strlen30(p
->rowSeparator
);
8796 eputz("Error: non-null row separator required for import\n");
8797 goto meta_command_exit
;
8799 if( nSep
==2 && p
->mode
==MODE_Csv
8800 && cli_strcmp(p
->rowSeparator
,SEP_CrLf
)==0
8802 /* When importing CSV (only), if the row separator is set to the
8803 ** default output row separator, change it to the default input
8804 ** row separator. This avoids having to maintain different input
8805 ** and output row separators. */
8806 sqlite3_snprintf(sizeof(p
->rowSeparator
), p
->rowSeparator
, SEP_Row
);
8807 nSep
= strlen30(p
->rowSeparator
);
8810 eputz("Error: multi-character row separators not allowed"
8812 goto meta_command_exit
;
8814 sCtx
.cColSep
= (u8
)p
->colSeparator
[0];
8815 sCtx
.cRowSep
= (u8
)p
->rowSeparator
[0];
8819 if( sCtx
.zFile
[0]=='|' ){
8820 #ifdef SQLITE_OMIT_POPEN
8821 eputz("Error: pipes are not supported in this OS\n");
8822 goto meta_command_exit
;
8824 sCtx
.in
= popen(sCtx
.zFile
+1, "r");
8825 sCtx
.zFile
= "<pipe>";
8826 sCtx
.xCloser
= pclose
;
8829 sCtx
.in
= fopen(sCtx
.zFile
, "rb");
8830 sCtx
.xCloser
= fclose
;
8833 eputf("Error: cannot open \"%s\"\n", zFile
);
8834 goto meta_command_exit
;
8836 if( eVerbose
>=2 || (eVerbose
>=1 && useOutputMode
) ){
8839 zSep
[0] = sCtx
.cColSep
;
8840 oputz("Column separator ");
8841 output_c_string(zSep
);
8842 oputz(", row separator ");
8843 zSep
[0] = sCtx
.cRowSep
;
8844 output_c_string(zSep
);
8847 sCtx
.z
= sqlite3_malloc64(120);
8849 import_cleanup(&sCtx
);
8850 shell_out_of_memory();
8852 /* Below, resources must be freed before exit. */
8853 while( (nSkip
--)>0 ){
8854 while( xRead(&sCtx
) && sCtx
.cTerm
==sCtx
.cColSep
){}
8856 import_append_char(&sCtx
, 0); /* To ensure sCtx.z is allocated */
8857 if( sqlite3_table_column_metadata(p
->db
, zSchema
, zTable
,0,0,0,0,0,0) ){
8858 /* Table does not exist. Create it. */
8859 sqlite3
*dbCols
= 0;
8862 zCreate
= sqlite3_mprintf("CREATE TABLE \"%w\".\"%w\"",
8863 zSchema
? zSchema
: "main", zTable
);
8864 while( xRead(&sCtx
) ){
8865 zAutoColumn(sCtx
.z
, &dbCols
, 0);
8866 if( sCtx
.cTerm
!=sCtx
.cColSep
) break;
8868 zColDefs
= zAutoColumn(0, &dbCols
, &zRenames
);
8870 sputf((stdin_is_interactive
&& p
->in
==stdin
)? p
->out
: stderr
,
8871 "Columns renamed during .import %s due to duplicates:\n"
8872 "%s\n", sCtx
.zFile
, zRenames
);
8873 sqlite3_free(zRenames
);
8877 eputf("%s: empty file\n", sCtx
.zFile
);
8878 import_cleanup(&sCtx
);
8880 goto meta_command_exit
;
8882 zCreate
= sqlite3_mprintf("%z%z\n", zCreate
, zColDefs
);
8884 import_cleanup(&sCtx
);
8885 shell_out_of_memory();
8888 oputf("%s\n", zCreate
);
8890 rc
= sqlite3_exec(p
->db
, zCreate
, 0, 0, 0);
8891 sqlite3_free(zCreate
);
8894 eputf("%s failed:\n%s\n", zCreate
, sqlite3_errmsg(p
->db
));
8895 import_cleanup(&sCtx
);
8897 goto meta_command_exit
;
8900 zSql
= sqlite3_mprintf("SELECT count(*) FROM pragma_table_info(%Q,%Q);",
8903 import_cleanup(&sCtx
);
8904 shell_out_of_memory();
8906 nByte
= strlen(zSql
);
8907 rc
= sqlite3_prepare_v2(p
->db
, zSql
, -1, &pStmt
, 0);
8911 if (pStmt
) sqlite3_finalize(pStmt
);
8912 eputf("Error: %s\n", sqlite3_errmsg(p
->db
));
8913 import_cleanup(&sCtx
);
8915 goto meta_command_exit
;
8917 if( sqlite3_step(pStmt
)==SQLITE_ROW
){
8918 nCol
= sqlite3_column_int(pStmt
, 0);
8922 sqlite3_finalize(pStmt
);
8924 if( nCol
==0 ) return 0; /* no columns, no error */
8925 zSql
= sqlite3_malloc64( nByte
*2 + 20 + nCol
*2 );
8927 import_cleanup(&sCtx
);
8928 shell_out_of_memory();
8931 sqlite3_snprintf(nByte
+20, zSql
, "INSERT INTO \"%w\".\"%w\" VALUES(?",
8934 sqlite3_snprintf(nByte
+20, zSql
, "INSERT INTO \"%w\" VALUES(?", zTable
);
8937 for(i
=1; i
<nCol
; i
++){
8944 oputf("Insert using: %s\n", zSql
);
8946 rc
= sqlite3_prepare_v2(p
->db
, zSql
, -1, &pStmt
, 0);
8950 eputf("Error: %s\n", sqlite3_errmsg(p
->db
));
8951 if (pStmt
) sqlite3_finalize(pStmt
);
8952 import_cleanup(&sCtx
);
8954 goto meta_command_exit
;
8956 needCommit
= sqlite3_get_autocommit(p
->db
);
8957 if( needCommit
) sqlite3_exec(p
->db
, "BEGIN", 0, 0, 0);
8959 int startLine
= sCtx
.nLine
;
8960 for(i
=0; i
<nCol
; i
++){
8961 char *z
= xRead(&sCtx
);
8963 ** Did we reach end-of-file before finding any columns?
8964 ** If so, stop instead of NULL filling the remaining columns.
8966 if( z
==0 && i
==0 ) break;
8968 ** Did we reach end-of-file OR end-of-line before finding any
8969 ** columns in ASCII mode? If so, stop instead of NULL filling
8970 ** the remaining columns.
8972 if( p
->mode
==MODE_Ascii
&& (z
==0 || z
[0]==0) && i
==0 ) break;
8974 ** For CSV mode, per RFC 4180, accept EOF in lieu of final
8975 ** record terminator but only for last field of multi-field row.
8976 ** (If there are too few fields, it's not valid CSV anyway.)
8978 if( z
==0 && (xRead
==csv_read_one_field
) && i
==nCol
-1 && i
>0 ){
8981 sqlite3_bind_text(pStmt
, i
+1, z
, -1, SQLITE_TRANSIENT
);
8982 if( i
<nCol
-1 && sCtx
.cTerm
!=sCtx
.cColSep
){
8983 eputf("%s:%d: expected %d columns but found %d"
8984 " - filling the rest with NULL\n",
8985 sCtx
.zFile
, startLine
, nCol
, i
+1);
8987 while( i
<=nCol
){ sqlite3_bind_null(pStmt
, i
); i
++; }
8990 if( sCtx
.cTerm
==sCtx
.cColSep
){
8994 }while( sCtx
.cTerm
==sCtx
.cColSep
);
8995 eputf("%s:%d: expected %d columns but found %d - extras ignored\n",
8996 sCtx
.zFile
, startLine
, nCol
, i
);
8999 sqlite3_step(pStmt
);
9000 rc
= sqlite3_reset(pStmt
);
9001 if( rc
!=SQLITE_OK
){
9002 eputf("%s:%d: INSERT failed: %s\n",
9003 sCtx
.zFile
, startLine
, sqlite3_errmsg(p
->db
));
9009 }while( sCtx
.cTerm
!=EOF
);
9011 import_cleanup(&sCtx
);
9012 sqlite3_finalize(pStmt
);
9013 if( needCommit
) sqlite3_exec(p
->db
, "COMMIT", 0, 0, 0);
9015 oputf("Added %d rows with %d errors using %d lines of input\n",
9016 sCtx
.nRow
, sCtx
.nErr
, sCtx
.nLine
-1);
9019 #endif /* !defined(SQLITE_SHELL_FIDDLE) */
9021 #ifndef SQLITE_UNTESTABLE
9022 if( c
=='i' && cli_strncmp(azArg
[0], "imposter", n
)==0 ){
9025 sqlite3_stmt
*pStmt
;
9027 int isWO
= 0; /* True if making an imposter of a WITHOUT ROWID table */
9028 int lenPK
= 0; /* Length of the PRIMARY KEY string for isWO tables */
9030 if( !ShellHasFlag(p
,SHFLG_TestingMode
) ){
9031 eputf(".%s unavailable without --unsafe-testing\n",
9034 goto meta_command_exit
;
9036 if( !(nArg
==3 || (nArg
==2 && sqlite3_stricmp(azArg
[1],"off")==0)) ){
9037 eputz("Usage: .imposter INDEX IMPOSTER\n"
9038 " .imposter off\n");
9039 /* Also allowed, but not documented:
9041 ** .imposter TABLE IMPOSTER
9043 ** where TABLE is a WITHOUT ROWID table. In that case, the
9044 ** imposter is another WITHOUT ROWID table with the columns in
9045 ** storage order. */
9047 goto meta_command_exit
;
9051 sqlite3_test_control(SQLITE_TESTCTRL_IMPOSTER
, p
->db
, "main", 0, 1);
9052 goto meta_command_exit
;
9054 zSql
= sqlite3_mprintf(
9055 "SELECT rootpage, 0 FROM sqlite_schema"
9056 " WHERE name='%q' AND type='index'"
9058 "SELECT rootpage, 1 FROM sqlite_schema"
9059 " WHERE name='%q' AND type='table'"
9060 " AND sql LIKE '%%without%%rowid%%'",
9063 sqlite3_prepare_v2(p
->db
, zSql
, -1, &pStmt
, 0);
9065 if( sqlite3_step(pStmt
)==SQLITE_ROW
){
9066 tnum
= sqlite3_column_int(pStmt
, 0);
9067 isWO
= sqlite3_column_int(pStmt
, 1);
9069 sqlite3_finalize(pStmt
);
9070 zSql
= sqlite3_mprintf("PRAGMA index_xinfo='%q'", azArg
[1]);
9071 rc
= sqlite3_prepare_v2(p
->db
, zSql
, -1, &pStmt
, 0);
9074 while( rc
==SQLITE_OK
&& sqlite3_step(pStmt
)==SQLITE_ROW
){
9076 const char *zCol
= (const char*)sqlite3_column_text(pStmt
,2);
9079 if( sqlite3_column_int(pStmt
,1)==-1 ){
9082 sqlite3_snprintf(sizeof(zLabel
),zLabel
,"expr%d",i
);
9086 if( isWO
&& lenPK
==0 && sqlite3_column_int(pStmt
,5)==0 && zCollist
){
9087 lenPK
= (int)strlen(zCollist
);
9090 zCollist
= sqlite3_mprintf("\"%w\"", zCol
);
9092 zCollist
= sqlite3_mprintf("%z,\"%w\"", zCollist
, zCol
);
9095 sqlite3_finalize(pStmt
);
9096 if( i
==0 || tnum
==0 ){
9097 eputf("no such index: \"%s\"\n", azArg
[1]);
9099 sqlite3_free(zCollist
);
9100 goto meta_command_exit
;
9102 if( lenPK
==0 ) lenPK
= 100000;
9103 zSql
= sqlite3_mprintf(
9104 "CREATE TABLE \"%w\"(%s,PRIMARY KEY(%.*s))WITHOUT ROWID",
9105 azArg
[2], zCollist
, lenPK
, zCollist
);
9106 sqlite3_free(zCollist
);
9107 rc
= sqlite3_test_control(SQLITE_TESTCTRL_IMPOSTER
, p
->db
, "main", 1, tnum
);
9108 if( rc
==SQLITE_OK
){
9109 rc
= sqlite3_exec(p
->db
, zSql
, 0, 0, 0);
9110 sqlite3_test_control(SQLITE_TESTCTRL_IMPOSTER
, p
->db
, "main", 0, 0);
9112 eputf("Error in [%s]: %s\n", zSql
, sqlite3_errmsg(p
->db
));
9114 sputf(stdout
, "%s;\n", zSql
);
9115 sputf(stdout
, "WARNING: writing to an imposter table will corrupt"
9116 " the \"%s\" %s!\n", azArg
[1], isWO
? "table" : "index");
9119 eputf("SQLITE_TESTCTRL_IMPOSTER returns %d\n", rc
);
9124 #endif /* !defined(SQLITE_OMIT_TEST_CONTROL) */
9126 #ifdef SQLITE_ENABLE_IOTRACE
9127 if( c
=='i' && cli_strncmp(azArg
[0], "iotrace", n
)==0 ){
9128 SQLITE_API
extern void (SQLITE_CDECL
*sqlite3IoTrace
)(const char*, ...);
9129 if( iotrace
&& iotrace
!=stdout
) fclose(iotrace
);
9133 }else if( cli_strcmp(azArg
[1], "-")==0 ){
9134 sqlite3IoTrace
= iotracePrintf
;
9137 iotrace
= fopen(azArg
[1], "w");
9139 eputf("Error: cannot open \"%s\"\n", azArg
[1]);
9143 sqlite3IoTrace
= iotracePrintf
;
9149 if( c
=='l' && n
>=5 && cli_strncmp(azArg
[0], "limits", n
)==0 ){
9150 static const struct {
9151 const char *zLimitName
; /* Name of a limit */
9152 int limitCode
; /* Integer code for that limit */
9154 { "length", SQLITE_LIMIT_LENGTH
},
9155 { "sql_length", SQLITE_LIMIT_SQL_LENGTH
},
9156 { "column", SQLITE_LIMIT_COLUMN
},
9157 { "expr_depth", SQLITE_LIMIT_EXPR_DEPTH
},
9158 { "compound_select", SQLITE_LIMIT_COMPOUND_SELECT
},
9159 { "vdbe_op", SQLITE_LIMIT_VDBE_OP
},
9160 { "function_arg", SQLITE_LIMIT_FUNCTION_ARG
},
9161 { "attached", SQLITE_LIMIT_ATTACHED
},
9162 { "like_pattern_length", SQLITE_LIMIT_LIKE_PATTERN_LENGTH
},
9163 { "variable_number", SQLITE_LIMIT_VARIABLE_NUMBER
},
9164 { "trigger_depth", SQLITE_LIMIT_TRIGGER_DEPTH
},
9165 { "worker_threads", SQLITE_LIMIT_WORKER_THREADS
},
9170 for(i
=0; i
<ArraySize(aLimit
); i
++){
9171 sputf(stdout
, "%20s %d\n", aLimit
[i
].zLimitName
,
9172 sqlite3_limit(p
->db
, aLimit
[i
].limitCode
, -1));
9175 eputz("Usage: .limit NAME ?NEW-VALUE?\n");
9177 goto meta_command_exit
;
9180 n2
= strlen30(azArg
[1]);
9181 for(i
=0; i
<ArraySize(aLimit
); i
++){
9182 if( sqlite3_strnicmp(aLimit
[i
].zLimitName
, azArg
[1], n2
)==0 ){
9186 eputf("ambiguous limit: \"%s\"\n", azArg
[1]);
9188 goto meta_command_exit
;
9193 eputf("unknown limit: \"%s\"\n"
9194 "enter \".limits\" with no arguments for a list.\n",
9197 goto meta_command_exit
;
9200 sqlite3_limit(p
->db
, aLimit
[iLimit
].limitCode
,
9201 (int)integerValue(azArg
[2]));
9203 sputf(stdout
, "%20s %d\n", aLimit
[iLimit
].zLimitName
,
9204 sqlite3_limit(p
->db
, aLimit
[iLimit
].limitCode
, -1));
9208 if( c
=='l' && n
>2 && cli_strncmp(azArg
[0], "lint", n
)==0 ){
9210 lintDotCommand(p
, azArg
, nArg
);
9213 #if !defined(SQLITE_OMIT_LOAD_EXTENSION) && !defined(SQLITE_SHELL_FIDDLE)
9214 if( c
=='l' && cli_strncmp(azArg
[0], "load", n
)==0 ){
9215 const char *zFile
, *zProc
;
9217 failIfSafeMode(p
, "cannot run .load in safe mode");
9218 if( nArg
<2 || azArg
[1][0]==0 ){
9219 /* Must have a non-empty FILE. (Will not load self.) */
9220 eputz("Usage: .load FILE ?ENTRYPOINT?\n");
9222 goto meta_command_exit
;
9225 zProc
= nArg
>=3 ? azArg
[2] : 0;
9227 rc
= sqlite3_load_extension(p
->db
, zFile
, zProc
, &zErrMsg
);
9228 if( rc
!=SQLITE_OK
){
9229 eputf("Error: %s\n", zErrMsg
);
9230 sqlite3_free(zErrMsg
);
9236 if( c
=='l' && cli_strncmp(azArg
[0], "log", n
)==0 ){
9238 eputz("Usage: .log FILENAME\n");
9241 const char *zFile
= azArg
[1];
9243 && cli_strcmp(zFile
,"on")!=0
9244 && cli_strcmp(zFile
,"off")!=0
9246 sputz(stdout
, "cannot set .log to anything other"
9247 " than \"on\" or \"off\"\n");
9250 output_file_close(p
->pLog
);
9251 if( cli_strcmp(zFile
,"on")==0 ) zFile
= "stdout";
9252 p
->pLog
= output_file_open(zFile
, 0);
9256 if( c
=='m' && cli_strncmp(azArg
[0], "mode", n
)==0 ){
9257 const char *zMode
= 0;
9258 const char *zTabname
= 0;
9260 ColModeOpts cmOpts
= ColModeOpts_default
;
9261 for(i
=1; i
<nArg
; i
++){
9262 const char *z
= azArg
[i
];
9263 if( optionMatch(z
,"wrap") && i
+1<nArg
){
9264 cmOpts
.iWrap
= integerValue(azArg
[++i
]);
9265 }else if( optionMatch(z
,"ww") ){
9266 cmOpts
.bWordWrap
= 1;
9267 }else if( optionMatch(z
,"wordwrap") && i
+1<nArg
){
9268 cmOpts
.bWordWrap
= (u8
)booleanValue(azArg
[++i
]);
9269 }else if( optionMatch(z
,"quote") ){
9271 }else if( optionMatch(z
,"noquote") ){
9273 }else if( zMode
==0 ){
9275 /* Apply defaults for qbox pseudo-mode. If that
9276 * overwrites already-set values, user was informed of this.
9278 if( cli_strcmp(z
, "qbox")==0 ){
9279 ColModeOpts cmo
= ColModeOpts_default_qbox
;
9283 }else if( zTabname
==0 ){
9285 }else if( z
[0]=='-' ){
9286 eputf("unknown option: %s\n", z
);
9290 " --wordwrap on/off\n"
9294 goto meta_command_exit
;
9296 eputf("extra argument: \"%s\"\n", z
);
9298 goto meta_command_exit
;
9302 if( p
->mode
==MODE_Column
9303 || (p
->mode
>=MODE_Markdown
&& p
->mode
<=MODE_Box
)
9305 oputf("current output mode: %s --wrap %d --wordwrap %s --%squote\n",
9306 modeDescr
[p
->mode
], p
->cmOpts
.iWrap
,
9307 p
->cmOpts
.bWordWrap
? "on" : "off",
9308 p
->cmOpts
.bQuote
? "" : "no");
9310 oputf("current output mode: %s\n", modeDescr
[p
->mode
]);
9312 zMode
= modeDescr
[p
->mode
];
9314 n2
= strlen30(zMode
);
9315 if( cli_strncmp(zMode
,"lines",n2
)==0 ){
9316 p
->mode
= MODE_Line
;
9317 sqlite3_snprintf(sizeof(p
->rowSeparator
), p
->rowSeparator
, SEP_Row
);
9318 }else if( cli_strncmp(zMode
,"columns",n2
)==0 ){
9319 p
->mode
= MODE_Column
;
9320 if( (p
->shellFlgs
& SHFLG_HeaderSet
)==0 ){
9323 sqlite3_snprintf(sizeof(p
->rowSeparator
), p
->rowSeparator
, SEP_Row
);
9325 }else if( cli_strncmp(zMode
,"list",n2
)==0 ){
9326 p
->mode
= MODE_List
;
9327 sqlite3_snprintf(sizeof(p
->colSeparator
), p
->colSeparator
, SEP_Column
);
9328 sqlite3_snprintf(sizeof(p
->rowSeparator
), p
->rowSeparator
, SEP_Row
);
9329 }else if( cli_strncmp(zMode
,"html",n2
)==0 ){
9330 p
->mode
= MODE_Html
;
9331 }else if( cli_strncmp(zMode
,"tcl",n2
)==0 ){
9333 sqlite3_snprintf(sizeof(p
->colSeparator
), p
->colSeparator
, SEP_Space
);
9334 sqlite3_snprintf(sizeof(p
->rowSeparator
), p
->rowSeparator
, SEP_Row
);
9335 }else if( cli_strncmp(zMode
,"csv",n2
)==0 ){
9337 sqlite3_snprintf(sizeof(p
->colSeparator
), p
->colSeparator
, SEP_Comma
);
9338 sqlite3_snprintf(sizeof(p
->rowSeparator
), p
->rowSeparator
, SEP_CrLf
);
9339 }else if( cli_strncmp(zMode
,"tabs",n2
)==0 ){
9340 p
->mode
= MODE_List
;
9341 sqlite3_snprintf(sizeof(p
->colSeparator
), p
->colSeparator
, SEP_Tab
);
9342 }else if( cli_strncmp(zMode
,"insert",n2
)==0 ){
9343 p
->mode
= MODE_Insert
;
9344 set_table_name(p
, zTabname
? zTabname
: "table");
9345 }else if( cli_strncmp(zMode
,"quote",n2
)==0 ){
9346 p
->mode
= MODE_Quote
;
9347 sqlite3_snprintf(sizeof(p
->colSeparator
), p
->colSeparator
, SEP_Comma
);
9348 sqlite3_snprintf(sizeof(p
->rowSeparator
), p
->rowSeparator
, SEP_Row
);
9349 }else if( cli_strncmp(zMode
,"ascii",n2
)==0 ){
9350 p
->mode
= MODE_Ascii
;
9351 sqlite3_snprintf(sizeof(p
->colSeparator
), p
->colSeparator
, SEP_Unit
);
9352 sqlite3_snprintf(sizeof(p
->rowSeparator
), p
->rowSeparator
, SEP_Record
);
9353 }else if( cli_strncmp(zMode
,"markdown",n2
)==0 ){
9354 p
->mode
= MODE_Markdown
;
9356 }else if( cli_strncmp(zMode
,"table",n2
)==0 ){
9357 p
->mode
= MODE_Table
;
9359 }else if( cli_strncmp(zMode
,"box",n2
)==0 ){
9362 }else if( cli_strncmp(zMode
,"count",n2
)==0 ){
9363 p
->mode
= MODE_Count
;
9364 }else if( cli_strncmp(zMode
,"off",n2
)==0 ){
9366 }else if( cli_strncmp(zMode
,"json",n2
)==0 ){
9367 p
->mode
= MODE_Json
;
9369 eputz("Error: mode should be one of: "
9370 "ascii box column csv html insert json line list markdown "
9371 "qbox quote table tabs tcl\n");
9377 #ifndef SQLITE_SHELL_FIDDLE
9378 if( c
=='n' && cli_strcmp(azArg
[0], "nonce")==0 ){
9380 eputz("Usage: .nonce NONCE\n");
9382 }else if( p
->zNonce
==0 || cli_strcmp(azArg
[1],p
->zNonce
)!=0 ){
9383 eputf("line %d: incorrect nonce: \"%s\"\n",
9384 p
->lineno
, azArg
[1]);
9388 return 0; /* Return immediately to bypass the safe mode reset
9389 ** at the end of this procedure */
9392 #endif /* !defined(SQLITE_SHELL_FIDDLE) */
9394 if( c
=='n' && cli_strncmp(azArg
[0], "nullvalue", n
)==0 ){
9396 sqlite3_snprintf(sizeof(p
->nullValue
), p
->nullValue
,
9397 "%.*s", (int)ArraySize(p
->nullValue
)-1, azArg
[1]);
9399 eputz("Usage: .nullvalue STRING\n");
9404 if( c
=='o' && cli_strncmp(azArg
[0], "open", n
)==0 && n
>=2 ){
9405 const char *zFN
= 0; /* Pointer to constant filename */
9406 char *zNewFilename
= 0; /* Name of the database file to open */
9407 int iName
= 1; /* Index in azArg[] of the filename */
9408 int newFlag
= 0; /* True to delete file before opening */
9409 int openMode
= SHELL_OPEN_UNSPEC
;
9411 /* Check for command-line arguments */
9412 for(iName
=1; iName
<nArg
; iName
++){
9413 const char *z
= azArg
[iName
];
9414 #ifndef SQLITE_SHELL_FIDDLE
9415 if( optionMatch(z
,"new") ){
9417 #ifdef SQLITE_HAVE_ZLIB
9418 }else if( optionMatch(z
, "zip") ){
9419 openMode
= SHELL_OPEN_ZIPFILE
;
9421 }else if( optionMatch(z
, "append") ){
9422 openMode
= SHELL_OPEN_APPENDVFS
;
9423 }else if( optionMatch(z
, "readonly") ){
9424 openMode
= SHELL_OPEN_READONLY
;
9425 }else if( optionMatch(z
, "nofollow") ){
9426 p
->openFlags
|= SQLITE_OPEN_NOFOLLOW
;
9427 #ifndef SQLITE_OMIT_DESERIALIZE
9428 }else if( optionMatch(z
, "deserialize") ){
9429 openMode
= SHELL_OPEN_DESERIALIZE
;
9430 }else if( optionMatch(z
, "hexdb") ){
9431 openMode
= SHELL_OPEN_HEXDB
;
9432 }else if( optionMatch(z
, "maxsize") && iName
+1<nArg
){
9433 p
->szMax
= integerValue(azArg
[++iName
]);
9434 #endif /* SQLITE_OMIT_DESERIALIZE */
9436 #endif /* !SQLITE_SHELL_FIDDLE */
9438 eputf("unknown option: %s\n", z
);
9440 goto meta_command_exit
;
9442 eputf("extra argument: \"%s\"\n", z
);
9444 goto meta_command_exit
;
9450 /* Close the existing database */
9451 session_close_all(p
, -1);
9454 p
->pAuxDb
->zDbFilename
= 0;
9455 sqlite3_free(p
->pAuxDb
->zFreeOnClose
);
9456 p
->pAuxDb
->zFreeOnClose
= 0;
9457 p
->openMode
= openMode
;
9461 /* If a filename is specified, try to open it first */
9462 if( zFN
|| p
->openMode
==SHELL_OPEN_HEXDB
){
9463 if( newFlag
&& zFN
&& !p
->bSafeMode
) shellDeleteFile(zFN
);
9464 #ifndef SQLITE_SHELL_FIDDLE
9466 && p
->openMode
!=SHELL_OPEN_HEXDB
9468 && cli_strcmp(zFN
,":memory:")!=0
9470 failIfSafeMode(p
, "cannot open disk-based database files in safe mode");
9473 /* WASM mode has its own sandboxed pseudo-filesystem. */
9476 zNewFilename
= sqlite3_mprintf("%s", zFN
);
9477 shell_check_oom(zNewFilename
);
9481 p
->pAuxDb
->zDbFilename
= zNewFilename
;
9482 open_db(p
, OPEN_DB_KEEPALIVE
);
9484 eputf("Error: cannot open '%s'\n", zNewFilename
);
9485 sqlite3_free(zNewFilename
);
9487 p
->pAuxDb
->zFreeOnClose
= zNewFilename
;
9491 /* As a fall-back open a TEMP database */
9492 p
->pAuxDb
->zDbFilename
= 0;
9497 #ifndef SQLITE_SHELL_FIDDLE
9499 && (cli_strncmp(azArg
[0], "output", n
)==0
9500 || cli_strncmp(azArg
[0], "once", n
)==0))
9501 || (c
=='e' && n
==5 && cli_strcmp(azArg
[0],"excel")==0)
9507 int bOnce
= 0; /* 0: .output, 1: .once, 2: .excel */
9508 static const char *zBomUtf8
= "\xef\xbb\xbf";
9509 const char *zBom
= 0;
9511 failIfSafeMode(p
, "cannot run .%s in safe mode", azArg
[0]);
9515 }else if( cli_strncmp(azArg
[0],"once",n
)==0 ){
9518 for(i
=1; i
<nArg
; i
++){
9521 if( z
[1]=='-' ) z
++;
9522 if( cli_strcmp(z
,"-bom")==0 ){
9524 }else if( c
!='e' && cli_strcmp(z
,"-x")==0 ){
9525 eMode
= 'x'; /* spreadsheet */
9526 }else if( c
!='e' && cli_strcmp(z
,"-e")==0 ){
9527 eMode
= 'e'; /* text editor */
9529 oputf("ERROR: unknown option: \"%s\". Usage:\n", azArg
[i
]);
9530 showHelp(p
->out
, azArg
[0]);
9532 goto meta_command_exit
;
9534 }else if( zFile
==0 && eMode
!='e' && eMode
!='x' ){
9535 zFile
= sqlite3_mprintf("%s", z
);
9536 if( zFile
&& zFile
[0]=='|' ){
9537 while( i
+1<nArg
) zFile
= sqlite3_mprintf("%z %s", zFile
, azArg
[++i
]);
9541 oputf("ERROR: extra parameter: \"%s\". Usage:\n", azArg
[i
]);
9542 showHelp(p
->out
, azArg
[0]);
9544 sqlite3_free(zFile
);
9545 goto meta_command_exit
;
9549 zFile
= sqlite3_mprintf("stdout");
9557 #ifndef SQLITE_NOHAVE_SYSTEM
9558 if( eMode
=='e' || eMode
=='x' ){
9562 /* spreadsheet mode. Output as CSV. */
9563 newTempFile(p
, "csv");
9564 ShellClearFlag(p
, SHFLG_Echo
);
9566 sqlite3_snprintf(sizeof(p
->colSeparator
), p
->colSeparator
, SEP_Comma
);
9567 sqlite3_snprintf(sizeof(p
->rowSeparator
), p
->rowSeparator
, SEP_CrLf
);
9569 /* text editor mode */
9570 newTempFile(p
, "txt");
9573 sqlite3_free(zFile
);
9574 zFile
= sqlite3_mprintf("%s", p
->zTempFile
);
9576 #endif /* SQLITE_NOHAVE_SYSTEM */
9577 shell_check_oom(zFile
);
9578 if( zFile
[0]=='|' ){
9579 #ifdef SQLITE_OMIT_POPEN
9580 eputz("Error: pipes are not supported in this OS\n");
9582 output_redir(p
, stdout
);
9584 FILE *pfPipe
= popen(zFile
+ 1, "w");
9586 eputf("Error: cannot open pipe \"%s\"\n", zFile
+ 1);
9589 output_redir(p
, pfPipe
);
9590 if( zBom
) oputz(zBom
);
9591 sqlite3_snprintf(sizeof(p
->outfile
), p
->outfile
, "%s", zFile
);
9595 FILE *pfFile
= output_file_open(zFile
, bTxtMode
);
9597 if( cli_strcmp(zFile
,"off")!=0 ){
9598 eputf("Error: cannot write to \"%s\"\n", zFile
);
9602 output_redir(p
, pfFile
);
9603 if( zBom
) oputz(zBom
);
9604 sqlite3_snprintf(sizeof(p
->outfile
), p
->outfile
, "%s", zFile
);
9607 sqlite3_free(zFile
);
9609 #endif /* !defined(SQLITE_SHELL_FIDDLE) */
9611 if( c
=='p' && n
>=3 && cli_strncmp(azArg
[0], "parameter", n
)==0 ){
9613 if( nArg
<=1 ) goto parameter_syntax_error
;
9616 ** Clear all bind parameters by dropping the TEMP table that holds them.
9618 if( nArg
==2 && cli_strcmp(azArg
[1],"clear")==0 ){
9619 sqlite3_exec(p
->db
, "DROP TABLE IF EXISTS temp.sqlite_parameters;",
9624 ** List all bind parameters.
9626 if( nArg
==2 && cli_strcmp(azArg
[1],"list")==0 ){
9627 sqlite3_stmt
*pStmt
= 0;
9630 rx
= sqlite3_prepare_v2(p
->db
,
9631 "SELECT max(length(key)) "
9632 "FROM temp.sqlite_parameters;", -1, &pStmt
, 0);
9633 if( rx
==SQLITE_OK
&& sqlite3_step(pStmt
)==SQLITE_ROW
){
9634 len
= sqlite3_column_int(pStmt
, 0);
9635 if( len
>40 ) len
= 40;
9637 sqlite3_finalize(pStmt
);
9640 rx
= sqlite3_prepare_v2(p
->db
,
9641 "SELECT key, quote(value) "
9642 "FROM temp.sqlite_parameters;", -1, &pStmt
, 0);
9643 while( rx
==SQLITE_OK
&& sqlite3_step(pStmt
)==SQLITE_ROW
){
9644 oputf("%-*s %s\n", len
, sqlite3_column_text(pStmt
,0),
9645 sqlite3_column_text(pStmt
,1));
9647 sqlite3_finalize(pStmt
);
9652 ** Make sure the TEMP table used to hold bind parameters exists.
9653 ** Create it if necessary.
9655 if( nArg
==2 && cli_strcmp(azArg
[1],"init")==0 ){
9659 /* .parameter set NAME VALUE
9660 ** Set or reset a bind parameter. NAME should be the full parameter
9661 ** name exactly as it appears in the query. (ex: $abc, @def). The
9662 ** VALUE can be in either SQL literal notation, or if not it will be
9663 ** understood to be a text string.
9665 if( nArg
==4 && cli_strcmp(azArg
[1],"set")==0 ){
9668 sqlite3_stmt
*pStmt
;
9669 const char *zKey
= azArg
[2];
9670 const char *zValue
= azArg
[3];
9672 zSql
= sqlite3_mprintf(
9673 "REPLACE INTO temp.sqlite_parameters(key,value)"
9674 "VALUES(%Q,%s);", zKey
, zValue
);
9675 shell_check_oom(zSql
);
9677 rx
= sqlite3_prepare_v2(p
->db
, zSql
, -1, &pStmt
, 0);
9679 if( rx
!=SQLITE_OK
){
9680 sqlite3_finalize(pStmt
);
9682 zSql
= sqlite3_mprintf(
9683 "REPLACE INTO temp.sqlite_parameters(key,value)"
9684 "VALUES(%Q,%Q);", zKey
, zValue
);
9685 shell_check_oom(zSql
);
9686 rx
= sqlite3_prepare_v2(p
->db
, zSql
, -1, &pStmt
, 0);
9688 if( rx
!=SQLITE_OK
){
9689 oputf("Error: %s\n", sqlite3_errmsg(p
->db
));
9690 sqlite3_finalize(pStmt
);
9695 sqlite3_step(pStmt
);
9696 sqlite3_finalize(pStmt
);
9699 /* .parameter unset NAME
9700 ** Remove the NAME binding from the parameter binding table, if it
9703 if( nArg
==3 && cli_strcmp(azArg
[1],"unset")==0 ){
9704 char *zSql
= sqlite3_mprintf(
9705 "DELETE FROM temp.sqlite_parameters WHERE key=%Q", azArg
[2]);
9706 shell_check_oom(zSql
);
9707 sqlite3_exec(p
->db
, zSql
, 0, 0, 0);
9710 /* If no command name matches, show a syntax error */
9711 parameter_syntax_error
:
9712 showHelp(p
->out
, "parameter");
9715 if( c
=='p' && n
>=3 && cli_strncmp(azArg
[0], "print", n
)==0 ){
9717 for(i
=1; i
<nArg
; i
++){
9718 if( i
>1 ) oputz(" ");
9724 #ifndef SQLITE_OMIT_PROGRESS_CALLBACK
9725 if( c
=='p' && n
>=3 && cli_strncmp(azArg
[0], "progress", n
)==0 ){
9731 for(i
=1; i
<nArg
; i
++){
9732 const char *z
= azArg
[i
];
9735 if( z
[0]=='-' ) z
++;
9736 if( cli_strcmp(z
,"quiet")==0 || cli_strcmp(z
,"q")==0 ){
9737 p
->flgProgress
|= SHELL_PROGRESS_QUIET
;
9740 if( cli_strcmp(z
,"reset")==0 ){
9741 p
->flgProgress
|= SHELL_PROGRESS_RESET
;
9744 if( cli_strcmp(z
,"once")==0 ){
9745 p
->flgProgress
|= SHELL_PROGRESS_ONCE
;
9748 if( cli_strcmp(z
,"limit")==0 ){
9750 eputz("Error: missing argument on --limit\n");
9752 goto meta_command_exit
;
9754 p
->mxProgress
= (int)integerValue(azArg
[++i
]);
9758 eputf("Error: unknown option: \"%s\"\n", azArg
[i
]);
9760 goto meta_command_exit
;
9762 nn
= (int)integerValue(z
);
9766 sqlite3_progress_handler(p
->db
, nn
, progress_handler
, p
);
9768 #endif /* SQLITE_OMIT_PROGRESS_CALLBACK */
9770 if( c
=='p' && cli_strncmp(azArg
[0], "prompt", n
)==0 ){
9772 shell_strncpy(mainPrompt
,azArg
[1],(int)ArraySize(mainPrompt
)-1);
9775 shell_strncpy(continuePrompt
,azArg
[2],(int)ArraySize(continuePrompt
)-1);
9779 #ifndef SQLITE_SHELL_FIDDLE
9780 if( c
=='q' && cli_strncmp(azArg
[0], "quit", n
)==0 ){
9785 #ifndef SQLITE_SHELL_FIDDLE
9786 if( c
=='r' && n
>=3 && cli_strncmp(azArg
[0], "read", n
)==0 ){
9787 FILE *inSaved
= p
->in
;
9788 int savedLineno
= p
->lineno
;
9789 failIfSafeMode(p
, "cannot run .read in safe mode");
9791 eputz("Usage: .read FILE\n");
9793 goto meta_command_exit
;
9795 if( azArg
[1][0]=='|' ){
9796 #ifdef SQLITE_OMIT_POPEN
9797 eputz("Error: pipes are not supported in this OS\n");
9801 p
->in
= popen(azArg
[1]+1, "r");
9803 eputf("Error: cannot open \"%s\"\n", azArg
[1]);
9806 rc
= process_input(p
);
9810 }else if( (p
->in
= openChrSource(azArg
[1]))==0 ){
9811 eputf("Error: cannot open \"%s\"\n", azArg
[1]);
9814 rc
= process_input(p
);
9818 p
->lineno
= savedLineno
;
9820 #endif /* !defined(SQLITE_SHELL_FIDDLE) */
9822 #ifndef SQLITE_SHELL_FIDDLE
9823 if( c
=='r' && n
>=3 && cli_strncmp(azArg
[0], "restore", n
)==0 ){
9824 const char *zSrcFile
;
9827 sqlite3_backup
*pBackup
;
9830 failIfSafeMode(p
, "cannot run .restore in safe mode");
9832 zSrcFile
= azArg
[1];
9834 }else if( nArg
==3 ){
9835 zSrcFile
= azArg
[2];
9838 eputz("Usage: .restore ?DB? FILE\n");
9840 goto meta_command_exit
;
9842 rc
= sqlite3_open(zSrcFile
, &pSrc
);
9843 if( rc
!=SQLITE_OK
){
9844 eputf("Error: cannot open \"%s\"\n", zSrcFile
);
9849 pBackup
= sqlite3_backup_init(p
->db
, zDb
, pSrc
, "main");
9851 eputf("Error: %s\n", sqlite3_errmsg(p
->db
));
9855 while( (rc
= sqlite3_backup_step(pBackup
,100))==SQLITE_OK
9856 || rc
==SQLITE_BUSY
){
9857 if( rc
==SQLITE_BUSY
){
9858 if( nTimeout
++ >= 3 ) break;
9862 sqlite3_backup_finish(pBackup
);
9863 if( rc
==SQLITE_DONE
){
9865 }else if( rc
==SQLITE_BUSY
|| rc
==SQLITE_LOCKED
){
9866 eputz("Error: source database is busy\n");
9869 eputf("Error: %s\n", sqlite3_errmsg(p
->db
));
9874 #endif /* !defined(SQLITE_SHELL_FIDDLE) */
9876 if( c
=='s' && cli_strncmp(azArg
[0], "scanstats", n
)==0 ){
9878 if( cli_strcmp(azArg
[1], "vm")==0 ){
9881 if( cli_strcmp(azArg
[1], "est")==0 ){
9884 p
->scanstatsOn
= (u8
)booleanValue(azArg
[1]);
9888 p
->db
, SQLITE_DBCONFIG_STMT_SCANSTATUS
, p
->scanstatsOn
, (int*)0
9890 #if !defined(SQLITE_ENABLE_STMT_SCANSTATUS)
9891 eputz("Warning: .scanstats not available in this build.\n");
9892 #elif !defined(SQLITE_ENABLE_BYTECODE_VTAB)
9893 if( p
->scanstatsOn
==3 ){
9894 eputz("Warning: \".scanstats vm\" not available in this build.\n");
9898 eputz("Usage: .scanstats on|off|est\n");
9903 if( c
=='s' && cli_strncmp(azArg
[0], "schema", n
)==0 ){
9907 const char *zDiv
= "(";
9908 const char *zName
= 0;
9911 int bNoSystemTabs
= 0;
9915 memcpy(&data
, p
, sizeof(data
));
9916 data
.showHeader
= 0;
9917 data
.cMode
= data
.mode
= MODE_Semi
;
9919 for(ii
=1; ii
<nArg
; ii
++){
9920 if( optionMatch(azArg
[ii
],"indent") ){
9921 data
.cMode
= data
.mode
= MODE_Pretty
;
9922 }else if( optionMatch(azArg
[ii
],"debug") ){
9924 }else if( optionMatch(azArg
[ii
],"nosys") ){
9926 }else if( azArg
[ii
][0]=='-' ){
9927 eputf("Unknown option: \"%s\"\n", azArg
[ii
]);
9929 goto meta_command_exit
;
9930 }else if( zName
==0 ){
9933 eputz("Usage: .schema ?--indent? ?--nosys? ?LIKE-PATTERN?\n");
9935 goto meta_command_exit
;
9939 int isSchema
= sqlite3_strlike(zName
, "sqlite_master", '\\')==0
9940 || sqlite3_strlike(zName
, "sqlite_schema", '\\')==0
9941 || sqlite3_strlike(zName
,"sqlite_temp_master", '\\')==0
9942 || sqlite3_strlike(zName
,"sqlite_temp_schema", '\\')==0;
9944 char *new_argv
[2], *new_colv
[2];
9945 new_argv
[0] = sqlite3_mprintf(
9946 "CREATE TABLE %s (\n"
9950 " rootpage integer,\n"
9953 shell_check_oom(new_argv
[0]);
9955 new_colv
[0] = "sql";
9957 callback(&data
, 1, new_argv
, new_colv
);
9958 sqlite3_free(new_argv
[0]);
9962 sqlite3_stmt
*pStmt
= 0;
9963 rc
= sqlite3_prepare_v2(p
->db
, "SELECT name FROM pragma_database_list",
9966 eputf("Error: %s\n", sqlite3_errmsg(p
->db
));
9967 sqlite3_finalize(pStmt
);
9969 goto meta_command_exit
;
9971 appendText(&sSelect
, "SELECT sql FROM", 0);
9973 while( sqlite3_step(pStmt
)==SQLITE_ROW
){
9974 const char *zDb
= (const char*)sqlite3_column_text(pStmt
, 0);
9976 sqlite3_snprintf(sizeof(zScNum
), zScNum
, "%d", ++iSchema
);
9977 appendText(&sSelect
, zDiv
, 0);
9978 zDiv
= " UNION ALL ";
9979 appendText(&sSelect
, "SELECT shell_add_schema(sql,", 0);
9980 if( sqlite3_stricmp(zDb
, "main")!=0 ){
9981 appendText(&sSelect
, zDb
, '\'');
9983 appendText(&sSelect
, "NULL", 0);
9985 appendText(&sSelect
, ",name) AS sql, type, tbl_name, name, rowid,", 0);
9986 appendText(&sSelect
, zScNum
, 0);
9987 appendText(&sSelect
, " AS snum, ", 0);
9988 appendText(&sSelect
, zDb
, '\'');
9989 appendText(&sSelect
, " AS sname FROM ", 0);
9990 appendText(&sSelect
, zDb
, quoteChar(zDb
));
9991 appendText(&sSelect
, ".sqlite_schema", 0);
9993 sqlite3_finalize(pStmt
);
9994 #ifndef SQLITE_OMIT_INTROSPECTION_PRAGMAS
9996 appendText(&sSelect
,
9997 " UNION ALL SELECT shell_module_schema(name),"
9998 " 'table', name, name, name, 9e+99, 'main' FROM pragma_module_list",
10002 appendText(&sSelect
, ") WHERE ", 0);
10004 char *zQarg
= sqlite3_mprintf("%Q", zName
);
10006 shell_check_oom(zQarg
);
10007 bGlob
= strchr(zName
, '*') != 0 || strchr(zName
, '?') != 0 ||
10008 strchr(zName
, '[') != 0;
10009 if( strchr(zName
, '.') ){
10010 appendText(&sSelect
, "lower(printf('%s.%s',sname,tbl_name))", 0);
10012 appendText(&sSelect
, "lower(tbl_name)", 0);
10014 appendText(&sSelect
, bGlob
? " GLOB " : " LIKE ", 0);
10015 appendText(&sSelect
, zQarg
, 0);
10017 appendText(&sSelect
, " ESCAPE '\\' ", 0);
10019 appendText(&sSelect
, " AND ", 0);
10020 sqlite3_free(zQarg
);
10022 if( bNoSystemTabs
){
10023 appendText(&sSelect
, "name NOT LIKE 'sqlite_%%' AND ", 0);
10025 appendText(&sSelect
, "sql IS NOT NULL"
10026 " ORDER BY snum, rowid", 0);
10028 oputf("SQL: %s;\n", sSelect
.z
);
10030 rc
= sqlite3_exec(p
->db
, sSelect
.z
, callback
, &data
, &zErrMsg
);
10032 freeText(&sSelect
);
10035 eputf("Error: %s\n", zErrMsg
);
10036 sqlite3_free(zErrMsg
);
10038 }else if( rc
!= SQLITE_OK
){
10039 eputz("Error: querying schema information\n");
10046 if( (c
=='s' && n
==11 && cli_strncmp(azArg
[0], "selecttrace", n
)==0)
10047 || (c
=='t' && n
==9 && cli_strncmp(azArg
[0], "treetrace", n
)==0)
10049 unsigned int x
= nArg
>=2? (unsigned int)integerValue(azArg
[1]) : 0xffffffff;
10050 sqlite3_test_control(SQLITE_TESTCTRL_TRACEFLAGS
, 1, &x
);
10053 #if defined(SQLITE_ENABLE_SESSION)
10054 if( c
=='s' && cli_strncmp(azArg
[0],"session",n
)==0 && n
>=3 ){
10055 struct AuxDb
*pAuxDb
= p
->pAuxDb
;
10056 OpenSession
*pSession
= &pAuxDb
->aSession
[0];
10057 char **azCmd
= &azArg
[1];
10059 int nCmd
= nArg
- 1;
10061 if( nArg
<=1 ) goto session_syntax_error
;
10064 for(iSes
=0; iSes
<pAuxDb
->nSession
; iSes
++){
10065 if( cli_strcmp(pAuxDb
->aSession
[iSes
].zName
, azArg
[1])==0 ) break;
10067 if( iSes
<pAuxDb
->nSession
){
10068 pSession
= &pAuxDb
->aSession
[iSes
];
10072 pSession
= &pAuxDb
->aSession
[0];
10077 /* .session attach TABLE
10078 ** Invoke the sqlite3session_attach() interface to attach a particular
10079 ** table so that it is never filtered.
10081 if( cli_strcmp(azCmd
[0],"attach")==0 ){
10082 if( nCmd
!=2 ) goto session_syntax_error
;
10083 if( pSession
->p
==0 ){
10085 eputz("ERROR: No sessions are open\n");
10087 rc
= sqlite3session_attach(pSession
->p
, azCmd
[1]);
10089 eputf("ERROR: sqlite3session_attach() returns %d\n",rc
);
10095 /* .session changeset FILE
10096 ** .session patchset FILE
10097 ** Write a changeset or patchset into a file. The file is overwritten.
10099 if( cli_strcmp(azCmd
[0],"changeset")==0
10100 || cli_strcmp(azCmd
[0],"patchset")==0
10103 failIfSafeMode(p
, "cannot run \".session %s\" in safe mode", azCmd
[0]);
10104 if( nCmd
!=2 ) goto session_syntax_error
;
10105 if( pSession
->p
==0 ) goto session_not_open
;
10106 out
= fopen(azCmd
[1], "wb");
10108 eputf("ERROR: cannot open \"%s\" for writing\n",
10113 if( azCmd
[0][0]=='c' ){
10114 rc
= sqlite3session_changeset(pSession
->p
, &szChng
, &pChng
);
10116 rc
= sqlite3session_patchset(pSession
->p
, &szChng
, &pChng
);
10119 sputf(stdout
, "Error: error code %d\n", rc
);
10123 && fwrite(pChng
, szChng
, 1, out
)!=1 ){
10124 eputf("ERROR: Failed to write entire %d-byte output\n", szChng
);
10126 sqlite3_free(pChng
);
10132 ** Close the identified session
10134 if( cli_strcmp(azCmd
[0], "close")==0 ){
10135 if( nCmd
!=1 ) goto session_syntax_error
;
10136 if( pAuxDb
->nSession
){
10137 session_close(pSession
);
10138 pAuxDb
->aSession
[iSes
] = pAuxDb
->aSession
[--pAuxDb
->nSession
];
10142 /* .session enable ?BOOLEAN?
10143 ** Query or set the enable flag
10145 if( cli_strcmp(azCmd
[0], "enable")==0 ){
10147 if( nCmd
>2 ) goto session_syntax_error
;
10148 ii
= nCmd
==1 ? -1 : booleanValue(azCmd
[1]);
10149 if( pAuxDb
->nSession
){
10150 ii
= sqlite3session_enable(pSession
->p
, ii
);
10151 oputf("session %s enable flag = %d\n", pSession
->zName
, ii
);
10155 /* .session filter GLOB ....
10156 ** Set a list of GLOB patterns of table names to be excluded.
10158 if( cli_strcmp(azCmd
[0], "filter")==0 ){
10160 if( nCmd
<2 ) goto session_syntax_error
;
10161 if( pAuxDb
->nSession
){
10162 for(ii
=0; ii
<pSession
->nFilter
; ii
++){
10163 sqlite3_free(pSession
->azFilter
[ii
]);
10165 sqlite3_free(pSession
->azFilter
);
10166 nByte
= sizeof(pSession
->azFilter
[0])*(nCmd
-1);
10167 pSession
->azFilter
= sqlite3_malloc( nByte
);
10168 shell_check_oom( pSession
->azFilter
);
10169 for(ii
=1; ii
<nCmd
; ii
++){
10170 char *x
= pSession
->azFilter
[ii
-1] = sqlite3_mprintf("%s", azCmd
[ii
]);
10171 shell_check_oom(x
);
10173 pSession
->nFilter
= ii
-1;
10177 /* .session indirect ?BOOLEAN?
10178 ** Query or set the indirect flag
10180 if( cli_strcmp(azCmd
[0], "indirect")==0 ){
10182 if( nCmd
>2 ) goto session_syntax_error
;
10183 ii
= nCmd
==1 ? -1 : booleanValue(azCmd
[1]);
10184 if( pAuxDb
->nSession
){
10185 ii
= sqlite3session_indirect(pSession
->p
, ii
);
10186 oputf("session %s indirect flag = %d\n", pSession
->zName
, ii
);
10190 /* .session isempty
10191 ** Determine if the session is empty
10193 if( cli_strcmp(azCmd
[0], "isempty")==0 ){
10195 if( nCmd
!=1 ) goto session_syntax_error
;
10196 if( pAuxDb
->nSession
){
10197 ii
= sqlite3session_isempty(pSession
->p
);
10198 oputf("session %s isempty flag = %d\n", pSession
->zName
, ii
);
10203 ** List all currently open sessions
10205 if( cli_strcmp(azCmd
[0],"list")==0 ){
10206 for(i
=0; i
<pAuxDb
->nSession
; i
++){
10207 oputf("%d %s\n", i
, pAuxDb
->aSession
[i
].zName
);
10211 /* .session open DB NAME
10212 ** Open a new session called NAME on the attached database DB.
10213 ** DB is normally "main".
10215 if( cli_strcmp(azCmd
[0],"open")==0 ){
10217 if( nCmd
!=3 ) goto session_syntax_error
;
10219 if( zName
[0]==0 ) goto session_syntax_error
;
10220 for(i
=0; i
<pAuxDb
->nSession
; i
++){
10221 if( cli_strcmp(pAuxDb
->aSession
[i
].zName
,zName
)==0 ){
10222 eputf("Session \"%s\" already exists\n", zName
);
10223 goto meta_command_exit
;
10226 if( pAuxDb
->nSession
>=ArraySize(pAuxDb
->aSession
) ){
10227 eputf("Maximum of %d sessions\n", ArraySize(pAuxDb
->aSession
));
10228 goto meta_command_exit
;
10230 pSession
= &pAuxDb
->aSession
[pAuxDb
->nSession
];
10231 rc
= sqlite3session_create(p
->db
, azCmd
[1], &pSession
->p
);
10233 eputf("Cannot open session: error code=%d\n", rc
);
10235 goto meta_command_exit
;
10237 pSession
->nFilter
= 0;
10238 sqlite3session_table_filter(pSession
->p
, session_filter
, pSession
);
10239 pAuxDb
->nSession
++;
10240 pSession
->zName
= sqlite3_mprintf("%s", zName
);
10241 shell_check_oom(pSession
->zName
);
10243 /* If no command name matches, show a syntax error */
10244 session_syntax_error
:
10245 showHelp(p
->out
, "session");
10249 #ifdef SQLITE_DEBUG
10250 /* Undocumented commands for internal testing. Subject to change
10251 ** without notice. */
10252 if( c
=='s' && n
>=10 && cli_strncmp(azArg
[0], "selftest-", 9)==0 ){
10253 if( cli_strncmp(azArg
[0]+9, "boolean", n
-9)==0 ){
10255 for(i
=1; i
<nArg
; i
++){
10256 v
= booleanValue(azArg
[i
]);
10257 oputf("%s: %d 0x%x\n", azArg
[i
], v
, v
);
10260 if( cli_strncmp(azArg
[0]+9, "integer", n
-9)==0 ){
10261 int i
; sqlite3_int64 v
;
10262 for(i
=1; i
<nArg
; i
++){
10264 v
= integerValue(azArg
[i
]);
10265 sqlite3_snprintf(sizeof(zBuf
),zBuf
,"%s: %lld 0x%llx\n", azArg
[i
],v
,v
);
10272 if( c
=='s' && n
>=4 && cli_strncmp(azArg
[0],"selftest",n
)==0 ){
10273 int bIsInit
= 0; /* True to initialize the SELFTEST table */
10274 int bVerbose
= 0; /* Verbose output */
10275 int bSelftestExists
; /* True if SELFTEST already exists */
10276 int i
, k
; /* Loop counters */
10277 int nTest
= 0; /* Number of tests runs */
10278 int nErr
= 0; /* Number of errors seen */
10279 ShellText str
; /* Answer for a query */
10280 sqlite3_stmt
*pStmt
= 0; /* Query against the SELFTEST table */
10283 for(i
=1; i
<nArg
; i
++){
10284 const char *z
= azArg
[i
];
10285 if( z
[0]=='-' && z
[1]=='-' ) z
++;
10286 if( cli_strcmp(z
,"-init")==0 ){
10289 if( cli_strcmp(z
,"-v")==0 ){
10293 eputf("Unknown option \"%s\" on \"%s\"\n", azArg
[i
], azArg
[0]);
10294 eputz("Should be one of: --init -v\n");
10296 goto meta_command_exit
;
10299 if( sqlite3_table_column_metadata(p
->db
,"main","selftest",0,0,0,0,0,0)
10301 bSelftestExists
= 0;
10303 bSelftestExists
= 1;
10306 createSelftestTable(p
);
10307 bSelftestExists
= 1;
10310 appendText(&str
, "x", 0);
10311 for(k
=bSelftestExists
; k
>=0; k
--){
10313 rc
= sqlite3_prepare_v2(p
->db
,
10314 "SELECT tno,op,cmd,ans FROM selftest ORDER BY tno",
10317 rc
= sqlite3_prepare_v2(p
->db
,
10318 "VALUES(0,'memo','Missing SELFTEST table - default checks only',''),"
10319 " (1,'run','PRAGMA integrity_check','ok')",
10323 eputz("Error querying the selftest table\n");
10325 sqlite3_finalize(pStmt
);
10326 goto meta_command_exit
;
10328 for(i
=1; sqlite3_step(pStmt
)==SQLITE_ROW
; i
++){
10329 int tno
= sqlite3_column_int(pStmt
, 0);
10330 const char *zOp
= (const char*)sqlite3_column_text(pStmt
, 1);
10331 const char *zSql
= (const char*)sqlite3_column_text(pStmt
, 2);
10332 const char *zAns
= (const char*)sqlite3_column_text(pStmt
, 3);
10334 if( zOp
==0 ) continue;
10335 if( zSql
==0 ) continue;
10336 if( zAns
==0 ) continue;
10339 sputf(stdout
, "%d: %s %s\n", tno
, zOp
, zSql
);
10341 if( cli_strcmp(zOp
,"memo")==0 ){
10342 oputf("%s\n", zSql
);
10344 if( cli_strcmp(zOp
,"run")==0 ){
10348 rc
= sqlite3_exec(p
->db
, zSql
, captureOutputCallback
, &str
, &zErrMsg
);
10351 oputf("Result: %s\n", str
.z
);
10353 if( rc
|| zErrMsg
){
10356 oputf("%d: error-code-%d: %s\n", tno
, rc
, zErrMsg
);
10357 sqlite3_free(zErrMsg
);
10358 }else if( cli_strcmp(zAns
,str
.z
)!=0 ){
10361 oputf("%d: Expected: [%s]\n", tno
, zAns
);
10362 oputf("%d: Got: [%s]\n", tno
, str
.z
);
10366 eputf("Unknown operation \"%s\" on selftest line %d\n", zOp
, tno
);
10370 } /* End loop over rows of content from SELFTEST */
10371 sqlite3_finalize(pStmt
);
10372 } /* End loop over k */
10374 oputf("%d errors out of %d tests\n", nErr
, nTest
);
10377 if( c
=='s' && cli_strncmp(azArg
[0], "separator", n
)==0 ){
10378 if( nArg
<2 || nArg
>3 ){
10379 eputz("Usage: .separator COL ?ROW?\n");
10383 sqlite3_snprintf(sizeof(p
->colSeparator
), p
->colSeparator
,
10384 "%.*s", (int)ArraySize(p
->colSeparator
)-1, azArg
[1]);
10387 sqlite3_snprintf(sizeof(p
->rowSeparator
), p
->rowSeparator
,
10388 "%.*s", (int)ArraySize(p
->rowSeparator
)-1, azArg
[2]);
10392 if( c
=='s' && n
>=4 && cli_strncmp(azArg
[0],"sha3sum",n
)==0 ){
10393 const char *zLike
= 0; /* Which table to checksum. 0 means everything */
10394 int i
; /* Loop counter */
10395 int bSchema
= 0; /* Also hash the schema */
10396 int bSeparate
= 0; /* Hash each table separately */
10397 int iSize
= 224; /* Hash algorithm to use */
10398 int bDebug
= 0; /* Only show the query that would have run */
10399 sqlite3_stmt
*pStmt
; /* For querying tables names */
10400 char *zSql
; /* SQL to be run */
10401 char *zSep
; /* Separator */
10402 ShellText sSql
; /* Complete SQL for the query to run the hash */
10403 ShellText sQuery
; /* Set of queries used to read all content */
10405 for(i
=1; i
<nArg
; i
++){
10406 const char *z
= azArg
[i
];
10409 if( z
[0]=='-' ) z
++;
10410 if( cli_strcmp(z
,"schema")==0 ){
10413 if( cli_strcmp(z
,"sha3-224")==0 || cli_strcmp(z
,"sha3-256")==0
10414 || cli_strcmp(z
,"sha3-384")==0 || cli_strcmp(z
,"sha3-512")==0
10416 iSize
= atoi(&z
[5]);
10418 if( cli_strcmp(z
,"debug")==0 ){
10422 eputf("Unknown option \"%s\" on \"%s\"\n", azArg
[i
], azArg
[0]);
10423 showHelp(p
->out
, azArg
[0]);
10425 goto meta_command_exit
;
10428 eputz("Usage: .sha3sum ?OPTIONS? ?LIKE-PATTERN?\n");
10430 goto meta_command_exit
;
10434 if( sqlite3_strlike("sqlite\\_%", zLike
, '\\')==0 ) bSchema
= 1;
10438 zSql
= "SELECT lower(name) as tname FROM sqlite_schema"
10439 " WHERE type='table' AND coalesce(rootpage,0)>1"
10440 " UNION ALL SELECT 'sqlite_schema'"
10441 " ORDER BY 1 collate nocase";
10443 zSql
= "SELECT lower(name) as tname FROM sqlite_schema"
10444 " WHERE type='table' AND coalesce(rootpage,0)>1"
10445 " AND name NOT LIKE 'sqlite_%'"
10446 " ORDER BY 1 collate nocase";
10448 sqlite3_prepare_v2(p
->db
, zSql
, -1, &pStmt
, 0);
10451 appendText(&sSql
, "WITH [sha3sum$query](a,b) AS(",0);
10453 while( SQLITE_ROW
==sqlite3_step(pStmt
) ){
10454 const char *zTab
= (const char*)sqlite3_column_text(pStmt
,0);
10455 if( zTab
==0 ) continue;
10456 if( zLike
&& sqlite3_strlike(zLike
, zTab
, 0)!=0 ) continue;
10457 if( cli_strncmp(zTab
, "sqlite_",7)!=0 ){
10458 appendText(&sQuery
,"SELECT * FROM ", 0);
10459 appendText(&sQuery
,zTab
,'"');
10460 appendText(&sQuery
," NOT INDEXED;", 0);
10461 }else if( cli_strcmp(zTab
, "sqlite_schema")==0 ){
10462 appendText(&sQuery
,"SELECT type,name,tbl_name,sql FROM sqlite_schema"
10463 " ORDER BY name;", 0);
10464 }else if( cli_strcmp(zTab
, "sqlite_sequence")==0 ){
10465 appendText(&sQuery
,"SELECT name,seq FROM sqlite_sequence"
10466 " ORDER BY name;", 0);
10467 }else if( cli_strcmp(zTab
, "sqlite_stat1")==0 ){
10468 appendText(&sQuery
,"SELECT tbl,idx,stat FROM sqlite_stat1"
10469 " ORDER BY tbl,idx;", 0);
10470 }else if( cli_strcmp(zTab
, "sqlite_stat4")==0 ){
10471 appendText(&sQuery
, "SELECT * FROM ", 0);
10472 appendText(&sQuery
, zTab
, 0);
10473 appendText(&sQuery
, " ORDER BY tbl, idx, rowid;\n", 0);
10475 appendText(&sSql
, zSep
, 0);
10476 appendText(&sSql
, sQuery
.z
, '\'');
10478 appendText(&sSql
, ",", 0);
10479 appendText(&sSql
, zTab
, '\'');
10482 sqlite3_finalize(pStmt
);
10484 zSql
= sqlite3_mprintf(
10486 " SELECT lower(hex(sha3_query(a,%d))) AS hash, b AS label"
10487 " FROM [sha3sum$query]",
10490 zSql
= sqlite3_mprintf(
10492 " SELECT lower(hex(sha3_query(group_concat(a,''),%d))) AS hash"
10493 " FROM [sha3sum$query]",
10496 shell_check_oom(zSql
);
10500 oputf("%s\n", zSql
);
10502 shell_exec(p
, zSql
, 0);
10504 #if !defined(SQLITE_OMIT_SCHEMA_PRAGMAS) && !defined(SQLITE_OMIT_VIRTUALTABLE)
10507 char *zRevText
= /* Query for reversible to-blob-to-text check */
10508 "SELECT lower(name) as tname FROM sqlite_schema\n"
10509 "WHERE type='table' AND coalesce(rootpage,0)>1\n"
10510 "AND name NOT LIKE 'sqlite_%%'%s\n"
10511 "ORDER BY 1 collate nocase";
10512 zRevText
= sqlite3_mprintf(zRevText
, zLike
? " AND name LIKE $tspec" : "");
10513 zRevText
= sqlite3_mprintf(
10514 /* lower-case query is first run, producing upper-case query. */
10515 "with tabcols as materialized(\n"
10516 "select tname, cname\n"
10518 " select printf('\"%%w\"',ss.tname) as tname,"
10519 " printf('\"%%w\"',ti.name) as cname\n"
10520 " from (%z) ss\n inner join pragma_table_info(tname) ti))\n"
10521 "select 'SELECT total(bad_text_count) AS bad_text_count\n"
10522 "FROM ('||group_concat(query, ' UNION ALL ')||')' as btc_query\n"
10523 " from (select 'SELECT COUNT(*) AS bad_text_count\n"
10524 "FROM '||tname||' WHERE '\n"
10525 "||group_concat('CAST(CAST('||cname||' AS BLOB) AS TEXT)<>'||cname\n"
10526 "|| ' AND typeof('||cname||')=''text'' ',\n"
10527 "' OR ') as query, tname from tabcols group by tname)"
10529 shell_check_oom(zRevText
);
10530 if( bDebug
) oputf("%s\n", zRevText
);
10531 lrc
= sqlite3_prepare_v2(p
->db
, zRevText
, -1, &pStmt
, 0);
10532 if( lrc
!=SQLITE_OK
){
10533 /* assert(lrc==SQLITE_NOMEM); // might also be SQLITE_ERROR if the
10534 ** user does cruel and unnatural things like ".limit expr_depth 0". */
10537 if( zLike
) sqlite3_bind_text(pStmt
,1,zLike
,-1,SQLITE_STATIC
);
10538 lrc
= SQLITE_ROW
==sqlite3_step(pStmt
);
10540 const char *zGenQuery
= (char*)sqlite3_column_text(pStmt
,0);
10541 sqlite3_stmt
*pCheckStmt
;
10542 lrc
= sqlite3_prepare_v2(p
->db
, zGenQuery
, -1, &pCheckStmt
, 0);
10543 if( bDebug
) oputf("%s\n", zGenQuery
);
10544 if( lrc
!=SQLITE_OK
){
10547 if( SQLITE_ROW
==sqlite3_step(pCheckStmt
) ){
10548 double countIrreversible
= sqlite3_column_double(pCheckStmt
, 0);
10549 if( countIrreversible
>0 ){
10550 int sz
= (int)(countIrreversible
+ 0.5);
10551 eputf("Digest includes %d invalidly encoded text field%s.\n",
10552 sz
, (sz
>1)? "s": "");
10555 sqlite3_finalize(pCheckStmt
);
10557 sqlite3_finalize(pStmt
);
10560 if( rc
) eputz(".sha3sum failed.\n");
10561 sqlite3_free(zRevText
);
10563 #endif /* !defined(*_OMIT_SCHEMA_PRAGMAS) && !defined(*_OMIT_VIRTUALTABLE) */
10564 sqlite3_free(zSql
);
10567 #if !defined(SQLITE_NOHAVE_SYSTEM) && !defined(SQLITE_SHELL_FIDDLE)
10569 && (cli_strncmp(azArg
[0], "shell", n
)==0
10570 || cli_strncmp(azArg
[0],"system",n
)==0)
10574 failIfSafeMode(p
, "cannot run .%s in safe mode", azArg
[0]);
10576 eputz("Usage: .system COMMAND\n");
10578 goto meta_command_exit
;
10580 zCmd
= sqlite3_mprintf(strchr(azArg
[1],' ')==0?"%s":"\"%s\"", azArg
[1]);
10581 for(i
=2; i
<nArg
&& zCmd
!=0; i
++){
10582 zCmd
= sqlite3_mprintf(strchr(azArg
[i
],' ')==0?"%z %s":"%z \"%s\"",
10586 x
= zCmd
!=0 ? system(zCmd
) : 1;
10587 consoleRenewSetup();
10588 sqlite3_free(zCmd
);
10589 if( x
) eputf("System command returns %d\n", x
);
10591 #endif /* !defined(SQLITE_NOHAVE_SYSTEM) && !defined(SQLITE_SHELL_FIDDLE) */
10593 if( c
=='s' && cli_strncmp(azArg
[0], "show", n
)==0 ){
10594 static const char *azBool
[] = { "off", "on", "trigger", "full"};
10598 eputz("Usage: .show\n");
10600 goto meta_command_exit
;
10602 oputf("%12.12s: %s\n","echo",
10603 azBool
[ShellHasFlag(p
, SHFLG_Echo
)]);
10604 oputf("%12.12s: %s\n","eqp", azBool
[p
->autoEQP
&3]);
10605 oputf("%12.12s: %s\n","explain",
10606 p
->mode
==MODE_Explain
? "on" : p
->autoExplain
? "auto" : "off");
10607 oputf("%12.12s: %s\n","headers", azBool
[p
->showHeader
!=0]);
10608 if( p
->mode
==MODE_Column
10609 || (p
->mode
>=MODE_Markdown
&& p
->mode
<=MODE_Box
)
10611 oputf("%12.12s: %s --wrap %d --wordwrap %s --%squote\n", "mode",
10612 modeDescr
[p
->mode
], p
->cmOpts
.iWrap
,
10613 p
->cmOpts
.bWordWrap
? "on" : "off",
10614 p
->cmOpts
.bQuote
? "" : "no");
10616 oputf("%12.12s: %s\n","mode", modeDescr
[p
->mode
]);
10618 oputf("%12.12s: ", "nullvalue");
10619 output_c_string(p
->nullValue
);
10621 oputf("%12.12s: %s\n","output",
10622 strlen30(p
->outfile
) ? p
->outfile
: "stdout");
10623 oputf("%12.12s: ", "colseparator");
10624 output_c_string(p
->colSeparator
);
10626 oputf("%12.12s: ", "rowseparator");
10627 output_c_string(p
->rowSeparator
);
10629 switch( p
->statsOn
){
10630 case 0: zOut
= "off"; break;
10631 default: zOut
= "on"; break;
10632 case 2: zOut
= "stmt"; break;
10633 case 3: zOut
= "vmstep"; break;
10635 oputf("%12.12s: %s\n","stats", zOut
);
10636 oputf("%12.12s: ", "width");
10637 for (i
=0;i
<p
->nWidth
;i
++) {
10638 oputf("%d ", p
->colWidth
[i
]);
10641 oputf("%12.12s: %s\n", "filename",
10642 p
->pAuxDb
->zDbFilename
? p
->pAuxDb
->zDbFilename
: "");
10645 if( c
=='s' && cli_strncmp(azArg
[0], "stats", n
)==0 ){
10647 if( cli_strcmp(azArg
[1],"stmt")==0 ){
10649 }else if( cli_strcmp(azArg
[1],"vmstep")==0 ){
10652 p
->statsOn
= (u8
)booleanValue(azArg
[1]);
10654 }else if( nArg
==1 ){
10655 display_stats(p
->db
, p
, 0);
10657 eputz("Usage: .stats ?on|off|stmt|vmstep?\n");
10662 if( (c
=='t' && n
>1 && cli_strncmp(azArg
[0], "tables", n
)==0)
10663 || (c
=='i' && (cli_strncmp(azArg
[0], "indices", n
)==0
10664 || cli_strncmp(azArg
[0], "indexes", n
)==0) )
10666 sqlite3_stmt
*pStmt
;
10673 rc
= sqlite3_prepare_v2(p
->db
, "PRAGMA database_list", -1, &pStmt
, 0);
10675 sqlite3_finalize(pStmt
);
10676 return shellDatabaseError(p
->db
);
10679 if( nArg
>2 && c
=='i' ){
10680 /* It is an historical accident that the .indexes command shows an error
10681 ** when called with the wrong number of arguments whereas the .tables
10682 ** command does not. */
10683 eputz("Usage: .indexes ?LIKE-PATTERN?\n");
10685 sqlite3_finalize(pStmt
);
10686 goto meta_command_exit
;
10688 for(ii
=0; sqlite3_step(pStmt
)==SQLITE_ROW
; ii
++){
10689 const char *zDbName
= (const char*)sqlite3_column_text(pStmt
, 1);
10690 if( zDbName
==0 ) continue;
10691 if( s
.z
&& s
.z
[0] ) appendText(&s
, " UNION ALL ", 0);
10692 if( sqlite3_stricmp(zDbName
, "main")==0 ){
10693 appendText(&s
, "SELECT name FROM ", 0);
10695 appendText(&s
, "SELECT ", 0);
10696 appendText(&s
, zDbName
, '\'');
10697 appendText(&s
, "||'.'||name FROM ", 0);
10699 appendText(&s
, zDbName
, '"');
10700 appendText(&s
, ".sqlite_schema ", 0);
10702 appendText(&s
," WHERE type IN ('table','view')"
10703 " AND name NOT LIKE 'sqlite_%'"
10704 " AND name LIKE ?1", 0);
10706 appendText(&s
," WHERE type='index'"
10707 " AND tbl_name LIKE ?1", 0);
10710 rc
= sqlite3_finalize(pStmt
);
10711 if( rc
==SQLITE_OK
){
10712 appendText(&s
, " ORDER BY 1", 0);
10713 rc
= sqlite3_prepare_v2(p
->db
, s
.z
, -1, &pStmt
, 0);
10716 if( rc
) return shellDatabaseError(p
->db
);
10718 /* Run the SQL statement prepared by the above block. Store the results
10719 ** as an array of nul-terminated strings in azResult[]. */
10723 sqlite3_bind_text(pStmt
, 1, azArg
[1], -1, SQLITE_TRANSIENT
);
10725 sqlite3_bind_text(pStmt
, 1, "%", -1, SQLITE_STATIC
);
10727 while( sqlite3_step(pStmt
)==SQLITE_ROW
){
10728 if( nRow
>=nAlloc
){
10730 int n2
= nAlloc
*2 + 10;
10731 azNew
= sqlite3_realloc64(azResult
, sizeof(azResult
[0])*n2
);
10732 shell_check_oom(azNew
);
10736 azResult
[nRow
] = sqlite3_mprintf("%s", sqlite3_column_text(pStmt
, 0));
10737 shell_check_oom(azResult
[nRow
]);
10740 if( sqlite3_finalize(pStmt
)!=SQLITE_OK
){
10741 rc
= shellDatabaseError(p
->db
);
10744 /* Pretty-print the contents of array azResult[] to the output */
10745 if( rc
==0 && nRow
>0 ){
10746 int len
, maxlen
= 0;
10748 int nPrintCol
, nPrintRow
;
10749 for(i
=0; i
<nRow
; i
++){
10750 len
= strlen30(azResult
[i
]);
10751 if( len
>maxlen
) maxlen
= len
;
10753 nPrintCol
= 80/(maxlen
+2);
10754 if( nPrintCol
<1 ) nPrintCol
= 1;
10755 nPrintRow
= (nRow
+ nPrintCol
- 1)/nPrintCol
;
10756 for(i
=0; i
<nPrintRow
; i
++){
10757 for(j
=i
; j
<nRow
; j
+=nPrintRow
){
10758 char *zSp
= j
<nPrintRow
? "" : " ";
10759 oputf("%s%-*s", zSp
, maxlen
, azResult
[j
] ? azResult
[j
]:"");
10765 for(ii
=0; ii
<nRow
; ii
++) sqlite3_free(azResult
[ii
]);
10766 sqlite3_free(azResult
);
10769 #ifndef SQLITE_SHELL_FIDDLE
10770 /* Begin redirecting output to the file "testcase-out.txt" */
10771 if( c
=='t' && cli_strcmp(azArg
[0],"testcase")==0 ){
10773 p
->out
= output_file_open("testcase-out.txt", 0);
10775 eputz("Error: cannot open 'testcase-out.txt'\n");
10778 sqlite3_snprintf(sizeof(p
->zTestcase
), p
->zTestcase
, "%s", azArg
[1]);
10780 sqlite3_snprintf(sizeof(p
->zTestcase
), p
->zTestcase
, "?");
10783 #endif /* !defined(SQLITE_SHELL_FIDDLE) */
10785 #ifndef SQLITE_UNTESTABLE
10786 if( c
=='t' && n
>=8 && cli_strncmp(azArg
[0], "testctrl", n
)==0 ){
10787 static const struct {
10788 const char *zCtrlName
; /* Name of a test-control option */
10789 int ctrlCode
; /* Integer code for that option */
10790 int unSafe
; /* Not valid unless --unsafe-testing */
10791 const char *zUsage
; /* Usage notes */
10793 {"always", SQLITE_TESTCTRL_ALWAYS
, 1, "BOOLEAN" },
10794 {"assert", SQLITE_TESTCTRL_ASSERT
, 1, "BOOLEAN" },
10795 /*{"benign_malloc_hooks",SQLITE_TESTCTRL_BENIGN_MALLOC_HOOKS,1, "" },*/
10796 /*{"bitvec_test", SQLITE_TESTCTRL_BITVEC_TEST, 1, "" },*/
10797 {"byteorder", SQLITE_TESTCTRL_BYTEORDER
, 0, "" },
10798 {"extra_schema_checks",SQLITE_TESTCTRL_EXTRA_SCHEMA_CHECKS
,0,"BOOLEAN" },
10799 /*{"fault_install", SQLITE_TESTCTRL_FAULT_INSTALL, 1,"" },*/
10800 {"fk_no_action", SQLITE_TESTCTRL_FK_NO_ACTION
, 0, "BOOLEAN" },
10801 {"imposter", SQLITE_TESTCTRL_IMPOSTER
,1,"SCHEMA ON/OFF ROOTPAGE"},
10802 {"internal_functions", SQLITE_TESTCTRL_INTERNAL_FUNCTIONS
,0,"" },
10803 {"json_selfcheck", SQLITE_TESTCTRL_JSON_SELFCHECK
,0,"BOOLEAN" },
10804 {"localtime_fault", SQLITE_TESTCTRL_LOCALTIME_FAULT
,0,"BOOLEAN" },
10805 {"never_corrupt", SQLITE_TESTCTRL_NEVER_CORRUPT
,1, "BOOLEAN" },
10806 {"optimizations", SQLITE_TESTCTRL_OPTIMIZATIONS
,0,"DISABLE-MASK" },
10808 {"parser_coverage", SQLITE_TESTCTRL_PARSER_COVERAGE
,0,"" },
10810 {"pending_byte", SQLITE_TESTCTRL_PENDING_BYTE
,0, "OFFSET " },
10811 {"prng_restore", SQLITE_TESTCTRL_PRNG_RESTORE
,0, "" },
10812 {"prng_save", SQLITE_TESTCTRL_PRNG_SAVE
, 0, "" },
10813 {"prng_seed", SQLITE_TESTCTRL_PRNG_SEED
, 0, "SEED ?db?" },
10814 {"seek_count", SQLITE_TESTCTRL_SEEK_COUNT
, 0, "" },
10815 {"sorter_mmap", SQLITE_TESTCTRL_SORTER_MMAP
, 0, "NMAX" },
10816 {"tune", SQLITE_TESTCTRL_TUNE
, 1, "ID VALUE" },
10817 {"uselongdouble", SQLITE_TESTCTRL_USELONGDOUBLE
,0,"?BOOLEAN|\"default\"?"},
10821 int rc2
= 0; /* 0: usage. 1: %d 2: %x 3: no-output */
10824 const char *zCmd
= 0;
10827 zCmd
= nArg
>=2 ? azArg
[1] : "help";
10829 /* The argument can optionally begin with "-" or "--" */
10830 if( zCmd
[0]=='-' && zCmd
[1] ){
10832 if( zCmd
[0]=='-' && zCmd
[1] ) zCmd
++;
10835 /* --help lists all test-controls */
10836 if( cli_strcmp(zCmd
,"help")==0 ){
10837 oputz("Available test-controls:\n");
10838 for(i
=0; i
<ArraySize(aCtrl
); i
++){
10839 if( aCtrl
[i
].unSafe
&& !ShellHasFlag(p
,SHFLG_TestingMode
) ) continue;
10840 oputf(" .testctrl %s %s\n",
10841 aCtrl
[i
].zCtrlName
, aCtrl
[i
].zUsage
);
10844 goto meta_command_exit
;
10847 /* convert testctrl text option to value. allow any unique prefix
10848 ** of the option name, or a numerical value. */
10849 n2
= strlen30(zCmd
);
10850 for(i
=0; i
<ArraySize(aCtrl
); i
++){
10851 if( aCtrl
[i
].unSafe
&& !ShellHasFlag(p
,SHFLG_TestingMode
) ) continue;
10852 if( cli_strncmp(zCmd
, aCtrl
[i
].zCtrlName
, n2
)==0 ){
10854 testctrl
= aCtrl
[i
].ctrlCode
;
10857 eputf("Error: ambiguous test-control: \"%s\"\n"
10858 "Use \".testctrl --help\" for help\n", zCmd
);
10860 goto meta_command_exit
;
10865 eputf("Error: unknown test-control: %s\n"
10866 "Use \".testctrl --help\" for help\n", zCmd
);
10870 /* sqlite3_test_control(int, db, int) */
10871 case SQLITE_TESTCTRL_OPTIMIZATIONS
:
10872 case SQLITE_TESTCTRL_FK_NO_ACTION
:
10874 unsigned int opt
= (unsigned int)strtol(azArg
[2], 0, 0);
10875 rc2
= sqlite3_test_control(testctrl
, p
->db
, opt
);
10880 /* sqlite3_test_control(int) */
10881 case SQLITE_TESTCTRL_PRNG_SAVE
:
10882 case SQLITE_TESTCTRL_PRNG_RESTORE
:
10883 case SQLITE_TESTCTRL_BYTEORDER
:
10885 rc2
= sqlite3_test_control(testctrl
);
10886 isOk
= testctrl
==SQLITE_TESTCTRL_BYTEORDER
? 1 : 3;
10890 /* sqlite3_test_control(int, uint) */
10891 case SQLITE_TESTCTRL_PENDING_BYTE
:
10893 unsigned int opt
= (unsigned int)integerValue(azArg
[2]);
10894 rc2
= sqlite3_test_control(testctrl
, opt
);
10899 /* sqlite3_test_control(int, int, sqlite3*) */
10900 case SQLITE_TESTCTRL_PRNG_SEED
:
10901 if( nArg
==3 || nArg
==4 ){
10902 int ii
= (int)integerValue(azArg
[2]);
10904 if( ii
==0 && cli_strcmp(azArg
[2],"random")==0 ){
10905 sqlite3_randomness(sizeof(ii
),&ii
);
10906 sputf(stdout
, "-- random seed: %d\n", ii
);
10912 /* Make sure the schema has been loaded */
10913 sqlite3_table_column_metadata(db
, 0, "x", 0, 0, 0, 0, 0, 0);
10915 rc2
= sqlite3_test_control(testctrl
, ii
, db
);
10920 /* sqlite3_test_control(int, int) */
10921 case SQLITE_TESTCTRL_ASSERT
:
10922 case SQLITE_TESTCTRL_ALWAYS
:
10924 int opt
= booleanValue(azArg
[2]);
10925 rc2
= sqlite3_test_control(testctrl
, opt
);
10930 /* sqlite3_test_control(int, int) */
10931 case SQLITE_TESTCTRL_LOCALTIME_FAULT
:
10932 case SQLITE_TESTCTRL_NEVER_CORRUPT
:
10934 int opt
= booleanValue(azArg
[2]);
10935 rc2
= sqlite3_test_control(testctrl
, opt
);
10940 /* sqlite3_test_control(int, int) */
10941 case SQLITE_TESTCTRL_USELONGDOUBLE
: {
10944 if( cli_strcmp(azArg
[2],"default")==0 ){
10947 opt
= booleanValue(azArg
[2]);
10950 rc2
= sqlite3_test_control(testctrl
, opt
);
10955 /* sqlite3_test_control(sqlite3*) */
10956 case SQLITE_TESTCTRL_INTERNAL_FUNCTIONS
:
10957 rc2
= sqlite3_test_control(testctrl
, p
->db
);
10961 case SQLITE_TESTCTRL_IMPOSTER
:
10963 rc2
= sqlite3_test_control(testctrl
, p
->db
,
10965 integerValue(azArg
[3]),
10966 integerValue(azArg
[4]));
10971 case SQLITE_TESTCTRL_SEEK_COUNT
: {
10973 rc2
= sqlite3_test_control(testctrl
, p
->db
, &x
);
10974 oputf("%llu\n", x
);
10980 case SQLITE_TESTCTRL_PARSER_COVERAGE
: {
10982 sqlite3_test_control(testctrl
, p
->out
);
10988 #ifdef SQLITE_DEBUG
10989 case SQLITE_TESTCTRL_TUNE
: {
10991 int id
= (int)integerValue(azArg
[2]);
10992 int val
= (int)integerValue(azArg
[3]);
10993 sqlite3_test_control(testctrl
, id
, &val
);
10995 }else if( nArg
==3 ){
10996 int id
= (int)integerValue(azArg
[2]);
10997 sqlite3_test_control(testctrl
, -id
, &rc2
);
10999 }else if( nArg
==2 ){
11003 rc2
= sqlite3_test_control(testctrl
, -id
, &val
);
11004 if( rc2
!=SQLITE_OK
) break;
11005 if( id
>1 ) oputz(" ");
11006 oputf("%d: %d", id
, val
);
11009 if( id
>1 ) oputz("\n");
11015 case SQLITE_TESTCTRL_SORTER_MMAP
:
11017 int opt
= (unsigned int)integerValue(azArg
[2]);
11018 rc2
= sqlite3_test_control(testctrl
, p
->db
, opt
);
11022 case SQLITE_TESTCTRL_JSON_SELFCHECK
:
11027 rc2
= booleanValue(azArg
[2]);
11030 sqlite3_test_control(testctrl
, &rc2
);
11034 if( isOk
==0 && iCtrl
>=0 ){
11035 oputf("Usage: .testctrl %s %s\n", zCmd
,aCtrl
[iCtrl
].zUsage
);
11037 }else if( isOk
==1 ){
11038 oputf("%d\n", rc2
);
11039 }else if( isOk
==2 ){
11040 oputf("0x%08x\n", rc2
);
11043 #endif /* !defined(SQLITE_UNTESTABLE) */
11045 if( c
=='t' && n
>4 && cli_strncmp(azArg
[0], "timeout", n
)==0 ){
11047 sqlite3_busy_timeout(p
->db
, nArg
>=2 ? (int)integerValue(azArg
[1]) : 0);
11050 if( c
=='t' && n
>=5 && cli_strncmp(azArg
[0], "timer", n
)==0 ){
11052 enableTimer
= booleanValue(azArg
[1]);
11053 if( enableTimer
&& !HAS_TIMER
){
11054 eputz("Error: timer not available on this system.\n");
11058 eputz("Usage: .timer on|off\n");
11063 #ifndef SQLITE_OMIT_TRACE
11064 if( c
=='t' && cli_strncmp(azArg
[0], "trace", n
)==0 ){
11068 for(jj
=1; jj
<nArg
; jj
++){
11069 const char *z
= azArg
[jj
];
11071 if( optionMatch(z
, "expanded") ){
11072 p
->eTraceType
= SHELL_TRACE_EXPANDED
;
11074 #ifdef SQLITE_ENABLE_NORMALIZE
11075 else if( optionMatch(z
, "normalized") ){
11076 p
->eTraceType
= SHELL_TRACE_NORMALIZED
;
11079 else if( optionMatch(z
, "plain") ){
11080 p
->eTraceType
= SHELL_TRACE_PLAIN
;
11082 else if( optionMatch(z
, "profile") ){
11083 mType
|= SQLITE_TRACE_PROFILE
;
11085 else if( optionMatch(z
, "row") ){
11086 mType
|= SQLITE_TRACE_ROW
;
11088 else if( optionMatch(z
, "stmt") ){
11089 mType
|= SQLITE_TRACE_STMT
;
11091 else if( optionMatch(z
, "close") ){
11092 mType
|= SQLITE_TRACE_CLOSE
;
11095 eputf("Unknown option \"%s\" on \".trace\"\n", z
);
11097 goto meta_command_exit
;
11100 output_file_close(p
->traceOut
);
11101 p
->traceOut
= output_file_open(z
, 0);
11104 if( p
->traceOut
==0 ){
11105 sqlite3_trace_v2(p
->db
, 0, 0, 0);
11107 if( mType
==0 ) mType
= SQLITE_TRACE_STMT
;
11108 sqlite3_trace_v2(p
->db
, mType
, sql_trace_callback
, p
);
11111 #endif /* !defined(SQLITE_OMIT_TRACE) */
11113 #if defined(SQLITE_DEBUG) && !defined(SQLITE_OMIT_VIRTUALTABLE)
11114 if( c
=='u' && cli_strncmp(azArg
[0], "unmodule", n
)==0 ){
11119 eputz("Usage: .unmodule [--allexcept] NAME ...\n");
11121 goto meta_command_exit
;
11125 if( zOpt
[0]=='-' && zOpt
[1]=='-' && zOpt
[2]!=0 ) zOpt
++;
11126 lenOpt
= (int)strlen(zOpt
);
11127 if( lenOpt
>=3 && cli_strncmp(zOpt
, "-allexcept",lenOpt
)==0 ){
11128 assert( azArg
[nArg
]==0 );
11129 sqlite3_drop_modules(p
->db
, nArg
>2 ? (const char**)(azArg
+2) : 0);
11131 for(ii
=1; ii
<nArg
; ii
++){
11132 sqlite3_create_module(p
->db
, azArg
[ii
], 0, 0);
11138 #if SQLITE_USER_AUTHENTICATION
11139 if( c
=='u' && cli_strncmp(azArg
[0], "user", n
)==0 ){
11141 eputz("Usage: .user SUBCOMMAND ...\n");
11143 goto meta_command_exit
;
11146 if( cli_strcmp(azArg
[1],"login")==0 ){
11148 eputz("Usage: .user login USER PASSWORD\n");
11150 goto meta_command_exit
;
11152 rc
= sqlite3_user_authenticate(p
->db
, azArg
[2], azArg
[3],
11153 strlen30(azArg
[3]));
11155 eputf("Authentication failed for user %s\n", azArg
[2]);
11158 }else if( cli_strcmp(azArg
[1],"add")==0 ){
11160 eputz("Usage: .user add USER PASSWORD ISADMIN\n");
11162 goto meta_command_exit
;
11164 rc
= sqlite3_user_add(p
->db
, azArg
[2], azArg
[3], strlen30(azArg
[3]),
11165 booleanValue(azArg
[4]));
11167 eputf("User-Add failed: %d\n", rc
);
11170 }else if( cli_strcmp(azArg
[1],"edit")==0 ){
11172 eputz("Usage: .user edit USER PASSWORD ISADMIN\n");
11174 goto meta_command_exit
;
11176 rc
= sqlite3_user_change(p
->db
, azArg
[2], azArg
[3], strlen30(azArg
[3]),
11177 booleanValue(azArg
[4]));
11179 eputf("User-Edit failed: %d\n", rc
);
11182 }else if( cli_strcmp(azArg
[1],"delete")==0 ){
11184 eputz("Usage: .user delete USER\n");
11186 goto meta_command_exit
;
11188 rc
= sqlite3_user_delete(p
->db
, azArg
[2]);
11190 eputf("User-Delete failed: %d\n", rc
);
11194 eputz("Usage: .user login|add|edit|delete ...\n");
11196 goto meta_command_exit
;
11199 #endif /* SQLITE_USER_AUTHENTICATION */
11201 if( c
=='v' && cli_strncmp(azArg
[0], "version", n
)==0 ){
11202 char *zPtrSz
= sizeof(void*)==8 ? "64-bit" : "32-bit";
11203 oputf("SQLite %s %s\n" /*extra-version-info*/,
11204 sqlite3_libversion(), sqlite3_sourceid());
11205 /* BEGIN SQLCIPHER */
11206 #ifdef SQLITE_HAS_CODEC
11208 extern char* sqlcipher_version();
11209 char *sqlcipher_ver
= sqlcipher_version();
11210 oputf("SQLCipher %s\n", sqlcipher_ver
);
11211 sqlite3_free(sqlcipher_ver
);
11214 /* END SQLCIPHER */
11215 #if SQLITE_HAVE_ZLIB
11216 oputf("zlib version %s\n", zlibVersion());
11218 #define CTIMEOPT_VAL_(opt) #opt
11219 #define CTIMEOPT_VAL(opt) CTIMEOPT_VAL_(opt)
11220 #if defined(__clang__) && defined(__clang_major__)
11221 oputf("clang-" CTIMEOPT_VAL(__clang_major__
) "."
11222 CTIMEOPT_VAL(__clang_minor__
) "."
11223 CTIMEOPT_VAL(__clang_patchlevel__
) " (%s)\n", zPtrSz
);
11224 #elif defined(_MSC_VER)
11225 oputf("msvc-" CTIMEOPT_VAL(_MSC_VER
) " (%s)\n", zPtrSz
);
11226 #elif defined(__GNUC__) && defined(__VERSION__)
11227 oputf("gcc-" __VERSION__
" (%s)\n", zPtrSz
);
11231 if( c
=='v' && cli_strncmp(azArg
[0], "vfsinfo", n
)==0 ){
11232 const char *zDbName
= nArg
==2 ? azArg
[1] : "main";
11233 sqlite3_vfs
*pVfs
= 0;
11235 sqlite3_file_control(p
->db
, zDbName
, SQLITE_FCNTL_VFS_POINTER
, &pVfs
);
11237 oputf("vfs.zName = \"%s\"\n", pVfs
->zName
);
11238 oputf("vfs.iVersion = %d\n", pVfs
->iVersion
);
11239 oputf("vfs.szOsFile = %d\n", pVfs
->szOsFile
);
11240 oputf("vfs.mxPathname = %d\n", pVfs
->mxPathname
);
11245 if( c
=='v' && cli_strncmp(azArg
[0], "vfslist", n
)==0 ){
11247 sqlite3_vfs
*pCurrent
= 0;
11249 sqlite3_file_control(p
->db
, "main", SQLITE_FCNTL_VFS_POINTER
, &pCurrent
);
11251 for(pVfs
=sqlite3_vfs_find(0); pVfs
; pVfs
=pVfs
->pNext
){
11252 oputf("vfs.zName = \"%s\"%s\n", pVfs
->zName
,
11253 pVfs
==pCurrent
? " <--- CURRENT" : "");
11254 oputf("vfs.iVersion = %d\n", pVfs
->iVersion
);
11255 oputf("vfs.szOsFile = %d\n", pVfs
->szOsFile
);
11256 oputf("vfs.mxPathname = %d\n", pVfs
->mxPathname
);
11258 oputz("-----------------------------------\n");
11263 if( c
=='v' && cli_strncmp(azArg
[0], "vfsname", n
)==0 ){
11264 const char *zDbName
= nArg
==2 ? azArg
[1] : "main";
11265 char *zVfsName
= 0;
11267 sqlite3_file_control(p
->db
, zDbName
, SQLITE_FCNTL_VFSNAME
, &zVfsName
);
11269 oputf("%s\n", zVfsName
);
11270 sqlite3_free(zVfsName
);
11275 if( c
=='w' && cli_strncmp(azArg
[0], "wheretrace", n
)==0 ){
11276 unsigned int x
= nArg
>=2? (unsigned int)integerValue(azArg
[1]) : 0xffffffff;
11277 sqlite3_test_control(SQLITE_TESTCTRL_TRACEFLAGS
, 3, &x
);
11280 if( c
=='w' && cli_strncmp(azArg
[0], "width", n
)==0 ){
11282 assert( nArg
<=ArraySize(azArg
) );
11283 p
->nWidth
= nArg
-1;
11284 p
->colWidth
= realloc(p
->colWidth
, (p
->nWidth
+1)*sizeof(int)*2);
11285 if( p
->colWidth
==0 && p
->nWidth
>0 ) shell_out_of_memory();
11286 if( p
->nWidth
) p
->actualWidth
= &p
->colWidth
[p
->nWidth
];
11287 for(j
=1; j
<nArg
; j
++){
11288 p
->colWidth
[j
-1] = (int)integerValue(azArg
[j
]);
11293 eputf("Error: unknown command or invalid arguments: "
11294 " \"%s\". Enter \".help\" for help\n", azArg
[0]);
11301 if( p
->outCount
==0 ) output_reset(p
);
11303 p
->bSafeMode
= p
->bSafeModePersist
;
11307 /* Line scan result and intermediate states (supporting scan resumption)
11310 # define CHAR_BIT 8
11313 QSS_HasDark
= 1<<CHAR_BIT
, QSS_EndingSemi
= 2<<CHAR_BIT
,
11314 QSS_CharMask
= (1<<CHAR_BIT
)-1, QSS_ScanMask
= 3<<CHAR_BIT
,
11317 #define QSS_SETV(qss, newst) ((newst) | ((qss) & QSS_ScanMask))
11318 #define QSS_INPLAIN(qss) (((qss)&QSS_CharMask)==QSS_Start)
11319 #define QSS_PLAINWHITE(qss) (((qss)&~QSS_EndingSemi)==QSS_Start)
11320 #define QSS_PLAINDARK(qss) (((qss)&~QSS_EndingSemi)==QSS_HasDark)
11321 #define QSS_SEMITERM(qss) (((qss)&~QSS_HasDark)==QSS_EndingSemi)
11324 ** Scan line for classification to guide shell's handling.
11325 ** The scan is resumable for subsequent lines when prior
11326 ** return values are passed as the 2nd argument.
11328 static QuickScanState
quickscan(char *zLine
, QuickScanState qss
,
11329 SCAN_TRACKER_REFTYPE pst
){
11331 char cWait
= (char)qss
; /* intentional narrowing loss */
11334 assert( cWait
==0 );
11335 while( (cin
= *zLine
++)!=0 ){
11342 while((cin
= *++zLine
)!=0 )
11347 qss
|= QSS_EndingSemi
;
11353 CONTINUE_PROMPT_AWAITS(pst
, "/*");
11354 qss
= QSS_SETV(qss
, cWait
);
11360 deliberate_fall_through
;
11361 case '`': case '\'': case '"':
11363 qss
= QSS_HasDark
| cWait
;
11364 CONTINUE_PROMPT_AWAITC(pst
, cin
);
11367 CONTINUE_PAREN_INCR(pst
, 1);
11370 CONTINUE_PAREN_INCR(pst
, -1);
11375 qss
= (qss
& ~QSS_EndingSemi
) | QSS_HasDark
;
11379 while( (cin
= *zLine
++)!=0 ){
11383 if( *zLine
!= '/' )
11387 CONTINUE_PROMPT_AWAITC(pst
, 0);
11388 qss
= QSS_SETV(qss
, 0);
11390 case '`': case '\'': case '"':
11392 /* Swallow doubled end-delimiter.*/
11396 deliberate_fall_through
;
11399 CONTINUE_PROMPT_AWAITC(pst
, 0);
11400 qss
= QSS_SETV(qss
, 0);
11402 default: assert(0);
11411 ** Return TRUE if the line typed in is an SQL command terminator other
11412 ** than a semi-colon. The SQL Server style "go" command is understood
11413 ** as is the Oracle "/".
11415 static int line_is_command_terminator(char *zLine
){
11416 while( IsSpace(zLine
[0]) ){ zLine
++; };
11417 if( zLine
[0]=='/' )
11418 zLine
+= 1; /* Oracle */
11419 else if ( ToLower(zLine
[0])=='g' && ToLower(zLine
[1])=='o' )
11420 zLine
+= 2; /* SQL Server */
11423 return quickscan(zLine
, QSS_Start
, 0)==QSS_Start
;
11427 ** The CLI needs a working sqlite3_complete() to work properly. So error
11428 ** out of the build if compiling with SQLITE_OMIT_COMPLETE.
11430 #ifdef SQLITE_OMIT_COMPLETE
11431 # error the CLI application is imcompatable with SQLITE_OMIT_COMPLETE.
11435 ** Return true if zSql is a complete SQL statement. Return false if it
11436 ** ends in the middle of a string literal or C-style comment.
11438 static int line_is_complete(char *zSql
, int nSql
){
11440 if( zSql
==0 ) return 1;
11443 rc
= sqlite3_complete(zSql
);
11449 ** This function is called after processing each line of SQL in the
11450 ** runOneSqlLine() function. Its purpose is to detect scenarios where
11451 ** defensive mode should be automatically turned off. Specifically, when
11453 ** 1. The first line of input is "PRAGMA foreign_keys=OFF;",
11454 ** 2. The second line of input is "BEGIN TRANSACTION;",
11455 ** 3. The database is empty, and
11456 ** 4. The shell is not running in --safe mode.
11458 ** The implementation uses the ShellState.eRestoreState to maintain state:
11460 ** 0: Have not seen any SQL.
11461 ** 1: Have seen "PRAGMA foreign_keys=OFF;".
11462 ** 2-6: Currently running .dump transaction. If the "2" bit is set,
11463 ** disable DEFENSIVE when done. If "4" is set, disable DQS_DDL.
11464 ** 7: Nothing left to do. This function becomes a no-op.
11466 static int doAutoDetectRestore(ShellState
*p
, const char *zSql
){
11467 int rc
= SQLITE_OK
;
11469 if( p
->eRestoreState
<7 ){
11470 switch( p
->eRestoreState
){
11472 const char *zExpect
= "PRAGMA foreign_keys=OFF;";
11473 assert( strlen(zExpect
)==24 );
11474 if( p
->bSafeMode
==0 && memcmp(zSql
, zExpect
, 25)==0 ){
11475 p
->eRestoreState
= 1;
11477 p
->eRestoreState
= 7;
11484 const char *zExpect
= "BEGIN TRANSACTION;";
11485 assert( strlen(zExpect
)==18 );
11486 if( memcmp(zSql
, zExpect
, 19)==0 ){
11487 /* Now check if the database is empty. */
11488 const char *zQuery
= "SELECT 1 FROM sqlite_schema LIMIT 1";
11489 sqlite3_stmt
*pStmt
= 0;
11492 shellPrepare(p
->db
, &rc
, zQuery
, &pStmt
);
11493 if( rc
==SQLITE_OK
&& sqlite3_step(pStmt
)==SQLITE_ROW
){
11496 shellFinalize(&rc
, pStmt
);
11498 if( bIsDump
&& rc
==SQLITE_OK
){
11501 sqlite3_db_config(p
->db
, SQLITE_DBCONFIG_DEFENSIVE
, -1, &bDefense
);
11502 sqlite3_db_config(p
->db
, SQLITE_DBCONFIG_DQS_DDL
, -1, &bDqsDdl
);
11503 sqlite3_db_config(p
->db
, SQLITE_DBCONFIG_DEFENSIVE
, 0, 0);
11504 sqlite3_db_config(p
->db
, SQLITE_DBCONFIG_DQS_DDL
, 1, 0);
11505 p
->eRestoreState
= (bDefense
? 2 : 0) + (bDqsDdl
? 4 : 0);
11507 p
->eRestoreState
= 7;
11513 if( sqlite3_get_autocommit(p
->db
) ){
11514 if( (p
->eRestoreState
& 2) ){
11515 sqlite3_db_config(p
->db
, SQLITE_DBCONFIG_DEFENSIVE
, 1, 0);
11517 if( (p
->eRestoreState
& 4) ){
11518 sqlite3_db_config(p
->db
, SQLITE_DBCONFIG_DQS_DDL
, 0, 0);
11520 p
->eRestoreState
= 7;
11531 ** Run a single line of SQL. Return the number of errors.
11533 static int runOneSqlLine(ShellState
*p
, char *zSql
, FILE *in
, int startline
){
11538 if( ShellHasFlag(p
,SHFLG_Backslash
) ) resolve_backslashes(zSql
);
11539 if( p
->flgProgress
& SHELL_PROGRESS_RESET
) p
->nProgress
= 0;
11541 rc
= shell_exec(p
, zSql
, &zErrMsg
);
11543 if( rc
|| zErrMsg
){
11545 const char *zErrorTail
;
11546 const char *zErrorType
;
11548 zErrorType
= "Error";
11549 zErrorTail
= sqlite3_errmsg(p
->db
);
11550 }else if( cli_strncmp(zErrMsg
, "in prepare, ",12)==0 ){
11551 zErrorType
= "Parse error";
11552 zErrorTail
= &zErrMsg
[12];
11553 }else if( cli_strncmp(zErrMsg
, "stepping, ", 10)==0 ){
11554 zErrorType
= "Runtime error";
11555 zErrorTail
= &zErrMsg
[10];
11557 zErrorType
= "Error";
11558 zErrorTail
= zErrMsg
;
11560 if( in
!=0 || !stdin_is_interactive
){
11561 sqlite3_snprintf(sizeof(zPrefix
), zPrefix
,
11562 "%s near line %d:", zErrorType
, startline
);
11564 sqlite3_snprintf(sizeof(zPrefix
), zPrefix
, "%s:", zErrorType
);
11566 eputf("%s %s\n", zPrefix
, zErrorTail
);
11567 sqlite3_free(zErrMsg
);
11570 }else if( ShellHasFlag(p
, SHFLG_CountChanges
) ){
11571 char zLineBuf
[2000];
11572 sqlite3_snprintf(sizeof(zLineBuf
), zLineBuf
,
11573 "changes: %lld total_changes: %lld",
11574 sqlite3_changes64(p
->db
), sqlite3_total_changes64(p
->db
));
11575 oputf("%s\n", zLineBuf
);
11578 if( doAutoDetectRestore(p
, zSql
) ) return 1;
11582 static void echo_group_input(ShellState
*p
, const char *zDo
){
11583 if( ShellHasFlag(p
, SHFLG_Echo
) ) oputf("%s\n", zDo
);
11586 #ifdef SQLITE_SHELL_FIDDLE
11588 ** Alternate one_input_line() impl for wasm mode. This is not in the primary
11589 ** impl because we need the global shellState and cannot access it from that
11590 ** function without moving lots of code around (creating a larger/messier diff).
11592 static char *one_input_line(FILE *in
, char *zPrior
, int isContinuation
){
11593 /* Parse the next line from shellState.wasm.zInput. */
11594 const char *zBegin
= shellState
.wasm
.zPos
;
11595 const char *z
= zBegin
;
11599 UNUSED_PARAMETER(in
);
11600 UNUSED_PARAMETER(isContinuation
);
11604 while(*z
&& isspace(*z
)) ++z
;
11606 for(; *z
&& '\n'!=*z
; ++nZ
, ++z
){}
11607 if(nZ
>0 && '\r'==zBegin
[nZ
-1]){
11610 shellState
.wasm
.zPos
= z
;
11611 zLine
= realloc(zPrior
, nZ
+1);
11612 shell_check_oom(zLine
);
11613 memcpy(zLine
, zBegin
, nZ
);
11617 #endif /* SQLITE_SHELL_FIDDLE */
11620 ** Read input from *in and process it. If *in==0 then input
11621 ** is interactive - the user is typing it it. Otherwise, input
11622 ** is coming from a file or device. A prompt is issued and history
11623 ** is saved only if input is interactive. An interrupt signal will
11624 ** cause this routine to exit immediately, unless input is interactive.
11626 ** Return the number of errors.
11628 static int process_input(ShellState
*p
){
11629 char *zLine
= 0; /* A single input line */
11630 char *zSql
= 0; /* Accumulated SQL text */
11631 i64 nLine
; /* Length of current line */
11632 i64 nSql
= 0; /* Bytes of zSql[] used */
11633 i64 nAlloc
= 0; /* Allocated zSql[] space */
11634 int rc
; /* Error code */
11635 int errCnt
= 0; /* Number of errors seen */
11636 i64 startline
= 0; /* Line number for start of current input */
11637 QuickScanState qss
= QSS_Start
; /* Accumulated line status (so far) */
11639 if( p
->inputNesting
==MAX_INPUT_NESTING
){
11640 /* This will be more informative in a later version. */
11641 eputf("Input nesting limit (%d) reached at line %d."
11642 " Check recursion.\n", MAX_INPUT_NESTING
, p
->lineno
);
11647 CONTINUE_PROMPT_RESET
;
11648 while( errCnt
==0 || !bail_on_error
|| (p
->in
==0 && stdin_is_interactive
) ){
11650 zLine
= one_input_line(p
->in
, zLine
, nSql
>0);
11653 if( p
->in
==0 && stdin_is_interactive
) oputz("\n");
11656 if( seenInterrupt
){
11657 if( p
->in
!=0 ) break;
11661 if( QSS_INPLAIN(qss
)
11662 && line_is_command_terminator(zLine
)
11663 && line_is_complete(zSql
, nSql
) ){
11664 memcpy(zLine
,";",2);
11666 qss
= quickscan(zLine
, qss
, CONTINUE_PROMPT_PSTATE
);
11667 if( QSS_PLAINWHITE(qss
) && nSql
==0 ){
11668 /* Just swallow single-line whitespace */
11669 echo_group_input(p
, zLine
);
11673 if( zLine
&& (zLine
[0]=='.' || zLine
[0]=='#') && nSql
==0 ){
11674 CONTINUE_PROMPT_RESET
;
11675 echo_group_input(p
, zLine
);
11676 if( zLine
[0]=='.' ){
11677 rc
= do_meta_command(zLine
, p
);
11678 if( rc
==2 ){ /* exit requested */
11687 /* No single-line dispositions remain; accumulate line(s). */
11688 nLine
= strlen(zLine
);
11689 if( nSql
+nLine
+2>=nAlloc
){
11690 /* Grow buffer by half-again increments when big. */
11691 nAlloc
= nSql
+(nSql
>>1)+nLine
+100;
11692 zSql
= realloc(zSql
, nAlloc
);
11693 shell_check_oom(zSql
);
11697 for(i
=0; zLine
[i
] && IsSpace(zLine
[i
]); i
++){}
11698 assert( nAlloc
>0 && zSql
!=0 );
11699 memcpy(zSql
, zLine
+i
, nLine
+1-i
);
11700 startline
= p
->lineno
;
11703 zSql
[nSql
++] = '\n';
11704 memcpy(zSql
+nSql
, zLine
, nLine
+1);
11707 if( nSql
&& QSS_SEMITERM(qss
) && sqlite3_complete(zSql
) ){
11708 echo_group_input(p
, zSql
);
11709 errCnt
+= runOneSqlLine(p
, zSql
, p
->in
, startline
);
11710 CONTINUE_PROMPT_RESET
;
11718 p
->bSafeMode
= p
->bSafeModePersist
;
11720 }else if( nSql
&& QSS_PLAINWHITE(qss
) ){
11721 echo_group_input(p
, zSql
);
11727 /* This may be incomplete. Let the SQL parser deal with that. */
11728 echo_group_input(p
, zSql
);
11729 errCnt
+= runOneSqlLine(p
, zSql
, p
->in
, startline
);
11730 CONTINUE_PROMPT_RESET
;
11739 ** Return a pathname which is the user's home directory. A
11740 ** 0 return indicates an error of some kind.
11742 static char *find_home_dir(int clearFlag
){
11743 static char *home_dir
= NULL
;
11749 if( home_dir
) return home_dir
;
11751 #if !defined(_WIN32) && !defined(WIN32) && !defined(_WIN32_WCE) \
11752 && !defined(__RTP__) && !defined(_WRS_KERNEL) && !defined(SQLITE_WASI)
11754 struct passwd
*pwent
;
11755 uid_t uid
= getuid();
11756 if( (pwent
=getpwuid(uid
)) != NULL
) {
11757 home_dir
= pwent
->pw_dir
;
11762 #if defined(_WIN32_WCE)
11763 /* Windows CE (arm-wince-mingw32ce-gcc) does not provide getenv()
11768 #if defined(_WIN32) || defined(WIN32)
11770 home_dir
= getenv("USERPROFILE");
11775 home_dir
= getenv("HOME");
11778 #if defined(_WIN32) || defined(WIN32)
11780 char *zDrive
, *zPath
;
11782 zDrive
= getenv("HOMEDRIVE");
11783 zPath
= getenv("HOMEPATH");
11784 if( zDrive
&& zPath
){
11785 n
= strlen30(zDrive
) + strlen30(zPath
) + 1;
11786 home_dir
= malloc( n
);
11787 if( home_dir
==0 ) return 0;
11788 sqlite3_snprintf(n
, home_dir
, "%s%s", zDrive
, zPath
);
11795 #endif /* !_WIN32_WCE */
11798 i64 n
= strlen(home_dir
) + 1;
11799 char *z
= malloc( n
);
11800 if( z
) memcpy(z
, home_dir
, n
);
11808 ** On non-Windows platforms, look for $XDG_CONFIG_HOME.
11809 ** If ${XDG_CONFIG_HOME}/sqlite3/sqliterc is found, return
11810 ** the path to it, else return 0. The result is cached for
11811 ** subsequent calls.
11813 static const char *find_xdg_config(void){
11814 #if defined(_WIN32) || defined(WIN32) || defined(_WIN32_WCE) \
11815 || defined(__RTP__) || defined(_WRS_KERNEL)
11818 static int alreadyTried
= 0;
11819 static char *zConfig
= 0;
11820 const char *zXdgHome
;
11822 if( alreadyTried
!=0 ){
11826 zXdgHome
= getenv("XDG_CONFIG_HOME");
11830 zConfig
= sqlite3_mprintf("%s/sqlite3/sqliterc", zXdgHome
);
11831 shell_check_oom(zConfig
);
11832 if( access(zConfig
,0)!=0 ){
11833 sqlite3_free(zConfig
);
11841 ** Read input from the file given by sqliterc_override. Or if that
11842 ** parameter is NULL, take input from the first of find_xdg_config()
11843 ** or ~/.sqliterc which is found.
11845 ** Returns the number of errors.
11847 static void process_sqliterc(
11848 ShellState
*p
, /* Configuration data */
11849 const char *sqliterc_override
/* Name of config file. NULL to use default */
11851 char *home_dir
= NULL
;
11852 const char *sqliterc
= sqliterc_override
;
11854 FILE *inSaved
= p
->in
;
11855 int savedLineno
= p
->lineno
;
11857 if( sqliterc
== NULL
){
11858 sqliterc
= find_xdg_config();
11860 if( sqliterc
== NULL
){
11861 home_dir
= find_home_dir(0);
11863 eputz("-- warning: cannot find home directory;"
11864 " cannot read ~/.sqliterc\n");
11867 zBuf
= sqlite3_mprintf("%s/.sqliterc",home_dir
);
11868 shell_check_oom(zBuf
);
11871 p
->in
= fopen(sqliterc
,"rb");
11873 if( stdin_is_interactive
){
11874 eputf("-- Loading resources from %s\n", sqliterc
);
11876 if( process_input(p
) && bail_on_error
) exit(1);
11878 }else if( sqliterc_override
!=0 ){
11879 eputf("cannot open: \"%s\"\n", sqliterc
);
11880 if( bail_on_error
) exit(1);
11883 p
->lineno
= savedLineno
;
11884 sqlite3_free(zBuf
);
11888 ** Show available command line options
11890 static const char zOptions
[] =
11891 " -- treat no subsequent arguments as options\n"
11892 #if defined(SQLITE_HAVE_ZLIB) && !defined(SQLITE_OMIT_VIRTUALTABLE)
11893 " -A ARGS... run \".archive ARGS\" and exit\n"
11895 " -append append the database to the end of the file\n"
11896 " -ascii set output mode to 'ascii'\n"
11897 " -bail stop after hitting an error\n"
11898 " -batch force batch I/O\n"
11899 " -box set output mode to 'box'\n"
11900 " -column set output mode to 'column'\n"
11901 " -cmd COMMAND run \"COMMAND\" before reading stdin\n"
11902 " -csv set output mode to 'csv'\n"
11903 #if !defined(SQLITE_OMIT_DESERIALIZE)
11904 " -deserialize open the database using sqlite3_deserialize()\n"
11906 " -echo print inputs before execution\n"
11907 " -init FILENAME read/process named file\n"
11908 " -[no]header turn headers on or off\n"
11909 #if defined(SQLITE_ENABLE_MEMSYS3) || defined(SQLITE_ENABLE_MEMSYS5)
11910 " -heap SIZE Size of heap for memsys3 or memsys5\n"
11912 " -help show this message\n"
11913 " -html set output mode to HTML\n"
11914 " -interactive force interactive I/O\n"
11915 " -json set output mode to 'json'\n"
11916 " -line set output mode to 'line'\n"
11917 " -list set output mode to 'list'\n"
11918 " -lookaside SIZE N use N entries of SZ bytes for lookaside memory\n"
11919 " -markdown set output mode to 'markdown'\n"
11920 #if !defined(SQLITE_OMIT_DESERIALIZE)
11921 " -maxsize N maximum size for a --deserialize database\n"
11923 " -memtrace trace all memory allocations and deallocations\n"
11924 " -mmap N default mmap size set to N\n"
11925 #ifdef SQLITE_ENABLE_MULTIPLEX
11926 " -multiplex enable the multiplexor VFS\n"
11928 " -newline SEP set output row separator. Default: '\\n'\n"
11929 " -nofollow refuse to open symbolic links to database files\n"
11930 " -nonce STRING set the safe-mode escape nonce\n"
11931 " -no-rowid-in-view Disable rowid-in-view using sqlite3_config()\n"
11932 " -nullvalue TEXT set text string for NULL values. Default ''\n"
11933 " -pagecache SIZE N use N slots of SZ bytes each for page cache memory\n"
11934 " -pcachetrace trace all page cache operations\n"
11935 " -quote set output mode to 'quote'\n"
11936 " -readonly open the database read-only\n"
11937 " -safe enable safe-mode\n"
11938 " -separator SEP set output column separator. Default: '|'\n"
11939 #ifdef SQLITE_ENABLE_SORTER_REFERENCES
11940 " -sorterref SIZE sorter references threshold size\n"
11942 " -stats print memory stats before each finalize\n"
11943 " -table set output mode to 'table'\n"
11944 " -tabs set output mode to 'tabs'\n"
11945 " -unsafe-testing allow unsafe commands and modes for testing\n"
11946 " -version show SQLite version\n"
11947 " -vfs NAME use NAME as the default VFS\n"
11948 #ifdef SQLITE_ENABLE_VFSTRACE
11949 " -vfstrace enable tracing of all VFS calls\n"
11951 #ifdef SQLITE_HAVE_ZLIB
11952 " -zip open the file as a ZIP Archive\n"
11955 static void usage(int showDetail
){
11956 eputf("Usage: %s [OPTIONS] [FILENAME [SQL]]\n"
11957 "FILENAME is the name of an SQLite database. A new database is created\n"
11958 "if the file does not previously exist. Defaults to :memory:.\n", Argv0
);
11960 eputf("OPTIONS include:\n%s", zOptions
);
11962 eputz("Use the -help option for additional information\n");
11968 ** Internal check: Verify that the SQLite is uninitialized. Print a
11969 ** error message if it is initialized.
11971 static void verify_uninitialized(void){
11972 if( sqlite3_config(-1)==SQLITE_MISUSE
){
11973 sputz(stdout
, "WARNING: attempt to configure SQLite after"
11974 " initialization.\n");
11979 ** Initialize the state information in data
11981 static void main_init(ShellState
*data
) {
11982 memset(data
, 0, sizeof(*data
));
11983 data
->normalMode
= data
->cMode
= data
->mode
= MODE_List
;
11984 data
->autoExplain
= 1;
11985 data
->pAuxDb
= &data
->aAuxDb
[0];
11986 memcpy(data
->colSeparator
,SEP_Column
, 2);
11987 memcpy(data
->rowSeparator
,SEP_Row
, 2);
11988 data
->showHeader
= 0;
11989 data
->shellFlgs
= SHFLG_Lookaside
;
11990 sqlite3_config(SQLITE_CONFIG_LOG
, shellLog
, data
);
11991 #if !defined(SQLITE_SHELL_FIDDLE)
11992 verify_uninitialized();
11994 sqlite3_config(SQLITE_CONFIG_URI
, 1);
11995 sqlite3_config(SQLITE_CONFIG_MULTITHREAD
);
11996 sqlite3_snprintf(sizeof(mainPrompt
), mainPrompt
,"sqlite> ");
11997 sqlite3_snprintf(sizeof(continuePrompt
), continuePrompt
," ...> ");
12001 ** Output text to the console in a font that attracts extra attention.
12003 #if defined(_WIN32) || defined(WIN32)
12004 static void printBold(const char *zText
){
12005 #if !SQLITE_OS_WINRT
12006 HANDLE out
= GetStdHandle(STD_OUTPUT_HANDLE
);
12007 CONSOLE_SCREEN_BUFFER_INFO defaultScreenInfo
;
12008 GetConsoleScreenBufferInfo(out
, &defaultScreenInfo
);
12009 SetConsoleTextAttribute(out
,
12010 FOREGROUND_RED
|FOREGROUND_INTENSITY
12013 sputz(stdout
, zText
);
12014 #if !SQLITE_OS_WINRT
12015 SetConsoleTextAttribute(out
, defaultScreenInfo
.wAttributes
);
12019 static void printBold(const char *zText
){
12020 sputf(stdout
, "\033[1m%s\033[0m", zText
);
12025 ** Get the argument to an --option. Throw an error and die if no argument
12028 static char *cmdline_option_value(int argc
, char **argv
, int i
){
12030 eputf("%s: Error: missing argument to %s\n", argv
[0], argv
[argc
-1]);
12036 static void sayAbnormalExit(void){
12037 if( seenInterrupt
) eputz("Program interrupted.\n");
12040 #ifndef SQLITE_SHELL_IS_UTF8
12041 # if (defined(_WIN32) || defined(WIN32)) \
12042 && (defined(_MSC_VER) || (defined(UNICODE) && defined(__GNUC__)))
12043 # define SQLITE_SHELL_IS_UTF8 (0)
12045 # define SQLITE_SHELL_IS_UTF8 (1)
12049 #ifdef SQLITE_SHELL_FIDDLE
12050 # define main fiddle_main
12053 #if SQLITE_SHELL_IS_UTF8
12054 int SQLITE_CDECL
main(int argc
, char **argv
){
12056 int SQLITE_CDECL
wmain(int argc
, wchar_t **wargv
){
12059 #ifdef SQLITE_DEBUG
12060 sqlite3_int64 mem_main_enter
= 0;
12063 #ifdef SQLITE_SHELL_FIDDLE
12064 # define data shellState
12067 StreamsAreConsole consStreams
= SAC_NoConsole
;
12069 const char *zInitFile
= 0;
12072 int warnInmemoryDb
= 0;
12075 int nOptsEnd
= argc
;
12077 const char *zVfs
= 0; /* Value of -vfs command-line option */
12078 #if !SQLITE_SHELL_IS_UTF8
12079 char **argvToFree
= 0;
12080 int argcToFree
= 0;
12082 setvbuf(stderr
, 0, _IONBF
, 0); /* Make sure stderr is unbuffered */
12084 #ifdef SQLITE_SHELL_FIDDLE
12085 stdin_is_interactive
= 0;
12086 stdout_is_console
= 1;
12087 data
.wasm
.zDefaultDbName
= "/fiddle.sqlite3";
12089 consStreams
= consoleClassifySetup(stdin
, stdout
, stderr
);
12090 stdin_is_interactive
= (consStreams
& SAC_InConsole
)!=0;
12091 stdout_is_console
= (consStreams
& SAC_OutConsole
)!=0;
12092 atexit(consoleRestore
);
12094 atexit(sayAbnormalExit
);
12095 #ifdef SQLITE_DEBUG
12096 mem_main_enter
= sqlite3_memory_used();
12098 #if !defined(_WIN32_WCE)
12099 if( getenv("SQLITE_DEBUG_BREAK") ){
12100 if( isatty(0) && isatty(2) ){
12101 eputf("attach debugger to process %d and press any key to continue.\n",
12105 #if defined(_WIN32) || defined(WIN32)
12106 #if SQLITE_OS_WINRT
12111 #elif defined(SIGTRAP)
12117 /* Register a valid signal handler early, before much else is done. */
12119 signal(SIGINT
, interrupt_handler
);
12120 #elif (defined(_WIN32) || defined(WIN32)) && !defined(_WIN32_WCE)
12121 if( !SetConsoleCtrlHandler(ConsoleCtrlHandler
, TRUE
) ){
12122 eputz("No ^C handler.\n");
12126 #if USE_SYSTEM_SQLITE+0!=1
12127 if( cli_strncmp(sqlite3_sourceid(),SQLITE_SOURCE_ID
,60)!=0 ){
12128 eputf("SQLite header and source version mismatch\n%s\n%s\n",
12129 sqlite3_sourceid(), SQLITE_SOURCE_ID
);
12135 /* On Windows, we must translate command-line arguments into UTF-8.
12136 ** The SQLite memory allocator subsystem has to be enabled in order to
12137 ** do this. But we want to run an sqlite3_shutdown() afterwards so that
12138 ** subsequent sqlite3_config() calls will work. So copy all results into
12139 ** memory that does not come from the SQLite memory allocator.
12141 #if !SQLITE_SHELL_IS_UTF8
12142 sqlite3_initialize();
12143 argvToFree
= malloc(sizeof(argv
[0])*argc
*2);
12144 shell_check_oom(argvToFree
);
12146 argv
= argvToFree
+ argc
;
12147 for(i
=0; i
<argc
; i
++){
12148 char *z
= sqlite3_win32_unicode_to_utf8(wargv
[i
]);
12150 shell_check_oom(z
);
12152 argv
[i
] = malloc( n
+1 );
12153 shell_check_oom(argv
[i
]);
12154 memcpy(argv
[i
], z
, n
+1);
12155 argvToFree
[i
] = argv
[i
];
12158 sqlite3_shutdown();
12161 assert( argc
>=1 && argv
&& argv
[0] );
12164 #ifdef SQLITE_SHELL_DBNAME_PROC
12166 /* If the SQLITE_SHELL_DBNAME_PROC macro is defined, then it is the name
12167 ** of a C-function that will provide the name of the database file. Use
12168 ** this compile-time option to embed this shell program in larger
12169 ** applications. */
12170 extern void SQLITE_SHELL_DBNAME_PROC(const char**);
12171 SQLITE_SHELL_DBNAME_PROC(&data
.pAuxDb
->zDbFilename
);
12172 warnInmemoryDb
= 0;
12176 /* Do an initial pass through the command-line argument to locate
12177 ** the name of the database file, the name of the initialization file,
12178 ** the size of the alternative malloc heap, options affecting commands
12179 ** or SQL run from the command line, and the first command to execute.
12181 #ifndef SQLITE_SHELL_FIDDLE
12182 verify_uninitialized();
12184 for(i
=1; i
<argc
; i
++){
12187 if( z
[0]!='-' || i
>nOptsEnd
){
12188 if( data
.aAuxDb
->zDbFilename
==0 ){
12189 data
.aAuxDb
->zDbFilename
= z
;
12191 /* Excess arguments are interpreted as SQL (or dot-commands) and
12192 ** mean that nothing is read from stdin */
12195 azCmd
= realloc(azCmd
, sizeof(azCmd
[0])*nCmd
);
12196 shell_check_oom(azCmd
);
12201 if( z
[1]=='-' ) z
++;
12202 if( cli_strcmp(z
, "-")==0 ){
12205 }else if( cli_strcmp(z
,"-separator")==0
12206 || cli_strcmp(z
,"-nullvalue")==0
12207 || cli_strcmp(z
,"-newline")==0
12208 || cli_strcmp(z
,"-cmd")==0
12210 (void)cmdline_option_value(argc
, argv
, ++i
);
12211 }else if( cli_strcmp(z
,"-init")==0 ){
12212 zInitFile
= cmdline_option_value(argc
, argv
, ++i
);
12213 }else if( cli_strcmp(z
,"-interactive")==0 ){
12214 }else if( cli_strcmp(z
,"-batch")==0 ){
12215 /* Need to check for batch mode here to so we can avoid printing
12216 ** informational messages (like from process_sqliterc) before
12217 ** we do the actual processing of arguments later in a second pass.
12219 stdin_is_interactive
= 0;
12220 }else if( cli_strcmp(z
,"-utf8")==0 ){
12221 }else if( cli_strcmp(z
,"-no-utf8")==0 ){
12222 }else if( cli_strcmp(z
,"-no-rowid-in-view")==0 ){
12224 sqlite3_config(SQLITE_CONFIG_ROWID_IN_VIEW
, &val
);
12226 }else if( cli_strcmp(z
,"-heap")==0 ){
12227 #if defined(SQLITE_ENABLE_MEMSYS3) || defined(SQLITE_ENABLE_MEMSYS5)
12229 sqlite3_int64 szHeap
;
12231 zSize
= cmdline_option_value(argc
, argv
, ++i
);
12232 szHeap
= integerValue(zSize
);
12233 if( szHeap
>0x7fff0000 ) szHeap
= 0x7fff0000;
12234 verify_uninitialized();
12235 sqlite3_config(SQLITE_CONFIG_HEAP
, malloc((int)szHeap
), (int)szHeap
, 64);
12237 (void)cmdline_option_value(argc
, argv
, ++i
);
12239 }else if( cli_strcmp(z
,"-pagecache")==0 ){
12240 sqlite3_int64 n
, sz
;
12241 sz
= integerValue(cmdline_option_value(argc
,argv
,++i
));
12242 if( sz
>70000 ) sz
= 70000;
12244 n
= integerValue(cmdline_option_value(argc
,argv
,++i
));
12245 if( sz
>0 && n
>0 && 0xffffffffffffLL
/sz
<n
){
12246 n
= 0xffffffffffffLL
/sz
;
12248 verify_uninitialized();
12249 sqlite3_config(SQLITE_CONFIG_PAGECACHE
,
12250 (n
>0 && sz
>0) ? malloc(n
*sz
) : 0, sz
, n
);
12251 data
.shellFlgs
|= SHFLG_Pagecache
;
12252 }else if( cli_strcmp(z
,"-lookaside")==0 ){
12254 sz
= (int)integerValue(cmdline_option_value(argc
,argv
,++i
));
12256 n
= (int)integerValue(cmdline_option_value(argc
,argv
,++i
));
12258 verify_uninitialized();
12259 sqlite3_config(SQLITE_CONFIG_LOOKASIDE
, sz
, n
);
12260 if( sz
*n
==0 ) data
.shellFlgs
&= ~SHFLG_Lookaside
;
12261 }else if( cli_strcmp(z
,"-threadsafe")==0 ){
12263 n
= (int)integerValue(cmdline_option_value(argc
,argv
,++i
));
12264 verify_uninitialized();
12266 case 0: sqlite3_config(SQLITE_CONFIG_SINGLETHREAD
); break;
12267 case 2: sqlite3_config(SQLITE_CONFIG_MULTITHREAD
); break;
12268 default: sqlite3_config(SQLITE_CONFIG_SERIALIZED
); break;
12270 #ifdef SQLITE_ENABLE_VFSTRACE
12271 }else if( cli_strcmp(z
,"-vfstrace")==0 ){
12272 extern int vfstrace_register(
12273 const char *zTraceName
,
12274 const char *zOldVfsName
,
12275 int (*xOut
)(const char*,void*),
12279 vfstrace_register("trace",0,(int(*)(const char*,void*))fputs
,stderr
,1);
12281 #ifdef SQLITE_ENABLE_MULTIPLEX
12282 }else if( cli_strcmp(z
,"-multiplex")==0 ){
12283 extern int sqlite3_multiplex_initialize(const char*,int);
12284 sqlite3_multiplex_initialize(0, 1);
12286 }else if( cli_strcmp(z
,"-mmap")==0 ){
12287 sqlite3_int64 sz
= integerValue(cmdline_option_value(argc
,argv
,++i
));
12288 verify_uninitialized();
12289 sqlite3_config(SQLITE_CONFIG_MMAP_SIZE
, sz
, sz
);
12290 #if defined(SQLITE_ENABLE_SORTER_REFERENCES)
12291 }else if( cli_strcmp(z
,"-sorterref")==0 ){
12292 sqlite3_int64 sz
= integerValue(cmdline_option_value(argc
,argv
,++i
));
12293 verify_uninitialized();
12294 sqlite3_config(SQLITE_CONFIG_SORTERREF_SIZE
, (int)sz
);
12296 }else if( cli_strcmp(z
,"-vfs")==0 ){
12297 zVfs
= cmdline_option_value(argc
, argv
, ++i
);
12298 #ifdef SQLITE_HAVE_ZLIB
12299 }else if( cli_strcmp(z
,"-zip")==0 ){
12300 data
.openMode
= SHELL_OPEN_ZIPFILE
;
12302 }else if( cli_strcmp(z
,"-append")==0 ){
12303 data
.openMode
= SHELL_OPEN_APPENDVFS
;
12304 #ifndef SQLITE_OMIT_DESERIALIZE
12305 }else if( cli_strcmp(z
,"-deserialize")==0 ){
12306 data
.openMode
= SHELL_OPEN_DESERIALIZE
;
12307 }else if( cli_strcmp(z
,"-maxsize")==0 && i
+1<argc
){
12308 data
.szMax
= integerValue(argv
[++i
]);
12310 }else if( cli_strcmp(z
,"-readonly")==0 ){
12311 data
.openMode
= SHELL_OPEN_READONLY
;
12312 }else if( cli_strcmp(z
,"-nofollow")==0 ){
12313 data
.openFlags
= SQLITE_OPEN_NOFOLLOW
;
12314 #if !defined(SQLITE_OMIT_VIRTUALTABLE) && defined(SQLITE_HAVE_ZLIB)
12315 }else if( cli_strncmp(z
, "-A",2)==0 ){
12316 /* All remaining command-line arguments are passed to the ".archive"
12317 ** command, so ignore them */
12320 }else if( cli_strcmp(z
, "-memtrace")==0 ){
12321 sqlite3MemTraceActivate(stderr
);
12322 }else if( cli_strcmp(z
, "-pcachetrace")==0 ){
12323 sqlite3PcacheTraceActivate(stderr
);
12324 }else if( cli_strcmp(z
,"-bail")==0 ){
12326 }else if( cli_strcmp(z
,"-nonce")==0 ){
12328 data
.zNonce
= strdup(cmdline_option_value(argc
, argv
, ++i
));
12329 }else if( cli_strcmp(z
,"-unsafe-testing")==0 ){
12330 ShellSetFlag(&data
,SHFLG_TestingMode
);
12331 }else if( cli_strcmp(z
,"-safe")==0 ){
12332 /* no-op - catch this on the second pass */
12335 #ifndef SQLITE_SHELL_FIDDLE
12336 verify_uninitialized();
12340 #ifdef SQLITE_SHELL_INIT_PROC
12342 /* If the SQLITE_SHELL_INIT_PROC macro is defined, then it is the name
12343 ** of a C-function that will perform initialization actions on SQLite that
12344 ** occur just before or after sqlite3_initialize(). Use this compile-time
12345 ** option to embed this shell program in larger applications. */
12346 extern void SQLITE_SHELL_INIT_PROC(void);
12347 SQLITE_SHELL_INIT_PROC();
12350 /* All the sqlite3_config() calls have now been made. So it is safe
12351 ** to call sqlite3_initialize() and process any command line -vfs option. */
12352 sqlite3_initialize();
12356 sqlite3_vfs
*pVfs
= sqlite3_vfs_find(zVfs
);
12358 sqlite3_vfs_register(pVfs
, 1);
12360 eputf("no such VFS: \"%s\"\n", zVfs
);
12365 if( data
.pAuxDb
->zDbFilename
==0 ){
12366 #ifndef SQLITE_OMIT_MEMORYDB
12367 data
.pAuxDb
->zDbFilename
= ":memory:";
12368 warnInmemoryDb
= argc
==1;
12370 eputf("%s: Error: no database filename specified\n", Argv0
);
12375 #ifndef SQLITE_SHELL_FIDDLE
12376 sqlite3_appendvfs_init(0,0,0);
12379 /* Go ahead and open the database file if it already exists. If the
12380 ** file does not exist, delay opening it. This prevents empty database
12381 ** files from being created if a user mistypes the database name argument
12382 ** to the sqlite command-line tool.
12384 if( access(data
.pAuxDb
->zDbFilename
, 0)==0 ){
12388 /* Process the initialization file if there is one. If no -init option
12389 ** is given on the command line, look for a file named ~/.sqliterc and
12390 ** try to process it.
12392 process_sqliterc(&data
,zInitFile
);
12394 /* Make a second pass through the command-line argument and set
12395 ** options. This second pass is delayed until after the initialization
12396 ** file is processed so that the command-line arguments will override
12397 ** settings in the initialization file.
12399 for(i
=1; i
<argc
; i
++){
12401 if( z
[0]!='-' || i
>=nOptsEnd
) continue;
12402 if( z
[1]=='-' ){ z
++; }
12403 if( cli_strcmp(z
,"-init")==0 ){
12405 }else if( cli_strcmp(z
,"-html")==0 ){
12406 data
.mode
= MODE_Html
;
12407 }else if( cli_strcmp(z
,"-list")==0 ){
12408 data
.mode
= MODE_List
;
12409 }else if( cli_strcmp(z
,"-quote")==0 ){
12410 data
.mode
= MODE_Quote
;
12411 sqlite3_snprintf(sizeof(data
.colSeparator
), data
.colSeparator
, SEP_Comma
);
12412 sqlite3_snprintf(sizeof(data
.rowSeparator
), data
.rowSeparator
, SEP_Row
);
12413 }else if( cli_strcmp(z
,"-line")==0 ){
12414 data
.mode
= MODE_Line
;
12415 }else if( cli_strcmp(z
,"-column")==0 ){
12416 data
.mode
= MODE_Column
;
12417 }else if( cli_strcmp(z
,"-json")==0 ){
12418 data
.mode
= MODE_Json
;
12419 }else if( cli_strcmp(z
,"-markdown")==0 ){
12420 data
.mode
= MODE_Markdown
;
12421 }else if( cli_strcmp(z
,"-table")==0 ){
12422 data
.mode
= MODE_Table
;
12423 }else if( cli_strcmp(z
,"-box")==0 ){
12424 data
.mode
= MODE_Box
;
12425 }else if( cli_strcmp(z
,"-csv")==0 ){
12426 data
.mode
= MODE_Csv
;
12427 memcpy(data
.colSeparator
,",",2);
12428 #ifdef SQLITE_HAVE_ZLIB
12429 }else if( cli_strcmp(z
,"-zip")==0 ){
12430 data
.openMode
= SHELL_OPEN_ZIPFILE
;
12432 }else if( cli_strcmp(z
,"-append")==0 ){
12433 data
.openMode
= SHELL_OPEN_APPENDVFS
;
12434 #ifndef SQLITE_OMIT_DESERIALIZE
12435 }else if( cli_strcmp(z
,"-deserialize")==0 ){
12436 data
.openMode
= SHELL_OPEN_DESERIALIZE
;
12437 }else if( cli_strcmp(z
,"-maxsize")==0 && i
+1<argc
){
12438 data
.szMax
= integerValue(argv
[++i
]);
12440 }else if( cli_strcmp(z
,"-readonly")==0 ){
12441 data
.openMode
= SHELL_OPEN_READONLY
;
12442 }else if( cli_strcmp(z
,"-nofollow")==0 ){
12443 data
.openFlags
|= SQLITE_OPEN_NOFOLLOW
;
12444 }else if( cli_strcmp(z
,"-ascii")==0 ){
12445 data
.mode
= MODE_Ascii
;
12446 sqlite3_snprintf(sizeof(data
.colSeparator
), data
.colSeparator
,SEP_Unit
);
12447 sqlite3_snprintf(sizeof(data
.rowSeparator
), data
.rowSeparator
,SEP_Record
);
12448 }else if( cli_strcmp(z
,"-tabs")==0 ){
12449 data
.mode
= MODE_List
;
12450 sqlite3_snprintf(sizeof(data
.colSeparator
), data
.colSeparator
,SEP_Tab
);
12451 sqlite3_snprintf(sizeof(data
.rowSeparator
), data
.rowSeparator
,SEP_Row
);
12452 }else if( cli_strcmp(z
,"-separator")==0 ){
12453 sqlite3_snprintf(sizeof(data
.colSeparator
), data
.colSeparator
,
12454 "%s",cmdline_option_value(argc
,argv
,++i
));
12455 }else if( cli_strcmp(z
,"-newline")==0 ){
12456 sqlite3_snprintf(sizeof(data
.rowSeparator
), data
.rowSeparator
,
12457 "%s",cmdline_option_value(argc
,argv
,++i
));
12458 }else if( cli_strcmp(z
,"-nullvalue")==0 ){
12459 sqlite3_snprintf(sizeof(data
.nullValue
), data
.nullValue
,
12460 "%s",cmdline_option_value(argc
,argv
,++i
));
12461 }else if( cli_strcmp(z
,"-header")==0 ){
12462 data
.showHeader
= 1;
12463 ShellSetFlag(&data
, SHFLG_HeaderSet
);
12464 }else if( cli_strcmp(z
,"-noheader")==0 ){
12465 data
.showHeader
= 0;
12466 ShellSetFlag(&data
, SHFLG_HeaderSet
);
12467 }else if( cli_strcmp(z
,"-echo")==0 ){
12468 ShellSetFlag(&data
, SHFLG_Echo
);
12469 }else if( cli_strcmp(z
,"-eqp")==0 ){
12470 data
.autoEQP
= AUTOEQP_on
;
12471 }else if( cli_strcmp(z
,"-eqpfull")==0 ){
12472 data
.autoEQP
= AUTOEQP_full
;
12473 }else if( cli_strcmp(z
,"-stats")==0 ){
12475 }else if( cli_strcmp(z
,"-scanstats")==0 ){
12476 data
.scanstatsOn
= 1;
12477 }else if( cli_strcmp(z
,"-backslash")==0 ){
12478 /* Undocumented command-line option: -backslash
12479 ** Causes C-style backslash escapes to be evaluated in SQL statements
12480 ** prior to sending the SQL into SQLite. Useful for injecting
12481 ** crazy bytes in the middle of SQL statements for testing and debugging.
12483 ShellSetFlag(&data
, SHFLG_Backslash
);
12484 }else if( cli_strcmp(z
,"-bail")==0 ){
12485 /* No-op. The bail_on_error flag should already be set. */
12486 }else if( cli_strcmp(z
,"-version")==0 ){
12487 /* BEGIN SQLCIPHER */
12488 #ifdef SQLITE_HAS_CODEC
12489 extern char* sqlcipher_version();
12490 char *sqlcipher_ver
= sqlcipher_version();
12491 sputf(stdout
, "%s %s (%d-bit)",
12492 sqlite3_libversion(), sqlite3_sourceid(), 8*(int)sizeof(char*));
12493 sputf(stdout
, " (SQLCipher %s)\n", sqlcipher_ver
);
12494 sqlite3_free(sqlcipher_ver
);
12496 sputf(stdout
, "%s %s (%d-bit)\n",
12497 sqlite3_libversion(), sqlite3_sourceid(), 8*(int)sizeof(char*));
12499 /* END SQLCIPHER */
12501 }else if( cli_strcmp(z
,"-interactive")==0 ){
12502 /* Need to check for interactive override here to so that it can
12503 ** affect console setup (for Windows only) and testing thereof.
12505 stdin_is_interactive
= 1;
12506 }else if( cli_strcmp(z
,"-batch")==0 ){
12507 /* already handled */
12508 }else if( cli_strcmp(z
,"-utf8")==0 ){
12509 /* already handled */
12510 }else if( cli_strcmp(z
,"-no-utf8")==0 ){
12511 /* already handled */
12512 }else if( cli_strcmp(z
,"-no-rowid-in-view")==0 ){
12513 /* already handled */
12514 }else if( cli_strcmp(z
,"-heap")==0 ){
12516 }else if( cli_strcmp(z
,"-pagecache")==0 ){
12518 }else if( cli_strcmp(z
,"-lookaside")==0 ){
12520 }else if( cli_strcmp(z
,"-threadsafe")==0 ){
12522 }else if( cli_strcmp(z
,"-nonce")==0 ){
12524 }else if( cli_strcmp(z
,"-mmap")==0 ){
12526 }else if( cli_strcmp(z
,"-memtrace")==0 ){
12528 }else if( cli_strcmp(z
,"-pcachetrace")==0 ){
12530 #ifdef SQLITE_ENABLE_SORTER_REFERENCES
12531 }else if( cli_strcmp(z
,"-sorterref")==0 ){
12534 }else if( cli_strcmp(z
,"-vfs")==0 ){
12536 #ifdef SQLITE_ENABLE_VFSTRACE
12537 }else if( cli_strcmp(z
,"-vfstrace")==0 ){
12540 #ifdef SQLITE_ENABLE_MULTIPLEX
12541 }else if( cli_strcmp(z
,"-multiplex")==0 ){
12544 }else if( cli_strcmp(z
,"-help")==0 ){
12546 }else if( cli_strcmp(z
,"-cmd")==0 ){
12547 /* Run commands that follow -cmd first and separately from commands
12548 ** that simply appear on the command-line. This seems goofy. It would
12549 ** be better if all commands ran in the order that they appear. But
12550 ** we retain the goofy behavior for historical compatibility. */
12551 if( i
==argc
-1 ) break;
12552 z
= cmdline_option_value(argc
,argv
,++i
);
12554 rc
= do_meta_command(z
, &data
);
12555 if( rc
&& bail_on_error
) return rc
==2 ? 0 : rc
;
12558 rc
= shell_exec(&data
, z
, &zErrMsg
);
12560 eputf("Error: %s\n", zErrMsg
);
12561 if( bail_on_error
) return rc
!=0 ? rc
: 1;
12563 eputf("Error: unable to process SQL \"%s\"\n", z
);
12564 if( bail_on_error
) return rc
;
12567 #if !defined(SQLITE_OMIT_VIRTUALTABLE) && defined(SQLITE_HAVE_ZLIB)
12568 }else if( cli_strncmp(z
, "-A", 2)==0 ){
12570 eputf("Error: cannot mix regular SQL or dot-commands"
12571 " with \"%s\"\n", z
);
12574 open_db(&data
, OPEN_DB_ZIPFILE
);
12577 arDotCommand(&data
, 1, argv
+(i
-1), argc
-(i
-1));
12579 arDotCommand(&data
, 1, argv
+i
, argc
-i
);
12584 }else if( cli_strcmp(z
,"-safe")==0 ){
12585 data
.bSafeMode
= data
.bSafeModePersist
= 1;
12586 }else if( cli_strcmp(z
,"-unsafe-testing")==0 ){
12587 /* Acted upon in first pass. */
12589 eputf("%s: Error: unknown option: %s\n", Argv0
, z
);
12590 eputz("Use -help for a list of options.\n");
12593 data
.cMode
= data
.mode
;
12597 /* Run all arguments that do not begin with '-' as if they were separate
12598 ** command-line inputs, except for the argToSkip argument which contains
12599 ** the database filename.
12601 for(i
=0; i
<nCmd
; i
++){
12602 if( azCmd
[i
][0]=='.' ){
12603 rc
= do_meta_command(azCmd
[i
], &data
);
12606 return rc
==2 ? 0 : rc
;
12610 echo_group_input(&data
, azCmd
[i
]);
12611 rc
= shell_exec(&data
, azCmd
[i
], &zErrMsg
);
12612 if( zErrMsg
|| rc
){
12614 eputf("Error: %s\n", zErrMsg
);
12616 eputf("Error: unable to process SQL: %s\n", azCmd
[i
]);
12618 sqlite3_free(zErrMsg
);
12620 return rc
!=0 ? rc
: 1;
12625 /* Run commands received from standard input
12627 if( stdin_is_interactive
){
12631 #if CIO_WIN_WC_XLATE
12632 # define SHELL_CIO_CHAR_SET (stdout_is_console? " (UTF-16 console I/O)" : "")
12634 # define SHELL_CIO_CHAR_SET ""
12636 /* BEGIN SQLCIPHER */
12637 #ifdef SQLITE_HAS_CODEC
12639 extern char* sqlcipher_version();
12640 char *sqlcipher_ver
= sqlcipher_version();
12641 sputf(stdout
, "SQLite version %s %.19s%s" /*extra-version-info*/
12642 " (SQLCipher %s)\n" /*sqlcipher version info*/
12643 "Enter \".help\" for usage hints.\n",
12644 sqlite3_libversion(), sqlite3_sourceid(), SHELL_CIO_CHAR_SET
, sqlcipher_ver
);
12645 sqlite3_free(sqlcipher_ver
);
12648 sputf(stdout
, "SQLite version %s %.19s%s\n" /*extra-version-info*/
12649 "Enter \".help\" for usage hints.\n",
12650 sqlite3_libversion(), sqlite3_sourceid(), SHELL_CIO_CHAR_SET
);
12652 /* END SQLCIPHER */
12653 if( warnInmemoryDb
){
12654 sputz(stdout
, "Connected to a ");
12655 printBold("transient in-memory database");
12656 sputz(stdout
, ".\nUse \".open FILENAME\" to reopen on a"
12657 " persistent database.\n");
12659 zHistory
= getenv("SQLITE_HISTORY");
12661 zHistory
= strdup(zHistory
);
12662 }else if( (zHome
= find_home_dir(0))!=0 ){
12663 nHistory
= strlen30(zHome
) + 20;
12664 if( (zHistory
= malloc(nHistory
))!=0 ){
12665 sqlite3_snprintf(nHistory
, zHistory
,"%s/.sqlite_history", zHome
);
12668 if( zHistory
){ shell_read_history(zHistory
); }
12669 #if HAVE_READLINE || HAVE_EDITLINE
12670 rl_attempted_completion_function
= readline_completion
;
12671 #elif HAVE_LINENOISE
12672 linenoiseSetCompletionCallback(linenoise_completion
);
12675 rc
= process_input(&data
);
12677 shell_stifle_history(2000);
12678 shell_write_history(zHistory
);
12683 rc
= process_input(&data
);
12686 #ifndef SQLITE_SHELL_FIDDLE
12687 /* In WASM mode we have to leave the db state in place so that
12688 ** client code can "push" SQL into it after this call returns. */
12690 set_table_name(&data
, 0);
12692 session_close_all(&data
, -1);
12695 for(i
=0; i
<ArraySize(data
.aAuxDb
); i
++){
12696 sqlite3_free(data
.aAuxDb
[i
].zFreeOnClose
);
12697 if( data
.aAuxDb
[i
].db
){
12698 session_close_all(&data
, i
);
12699 close_db(data
.aAuxDb
[i
].db
);
12703 output_reset(&data
);
12704 data
.doXdgOpen
= 0;
12705 clearTempFile(&data
);
12706 #if !SQLITE_SHELL_IS_UTF8
12707 for(i
=0; i
<argcToFree
; i
++) free(argvToFree
[i
]);
12710 free(data
.colWidth
);
12712 /* Clear the global data structure so that valgrind will detect memory
12714 memset(&data
, 0, sizeof(data
));
12715 #ifdef SQLITE_DEBUG
12716 if( sqlite3_memory_used()>mem_main_enter
){
12717 eputf("Memory leaked: %u bytes\n",
12718 (unsigned int)(sqlite3_memory_used()-mem_main_enter
));
12721 #endif /* !SQLITE_SHELL_FIDDLE */
12726 #ifdef SQLITE_SHELL_FIDDLE
12727 /* Only for emcc experimentation purposes. */
12728 int fiddle_experiment(int a
,int b
){
12733 ** Returns a pointer to the current DB handle.
12735 sqlite3
* fiddle_db_handle(){
12740 ** Returns a pointer to the given DB name's VFS. If zDbName is 0 then
12741 ** "main" is assumed. Returns 0 if no db with the given name is
12744 sqlite3_vfs
* fiddle_db_vfs(const char *zDbName
){
12745 sqlite3_vfs
* pVfs
= 0;
12747 sqlite3_file_control(globalDb
, zDbName
? zDbName
: "main",
12748 SQLITE_FCNTL_VFS_POINTER
, &pVfs
);
12753 /* Only for emcc experimentation purposes. */
12754 sqlite3
* fiddle_db_arg(sqlite3
*arg
){
12755 printf("fiddle_db_arg(%p)\n", (const void*)arg
);
12760 ** Intended to be called via a SharedWorker() while a separate
12761 ** SharedWorker() (which manages the wasm module) is performing work
12762 ** which should be interrupted. Unfortunately, SharedWorker is not
12763 ** portable enough to make real use of.
12765 void fiddle_interrupt(void){
12766 if( globalDb
) sqlite3_interrupt(globalDb
);
12770 ** Returns the filename of the given db name, assuming "main" if
12771 ** zDbName is NULL. Returns NULL if globalDb is not opened.
12773 const char * fiddle_db_filename(const char * zDbName
){
12775 ? sqlite3_db_filename(globalDb
, zDbName
? zDbName
: "main")
12780 ** Completely wipes out the contents of the currently-opened database
12781 ** but leaves its storage intact for reuse.
12783 void fiddle_reset_db(void){
12785 int rc
= sqlite3_db_config(globalDb
, SQLITE_DBCONFIG_RESET_DATABASE
, 1, 0);
12786 if( 0==rc
) rc
= sqlite3_exec(globalDb
, "VACUUM", 0, 0, 0);
12787 sqlite3_db_config(globalDb
, SQLITE_DBCONFIG_RESET_DATABASE
, 0, 0);
12792 ** Uses the current database's VFS xRead to stream the db file's
12793 ** contents out to the given callback. The callback gets a single
12794 ** chunk of size n (its 2nd argument) on each call and must return 0
12795 ** on success, non-0 on error. This function returns 0 on success,
12796 ** SQLITE_NOTFOUND if no db is open, or propagates any other non-0
12797 ** code from the callback. Note that this is not thread-friendly: it
12798 ** expects that it will be the only thread reading the db file and
12799 ** takes no measures to ensure that is the case.
12801 int fiddle_export_db( int (*xCallback
)(unsigned const char *zOut
, int n
) ){
12802 sqlite3_int64 nSize
= 0;
12803 sqlite3_int64 nPos
= 0;
12804 sqlite3_file
* pFile
= 0;
12805 unsigned char buf
[1024 * 8];
12806 int nBuf
= (int)sizeof(buf
);
12807 int rc
= shellState
.db
12808 ? sqlite3_file_control(shellState
.db
, "main",
12809 SQLITE_FCNTL_FILE_POINTER
, &pFile
)
12811 if( rc
) return rc
;
12812 rc
= pFile
->pMethods
->xFileSize(pFile
, &nSize
);
12813 if( rc
) return rc
;
12815 /* DB size is not an even multiple of the buffer size. Reduce
12816 ** buffer size so that we do not unduly inflate the db size when
12818 if(0 == nSize
% 4096) nBuf
= 4096;
12819 else if(0 == nSize
% 2048) nBuf
= 2048;
12820 else if(0 == nSize
% 1024) nBuf
= 1024;
12823 for( ; 0==rc
&& nPos
<nSize
; nPos
+= nBuf
){
12824 rc
= pFile
->pMethods
->xRead(pFile
, buf
, nBuf
, nPos
);
12825 if(SQLITE_IOERR_SHORT_READ
== rc
){
12826 rc
= (nPos
+ nBuf
) < nSize
? rc
: 0/*assume EOF*/;
12828 if( 0==rc
) rc
= xCallback(buf
, nBuf
);
12834 ** Trivial exportable function for emscripten. It processes zSql as if
12835 ** it were input to the sqlite3 shell and redirects all output to the
12836 ** wasm binding. fiddle_main() must have been called before this
12837 ** is called, or results are undefined.
12839 void fiddle_exec(const char * zSql
){
12841 if('.'==*zSql
) puts(zSql
);
12842 shellState
.wasm
.zInput
= zSql
;
12843 shellState
.wasm
.zPos
= zSql
;
12844 process_input(&shellState
);
12845 shellState
.wasm
.zInput
= shellState
.wasm
.zPos
= 0;
12848 #endif /* SQLITE_SHELL_FIDDLE */