Skip to content

Commit 1127cd4

Browse files
committed
Update docs
1 parent 9ded4ea commit 1127cd4

File tree

2 files changed

+12
-0
lines changed

2 files changed

+12
-0
lines changed

docs/src/index.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,10 @@ SQLite.Sink
5252
5353

5454
* `SQLite.execute!(stmt::SQLite.Stmt)`
55+
5556
`SQLite.execute!(db::SQLite.DB, sql::String)`
5657

58+
5759
Used to execute a prepared `SQLite.Stmt`. The 2nd method is a convenience method to pass in an SQL statement as a string which gets prepared and executed in one call. This method does not check for or return any results, hence it is only useful for database manipulation methods (i.e. ALTER, CREATE, UPDATE, DROP). To return results, see `SQLite.query` below.
5860

5961

@@ -65,7 +67,9 @@ SQLite.Sink
6567

6668

6769
* `SQLite.drop!(db::SQLite.DB,table::String;ifexists::Bool=false)`
70+
6871
`SQLite.dropindex!(db::SQLite.DB,index::String;ifexists::Bool=false)`
72+
6973

7074
These are pretty self-explanatory. They're really just a convenience methods to execute DROP TABLE/DROP INDEX commands, while also calling "VACUUM" to clean out freed memory from the database.
7175

src/SQLite.jl

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -181,8 +181,10 @@ end
181181

182182
"""
183183
`SQLite.execute!(stmt::SQLite.Stmt)` => `Void`
184+
184185
`SQLite.execute!(db::DB, sql::String)` => `Void`
185186
187+
186188
Execute a prepared SQLite statement, not checking for or returning any results.
187189
"""
188190
function execute! end
@@ -217,8 +219,10 @@ esc_id{S<:AbstractString}(X::AbstractVector{S}) = join(map(esc_id,X),',')
217219
# Transaction-based commands
218220
"""
219221
`SQLite.transaction(db, mode="DEFERRED")`
222+
220223
`SQLite.transaction(func, db)`
221224
225+
222226
Begin a transaction in the specified `mode`, default = "DEFERRED".
223227
224228
If `mode` is one of "", "DEFERRED", "IMMEDIATE" or "EXCLUSIVE" then a
@@ -256,8 +260,10 @@ end
256260

257261
"""
258262
`SQLite.commit(db)`
263+
259264
`SQLite.commit(db, name)`
260265
266+
261267
commit a transaction or named savepoint
262268
"""
263269
function commit end
@@ -267,8 +273,10 @@ commit(db, name) = execute!(db, "RELEASE SAVEPOINT $(name);")
267273

268274
"""
269275
`SQLite.rollback(db)`
276+
270277
`SQLite.rollback(db, name)`
271278
279+
272280
rollback transaction or named savepoint
273281
"""
274282
function rollback end

0 commit comments

Comments
 (0)