From ffe86980cdd45918a709ae52ffbf80ea1d713035 Mon Sep 17 00:00:00 2001 From: Jinzhu Date: Sun, 21 Feb 2016 18:35:08 +0800 Subject: [PATCH] Add more plugins --- SUMMARY.md | 31 +++++++++++++++++++++++++++++++ book.json | 18 +++++++++++++++++- database.md | 31 +++++++++++++++++++++++++++++++ getting-started.md | 0 4 files changed, 79 insertions(+), 1 deletion(-) create mode 100644 database.md create mode 100644 getting-started.md diff --git a/SUMMARY.md b/SUMMARY.md index ac9323cb..8a0a43d5 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -1 +1,32 @@ # Summary + +* [Getting Started](getting-started.md) +* [Database](database.md) + * [Connecting to a Database](#connecting-to-a-database) + * [Migration]() + * [Schema]() +* [Models]() + * [Model Defination]() + * [Naming Conventions & Overriding]() + * [Associations]() + * [Belongs To]() + * [Has One]() + * [Has Many]() + * [Many To Many]() + * [Polymorphism]() + * [Association Mode]() +* [CRUD: Reading and Writing Data]() + * [Create]() + * [Query]() + * [Preloading (Eager Loading)]() + * [Update]() + * [Delete / Soft Delete]() + * [Callbacks]() +* [Advanced Usage]() + * [Error Handling]() + * [Transactions]() + * [Raw SQL & SQL Builder]() + * [Composite Primary Key]() + * [Overriding Logger]() +* [Development]() + * [Write Plugins]() diff --git a/book.json b/book.json index 700661e0..102cd215 100644 --- a/book.json +++ b/book.json @@ -1,3 +1,19 @@ { - "plugins": ["prism", "-highlight"] + "plugins": [ + "prism", "-highlight", "toggle-chapters", "toc", + "github", "anchors", "edit-link" + ], + "pluginsConfig": { + "toc": { + "addClass": true, + "className": "toc" + }, + "github": { + "url": "https://github.com/jinzhu/gorm" + }, + "edit-link": { + "base": "https://github.com/jinzhu/gorm/edit/gh-pages", + "label": "Edit This Page" + } + } } diff --git a/database.md b/database.md new file mode 100644 index 00000000..f32e1c97 --- /dev/null +++ b/database.md @@ -0,0 +1,31 @@ +## Connecting To A Database + +```go +import ( + "github.com/jinzhu/gorm" + _ "github.com/lib/pq" + _ "github.com/go-sql-driver/mysql" + _ "github.com/mattn/go-sqlite3" +) + +func init() { + db, err := gorm.Open("postgres", "user=gorm dbname=gorm sslmode=disable") + // db, err := gorm.Open("mysql", "user:password@/dbname?charset=utf8&parseTime=True&loc=Local") + // db, err := gorm.Open("sqlite3", "/tmp/gorm.db") + + // You can also use an existing database connection handle + // dbSql, _ := sql.Open("postgres", "user=gorm dbname=gorm sslmode=disable") + // db, _ := gorm.Open("postgres", dbSql) + + // Get database connection handle [*sql.DB](http://golang.org/pkg/database/sql/#DB) + db.DB() + + // Then you could invoke `*sql.DB`'s functions with it + db.DB().Ping() + db.DB().SetMaxIdleConns(10) + db.DB().SetMaxOpenConns(100) + + // Disable table name's pluralization + db.SingularTable(true) +} +``` diff --git a/getting-started.md b/getting-started.md new file mode 100644 index 00000000..e69de29b