sqlite3 1.3.3-x86-mswin32-60
Sign up to get free protection for your applications and to get access to all the features.
- data/API_CHANGES.rdoc +50 -0
- data/CHANGELOG.rdoc +177 -0
- data/ChangeLog.cvs +88 -0
- data/LICENSE +27 -0
- data/Manifest.txt +50 -0
- data/README.rdoc +103 -0
- data/Rakefile +10 -0
- data/ext/sqlite3/backup.c +164 -0
- data/ext/sqlite3/backup.h +15 -0
- data/ext/sqlite3/database.c +762 -0
- data/ext/sqlite3/database.h +15 -0
- data/ext/sqlite3/exception.c +94 -0
- data/ext/sqlite3/exception.h +8 -0
- data/ext/sqlite3/extconf.rb +47 -0
- data/ext/sqlite3/sqlite3.c +36 -0
- data/ext/sqlite3/sqlite3_ruby.h +44 -0
- data/ext/sqlite3/statement.c +419 -0
- data/ext/sqlite3/statement.h +16 -0
- data/faq/faq.rb +145 -0
- data/faq/faq.yml +426 -0
- data/lib/sqlite3.rb +10 -0
- data/lib/sqlite3/1.8/sqlite3_native.so +0 -0
- data/lib/sqlite3/1.9/sqlite3_native.so +0 -0
- data/lib/sqlite3/constants.rb +49 -0
- data/lib/sqlite3/database.rb +587 -0
- data/lib/sqlite3/errors.rb +44 -0
- data/lib/sqlite3/pragmas.rb +280 -0
- data/lib/sqlite3/resultset.rb +126 -0
- data/lib/sqlite3/statement.rb +148 -0
- data/lib/sqlite3/translator.rb +118 -0
- data/lib/sqlite3/value.rb +57 -0
- data/lib/sqlite3/version.rb +25 -0
- data/setup.rb +1333 -0
- data/tasks/faq.rake +9 -0
- data/tasks/gem.rake +31 -0
- data/tasks/native.rake +61 -0
- data/tasks/vendor_sqlite3.rake +104 -0
- data/test/helper.rb +3 -0
- data/test/test_backup.rb +33 -0
- data/test/test_collation.rb +82 -0
- data/test/test_database.rb +312 -0
- data/test/test_database_readonly.rb +29 -0
- data/test/test_deprecated.rb +37 -0
- data/test/test_encoding.rb +119 -0
- data/test/test_integration.rb +544 -0
- data/test/test_integration_open_close.rb +30 -0
- data/test/test_integration_pending.rb +115 -0
- data/test/test_integration_resultset.rb +156 -0
- data/test/test_integration_statement.rb +194 -0
- data/test/test_sqlite3.rb +9 -0
- data/test/test_statement.rb +207 -0
- data/test/test_statement_execute.rb +35 -0
- metadata +202 -0
@@ -0,0 +1,44 @@
|
|
1
|
+
require 'sqlite3/constants'
|
2
|
+
|
3
|
+
module SQLite3
|
4
|
+
class Exception < ::StandardError
|
5
|
+
@code = 0
|
6
|
+
|
7
|
+
# The numeric error code that this exception represents.
|
8
|
+
def self.code
|
9
|
+
@code
|
10
|
+
end
|
11
|
+
|
12
|
+
# A convenience for accessing the error code for this exception.
|
13
|
+
def code
|
14
|
+
self.class.code
|
15
|
+
end
|
16
|
+
end
|
17
|
+
|
18
|
+
class SQLException < Exception; end
|
19
|
+
class InternalException < Exception; end
|
20
|
+
class PermissionException < Exception; end
|
21
|
+
class AbortException < Exception; end
|
22
|
+
class BusyException < Exception; end
|
23
|
+
class LockedException < Exception; end
|
24
|
+
class MemoryException < Exception; end
|
25
|
+
class ReadOnlyException < Exception; end
|
26
|
+
class InterruptException < Exception; end
|
27
|
+
class IOException < Exception; end
|
28
|
+
class CorruptException < Exception; end
|
29
|
+
class NotFoundException < Exception; end
|
30
|
+
class FullException < Exception; end
|
31
|
+
class CantOpenException < Exception; end
|
32
|
+
class ProtocolException < Exception; end
|
33
|
+
class EmptyException < Exception; end
|
34
|
+
class SchemaChangedException < Exception; end
|
35
|
+
class TooBigException < Exception; end
|
36
|
+
class ConstraintException < Exception; end
|
37
|
+
class MismatchException < Exception; end
|
38
|
+
class MisuseException < Exception; end
|
39
|
+
class UnsupportedException < Exception; end
|
40
|
+
class AuthorizationException < Exception; end
|
41
|
+
class FormatException < Exception; end
|
42
|
+
class RangeException < Exception; end
|
43
|
+
class NotADatabaseException < Exception; end
|
44
|
+
end
|
@@ -0,0 +1,280 @@
|
|
1
|
+
require 'sqlite3/errors'
|
2
|
+
|
3
|
+
module SQLite3
|
4
|
+
|
5
|
+
# This module is intended for inclusion solely by the Database class. It
|
6
|
+
# defines convenience methods for the various pragmas supported by SQLite3.
|
7
|
+
#
|
8
|
+
# For a detailed description of these pragmas, see the SQLite3 documentation
|
9
|
+
# at http://sqlite.org/pragma.html.
|
10
|
+
module Pragmas
|
11
|
+
|
12
|
+
# Returns +true+ or +false+ depending on the value of the named pragma.
|
13
|
+
def get_boolean_pragma( name )
|
14
|
+
get_first_value( "PRAGMA #{name}" ) != "0"
|
15
|
+
end
|
16
|
+
private :get_boolean_pragma
|
17
|
+
|
18
|
+
# Sets the given pragma to the given boolean value. The value itself
|
19
|
+
# may be +true+ or +false+, or any other commonly used string or
|
20
|
+
# integer that represents truth.
|
21
|
+
def set_boolean_pragma( name, mode )
|
22
|
+
case mode
|
23
|
+
when String
|
24
|
+
case mode.downcase
|
25
|
+
when "on", "yes", "true", "y", "t"; mode = "'ON'"
|
26
|
+
when "off", "no", "false", "n", "f"; mode = "'OFF'"
|
27
|
+
else
|
28
|
+
raise Exception,
|
29
|
+
"unrecognized pragma parameter #{mode.inspect}"
|
30
|
+
end
|
31
|
+
when true, 1
|
32
|
+
mode = "ON"
|
33
|
+
when false, 0, nil
|
34
|
+
mode = "OFF"
|
35
|
+
else
|
36
|
+
raise Exception,
|
37
|
+
"unrecognized pragma parameter #{mode.inspect}"
|
38
|
+
end
|
39
|
+
|
40
|
+
execute( "PRAGMA #{name}=#{mode}" )
|
41
|
+
end
|
42
|
+
private :set_boolean_pragma
|
43
|
+
|
44
|
+
# Requests the given pragma (and parameters), and if the block is given,
|
45
|
+
# each row of the result set will be yielded to it. Otherwise, the results
|
46
|
+
# are returned as an array.
|
47
|
+
def get_query_pragma( name, *parms, &block ) # :yields: row
|
48
|
+
if parms.empty?
|
49
|
+
execute( "PRAGMA #{name}", &block )
|
50
|
+
else
|
51
|
+
args = "'" + parms.join("','") + "'"
|
52
|
+
execute( "PRAGMA #{name}( #{args} )", &block )
|
53
|
+
end
|
54
|
+
end
|
55
|
+
private :get_query_pragma
|
56
|
+
|
57
|
+
# Return the value of the given pragma.
|
58
|
+
def get_enum_pragma( name )
|
59
|
+
get_first_value( "PRAGMA #{name}" )
|
60
|
+
end
|
61
|
+
private :get_enum_pragma
|
62
|
+
|
63
|
+
# Set the value of the given pragma to +mode+. The +mode+ parameter must
|
64
|
+
# conform to one of the values in the given +enum+ array. Each entry in
|
65
|
+
# the array is another array comprised of elements in the enumeration that
|
66
|
+
# have duplicate values. See #synchronous, #default_synchronous,
|
67
|
+
# #temp_store, and #default_temp_store for usage examples.
|
68
|
+
def set_enum_pragma( name, mode, enums )
|
69
|
+
match = enums.find { |p| p.find { |i| i.to_s.downcase == mode.to_s.downcase } }
|
70
|
+
raise Exception,
|
71
|
+
"unrecognized #{name} #{mode.inspect}" unless match
|
72
|
+
execute( "PRAGMA #{name}='#{match.first.upcase}'" )
|
73
|
+
end
|
74
|
+
private :set_enum_pragma
|
75
|
+
|
76
|
+
# Returns the value of the given pragma as an integer.
|
77
|
+
def get_int_pragma( name )
|
78
|
+
get_first_value( "PRAGMA #{name}" ).to_i
|
79
|
+
end
|
80
|
+
private :get_int_pragma
|
81
|
+
|
82
|
+
# Set the value of the given pragma to the integer value of the +value+
|
83
|
+
# parameter.
|
84
|
+
def set_int_pragma( name, value )
|
85
|
+
execute( "PRAGMA #{name}=#{value.to_i}" )
|
86
|
+
end
|
87
|
+
private :set_int_pragma
|
88
|
+
|
89
|
+
# The enumeration of valid synchronous modes.
|
90
|
+
SYNCHRONOUS_MODES = [ [ 'full', 2 ], [ 'normal', 1 ], [ 'off', 0 ] ]
|
91
|
+
|
92
|
+
# The enumeration of valid temp store modes.
|
93
|
+
TEMP_STORE_MODES = [ [ 'default', 0 ], [ 'file', 1 ], [ 'memory', 2 ] ]
|
94
|
+
|
95
|
+
# Does an integrity check on the database. If the check fails, a
|
96
|
+
# SQLite3::Exception will be raised. Otherwise it
|
97
|
+
# returns silently.
|
98
|
+
def integrity_check
|
99
|
+
execute( "PRAGMA integrity_check" ) do |row|
|
100
|
+
raise Exception, row[0] if row[0] != "ok"
|
101
|
+
end
|
102
|
+
end
|
103
|
+
|
104
|
+
def auto_vacuum
|
105
|
+
get_boolean_pragma "auto_vacuum"
|
106
|
+
end
|
107
|
+
|
108
|
+
def auto_vacuum=( mode )
|
109
|
+
set_boolean_pragma "auto_vacuum", mode
|
110
|
+
end
|
111
|
+
|
112
|
+
def schema_cookie
|
113
|
+
get_int_pragma "schema_cookie"
|
114
|
+
end
|
115
|
+
|
116
|
+
def schema_cookie=( cookie )
|
117
|
+
set_int_pragma "schema_cookie", cookie
|
118
|
+
end
|
119
|
+
|
120
|
+
def user_cookie
|
121
|
+
get_int_pragma "user_cookie"
|
122
|
+
end
|
123
|
+
|
124
|
+
def user_cookie=( cookie )
|
125
|
+
set_int_pragma "user_cookie", cookie
|
126
|
+
end
|
127
|
+
|
128
|
+
def cache_size
|
129
|
+
get_int_pragma "cache_size"
|
130
|
+
end
|
131
|
+
|
132
|
+
def cache_size=( size )
|
133
|
+
set_int_pragma "cache_size", size
|
134
|
+
end
|
135
|
+
|
136
|
+
def default_cache_size
|
137
|
+
get_int_pragma "default_cache_size"
|
138
|
+
end
|
139
|
+
|
140
|
+
def default_cache_size=( size )
|
141
|
+
set_int_pragma "default_cache_size", size
|
142
|
+
end
|
143
|
+
|
144
|
+
def default_synchronous
|
145
|
+
get_enum_pragma "default_synchronous"
|
146
|
+
end
|
147
|
+
|
148
|
+
def default_synchronous=( mode )
|
149
|
+
set_enum_pragma "default_synchronous", mode, SYNCHRONOUS_MODES
|
150
|
+
end
|
151
|
+
|
152
|
+
def synchronous
|
153
|
+
get_enum_pragma "synchronous"
|
154
|
+
end
|
155
|
+
|
156
|
+
def synchronous=( mode )
|
157
|
+
set_enum_pragma "synchronous", mode, SYNCHRONOUS_MODES
|
158
|
+
end
|
159
|
+
|
160
|
+
def default_temp_store
|
161
|
+
get_enum_pragma "default_temp_store"
|
162
|
+
end
|
163
|
+
|
164
|
+
def default_temp_store=( mode )
|
165
|
+
set_enum_pragma "default_temp_store", mode, TEMP_STORE_MODES
|
166
|
+
end
|
167
|
+
|
168
|
+
def temp_store
|
169
|
+
get_enum_pragma "temp_store"
|
170
|
+
end
|
171
|
+
|
172
|
+
def temp_store=( mode )
|
173
|
+
set_enum_pragma "temp_store", mode, TEMP_STORE_MODES
|
174
|
+
end
|
175
|
+
|
176
|
+
def full_column_names
|
177
|
+
get_boolean_pragma "full_column_names"
|
178
|
+
end
|
179
|
+
|
180
|
+
def full_column_names=( mode )
|
181
|
+
set_boolean_pragma "full_column_names", mode
|
182
|
+
end
|
183
|
+
|
184
|
+
def parser_trace
|
185
|
+
get_boolean_pragma "parser_trace"
|
186
|
+
end
|
187
|
+
|
188
|
+
def parser_trace=( mode )
|
189
|
+
set_boolean_pragma "parser_trace", mode
|
190
|
+
end
|
191
|
+
|
192
|
+
def vdbe_trace
|
193
|
+
get_boolean_pragma "vdbe_trace"
|
194
|
+
end
|
195
|
+
|
196
|
+
def vdbe_trace=( mode )
|
197
|
+
set_boolean_pragma "vdbe_trace", mode
|
198
|
+
end
|
199
|
+
|
200
|
+
def database_list( &block ) # :yields: row
|
201
|
+
get_query_pragma "database_list", &block
|
202
|
+
end
|
203
|
+
|
204
|
+
def foreign_key_list( table, &block ) # :yields: row
|
205
|
+
get_query_pragma "foreign_key_list", table, &block
|
206
|
+
end
|
207
|
+
|
208
|
+
def index_info( index, &block ) # :yields: row
|
209
|
+
get_query_pragma "index_info", index, &block
|
210
|
+
end
|
211
|
+
|
212
|
+
def index_list( table, &block ) # :yields: row
|
213
|
+
get_query_pragma "index_list", table, &block
|
214
|
+
end
|
215
|
+
|
216
|
+
###
|
217
|
+
# Returns information about +table+. Yields each row of table information
|
218
|
+
# if a block is provided.
|
219
|
+
def table_info table
|
220
|
+
stmt = prepare "PRAGMA table_info(#{table})"
|
221
|
+
columns = stmt.columns
|
222
|
+
|
223
|
+
needs_tweak_default =
|
224
|
+
version_compare(SQLite3.libversion.to_s, "3.3.7") > 0
|
225
|
+
|
226
|
+
result = [] unless block_given?
|
227
|
+
stmt.each do |row|
|
228
|
+
new_row = Hash[columns.zip(row)]
|
229
|
+
|
230
|
+
# FIXME: This should be removed but is required for older versions
|
231
|
+
# of rails
|
232
|
+
if(Object.const_defined?(:ActiveRecord))
|
233
|
+
new_row['notnull'] = new_row['notnull'].to_s
|
234
|
+
end
|
235
|
+
|
236
|
+
tweak_default(new_row) if needs_tweak_default
|
237
|
+
|
238
|
+
if block_given?
|
239
|
+
yield new_row
|
240
|
+
else
|
241
|
+
result << new_row
|
242
|
+
end
|
243
|
+
end
|
244
|
+
stmt.close
|
245
|
+
|
246
|
+
result
|
247
|
+
end
|
248
|
+
|
249
|
+
private
|
250
|
+
|
251
|
+
# Compares two version strings
|
252
|
+
def version_compare(v1, v2)
|
253
|
+
v1 = v1.split(".").map { |i| i.to_i }
|
254
|
+
v2 = v2.split(".").map { |i| i.to_i }
|
255
|
+
parts = [v1.length, v2.length].max
|
256
|
+
v1.push 0 while v1.length < parts
|
257
|
+
v2.push 0 while v2.length < parts
|
258
|
+
v1.zip(v2).each do |a,b|
|
259
|
+
return -1 if a < b
|
260
|
+
return 1 if a > b
|
261
|
+
end
|
262
|
+
return 0
|
263
|
+
end
|
264
|
+
|
265
|
+
# Since SQLite 3.3.8, the table_info pragma has returned the default
|
266
|
+
# value of the row as a quoted SQL value. This method essentially
|
267
|
+
# unquotes those values.
|
268
|
+
def tweak_default(hash)
|
269
|
+
case hash["dflt_value"]
|
270
|
+
when /^null$/i
|
271
|
+
hash["dflt_value"] = nil
|
272
|
+
when /^'(.*)'$/
|
273
|
+
hash["dflt_value"] = $1.gsub(/''/, "'")
|
274
|
+
when /^"(.*)"$/
|
275
|
+
hash["dflt_value"] = $1.gsub(/""/, '"')
|
276
|
+
end
|
277
|
+
end
|
278
|
+
end
|
279
|
+
|
280
|
+
end
|
@@ -0,0 +1,126 @@
|
|
1
|
+
require 'sqlite3/constants'
|
2
|
+
require 'sqlite3/errors'
|
3
|
+
|
4
|
+
module SQLite3
|
5
|
+
|
6
|
+
# The ResultSet object encapsulates the enumerability of a query's output.
|
7
|
+
# It is a simple cursor over the data that the query returns. It will
|
8
|
+
# very rarely (if ever) be instantiated directly. Instead, client's should
|
9
|
+
# obtain a ResultSet instance via Statement#execute.
|
10
|
+
class ResultSet
|
11
|
+
include Enumerable
|
12
|
+
|
13
|
+
# The class of which we return an object in case we want an Array as
|
14
|
+
# result. (ArrayFields is installed.)
|
15
|
+
class ArrayWithTypes < Array
|
16
|
+
attr_accessor :types
|
17
|
+
end
|
18
|
+
|
19
|
+
# The class of which we return an object in case we want an Array as
|
20
|
+
# result. (ArrayFields is not installed.)
|
21
|
+
class ArrayWithTypesAndFields < Array
|
22
|
+
attr_accessor :types
|
23
|
+
attr_accessor :fields
|
24
|
+
end
|
25
|
+
|
26
|
+
# The class of which we return an object in case we want a Hash as
|
27
|
+
# result.
|
28
|
+
class HashWithTypes < Hash
|
29
|
+
attr_accessor :types
|
30
|
+
end
|
31
|
+
|
32
|
+
# Create a new ResultSet attached to the given database, using the
|
33
|
+
# given sql text.
|
34
|
+
def initialize db, stmt
|
35
|
+
@db = db
|
36
|
+
@stmt = stmt
|
37
|
+
end
|
38
|
+
|
39
|
+
# Reset the cursor, so that a result set which has reached end-of-file
|
40
|
+
# can be rewound and reiterated.
|
41
|
+
def reset( *bind_params )
|
42
|
+
@stmt.reset!
|
43
|
+
@stmt.bind_params( *bind_params )
|
44
|
+
@eof = false
|
45
|
+
end
|
46
|
+
|
47
|
+
# Query whether the cursor has reached the end of the result set or not.
|
48
|
+
def eof?
|
49
|
+
@stmt.done?
|
50
|
+
end
|
51
|
+
|
52
|
+
# Obtain the next row from the cursor. If there are no more rows to be
|
53
|
+
# had, this will return +nil+. If type translation is active on the
|
54
|
+
# corresponding database, the values in the row will be translated
|
55
|
+
# according to their types.
|
56
|
+
#
|
57
|
+
# The returned value will be an array, unless Database#results_as_hash has
|
58
|
+
# been set to +true+, in which case the returned value will be a hash.
|
59
|
+
#
|
60
|
+
# For arrays, the column names are accessible via the +fields+ property,
|
61
|
+
# and the column types are accessible via the +types+ property.
|
62
|
+
#
|
63
|
+
# For hashes, the column names are the keys of the hash, and the column
|
64
|
+
# types are accessible via the +types+ property.
|
65
|
+
def next
|
66
|
+
row = @stmt.step
|
67
|
+
return nil if @stmt.done?
|
68
|
+
|
69
|
+
if @db.type_translation
|
70
|
+
row = @stmt.types.zip(row).map do |type, value|
|
71
|
+
@db.translator.translate( type, value )
|
72
|
+
end
|
73
|
+
end
|
74
|
+
|
75
|
+
if @db.results_as_hash
|
76
|
+
new_row = HashWithTypes[*@stmt.columns.zip(row).flatten]
|
77
|
+
row.each_with_index { |value,idx|
|
78
|
+
new_row[idx] = value
|
79
|
+
}
|
80
|
+
row = new_row
|
81
|
+
else
|
82
|
+
if row.respond_to?(:fields)
|
83
|
+
row = ArrayWithTypes.new(row)
|
84
|
+
else
|
85
|
+
row = ArrayWithTypesAndFields.new(row)
|
86
|
+
end
|
87
|
+
row.fields = @stmt.columns
|
88
|
+
end
|
89
|
+
|
90
|
+
row.types = @stmt.types
|
91
|
+
row
|
92
|
+
end
|
93
|
+
|
94
|
+
# Required by the Enumerable mixin. Provides an internal iterator over the
|
95
|
+
# rows of the result set.
|
96
|
+
def each( &block )
|
97
|
+
while node = self.next
|
98
|
+
yield node
|
99
|
+
end
|
100
|
+
end
|
101
|
+
|
102
|
+
# Closes the statement that spawned this result set.
|
103
|
+
# <em>Use with caution!</em> Closing a result set will automatically
|
104
|
+
# close any other result sets that were spawned from the same statement.
|
105
|
+
def close
|
106
|
+
@stmt.close
|
107
|
+
end
|
108
|
+
|
109
|
+
# Queries whether the underlying statement has been closed or not.
|
110
|
+
def closed?
|
111
|
+
@stmt.closed?
|
112
|
+
end
|
113
|
+
|
114
|
+
# Returns the types of the columns returned by this result set.
|
115
|
+
def types
|
116
|
+
@stmt.types
|
117
|
+
end
|
118
|
+
|
119
|
+
# Returns the names of the columns returned by this result set.
|
120
|
+
def columns
|
121
|
+
@stmt.columns
|
122
|
+
end
|
123
|
+
|
124
|
+
end
|
125
|
+
|
126
|
+
end
|