Skip to content

Commit 2649aaa

Browse files
committed
V2.0.0
Closes mattn#597 Closes mattn#598
1 parent ac2e8f3 commit 2649aaa

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+837
-4610
lines changed

.github/ISSUE_TEMPLATE.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
### Issue description
2+
Tell us what should happen and what happens instead
3+
4+
### Example code
5+
```go
6+
If possible, please enter some example code here to reproduce the issue.
7+
```
8+
9+
### Error log
10+
```
11+
If you have an error log, please paste it here.
12+
```
13+
14+
### Configuration
15+
*Driver version (or git SHA):*
16+
17+
*Go version:* run `go version` in your console

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
### Description
2+
Please explain the changes you made here.
3+
4+
### Checklist
5+
- [ ] Code compiles correctly
6+
- [ ] Created tests which fail without the change (if possible)
7+
- [ ] All tests passing
8+
- [ ] Extended the README / documentation / Wiki, if necessary
9+
- [ ] Added myself / the copyright holder to the AUTHORS file

.gitignore

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,17 @@ tools/upgrade/*.h
1313
# Exclude upgrade binary
1414
cmd/upgrade/upgrade
1515

16+
# Exclude example binaries
17+
examples/*/*.db
18+
examples/custom_func/custom_func
19+
examples/hook/hook
20+
examples/limit/limit
21+
examples/*/*.so
22+
examples/*/extension
23+
examples/simple/simple
24+
examples/trace/trace
25+
examples/vtable/vtable
26+
1627
debug.test
1728
.DS_Store
1829
.DS_Store?

.travis.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ env:
1212
matrix:
1313
- GOTAGS=
1414
- GOTAGS=libsqlite3
15-
- GOTAGS="sqlite_allow_uri_authority sqlite_app_armor sqlite_foreign_keys sqlite_fts5 sqlite_icu sqlite_introspect sqlite_json sqlite_secure_delete sqlite_see sqlite_stat4 sqlite_trace sqlite_userauth sqlite_vacuum_incr sqlite_vtable"
15+
- GOTAGS="sqlite_allow_uri_authority sqlite_app_armor sqlite_foreign_keys sqlite_fts5 sqlite_icu sqlite_introspect sqlite_json sqlite_preupdate_hook sqlite_secure_delete sqlite_see sqlite_stat4 sqlite_trace sqlite_userauth sqlite_vacuum_incr sqlite_vtable"
1616
- GOTAGS=sqlite_vacuum_full
1717

1818
go:

AUTHORS

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
# Names should be added to this file as
77
# Name <email address>
88
# The email address is not required for organizations.
9-
# Please keep the list sorted.
9+
# Please keep the list sorted (First Name Ascending).
1010

1111
# Individual Persons
1212
G.J.R. Timmer <[email protected]>

CHANGELOG.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,16 @@
1-
## Version 2.0.0 (2018-xx-xx)
1+
## Version 2.0.0 (2018-07-19)
22

33
Changes:
44

55
- Rewrite of package
66
- Documentation fixes
77
- Moved `crypt` encoders to subpackage
8+
- Additional Tests
89

910
New Features:
1011

1112
- Golang:1.10 `sql/driver` support
1213
- Crypt
1314
`Encoder` interface for implementing custom encoder
1415
`Salter` interface for custom encoder
15-
16-
Bug Fixes:
17-
- TODO
16+
- Wiki Pages

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,4 +20,4 @@ Before merging the Pull Request, at least one team member must have commented wi
2020

2121
## Development Ideas
2222

23-
If you are looking for ideas for code contributions, please check our [Development Ideas](https://github.com/mattn/go-sqlite3/wiki/Development-Ideas) Wiki page.
23+
If you are looking for ideas for code contributions, please check our [Development Ideas](https://github.com/mattn/go-sqlite3/wiki/Development-Ideas) Wiki page.

README.md

Lines changed: 69 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,69 @@
1-
# TODO Rewrite
1+
# Go-SQLite3
2+
3+
[![GoDoc Reference](https://godoc.org/github.com/mattn/go-sqlite3?status.svg)](http://godoc.org/github.com/mattn/go-sqlite3)
4+
[![Build Status](https://travis-ci.org/mattn/go-sqlite3.svg?branch=master)](https://travis-ci.org/mattn/go-sqlite3)
5+
[![Coverage Status](https://coveralls.io/repos/mattn/go-sqlite3/badge.svg?branch=master)](https://coveralls.io/r/mattn/go-sqlite3?branch=master)
6+
[![Go Report Card](https://goreportcard.com/badge/github.com/mattn/go-sqlite3)](https://goreportcard.com/report/github.com/mattn/go-sqlite3)
7+
8+
**Current Version: 2.0.0**
9+
10+
**Please note that version 2.0.0 is not backwards compatible**
11+
12+
## Documentation
13+
14+
[More documentation is available in our Wiki](https://github.com/mattn/go-sqlite3/wiki)
15+
16+
## Description
17+
18+
sqlite3 driver conforming to the built-in database/sql interface
19+
20+
Supported Golang version:
21+
- 1.9.x
22+
- 1.10.x
23+
24+
[This package follows the official Golang Release Policy.](https://golang.org/doc/devel/release.html#policy)
25+
26+
## Requirements
27+
28+
* Go: 1.9 or higher.
29+
* GCC (Go-SQLite3 is a `CGO` package)
30+
31+
_go-sqlite3_ is *cgo* package.
32+
If you want to build your app using go-sqlite3, you need gcc.
33+
However, after you have built and installed _go-sqlite3_ with `go install github.com/mattn/go-sqlite3` (which requires gcc), you can build your app without relying on gcc in future.
34+
35+
**Important: because this is a `CGO` enabled package you are required to set the environment variable `CGO_ENABLED=1` and have a `gcc` compile present within your path.**
36+
37+
## Installation
38+
39+
```bash
40+
go get github.com/mattn/go-sqlite3
41+
```
42+
43+
## Usage
44+
45+
`Go-SQLite3 is an implementation of Go's database/sql/driver interface. You only need to import the driver and can use the full database/sql API then.
46+
47+
Use `sqlite3` as `drivername` and a valid [DSN](https://github.com/mattn/go-sqlite3/wiki/DSN) as `dataSourceName`:
48+
49+
```go
50+
import (
51+
"database/sql"
52+
_ "github.com/mattn/go-sqlite3/driver"
53+
)
54+
55+
db, err := sql.Open("sqlite3", "file:test.db")
56+
```
57+
58+
[Examples are available in our Wiki](https://github.com/mattn/go-sqlite3/wiki/Examples)
59+
60+
# License
61+
62+
MIT: http://mattn.mit-license.org/2018
63+
64+
sqlite3-binding.c, sqlite3-binding.h, sqlite3ext.h
65+
66+
The -binding suffix was added to avoid build failures under gccgo.
67+
68+
In this repository, those files are an amalgamation of code that was copied from SQLite3.
69+
The license of that code is the same as the license of SQLite3.

0 commit comments

Comments
 (0)