--- /dev/null
+<h1 align="center">SQLite Source Repository</h1>
+
+This repository contains the complete source code for the SQLite database
+engine. Some test scripts are also include. However, many other test scripts
+and most of the documentation are managed separately.
+
+## Compiling
+
+First create a directory in which to place
+the build products. It is recommended, but not required, that the
+build directory be separate from the source directory. Cd into the
+build directory and then from the build directory run the configure
+script found at the root of the source tree. Then run "make".
+
+For example:
+
+ tar xzf sqlite.tar.gz ;# Unpack the source tree into "sqlite"
+ mkdir bld ;# Build will occur in a sibling directory
+ cd bld ;# Change to the build directory
+ ../sqlite/configure ;# Run the configure script
+ make ;# Run the makefile.
+ make sqlite3.c ;# Build the "amalgamation" source file
+ make test ;# Run some tests (requires TCL)
+
+See the makefile for additional targets.
+
+The configure script uses autoconf 2.61 and libtool. If the configure
+script does not work out for you, there is a generic makefile named
+"Makefile.linux-gcc" in the top directory of the source tree that you
+can copy and edit to suit your needs. Comments on the generic makefile
+show what changes are needed.
+
+SQLite does not require TCL to run, but a TCL installation is required
+by the makefiles. SQLite contains a lot of generated code and TCL is
+used to do much of that code generation. The makefile also requires
+AWK.
+
+## Source Code Tour
+
+Most of the core source files are in the **src/** subdirectory. But
+src/ also contains files used to build the "testfixture" test harness;
+those file all begin with "test". And src/ contains the "shell.c" file
+which is the main program for the "sqlite3.exe" command-line shell and
+the "tclsqlite.c" file which implements the bindings to SQLite from the
+TCL programming language. (Historical note: SQLite began as a TCL
+extension and only later escaped to the wild as an independent library.)
+
+Test scripts and programs are found in the **test/** subdirectory.
+There are other test suites for SQLite (see
+[How SQLite Is Tested](http://www.sqlite.org/testing.html))
+but those other test suites are
+in separate source repositories.
+
+The **ext/** subdirectory contains code for extensions. The
+Full-text search engine is in **ext/fts3**. The R-Tree engine is in
+**ext/rtree**. The **ext/misc** subdirectory contains a number of
+smaller, single-file extensions, such as a REGEXP operator.
+
+The **tool/** subdirectory contains various scripts and programs used
+for building generated source code files or for testing or for generating
+accessory programs such as "sqlite3_analyzer(.exe)".
+
+### Generated Source Code Files
+
+Several of the C-language source files used by SQLite are generated from
+other sources rather than being typed in manually by a programmer. This
+section will summarize those automatically-generated files. To create all
+of the automatically-generated files, simply run "make target_source".
+The "target_source" make target will create a subdirectory "tsrc/" and
+fill it with all the source files needed to build SQLite, both
+manually-edited files and automatically-generated files.
+
+The SQLite interface is defined by the **sqlite3.h** header file, which is
+generated from src/sqlite.h.in, ./manifest.uuid, and ./VERSION. The
+TCL script at tool/mksqlite3h.tcl does the conversion. The manifest.uuid
+file contains the SHA1 hash of the particular check-in and is used to generate
+the SQLITE_SOURCE_ID macro. The VERSION file contains the current SQLite
+version number. The sqlite3.h header is really just a copy of src/sqlite.h.in
+with the source-id and version number inserted at just the right spots.
+Note that comment text in the sqlite3.h file is used to generate much of
+the SQLite API documentation. The TCL scripts used to generate that
+documentation are in a separate source repository.
+
+The SQL language parser is **parse.c** which is generate from a grammar in
+the src/parse.y file. The conversion of "parse.y" into "parse.c" is done
+by the [lemon](./doc/lemon.html) LALR(1) parser generator. The source code
+for lemon is at tool/lemon.c. Lemon uses a
+template for generating its parser. A generic template is in tool/lempar.c,
+but SQLite uses a slightly modified template found in src/lempar.c.
+
+Lemon also generates the **parse.h** header file, at the same time it
+generates parse.c. But the parse.h header file is
+modified further (to add additional symbols) using the ./addopcodes.awk
+AWK script.
+
+The **opcodes.h** header file contains macros that define the numbers
+corresponding to opcodes in the "VDBE" virtual machine. The opcodes.h
+file is generated by the scanning the src/vdbe.c source file. The
+AWK script at ./mkopcodeh.awk does this scan and generates opcodes.h.
+A second AWK script, ./mkopcodec.awk, then scans opcodes.h to generate
+the **opcodes.c** source file, which contains a reverse mapping from
+opcode-number to opcode-name that is used for EXPLAIN output.
+
+The **keywordhash.h** header file contains the definition of a hash table
+that maps SQL language keywords (ex: "CREATE", "SELECT", "INDEX", etc.) into
+the numeric codes used by the parse.c parser. The keywordhash.h file is
+generated by a C-language program at tool mkkeywordhash.c.
+
+### The Amalgamation
+
+All of the individual C source code and header files (both manually-edited
+and automatically-generated) can be combined into a single big source file
+**sqlite3.c** called "the amalgamation". The amalgamation is the recommended
+way of using SQLite in a larger application. Combining all individual
+source code files into a single big source code file allows the C compiler
+to perform more cross-procedure analysis and generate better code. SQLite
+runs about 5% faster when compiled from the amalgamation versus when compiled
+from individual source files.
+
+The amalgamation is generated from the tool/mksqlite3c.tcl TCL script.
+First, all of the individual source files must be gathered into the tsrc/
+subdirectory (using the equivalent of "make target_source") then the
+tool/mksqlite3c.tcl script is run to copy them all together in just the
+right order while resolving internal "#include" references.
+
+The amalgamation source file is more than 100K lines long. Some symbolic
+debuggers (most notably MSVC) are unable to deal with files longer than 64K
+lines. To work around this, a separate TCL script, tool/split-sqlite3c.tcl,
+can be run on the amalgamation to break it up into a single small C file
+called **sqlite3-all.c** that does #include on about five other files
+named **sqlite3-1.c**, **sqlite3-2.c**, ..., **sqlite3-5.c**. In this way,
+all of the source code is contained within a single translation unit so
+that the compiler can do extra cross-procedure optimization, but no
+individual source file exceeds 32K lines in length.
+
+## How It All Fits Together
+
+SQLite is modular in design.
+See the [architectural description](http://www.sqlite.org/arch.html)
+for details. Other documents that are useful in
+(helping to understand how SQLite works include the
+[file format](http://www.sqlite.org/fileformat2.html) description,
+the [virtual machine](http://www.sqlite.org/vdbe.html) that runs
+prepared statements, the description of
+[how transactions work](http://www.sqlite.org/atomiccommit.html), and
+the [overview of the query planner](http://www.sqlite.org/optoverview.html).
+
+Unfortunately, years of effort have gone into optimizating SQLite, both
+for small size and high performance. And optimizations tend to result in
+complex code. So there is a lot of complexity in the SQLite implementation.
+
+Key files:
+
+ * **sqlite3.h** - This file defines the public interface to the SQLite
+ library. Readers will need to be familiar with this interface before
+ trying to understand how the library works internally.
+
+ * **sqliteInt.h** - this header file defines many of the data objects
+ used internally by SQLite.
+
+ * **parse.y** - This file describes the LALR(1) grammer that SQLite uses
+ to parse SQL statements, and the actions that are taken at each stop
+ in the parsing process.
+
+ * **vdbe.c** - This file implements the virtual machine that runs
+ prepared statements. There are various helper files whose names
+ begin with "vdbe". The VDBE has access to the vdbeInt.h header file
+ which defines internal data objects. The rest of SQLite interacts
+ with the VDBE through an interface defined by vdbe.h.
+
+ * **where.c** - This file analyzes the WHERE clause and generates
+ virtual machine code to run queries efficiently. This file is
+ sometimes called the "query optimizer". It has its own private
+ header file, whereInt.h, that defines data objects used internally.
+
+ * **btree.c** - This file contains the implementation of the B-Tree
+ storage engine used by SQLite.
+
+ * **pager.c** - This file contains the "pager" implementation, the
+ module that implements transactions.
+
+ * **os_unix.c** and **os_win.c** - These two files implement the interface
+ between SQLite and the underlying operating system using the run-time
+ pluggable VFS interface.
+
+
+## Contacts
+
+The main SQLite webpage is [http://www.sqlite.org/](http://www.sqlite.org/)
+with geographically distributed backup servers at
+[http://www2.sqlite.org/](http://www2.sqlite.org) and
+[http://www3.sqlite.org/](http://www3.sqlite.org).
-C Avoid\spassing\sa\sflags\sargument\swith\sthe\sinternal\sWAL_SYNC_TRANSACTIONS\sbit\sset\swhen\scalling\ssqlite3OsSync().
-D 2014-02-13T18:46:59.101
+C Change\sREADME\sto\sREADME.md\sand\sexpand\sit.\s\sRemove\sunrelated\sand\sobsolete\sfiles.
+D 2014-02-13T19:10:24.061
F Makefile.arm-wince-mingw32ce-gcc d6df77f1f48d690bd73162294bbba7f59507c72f
F Makefile.in 2ef13430cd359f7b361bb863504e227b25cc7f81
F Makefile.linux-gcc 91d710bdc4998cb015f39edf3cb314ec4f4d7e23
F Makefile.msc 6ff3ff2eef45c7dd309a8626ff7947b20bd387e7
F Makefile.vxworks db21ed42a01d5740e656b16f92cb5d8d5e5dd315
-F README cd04a36fbc7ea56932a4052d7d0b7f09f27c33d6
+F README.md 8ff4548af6f7cdf4b02e585d4dd552b233998a9b w README
F VERSION 0dc30ad5cf90736d5fd9e540c9f05c542658abe7
F aclocal.m4 a5c22d164aff7ed549d53a90fa56d56955281f50
F addopcodes.awk 9eb448a552d5c0185cf62c463f9c173cedae3811
F ltmain.sh 3ff0879076df340d2e23ae905484d8c15d5fdea8
F magic.txt f439556c5ce01ced70987e5ee86549a45165d9ff
F main.mk 3ae543fa446525c1dec55f58de67f41b78651812
-F mkdll.sh 7d09b23c05d56532e9d44a50868eb4b12ff4f74a
-F mkextu.sh 416f9b7089d80e5590a29692c9d9280a10dbad9f
-F mkextw.sh d2a981497b404d6498f5ff3e3b1f3816bdfcb338
F mkopcodec.awk c2ff431854d702cdd2d779c9c0d1f58fa16fa4ea
F mkopcodeh.awk c6b3fa301db6ef7ac916b14c60868aeaec1337b5
F mkso.sh fd21c06b063bb16a5d25deea1752c2da6ac3ed83
F tool/warnings-clang.sh f6aa929dc20ef1f856af04a730772f59283631d4
F tool/warnings.sh d1a6de74685f360ab718efda6265994b99bbea01
F tool/win/sqlite.vsix 030f3eeaf2cb811a3692ab9c14d021a75ce41fff
-P b81ba7a4bc7e840fce25fc6801957a64f877ff60
-R a59cd87bb88fdc66ea1a7d77759b0c27
-U dan
-Z 4fedb8574b1ff1640e605452066ee2b1
+P e3b79e920c298a39613631d689d1a2f182d00496
+R 32cef02970d5145eabe1c7cffe4376d1
+U drh
+Z 910a038630fdb9ee9dcf69294f2c5c44
+++ /dev/null
-#!/bin/sh
-#
-# This script is used to compile SQLite into a DLL.
-#
-# Two separate DLLs are generated. "sqlite3.dll" is the core
-# library. "tclsqlite3.dll" contains the TCL bindings and is the
-# library that is loaded into TCL in order to run SQLite.
-#
-make sqlite3.c
-PATH=$PATH:/opt/mingw/bin
-TCLDIR=/home/drh/tcltk/846/win/846win
-TCLSTUBLIB=$TCLDIR/libtcl84stub.a
-OPTS='-DUSE_TCL_STUBS=1 -DBUILD_sqlite=1 -DSQLITE_OS_WIN=1'
-OPTS="$OPTS -DSQLITE_THREADSAFE=1"
-OPTS="$OPTS -DSQLITE_ENABLE_FTS3=1"
-OPTS="$OPTS -DSQLITE_ENABLE_RTREE=1"
-OPTS="$OPTS -DSQLITE_ENABLE_COLUMN_METADATA=1"
-CC="i386-mingw32msvc-gcc -Os $OPTS -Itsrc -I$TCLDIR"
-NM="i386-mingw32msvc-nm"
-CMD="$CC -c sqlite3.c"
-echo $CMD
-$CMD
-CMD="$CC -c tclsqlite3.c"
-echo $CMD
-$CMD
-echo 'EXPORTS' >tclsqlite3.def
-$NM tclsqlite3.o | grep ' T ' >temp1
-grep '_Init$' temp1 >temp2
-grep '_SafeInit$' temp1 >>temp2
-grep ' T _sqlite3_' temp1 >>temp2
-echo 'EXPORTS' >tclsqlite3.def
-sed 's/^.* T _//' temp2 | sort | uniq >>tclsqlite3.def
-i386-mingw32msvc-dllwrap \
- --def tclsqlite3.def -v --export-all \
- --driver-name i386-mingw32msvc-gcc \
- --dlltool-name i386-mingw32msvc-dlltool \
- --as i386-mingw32msvc-as \
- --target i386-mingw32 \
- -dllname tclsqlite3.dll -lmsvcrt tclsqlite3.o $TCLSTUBLIB
-$NM sqlite3.o | grep ' T ' >temp1
-echo 'EXPORTS' >sqlite3.def
-grep ' _sqlite3_' temp1 | sed 's/^.* _//' >>sqlite3.def
-i386-mingw32msvc-dllwrap \
- --def sqlite3.def -v --export-all \
- --driver-name i386-mingw32msvc-gcc \
- --dlltool-name i386-mingw32msvc-dlltool \
- --as i386-mingw32msvc-as \
- --target i386-mingw32 \
- -dllname sqlite3.dll -lmsvcrt sqlite3.o
projects / thirdparty / sqlite.git / commitdiff
