README
¶
sqlite3
sqlite3 is a pure Go package decoding the SQLite file format as
described by:
http://www.sqlite.org/fileformat.html
Current status
WIP: The near-term aim for sqlite3 is to iterate through the
data in tables in SQLite files: ie., readonly access, and no actual
SQL queries.
It doesn't quite do that yet: so far it just parses the
sqlite_master data enough to find a list of tables and their names.
Installation
$ go get github.com/go-sqlite/sqlite3
License
sqlite3 is released under the BSD-3 license.
Example
package main
import (
"fmt"
"github.com/go-sqlite/sqlite3"
)
func main() {
db, err := sqlite3.Open("test.sqlite")
if err != nil {
panic(err)
}
defer db.Close()
for _, table := range db.Tables() {
fmt.Printf(">>> table=%#v\n", table)
}
}
Contributing
We're always looking for new contributing finding bugs, fixing issues, or writing some docs. If you're interested in contriburing source code changes you'll just need to pull down the source code. You can run tests with go test ./... in the root of this project.
Make sure to add yourself to AUTHORS and CONTRIBUTORS if you submit a PR. We want you to take credit for your work!
Documentation
¶
Overview ¶
Package sqlite3 decodes the SQLite-3 file format.
Index ¶
- Constants
- type Column
- type DbFile
- func (db *DbFile) Close() error
- func (db *DbFile) Dumpdb() error
- func (db *DbFile) Encoding() int
- func (db *DbFile) NumPage() int
- func (db *DbFile) PageSize() int
- func (db *DbFile) Tables() []Table
- func (db *DbFile) Version() int
- func (db *DbFile) VisitTableRecords(tableName string, f func(*int64, Record) error) error
- type PageKind
- type Record
- type RecordHeader
- type SerialType
- type Table
Constants ¶
const ( BTreeInteriorIndexKind = zeroDataKind BTreeInteriorTableKind = leafDataKind | intKeyKind BTreeLeafIndexKind = zeroDataKind | leafKind BTreeLeafTableKind = leafDataKind | intKeyKind | leafKind )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Column ¶
type Column struct {
// contains filtered or unexported fields
}
Column describes a column in a SQLite table
type DbFile ¶
type DbFile struct {
// contains filtered or unexported fields
}
func (*DbFile) VisitTableRecords ¶
VisitTableRecords performs an inorder traversal of all cells in the btree for the table with the given name, passing the (optional, hence nullable) RowID, and record-decoded payload of each cell to the visitor function `f`.
type Record ¶
type Record struct {
Header RecordHeader
Body []byte
Values []interface{}
}
type RecordHeader ¶
type RecordHeader struct {
Len int
Types []SerialType
}
type SerialType ¶
type SerialType int
SerialType represents SQLite types on disk
const ( StNull SerialType = iota StInt8 StInt16 StInt24 StInt32 StInt48 StInt64 StFloat StC0 StC1 StBlob SerialType = 12 StText = 13 )
func (SerialType) IsBlob ¶
func (st SerialType) IsBlob() bool
func (SerialType) IsText ¶
func (st SerialType) IsText() bool
func (SerialType) NBytes ¶
func (st SerialType) NBytes() int
NBytes returns the number of bytes on disk for this SerialType NBytes returns -1 if the SerialType is invalid.
func (SerialType) String ¶
func (st SerialType) String() string
Source Files
¶
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
sqlite-dump
Command sqlite-dump is a simple command that dumps the high-level content of a SQLITE3 file on screen.
|
Command sqlite-dump is a simple command that dumps the high-level content of a SQLITE3 file on screen. |