{"id":4121,"date":"2024-10-31T08:25:57","date_gmt":"2024-10-31T01:25:57","guid":{"rendered":"https:\/\/www.sqlitetutorial.net\/?page_id=4121"},"modified":"2024-10-31T16:42:21","modified_gmt":"2024-10-31T09:42:21","slug":"connect","status":"publish","type":"page","link":"https:\/\/www.sqlitetutorial.net\/sqlite-go\/connect\/","title":{"rendered":"SQLite Go: Connecting to SQLite Databases."},"content":{"rendered":"\n

Summary<\/strong>: In this tutorial, you will learn how to connect to the SQLite database using a Go program.<\/p>\n\n\n\n

How to connect to an SQLite Database from Go<\/h2>\n\n\n\n

Step 1. Open your terminal and create a new project directory:<\/p>\n\n\n

mkdir go<\/span>-sqlite\ncd go<\/span>-sqlite<\/code><\/span>Code language:<\/span> Go<\/span> (<\/span>go<\/span>)<\/span><\/small><\/pre>\n\n\n
Step 2. Initialize a Go module by running the following command from your terminal:<\/p>\n\n\n
go<\/span> mod init sqlitetutorial.net\/go<\/span><\/code><\/span>Code language:<\/span> Go<\/span> (<\/span>go<\/span>)<\/span><\/small><\/pre>\n\n\n
This will create a go.mod<\/code> file. Without doing this step, you will not be able to install any external packages<\/p>\n\n\n\n
Step 3. Install the sqlite<\/code> driver:<\/p>\n\n\n
go<\/span> get github.com\/glebarez\/go<\/span>-sqlite<\/code><\/span>Code language:<\/span> Go<\/span> (<\/span>go<\/span>)<\/span><\/small><\/pre>\n\n\n
The go-sqlite<\/code> is a pure-Go driver for Go’s native database\/sql<\/code> package. <\/p>\n\n\n\n
Step 4. Create a new file main.go<\/code> that connects to the SQLite database file:<\/p>\n\n\n
package<\/span> main\n\nimport<\/span> (\n    \"database\/sql\"<\/span>\n    \"fmt\"<\/span>\n    _ \"github.com\/glebarez\/go-sqlite\"<\/span>\n)\n\nfunc<\/span> main<\/span>()<\/span><\/span> {\n    \/\/ Connect to the SQLite database<\/span>\n    db, err := sql.Open(\"sqlite\"<\/span>, \".\/my.db\"<\/span>)\n    if<\/span> err != nil<\/span> {\n        fmt.Println(err)\n        return<\/span>\n    }\n\n    defer<\/span> db.Close()\n    fmt.Println(\"Connected to the SQLite database successfully.\"<\/span>)\n\n    \/\/ Get the version of SQLite<\/span>\n    var<\/span> sqliteVersion string<\/span>\n    err = db.QueryRow(\"select sqlite_version()\"<\/span>).Scan(&sqliteVersion)\n    if<\/span> err != nil<\/span> {\n        fmt.Println(err)\n        return<\/span>\n    }\n\n    fmt.Println(sqliteVersion)\n}<\/code><\/span>Code language:<\/span> Go<\/span> (<\/span>go<\/span>)<\/span><\/small><\/pre>\n\n\n
How it works.<\/p>\n\n\n\n
First, import the database\/sql<\/code>, fmt, and go-sqlite<\/code> modules:<\/p>\n\n\n
import<\/span> (\n    \"database\/sql\"<\/span>\n    \"fmt\"<\/span>\n\n    _ \"github.com\/glebarez\/go-sqlite\"<\/span>\n)<\/code><\/span>Code language:<\/span> Go<\/span> (<\/span>go<\/span>)<\/span><\/small><\/pre>\n\n\n
Second, connect to the my.db<\/code> sqlite database file:<\/p>\n\n\n
db, err := sql.Open(\"sqlite\"<\/span>, \".\/my.db\"<\/span>)<\/code><\/span>Code language:<\/span> Go<\/span> (<\/span>go<\/span>)<\/span><\/small><\/pre>\n\n\n
If the file my.db<\/code> does not exist in the project directory, the program will create a new one and open a connection. Otherwise, it will create a new connection to the SQLite database file.<\/p>\n\n\n\n
The ?_pragma=foreign_keys<\/code>(1)<\/code> option enables the foreign key constraint check. Note that SQLite does not enforce the foreign key constraint<\/a> by default.<\/p>\n\n\n\n
If you want to connect to an SQLite database in the memory, you can replace the filename with the literal string\":memory:\"<\/code> like this:<\/p>\n\n\n
db, err := sql.Open(\"sqlite\"<\/span>, \":memory:\"<\/span>)<\/code><\/span>Code language:<\/span> Go<\/span> (<\/span>go<\/span>)<\/span><\/small><\/pre>\n\n\n
Third, check if an error occurs during the connection process, and display the error message:<\/p>\n\n\n
if<\/span> err != nil<\/span> {\n    fmt.Println(err)\n    return<\/span>\n}<\/code><\/span>Code language:<\/span> Go<\/span> (<\/span>go<\/span>)<\/span><\/small><\/pre>\n\n\n
Fourth, close the database connection before the main<\/code> function exits i.e., before the program ends:<\/p>\n\n\n
defer<\/span> db.Close()<\/code><\/span>Code language:<\/span> Go<\/span> (<\/span>go<\/span>)<\/span><\/small><\/pre>\n\n\n
Fifth, display a success message:<\/p>\n\n\n
fmt.Println(\"Connected to the SQLite database successfully.\"<\/span>)<\/code><\/span>Code language:<\/span> Go<\/span> (<\/span>go<\/span>)<\/span><\/small><\/pre>\n\n\n
Finally, get the SQLite version by calling the sqlite_version()<\/code> function and scan the result into the sqliteVersion<\/code> variable:<\/p>\n\n\n
err = db.QueryRow(\"select sqlite_version()\"<\/span>).Scan(&sqliteVersion)<\/code><\/span>Code language:<\/span> Go<\/span> (<\/span>go<\/span>)<\/span><\/small><\/pre>\n\n\n
If an error occurs, display the message and return:<\/p>\n\n\n
if<\/span> err != nil<\/span> {\n    fmt.Println(err)\n    return<\/span>\n}<\/code><\/span>Code language:<\/span> Go<\/span> (<\/span>go<\/span>)<\/span><\/small><\/pre>\n\n\n
Otherwise, print the SQLite version:<\/p>\n\n\n
fmt.Println(sqliteVersion)<\/code><\/span>Code language:<\/span> Go<\/span> (<\/span>go<\/span>)<\/span><\/small><\/pre>\n\n\n
It’s important to note that if you call the Open()<\/code> function to connect to a non-existing SQLite database file and don’t interact with it, the program will not create the SQLite database file.<\/p>\n\n\n\n
Summary<\/h2>\n\n\n\n
    \n
  • Install the go-sqlite<\/code> driver to interact with SQLite databases.<\/li>\n\n\n\n
  • Call the Open()<\/code> function to create a new SQLite database file or open a connection to an existing one.<\/li>\n<\/ul>\n
    \n\t
    \n\t\t
    Was this tutorial helpful ?<\/div>\n\t\t
    \n\t\t\t\n\t\t\t\t\n\t\t\t\t\t<\/path>\n\t\t\t\t<\/svg>\n\t\t\t\t Yes <\/span>\n\t\t\t<\/button>\n\n\t\t\t\n\t\t\t\t\n\t\t\t\t\t<\/path>\n\t\t\t\t<\/svg>\n\t\t\t\t No <\/span>\n\t\t\t<\/button>\n\t\t<\/div>\n\t<\/header>\n\n\t
    \n\t\t
    \n\t\t\t
    <\/div>\n\t\t\t\n\t\t\t